schema

type Column interface {
	SetName(string)
	Name() string
	SetPosition(int64)
	Position() int64
	SetNullable(string)
	Nullable() string
	SetSpannerType(string)
	SpannerType() string
	SetIsGenerated(bool)
	IsGenerated() bool
	SetGenerationExpression(string)
	GenerationExpression() string
	SetIsStored(string)
	IsStored() string
	SetSpannerState(string)
	SpannerState() string
	SetPrimaryKey(bool)
	PrimaryKey() bool
	SetAllowCommitTimestamp(bool)
	AllowCommitTimestamp() bool
	Type() spansql.Type
}

type ColumnIterator interface {
	ResetIterator()
	HasNext() bool
	GetNext() Column
}

type Columns interface {
	ColumnIterator
	Columns() []Column
	AddColumn(Column)
	ColumnNames() []string
	PrimaryKeys() Columns
	Len() int
}

type Index interface {
	SetIndexName(string)
	IndexName() string
	SetIsUnique(bool)
	IsUnique() bool
	SetIsNullFiltered(bool)
	IsNullFiltered() bool
	SetIndexState(string)
	IndexState() string
}

type IndexIterator interface {
	ResetIterator()
	HasNext() bool
	GetNext() Index
}

type Indexes interface {
	IndexIterator
	Indexes() []Index
	AddIndex(Index)
}

type Schema interface {
	SetTable(Table) // TODO: Remove this
	Table() Table
	AddTable(Table)
	Tables() Tables
	GetTable(string) Table

	// Traverse should be called after a schema load operation to detect interleaved relationships
	Traverse() error
}

type Table interface {
	SetName(string)
	Name() string
	SetType(string)
	Type() string
	HasParent() bool
	SetParentName(string)
	ParentName() string
	SetParent(Table)
	Parent() Table
	HasChild() bool
	SetChildName(string)
	ChildName() string
	SetChild(Table)
	Child() Table

	SetSpanenrState(string)
	SpannerState() string

	AddColumn(Column)
	AddIndex(Index)
	Columns() Columns
	ColumnNames() []string

	PrimaryKeys() Columns
	PrimaryKeyNames() []string
	PointInsertStatement() (string, error)
	PointReadStatement(...string) (string, error)
	TableSample(float64) (string, error)

	IsView() bool
	// IsInterleaved will return true if the table has a parent or child
	IsInterleaved() bool
	// IsApex will return true if the table is the apex of an interleaved relationship
	IsApex() bool
	// IsBottom will return true if table is the bottom of an interleaved relationship
	IsBottom() bool
	// GetApex will return the top level parent or nil if it does not exist
	GetApex() Table
	GetAllRelationNames() []string
}

type TableIterator interface {
	ResetIterator()
	HasNext() bool
	GetNext() Table
}

type Tables interface {
	TableIterator
	Len() int
	Tables() []Table
	AddTable(Table)
	GetTable(string) Table
	Traverse() error
}