Documentation
¶
Index ¶
- func NewPlugin(plugin *sqlConfig) *sqlConfig
- func WithOmitVariablesFromTrace(ctx context.Context) context.Context
- type Client
- type DB
- func (db *DB) Assign(attrs ...interface{}) db.IDB
- func (db *DB) Attrs(attrs ...interface{}) db.IDB
- func (db *DB) Distinct(args ...interface{}) db.IDB
- func (db *DB) Group(name string) db.IDB
- func (db *DB) Having(query interface{}, args ...interface{}) db.IDB
- func (db *DB) Joins(query string, args ...interface{}) db.IDB
- func (db *DB) Limit(limit int) db.IDB
- func (db *DB) Model(value interface{}) db.IDB
- func (db *DB) Not(query interface{}, args ...interface{}) db.IDB
- func (db *DB) Offset(offset int) db.IDB
- func (db *DB) Omit(columns ...string) db.IDB
- func (db *DB) Or(query interface{}, args ...interface{}) db.IDB
- func (db *DB) Order(value interface{}) db.IDB
- func (db *DB) Preload(query string, args ...interface{}) db.IDB
- func (db *DB) Raw(sql string, values ...interface{}) db.IDB
- func (db *DB) Select(query interface{}, args ...interface{}) db.IDB
- func (db *DB) Table(name string, args ...interface{}) db.IDB
- func (db *DB) Unscoped() db.IDB
- func (db *DB) Where(query interface{}, args ...interface{}) db.IDB
- type LogSql
- func (l *LogSql) Error(ctx context.Context, msg string, data ...interface{})
- func (l *LogSql) Info(ctx context.Context, msg string, data ...interface{})
- func (l *LogSql) LogMode(level logger.LogLevel) logger.Interface
- func (l *LogSql) Trace(ctx context.Context, begin time.Time, ...)
- func (l *LogSql) Warn(ctx context.Context, msg string, data ...interface{})
- type Option
- func WithAttributes(attrs ...attribute.KeyValue) Option
- func WithConnMaxIdleTime(connMaxIdleTime time.Duration) Option
- func WithDBName(name string) Option
- func WithDNS(dsn map[string]string) Option
- func WithDefaultStringSize(defaultStringSize uint) Option
- func WithDisableDatetimePrecision(disableDatetimePrecision bool) Option
- func WithDontSupportRenameColumn(dontSupportRenameColumn bool) Option
- func WithDontSupportRenameIndex(dontSupportRenameIndex bool) Option
- func WithIgnoreRecordNotFoundError(ignoreRecordNotFoundError bool) Option
- func WithLogger(logger glog.ILogger) Option
- func WithMaxIdleCons(maxIdleCons int) Option
- func WithMaxOpenCons(maxOpenCons int) Option
- func WithQueryFormatter(queryFormatter func(query string) string) Option
- func WithSkipInitializeWithVersion(skipInitializeWithVersion bool) Option
- func WithSlowThreshold(slowThreshold time.Duration) Option
- func WithTracer(tracerServer *tracer.Server) Option
- func WithoutMetrics() Option
- func WithoutQueryVariables() Option
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type DB ¶
func (*DB) Joins ¶
Joins specify Joins conditions
db.Joins("Account").Find(&user)
db.Joins("JOIN emails ON emails.user_id = users.id AND emails.email = ?", "jinzhu@example.org").Find(&user)
db.Joins("Account", DB.Select("id").Where("user_id = users.id AND name = ?", "someName").Model(&Account{}))
func (*DB) Model ¶
Model specify the model you would like to run db operations
// update all users is name to `hello`
db.Model(&User{}).Update("name", "hello")
// if user's primary key is non-blank, will use it as condition, then will only update the user's name to `hello`
db.Model(&user).Update("name", "hello")
func (*DB) Offset ¶
Offset specify the number of records to skip before starting to return the records
func (*DB) Order ¶
Order specify order when retrieve records from database
db.Order("name DESC")
db.Order(clause.OrderByColumn{Column: clause.Column{Name: "name"}, Desc: true})
func (*DB) Preload ¶
Preload associations with given conditions
db.Preload("Orders", "state NOT IN (?)", "cancelled").Find(&users)
type Option ¶
type Option func(p *config)
func WithAttributes ¶
WithAttributes configures attributes that are used to create a span.
func WithConnMaxIdleTime ¶
WithConnMaxIdleTime connMaxIdleTime
func WithDefaultStringSize ¶
WithDefaultStringSize defaultStringSize
func WithDisableDatetimePrecision ¶
WithDisableDatetimePrecision disableDatetimePrecision
func WithDontSupportRenameColumn ¶
WithDontSupportRenameColumn dontSupportRenameColumn
func WithDontSupportRenameIndex ¶
WithDontSupportRenameIndex dontSupportRenameIndex
func WithIgnoreRecordNotFoundError ¶
WithIgnoreRecordNotFoundError ignoreRecordNotFoundError
func WithQueryFormatter ¶
WithQueryFormatter configures a query formatter
func WithSkipInitializeWithVersion ¶
WithSkipInitializeWithVersion skipInitializeWithVersion
func WithSlowThreshold ¶
WithSlowThreshold slowThreshold
func WithTracer ¶
WithTracer tracerServer tracer.Server
func WithoutMetrics ¶
func WithoutMetrics() Option
WithoutMetrics prevents DBStats metrics from being reported.
func WithoutQueryVariables ¶
func WithoutQueryVariables() Option
WithoutQueryVariables configures the db.statement attribute to exclude query variables