mysql

Documentation

Index

• Constants
• func RawMysqlConn(config *Config) (*sql.DB, error)
• type Config
  • func ConfigFromEnv() *Config
  • func ConfigFromEnvPrefix(prefix string) *Config
  • func (c *Config) String() string
  • func (c *Config) Valid() error
• type DBExecuter
• type InvalidateFunc
• type Manager
  • func NewMysqlManager(config *Config) (Manager, error)
  • func NewMysqlManagerWithMetrics(config *Config) (Manager, error)
• type RowScanner

Constants

const (
	HighQPSMaxOpenConns = 100
	AppNameLengthMax    = 32
)

Functions

func RawMysqlConn

func RawMysqlConn(config *Config) (*sql.DB, error)

Types

type Config

type Config struct {
	Username         string        `default:"root"`
	Password         string        `default:"my-secret"`
	Host             string        `default:"localhost"`
	Port             int           `default:"3306"`
	DBName           string        `default:"test_db"`
	MaxOpenConns     int           `default:"10"`
	MaxIdleConns     int           `default:"10"`
	MaxLifetime      time.Duration `default:"60s"`
	AppName          string        `default:""`
	EnablePrometheus bool          `default:"true"`
}

func ConfigFromEnv

func ConfigFromEnv() *Config

func ConfigFromEnvPrefix

func ConfigFromEnvPrefix(prefix string) *Config

func (*Config) String

func (c *Config) String() string

func (*Config) Valid

func (c *Config) Valid() error

type DBExecuter

type DBExecuter interface {
	Invalidate(InvalidateFunc) error
	Query(ctx context.Context, unprepared string, args ...interface{}) (*sql.Rows, error)
	Exec(ctx context.Context, unprepared string, args ...interface{}) (sql.Result, error)
	Prepare(ctx context.Context, query string) (*sql.Stmt, error)
}

DBExecuter wraps transaction and non-transaction db calls

type InvalidateFunc

type InvalidateFunc = func() error

type Manager

type Manager interface {
	Ping() error
	Close() error
	GetConn() *sql.DB

	GetExec() DBExecuter
	Transact(txFunc func(DBExecuter) (interface{}, error)) (resp interface{}, err error)
}

Manager wraps the underlying *sql.DB to provide a uniformed interface of getting a simple or transactional SQL executor.

func NewMysqlManager

func NewMysqlManager(config *Config) (Manager, error)

func NewMysqlManagerWithMetrics

func NewMysqlManagerWithMetrics(config *Config) (Manager, error)

type RowScanner

type RowScanner interface {
	Scan(dest ...interface{}) error
}