fortytw2 / trek

database migration and query management for Go

github.com/fortytw2/trek

A foot-gun free database access layer for Go.

General Features

• Cannot forget rows.Close() and leak database connections
• Transactions are handled via passed functions, nothing to forget to commit or rollback
• Integrated, concurrency-safe migrator built on fs.FS
• Sensible functions for running user code between migrations
• Test helpers for rapidly setting up, tearing down, and resetting databases
• Sensible connection tuning out of the box
• Distributed migration locking/running (any instance of a trek application can run migrations safely)

SQLite Specific Features (in-progress)

• Automatic threadsafe write serialization (SQLite only supports one writer at a time)
• sqlite.NewMemory to optionally create a purely in-memory database instance
• Clear explanation of build tags to statically compile a go program using sqlite3

Postgresql Specific Features

• Uses advisory locks for concurrency safe migrations

//go:embed schema/*.sql
var schema fs.FS

func TestStuff(t *testing.T) {
    // export POSTGRES_DSN=xyz to use a local, already running, postgres instance.
    db := pgtest.NewDB(t, schema)
    defer db.Shutdown()

    for _, c := range cases {
        // helpfully truncate all tables between test cases
        db.Truncate()
    }
}

//go:embed schema/*.sql
var schema fs.FS

func main() {
    db := postgresql.NewWrapper(os.Getenv("POSTGRES_DSN"), lounge.NewDefaultLog())

    // use db for fun and profit.
}

LICENSE

Do What The Fuck You Want To Public License (WTFPL), see LICENSE for full details