Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

database

package

Go to main page

Versions in this module

v1

v1.3.1

Mar 10, 2026

v1.3.0

Mar 10, 2026

v1.2.1

Mar 10, 2026

v1.2.0

Mar 9, 2026

v1.1.1

Mar 9, 2026

v1.1.0

Mar 9, 2026

Changes in this version

+ const MaxRetryAttempts

+ type Connector interface

+ Connect func(ctx context.Context) (*gorm.DB, error)

+ type DB interface

+ Exec func(ctx context.Context, query string, args ...interface{}) error

+ Query func(ctx context.Context, dest interface{}, query string, args ...interface{}) error

+ Raw func() *gorm.DB

+ SQLDB func() (*sql.DB, error)

+ Tx func(ctx context.Context, fn func(tx *gorm.DB) error, opts ...*sql.TxOptions) error

type Database

+ func NewWithOptions(config *Config, opts ...Option) (*Database, error)

+ func (d *Database) BeginTx(ctx context.Context, opts ...*sql.TxOptions) (*gorm.DB, error)

+ func (d *Database) CloseWithContext(ctx context.Context) error

+ func (d *Database) Exec(ctx context.Context, query string, args ...interface{}) error

+ func (d *Database) Query(ctx context.Context, dest interface{}, query string, args ...interface{}) error

+ func (d *Database) Raw() *gorm.DB

+ func (d *Database) SQLDB() (*sql.DB, error)

+ func (d *Database) Tx(ctx context.Context, fn func(tx *gorm.DB) error, opts ...*sql.TxOptions) error

+ type Executor interface

+ BeginTx func(ctx context.Context, opts ...*sql.TxOptions) (*gorm.DB, error)

+ Exec func(ctx context.Context, query string, args ...interface{}) error

+ Query func(ctx context.Context, dest interface{}, query string, args ...interface{}) error

+ Tx func(ctx context.Context, fn func(tx *gorm.DB) error, opts ...*sql.TxOptions) error

+ type HealthChecker interface

+ HealthCheck func() error

+ HealthCheckWithContext func(ctx context.Context) *HealthStatus

+ Ping func() error

+ type Hooks struct

+ AfterClose func(ctx context.Context, closeErr error)

+ AfterConnect func(db *gorm.DB)

+ AfterProbe func(ctx context.Context, probeErr error)

+ BeforeClose func(ctx context.Context, db *gorm.DB) error

+ BeforeConnect func(cfg *Config)

+ BeforeProbe func(ctx context.Context) error

+ type Option func(*Database)

+ func WithConnector(connector Connector) Option

+ func WithExecutor(executor Executor) Option

+ func WithHealthChecker(healthChecker HealthChecker) Option

+ func WithHooks(h Hooks) Option

+ func WithLogger(l SimpleLogger) Option

+ type PoolConfigurator interface

+ Configure func(db *gorm.DB) error

v1.0.2

Dec 24, 2025

v1.0.1-beta.1

Oct 22, 2025

v1.0.0

Jul 25, 2025

Changes in this version

+ const DefaultCharset

+ const DefaultConnMaxIdleTime

+ const DefaultConnMaxLifetime

+ const DefaultLogLevel

+ const DefaultMaxIdleConns

+ const DefaultMaxOpenConns

+ const DefaultPostgresSSLMode

+ const DefaultPostgresTimezone

+ const DefaultRetryBackoffFactor

+ const DefaultRetryInitialDelay

+ const DefaultRetryJitterEnabled

+ const DefaultRetryMaxAttempts

+ const DefaultRetryMaxDelay

+ const DefaultSlowThreshold

+ const DefaultTimezone

+ var ErrConnectionFailed = errors.New("数据库连接失败")

+ var ErrInvalidCharset = errors.New("无效的字符集")

+ var ErrInvalidConnPool = errors.New("连接池配置无效")

+ var ErrInvalidLogLevel = errors.New("无效的日志级别")

+ var ErrInvalidPort = errors.New("数据库端口无效")

+ var ErrInvalidSSLMode = errors.New("无效的SSL模式")

+ var ErrInvalidTimeout = errors.New("超时配置无效")

+ var ErrMigrationFailed = errors.New("数据库迁移失败")

+ var ErrMissingDBPath = errors.New("SQLite数据库路径不能为空")

+ var ErrMissingDatabase = errors.New("数据库名不能为空")

+ var ErrMissingDriver = errors.New("数据库驱动不能为空")

+ var ErrMissingHost = errors.New("数据库主机不能为空")

