gorm

Documentation

Index

• type Config
  • func NewPlugin(plugin *Config) *Config
  • func (p *Config) Initialize(db *gorm.DB) (err error)
  • func (p *Config) Name() string
• 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{})

Types

type Config

type Config struct {
	Logger           glog.ILoggerEntry
	TracerServer     *tracer.Server
	Attrs            []attribute.KeyValue
	ExcludeQueryVars bool
	ExcludeMetrics   bool
	QueryFormatter   func(query string) string
}

func NewPlugin

func NewPlugin(plugin *Config) *Config

func (*Config) Initialize

func (p *Config) Initialize(db *gorm.DB) (err error)

func (*Config) Name

func (p *Config) Name() string

type DB

type DB struct {
	Client *gorm.DB
}

func (*DB) Assign

func (db *DB) Assign(attrs ...interface{}) db.IDB

func (*DB) Attrs

func (db *DB) Attrs(attrs ...interface{}) db.IDB

func (*DB) Distinct

func (db *DB) Distinct(args ...interface{}) db.IDB

Distinct specify distinct fields that you want querying

func (*DB) Group

func (db *DB) Group(name string) db.IDB

Group specify the group method on the find

func (*DB) Having

func (db *DB) Having(query interface{}, args ...interface{}) db.IDB

Having specify HAVING conditions for GROUP BY

func (*DB) Joins

func (db *DB) Joins(query string, args ...interface{}) db.IDB

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) Limit

func (db *DB) Limit(limit int) db.IDB

Limit specify the number of records to be retrieved

func (*DB) Model

func (db *DB) Model(value interface{}) db.IDB

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) Not

func (db *DB) Not(query interface{}, args ...interface{}) db.IDB

Not add NOT conditions

func (*DB) Offset

func (db *DB) Offset(offset int) db.IDB

Offset specify the number of records to skip before starting to return the records

func (*DB) Omit

func (db *DB) Omit(columns ...string) db.IDB

Omit specify fields that you want to ignore when creating, updating and querying

func (*DB) Or

func (db *DB) Or(query interface{}, args ...interface{}) db.IDB

Or add OR conditions

func (*DB) Order

func (db *DB) Order(value interface{}) db.IDB

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

func (db *DB) Preload(query string, args ...interface{}) db.IDB

Preload associations with given conditions

db.Preload("Orders", "state NOT IN (?)", "cancelled").Find(&users)

func (*DB) Raw

func (db *DB) Raw(sql string, values ...interface{}) db.IDB

func (*DB) Select

func (db *DB) Select(query interface{}, args ...interface{}) db.IDB

Select specify fields that you want when querying, creating, updating

func (*DB) Table

func (db *DB) Table(name string, args ...interface{}) db.IDB

Table specify the table you would like to run db operations

func (*DB) Unscoped

func (db *DB) Unscoped() db.IDB

func (*DB) Where

func (db *DB) Where(query interface{}, args ...interface{}) db.IDB

Where add conditions

type LogSql

type LogSql struct {
	SlowThreshold             time.Duration
	IgnoreRecordNotFoundError bool
	Logger                    glog.ILoggerEntry
}

func (*LogSql) Error

func (l *LogSql) Error(ctx context.Context, msg string, data ...interface{})

func (*LogSql) Info

func (l *LogSql) Info(ctx context.Context, msg string, data ...interface{})

func (*LogSql) LogMode

func (l *LogSql) LogMode(level logger.LogLevel) logger.Interface

func (*LogSql) Trace

func (l *LogSql) Trace(ctx context.Context, begin time.Time, fc func() (sql string, rowsAffected int64), err error)

func (*LogSql) Warn

func (l *LogSql) Warn(ctx context.Context, msg string, data ...interface{})