schema

type AssociationReference struct {
	// Table is the name of the table being referenced.
	// If Table is the same as the column's table, it creates a parent-child relationship.
	// Should match a Table.Name value in another table.
	Table string `json:"table"`

	// Schema is the schema that Table is in.
	Schema string `json:"schema,omitempty"`

	// Column is the name of the column created in the association table to hold a duplicate of the private key in Table.
	// It will default to a name based on Table and the name of the primary key column in Table.
	Column string `json:"column,omitempty"`

	// Identifier is the Go name used for the referenced object.
	// If not specified, will be based on Column.
	Identifier string `json:"identifier,omitempty"`

	// IdentifierPlural is the plural of Identifier.
	// Will be based on Identifier if left blank.
	IdentifierPlural string `json:"identifierPlural,omitempty"`

	// Label is the human-readable name for the referenced object.
	// If not specified, will be based on Identifier.
	Label string `json:"label,omitempty"`

	// LabelPlural is the plural of Label
	LabelPlural string `json:"labelPlural,omitempty"`
}

type AssociationTable struct {
	// Table is the name of the association table in the database. It should be lower_snake_case and end
	// with the Database.AssnTableSuffix value.
	// Example: "project_team_member_assn"
	Table string `json:"name"`
	// For databases that support schemas, this is the name of the schema of the table.
	// Leave blank for the default schema.
	// Databases that do not support schemas will have this prepended to the name of the table if this is present.
	Schema string `json:"schema,omitempty"`

	// Ref1 references the first table in the many-many relationship
	Ref1 AssociationReference `json:"ref1"`
	// Ref2 references the second table in the many-many relationship
	Ref2 AssociationReference `json:"ref2"`

	// Comment is a place to put a comment in the JSON schema file.
	// If the database driver supports it, it may be put in the database.
	Comment string `json:"comment,omitempty"`
}

type Column struct {
	// Name is the name of the column in the database.
	//
	// If an enum column, by convention the name can be one of the following forms:
	//  - enumtype
	//	- tablename_enumtype
	//  - enumtype_enum
	//  - tablename_enumtype_enum
	// For example, if this table is named "person", and the enum table is named "status",
	// then by convention the name can be: status, person_status, status_enum, or person_status_enum.
	// If this convention is not followed, then the EnumTable should include the name of the enum table.
	Name string `json:"name"`

	// Type is the type of column. See the doc for ColumnType for more info.
	Type ColumnType `json:"type"`

	// SubType further describes how the database treats the type.
	SubType ColumnSubType `json:"sub_type,omitempty"`

	// If a string column, Size is the maximum length of runes that the column can accommodate.
	// If a []byte column, Size is the maximum number of bytes allowed in the column.
	// If an int, unsigned int, or float, Size is the number of bits allowed in the number and will also
	// determine the Go number type that will represent the column. This can be a zero in order to use the default,
	// which will be 32-bits for ints (the SQL default), or 64-bits for floats.
	Size uint64 `json:"size,omitempty"`

	// DefaultValue is the value that this field will be initialized to when a new object is created.
	// If not specified, it will be the zero value of the column's type.
	// Non-nullable columns that do not have a default value are required to be set by the application
	// before the object is saved.
	// Time columns can use the string "now" to set the value to the current time when the object
	// is first saved, and "update" to also set the value to the current time every time the object
	// is modified and saved.
	DefaultValue interface{} `json:"default_value,omitempty"`

	// IsNullable is true if the column can be given a NULL value.
	IsNullable bool `json:"nullable,omitempty"`

	// IndexLevel indicates what kind of single-column index is associated with this column.
	// ColTypeAutoPrimaryKey columns by default will be given a single primary key index.
	// At least one primary key index must be specified.
	// See Table.Indexes for specifying a multi-column index.
	IndexLevel IndexLevel `json:"index_level,omitempty"`

	// Identifier is the name of the column in Go code. Leave blank to base it on the Name.
	// Should be CamelCase. For example: "LastName".
	Identifier string `json:"identifier,omitempty"`

	// Label is the human-readable description of the item. Leave blank to base it on the Identifier.
	// Should be title case.
	// For example: "Last Name".
	Label string `json:"label,omitempty"`

	// DatabaseDefinition contains database specific extra information on the column that helps the database driver
	// recreate the column in the database if needed. The top key is a db.DriverType constant, and the secondary key is the
	// type of information. For example, a DECIMAL field might look like this:
	//  {"mysql":{"type":"decimal(5,2)"},"sqllite":{"type":"string"}}
	// This would indicate that in Mysql, the column is defined as DECIMAL(5,2), but in Sqllite, as a string.
	// The information recognized is specific to the database driver.
	DatabaseDefinition map[string]map[string]interface{} `json:"database_def,omitempty"`

	// Comment is a place to put a comment in the JSON description file. If the database driver supports it, it may be put in the database..
	Comment string `json:"comment,omitempty"`

	// EnumTable is the enum table if the Type is ColTypeEnum.
	EnumTable string `json:"enum_table,omitempty"`
}

