schema

type Column interface {
	Name() string                 // name of this column (without quotes).
	Rename() string               // change the name of this column (without quotes).
	DataType() DataType           // the abstract DB type of this column. Possible DB types vary according to the type of DBMS.
	DefaultValue() interface{}    // Specify a "default" value for the column, the value type must be a string or fmt.Stringer interface
	Nullable() bool               // Allow NULL values to be inserted into the column
	AllowedValues() []interface{} // set column allowed values when column type is enum or set
	Length() int                  // display size of the column.
	Precision() int               // precision of the column data, if it is numeric.
	Scale() int                   // scale of the column data, if it is numeric
	PrimaryKey() bool             // is a primary index
	AutoIncrement() bool          // Set INTEGER columns as auto-increment (primary key)
	Unsigned() bool               // whether this column is unsigned. This is only meaningful when [[type]] is `smallint`, `integer` or `bigint`.
	GeneratedAs() string          // Create a SQL compliant identity column (PostgreSQL)
	Alawys() bool                 // Used as a modifier for generatedAs() (PostgreSQL)
	Charset() string              // Specify a character set for the column (MySQL)
	Collate() string              // Specify a collate for the column (MySQL)
	After() string                // Place the column "after" another column (MySQL)
	First() string                // Place the column "first" in the table (MySQL)
	Append() string               // append
	Added() bool                  // Change the columns
	Changed() bool                // Change the columns
	StoredAs() string             // the stored generated column (MySQL)
	Srid() int                    // the srid of the column
	UseCurrent() bool             // the TIMESTAMP column to use CURRENT_TIMESTAMP as default value
	VirtualAs() string            // the virtual generated column (MySQL)
	Projection() string           //
	Comment() string              // the comment of the column
}

type ColumnOption func(column *ColumnSchema)

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

type ColumnTypeConverter func(column Column) (string, error)

type DataType string

type Dialect interface {
	// Create the column definition for a char type.
	TypeChar(column Column) (string, error)
	// Create the column definition for a string type.
	TypeString(column Column) (string, error)
	// Create the column definition for a text type.
	TypeText(column Column) (string, error)
	// Create the column definition for a medium text type.
	TypeMediumText(column Column) (string, error)
	// Create the column definition for a long text type.
	TypeLongText(column Column) (string, error)
	// Create the column definition for a big integer type.
	TypeBigInteger(column Column) (string, error)
	// Create the column definition for an integer type.
	TypeInteger(column Column) (string, error)
	// Create the column definition for a medium integer type.
	TypeMediumInteger(column Column) (string, error)
	// Create the column definition for a tiny integer type.
	TypeTinyInteger(column Column) (string, error)

	// Create the column definition for a tiny blob type.
	TypeTinyBlob(column Column) (string, error)
	// Create the column definition for an blob type.
	TypeBlob(column Column) (string, error)
	// Create the column definition for a medium blob type.
	TypeMediumBlob(column Column) (string, error)
	// Create the column definition for a long blob type.
	TypeLongBlob(column Column) (string, error)

	// Create the column definition for a small integer type.
	TypeSmallInteger(column Column) (string, error)
	// Create the column definition for a float type.
	TypeFloat(column Column) (string, error)
	// Create the column definition for a double type.
	TypeDouble(column Column) (string, error)
	// Create the column definition for a decimal type.
	TypeDecimal(column Column) (string, error)
	// Create the column definition for a boolean type.
	TypeBoolean(column Column) (string, error)
	// Create the column definition for an enumeration type.
	TypeEnum(column Column) (string, error)
	// Create the column definition for a set enumeration type.
	TypeSet(column Column) (string, error)
	// Create the column definition for a json type.
	TypeJson(column Column) (string, error)
	// Create the column definition for a jsonb type.
	TypeJsonb(column Column) (string, error)
	// Create the column definition for a date type.
	TypeDate(column Column) (string, error)
	// Create the column definition for a date-time type.
	TypeDateTime(column Column) (string, error)
	// Create the column definition for a date-time (with time zone) type.
	TypeDateTimeTz(column Column) (string, error)
	// Create the column definition for a time type.
	TypeTime(column Column) (string, error)
	// Create the column definition for a time (with time zone) type.
	TypeTimeTz(column Column) (string, error)
	// Create the column definition for a timestamp type.
	TypeTimestamp(column Column) (string, error)
	// Create the column definition for a timestamp (with time zone) type.
	TypeTimestampTz(column Column) (string, error)
	// Create the column definition for a year type.
	TypeYear(column Column) (string, error)
	// Create the column definition for a binary type.
	TypeBinary(column Column) (string, error)
	// Create the column definition for a uuid type.
	TypeUuid(column Column) (string, error)
	// Create the column definition for an IP address type.
	TypeIpAddress(column Column) (string, error)
	// Create the column definition for a MAC address type.
	TypeMacAddress(column Column) (string, error)
	// Create the column definition for a spatial Geometry type.
	TypeGeometry(column Column) (string, error)
	// Create the column definition for a spatial Point type.
	TypePoint(column Column) (string, error)
	// Create the column definition for a spatial LineString type.
	TypeLineString(column Column) (string, error)
	// Create the column definition for a spatial Polygon type.
	TypePolygon(column Column) (string, error)
	// Create the column definition for a spatial GeometryCollection type.
	TypeGeometryCollection(column Column) (string, error)
	// Create the column definition for a spatial MultiPoint type.
	TypeMultiPoint(column Column) (string, error)
	// Create the column definition for a spatial MultiLineString type.
	TypeMultiLineString(column Column) (string, error)
	// Create the column definition for a spatial MultiPolygon type.
	TypeMultiPolygon(column Column) (string, error)
	// Modify the column
	ModifyColumn(column Column) string
	// Compile the query exists of the table
	CompileTableExists(tableName string, tableSchema ...string) (string, error)
	// Compile the query to determine the list of columns.
	CompileColumnListing(tableName string, tableSchema ...string) (string, error)
	// Compile a create table command.
	CompileCreate(table Table) (string, error)
	//  Compile a modify columns command.
	CompileModifyColumns(table Table) (string, error)
	//  Compile a modify column command.
	CompileModifyColumn(table Table, columnName string) (string, error)
	// Compile add columns.
	CompileAddColumns(table Table) (string, error)
	// Compile add columns.
	CompileAddColumn(table Table, columnName string) (string, error)
	// Compile a primary key command.
	CompilePrimaryKey(table Table, columnNames ...string) (string, error)
	// Compile a drop primary key command.
	CompileDropPrimaryKey(table Table) (string, error)
	// Compile an index creation command.
	CompileIndex(table Table, index Index) (string, error)
	// Compile a drop index command.
	CompileDropIndex(table Table, indexName string) (string, error)
	// Compile a drop unique index command.
	CompileDropUnique(table Table, indexName string) (string, error)
	// Compile a drop spatial index command.
	CompileDropSpatialIndex(table Table, indexName string) (string, error)
	// Compile a drop foreign index command.
	CompileDropForeign(table Table, indexName string) (string, error)
	// Compile a drop table command.
	CompileDrop(tableName string) (string, error)
	// Compile a drop table (if exists) command.
	CompileDropIfExists(tableName string) (string, error)
	// Compile a drop column command.
	CompileDropColumn(table Table, columnNames []string) (string, error)
	// Compile a rename table command.
	CompileRenameTable(table Table, toName string) (string, error)
	// Compile a rename index command.
	CompileRenameIndex(table Table, from string, to string) (string, error)
	// Compile the SQL needed to drop all tables. [PostgreSQL]
	CompileDropAllTables(tableNames ...string) (string, error)
	// Compile the SQL needed to drop all views.
	CompileDropAllViews(viewNames ...string) (string, error)
	// Compile the SQL needed to drop all types.
	CompileDropAllTypes(schemaNames ...string) (string, error)
	// Compile the SQL needed to retrieve all table names.
	CompileGetAllTables(schemaNames ...string) (string, error)
	// Compile the SQL needed to retrieve all view names.
	CompileGetAllViews(schemaNames ...string) (string, error)
	// Compile the SQL needed to retrieve all type names. [PostgreSQL]
	CompileGetAllTypes() (string, error)
	// Compile the SQL needed to rebuild the database. [SQLite]
	CompileRebuild() (string, error)
	// Compile the command to enable foreign key constraints.
	CompileEnableForeignKeyConstraints() (string, error)
	// Compile the command to disable foreign key constraints.
	CompileDisableForeignKeyConstraints() (string, error)
	// Load table columns from the database
	LoadColumns(tableName string, tableSchema ...string) ([]Column, error)
	// Load table from the database
	LoadTable(tableName string, tableSchema ...string) (Table, error)
	// Load table constraints from the database
	LoadTableConstraints(tableName string, tableSchema ...string) (TableConstraints, error)
}

