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

# Functions

AllDescIDs returns all the IDs referenced by an element.
AllTargetDescIDs returns all the descriptor IDs referenced in the element.
AllTargetStateDescIDs applies AllTargetDescIDs to the whole target state.
ContainsDescID searches the element to see if it contains a descriptor id.
ElementString formats an element as a string by invoking FormatElement.
EqualElementKeys returns true if the two elements are equal over all of their scalar attributes and have the same type.
FormatElement formats the element into the SafeWriter.
FormatNode formats the node into the SafeWriter.
FormatTargetElement formats the target element into the SafeWriter.
GetDescID retrieves the descriptor ID from the element.
MaxElementVersion returns the maximum cluster version at which an element may be used.
MustQuery constructs a query using this package's schema.
NodeString formats a node as a string by invoking FormatNode.
VersionSupportsElementUse checks if an element may be used at a given version.
WalkColumnIDs calls f for every catid.ColumnID field in e.
WalkDescIDs calls f for every catid.DescID field in e.
WalkExpressions calls f for every catpb.Expression field in e.
WalkTypes calls f for every *types.T field in e.

# Constants

AttrMax is the largest possible Attr value.
ColumnFamilyID is the ID of the column family for this element.
ColumnID is the ID of the column for this element.
Comment is the comment metadata on descriptors.
ConstraintID is the ID of a constraint.
CurrentStatus is the current status of an element.
DescID is the descriptor ID to which this element belongs.
Element references an element.
Expr corresponds to the string representation of a SQL expression for an element.
IndexID is the index ID to which this element corresponds.
Name is the name of the element.
PartitionName corresponds to the name of a partition.
PolicyID is an attribute for row-level security policies to uniquely identify a policy within a table.
RecreateSourceIndexID is the index ID that we are replacing with this new index.
ReferencedColumnIDs corresponds to a slice of column IDs referenced by an element.
ReferencedDescID is the descriptor ID to which this element refers.
ReferencedFunctionIDs corresponds to a slice of function descriptor IDs referenced by an element.
ReferencedSequenceIDs corresponds to a slice of sequence descriptor IDs referenced by an element.
ReferencedTypeIDs corresponds to a slice of type descriptor IDs referenced by an element.
SeqNum is a number given to different elements of the same conceptual object.
SourceIndexID is the index ID of the source index for a newly created index.
Target is the reference from a node to a target.
TargetStatus is the target status of an element.
TemporaryIndexID is the index ID of the temporary index being populated during this index's backfill.
TriggerID is the ID of a trigger.
TypeName corresponds to the SQL string name of the type.
Usage is an attribute for column compute expression to identify why it's being added.

# Variables

JoinTarget generates a clause that joins the target to the corresponding element.
JoinTargetNode generates a clause that joins the target and node vars to the corresponding element.
Schema is the schema exported by this package covering the elements of scpb.

# Structs

Node represents a target element with a given current status.

# Type aliases

Attr are attributes used to identify, order, and relate nodes, targets, and elements to each other using the rel library.