sqlschema

type AppUser struct {
	// Name is the role to create. It is validated as an identifier, since
	// provisioning takes no free-form SQL.
	Name string

	// Password backs password authentication. Ignored in IAM mode.
	Password string

	// IAMAuth grants the engine's IAM authentication role instead of setting a
	// password, so the handler exchanges its execution role for a short-lived
	// token.
	IAMAuth bool

	// Database is the database the role is granted CONNECT on. Defaults to the
	// connected database when empty.
	Database string
}

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

type CodegenLanguage string

type Column struct {
	Type           string `yaml:"type"`
	PrimaryKey     bool   `yaml:"primaryKey"`
	Nullable       bool   `yaml:"nullable"`
	Unique         bool   `yaml:"unique"`
	Default        string `yaml:"default"`
	Description    string `yaml:"description"`
	Classification string `yaml:"classification"`
	// Tags are free-form categorisation labels for the column, surfaced in
	// exports. They have no effect on DDL.
	Tags       []string    `yaml:"tags"`
	References *ForeignKey `yaml:"references"`
}

type Constraint struct {
	Name       string   `yaml:"name"`
	Type       string   `yaml:"type"`
	Expression string   `yaml:"expression"`
	Columns    []string `yaml:"columns"`
}

type Contract struct {
	Name         string       `yaml:"name"`
	Owner        string       `yaml:"owner"`
	Dependencies []Dependency `yaml:"dependencies"`
}

type ContractImpact struct {
	Contract string
	Owner    string
	Policy   ContractPolicy
	Database string
	Tables   []string
}

type ContractPolicy string

type ContractsFile struct {
	Contracts []Contract `yaml:"contracts"`
}

type DatabaseResource struct {
	ResourceName   string
	Name           string
	Engine         string
	SchemaPath     string
	MigrationsPath string
	AuthMode       string
}

type Dependency struct {
	Database string   `yaml:"database"`
	Tables   []string `yaml:"tables"`
	// Datastore/Entities cover NoSQL datastores; SQL schema management ignores
	// them, but they are parsed so a combined contracts file stays valid.
	Datastore string         `yaml:"datastore"`
	Entities  []string       `yaml:"entities"`
	Policy    ContractPolicy `yaml:"policy"`
}

type DriftReport struct {
	Resource   string
	Target     string
	History    []string
	Structural []string
	Advanced   []string
	// StructuralTables lists the tables that drifted structurally, for schema
	// contract evaluation. Contracts, when populated by the caller, are rendered
	// in the report.
	StructuralTables []string
	Contracts        []ContractImpact
}

type ExportFormat string

type ForeignKey struct {
	Table    string `yaml:"table"`
	Column   string `yaml:"column"`
	OnDelete string `yaml:"onDelete"`
}

type GeneratedFile struct {
	Name    string
	Content string
}

type Index struct {
	Name    string   `yaml:"name"`
	Columns []string `yaml:"columns"`
	Unique  bool     `yaml:"unique"`
	// Type is the index method (Postgres: btree, gin, gist, spgist, brin, hash;
	// MySQL: btree, hash, fulltext, spatial). Empty means the engine default
	// (btree). Only the index method is covered. Expression parts, operator
	// classes and partial-index predicates are not modelled here, and those
	// indexes belong in a hand-written migration listed under Schema.Exclude.
	Type string `yaml:"type"`
}

type MigrationRecord struct {
	Version       string
	Description   string
	AppliedAt     time.Time
	ExecutionTime time.Duration
	Failed        bool
	Error         string
}

type PendingMigration struct {
	Name string
	Risk RiskLevel
}

type ProvisionReport struct {
	// User is the role that was provisioned.
	User string

	// Schema is the schema its object privileges were granted in.
	Schema string

	// RoleCreated is true when the role did not exist and was created.
	RoleCreated bool

	// AuthConfigured is true when a password was set or the IAM role granted.
	AuthConfigured bool

	// IAMAuth records which authentication mode was configured.
	IAMAuth bool

	// Grants lists the privileges applied, in the order they were applied. Safe
	// to print: identifiers only, never the password.
	Grants []string
}

type RiskLevel string

type Schema struct {
	Tables     map[string]Table `yaml:"tables"`
	Extensions []string         `yaml:"extensions"`
	// Exclude lists objects that exist in the database but are deliberately not
	// modelled here, typically because a hand-written migration creates them
	// (expression or partial indexes, triggers, functions, policies). Patterns
	// use Atlas's glob syntax relative to the managed schema, e.g.
	// "audit_log.index[idx_*]" or "legacy_*". Excluded objects are never
	// created, altered or dropped by schema-YAML-driven diffs.
	Exclude []string `yaml:"exclude"`
}

type Table struct {
	Description string            `yaml:"description"`
	Columns     map[string]Column `yaml:"columns"`
	Indexes     []Index           `yaml:"indexes"`
	Constraints []Constraint      `yaml:"constraints"`
	// Tags are free-form categorisation labels (e.g. "financial", "core-entity")
	// surfaced in exports. They have no effect on DDL.
	Tags []string `yaml:"tags"`
	// TypeName overrides the generated entity type name for this table (used by
	// `schema codegen`). When empty, the name is derived by singularising the
	// table name (e.g. customers → Customer). Set this for irregular plurals the
	// singulariser gets wrong.
	TypeName string `yaml:"typeName"`
}