Documentation
¶
Index ¶
- func Ctx(ctx context.Context) *gorm.DB
- func CtxWith(ctx context.Context, key string) *gorm.DB
- func Default() *gorm.DB
- func RecordNotFound(err error) bool
- func RegisterDriver(t Driver, f func(*Config) gorm.Dialector)
- func SetDefault(gormDB *gorm.DB)
- func Use(key string) *gorm.DB
- func WithContext(ctx context.Context, key string) context.Context
- func WithContextDB(ctx context.Context, db *gorm.DB) context.Context
- type Config
- type DB
- type Driver
- type GroupConfig
- type Logger
- func (l *Logger) Error(ctx context.Context, msg string, args ...interface{})
- func (l *Logger) Info(ctx context.Context, msg string, args ...interface{})
- func (l *Logger) LogMode(level logger.LogLevel) logger.Interface
- func (l *Logger) ParamsFilter(ctx context.Context, sql string, params ...interface{}) (string, []interface{})
- func (l *Logger) Trace(ctx context.Context, begin time.Time, ...)
- func (l *Logger) Warn(ctx context.Context, msg string, args ...interface{})
- type Option
- type Options
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterDriver ¶
RegisterDriver 注册数据库驱动 默认会注册mysql t 数据库驱动名 f 数据库驱动函数 传入配置返回 gorm.Dialector
func WithContext ¶
WithContext 根据 key 参数指定数据库,并将数据库实例存入 context 如果你想修改后续的数据库实例,你可以使用 db.WithContext ctx:=db.WithContext(ctx, "db2") SomeMethod(ctx)
Types ¶
type Config ¶
type Config struct {
Driver Driver `yaml:"driver"`
Dsn string `yaml:"dsn"`
Prefix string `yaml:"prefix"`
// 开启 gorm 的 debug 模式
Debug bool `yaml:"debug"`
// 读写分离,以后再说吧
//WriterDsn []string `yaml:"writerDsn,omitempty"` // 写入数据源
//ReaderDsn []string `yaml:"readerDsn,omitempty"` // 读取数据源
// gorm配置
PrepareStmt bool `yaml:"prepareStmt,omitempty"` // 是否开启预编译
// 连接池。这几项 gorm 不管,由 newDB 拿到底层的 *sql.DB 之后自己写进去。
// 零值表示不动,保持 database/sql 自己的默认值——而那套默认值对长期跑的服务
// 是不合适的,上线前建议按下面的说明配一遍:
// - MaxIdleConns 默认 2,并发一上来就会不停地建/拆 TCP + 数据库握手;
// - MaxOpenConns 默认无上限,一次流量尖峰就能顶穿数据库的最大连接数;
// - ConnMaxLifetime 默认永不过期,主从切换后会一直攥着指向旧主的死连接。
// 多副本部署时 MaxOpenConns 是**每个副本**的上限,调之前先算
// 「副本数 × MaxOpenConns ≤ 数据库的最大连接数」(MySQL 默认只有 151)。
MaxOpenConns int `yaml:"maxOpenConns,omitempty"` // 最大连接数,<=0 表示无上限
MaxIdleConns int `yaml:"maxIdleConns,omitempty"` // 最大空闲连接数,超过 MaxOpenConns 时由 database/sql 自动压到 MaxOpenConns
ConnMaxLifetime time.Duration `yaml:"connMaxLifetime,omitempty"` // 连接最长存活时间,<=0 表示永不过期
ConnMaxIdleTime time.Duration `yaml:"connMaxIdleTime,omitempty"` // 连接最长空闲时间,<=0 表示不因空闲而回收
}
type DB ¶
type DB struct {
// contains filtered or unexported fields
}
func Database ¶
func Database() *DB
Database gorm数据库封装,支持多数据库,如果你配置了 trace 的话会自动开启链路追踪 默认注册和使用 mysql 驱动,如果你需要其他驱动,可以使用 RegisterDriver 注册 或者导入对应的数据库驱动,例如: import _ "clickhouse"
func (*DB) CloseHandle ¶
func (d *DB) CloseHandle()
type GroupConfig ¶
type Logger ¶
func NewLogger ¶
NewLogger create new logger 自定义了gorm的日志输出,会屏蔽掉一些gorm的ErrRecordNotFound错误 将日志输出重定向到了cago的日志库
func (*Logger) ParamsFilter ¶
func (l *Logger) ParamsFilter(ctx context.Context, sql string, params ...interface{}) (string, []interface{})
ParamsFilter Trace print sql message
Click to show internal directories.
Click to hide internal directories.