model

type ColumnContainer interface {
	AddColumns(...IndexColumn)
	Columns() chan IndexColumn
}

type ColumnType int

type Database interface {
	Stmt

	Name() string
	IsIfNotExists() bool
	SetIfNotExists(bool) Database
	// contains filtered or unexported methods
}

type Index interface {
	Stmt
	ColumnContainer

	HasName() bool
	HasSymbol() bool
	Name() string
	Reference() Reference
	SetReference(Reference) Index
	SetSymbol(string) Index
	SetType(IndexType) Index
	SetName(string) Index
	Symbol() string
	IsBtree() bool
	IsHash() bool
	IsPrimaryKey() bool
	IsNormal() bool
	IsUnique() bool
	IsFullText() bool
	IsSpatial() bool
	IsForeginKey() bool

	// Normalize returns normalized index. If a normalization was performed
	// and the index is modified, returns a new instance of the Table object
	// along with a true value as the second return value.
	// Otherwise, Normalize() returns the receiver unchanged, with a false
	// as the second return value.
	Normalize() (Index, bool)

	// Clone returns the clone index
	Clone() Index
}

type IndexColumn interface {
	ID() string
	Name() string
	SetLength(string) IndexColumn
	HasLength() bool
	Length() string
}

type IndexKind int

type IndexType int

type Length interface {
	HasDecimal() bool
	Decimal() string
	SetDecimal(string) Length
	Length() string
}

type NullState int

type Reference interface {
	ColumnContainer

	ID() string
	String() string
	TableName() string
	OnDelete() ReferenceOption
	OnUpdate() ReferenceOption
	SetTableName(string) Reference
	SetMatch(ReferenceMatch) Reference
	SetOnDelete(ReferenceOption) Reference
	SetOnUpdate(ReferenceOption) Reference
	MatchFull() bool
	MatchPartial() bool
	MatchSimple() bool
}

type ReferenceMatch int

type ReferenceOption int

type Stmt interface {
	ID() string
}

type Stmts []Stmt

type Table interface {
	Stmt

	Name() string
	IsTemporary() bool
	SetTemporary(bool) Table
	IsIfNotExists() bool
	SetIfNotExists(bool) Table

	HasLikeTable() bool
	LikeTable() string
	SetLikeTable(string) Table

	AddColumn(TableColumn) Table
	Columns() chan TableColumn
	AddIndex(Index) Table
	Indexes() chan Index
	AddOption(TableOption) Table
	Options() chan TableOption

	LookupColumn(string) (TableColumn, bool)
	LookupIndex(string) (Index, bool)

	// Normalize returns normalized table. If a normalization was performed
	// and the table is modified, returns a new instance of the Table object
	// along with a true value as the second return value.
	// Otherwise, Normalize() returns the receiver unchanged, with a false
	// as the second return value.
	Normalize() (Table, bool)
}

type TableColumn interface {
	Stmt

	TableID() string
	SetTableID(string) TableColumn

	Name() string
	Type() ColumnType
	SetType(ColumnType) TableColumn

	HasLength() bool
	Length() Length
	SetLength(Length) TableColumn
	HasCharacterSet() bool
	CharacterSet() string
	SetCharacterSet(string) TableColumn
	HasCollation() bool
	Collation() string
	HasDefault() bool
	Default() string
	IsQuotedDefault() bool
	SetDefault(string, bool) TableColumn
	HasComment() bool
	Comment() string
	SetComment(string) TableColumn
	HasAutoUpdate() bool
	AutoUpdate() string
	SetAutoUpdate(string) TableColumn

	NullState() NullState
	SetNullState(NullState) TableColumn

	IsAutoIncrement() bool
	SetAutoIncrement(bool) TableColumn
	IsBinary() bool
	SetBinary(bool) TableColumn
	IsKey() bool
	SetKey(bool) TableColumn
	IsPrimary() bool
	SetPrimary(bool) TableColumn
	IsUnique() bool
	SetUnique(bool) TableColumn
	IsUnsigned() bool
	SetUnsigned(bool) TableColumn
	IsZeroFill() bool
	SetZeroFill(bool) TableColumn

	// NativeLength returns the "native" size of a column type. This is the length used if you do not explicitly specify it.
	// Currently only supports numeric types, but may change later.
	NativeLength() Length

	// Normalize returns normalized column. If a normalization was performed
	// and the column is modified, returns a new instance of the Table object
	// along with a true value as the second return value.
	// Otherwise, Normalize() returns the receiver unchanged, with a false
	// as the second return value.
	//
	// Normalization is performed on numertic type display lengths, synonym
	// types, and NULL expressions
	Normalize() (TableColumn, bool)

	// Clone returns the cloned column
	Clone() TableColumn
}

type TableOption interface {
	Stmt
	Key() string
	Value() string
	NeedQuotes() bool
}