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

# Functions

CommentsMetadataPrefix returns the key prefix for all comments in the system.comments table.
DecodeCommentMetadataID decodes a CommentKey from comments metadata key.
DecodeNameMetadataKey is the reciprocal of EncodeNameKey.
EncodeNameKey encodes nameKey using codec.
IndexColumnEncodingDirection converts a direction from the proto to an encoding.Direction.
IndexKeyValDirs returns the corresponding encoding.Directions for all the encoded values in index's "fullest" possible index key, including directions for table/index IDs and the index column values.
IsValidCommentType checks if a given comment type is in the valid value range.
MakeAllDescsMetadataKey returns the key for all descriptors.
MakeCommentKey returns a new CommentKey.
MakeDatabaseChildrenNameKeyPrefix constructs a key which is a prefix to all namespace entries for children of the requested database.
MakeDescMetadataKey returns the key for the descriptor.
MakeObjectCommentsMetadataPrefix returns the key prefix for a type of comments of a descriptor.
PrettyKey pretty-prints the specified key, skipping over the first `skip` fields.
PrettySpan returns a human-readable representation of a span.
PrettySpans returns a human-readable description of the spans.

# Constants

ColumnCommentType comment on a column.
ConstraintCommentType comment on a constraint.
DatabaseCommentType comment on a database.
DefaultDatabaseName is the name ofthe default CockroachDB database used for connections without a current db set.
FunctionCommentType comment on a function.
IndexCommentType comment on an index.
MaxCommentTypeValue is the max possible integer of CommentType type.
PgDatabaseName is the name of the default postgres system database.
SchemaCommentType comment on a schema.
TableCommentType comment on a table/view/sequence.
TypeCommentType comment on a type.

# Variables

AllCommentTypes is a slice of all valid schema comment types.
AllTableCommentTypes is a slice of all valid comment types on table elements.
DefaultUserDBs is a set of the databases which are present in a new cluster.

# Structs

CommentKey represents the primary index key of system.comments table.

# Type aliases

CommentType the type of the schema object on which a comment has been applied.