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

# Packages

# Functions

CanHaveCompositeKeyEncoding returns true if key columns of the given kind can have a composite encoding.
CheckDatumTypeFitsColumnType verifies that a given scalar value type is valid to be stored in a column of the given column type.
ColTypeInfoFromColTypes creates a ColTypeInfo from []ColumnType.
ColTypeInfoFromColumns creates a ColTypeInfo from []catalog.Column.
ColTypeInfoFromResCols creates a ColTypeInfo from ResultColumns.
ColumnTypeIsIndexable returns whether the type t is valid as an indexed column.
ColumnTypeIsInvertedIndexable returns whether the type t is valid to be indexed using an inverted index.
ColumnTypeIsOnlyInvertedIndexable returns true if the type t is only indexable via an inverted index.
CompareDatums compares two datum rows according to a column ordering.
GetSystemColumnKindFromColumnID returns the kind of system column that colID refers to.
GetTraceAgeColumnIdx retrieves the index of the age column depending on whether the compact format is used.
IsColIDSystemColumn returns whether a column ID refers to a system column.
IsSystemColumnName returns whether or not a name is a reserved system column name.
MustBeValueEncoded returns true if columns of the given kind can only be value encoded.
NewSourceInfoForSingleTable creates a simple DataSourceInfo which maps the same tableAlias to all columns.
NewUndefinedColumnError creates an error that represents a missing database column.
ProcessTargetColumns returns the column descriptors identified by the given name list.
ResolveAllColumnsSelector performs name resolution for a qualified star using a resolver.
ResolveColumnItem performs name resolution for a column item using a resolver.
ResultColumnsFromColDescs is used by ResultColumnsFromColumns and by tests.
ResultColumnsFromColumns converts []catalog.Column to []ResultColumn.
ValidateColumnDefType returns an error if the type of a column definition is not valid.

# Constants

ExactlyOne indicates just one source matching the requested name.
MoreThanOne signals an ambiguous match.
MVCCTimestampColumnID is the ColumnID of the MVCC timestamp column.
MVCCTimestampColumnName is the name of the MVCC timestamp system column.
NoResults for when there is no result.
OriginIDColumnID is the ColumnID of the OriginID column which returns the OriginID from the column family with the largest OriginTimestamp.
OriginIDColumnName is the name of the OriginID system column.
OriginTimestampColumnID is the ColumnID of the OriginTimestamp column which returns the most recent OriginTimestamp from the MVCCValueHeader.
OriginTimestampColumnName is the name of the OriginTimestamp system column.
RangesExtraRenders describes the extra projections in crdb_internal.ranges not included in crdb_internal.ranges_no_leases.
TableOIDColumnID is the ID of the tableoid system column.
TableOIDColumnName is the name of the tableoid system column.

# Variables

AllSystemColumnDescs contains all registered system columns.
AlterRangeRelocateColumns are the result columns of an ALTER RANGE .
AlterTableRelocateColumns are the result columns of an ALTER TABLE/INDEX .
AlterTableScatterColumns are the result columns of an ALTER TABLE/INDEX .
AlterTableSplitColumns are the result columns of an ALTER TABLE/INDEX .
AlterTableUnsplitColumns are the result columns of an ALTER TABLE/INDEX .
ExplainPlanColumns are the result columns of various EXPLAIN variants.
ExportColumns are the result columns of an EXPORT statement (i.e.
ExportColumnTypes is the type schema of the EXPORT statement.
IdentifySystemColumns is the schema for IDENTIFY_SYSTEM.
MVCCTimestampColumnDesc is a column descriptor for the MVCC system column.
MVCCTimestampColumnType is the type of the MVCC timestamp system column.
NoOrdering is used to indicate an empty ColumnOrdering.
OriginIDColumnDesc is a column descriptor for the OriginID system column.
OriginIDColumnType is the type of the OriginID system column.
OriginTimestampColumnDesc is a column descriptor for the OriginTimestamp system column.
OriginTimestampColumnType is the type of the OriginTimestamp system column.
Ranges is the schema for crdb_internal.ranges.
RangesNoLeases is the schema for crdb_internal.ranges_no_leases.
ScrubColumns are the result columns of a SCRUB statement.
SequenceSelectColumns are the result columns of a sequence data source.
ShowCommitTimestampColumns are the result columns of SHOW COMMIT TIMESTAMP.
ShowCompactTraceColumns are the result columns of a SHOW COMPACT [KV] TRACE statement.
ShowCompletionsColumns are the result columns of a SHOW COMPLETIONS statement.
ShowFingerprintsColumns are the result columns of a SHOW EXPERIMENTAL_FINGERPRINTS FROM TABLE statement.
ShowReplicaTraceColumns are the result columns of a SHOW EXPERIMENTAL_REPLICA TRACE statement.
ShowSyntaxColumns are the columns of a SHOW SYNTAX statement.
ShowTenantFingerprintsColumns are the result columns of a SHOW EXPERIMENTAL_FINGERPRINTS FROM TENANT statement.
ShowTraceColumns are the result columns of a SHOW [KV] TRACE statement.
TableOIDColumnDesc is a column descriptor for the tableoid column.
TenantColumns appear in all SHOW VIRTUAL CLUSTER queries.
TenantColumnsNoReplication appear in all SHOW VIRTUAL CLUSTER queries, except for SHOW VIRTUAL CLUSTER ..
TenantColumnsWithCapabilities is appended to TenantColumns and TenantColumnsNoReplication for SHOW VIRTUAL CLUSTER ..
TenantColumnsWithPriorReplication is appended to TenantColumns and TenantColumnsNoReplication for SHOW VIRTUAL CLUSTER ..
TenantColumnsWithReplication is appended to TenantColumns for SHOW VIRTUAL CLUSTER ..

# Structs

ColTypeInfo is a type that allows multiple representations of column type information (to avoid conversions and allocations).
ColumnOrderInfo describes a column (as an index) and a desired order direction.
ColumnResolver is a utility struct to be used when resolving column names to point to one of the data sources and one of the column IDs in that data source.
DataSourceInfo provides column metadata for exactly one data source.
ResultColumn contains the name and type of a SQL "cell".

# Interfaces

ColumnItemResolver is the helper interface to resolve column items.
ColumnResolutionResult is an opaque reference returned by ColumnItemResolver.Resolve().
ColumnSourceMeta is an opaque reference passed through column item resolution.

# Type aliases

ColumnOrdering is used to describe a desired column ordering.
NumResolutionResults represents the number of results in the lookup of data sources matching a given prefix.
ResultColumns is the type used throughout the sql module to describe the column types of a table.