dbspec

type Action string

type Analysis struct {
	Document    *Document
	Positions   []Position
	Diagnostics []Diagnostic
	Tokens      []Token
}

type ApplyError struct {
	Code    string
	Plan    string
	Step    int
	Message string
	Err     error
}

type ApplyEvent struct {
	Kind      string
	Plan      string
	Step      int
	Steps     int
	Statement string
}

type ApplyResult struct {
	// Stopped is true when the events callback returned an error, which ended the run there. Stop is that error.
	Stopped bool
	Stop    error
	// Failure is the ApplyError that ended the run, when that error is the only failure of the run.
	Failure *ApplyError
}

type AuditSetting struct {
	Comments     []string
	History      string
	Column       string
	References   string
	Action       string
	Previous     string
	Tables       string
	TablesRecord string
	TablesName   string
	Exclude      []string
	Include      []string
}

type Binary struct {
	Op    string
	Left  Expr
	Right Expr
	// contains filtered or unexported fields
}

type BlindIndexSetting struct {
	Comments    []string
	AESColumn   string
	IndexColumn string
}

type Change struct {
	Kind  string
	Table string
	Name  string
}

type Check struct {
	Comments   []string
	Name       string
	Expression Expr
}

type CheckboxSetting struct {
	Comments []string
	Column   string
	State    string
	Glyph    string
}

type CodecSetting struct {
	Comments []string
	Column   string
	Stages   []string
}

type Column struct {
	Comments []string
	Name     string
	Type     Type
	Null     bool
	Identity bool
	// Default is nil when the column has no default.
	Default *Default
}

type ColumnName struct{ Table, Name string }

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

type ColumnRename struct{ Table, Old, New string }

type ColumnSetting struct {
	Comments []string
	Column   string
}

type Default struct {
	Now     bool
	Literal string
}

type Diagnostic struct {
	Rule    string
	Line    int
	Column  int
	Message string
}

type Diagram struct {
	Comments        []string
	Name            string
	Entries         []DiagramEntry
	ClosingComments []string
}

type DiagramEntry struct {
	Comments []string
	Table    string
	X        int32
	Y        int32
}

type Dialect string

type Difference struct {
	Kind  string
	Table string
	Name  string
}

type Document struct {
	Name string
	// External means the document is not owned by the set; it is an external document that the owning document uses through use.
	// External documents are parsed and checked, but not rendered, installed, compared, or generated
	// (docs/spec/dbspec.md "Documents and use"). They do not appear in document text.
	External bool
	Uses     []Use
	Tables   []Table
	Diagrams []Diagram
	// TrailingComments are comment lines that no line follows.
	TrailingComments []string
}

type Effect struct {
	Kind    string
	Table   string
	Name    string
	Present bool
}

type EntitySetting struct {
	Comments []string
	Name     string
}

type Execer interface {
	Querier
	ExecContext(ctx context.Context, query string, args ...any) (sql.Result, error)
}

type Expr interface {
	// contains filtered or unexported methods
}

type ForeignKey struct {
	Comments   []string
	Name       string
	Columns    []string
	Table      string
	References []string
	OnDelete   Action
	OnUpdate   Action
}

type HistorySetting struct {
	Comments []string
	Table    string
	Row      string
	From     string
	To       string
	At       string
}

type ImmutableSetting struct {
	Comments []string
}

type In struct {
	Operand Expr
	Negated bool
	List    []Literal
}

type Index struct {
	Comments []string
	Name     string
	Columns  []IndexColumn
}

type IndexColumn struct {
	Name       string
	Descending bool
}

type IsNull struct {
	Operand Expr
	Negated bool
}

type KeyPrefixSetting struct {
	Comments []string
	Prefix   string
}

type LimitSetting struct {
	Comments []string
	State    string
	Count    int64
}

type Literal struct {
	Text string
	// contains filtered or unexported fields
}

type Manifest struct {
	ManifestText string
	// ExternalText is the canonical text holding, for each external document, the tables that owned documents use,
	// with their columns, primary key, unique keys, the foreign keys between used tables and the indexes leading them.
	// It is empty if there are no external documents.
	ExternalText string
	SchemaText   string
	ManifestHash string
	SchemaHash   string
}

