migratekit

Sep 27, 2026

Changes in this version

+ var ErrSchemaMismatch = errors.New("migratekit: schema does not match its ledger")

+ func SchemaDiff(ctx context.Context, db *sql.DB, schema, reference string) ([]string, error)

+ type Conversion struct

+ Fallback string

+ Name string

+ Replaces int

+ Retired Render

+ SQL func(schema string) (string, error)

type Postgres

+ func (p *Postgres) WithConversions(conversions ...Conversion) *Postgres

+ func (p *Postgres) WithRender(render Render) *Postgres

+ func (p *Postgres) WithStrictIntegrity() *Postgres

+ type Render func(schema string) ([]Migration, error)

Aug 11, 2026

retracted

Changes in this version

type Postgres

+ func (p *Postgres) WithStrictContent() *Postgres

Sep 20, 2026

Changes in this version

+ func Sequence(name string) (int64, error)

+ func ValidateSequences(migrations []Migration) error

Sep 19, 2026

retracted

Changes in this version

+ var ErrBaselineUnsafe = errors.New("migratekit: refusing to baseline")

+ type BaselinePlan struct

+ Record []Migration

+ Retire []AppliedRecord

+ Untouched []AppliedRecord

+ func PlanBaseline(applied map[string]AppliedRecord, migrations []Migration) (BaselinePlan, error)

+ func (p BaselinePlan) Empty() bool

+ type BaselineRequest struct

+ SchemaVerified bool

type Postgres

+ func (p *Postgres) Baseline(ctx context.Context, migrations []Migration, req BaselineRequest) (results []RepairResult, err error)

Sep 19, 2026

retracted

Changes in this version

+ const StatusApplied

+ const StatusFailed

+ const StatusRunning

+ var ErrNothingToRepair = errors.New("migratekit: nothing to repair")

+ var ErrRepairInCI = errors.New("migratekit: repairs are operator-runtime verbs and refuse to run in CI")

+ func CheckChain(names []string) error

+ func CheckChainFS(fsys fs.FS, dir string, requireLinks bool) error

+ func CheckRepairTotality(fsys fs.FS, dir string) error

+ func ContentDigest(content string) string

+ func DetectCI() (string, bool)

+ func RepairTotalityFindings(filePath, body string) []string

+ func SemanticContentDigest(content string) string

+ func VerifyChain(migrations []Migration, opts ...LoadOption) error

+ type AppliedRecord struct

+ Digest string

+ Error string

+ Filename string

+ Key string

+ SemanticDigest string

+ Status string

+ type Constraint struct

+ Kind ConstraintKind

+ Line int

+ Name string

+ Table string

+ type ConstraintKind string

+ const ConstraintCheck

+ const ConstraintColumnType

+ const ConstraintForeignKey

+ const ConstraintNotNull

+ const ConstraintNotNullCol

+ const ConstraintUnique

+ const ConstraintUniqueIndex

+ const ConstraintValidate

+ type Discrepancy struct

+ Blocker string

+ File string

+ FileDigest string

+ Key string

+ Kind DiscrepancyKind

+ LedgerDigest string

+ LedgerError string

+ LedgerFilename string

+ LedgerStatus string

+ Severity Severity

+ func (d Discrepancy) Headline() string

+ func (d Discrepancy) OneLine() string

+ func (d Discrepancy) String() string

+ type DiscrepancyKind string

+ const KindContentDrift

+ const KindDirtyMigration

+ const KindLedgerOnly

+ const KindNumberMismatch

+ const KindOrderViolation

+ type LoadOption func(*loadConfig)

+ func RequireParentLinks() LoadOption

+ func WithChainWarnFunc(fn func(string)) LoadOption

type Migration

+ func Load(fsys fs.FS, dir string, opts ...LoadOption) ([]Migration, error)

type MigrationSource

+ RewriteFrom []string

+ Schema string

+ type ParentLink struct

+ Digest string

+ IsRoot bool

+ Parent string

+ Present bool

type Postgres

+ func NewPostgresFromPGXPool(pool *pgxpool.Pool, app string) (*Postgres, error)

+ func (p *Postgres) AppliedRecords(ctx context.Context) (map[string]AppliedRecord, error)

+ func (p *Postgres) ApplyWithOrderingException(ctx context.Context, migrations []Migration, allowBelow []string, ...) error

