From 65432d7c298affc1a516b6cf0c2831d83943d4e6 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Fri, 17 Apr 2026 03:51:40 -0600 Subject: [PATCH] database/sqlmigrate/pgmigrate: add Schema field for qualified _migrations table Add Schema string field to Migrator. When set, Applied() constructs a schema-qualified table name via pgx.Identifier.Sanitize() rather than the bare "_migrations". New() signature is unchanged. Usage: runner := pgmigrate.New(conn) runner.Schema = "authz" --- database/sqlmigrate/pgmigrate/pgmigrate.go | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/database/sqlmigrate/pgmigrate/pgmigrate.go b/database/sqlmigrate/pgmigrate/pgmigrate.go index 3b4258b..618d125 100644 --- a/database/sqlmigrate/pgmigrate/pgmigrate.go +++ b/database/sqlmigrate/pgmigrate/pgmigrate.go @@ -2,12 +2,10 @@ // // # Multi-tenant schemas // -// For schema-based multi-tenancy, set search_path on the connection -// before creating the migrator: +// Pass a Schema to target a specific PostgreSQL schema: // -// conn, _ := pgx.Connect(ctx, pgURL) -// _, _ = conn.Exec(ctx, fmt.Sprintf("SET search_path TO %s", pgx.Identifier{schema}.Sanitize())) // runner := pgmigrate.New(conn) +// runner.Schema = "authz" // // Each schema gets its own _migrations table, so tenants are migrated // independently. The sql-migrate CLI supports this via TENANT_SCHEMA; @@ -27,7 +25,8 @@ import ( // Migrator implements sqlmigrate.Migrator using a single pgx.Conn. type Migrator struct { - Conn *pgx.Conn + Conn *pgx.Conn + Schema string // optional; qualifies the _migrations table (e.g. "authz") } // New creates a Migrator from the given connection. @@ -35,6 +34,15 @@ func New(conn *pgx.Conn) *Migrator { return &Migrator{Conn: conn} } +// migrationsTable returns the (optionally schema-qualified) _migrations table +// name, safe for direct interpolation into a query string. +func (r *Migrator) migrationsTable() string { + if r.Schema == "" { + return "_migrations" + } + return pgx.Identifier{r.Schema, "_migrations"}.Sanitize() +} + // verify interface compliance at compile time var _ sqlmigrate.Migrator = (*Migrator)(nil) @@ -73,7 +81,7 @@ func (r *Migrator) execInTx(ctx context.Context, sql string) error { // error may surface at rows.Err() rather than at Query(). Both sites // must check for it. func (r *Migrator) Applied(ctx context.Context) ([]sqlmigrate.Migration, error) { - rows, err := r.Conn.Query(ctx, "SELECT id, name FROM _migrations ORDER BY name") + rows, err := r.Conn.Query(ctx, "SELECT id, name FROM "+r.migrationsTable()+" ORDER BY name") if err != nil { if isUndefinedTable(err) { return nil, nil