package
20.2.19+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
# Functions
DefaultSearchPathForUser returns the default search path with the user specific schema name set so that it can be expanded during resolution.
DistSQLExecModeFromString converts a string into a DistSQLExecMode.
ExperimentalDistSQLPlanningModeFromString converts a string into a ExperimentalDistSQLPlanningMode.
MakeSearchPath returns a new immutable SearchPath struct.
NewSequenceState creates a SequenceState.
SerialNormalizationModeFromString converts a string into a SerialNormalizationMode.
VectorizeExecModeFromString converts a string into a VectorizeExecMode.
# Constants
CRDBInternalSchemaName is the name of the crdb_internal system schema.
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.
InformationSchemaName is the name of the information_schema system schema.
PgCatalogName is the name of the pg_catalog system schema.
PgExtensionSchemaName is the alias for schemas which are usually "public" in postgres when installing an extension, but must be stored as a separate schema in CRDB.
PgSchemaPrefix is a prefix for Postgres system schemas.
PgTempSchemaName is the alias for temporary schemas across sessions.
PublicSchemaName is the name of the pg_catalog system schema.
SerialUsesRowID means use INT NOT NULL DEFAULT unique_rowid().
SerialUsesSQLSequences means create a regular SQL sequence and use INT NOT NULL DEFAULT nextval(...).
SerialUsesVirtualSequences means create a virtual sequence and use INT NOT NULL DEFAULT nextval(...).
UserSchemaName is the alias for schema names for users.
Vectorize201Auto means that that any supported queries that use only streaming operators (i.e.
VectorizeExperimentalAlways means that we attempt to vectorize all queries; unsupported queries will fail.
VectorizeOff means that columnar execution is disabled.
VectorizeOn means that any supported queries will be run using the columnar execution.
# Variables
DefaultSearchPath is the search path used by virgin sessions.
EmptySearchPath is a SearchPath with no schema names in it.
NodeUserSessionDataOverride is an InternalExecutorOverride which overrides the users to the NodeUser.
NoSessionDataOverride is the empty InternalExecutorOverride which does not override any session data.
VirtualSchemaNames is a set of all virtual schema names.
# Structs
DataConversionConfig contains the parameters that influence the conversion between SQL data types and strings/byte arrays.
InternalExecutorOverride is used by the InternalExecutor interface to allow control over some of the session data.
SearchPath represents a list of namespaces to search builtins in.
SearchPathIter enables iteration over the search paths without triggering an allocation.
SequenceState stores session-scoped state used by sequence builtins.
SessionData contains session parameters.
# Type aliases
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.
SerialNormalizationMode controls if and when the Executor uses DistSQL.
VectorizeExecMode controls if an when the Executor executes queries using the columnar execution engine.