migrate

type BadVersionError string

type CodePackage struct {
	// contains filtered or unexported fields
}

type ErrorLineExtract struct {
	LineNum   int    // Line number starting with 1
	ColumnNum int    // Column number starting with 1
	Text      string // Text of the line without a new line character.
}

type IrreversibleMigrationError struct {
	// contains filtered or unexported fields
}

type Migration struct {
	// Sequence is a state identifier for the database schema after the up direction of the
	// [Migration] has been applied.
	Sequence int32
	// Name is a human-readable name or description of the [Migration].
	Name string

	// UpSQL declares SQL statements that brings the database up from its prior [Migration]
	// state. The [Migrator] will run the statements in a transaction unless the SQL contains
	// [disableTxPattern]. Cannot be used together with [UpFunc].
	UpSQL string
	// DownSQL declares SQL statements that brings the database back down to its prior
	// [Migration] state. The [Migrator] will run the statements in a transaction unless the SQL
	// contains [disableTxPattern]. Cannot be used together with [DownFunc].
	DownSQL string

	// DisableFuncTx, when true, tells the [Migrator] to not start a new transaction before
	// calling [UpFunc] (or [DownFunc]). Some SQL statements such as `create index concurrently`
	// cannot run within a transaction.
	DisableFuncTx bool
	// UpFunc is a Go function that brings the database up from its prior state [Migration]
	// state. Cannot be used together with [UpSQL].
	UpFunc MigrationFunc
	// DownFunc is a Go function that brings the database back down to its prior [Migration]
	// state. Cannot be used together with [DownSQL].
	DownFunc MigrationFunc
}

type MigrationFunc func(context.Context, *pgx.Conn) error

type MigrationPgError struct {
	MigrationName string
	Sql           string
	*pgconn.PgError
}

type Migrator struct {
	Migrations []*Migration
	OnStart    func(int32, string, string, string) // OnStart is called when a migration is run with the sequence, name, direction, and SQL
	Data       map[string]interface{}              // Data available to use in migrations
	// contains filtered or unexported fields
}

type MigratorOptions struct {
	// DisableTx causes the Migrator not to run migrations in a transaction.
	DisableTx bool
}

type NoMigrationsFoundError struct{}