package
25.1.0+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.
# Packages
No description provided by the author
Package explain implements "explaining" for cockroach.
# Constants
The following are all the supported join algorithms.
The following are all the supported join algorithms.
EstimatedStatsID is an annotation with a *EstimatedStats value.
ExecutionStatsID is an annotation with a *ExecutionStats value.
The following are all the supported join algorithms.
The following are all the supported join algorithms.
The following are all the supported join algorithms.
The following are all the supported join algorithms.
The following are all the supported join algorithms.
NoStreaming means that the grouping columns have no useful order, so a hash aggregator should be used.
The following are all the supported join algorithms.
NumScanCountTypes is the total number of types of counts of scans.
PartialStreaming means that the grouping columns are partially ordered, so some optimizations can be done during aggregation.
PlanFlagCheckContainsLocking is set if at least one node in at least one check plan uses locking.
PlanFlagContainsFullIndexScan is set if the statement contains an unconstrained non-partial secondary index scan.
PlanFlagContainsFullTableScan is set if the statement contains an unconstrained primary index scan.
PlanFlagContainsLargeFullIndexScan is set if the statement contains an unconstrained non-partial secondary index scan estimated to read more than large_full_scan_rows (or without available stats).
PlanFlagContainsLargeFullTableScan is set if the statement contains an unconstrained primary index scan estimated to read more than large_full_scan_rows (or without available stats).
PlanFlagContainsLocking is set if at least one node in the plan uses locking.
PlanFlagContainsMutation is set if the whole plan contains any mutations.
PlanFlagIsDDL is set if the statement contains DDL.
ScanCount is the count of all scans in a query.
ScanWithStatsCount is the count of scans with statistics in a query.
ScanWithStatsForecastCount is the count of scans which used forecasted statistics in a query.
Streaming means that the grouping columns are fully ordered.
SubqueryAllRows - the subquery is an argument to ARRAY.
SubqueryAnyRows - the subquery is an argument to ANY.
SubqueryDiscardAllRows - the subquery is executed for its side effects (e.g.
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.
The following are all the supported join algorithms.
# Structs
AggInfo represents an aggregation (see ConstructGroupBy).
EstimatedStats contains estimated statistics about a given operator.
ExecutionStats contain statistics about a given operator gathered from the execution of the query.
ExplainEnvData represents the data that's going to be displayed in EXPLAIN (env).
InsertFastPathCheck contains information about a foreign key or uniqueness check to be performed by the insert fast-path (see ConstructInsertFastPath).
KVOption represents information about a statement option (see tree.KVOptions).
PostQuery describes a cascading query or an AFTER trigger action.
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.planComponents).
# 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 base factory.
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.
GroupingOrderType is the grouping column order type for group by and distinct operations.
JoinAlgorithm is the type of join algorithm used.
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.
PlanFlags tracks various properties of the built plan.
RecursiveCTEIterationFn creates a plan for an iteration of WITH RECURSIVE, given the result of the last iteration (as a node created by ConstructBuffer).
ScanCountType is the type of count of scan operations in a query.
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.