package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
# Constants
BackfillType represents index backfills.
EarliestPhase references the earliest possible execution phase.
LatestPhase references the latest possible execution phase.
MutationType represents metadata changes.
PostCommitNonRevertiblePhase is like PostCommitPhase but in which target status changes are non-revertible.
PostCommitPhase refers to execution of ops occurring after the user transaction has committed (i.e., in the async schema change job).
PreCommitPhase refers to execution of ops occurring during the user transaction immediately before commit.
StatementPhase refers to execution of ops occurring during statement execution during the user transaction.
ValidationType represents constraint and unique index validations performed using internal queries.
# Structs
AddCheckConstraint adds a non-existent check constraint to the table.
AddColumnComputeExpression will add a new compute expression to a column.
AddColumnDefaultExpression adds a DEFAULT expression to a column.
AddColumnFamily adds a new column family to the table.
AddColumnOnUpdateExpression adds an ON UPDATE expression to a column.
AddColumnToIndex mutates an index to add a column to it.
AddDatabaseZoneConfig adds a zone config to a database.
AddDescriptorName marks a descriptor's name as to-be-added to the system.Namespace table.
AddForeignKeyConstraint adds a non-existent foreign key constraint to the table.
AddIndexPartitionInfo adds a partitioning descriptor to an existing index.
AddIndexZoneConfig adds a zone config to an index.
AddNamedRangeZoneConfig adds a zone config to a named range.
AddOwnerBackReferenceInSequence adds a sequence ownership back-reference from a sequence.
AddPartitionZoneConfig adds a zone config to a partition.
AddPolicy adds a policy to a table.
AddSchemaParent adds the schema - parent database relationship.
AddSequenceOwner adds a sequence ownership reference from the owning table column.
AddTableColumnBackReferencesInFunctions adds back-references to columns from referenced functions.
AddTableConstraintBackReferencesInFunctions adds back references to CHECK constraint to referenced functions.
AddTableZoneConfig adds a zone config to a table.
AddTrigger adds a trigger to a table.
AddTriggerBackReferencesInRoutines adds back references to a trigger from referenced functions.
AddUniqueWithoutIndexConstraint adds a non-existent unique_without_index constraint to the table.
AssertColumnFamilyIsRemoved asserts that a column family is removed, which is used as a validation to make sure that the family the element reaches absent.
BackfillIndex specifies an index backfill operation.
CreateGCJobForDatabase creates a GC job for a given database.
CreateGCJobForIndex creates a GC job for a given table index.
CreateGCJobForTable creates a GC job for a given table, when necessary.
CreateSchemaChangerJob constructs the job for the declarative schema changer post-commit phases.
DeleteDescriptor deletes a descriptor.
DeleteSchedule is used to delete a schedule ID from the database.
DiscardNamedRangeZoneConfig discards a zone config from a named range.
DiscardSubzoneConfig discards the subzone config for the given descriptor ID.
DiscardTableZoneConfig discards the zone config for the given table ID.
DiscardZoneConfig discards the zone config for the given ID.
DrainDescriptorName marks a descriptor's name as to-be-drained from the system.Namespace table.
MakeAbsentColumnDeleteOnly adds a new column in the DELETE_ONLY state.
MakeAbsentColumnNotNullWriteOnly adds a non-existent NOT NULL constraint, disguised as a CHECK constraint, to the table in the WRITE_ONLY state.
MakeAbsentIndexBackfilling adds a non-existent index to the table in the BACKFILLING state.
MakeAbsentTempIndexDeleteOnly adds a non-existent index to the table in the DELETE_ONLY state.
MakeBackfilledIndexMerging transitions an index addition mutation from DELETE_ONLY to MERGING.
MakeBackfillingIndexDeleteOnly transitions an index addition mutation from BACKFILLING to DELETE_ONLY.
MakeDeleteOnlyColumnAbsent removes a dropped column mutation in DELETE_ONLY from the table.
MakeDeleteOnlyColumnWriteOnly transitions a column addition mutation from DELETE_ONLY to WRITE_ONLY.
MakeDeleteOnlyIndexWriteOnly transitions an index addition mutation from DELETE_ONLY to WRITE_ONLY.
MakeIndexAbsent removes a dropped index mutation in DELETE_ONLY from the table.
MakeMergedIndexWriteOnly transitions an index addition mutation from MERGING to WRITE_ONLY.
MakePublicCheckConstraintValidated moves a public check constraint to VALIDATED.
MakePublicColumnNotNullValidated moves a PUBLIC column not null to VALIDATED.
MakePublicColumnWriteOnly zeros out the column and adds a column drop mutation in WRITE_ONLY for it.
MakePublicForeignKeyConstraintValidated moves a public check constraint to VALIDATED.
MakePublicPrimaryIndexWriteOnly zeros out the table's primary index and adds an index drop mutation in WRITE_ONLY for it.
MakePublicSecondaryIndexWriteOnly zeros out the secondary index and adds an index drop mutation in WRITE_ONLY for it.
MakePublicUniqueWithoutIndexConstraintValidated moves a public unique_without_index constraint to VALIDATED.
MakeValidatedCheckConstraintPublic moves a new, validated check constraint from mutation to public.
MakeValidatedColumnNotNullPublic moves a new, validated NOT NULL, disguised as a CHECK constraint, from mutation to public.
MakeValidatedForeignKeyConstraintPublic moves a new, validated foreign key constraint from mutation to public.
MakeValidatedPrimaryIndexPublic moves a new primary index from its mutation to public.
MakeValidatedSecondaryIndexPublic moves a new primary index from its mutation to public.
MakeValidatedUniqueWithoutIndexConstraintPublic moves a new, validated unique_without_index constraint from mutation to public.
MakeWriteOnlyColumnDeleteOnly transitions a column drop mutation from WRITE_ONLY to DELETE_ONLY.
MakeWriteOnlyColumnPublic moves a new column from its mutation to public.
MakeWriteOnlyIndexDeleteOnly transitions an index drop mutation from WRITE_ONLY to DELETE_ONLY.
MarkDescriptorAsDropped changes the descriptor's state to DROPPED.
MarkDescriptorAsPublic changes the descriptor's state to PUBLIC.
MaybeAddSplitForIndex adds a admin split range temproarily on this index.
MergeIndex specifies an index merge operation.
NotImplemented is a placeholder for operations which haven't been defined yet.
NotImplementedForPublicObjects is a placeholder for operations which haven't defined, these are okay when dropping objects.
RefreshStats is used to queue a table for stats refresh.
RemoveBackReferenceInTypes removes back references to a descriptor in the specified types.
RemoveBackReferencesInRelations removes back references to a view in the specified tables, views or sequences.
RemoveCheckConstraint removes a check constraint from a table.
RemoveColumnComment is used to delete a comment associated with a column.
RemoveColumnComputeExpression will remove the compute expression from a column.
RemoveColumnDefaultExpression removes a DEFAULT expression from a column.
RemoveColumnFromIndex mutates an index to removed a column from it.
RemoveColumnNotNull removes a NOT NULL, disguised as a CHECK constraint, from a table.
RemoveColumnOnUpdateExpression removes an ON UPDATE expression from a column.
RemoveConstraintComment is used to delete a comment associated with a constraint.
RemoveDatabaseComment is used to delete a comment associated with a database.
RemoveDatabaseRoleSettings is used to delete a role setting for a database.
RemoveDroppedColumnType unsets a column type and computed expr.
RemoveDroppedIndexPartialPredicate removes a partial predicate expression in a dropped secondary index.
RemoveForeignKeyBackReference removes a foreign key back-reference from the referenced table.
RemoveForeignKeyConstraint removes a foreign key from the origin table.
RemoveIndexComment is used to delete a comment associated with an index.
RemoveJobStateFromDescriptor removes the reference to a job from the descriptor and clears the pending targets.
RemoveOwnerBackReferenceInSequence removes a sequence ownership back-reference from a sequence.
RemovePolicy removes a policy from a table.
RemoveSchemaComment is used to delete a comment associated with a schema.
RemoveSchemaParent removes the schema - parent database relationship.
RemoveSequenceOwner removes a sequence ownership reference from the owning table column.
RemoveTableColumnBackReferencesInFunctions removes back-references to columns from referenced functions.
RemoveTableComment is used to delete a comment associated with a table.
RemoveTableConstraintBackReferencesFromFunctions removes back references to CHECK constraint from referenced functions.
RemoveTrigger is used to delete a trigger associated with a table.
RemoveTriggerBackReferencesInRoutines removes back-references to a trigger from referenced functions.
RemoveTypeComment is used to delete a comment associated with a Type.
RemoveUniqueWithoutIndexConstraint removes a unique_without_index from the origin table.
RemoveUserPrivileges is used to revoke a user's privileges.
SetAddedIndexPartialPredicate sets a partial predicate expression in an added secondary index.
SetColumnName renames a column.
SetConstraintName renames a constraint.
SetIndexName renames an index.
SetJobStateOnDescriptor adds the reference to a job to the descriptor.
SetNameInDescriptor sets the name field of the descriptor.
SetPolicyName sets the name of a policy.
SetTriggerEnabled sets the "enabled" status of a trigger, which indicates whether it will be executed in response to a triggering event.
SetTriggerEvents sets the events for a trigger, which indicate the operations that fire the trigger.
SetTriggerForwardReferences sets the forward references to relations, types, and routines for a trigger.
SetTriggerFunctionCall sets the trigger-function call for a trigger.
SetTriggerName sets the name of a trigger.
SetTriggerTiming sets the timing of a trigger, which indicates when it executes in relation to the triggering event.
SetTriggerTransition sets the transition alias(es) of a trigger.
SetTriggerWhen sets the WHEN condition of a trigger.
StatementForDropJob is a statement used to build a description for a drop job.
UndoAllInTxnImmediateMutationOpSideEffects undoes the side effects of all immediate mutation ops which have already executed.
UpdateSchemaChangerJob may update the job's cancelable status.
UpdateTableBackReferencesInSequences updates back references to a table expression (in a column or a check constraint) in the specified sequences.
UpdateTableBackReferencesInTypes updates back references to a table in the specified types.
UpdateTypeBackReferencesInTypes updates back references to a type in the specified types.
UpsertColumnComment is used to add a comment to a column.
UpsertColumnType sets the type of a new column.
UpsertConstraintComment is used to add a comment to a constraint.
UpsertDatabaseComment is used to add a comment to a database.
UpsertIndexComment is used to add a comment to an index.
UpsertSchemaComment is used to add a comment to a schema.
UpsertTableComment is used to add a comment to a table.
UpsertTypeComment is used to add a comment to a Type.
ValidateColumnNotNull validates a NOT NULL constraint on a table's column.
ValidateConstraint validates a check constraint on a table's columns.
ValidateIndex validates the following on an index addition that is in WRITE_ONLY: 1.
# Interfaces
BackfillOp is an operation which can be visited by BackfillVisitor.
BackfillVisitor is a visitor for BackfillOp operations.
DeferredMutationOp is an operation which can be visited by DeferredMutationVisitor.
DeferredMutationVisitor is a visitor for DeferredMutationOp operations.
ImmediateMutationOp is an operation which can be visited by ImmediateMutationVisitor.
ImmediateMutationVisitor is a visitor for ImmediateMutationOp operations.
Op represents an action to be taken on a single descriptor.
ValidationOp is an operation which can be visited by ValidationVisitor.
ValidationVisitor is a visitor for ValidationOp operations.