+ func (p *Postgres) RepairAcceptContent(ctx context.Context, m Migration, req RepairRequest) (RepairResult, error)

+ func (p *Postgres) RepairAdopt(ctx context.Context, m Migration, req RepairRequest) (RepairResult, error)

+ func (p *Postgres) RepairAdoptAllUnmatched(ctx context.Context, migrations []Migration, req RepairRequest) ([]RepairResult, error)

+ func (p *Postgres) RepairHistory(ctx context.Context) ([]RepairRecord, error)

+ func (p *Postgres) RepairResolve(ctx context.Context, m Migration, mode ResolveMode, req RepairRequest) (RepairResult, error)

+ func (p *Postgres) Status(ctx context.Context, migrations []Migration) (Status, error)

+ func (p *Postgres) WithStrictOrdering() *Postgres

+ func (p *Postgres) WithWarnFunc(fn func(Discrepancy)) *Postgres

+ type RelinkChange struct

+ File string

+ From string

+ To string

+ func Relink(dir string, opts RelinkOptions) ([]RelinkChange, error)

+ type RelinkOptions struct

+ DryRun bool

+ From string

+ type RepairRecord struct

+ App string

+ At time.Time

+ Host string

+ ID int64

+ Key string

+ NewDigest string

+ NewFilename string

+ OSUser string

+ OldDigest string

+ OldFilename string

+ Operator string

+ Reason string

+ Schema string

+ Verb string

+ func (r RepairRecord) Line() string

+ type RepairRequest struct

+ DryRun bool

+ Operator string

+ Reason string

+ type RepairResult struct

+ DryRun bool

+ Key string

+ NewDigest string

+ NewFilename string

+ OldDigest string

+ OldFilename string

+ Verb string

+ func (r RepairResult) String() string

+ type ResolveMode string

+ const ResolveApplied

+ const ResolveRerun

+ type Severity string

+ const SeverityError

+ const SeverityInfo

+ const SeverityWarning

+ type Status struct

+ App string

+ Applied []AppliedRecord

+ Discrepancies []Discrepancy

+ Pending []string

+ Repairs []RepairRecord

+ Schema string

+ func (s Status) HasErrors() bool

+ func (s Status) Report() string

Jan 29, 2026

Changes in this version

+ func Prefix(name string) string

+ func ValidateClickHouseMigrations(ctx context.Context, config *ClickHouseConfig, fs embed.FS) error

+ func ValidatePostgresMigrations(ctx context.Context, db *sql.DB, sources ...MigrationSource) error

+ type ClickHouse struct

+ func NewClickHouse(config *ClickHouseConfig) *ClickHouse

+ func (c *ClickHouse) Applied(ctx context.Context) ([]string, error)

+ func (c *ClickHouse) Apply(ctx context.Context, m Migration) error

+ func (c *ClickHouse) ApplyMigrations(ctx context.Context, migrations []Migration) error

+ func (c *ClickHouse) Close() error

+ func (c *ClickHouse) Lock(ctx context.Context) error

+ func (c *ClickHouse) Setup(ctx context.Context) error

+ func (c *ClickHouse) Unlock(ctx context.Context) error

+ func (c *ClickHouse) ValidateAllApplied(ctx context.Context, migrations []Migration) error

+ type ClickHouseConfig struct

+ App string

+ ClientAddr string

+ Cluster string

+ Database string

+ Password string

+ PostgresDB *sql.DB

+ Username string

+ type Migration struct

+ Content string

+ Name string

+ func LoadFromFS(fsys fs.FS, dir ...string) ([]Migration, error)

+ type MigrationSource struct

+ App string

+ FS embed.FS

+ type Postgres struct

+ func NewPostgres(db *sql.DB, app string) *Postgres

+ func (p *Postgres) Applied(ctx context.Context) ([]string, error)

+ func (p *Postgres) Apply(ctx context.Context, m Migration) error

+ func (p *Postgres) ApplyMigrations(ctx context.Context, migrations []Migration) error

+ func (p *Postgres) Close() error

+ func (p *Postgres) Lock(ctx context.Context) error

+ func (p *Postgres) Setup(ctx context.Context) error

+ func (p *Postgres) Unlock(ctx context.Context) error

+ func (p *Postgres) ValidateAllApplied(ctx context.Context, migrations []Migration) error

+ func (p *Postgres) WithSchema(schema string) *Postgres