package
19.1.0-beta.20190304+incompatible
Repository: https://github.com/darinpp/cockroach.git
Documentation: pkg.go.dev
# Functions
FindTableColumnByName returns the ordinal of the non-mutation column having the given name, if one exists in the given table.
FormatCatalogSequence nicely formats a catalog sequence using a treeprinter for debugging and testing.
FormatCatalogTable nicely formats a catalog table using a treeprinter for debugging and testing.
FormatCatalogView nicely formats a catalog view using a treeprinter for debugging and testing.
IsMutationColumn is a convenience function that returns true if the column at the given ordinal position is a mutation column.
IsMutationIndex is a convenience function that returns true if the index at the given ordinal position is a mutation index.
# Constants
PrimaryIndex selects the primary index of a table when calling the Table.Index method.
# Structs
FamilyColumn describes a single column that is part of a family definition.
ForeignKeyReference is a struct representing an outbound foreign key reference.
IndexColumn describes a single column that is part of an index definition.
# Interfaces
Catalog is an interface to a database catalog, exposing only the information needed by the query optimizer.
Column is an interface to a table column, exposing only the information needed by the query optimizer.
DataSource is an interface to a database object that provides rows, like a table, a view, or a sequence.
Family is an interface to a table column family, exposing only the information needed by the query optimizer.
Index is an interface to a database index, exposing only the information needed by the query optimizer.
Object is implemented by all objects in the catalog.
Schema is an interface to a database schema, which is a namespace that contains other database objects, like tables and views.
Sequence is an interface to a database sequence.
Table is an interface to a database table, exposing only the information needed by the query optimizer.
TableStatistic is an interface to a table statistic.
View is an interface to a database view, exposing only the information needed by the query optimizer.
# Type aliases
CheckConstraint is the SQL text for a check constraint on a table.
DataSourceName is an alias for tree.TableName, and is used for views and sequences as well as tables.
SchemaName is an alias for tree.TableNamePrefix, since it consists of the catalog + schema name.
StableID permanently and uniquely identifies a catalog object (table, view, index, column, etc.) within its scope:
data source StableID: unique within database index StableID: unique within table column StableID: unique within table
If a new catalog object is created, it will always be assigned a new StableID that has never, and will never, be reused by a different object in the same scope.