root/golib
1
0
Fork 0
mirror of https://github.com/therootcompany/golib.git synced 2026-04-24 04:38:02 +00:00
Code Issues Projects Releases Wiki Activity
golib/skills/use-sqlmigrate/SKILL.md
AJ ONeal 0c1eb1f125
feat(skills): add sqlmigrate skill index and per-database skills 
Index skill (use-sqlmigrate) plus focused skills for CLI usage, Go
library integration, and per-database conventions (PostgreSQL,
MySQL/MariaDB, SQLite, SQL Server).
2026-04-09 17:08:32 -06:00

2.0 KiB
Raw Permalink Blame History

name, description, depends
name description depends
use-sqlmigrate Database migration tools for Go projects. Use when writing migrations, running sql-migrate CLI, embedding migrations in Go apps, or setting up new database schemas. Covers PostgreSQL, MySQL/MariaDB, SQLite, SQL Server.
go-stack

Overview

sqlmigrate is a feature-branch-friendly SQL migration system with two modes:

  1. CLI (sql-migrate) — generates shell scripts that pipe to sh
  2. Go library (sqlmigrate + backend) — embed migrations in Go binaries

Both use the same migration file format and _migrations tracking table.

Focused skills

Skill When to use
use-sql-migrate-cli CLI tool: init, create, up, down, sync, status
use-sql-migrate-golang Go library: embed migrations, Migrator interface, auto-migrate on startup
use-sql-migrate-postgres PostgreSQL: pgx connection, schema multi-tenancy, PGOPTIONS
use-sql-migrate-mysql MySQL/MariaDB: multiStatements DSN, MY_CNF, mariadb vs mysql
use-sql-migrate-sqlite SQLite: foreign keys pragma, modernc.org/sqlite driver
use-sql-migrate-sqlserver SQL Server: sqlcmd, TDS 8.0 encryption, SQLCMD* env vars

Migration file format

<yyyy-mm-dd>-<number>_<name>.<up|down>.sql
2026-04-05-001000_create-todos.up.sql
2026-04-05-001000_create-todos.down.sql
  • Numbers increment by 1000 (allows inserting between)
  • Initial migration: 0001-01-01-001000_init-migrations
  • Each .up.sql MUST end with INSERT INTO _migrations (name, id) VALUES ('<name>', '<8-hex-id>');
  • Each .down.sql MUST end with DELETE FROM _migrations WHERE id = '<8-hex-id>';

Key design decisions

  • Feature-branch friendly: no sequential numbering, no conflicts
  • ID-based matching: migrations matched by 8-char hex ID, not name — safe to rename
  • Shell-first CLI: generates reviewable scripts, never executes directly
  • Separate Go modules: each backend is its own module to avoid pulling unnecessary drivers