gormx

Documentation

Index

• Constants
• type Config
• type Manager
  • func New(configs []*Config) *Manager
  • func (m *Manager) Default() *gorm.DB
  • func (m *Manager) MustUse(ctx context.Context) *gorm.DB
  • func (m *Manager) SetWriters(writers ...io.Writer)
  • func (m *Manager) Use(ctx context.Context, key string) (*gorm.DB, error)
• type OpenTracingPlugin
  • func (op *OpenTracingPlugin) Initialize(db *gorm.DB) (err error)
  • func (op *OpenTracingPlugin) Name() string
• type SQL
  • func MockSQLTesting(t *testing.T) *SQL
  • func (s *SQL) Close()
  • func (s *SQL) DB() *_sql.DB
  • func (s *SQL) GormDB() *gorm.DB
  • func (s *SQL) Mock() sqlmock.Sqlmock
• type SimpleGormBridge
  • func NewBridge(db *gorm.DB, key string) SimpleGormBridge

Constants

const (
	SQLModeDebug   = "debug"
	SQLModeRelease = "release"
)

Types

type Config

type Config struct {
	Usage       string // use to manage connection
	RunMode     string // debug, release
	DSN         string // root:root@tcp(127.0.0.1:3306)
	Database    string // default database
	MaxIdleConn int
	MaxOpenConn int
	MaxLifeTime int
}

Config init config

type Manager

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

Manager store all gorm db engine according to the config usage key

func New

func New(configs []*Config) *Manager

New return a gorm db Manager

func (*Manager) Default

func (m *Manager) Default() *gorm.DB

Default return default engine, default is the first config in configs

func (*Manager) MustUse

func (m *Manager) MustUse(ctx context.Context) *gorm.DB

MustUse return default engine, default is the first config in configs, if err, got panic

func (*Manager) SetWriters

func (m *Manager) SetWriters(writers ...io.Writer)

SetWriters set gorm log writers, default is stdout

func (*Manager) Use

func (m *Manager) Use(ctx context.Context, key string) (*gorm.DB, error)

Use return engine from incoming key

type OpenTracingPlugin

type OpenTracingPlugin struct{}

func (*OpenTracingPlugin) Initialize

func (op *OpenTracingPlugin) Initialize(db *gorm.DB) (err error)

func (*OpenTracingPlugin) Name

func (op *OpenTracingPlugin) Name() string

type SQL

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

func MockSQLTesting

func MockSQLTesting(t *testing.T) *SQL

func (*SQL) Close

func (s *SQL) Close()

func (*SQL) DB

func (s *SQL) DB() *_sql.DB

func (*SQL) GormDB

func (s *SQL) GormDB() *gorm.DB

func (*SQL) Mock

func (s *SQL) Mock() sqlmock.Sqlmock

type SimpleGormBridge

type SimpleGormBridge interface {
	Create(t schema.Tabler, v interface{}) error
	Update(t schema.Tabler, v interface{}, kv interface{}) error
	Delete(v schema.Tabler, kv interface{}) (int64, error)
	First(t schema.Tabler, v interface{}, kv interface{}) error
}

func NewBridge

func NewBridge(db *gorm.DB, key string) SimpleGormBridge