schema

type Column struct {
	Name       string
	Type       Type
	Nullable   bool
	PrimaryKey bool
	// Default is the rendered SQL default. An empty value adds no default.
	Default string
}

type Dialect string

type Extension struct {
	// Table is the physical name of the target table.
	Table string
	// Columns are the added columns. An added column is nullable, or it has a
	// default, because the target table can already hold rows.
	Columns []Column
	// Indexes are the added indexes.
	Indexes []Index
}

type ForeignKey struct {
	Column    string
	RefTable  string
	RefColumn string
	OnDelete  string // CASCADE or SET NULL. Empty means no action.
}

type IDType string

type Index struct {
	Name    string
	Columns []string
	Unique  bool
}

type Names struct {
	Users        string
	Credentials  string
	Accounts     string
	Sessions     string
	Tokens       string
	OAuthStates  string
	TOTP         string
	TOTPRecovery string
	APIKeys      string
	RateLimits   string
	Bootstrap    string
	Migrations   string
}

type Options struct {
	// Prefix starts every table name, index name, and record table name.
	Prefix string
	// IDType selects the physical type of the identifier columns.
	IDType IDType
	// UserFields are host-owned columns on the users table.
	UserFields []UserField
}

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

type Statement struct {
	ID  string
	SQL string
}

type Table struct {
	Name        string
	Columns     []Column
	Indexes     []Index
	ForeignKeys []ForeignKey
}

type Type string

type Unit struct {
	// Version is a 14-digit timestamp. It orders the units.
	Version string
	// Owner is OwnerCore or a plugin identifier.
	Owner string
	// Name is the unit name without the version.
	Name string
	// Up holds the forward statements of each dialect.
	Up map[Dialect][]Statement
	// Down holds the reverse statements of each dialect.
	Down map[Dialect][]Statement
	// Creates names the tables that the unit creates. The schema uses it to
	// find a table that no unit covers.
	Creates []string
}

type UserField struct {
	// Name is the column name.
	Name string
	// Type is the column type.
	Type Type
	// Nullable allows a null value.
	Nullable bool
	// Default is the rendered SQL default. An empty value adds no default.
	Default string
	// Input allows an HTTP route to write the field. The default is false.
	Input bool
	// Returned allows a response to carry the field. The default is false.
	Returned bool
}