lspostgres

func Computed ¶

func Computed[T ConnPtr](name string, action func(context.Context, T) error, opts ...libschema.MigrationOption) libschema.Migration

Computed defines a migration that runs arbitrary Go code. The signature of the action callback determines if the migration runs transactionally or if it runs outside a transaction:

func(context.Context, *sql.Tx) error // run transactionlly
func(context.Context, *sql.DB) error // run non-transactionally

func Generate ¶

func Generate(name string, generator func(context.Context, *sql.Tx) string, opts ...libschema.MigrationOption) libschema.Migration

Generate registers a callback that returns a migration in a string. To run the migration, libschema automatically chooses transactional (*sql.Tx) or non-transactional (*sql.DB) execution based on Postgres rules for statements that cannot run inside a transaction (e.g. CREATE INDEX CONCURRENTLY, VACUUM FULL, CREATE DATABASE). If the migration will be run transactionally, it will run in the same transaction as the callback that returned the string. If it runs non-transactionally, the transaction that returned the string will be idle (hanging around) while the migration runs. The choice of transactional vs non-transactional Can be overridden with ForceNonTransactional() or ForceTransactional() options.

func New ¶

func New(log *internal.Log, dbName string, schema *libschema.Schema, db *sql.DB) (*libschema.Database, error)

New creates a libschema.Database with a postgres driver built in. The dbName parameter is used internally by libschema, but does not affect where migrations are actually applied.

func Script ¶

func Script(name string, sqlText string, opts ...libschema.MigrationOption) libschema.Migration

Script defines a literal SQL statement migration. To run the migration, libschema automatically chooses transactional (*sql.Tx) or non-transactional (*sql.DB) execution based on Postgres rules for statements that cannot run inside a transaction (e.g. CREATE INDEX CONCURRENTLY, VACUUM FULL, CREATE DATABASE). The choice of transactional vs non-transactional Can be overridden with ForceNonTransactional() or ForceTransactional() options.