README
¶
mysql
mysql library wrapped in gorm, with added features such as tracer, paging queries, etc.
Example of use
Initializing the connection
import "gitee.com/jianguosun_admin/common_pkg/mysql"
var dsn = "root:123456@(192.168.1.6:3306)/test?charset=utf8mb4&parseTime=True&loc=Local"
// (1) connect to the database using the default settings
db, err := mysql.Init(dsn)
// (2) customised settings to connect to the database
db, err := Init(
dsn,
//WithLog(), // print all logs
WithSlowThreshold(time.Millisecond*100), // only print logs that take longer than 100 milliseconds to execute
WithEnableTrace(), // enable tracing
WithMaxIdleConns(5),
WithMaxOpenConns(50),
WithConnMaxLifetime(time.Minute*3),
)
Model
package model
import "gitee.com/jianguosun_admin/common_pkg/mysql"
// UserExample object fields mapping table
type UserExample struct {
mysql.Model `gorm:"embedded"`
Name string `gorm:"type:varchar(40);unique_index;not null" json:"name"`
Age int `gorm:"not null" json:"age"`
Gender string `gorm:"type:varchar(10);not null" json:"gender"`
}
// TableName get table name
func (table *UserExample) TableName() string {
return mysql.GetTableName(table)
}
Transaction
import "gitee.com/jianguosun_admin/common_pkg/mysql"
func createUser() error {
// note that you should use tx as the database handle when you are in a transaction
tx := db.Begin()
defer func() {
if err := recover(); err != nil { // rollback after a panic during transaction execution
tx.Rollback()
fmt.Printf("transaction failed, err = %v\n", err)
}
}()
var err error
if err = tx.Error; err != nil {
return err
}
if err = tx.Where("id = ?", 1).First(table).Error; err != nil {
tx.Rollback()
return err
}
panic("mock panic")
if err = tx.Create(&userExample{Name: "Mr Li", Age: table.Age + 2, Gender: "male"}).Error; err != nil {
tx.Rollback()
return err
}
return tx.Commit().Error
}
gorm User Guide
Documentation
¶
Overview ¶
Package mysql is a library wrapped on top of gorm.io/gorm, with added features such as link tracing, paging queries, etc.
Index ¶
- func Count(ctx context.Context, db *gorm.DB, table interface{}, ...) (int64, error)
- func Create(ctx context.Context, db *gorm.DB, table interface{}) error
- func Delete(ctx context.Context, db *gorm.DB, table interface{}, ...) error
- func DeleteByID(ctx context.Context, db *gorm.DB, table interface{}, id interface{}) error
- func Get(ctx context.Context, db *gorm.DB, table interface{}, ...) error
- func GetByID(ctx context.Context, db *gorm.DB, table interface{}, id interface{}) error
- func GetTableName(object interface{}) string
- func Init(opts ...Option) (*gorm.DB, error)
- func List(ctx context.Context, db *gorm.DB, tables interface{}, page *query.Page, ...) error
- func NewCustomGormLogger(o *options) logger.Interface
- func TableName(table interface{}) string
- func Update(ctx context.Context, db *gorm.DB, table interface{}, column string, ...) error
- func Updates(ctx context.Context, db *gorm.DB, table interface{}, update KV, ...) error
- type KV
- type Model
- type Model2
- type Option
- func WithConnMaxIdleTime(t time.Duration) Option
- func WithConnMaxLifetime(t time.Duration) Option
- func WithEnableForeignKey() Option
- func WithEnableTrace() Option
- func WithGormPlugin(plugins ...gorm.Plugin) Option
- func WithIsOpenReadDb(isOpenReadDb bool) Option
- func WithLog() Option
- func WithLogRequestIDKey(key string) Option
- func WithLogging(l *zap.Logger, level ...logger.LogLevel) Option
- func WithMaxIdleConns(size int) Option
- func WithMaxOpenConns(size int) Option
- func WithRWSeparation(slavesDsn []string, mastersDsn ...string) Option
- func WithSlowThreshold(d time.Duration) Option
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Count ¶
func Count(ctx context.Context, db *gorm.DB, table interface{}, queryCondition interface{}, args ...interface{}) (int64, error)
Count number of records the param of 'table' must be pointer, eg: &StructName
func Delete ¶
func Delete(ctx context.Context, db *gorm.DB, table interface{}, queryCondition interface{}, args ...interface{}) error
Delete record the param of 'table' must be pointer, eg: &StructName
func DeleteByID ¶
DeleteByID delete record by id the param of 'table' must be pointer, eg: &StructName
func Get ¶
func Get(ctx context.Context, db *gorm.DB, table interface{}, queryCondition interface{}, args ...interface{}) error
Get one record the param of 'table' must be pointer, eg: &StructName
func List ¶
func List(ctx context.Context, db *gorm.DB, tables interface{}, page *query.Page, queryCondition interface{}, args ...interface{}) error
List multiple records, starting from page 0 the param of 'tables' must be a slice, eg: []StructName
func NewCustomGormLogger ¶
NewCustomGormLogger custom gorm logger
Types ¶
type Model ¶
type Model struct {
ID uint64 `gorm:"column:id;AUTO_INCREMENT;primary_key" json:"id"`
CreatedAt time.Time `gorm:"column:created_at" json:"createdAt"`
UpdatedAt time.Time `gorm:"column:updated_at" json:"updatedAt"`
DeletedAt gorm.DeletedAt `gorm:"column:deleted_at;index" json:"-"`
}
Model embedded structs, add `gorm: "embedded"` when defining table structs
type Model2 ¶
type Model2 struct {
ID uint64 `gorm:"column:id;AUTO_INCREMENT;primary_key" json:"id"`
CreatedAt time.Time `gorm:"column:created_at" json:"created_at"`
UpdatedAt time.Time `gorm:"column:updated_at" json:"updated_at"`
DeletedAt gorm.DeletedAt `gorm:"column:deleted_at;index" json:"-"`
}
Model2 embedded structs, json tag named is snake case
type Option ¶
type Option func(*options)
Option set the mysql options.
func WithConnMaxIdleTime ¶
WithConnMaxIdleTime set conn max connMaxIdleTime
func WithConnMaxLifetime ¶
WithConnMaxLifetime set conn max lifetime
func WithEnableForeignKey ¶
func WithEnableForeignKey() Option
WithEnableForeignKey use foreign keys
func WithGormPlugin ¶ added in v1.0.4
WithGormPlugin setting gorm plugin
func WithIsOpenReadDb ¶
WithIsOpenReadDb isOpenReadDb
func WithLog ¶
func WithLog() Option
WithLog set log sql Deprecated: will be replaced by WithLogging
func WithLogRequestIDKey ¶
WithLogRequestIDKey log request id
func WithLogging ¶
WithLogging set log sql, If l=nil, the gorm log library will be used
func WithRWSeparation ¶ added in v1.0.4
WithRWSeparation setting read-write separation
func WithSlowThreshold ¶
WithSlowThreshold Set sql values greater than the threshold
Source Files
Directories