dbparity

type BackendClass string

type Capability struct {
	ID        string       `json:"id"`
	Class     BackendClass `json:"class"`
	Evidence  string       `json:"evidence"`
	Rationale string       `json:"rationale,omitempty"` // Required for non-common capabilities
}

type Catalog struct {
	Components  []Component `json:"components"`
	SharedInfra []string    `json:"shared_infra"`
}

type CheckConstraintSpec struct {
	Name       string `json:"name,omitempty"`
	Expression string `json:"expression"` // Substring/fragment expected in check definition
}

type ColumnSpec struct {
	Name            string       `json:"name"`
	Type            SemanticType `json:"type,omitempty"`             // Optional semantic type category
	Nullable        *bool        `json:"nullable,omitempty"`         // Optional nullability expectation
	PrimaryKey      bool         `json:"primary_key,omitempty"`      // Part of primary key
	Default         string       `json:"default,omitempty"`          // Expected default fragment ("" means no assertion)
	DefaultValue    string       `json:"default_value,omitempty"`    // Deprecated alias / backwards compatibility for Default
	DefaultPostgres string       `json:"default_postgres,omitempty"` // Optional engine-specific default override for PostgreSQL
}

type CommandPlan struct {
	ComponentID string   `json:"component_id"`
	Package     string   `json:"package"`
	Backend     string   `json:"backend"`
	Args        []string `json:"args"`
	Env         []string `json:"env,omitempty"`
}

type Component struct {
	ID             string       `json:"id"`
	SourceRoots    []string     `json:"source_roots"`
	TestPackages   []string     `json:"test_packages"`
	StoreContracts []string     `json:"store_contracts"`
	MigrationRoots []string     `json:"migration_roots"`
	Capabilities   []Capability `json:"capabilities"`
}

type ComponentListEntry struct {
	ID           string   `json:"id"`
	TestPackages []string `json:"test_packages"`
}

type ExitCoder interface {
	ExitCode() int
}

type ForeignKeySpec struct {
	Name       string   `json:"name,omitempty"`
	Columns    []string `json:"columns"`
	RefTable   string   `json:"ref_table"`
	RefColumns []string `json:"ref_columns,omitempty"`
}

type ImmutabilityProtection struct {
	Name         string `json:"name"`                     // Descriptive name
	Table        string `json:"table"`                    // Target table
	TriggerName  string `json:"trigger_name,omitempty"`   // Required trigger name in DB (if DB-enforced)
	AppLevelOnly bool   `json:"app_level_only,omitempty"` // If true, documented as app-level enforced (absent-by-design in DB)
	Description  string `json:"description,omitempty"`
}

type IndexSpec struct {
	Name      string   `json:"name,omitempty"`      // Optional if unique signature is matched
	Table     string   `json:"table"`               // Table on which index resides
	Columns   []string `json:"columns,omitempty"`   // Column list (ordered)
	Unique    bool     `json:"unique,omitempty"`    // Whether the index is unique
	Predicate string   `json:"predicate,omitempty"` // WHERE clause fragment for partial indexes
}

type Inventory = Catalog

type LogicalSchemaSpec struct {
	ComponentID string                   `json:"component_id,omitempty"`
	Tables      []TableSpec              `json:"tables,omitempty"`
	Indexes     []IndexSpec              `json:"indexes,omitempty"`
	Protections []ImmutabilityProtection `json:"protections,omitempty"`
	Retired     RetiredArtifacts         `json:"retired,omitempty"`
}

type MigrationFile struct {
	ID       string `json:"id"`       // 14-digit timestamp string (e.g. "20260812000000")
	Name     string `json:"name"`     // Descriptive name after timestamp prefix (e.g. "billing_baseline")
	Filename string `json:"filename"` // Base filename (e.g. "20260812000000_billing_baseline.go")
	Path     string `json:"path"`     // Full or relative path to the migration file
}

type PlanOptions struct {
	Catalog     Catalog                   // Parity catalog to use (defaults to DefaultCatalog() if empty)
	GoTestFlags []string                  // Additional flags for `go test` (e.g. -timeout=10m, -parallel=8)
	ComponentID string                    // Optional filter by component ID
	BaseEnv     []string                  // Base environment for DSN/env inspection (defaults to os.Environ() if nil)
	GoBinary    string                    // Optional go binary path (defaults to "go")
	CmdRunner   func(cmd *exec.Cmd) error // Optional test hook to override cmd.Run() execution (defaults to cmd.Run if nil)
}

type RetiredArtifacts struct {
	Tables   []string        `json:"tables,omitempty"`
	Columns  []RetiredColumn `json:"columns,omitempty"`
	Indexes  []string        `json:"indexes,omitempty"`
	Triggers []string        `json:"triggers,omitempty"`
}

type RetiredColumn struct {
	Table  string `json:"table"`
	Column string `json:"column"` // Exact name or prefix pattern (e.g. "reserved%nano" or glob)
}

type RunStepError struct {
	Component string `json:"component"`
	Package   string `json:"package"`
	Backend   string `json:"backend"`
	Err       error  `json:"-"`
}

type RunnerMode string

type SemanticType string

type TableSpec struct {
	Name              string                 `json:"name"`
	Columns           []ColumnSpec           `json:"columns,omitempty"`
	PrimaryKey        []string               `json:"primary_key,omitempty"` // Compound/single PK column order
	ForeignKeys       []ForeignKeySpec       `json:"foreign_keys,omitempty"`
	UniqueConstraints []UniqueConstraintSpec `json:"unique_constraints,omitempty"`
	CheckConstraints  []CheckConstraintSpec  `json:"check_constraints,omitempty"`
}

type UniqueConstraintSpec struct {
	Name    string   `json:"name,omitempty"`
	Columns []string `json:"columns"`
}