mysql

Documentation

Index

• Variables
• type Config
  • func (c Config) Addr() string
  • func (c Config) Connect(logger zerolog.Logger) (*sql.DB, error)
  • func (c Config) IsSet() bool
  • func (c Config) String() string
• type LoggerFunc
  • func (lf LoggerFunc) Print(v ...interface{})

Variables

var (
	// NewYKKSM is an alias for the global YKKSM sql driver structure
	NewYKKSM = drivers.NewYKKSM
	// NewYKVal is an alias for the global YKVal sql driver structure
	NewYKVal = drivers.NewYKVal
	// NewYKAuth is an alias for the global YKAuth sql driver structure
	NewYKAuth = drivers.NewYKAuth
)

Types

type Config

type Config struct {
	Host     string
	Port     int
	Name     string
	User     string
	Password string
	TLS      bool
}

Config is the structure containing the information to create a mysql connection using roster

func (Config) Addr

func (c Config) Addr() string

Addr returns a connect string passed to the sql.Open command

func (Config) Connect

func (c Config) Connect(logger zerolog.Logger) (*sql.DB, error)

Connect use the configuration to initialize a sql.DB connection with MySQL

func (Config) IsSet

func (c Config) IsSet() bool

IsSet is a check to ensure config is properly set up

func (Config) String

func (c Config) String() string

String is a representation of the connection string with password obfuscated

type LoggerFunc

type LoggerFunc func(v ...interface{})

LoggerFunc is here to catch errors and pipe them to our logger https://github.com/go-sql-driver/mysql/blob/749ddf1598b47e3cd909414bda735fe790ef3d30/errors.go#L43

func (LoggerFunc) Print

func (lf LoggerFunc) Print(v ...interface{})

Print wraps a function to implement Logger interface