schema

type Enum struct {
	Name   string
	Values []string
	Line   int
}

type Field struct {
	Name string
	// Type is a scalar name, an enum name or (for types) another type name.
	Type     string
	Optional bool
	Array    bool
	ID       bool
	Unique   bool
	Index    bool
	// Default is the literal as written: 42, true, "x", draft, uuid(),
	// now(), autoincrement().
	Default string
	// Ref is the model the field references (the field has the type of
	// that model's id); OnDelete is what happens
	// to the row when the referenced one is deleted: "cascade" (delete
	// it), "setnull" (clear the field; it must be optional) or "" (the
	// delete fails while the row exists).
	Ref      string
	OnDelete string
	Min      *float64
	Max      *float64
	// MinText and MaxText are @min and @max as written, for a decimal
	// field, whose rules compare exactly.
	MinText string `json:",omitempty"`
	MaxText string `json:",omitempty"`
	// Precision and Scale are the arguments of decimal(p, s).
	Precision int `json:",omitempty"`
	Scale     int `json:",omitempty"`
	Email     bool
	// Search is @search: the field is part of the model's full-text
	// search, with SearchWeight (A to D; by position when empty).
	Search       bool   `json:",omitempty"`
	SearchWeight string `json:",omitempty"`
	URL          bool
	// Timezone requires an IANA zone name ("Europe/Paris").
	Timezone bool
	Pattern  string
	Line     int
}

type Index struct {
	Fields []string
	Unique bool
}

type Migration struct {
	// Name is "0003_add_post"; the files are Name+".up.sql" and ".down.sql".
	Name string
	Up   []string
	Down []string
	// After holds what would lock a table that already has rows if it
	// ran in Up: indexes built CONCURRENTLY, constraints validated. It
	// becomes a second migration, marked NoTransaction, named after Up's
	// with the next stamp; AfterDown reverts it.
	After     []string
	AfterDown []string
}

type Model struct {
	Name string
	// Table is the Postgres table name; empty for types.
	Table   string
	Fields  []*Field
	Indexes []Index
	Line    int
	// Persisted is true for "model", false for "type".
	Persisted bool
	// Public is the model attribute @public: the rows are not owned and
	// the generated routes are open to visitors.
	Public bool `json:",omitempty"`
	// Shared is the model attribute @shared: the rows are not owned and
	// the generated routes are behind sign-in.
	Shared bool `json:",omitempty"`
	// SearchConfig is @@search("english"): the text search configuration
	// of the model's @search fields; "simple" when empty.
	SearchConfig string `json:",omitempty"`
}

type Rename struct {
	// Where is "schema.Post" or "queries (column post.tag_ids)".
	Where    string
	Old, New string
}

type Result struct {
	// Files are the paths written, relative to the project root.
	Files []string
	// Migration is the new migration's name, empty when nothing changed.
	Migration string
	// Renamed are the Go names in the schema package that changed from
	// the previous schema/schema.go with this release's naming (plurals
	// of initialisms as IDs, URLs): the app's code must follow.
	Renamed []Rename
}

type Schema struct {
	Enums  []*Enum
	Models []*Model // persisted: table and struct
	Types  []*Model // API shapes: struct only
}