schema

type Column struct {
	// These fields are read from the database
	BelongsTo        int // The name of the [Table] or [View] that owns this Column.
	Number           int // The position of this Column within its owners full set of columns. The first column is number 0.
	Name             string
	NotNull          bool
	DataType         string // The Postgres data type of this column
	IsIdentity       bool
	IsIdentityAlways bool           // If True, then IsIdentity is also True.
	IsGenerated      bool           // If True, then IsIdentity is False and IsIdentityAlways is False.
	Collation        sql.NullString // The collation rules for this column, if any.
	DefaultDef       sql.NullString // The default definition for this column, if any.
	Comment          sql.NullString // The comment on this column, if any.
	// These fields will be populated during Parse()
	Sequence *Sequence // If set, the sequence associated with this column. Usually set in the case of primary keys or IS IDENTITY GENERATED ALWAYS.
}

type CompoundType struct {
	OID     int
	Schema  string
	Name    string
	Columns []CompoundTypeColumn
	// contains filtered or unexported fields
}

type CompoundTypeColumn struct {
	Name string
	Type string
}

type Constraint struct {
	OID                int
	Schema             string
	Name               string
	TableName          string
	Definition         string
	Type               string
	Index              string
	ForeignTableSchema string
	ForeignTableName   string
	ForeignColumns     []string
	LocalColumns       []string
	IsDeferrable       bool
	InitiallyDeferred  bool
	// contains filtered or unexported fields
}

type DBObject interface {
	SortKey() string
	String() string
	AddDependency(string)
	DependsOn() []string
}

type Data struct {
	Schema  string   `yaml:"schema"`
	Name    string   `yaml:"name"`
	Columns []string `yaml:"columns"`
	OrderBy string   `yaml:"orderBy"`
	// contains filtered or unexported fields
}

type Dependency struct {
	Object    Object
	DependsOn Object
}

type Domain struct {
	Schema           string
	Name             string
	UnderlyingType   string
	NotNull          bool
	Collation        sql.NullString
	Default          sql.NullString
	CheckConstraints sql.NullString
	// contains filtered or unexported fields
}

type DumpConfig struct {
	// The names of the postgres schemas to include in the dump, defaults to
	// "public" if none are specified.
	SchemaNames []string `yaml:"schema_names"`
	// The name of the file to which the dump should be written. if `-`, then
	// the result will be printed to STDOUT.
	Out string `yaml:"out"`
	// Any explicit dependencies between database objects, described by their
	// fully-qualified names e.g., `schema.tablename`.
	Dependencies map[string][]string `yaml:"dependencies"`
	// Rules for dumping table data in the form of INSERT statements.
	Data []Data `yaml:"data"`
	// Lines to be written, in order, at the beginning of the generated schema
	// dump --- before all the dumped DDL.
	Header []string `yaml:"header"`
	// Lines to be written, in order, at the end of the generated schema dump
	// --- after all the dumped DDL.
	Footer []string `yaml:"footer"`
}

type Enum struct {
	OID          int
	Schema       string
	Name         string
	InternalName string
	Description  sql.NullString
	Size         string
	Elements     []string
	// contains filtered or unexported fields
}

type Extension struct {
	OID         int
	Schema      string
	Name        string
	Version     string
	Description string
	// contains filtered or unexported fields
}

type Followup struct {
	Name string
	SQL  string
	// contains filtered or unexported fields
}

type Function struct {
	OID           int
	Schema        string
	Name          string
	Language      string
	Kind          string
	Volatility    string
	Parallel      string
	Security      string
	ResultType    string
	ArgumentTypes string
	Definition    string
	// contains filtered or unexported fields
}

type Index struct {
	OID                 int
	Schema              string
	TableName           string
	Name                string
	Definition          string
	IndexColumns        []string
	KeyOptions          string
	TotalColumnCount    int
	KeyColumnCount      int
	NumAtt              int
	IncludedColumnCount int
	IsUnique            bool
	IsPrimaryKey        bool
	IsExclusion         bool
	IsImmediate         bool
	IsClustered         bool
	KeyCollations       string
	KeyExpressions      sql.NullString
	PartialPredicate    sql.NullString
	Algorithm           string
	KeyColumns          []string
	IncludedColumns     []string
	// contains filtered or unexported fields
}

type Object struct {
	OID    int
	Schema string
	Name   string
	Kind   string
}

type Schema struct {
	// Database objects that can be dumped.
	Extensions    []*Extension
	Domains       []*Domain
	CompoundTypes []*CompoundType
	Enums         []*Enum
	Functions     []*Function
	Tables        []*Table
	Views         []*View
	Sequences     []*Sequence
	Indexes       []*Index
	Constraints   []*Constraint
	Triggers      []*Trigger
	Data          []*Data
	// Metadata that isn't explicitly dumped.
	DumpConfig   DumpConfig
	Dependencies []*Dependency
}

type Sequence struct {
	OID              int
	Schema           string
	Name             string
	DataType         string
	StartValue       int
	MinValue         int
	MaxValue         int
	IncrementBy      int
	Cache            int
	Cycle            bool
	TableName        sql.NullString
	ColumnName       sql.NullString
	IsIdentity       bool
	IsIdentityAlways bool
	// contains filtered or unexported fields
}

type Sortable[K constraints.Ordered] interface {
	SortKey() K     // sorted by this, ascending
	DependsOn() []K // what they depend on
}

type Table struct {
	OID          int
	Schema       string
	Name         string
	Comment      sql.NullString
	Columns      []*Column
	Dependencies []string
	Indexes      []*Index
	Constraints  []*Constraint
	Sequences    []*Sequence
	Triggers     []*Trigger
}

type Trigger struct {
	OID        int
	Schema     string
	Name       string
	TableName  string
	Definition string
	ProcSchema string
	ProcName   string
	Enabled    string
	// contains filtered or unexported fields
}

type View struct {
	OID            int
	Schema         string
	Name           string
	Definition     string
	Comment        sql.NullString
	IsMaterialized bool
	Columns        []Column
	Dependencies   []string
}