db_gorm

Documentation

Index

• Variables
• func Connect(options ...Options) (trx.Manager, error)
• func LoadTx(ctx trx.Context) (*gorm.DB, error)
• func NewClient(opts ...Options) (*gorm.DB, error)
• func NewTxManager(conn *gorm.DB) trx.Manager
• func WithTx(ctx context.Context, fn func(tx *gorm.DB) error) error
• type BaseCrud
• type Config
  • func NewConfig(opts ...Options) *Config
• type DBType
• type GormTransaction
  • func (t *GormTransaction) Commit() error
  • func (t *GormTransaction) Rollback()
  • func (t *GormTransaction) RollbackTo(name string)
  • func (t *GormTransaction) SavePoint(name string)
• type GormTxManager
  • func (t *GormTxManager) Start(ctx context.Context) (trx.Context, error)
• type ID
• type Logger
  • func NewLogger(options *LoggerOptions) *Logger
  • func (l *Logger) Error(_ context.Context, s string, i ...interface{})
  • func (l *Logger) Info(_ context.Context, s string, i ...interface{})
  • func (l *Logger) LogMode(level logger.LogLevel) logger.Interface
  • func (l *Logger) Trace(ctx context.Context, begin time.Time, ...)
  • func (l *Logger) Warn(_ context.Context, s string, i ...interface{})
• type LoggerOptions
• type Model
• type Options
  • func ParseMysqlConfig(v *viper.Viper) []Options
  • func ParseOptions(v *viper.Viper) []Options
  • func ParsePostgresSqlConfig(v *viper.Viper) []Options
  • func ParseSqliteOptions(v *viper.Viper) []Options
  • func WithDBType(dBType DBType) Options
  • func WithDsn(dsn string) Options
  • func WithShowSql(showSql bool) Options
  • func WithSlowThreshold(slowThreshold time.Duration) Options
• type SoftDeletion

Variables

var (
	DB *gorm.DB
)

Functions

func Connect

func Connect(options ...Options) (trx.Manager, error)

func LoadTx

func LoadTx(ctx trx.Context) (*gorm.DB, error)

func NewClient

func NewClient(opts ...Options) (*gorm.DB, error)

func NewTxManager

func NewTxManager(conn *gorm.DB) trx.Manager

func WithTx

func WithTx(ctx context.Context, fn func(tx *gorm.DB) error) error

Types

type BaseCrud

type BaseCrud interface {
	Create(context.Context) error
	Update(context.Context) error
	Delete(context.Context) error
	Find(context.Context) error
}

type Config

type Config struct {
	ShowSql       bool
	SlowThreshold time.Duration
	Dsn           string
	DBType        DBType
}

func NewConfig

func NewConfig(opts ...Options) *Config

type DBType

type DBType int

const (
	Mysql DBType = iota + 1
	Postgres
	SQLite
)

type GormTransaction

type GormTransaction struct {
	context.Context
	// contains filtered or unexported fields
}

func (*GormTransaction) Commit

func (t *GormTransaction) Commit() error

func (*GormTransaction) Rollback

func (t *GormTransaction) Rollback()

func (*GormTransaction) RollbackTo

func (t *GormTransaction) RollbackTo(name string)

func (*GormTransaction) SavePoint

func (t *GormTransaction) SavePoint(name string)

type GormTxManager

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

func (*GormTxManager) Start

func (t *GormTxManager) Start(ctx context.Context) (trx.Context, error)

type ID

type ID int64

type Logger

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

func NewLogger

func NewLogger(options *LoggerOptions) *Logger

func (*Logger) Error

func (l *Logger) Error(_ context.Context, s string, i ...interface{})

func (*Logger) Info

func (l *Logger) Info(_ context.Context, s string, i ...interface{})

func (*Logger) LogMode

func (l *Logger) LogMode(level logger.LogLevel) logger.Interface

func (*Logger) Trace

func (l *Logger) Trace(ctx context.Context, begin time.Time, fc func() (sql string, rowsAffected int64), err error)

func (*Logger) Warn

func (l *Logger) Warn(_ context.Context, s string, i ...interface{})

type LoggerOptions

type LoggerOptions struct {
	SlowThreshold             time.Duration
	IgnoreRecordNotFoundError bool
	LogLevel                  plumeLogger.Level
}

type Model

type Model struct {
	ID        ID
	CreatedAt time.Time
	UpdatedAt time.Time
}

type Options

type Options interface {
	Apply(c *Config)
}

func ParseMysqlConfig

func ParseMysqlConfig(v *viper.Viper) []Options

func ParseOptions

func ParseOptions(v *viper.Viper) []Options

func ParsePostgresSqlConfig

func ParsePostgresSqlConfig(v *viper.Viper) []Options

func ParseSqliteOptions

func ParseSqliteOptions(v *viper.Viper) []Options

func WithDBType

func WithDBType(dBType DBType) Options

func WithDsn

func WithDsn(dsn string) Options

WithDsn, dsn example: - for postgres: host=localhost user=postgres password=123456 dbname=gorm port=5432 sslmode=disable TimeZone=Asia/Shanghai - for mysql: root:123456@tcp(127.0.0.1:3306)/gorm?charset=utf8mb4&parseTime=True&loc=Local

func WithShowSql

func WithShowSql(showSql bool) Options

func WithSlowThreshold

func WithSlowThreshold(slowThreshold time.Duration) Options

type SoftDeletion

type SoftDeletion struct {
	DeletedAt gorm.DeletedAt
}