package
20.2.19+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
# README
This exec package is temporarily in the opt directory. Eventually, it will
be moved to the sql directory, and we will move other execution-related
packages into the sql/exec directory as well. Until then, it's better to keep
it here so that developers are not confused as to why we have a top-level
exec directory that doesn't actually contain the main body of execution code.
# Constants
EstimatedStatsID is an annotation with a *EstimatedStats value.
InsertFastPathMaxRows is the maximum number of rows for which we can use the insert fast path.
SubqueryAllRows - the subquery is an argument to ARRAY.
SubqueryAnyRows - the subquery is an argument to ANY.
SubqueryExists - the value of the subquery is a boolean: true if the subquery returns any rows, false otherwise.
SubqueryOneRow - the subquery expects at most one row; the result is that row (as a single value or a tuple), or NULL if there were no rows.
# Structs
AggInfo represents an aggregation (see ConstructGroupBy).
Cascade describes a cascading query.
EstimatedStats contains estimated statistics about a given operator.
ExplainEnvData represents the data that's going to be displayed in EXPLAIN (env).
InsertFastPathFKCheck contains information about a foreign key check to be performed by the insert fast-path (see ConstructInsertFastPath).
KVOption represents information about a statement option (see tree.KVOptions).
ScanParams contains all the parameters for a table scan.
Subquery encapsulates information about a subquery that is part of a plan.
WindowInfo represents the information about a window function that must be passed through to the execution engine.
# Interfaces
ExplainFactory is an extension of Factory used when constructing a plan that can be explained.
Node represents a node in the execution tree (currently maps to sql.planNode).
Plan represents the plan for a query (currently maps to sql.planTop).
# Type aliases
ApplyJoinPlanRightSideFn creates a plan for an iteration of ApplyJoin, given a row produced from the left side.
BuildPlanForExplainFn builds an execution plan against the given ExplainFactory.
CheckOrdinalSet contains the ordinal positions of a set of check constraints taken from the opt.Table.Check collection.
ExplainAnnotationID identifies the type of a node annotation.
MkErrFn is a function that generates an error which includes values from a relevant row.
NodeColumnOrdinal is the 0-based ordinal index of a column produced by a Node.
NodeColumnOrdinalSet contains a set of NodeColumnOrdinal values.
OutputOrdering indicates the required output ordering on a Node that is being created.
RecursiveCTEIterationFn creates a plan for an iteration of WITH RECURSIVE, given the result of the last iteration (as a node created by ConstructBuffer).
SubqueryMode indicates how the results of the subquery are to be processed.
TableColumnOrdinal is the 0-based ordinal index of a cat.Table column.
TableColumnOrdinalSet contains a set of TableColumnOrdinal values.