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

# Functions

DescriptorValidationModeFromString converts a string into a DescriptorValidationMode.
DistSQLExecModeFromString converts a string into a DistSQLExecMode.
ExperimentalDistSQLPlanningModeFromString converts a string into a ExperimentalDistSQLPlanningMode.
NewSchemaChangerModeFromString converts a string into a NewSchemaChangerMode.
NewSequenceCacheNode initializes a new SequenceCacheNode.
ParseQoSLevelFromString converts a string into a QoSLevel.
PlanCacheModeFromString converts a string into a PlanCacheMode.
SerialNormalizationModeFromString converts a string into a SerialNormalizationMode.
ToQoSLevelString interprets an int32 value as a QoSLevel and returns its String representation.
VectorizeExecModeFromString converts a string into a VectorizeExecMode.

# Constants

BulkLow denotes a QoS level used internally by the bulk operations (like LDR ingestion and TTL), which is not settable as a session default_transaction_quality_of_service value.
BulkLowName is the string value to display indicating a BulkLow QoS level.
DescriptorValidationOff means that we never validate descriptors.
DescriptorValidationOn means that we always validate descriptors, both when reading from storage and when writing to storage.
DescriptorValidationReadOnly means that we validate descriptors when reading from storage, but not when writing to storage.
DistSQLAlways means that we only distribute; unsupported queries fail.
DistSQLAuto means that we automatically decide on a case-by-case basis if we distribute queries.
DistSQLOff means that we never distribute queries.
DistSQLOn means that we distribute queries that are supported.
ExperimentalDistSQLPlanningAlways means that we will only use the new path, and if it fails for any reason, the query will fail as well.
ExperimentalDistSQLPlanningOff means that we always use the old path of going from opt.Expr to planNodes and then to processor specs.
ExperimentalDistSQLPlanningOn means that we will attempt to use the new path for performing DistSQL planning in the optimizer, and if that doesn't succeed for some reason, we will fallback to the old path.
LockingHigh denotes an internal increased priority for UserHigh transactions that are acquiring locks.
LockingHighName is the string value to display indicating a LockingHigh QoS level.
LockingNormal denotes an internal increased priority for normal transactions that are acquiring locks.
LockingNormalName is the string value to display indicating a LockingNormal QoS level.
Normal denotes an end user QoS level unchanged from the default.
NormalName is the external session setting string value to use to mean Normal QoS level.
SerialUsesCachedNodeSQLSequences is identical to SerialUsesCachedSQLSequences, except the sequence values are cached per node instead of per session.
SerialUsesCachedSQLSequences is identical to SerialUsesSQLSequences with the exception that sessions can cache sequence values.
SerialUsesRowID means use INT NOT NULL DEFAULT unique_rowid().
SerialUsesSQLSequences means create a regular SQL sequence and use INT NOT NULL DEFAULT nextval(...).
SerialUsesUnorderedRowID means use INT NOT NULL DEFAULT unordered_unique_rowid().
SerialUsesVirtualSequences means create a virtual sequence and use INT NOT NULL DEFAULT nextval(...).
SystemHigh denotes the maximum system QoS level, which is not settable as a session default_transaction_quality_of_service value.
SystemHighName is the string value to display indicating a SystemHigh QoS level.
SystemLow denotes the minimum system QoS level, which is not settable as a session default_transaction_quality_of_service value.
SystemLowName is the string value to display indicating a SystemLow QoS level.
UseNewSchemaChangerOff means that we never use the new schema changer.
UseNewSchemaChangerOn means that we use the new schema changer for supported statements in implicit transactions, but fall back to the old schema changer otherwise.
UseNewSchemaChangerUnsafe means that we attempt to use the new schema changer for implemented statements including ones which aren't production ready.
UseNewSchemaChangerUnsafeAlways means that we attempt to use the new schema changer for all statements and return errors for unsupported statements.
UserHigh denotes an end user QoS level higher than the default.
UserHighName is the external session setting string value to use to mean UserHigh QoS level.
UserLow denotes an end user QoS level lower than the default.
UserLowName is the external session setting string value to use to mean UserLow QoS level.

# Variables

When providing SessionData overrides to the internal executor, we need to use pointers to specify the QoSLevel.
When providing SessionData overrides to the internal executor, we need to use pointers to specify the QoSLevel.
When providing SessionData overrides to the internal executor, we need to use pointers to specify the QoSLevel.

# Structs

SequenceCacheNode stores sequence values at a per-node level The cache stores sequence values that have already been created in KV and are available to be given out as sequence numbers.
SequenceCacheNodeEntry embeds the existing SequenceCacheEntry struct that session-level sequence caching currently utilizes, and also includes a mutex.

# Type aliases

DescriptorValidationMode controls if and when descriptors are validated.
DistSQLExecMode controls if and when the Executor distributes queries.
ExperimentalDistSQLPlanningMode controls if and when the opt-driven DistSQL planning is used to create physical plans.
NewSchemaChangerMode controls if and when the new schema changer (in sql/schemachanger) is in use.
QoSLevel controls the level of admission control to use for new SQL requests.
SequenceCache stores sequence values that have already been created in KV and are available to be given out as sequence numbers.
SerialNormalizationMode controls if and when the Executor uses DistSQL.