+ var ErrMissingUsername = errors.New("数据库用户名不能为空")

+ var ErrQueryFailed = errors.New("查询执行失败")

+ var ErrTransactionFailed = errors.New("事务执行失败")

+ var ErrUnsupportedDriver = errors.New("不支持的数据库驱动")

+ func IsConnectionError(err error) bool

+ func IsValidLogLevel(level string) bool

+ func IsValidationError(err error) bool

+ func NewGormLogger(l SimpleLogger, logLevel string) logger.Interface

+ type Config struct

+ Charset string

+ Colorful bool

+ ConnMaxIdleTime time.Duration

+ ConnMaxLifetime time.Duration

+ CustomLogger logger.Interface

+ Database string

+ DisableForeignKey bool

+ Driver string

+ DryRun bool

+ Host string

+ IgnoreRecordNotFoundError bool

+ LogLevel string

+ MaxIdleConns int

+ MaxOpenConns int

+ ParameterizedQueries bool

+ Password string

+ Port int

+ PrepareStmt bool

+ RetryBackoffFactor float64

+ RetryEnabled bool

+ RetryInitialDelay time.Duration

+ RetryJitterEnabled bool

+ RetryMaxAttempts int

+ RetryMaxDelay time.Duration

+ SSLMode string

+ SingularTable bool

+ SlowThreshold time.Duration

+ TablePrefix string

+ Timezone string

+ Username string

+ func (c *Config) SafeString() string

+ func (c *Config) SetDefaults()

+ func (c *Config) Validate() error

+ func (d *Config) SetCustomLogger(l SimpleLogger, level string)

+ type ContextualLogger interface

+ ErrorWithContext func(ctx context.Context, msg string, fields ...interface{})

+ InfoWithContext func(ctx context.Context, msg string, fields ...interface{})

+ WarnWithContext func(ctx context.Context, msg string, fields ...interface{})

+ type Database struct

+ func New(config *Config) (*Database, error)

+ func (d *Database) AutoMigrate(dst ...interface{}) error

+ func (d *Database) Close() error

+ func (d *Database) GetConfig() Config

+ func (d *Database) GetDB() *gorm.DB

+ func (d *Database) GetDriver() string

+ func (d *Database) HealthCheck() error

+ func (d *Database) HealthCheckWithContext(ctx context.Context) *HealthStatus

+ func (d *Database) IsConnected() bool

+ func (d *Database) IsReadOnly() bool

+ func (d *Database) Ping() error

+ func (d *Database) Stats() PoolStats

+ func (d *Database) Transaction(fn func(*gorm.DB) error) error

+ func (d *Database) TransactionWithContext(ctx context.Context, fn func(*gorm.DB) error) error

+ func (d *Database) WithContext(ctx context.Context) *gorm.DB

+ type DatabaseError struct

+ Context map[string]interface{}

+ Err error

+ Operation string

+ Type ErrorType

+ func NewDatabaseError(errorType ErrorType, operation string, err error) *DatabaseError

+ func (e *DatabaseError) Error() string

+ func (e *DatabaseError) Is(target error) bool

+ func (e *DatabaseError) Unwrap() error

+ func (e *DatabaseError) WithContext(key string, value interface{}) *DatabaseError

+ type ErrorType int

+ const ErrorTypeConnection

+ const ErrorTypeMigration

+ const ErrorTypeQuery

+ const ErrorTypeTransaction

+ const ErrorTypeValidation

+ type GORMLogger struct

+ func (g *GORMLogger) Error(ctx context.Context, msg string, data ...interface{})

+ func (g *GORMLogger) Info(ctx context.Context, msg string, data ...interface{})

+ func (g *GORMLogger) LogMode(l logger.LogLevel) logger.Interface

+ func (g *GORMLogger) Trace(ctx context.Context, begin time.Time, ...)

+ func (g *GORMLogger) Warn(ctx context.Context, msg string, data ...interface{})

+ type HealthStatus struct

+ Driver string

+ Errors []string

+ Healthy bool

+ Stats PoolStats

+ Timestamp time.Time

+ Warnings []string

+ type PoolStats struct

+ IdleConnections int

+ MaxIdleClosed int64

+ MaxLifetimeClosed int64

+ OpenConnections int

+ WaitCount int64

+ WaitDuration time.Duration

+ type SimpleLogger interface

+ Error func(msg string, fields ...interface{})

+ Info func(msg string, fields ...interface{})

+ Warn func(msg string, fields ...interface{})