type MarkSetting struct {
	Comments []string
	Column   string
}

type NavigationSetting struct {
	Comments   []string
	ForeignKey string
	ChildName  string
	ParentName string
}

type NullCheck struct {
	Table      string
	Column     string
	Default    string
	HasDefault bool
}

type Plan struct {
	Name          string
	From          string
	RenameTables  []TableRename
	RenameColumns []ColumnRename
	DropTables    []string
	DropColumns   []ColumnName
	// Schema is the document parsed from the target schema text, and To is its schemaHash.
	Schema *Document
	To     string
	// contains filtered or unexported fields
}

type PlanStep struct {
	Statement    string
	Rollback     string
	Irreversible string
	Effect       Effect
	// Restore and RollbackRestore are the statements that run instead of Statement and Rollback when RestoreIf is true
	// (when a column that rollback hid and added is in the table).
	Restore         string
	RollbackRestore string
	RestoreIf       Effect
	NullChecks      []NullCheck
	Finalize        bool
}

type Position struct {
	Kind   string
	Path   []string
	Line   int
	Column int
}

type PrimaryKey struct {
	Comments []string
	Columns  []string
}

type Querier interface {
	QueryContext(ctx context.Context, query string, args ...any) (*sql.Rows, error)
}

type QueryObserver interface {
	QueryEnded(query string, err error) error
}

type RenderedStatement struct {
	SQL   string
	Table string
}

type SelectExplicitSetting struct {
	Comments []string
	Columns  []string
}

type Set struct {
	Documents []SetFile
	External  []SetFile
}

type SetDocument struct {
	Name        string
	External    bool
	Document    *Document
	Positions   []Position
	Diagnostics []Diagnostic
}

type SetError struct {
	Rule    string
	Path    string
	Message string
}

type SetFile struct {
	Path  string
	Bytes []byte
}

type Settings struct {
	Comments        []string
	Entity          *EntitySetting
	Updated         *ColumnSetting
	SoftDelete      *ColumnSetting
	SelectExplicit  *SelectExplicitSetting
	Codecs          []CodecSetting
	AESVersion      *ColumnSetting
	BlindIndexes    []BlindIndexSetting
	Navigations     []NavigationSetting
	Immutable       *ImmutableSetting
	Audit           *AuditSetting
	StateMachine    *StateMachineSetting
	Marks           []MarkSetting
	Store           *StoreSetting
	KeyPrefix       *KeyPrefixSetting
	Title           *ColumnSetting
	Body            *ColumnSetting
	Order           *ColumnSetting
	Checkboxes      []CheckboxSetting
	ClosingComments []string
}

type StateLineSetting struct {
	Comments []string
	Initial  bool
	Terminal bool
	From     string
	To       string
	State    string
	Requires []string
}

type StateMachineSetting struct {
	Comments []string
	Column   string
	Lines    []StateLineSetting
	History  *HistorySetting
	Limits   []LimitSetting
}

type StoreSetting struct {
	Comments []string
	Kind     string
	Foreign  string
	Shape    string
	// Shard is the `shard <column> <period>` clause, or nil if there is no clause. The SQL backend does not read it.
	Shard *StoreShard
}

type StoreShard struct {
	Column string
	Period string
}

type Table struct {
	Comments    []string
	Name        string
	Columns     []Column
	PrimaryKey  PrimaryKey
	Uniques     []Unique
	Indexes     []Index
	ForeignKeys []ForeignKey
	Checks      []Check
	// Settings is nil when the table has no settings block.
	Settings *Settings
	// ClosingComments precede the closing brace of the table.
	ClosingComments []string
}

type TableRename struct{ Old, New string }

type Token struct {
	Line  int
	Start int
	End   int
	Class string
}

type Type struct {
	Kind      TypeKind
	Length    int
	Precision int
	Scale     int
}

type TypeKind string

type Unique struct {
	Comments []string
	Name     string
	Columns  []string
}

type Unsupported struct {
	Kind   string
	Table  string
	Name   string
	Reason string
}

type Use struct {
	Comments []string
	Document string
	Tables   []string
}