type ColumnSubType int

type ColumnType int

type Database struct {
	// Key is the database key corresponding to its key in the global database cluster.
	// Should be unique among the other databases in use.
	Key string `json:"key"`

	// Package is the name of the root package for top level code sent to the output directory.
	// Should be all lower case, with no hyphens or underscores.
	// Will be the name of the output directory if omitted.
	Package string `json:"package,omitempty"`

	// ImportPath is the import path that refers to the output directory.
	// This value will be used to refer to files across packages.
	// If omitted, it will be calculated based on the output directory by looking for the go.mod
	// file that applies to the output directory.
	ImportPath string `json:"import_path,omitempty"`

	// WriteTimeout is used to wrap write transactions with a timeout on their contexts.
	// Leaving it as zero will turn off timeout wrapping, allowing you to wrap individual calls as you
	// see fit. This only applies to code generated transactions. See also table.WriteTimeout to set
	// a timeout value on an individual table.
	// Use a duration format understood by time.ParseDuration.
	WriteTimeout string `json:"write_timeout,omitempty"`

	// ReadTimeout is used to wrap read transactions with a timeout on their contexts.
	// Leaving it as zero will turn off timeout wrapping, allowing you to wrap individual calls as you
	// see fit. This only applies to code generated transactions. See also table.ReadTimeout to set
	// a timeout value on an individual table.
	// Use a duration format understood by time.ParseDuration.
	ReadTimeout string `json:"read_timeout,omitempty"`

	// EnumTableSuffix is the text to strip off the end of an enum table name when converting it to a type name.
	// Defaults to "_enum". Will be added to enum table names if missing.
	EnumTableSuffix string `json:"enum_table_suffix,omitempty"`

	// AssnTableSuffix is the suffix for association table names.
	AssnTableSuffix string `json:"assn_table_suffix,omitempty"`

	// Tables are the standard tables in the database.
	Tables []*Table `json:"tables"`

	// EnumTables contains a description of the enumerated types from the enum tables in the database.
	EnumTables []*EnumTable `json:"enum_tables"`

	// AssociationTables form many-to-many relationships between tables in the database.
	AssociationTables []*AssociationTable `json:"association_tables"`
}

type EnumField struct {
	// Identifier is the name used in Go code to access the data.
	Identifier string `json:"identifier,omitempty"`
	// IdentifierPlural is the plural of the Identifier.
	IdentifierPlural string `json:"identifier_plural,omitempty"`
	// Type is the type of the column.
	// It is inferred from the data, but can be specifically identified if needed, like if integer data
	// should be presented as floating point.
	Type ColumnType `json:"type"`
}

