mysql

Documentation

Index

• Constants
• func NonEmptyOrNil(str string) interface{}
• func RawMysqlConn(config *Config) (*sql.DB, error)
• type Config
  • func ConfigFromEnv() *Config
  • func ConfigFromEnvPrefix(prefix string) *Config
  • func (c *Config) String() string
• type DBExecuter
• type Manager
  • func NewMysqlManager(config *Config) (Manager, error)
  • func NewMysqlManagerWithMetrics(config *Config, gauge *prometheus.GaugeVec, execCounter *prometheus.CounterVec, ...) (Manager, error)
• type RowScanner

Constants

const (
	HighQPSMaxOpenConns = 100
)

Functions

func NonEmptyOrNil

func NonEmptyOrNil(str string) interface{}

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"`
}

func ConfigFromEnv

func ConfigFromEnv() *Config

func ConfigFromEnvPrefix

func ConfigFromEnvPrefix(prefix string) *Config

func (*Config) String

func (c *Config) String() string

type DBExecuter

type DBExecuter interface {
	Invalidate(func()) 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 Manager

type Manager interface {
	CheckStmts(service string, unprepared map[string]string) (map[string]*sql.Stmt, error)
	Ping() error
	Close()
	GetConn() *sql.DB

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

Manager is an interface to helper functions

func NewMysqlManager

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

func NewMysqlManagerWithMetrics

func NewMysqlManagerWithMetrics(config *Config, gauge *prometheus.GaugeVec, execCounter *prometheus.CounterVec, execHistogram *prometheus.HistogramVec) (Manager, error)

type RowScanner

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