package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev

# Functions

GetDescriptorMetadata extracts metadata out of a raw descpb.Descriptor.
GetDescriptors is a replacement for Get* methods on descpb.Descriptor.
IsSystemConfigID returns whether this ID is for a system config object.
IsVirtualTable returns true if the TableDescriptor describes a virtual Table (like the information_schema tables) and thus doesn't need to be physically stored.
JoinTypeFromAstString takes a join string as found in a SQL statement (e.g.
MustSetModificationTime returns true iff a descriptor's ModificationTime field must be set to the given MVCC timestamp.
ToScanLockingDurability converts a tree.LockingDurability to its corresponding ScanLockingDurability.
ToScanLockingStrength converts a tree.LockingStrength to its corresponding ScanLockingStrength.
ToScanLockingWaitPolicy converts a tree.LockingWaitPolicy to its corresponding ScanLockingWaitPolicy.

# Constants

BaseFormatVersion corresponds to the encoding described in https://www.cockroachlabs.com/blog/sql-in-cockroachdb-mapping-table-data-to-key-value-storage/.
BaseIndexFormatVersion corresponds to the original encoding of secondary indexes that don't respect table level column family definitions.
EmptyArraysInInvertedIndexesVersion corresponds to the encoding of secondary indexes that is identical to SecondaryIndexFamilyFormatVersion, but also includes a key encoding for empty arrays in array inverted indexes.
Prettier aliases for JoinType values.
FamilyFormatVersion corresponds to the encoding described in https://github.com/cockroachdb/cockroach/blob/master/docs/RFCS/20151214_sql_column_families.md.
Prettier aliases for JoinType values.
Prettier aliases for JoinType values.
InterleavedFormatVersion corresponds to the encoding described in https://github.com/cockroachdb/cockroach/blob/master/docs/RFCS/20160624_sql_interleaved_tables.md.
Prettier aliases for JoinType values.
InvalidID is the uninitialised descriptor id.
InvalidMutationID is the uninitialised mutation id.
LatestIndexDescriptorVersion corresponds to the latest encoding version.
Prettier aliases for JoinType values.
Prettier aliases for JoinType values.
Prettier aliases for JoinType values.
PrimaryIndexWithStoredColumnsVersion corresponds to the encoding of primary indexes that is identical to the unspecified scheme previously in use (the IndexDescriptorVersion type was originally only used for secondary indexes) but with the guarantee that the StoreColumnIDs and StoreColumnNames slices are explicitly populated and maintained.
Prettier aliases for JoinType values.
Prettier aliases for JoinType values.
Prettier aliases for JoinType values.
SecondaryIndexFamilyFormatVersion corresponds to the encoding of secondary indexes that use table level column family definitions.
StrictIndexColumnIDGuaranteesVersion corresponds to the encoding of secondary indexes that is identical to EmptyArraysInInvertedIndexesVersion, but also includes guarantees on the column ID slices in the index: each column ID in the ColumnIDs, StoreColumnIDs and KeySuffixColumnIDs slices are unique within each slice, and the slices form disjoint sets.

# Variables

AnonymousTable is the empty table name, used when a data source has no own name, e.g.

# Type aliases

ColumnID is a custom type for ColumnDescriptor IDs.
ColumnIDs is a slice of ColumnDescriptor IDs.
ConstraintID is a custom type for TableDescriptor constraint IDs.
DescriptorVersion is a custom type for TableDescriptor Versions.
FamilyID is a custom type for ColumnFamilyDescriptor IDs.
FormatVersion is a custom type for TableDescriptor versions of the sql to key:value mapping.
ID is a custom type for {Database,Table}Descriptor IDs.
IDs is a sortable list of IDs.
IndexDescriptorVersion is a custom type for IndexDescriptor Versions.
IndexID is a custom type for IndexDescriptor IDs.
MutationID is a custom type for TableDescriptor mutations.
PGAttributeNum is a custom type for ColumnDescriptor's PGAttributeNum field.
PolicyID is a custom type for TableDescriptor policy IDs.
TriggerID is a custom type for TableDescriptor trigger IDs.