v1.0.0

code.nochebuena.dev/einherjar/db-mysql

Architecture Decisions Resolved

Decision	Outcome
Tx Commit/Rollback context	No ctx — honest `database/sql` contract; `sql.Tx` does not support per-call context
BeginTx vs Begin	Both — `BeginTx` exposes `*sql.TxOptions` for isolation level control
Write mutex	Not needed — MySQL is a server DB; concurrency handled server-side
GetExecutor nil guard	Explicit `if db == nil { return nil }` — avoids typed-nil interface pitfall
Health priority	`LevelCritical` — MySQL outage halts the service
Driver alias	`mysqldrv "github.com/go-sql-driver/mysql"` in errors.go — avoids package-name collision
Collation	Set at schema level (DDL), not in DSN — MariaDB 11.4+ collations exceed go-sql-driver's 1-byte handshake limit

API

import "code.nochebuena.dev/einherjar/db-mysql"

// Interfaces
type Executor interface {
    ExecContext(ctx context.Context, query string, args ...any) (sql.Result, error)
    QueryContext(ctx context.Context, query string, args ...any) (*sql.Rows, error)
    QueryRowContext(ctx context.Context, query string, args ...any) *sql.Row
}
type Tx interface {
    Executor
    Commit() error    // no ctx — database/sql limitation
    Rollback() error
}
type Provider interface {
    GetExecutor(ctx context.Context) Executor
    Begin(ctx context.Context) (Tx, error)
    BeginTx(ctx context.Context, opts *sql.TxOptions) (Tx, error)
    Ping(ctx context.Context) error
    HandleError(err error) error
}
type Component interface {
    lifecycle.Component
    observability.Checkable
    observability.Identifiable
    Provider
    Stats() sql.DBStats
}
type UnitOfWork interface {
    Do(ctx context.Context, fn func(ctx context.Context) error) error
}

// Config
type Config struct {
    Host            string `env:"EINHERJAR_MYSQL_HOST,required"`
    Port            int    `env:"EINHERJAR_MYSQL_PORT"                  envDefault:"3306"`
    User            string `env:"EINHERJAR_MYSQL_USER,required"`
    Password        string `env:"EINHERJAR_MYSQL_PASSWORD,required"`
    Name            string `env:"EINHERJAR_MYSQL_NAME,required"`
    MaxConns        int    `env:"EINHERJAR_MYSQL_MAX_CONNS"             envDefault:"5"`
    MinConns        int    `env:"EINHERJAR_MYSQL_MIN_CONNS"             envDefault:"2"`
    MaxConnLifetime string `env:"EINHERJAR_MYSQL_MAX_CONN_LIFETIME"     envDefault:"1h"`
    MaxConnIdleTime string `env:"EINHERJAR_MYSQL_MAX_CONN_IDLE_TIME"    envDefault:"30m"`
    Charset         string `env:"EINHERJAR_MYSQL_CHARSET"               envDefault:"utf8mb4"`
    Loc             string `env:"EINHERJAR_MYSQL_LOC"                   envDefault:"UTC"`
    ParseTime       string `env:"EINHERJAR_MYSQL_PARSE_TIME"            envDefault:"true"`
}
func DefaultConfig() Config
func (c Config) DSN() string

// Constructors
func New(logger logging.Logger, cfg Config) Component
func NewUnitOfWork(logger logging.Logger, client Provider) UnitOfWork

// Package-level error handler (also available as Provider.HandleError)
func HandleError(err error) error

Install

go get code.nochebuena.dev/einherjar/db-mysql@v1.0.0

Dependencies

Module	Version	Role
`code.nochebuena.dev/einherjar/contracts`	v1.0.0	`lifecycle.Component`, `observability.Checkable`, `logging.Logger`
`code.nochebuena.dev/einherjar/core`	v1.0.0	`xerrors`
`github.com/go-sql-driver/mysql`	v1.8.1	MySQL driver

Downloads

1 Release 1 Tag

Release v1.0.0 Stable

v1.0.0

Architecture Decisions Resolved

API

Install

Dependencies