db

Documentation

Index

• func ContainWithMasterOpt(opt []Option) bool
• func MaybeAddEqToWhere[T comparable](b *WhereBuilder, fieldEq T, column string, opt ...func(builder *WhereBuilder))
• func MaybeAddGtToWhere[T comparable](b *WhereBuilder, value T, column string, opt ...func(builder *WhereBuilder))
• func MaybeAddInToWhere[T any](b *WhereBuilder, fieldIn []T, column string, ...)
• func MaybeAddLikeToWhere(b *WhereBuilder, fieldLike string, column string, ...)
• func MaybeAddLteToWhere[T comparable](b *WhereBuilder, value T, column string, opt ...func(builder *WhereBuilder))
• func MaybeAddMultiLikeToWhere(b *WhereBuilder, fieldLikes []string, column string, ...)
• func RetryOnNotFound(fn func(opt ...Option) error, originalOpts []Option) error
• func WhereWithIndex(w *WhereBuilder)
• type Config
• type Option
  • func Debug() Option
  • func WithDeleted() Option
  • func WithMaster() Option
  • func WithSelectForUpdate() Option
  • func WithTransaction(tx *gorm.DB) Option
• type Provider
  • func NewDB(dialer gorm.Dialector, opts ...gorm.Option) (Provider, error)
  • func NewDBFromConfig(cfg *Config, opts ...gorm.Option) (Provider, error)
  • func NewTestDB(t tester, pos ...any) Provider
• type WhereBuilder
  • func NewWhereBuilder() *WhereBuilder
  • func (b *WhereBuilder) AddWhere(expr clause.Expression)
  • func (b *WhereBuilder) Build() (*clause.Where, error)
  • func (b *WhereBuilder) EqOrIn(column string, values ...any)
  • func (b *WhereBuilder) WithIndex()

Functions

func ContainWithMasterOpt

func ContainWithMasterOpt(opt []Option) bool

func MaybeAddEqToWhere

func MaybeAddEqToWhere[T comparable](b *WhereBuilder, fieldEq T, column string, opt ...func(builder *WhereBuilder))

func MaybeAddGtToWhere

func MaybeAddGtToWhere[T comparable](b *WhereBuilder, value T, column string, opt ...func(builder *WhereBuilder))

func MaybeAddInToWhere

func MaybeAddInToWhere[T any](b *WhereBuilder, fieldIn []T, column string, opt ...func(builder *WhereBuilder))

func MaybeAddLikeToWhere

func MaybeAddLikeToWhere(b *WhereBuilder, fieldLike string, column string, opt ...func(builder *WhereBuilder))

MaybeAddLikeToWhere 模糊搜索，字符串为空时不添加。会对原字符串中的通配符进行转义，如 % 转义为 \%。

func MaybeAddLteToWhere

func MaybeAddLteToWhere[T comparable](b *WhereBuilder, value T, column string, opt ...func(builder *WhereBuilder))

func MaybeAddMultiLikeToWhere

func MaybeAddMultiLikeToWhere(b *WhereBuilder, fieldLikes []string, column string, opt ...func(builder *WhereBuilder))

MaybeAddMultiLikeToWhere 某个字段多个模糊搜索条件.

func RetryOnNotFound

func RetryOnNotFound(fn func(opt ...Option) error, originalOpts []Option) error

RetryOnNotFound 如果 fn 返回 gorm.ErrRecordNotFound 错误，则使用主库重试一次。 用于处理主从同步延迟导致的读取不到数据的情况，注意 gorm.DB.Find 不会返回 ErrRecordNotFound 错误。

func WhereWithIndex

func WhereWithIndex(w *WhereBuilder)

Types

type Config

type Config struct {
	Timeout           time.Duration `yaml:"timeout"`
	ReadTimeout       time.Duration `yaml:"read_timeout"`
	WriteTimeout      time.Duration `yaml:"write_timeout"`
	User              string        `yaml:"user"`
	Password          string        `yaml:"password"`
	Loc               string        `yaml:"loc"`
	DBName            string        `yaml:"db_name"`
	DBCharset         string        `yaml:"db_charset"`
	DBHostname        string        `yaml:"db_hostname"`
	DBPort            string        `yaml:"db_port"`
	InterpolateParams bool          `yaml:"interpolate_params"`
	DSNParams         url.Values    `yaml:"dsn_params"`
	WithReturning     bool          `yaml:"with_returning"`
}

type Option

type Option func(option *option)

func Debug

func Debug() Option

Debug 启用调试模式

func WithDeleted

func WithDeleted() Option

WithDeleted 返回软删的数据

func WithMaster

func WithMaster() Option

WithMaster 强制读主库

func WithSelectForUpdate

func WithSelectForUpdate() Option

func WithTransaction

func WithTransaction(tx *gorm.DB) Option

WithTransaction 使用一个已有的事务

type Provider

type Provider interface {
	// NewSession 创建一个新的数据库会话
	NewSession(ctx context.Context, opts ...Option) *gorm.DB

	// Transaction 执行一个事务
	Transaction(ctx context.Context, fc func(tx *gorm.DB) error, opts ...Option) error
}

func NewDB

func NewDB(dialer gorm.Dialector, opts ...gorm.Option) (Provider, error)

NewDB 创建一个 db 实例

func NewDBFromConfig

func NewDBFromConfig(cfg *Config, opts ...gorm.Option) (Provider, error)

NewDBFromConfig 从配置创建一个 db 实例

func NewTestDB

func NewTestDB(t tester, pos ...any) Provider

NewTestDB 创建一个测试用的 db 实例, 创建失败会导致测试失败 提供的 pos 将会自动执行 migration.

type WhereBuilder

type WhereBuilder struct {
	// contains filtered or unexported fields
}

func NewWhereBuilder

func NewWhereBuilder() *WhereBuilder

func (*WhereBuilder) AddWhere

func (b *WhereBuilder) AddWhere(expr clause.Expression)

func (*WhereBuilder) Build

func (b *WhereBuilder) Build() (*clause.Where, error)

func (*WhereBuilder) EqOrIn

func (b *WhereBuilder) EqOrIn(column string, values ...any)

func (*WhereBuilder) WithIndex

func (b *WhereBuilder) WithIndex()