mysql

Documentation

Index

• func Close(dt DBType) error
• func CloseAll() error
• func ConnectReader(ctx context.Context, env aveo.Env) (*sql.DB, error)
• func ConnectWriter(ctx context.Context, env aveo.Env) (*sql.DB, error)
• func PingDB(dt DBType) error
• type Config
  • func NewConfig(ctx context.Context, env aveo.Env, dt string) Config
• type DBType

Functions

func Close

func Close(dt DBType) error

Close a database connection

func CloseAll

func CloseAll() error

CloseAll closes all of database connections

func ConnectReader

func ConnectReader(ctx context.Context, env aveo.Env) (*sql.DB, error)

ConnectReader creates database connection for reader DB

func ConnectWriter

func ConnectWriter(ctx context.Context, env aveo.Env) (*sql.DB, error)

ConnectWriter creates database connection for writer DB

func PingDB

func PingDB(dt DBType) error

PingDB ...

Types

type Config

type Config struct {
	DBName               string `env:"DATABASE_NAME"`
	DBHost               string `env:"DATABASE_HOST"`
	DBPort               string `env:"DATABASE_PORT"`
	DBUser               string `env:"DATABASE_USER"`
	DBPassword           string `env:"DATABASE_PASSWORD"`
	DBMaxIdleConnections int    `env:"DATABASE_MAX_IDLE_CONNECTIONS"`
	DBMaxOpenConnections int    `env:"DATABASE_MAX_OPEN_CONNECTIONS"`
}

Config ...

func NewConfig

func NewConfig(ctx context.Context, env aveo.Env, dt string) Config

NewConfig creates a new Config

type DBType

type DBType string

DBType is the data type to define database type

const (

	// DriverName ...
	DriverName = "mysql"

	// TypeReader means to access reader DB
	TypeReader DBType = "READER"
	// TypeWriter means to access writer DB
	TypeWriter DBType = "WRITER"
)