mirror of
https://github.com/therootcompany/golib.git
synced 2026-11-04 15:05:00 +00:00
AJ ONeal
a86d901d64
Extract a database-agnostic migration interface (Migrator) with Collect, Up, Down, and GetStatus orchestration. Each backend is its own Go module to avoid dependency bloat: - sqlmigrate: core interface, types, sentinel errors, file collection - pgmigrate: PostgreSQL via pgx/v5 - mymigrate: MySQL/MariaDB via go-sql-driver/mysql - litemigrate: SQLite via database/sql (caller imports driver) - msmigrate: SQL Server via go-mssqldb - shmigrate: shell script generation (file-path commands, not heredocs) Integrates shmigrate into the existing cmd/sql-migrate CLI, replacing its bespoke up/down/status logic with sqlmigrate orchestration.
87 lines
2.5 KiB
Go
87 lines
2.5 KiB
Go
// Package mymigrate implements sqlmigrate.Migrator for MySQL and MariaDB
|
|
// using database/sql with github.com/go-sql-driver/mysql.
|
|
//
|
|
// The caller must open the *sql.DB with multiStatements=true in the DSN
|
|
// for multi-statement migration files to work:
|
|
//
|
|
// db, err := sql.Open("mysql", "user:pass@tcp(host:3306)/dbname?multiStatements=true")
|
|
package mymigrate
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"errors"
|
|
"fmt"
|
|
|
|
"github.com/go-sql-driver/mysql"
|
|
|
|
"github.com/therootcompany/golib/database/sqlmigrate"
|
|
)
|
|
|
|
// Migrator implements sqlmigrate.Migrator using a *sql.DB with MySQL/MariaDB.
|
|
type Migrator struct {
|
|
DB *sql.DB
|
|
}
|
|
|
|
// New creates a Migrator from the given database handle.
|
|
func New(db *sql.DB) *Migrator {
|
|
return &Migrator{DB: db}
|
|
}
|
|
|
|
var _ sqlmigrate.Migrator = (*Migrator)(nil)
|
|
|
|
// ExecUp runs the up migration SQL inside a transaction.
|
|
func (m *Migrator) ExecUp(ctx context.Context, mig sqlmigrate.Migration) error {
|
|
return m.execInTx(ctx, mig.Up)
|
|
}
|
|
|
|
// ExecDown runs the down migration SQL inside a transaction.
|
|
func (m *Migrator) ExecDown(ctx context.Context, mig sqlmigrate.Migration) error {
|
|
return m.execInTx(ctx, mig.Down)
|
|
}
|
|
|
|
func (m *Migrator) execInTx(ctx context.Context, sqlStr string) error {
|
|
tx, err := m.DB.BeginTx(ctx, nil)
|
|
if err != nil {
|
|
return fmt.Errorf("%w: begin: %w", sqlmigrate.ErrExecFailed, err)
|
|
}
|
|
defer tx.Rollback() //nolint:errcheck
|
|
|
|
if _, err := tx.ExecContext(ctx, sqlStr); err != nil {
|
|
return fmt.Errorf("%w: exec: %w", sqlmigrate.ErrExecFailed, err)
|
|
}
|
|
|
|
if err := tx.Commit(); err != nil {
|
|
return fmt.Errorf("%w: commit: %w", sqlmigrate.ErrExecFailed, err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// Applied returns the names of all applied migrations from the _migrations table.
|
|
// Returns an empty slice if the table does not exist (MySQL error 1146).
|
|
func (m *Migrator) Applied(ctx context.Context) ([]string, error) {
|
|
rows, err := m.DB.QueryContext(ctx, "SELECT name FROM _migrations ORDER BY name")
|
|
if err != nil {
|
|
if mysqlErr, ok := errors.AsType[*mysql.MySQLError](err); ok && mysqlErr.Number == 1146 {
|
|
return nil, nil
|
|
}
|
|
return nil, fmt.Errorf("%w: %w", sqlmigrate.ErrQueryApplied, err)
|
|
}
|
|
defer rows.Close()
|
|
|
|
var names []string
|
|
for rows.Next() {
|
|
var name string
|
|
if err := rows.Scan(&name); err != nil {
|
|
return nil, fmt.Errorf("%w: scanning row: %w", sqlmigrate.ErrQueryApplied, err)
|
|
}
|
|
names = append(names, name)
|
|
}
|
|
if err := rows.Err(); err != nil {
|
|
return nil, fmt.Errorf("%w: reading rows: %w", sqlmigrate.ErrQueryApplied, err)
|
|
}
|
|
|
|
return names, nil
|
|
}
|