type Index interface {
	Name() string          // index name
	Type() IndexType       // index type
	ColumnNames() []string // the column names of index
	Algorithm() string     // index algorithm
	Comment() string       // the comment of index
}

type IndexOptions func(index *IndexSchema)

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

type IndexType string

type Query func(sql string, dest interface{}, args ...interface{}) (int, error)

type Table interface {
	Name() string             // The name of the table
	Schema() string           // The schema of the table
	Prefix() string           // The prefix of the table.
	Engine() string           // The storage engine that should be used for the table.
	Charset() string          // The default character set that should be used for the table.
	Collation() string        // The collation that should be used for the table.
	IsTemporary() bool        // Whether to make the table temporary.
	Comment() string          // the comment of the table
	Columns() []Column        // The columns that should be added to the table.
	PrimaryKey() []string     // The primary keys of the table
	AddedColumns() []Column   // the added columns
	ChangedColumns() []Column // the changed columns
	Commands() []TableCommand // the table commands
}

type TableCommand func(d Dialect) (string, error)

type TableConstraintInfo struct {
	Name               string         `db:"name"`
	ColumnName         string         `db:"column_name"`
	Type               string         `db:"type"`
	ForeignTableSchema sql.NullString `db:"foreign_table_schema"`
	ForeignTableName   sql.NullString `db:"foreign_table_name"`
	ForeignColumnName  sql.NullString `db:"foreign_column_name"`
	OnUpdate           sql.NullString `db:"on_update"`
	OnDelete           sql.NullString `db:"on_delete"`
	CheckExpr          sql.NullString `db:"check_expr"`
}

type TableConstraintInfos []TableConstraintInfo

type TableConstraints struct {
	PrimaryKey  constraint.PrimaryKey
	ForeignKeys []constraint.ForeignKey
	Checks      []constraint.Check
	Uniques     []constraint.Unique
}

type TableHandler func(table *TableSchema)

type TableOption func(column *TableSchema)

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