migrate

type AmbiguityKind string

type Change struct {
	Kind    ChangeKind
	UpSQL   string
	DownSQL string

	// Destructive means this change can lose data in a way no amount of user
	// confirmation resolves — e.g. a column type or a NOT NULL column with no default.
	Destructive bool

	// RequiresNoTx means this statement cannot run inside the transaction
	// Apply() wraps each migration file in — e.g. ALTER TYPE ... ADD VALUE.
	// The generate step emits these into dedicated `-- +RequiresNoTx Up|Down`
	// sections that the apply step runs outside the migration transaction.
	RequiresNoTx bool
	Note         string
}

type ChangeKind string

type ColumnSnapshot struct {
	Name        string `json:"name"`
	Type        string `json:"type"`
	NotNull     bool   `json:"not_null,omitempty"`
	Unique      bool   `json:"unique,omitempty"`
	PK          bool   `json:"pk,omitempty"`
	Identity    bool   `json:"identity,omitempty"`
	Default     any    `json:"default,omitempty"`
	DefaultExpr string `json:"default_expr,omitempty"`
	Generated   string `json:"generated,omitempty"`
	Check       string `json:"check,omitempty"`
	Collation   string `json:"collation,omitempty"`
	RefTable    string `json:"ref_table,omitempty"`
	RefColumn   string `json:"ref_column,omitempty"`
	OnDelete    string `json:"on_delete,omitempty"`
	OnUpdate    string `json:"on_update,omitempty"`
}

type ConstraintSnapshot struct {
	Name string `json:"name"`
	Expr string `json:"expr"`
}

type EnumSnapshot struct {
	Name   string   `json:"name"`
	Values []string `json:"values"`
}

type GenerateOptions struct {
	// Force bypasses the ManualReviewRequiredError guard and writes destructive
	// changes (type casts without USING, SET NOT NULL without backfill, etc.)
	// into the migration file. Use only when you know the data is safe.
	Force bool
}

type IndexSnapshot struct {
	Name      string   `json:"name"`
	Cols      []string `json:"cols"`
	Unique    bool     `json:"unique,omitempty"`
	Predicate string   `json:"predicate,omitempty"`
}

type ManualReviewRequiredError struct {
	Changes []Change
}

type MigrationFile struct {
	Version     int64
	Name        string
	UpSQL       string
	DownSQL     string
	NoTxUpSQL   string
	NoTxDownSQL string
	Path        string
	Checksum    string
}

type MigrationStatus struct {
	MigrationFile
	Applied          bool
	ChecksumVerified bool
	Orphaned         bool
}

type PromptContext struct {
	Kind       AmbiguityKind
	Table      string
	OldName    string
	Candidates []string
}

type PromptFunc func(ctx PromptContext) (Resolution, error)

type Resolution struct {
	Action string // "rename", "delete", or "ignore"
	Target string // the new name, when Action == "rename"
}

type Snapshot struct {
	FormatVersion int             `json:"format_version"`
	Tables        []TableSnapshot `json:"tables"`
	Enums         []EnumSnapshot  `json:"enums"`
}

type TableSnapshot struct {
	Name        string               `json:"name"`
	Columns     []ColumnSnapshot     `json:"columns"`
	Indexes     []IndexSnapshot      `json:"indexes"`
	Uniques     []IndexSnapshot      `json:"uniques"`
	Constraints []ConstraintSnapshot `json:"constraints"`
}