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

# Functions

BuildChildPhysicalProps returns the set of physical properties required of the nth child, based upon the properties required of the parent.
BuildChildPhysicalPropsScalar is like BuildChildPhysicalProps, but for when the parent is a scalar expression.
CanProvidePhysicalProps returns true if the given expression can provide the required physical properties.
MakeDefaultCoster creates an instance of the default coster.

# Constants

FmtCycle formats a memo like FmtPretty, but attempts to detect a cycle in the memo and include it in the formatted output.
FmtPretty performs a breadth-first topological sort on the memo groups, and shows the root group at the top of the memo.

# Variables

DistributeCost is the per-operation cost overhead for Distribute operations or scans which access remote regions.
LargeDistributeCost is the cost to use for Distribute operations when a session mode is set to error out on access of rows from remote regions.
LargeDistributeCostWithHomeRegion is the cost to use for Distribute operations when a session mode is set to error out on access of rows from remote regions, and the query plan has a home region.
SmallDistributeCost is the per-operation cost overhead for scans which may access remote regions, but the scanned table is unpartitioned with no lease preferences, so locality information is not available.

# Structs

CustomFuncs contains all the custom match and replace functions used by the exploration rules.
JoinOrderBuilder is used to add valid orderings of a given join tree to the memo during exploration.
OnReorderEdgeParam is a struct representing an edge in the join graph.
OnReorderRuleParam is a struct representing a conflict rule.
Optimizer transforms an input expression tree into the logically equivalent output expression tree with the lowest possible execution cost.

# Interfaces

Coster is used by the optimizer to assign a cost to a candidate expression that can provide a set of required physical properties.

# Type aliases

AppliedRuleFunc defines the callback function for the NotifyOnAppliedRule event supported by the optimizer.
FmtFlags controls how the memo output is formatted.
MatchedRuleFunc defines the callback function for the NotifyOnMatchedRule event supported by the optimizer.
OnAddJoinFunc defines the callback function for the NotifyOnAddJoin event supported by JoinOrderBuilder.
OnReorderFunc defines the callback function for the NotifyOnReorder event supported by the optimizer and factory.
RuleSet efficiently stores an unordered set of RuleNames.