sql

sql — SQL database abstraction with leader/follower routing

import "github.com/downsized-devs/sdk-go/sql"

Stability: Stable — see STABILITY.md

Multi-driver (MySQL, Postgres, SQLite) database client built on sqlx, with leader/follower split, prepared statements, transactions, and built-in Prometheus instrumentation.

Features

• Leader/follower routing (Leader(), Follower())
• Multi-driver: github.com/go-sql-driver/mysql, github.com/lib/pq, modernc.org/sqlite
• Transactions with BeginTx
• Prepared statements (Prepare)
• Automatic instrument metrics for query timings + connection pool stats
• ErrNotFound sentinel for "no rows" lookups

Installation

go get github.com/downsized-devs/sdk-go/sql

Quick Start

import (
    "context"

    "github.com/downsized-devs/sdk-go/instrument"
    "github.com/downsized-devs/sdk-go/logger"
    "github.com/downsized-devs/sdk-go/sql"
)

log := logger.Init(logger.Config{Level: "info"})
metrics := instrument.Init(instrument.Config{
    Metrics: instrument.MetricsConfig{Enabled: true},
})

db := sql.Init(sql.Config{
    Driver: "postgres",
    Leader: sql.ConnConfig{
        Host:     "leader",
        Port:     5432,
        DB:       "app",
        User:     "user",
        Password: "pass",
    },
    Follower: sql.ConnConfig{
        Host:     "follower",
        Port:     5432,
        DB:       "app",
        User:     "user",
        Password: "pass",
    },
}, log, metrics)
defer db.Stop()

var u User
if err := db.Follower().Get(ctx, &u, "SELECT * FROM users WHERE id=$1", 1); err != nil {
    if errors.Is(err, sql.ErrNotFound) { /* miss */ }
}

API Reference

ErrNotFound is returned by Get when the row is missing.

Configuration

Examples

Run a transaction

tx, err := db.Leader().BeginTx(ctx, sql.TxOptions{})
if err != nil { return err }
defer tx.Rollback()

if _, err := tx.Exec(ctx, "UPDATE accounts SET balance = balance - $1 WHERE id = $2", 100, 1); err != nil {
    return err
}
return tx.Commit()

Use a prepared statement

stmt, _ := db.Leader().Prepare(ctx, "INSERT INTO events(name, payload) VALUES (?, ?)")
defer stmt.Close()
for _, e := range events {
    _, _ = stmt.Exec(ctx, e.Name, e.Payload)
}

Error Handling

Dependencies

• Internal: codes, errors, instrument, logger
• External: github.com/jmoiron/sqlx, github.com/go-sql-driver/mysql, github.com/lib/pq, modernc.org/sqlite

Testing

go test ./sql/...

Five test files exercise sqlite in-memory; MySQL/Postgres tests require live databases.

Contributing

See CONTRIBUTING.md. Any change to the Interface or Command interface is breaking — coordinate with downstream services.

Related Packages

• query — dynamic WHERE/ORDER builder that consumes sql.Interface.
• null — nullable types matching SQL semantics.
• instrument — receives DB pool stats and query timings.
• redis — pair for cache-aside reads.