type EnumTable struct {
	// Name is the name of the table in the database.
	// By convention, the name should have the Database.EnumTableSuffix value as a suffix.
	// This suffix will be stripped off for items below that use Name as the basis for a default value.
	Name string `json:"name"`
	// For databases that support schemas, this is the name of the schema of the table.
	// Leave blank for the default schema.
	// Databases that do not support schemas will have this prepended to the name of the table.
	Schema string `json:"schema,omitempty"`

	// Values are the enum values themselves.
	// At a minimum, each entry must have a "name" field. This should be a CamelCase string that will be
	// used to build the constant value in the Go code.
	// By default, numbers for values will be assigned in order. If you set a "value" value, it will override this default.
	// By default, a "label" value will be assigned based on "name". This should be a Title Case string that will
	// represent the value to humans. Set "label" to override the default.
	// Alternatively specify a "key" value to be used as the json key and other appropriate contexts. This
	// should be a lower_snake_case value and will be generated if missing.
	// Additional entries will create accessor functions for those values. The type and identifiers will be
	// inferred from the entries, or you can use Fields to specify these values for the additional fields.
	Values []map[string]any `json:"values"`

	// Fields provides descriptions for additional values found in Values.
	// If the entries are omitted, a default will be generated.
	// Keys are the same as the keys in the Values entries.
	// "label" field will be generated automatically and should not be included on import.
	Fields map[string]EnumField `json:"fields,omitempty"`

	// Label is the name of the object when describing it to humans.
	// If creating a multi-language app, your app would provide translation from this string to the language of choice.
	// Can be multiple words. Should be Title Case.
	// If left blank, the app will base this on the Name of the table.
	Label string `json:"label,omitempty"`

	// LabelPlural is the plural form of the Label.
	LabelPlural string `json:"label_plural,omitempty"`

	// Identifier is the corresponding Go object name. It must obey Go identifier labeling rules.
	// Should be CamelCase.
	// Leave blank to base it on the Name.
	Identifier string `json:"identifier,omitempty"`

	// IdentifierPlural is the plural form of Identifier.
	IdentifierPlural string `json:"identifier_plural,omitempty"`

	// Comment is a place to put a comment in the JSON description file.
	// If the database driver supports it, it may be put in the database.
	Comment string `json:"comment,omitempty"`
}

type Index struct {
	// Columns are the Column.Name values of the columns in the table that will be used to access the data.
	Columns []string `json:"columns"`
	// IndexLevel will specify the type of index, and possibly a constraint to put on the columns.
	IndexLevel IndexLevel `json:"index_level"`
	// Name is the name given to the index in the database, if the database requires a name.
	// The name will be concatenated with the name of the table and "idx".
	// Should be a snake_case word
	Name string `json:"name,omitempty"`
	// Identifier is the identifier used to create accessor functions.
	// Should be CamelCase.
	// A default will be generated from the column names if none is provided.
	Identifier string `json:"identifier,omitempty"`
}

type IndexLevel int

type Reference struct {
	// Table is the name of the table being referenced.
	// If Table is the same as the column's table, it creates a parent-child relationship.
	// Should match a Table.Name value in another table.
	Table string `json:"table"`

	// Schema is the schema that Table belongs to. If empty, will use the default schema.
	Schema string `json:"schema,omitempty"`

	// Column is the name of the local column created in this table to hold a duplicate of the private key in Table,
	// and is also known as a foreign key.
	// It will default to a name based on Table and the name of the primary key column in Table.
	Column string `json:"column,omitempty"`

	// ColumnIdentifier is the name that Go will use to identify the column
	ColumnIdentifier string `json:"column_identifier,omitempty"`

	// ColumnLabel is the human-readable name of the column.
	ColumnLabel string `json:"column_label,omitempty"`

	// ObjectIdentifier is the Go name used for the referenced object.
	// If not specified, will be based on Column.
	ObjectIdentifier string `json:"object_identifier,omitempty"`

	// Label is the human-readable name for the referenced object.
	// If not specified, will be based on Identifier.
	ObjectLabel string `json:"object_label,omitempty"`

	// IndexLevel specifies the index to be created on the foreign key column.
	// If a primary key or unique key, will create a one-to-one relationship.
	// If left empty, will default to IndexLevelIndexed.
	IndexLevel IndexLevel `json:"index_level,omitempty"`

	// IsNullable indicates that the reference is not required and can be represented as a null value in the database.
	// If not nullable, then the reference is required to be present and valid when the record is saved.
	// This would also mean that if the referenced object is deleted, or changes its reverse
	// relationship, then this object will be deleted.
	// The foreign key column will be nullable if this is nullable.
	IsNullable bool `json:"nullable,omitempty"`

	// The singular Go identifier that will be used for the reverse relationship objects.
	// If not specified, will be based on Table.Name.
	// Should be CamelCase with no spaces.
	// For example, "ManagedProject".
	ReverseIdentifier string `json:"reverse_identifier,omitempty"`

	// The plural Go identifier that will be used for the reverse relationship objects.
	// If not specified, the ReverseIdentifier will be pluralized.
	ReverseIdentifierPlural string `json:"reverse_identifier_plural,omitempty"`

	// The singular description of the Table objects as referred to by the referenced table.
	// If not specified, will be based on ReverseIdentifier.
	// For example, "Managed Project", or "Project I Manage".
	ReverseLabel string `json:"reverse_label,omitempty"`

	// The plural description of Table objects as referred to by the referenced table.
	// If not specified, the ReverseLabel will be pluralized.
	ReverseLabelPlural string `json:"reverse_label_plural,omitempty"`
}

