migrate

type Applied struct {
	Version   string
	Name      string
	Status    string
	Up        string
	Down      string
	AppliedAt time.Time
}

type Dialect interface {
	// Name is the value written in icpt.json.
	Name() string
	// Driver is the database/sql driver to open with.
	Driver() string
	// Placeholder renders the nth bind parameter, 1-based.
	Placeholder(n int) string
	// LedgerDDL returns the statements that create or upgrade the ledger.
	// Each must be safe to run on every invocation.
	LedgerDDL(table string) []string
	// TransactionalDDL reports whether a schema change can be rolled back.
	TransactionalDDL() bool
	// Lock takes a cross-process advisory lock, returning a release
	// function. A dialect without one returns a no-op release and no error;
	// see the note on each implementation for what that costs.
	Lock(ctx context.Context, conn *sql.Conn) (release func(context.Context), err error)
	// QuoteIdent quotes an identifier.
	QuoteIdent(s string) string
}

type DownOptions struct {
	// Steps is how many migrations to reverse, most recent first.
	Steps int
	// DryRun prints what would run and changes nothing.
	DryRun bool
}

type File struct {
	Version  string
	Name     string
	UpPath   string
	DownPath string
	Up       string
	Down     string
}

type Migrator struct {

	// Out receives progress lines. Defaults to discarding them.
	Out func(format string, args ...any)
	// contains filtered or unexported fields
}

type Options struct {
	// Name identifies the target in messages.
	Name string
	// DSN is the connection string. It comes from the environment, never
	// from a file in the repository.
	DSN string
	// Dir is the migration directory.
	Dir string
	// Dialect is "postgres", "mysql" or "sqlite". Empty means postgres.
	Dialect string
	// LedgerTable overrides the ledger's name, for a repository that
	// already has a table called schema_migrations belonging to something
	// else.
	LedgerTable string
	// NoLock skips the advisory lock. Only for a dialect or a deployment
	// where it cannot work; without it, two concurrent deploys can both
	// apply the same migration.
	NoLock bool
}

type Status struct {
	Version string
	Name    string
	// Applied is true when a successful ledger row exists.
	Applied bool
	// Missing is true for a ledger row with no file: the migration ran once
	// and the file has since been deleted or renamed, so the database cannot
	// be rebuilt from this checkout.
	Missing bool
	// Drifted is true when the file's SQL differs from what was recorded.
	Drifted    bool
	AppliedAt  time.Time
	StatusText string
}

type UpOptions struct {
	// To stops after this version. Empty applies everything pending.
	To string
	// DryRun prints what would run and changes nothing.
	DryRun bool
	// AllowDrift proceeds although an applied migration's file has changed.
	// Off by default: drift usually means somebody edited an applied
	// migration, which leaves the ledger unable to rebuild the database.
	AllowDrift bool
}