drivers

type Column struct {
	Name      string `json:"name" toml:"name"`
	Type      string `json:"type" toml:"type"`
	DBType    string `json:"db_type" toml:"db_type"`
	Default   string `json:"default" toml:"default"`
	Comment   string `json:"comment" toml:"comment"`
	Nullable  bool   `json:"nullable" toml:"nullable"`
	Unique    bool   `json:"unique" toml:"unique"`
	Generated bool   `json:"generated" toml:"generated"`

	// OptionalType is a type that implements interface{IsSet() bool}
	// Used in the OptionalXXX type
	OptionalType string `json:"optional_type" toml:"optional_type"`
	// The type for where comparisons. This should be the non-nullable version
	// of the Type
	CompareType string `json:"compare_type" toml:"compare_type"`

	// For Nullable columns, a method or property to retrieve the
	// non null type from the nullable one
	GetNonNull string `json:"get_non_null" toml:"get_non_null"`

	// Postgres only extension bits
	// ArrType is the underlying data type of the Postgres
	// ARRAY type. See here:
	// https://www.postgresql.org/docs/9.1/static/infoschema-element-types.html
	ArrType *string `json:"arr_type" toml:"arr_type"`
	UDTName string  `json:"udt_name" toml:"udt_name"`
	// DomainName is the domain type name associated to the column. See here:
	// https://www.postgresql.org/docs/10/extend-type-system.html#EXTEND-TYPE-SYSTEM-DOMAINS
	DomainName *string `json:"domain_name" toml:"domain_name"`

	// MySQL only bits
	// Used to get full type, ex:
	// tinyint(1) instead of tinyint
	// Used for "tinyint-as-bool" flag
	FullDBType string `json:"full_db_type" toml:"full_db_type"`
}

type ColumnFilter map[string]Filter

type Constraint struct {
	Name    string   `json:"name"`
	Columns []string `json:"columns"`
}

type Constructor interface {
	// Load all constaints in the database, keyed by table
	Constraints(ColumnFilter) (DBConstraints, error)

	// For tables
	TableNames(Filter) ([]string, error)
	TableColumns(tableName string, filter ColumnFilter) ([]Column, error)

	// For views
	ViewNames(Filter) ([]string, error)
	ViewColumns(tableName string, filter ColumnFilter) ([]Column, error)

	// TranslateColumnType takes a Database column type and returns a go column type.
	TranslateColumnType(Column) Column
}

type DBConstraints struct {
	PKs     map[string]*PrimaryKey
	FKs     map[string][]ForeignKey
	Uniques map[string][]Constraint
}

type DBInfo struct {
	Schema string  `json:"schema"`
	Tables []Table `json:"tables"`
	Enums  []Enum  `json:"enums"`
}

type Enum struct {
	Name   string
	Type   string
	Values []string
}

type Filter struct {
	Include []string
	Exclude []string
}

type ForeignKey struct {
	Constraint
	ForeignTable   string   `json:"foreign_table"`
	ForeignColumns []string `json:"foreign_columns"`
}

type Interface interface {
	// Assemble the database information into a nice struct
	Assemble() (*DBInfo, error)
	// Imports to merge for generation
	Imports() (importers.Collection, error)
}

type PrimaryKey = Constraint

type RelType string

type Relationship struct {
	// The type of relationship. ToOne or ToMany
	// To know if it needs a single model or a slice
	Type RelType `json:"type"`
	orm.Relationship
}

type Table struct {
	Name string `json:"name"`
	// For dbs with real schemas, like Postgres.
	// Example value: "schema_name"."table_name"
	SchemaName string   `json:"schema_name"`
	Columns    []Column `json:"columns"`

	PKey    *PrimaryKey  `json:"p_key"`
	FKeys   []ForeignKey `json:"foreign_keys"`
	Uniques []Constraint `json:"unique"`

	IsJoinTable bool `json:"is_join_table"`

	Relationships []Relationship `json:"relationship"`

	// For views
	IsView bool `json:"is_view"`
}

type TableColumnTypeTranslator interface {
	// TranslateTableColumnType takes a Database column type and table name and returns a go column type.
	TranslateTableColumnType(c Column, tableName string) Column
}