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

# Functions

ColumnReferencedByPartialIndex is returned when an attempt is made to modify a column that is referenced in a partial index's predicate.
ColumnReferencedByPartialUniqueWithoutIndexConstraint is almost the same as ColumnReferencedByPartialIndex except it's used when altering a column that is referenced in a partial unique without index constraint's predicate.
IsCCLRequiredError returns whether the error is a CCLRequired error.
IsDiskFullError checks whether this is a disk full error.
IsDistSQLRetryableError returns true if the supplied error, or any of its parent causes is an rpc error.
IsMissingDescriptorError checks whether the error has any indication that it corresponds to a missing descriptor of any kind.
IsOutOfMemoryError checks whether this is an out of memory error.
IsRelationAlreadyExistsError checks whether this is an error for a preexisting relation.
IsUndefinedColumnError checks whether this is an undefined column error.
IsUndefinedDatabaseError checks whether this is an undefined database error.
IsUndefinedRelationError checks whether this is an undefined relation error.
IsUndefinedSchemaError checks whether this is an undefined schema error.
MakeObjectAlreadyExistsError creates an error for a namespace collision with an arbitrary descriptor type.
NewAggInAggError creates an error for the case when an aggregate function is contained within another aggregate function.
NewAlterDependsOnDurationExprError creates an error for attempting to alter the internal column created for the duration expression.
NewAlterDependsOnExpirationExprError creates an error for attempting to alter the column that is referenced in the expiration expression.
NewCCLRequiredError creates an error for when a CCL feature is used in an OSS binary.
NewColumnAlreadyExistsInIndexError creates an error for a preexisting column in index.
NewColumnAlreadyExistsInRelationError creates an error for a preexisting column in relation.
NewColumnReferencedByComputedColumnError is returned when dropping a column and that column being dropped is referenced by a computed column.
NewColumnReferencedByPrimaryKeyError is returned when attempting to drop a column which is a part of the table's primary key.
NewDatabaseAlreadyExistsError creates an error for a preexisting database.
NewDependentBlocksOpError creates an error because dependingObjName (of type dependingObjType) has a reference to objName (of objType) when someone attempts to `op` on it.
NewDependentObjectErrorf creates a dependent object error.
NewDisallowedSchemaChangeOnLDRTableErr creates an error that indicates that the schema change is disallowed because the table is being used by a logical data replication job.
NewGeneratedAlwaysAsIdentityColumnOverrideError creates an error for explicitly writing a column created with `GENERATED ALWAYS AS IDENTITY` syntax.
NewGeneratedAlwaysAsIdentityColumnUpdateError creates an error for updating a column created with `GENERATED ALWAYS AS IDENTITY` syntax to an expression other than "DEFAULT".
NewIdentityColumnTypeError creates an error for declaring an IDENTITY column with a non-integer type.
NewInsufficientPrivilegeOnDescriptorError creates an InsufficientPrivilege error saying the `user` does not have any of the privilege in `orPrivs` on the descriptor.
NewInvalidActionOnComputedFKColumnError creates an error when there is an attempt to have an unsupported action on a FK over a computed column.
NewInvalidAssignmentCastError creates an error that is used when a mutation cannot be performed because there is not a valid assignment cast from a value's type to the type of the target column.
NewInvalidSchemaDefinitionError creates an error for an invalid schema definition such as a schema definition that doesn't parse.
NewInvalidVolatilityError creates an error for the case when provided volatility options are not valid through CREATE/REPLACE/ALTER FUNCTION.
NewInvalidWildcardError creates an error that represents the result of expanding a table wildcard over an invalid database or schema prefix.
NewNonNullViolationError creates an error for a violation of a non-NULL constraint.
NewRangeUnavailableError creates an unavailable range error.
NewRelationAlreadyExistsError creates an error for a preexisting relation.
NewSchemaAlreadyExistsError creates an error for a preexisting schema.
NewSchemaChangeOnLockedTableErr creates an error signaling schema change statement is attempted on a table with locked schema.
NewSyntaxErrorf creates a syntax error.
NewTransactionAbortedError creates an error for trying to run a command in the context of transaction that's in the aborted state.
NewTransactionCommittedError creates an error that signals that the SQL txn is in the COMMIT_WAIT state and that only a COMMIT statement will be accepted.
NewTypeAlreadyExistsError creates an error for a preexisting type.
NewUndefinedConstraintError returns a missing constraint error.
NewUndefinedDatabaseError creates an error that represents a missing database.
NewUndefinedObjectError creates an error that represents a missing object.
NewUndefinedPolicyError return an error that the policy doesn't exist.
NewUndefinedRelationError creates an error that represents a missing database table or view.
NewUndefinedSchemaError creates an error for an undefined schema.
NewUndefinedTriggerError returns a missing constraint error.
NewUndefinedTypeError creates an error that represents a missing type.
NewUndefinedUserError returns an undefined user error.
NewUniqueConstraintReferencedByForeignKeyError generates an error to be returned when dropping a unique constraint that is relied upon by an inbound foreign key constraint.
NewWindowInAggError creates an error for the case when a window function is nested within an aggregate function.
NewWrongObjectTypeError creates a wrong object type error.

# Constants

EnforceHomeRegionFurtherInfo is the suffix to append to every error returned due to turning on the enforce_home_region session setting, and provides some information for users or app developers.

# Variables

QueryTimeoutError is an error representing a query timeout.
TxnTimeoutError is an error representing a transasction timeout.