Documentation
¶
Index ¶
- func EnableContextAwareSQLLogging(db *gorm.DB, fallbackLogger debugger.LoggerInterface, opts ...interface{}) *gorm.DB
- func EnableSQLLogging(db *gorm.DB, debuggerLogger debugger.LoggerInterface, opts ...interface{}) *gorm.DB
- func WithContextAwareSQLLogging(fallbackLogger debugger.LoggerInterface, opts ...interface{}) gorm.Option
- func WithSQLLogging(debuggerLogger debugger.LoggerInterface, opts ...interface{}) gorm.Option
- type GormDebuggerLogger
- func (l *GormDebuggerLogger) Error(ctx context.Context, msg string, data ...interface{})
- func (l *GormDebuggerLogger) GetDebuggerLogger() debugger.LoggerInterface
- func (l *GormDebuggerLogger) Info(ctx context.Context, msg string, data ...interface{})
- func (l *GormDebuggerLogger) IsContextAware() bool
- func (l *GormDebuggerLogger) LogMode(level logger.LogLevel) logger.Interface
- func (l *GormDebuggerLogger) SetDebuggerLogger(debuggerLogger debugger.LoggerInterface)
- func (l *GormDebuggerLogger) Trace(ctx context.Context, begin time.Time, ...)
- func (l *GormDebuggerLogger) Warn(ctx context.Context, msg string, data ...interface{})
- type Instance
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EnableContextAwareSQLLogging ¶ added in v0.15.0
func EnableContextAwareSQLLogging(db *gorm.DB, fallbackLogger debugger.LoggerInterface, opts ...interface{}) *gorm.DB
EnableContextAwareSQLLogging 为GORM实例启用上下文感知的SQL日志记录
与 EnableSQLLogging 的区别:本函数全局只需在初始化阶段调用一次, 运行期每条SQL会依据 context.Context 中携带的请求级Logger路由到对应请求的日志中, 不会因并发请求互相覆盖而导致日志串台。
参数:
- db: GORM数据库实例
- fallbackLogger: 兜底日志记录器,context 中无Logger时使用,建议传 GetMainLogger()
- opts: 可选参数,语义同 EnableSQLLogging(日志级别、慢查询阈值)
返回:
- *gorm.DB: 配置好SQL日志的GORM实例
使用示例:
orm.EnableContextAwareSQLLogging(db, dbg.GetMainLogger()) orm.EnableContextAwareSQLLogging(db, dbg.GetMainLogger(), debugger.LevelInfo, 100*time.Millisecond)
func EnableSQLLogging ¶ added in v0.13.8
func EnableSQLLogging(db *gorm.DB, debuggerLogger debugger.LoggerInterface, opts ...interface{}) *gorm.DB
EnableSQLLogging 为GORM实例启用SQL日志记录(固定Logger模式) 支持统一的日志级别配置,优先使用debugger的日志级别设置 参数:
- db: GORM数据库实例
- debuggerLogger: debugger日志记录器
- opts: 可选参数,可以是logger.LogLevel或time.Duration
- 第一个参数:日志级别(可选,如果不提供则使用debugger的日志级别)
- 第二个参数:慢查询阈值(可选,默认200ms)
返回:
- *gorm.DB: 配置好SQL日志的GORM实例
func WithContextAwareSQLLogging ¶ added in v0.15.0
func WithContextAwareSQLLogging(fallbackLogger debugger.LoggerInterface, opts ...interface{}) gorm.Option
WithContextAwareSQLLogging GORM配置选项,用于启用上下文感知的SQL日志记录 使用示例:
db, err := gorm.Open(mysql.Open(dsn), WithContextAwareSQLLogging(dbg.GetMainLogger())) db, err := gorm.Open(mysql.Open(dsn), WithContextAwareSQLLogging(dbg.GetMainLogger(), debugger.LevelInfo, 100*time.Millisecond))
func WithSQLLogging ¶ added in v0.13.8
func WithSQLLogging(debuggerLogger debugger.LoggerInterface, opts ...interface{}) gorm.Option
WithSQLLogging GORM配置选项,用于启用SQL日志记录(固定Logger模式) 支持统一的日志级别配置,优先使用debugger的日志级别设置 使用示例:
db, err := gorm.Open(mysql.Open(dsn), WithSQLLogging(debuggerLogger)) db, err := gorm.Open(mysql.Open(dsn), WithSQLLogging(debuggerLogger, logger.Info)) db, err := gorm.Open(mysql.Open(dsn), WithSQLLogging(debuggerLogger, "debug", 100*time.Millisecond))
Types ¶
type GormDebuggerLogger ¶ added in v0.13.8
type GormDebuggerLogger struct {
// contains filtered or unexported fields
}
GormDebuggerLogger 实现GORM的logger.Interface接口,将SQL执行情况记录到debugger中
支持两种工作模式:
- 固定Logger模式(contextAware=false,默认):所有SQL日志写入构造时注入的Logger, 适用于只有单一日志目标、或按开关临时打开SQL日志的场景;
- 上下文感知模式(contextAware=true):每次记录时优先从 context.Context 中取请求级Logger, 取不到才回退到兜底Logger。全局只需注入一次,天然并发安全, 适用于需要把SQL日志归属到具体HTTP请求的场景。
func NewContextAwareGormDebuggerLogger ¶ added in v0.15.0
func NewContextAwareGormDebuggerLogger(fallbackLogger debugger.LoggerInterface, logLevel debugger.LogLevel, slowThreshold time.Duration) *GormDebuggerLogger
NewContextAwareGormDebuggerLogger 创建上下文感知模式的GORM调试日志记录器
与固定Logger模式的区别:本模式下SQL日志会写入 context.Context 中携带的请求级Logger, 因此可在高并发场景下把每条SQL正确归属到对应的请求详情,不会被并发请求互相覆盖。
参数:
- fallbackLogger: 兜底日志记录器,当 context 中不存在Logger时使用; 建议传入 debugger.Debugger 的 GetMainLogger(),使定时任务、启动迁移等 无请求上下文的SQL也能落盘;传 nil 表示此类SQL直接丢弃
- logLevel: GORM日志级别
- slowThreshold: 慢查询阈值
返回:
- *GormDebuggerLogger: 上下文感知模式的GORM调试日志记录器实例
使用示例:
gormLogger := orm.NewContextAwareGormDebuggerLogger(dbg.GetMainLogger(), debugger.LevelInfo, 200*time.Millisecond) db.Config.Logger = gormLogger
func NewGormDebuggerLogger ¶ added in v0.13.8
func NewGormDebuggerLogger(debuggerLogger debugger.LoggerInterface, logLevel debugger.LogLevel, slowThreshold time.Duration) *GormDebuggerLogger
NewGormDebuggerLogger 创建GORM调试日志记录器(固定Logger模式) 参数:
- debuggerLogger: debugger组件的日志记录器实例
- logLevel: GORM日志级别
- slowThreshold: 慢查询阈值
返回:
- *GormDebuggerLogger: GORM调试日志记录器实例
func (*GormDebuggerLogger) Error ¶ added in v0.13.8
func (l *GormDebuggerLogger) Error(ctx context.Context, msg string, data ...interface{})
Error 记录错误级别日志
func (*GormDebuggerLogger) GetDebuggerLogger ¶ added in v0.13.8
func (l *GormDebuggerLogger) GetDebuggerLogger() debugger.LoggerInterface
GetDebuggerLogger 获取当前的debugger日志记录器
func (*GormDebuggerLogger) Info ¶ added in v0.13.8
func (l *GormDebuggerLogger) Info(ctx context.Context, msg string, data ...interface{})
Info 记录信息级别日志
func (*GormDebuggerLogger) IsContextAware ¶ added in v0.15.0
func (l *GormDebuggerLogger) IsContextAware() bool
IsContextAware 判断当前是否处于上下文感知模式
返回:
- bool: 上下文感知模式返回 true,固定Logger模式返回 false
func (*GormDebuggerLogger) LogMode ¶ added in v0.13.8
func (l *GormDebuggerLogger) LogMode(level logger.LogLevel) logger.Interface
LogMode 设置日志级别
func (*GormDebuggerLogger) SetDebuggerLogger ¶ added in v0.13.8
func (l *GormDebuggerLogger) SetDebuggerLogger(debuggerLogger debugger.LoggerInterface)
SetDebuggerLogger 设置debugger日志记录器 用于在运行时动态更换日志记录器
注意:本方法只替换兜底Logger,不会关闭上下文感知模式; 固定Logger模式下等价于更换全部SQL日志的写入目标。
type Instance ¶
type Instance interface {
// GetDb 获取数据库连接
GetDb() *gorm.DB
// GetConf 获取数据库配置信息,类型:jcbaseGo.DbStruct 或 jcbaseGo.SqlLiteStruct
GetConf() interface{}
// SetDebuggerLogger 设置debugger日志记录器
SetDebuggerLogger(debuggerLogger debugger.LoggerInterface)
// GetDebuggerLogger 获取debugger日志记录器
GetDebuggerLogger() debugger.LoggerInterface
}
Instance 定义数据库实例接口
Directories
¶
| Path | Synopsis |
|---|---|
|
Package mysql 提供 MySQL 数据库的 ORM 封装,基于 GORM,包含连接创建、连接池配置、表名处理与分页查询等辅助方法。
|
Package mysql 提供 MySQL 数据库的 ORM 封装,基于 GORM,包含连接创建、连接池配置、表名处理与分页查询等辅助方法。 |
|
Package sqlite 提供 SQLite 数据库的 ORM 封装,基于 GORM,包含连接管理、表名处理与分页查询等辅助方法。
|
Package sqlite 提供 SQLite 数据库的 ORM 封装,基于 GORM,包含连接管理、表名处理与分页查询等辅助方法。 |