type Table struct {
	// Name is the name of the table or object as used in the database.
	// Must be unique within the table or schema if one is provided.
	// Should be lower_snake_case.
	Name string `json:"name"`

	// For databases that support schemas, this is the name of the schema of the table.
	// Leave blank for the default schema.
	// Databases that do not support schemas will have this prepended to the name of the table.
	Schema string `json:"schema,omitempty"`

	// WriteTimeout is used to wrap write transactions with a timeout on their contexts.
	// Leaving it as zero will use the Database.WriteTimeout value.
	// Use a duration format understood by time.ParseDuration.
	WriteTimeout string `json:"write_timeout,omitempty"`

	// ReadTimeout is used to wrap read transactions with a timeout on their contexts.
	// Leaving it as zero will use the Database.ReadTimeout value.
	// Use a duration format understood by time.ParseDuration.
	ReadTimeout string `json:"read_timeout,omitempty"`

	// NoTest indicates that the table should NOT have an automated test generated for it.
	NoTest bool `json:"no_test,omitempty"`

	// Columns is a list of Column objects, one for each column in the table.
	// This does not include columns associated with references.
	// Use AllColumns() to get the list of all columns, including the foreign key columns.
	Columns []*Column `json:"columns"`

	// References is a list of links to other tables, also known as foreign keys.
	References []*Reference `json:"references,omitempty"`

	// Indexes will be used to generate additional indexes and getter functions.
	// Single-column indexes can also be defined in Column and Reference.
	// You can use this to specify multiple types of indexes on the same column(s), including a
	// composite primary key. Note that some databases do not support composite primary keys and
	// will convert a composite primary key to a composite unique key, and then will automatically
	// generate a single unique primary key.
	// Composite primary keys with an auto generated primary key is not supported in the orm. To
	// implement this, you will need to manually generate or assign the primary key columns.
	Indexes []*Index `json:"indexes,omitempty"`

	// Identifier is the corresponding Go object name.
	// It must obey Go identifier labeling rules.
	// Should be CamelCase.
	// If empty, will be based on Name.
	Identifier string `json:"identifier,omitempty"`

	// IdentifierPlural is the plural form of Identifier.
	// If blank, will be base on Identifier.
	IdentifierPlural string `json:"identifier_plural,omitempty"`

	// Label is the name of the object when describing it to humans.
	// If creating a multi-language app, your app would provide translation from this string to the language of choice.
	// Can be multiple words.
	// If left blank, will be base on Identifier.
	Label string `json:"label,omitempty"`

	// LabelPlural is the plural form of the Label.
	// If left blank, will be based on Label.
	LabelPlural string `json:"label_plural,omitempty"`

	// Comment is a place to put a comment in the json description file.
	// If the database driver supports it, it may be put in the database.
	Comment string `json:"comment,omitempty"`
}