package
2.1.0-alpha.20180416+incompatible
Repository: https://github.com/coyle/cockroach.git
Documentation: pkg.go.dev

# README

The opt package defines common high-level interfaces and classes that multiple sub-packages share. None of these definitions depend on any sub-packages, so all sub-packages can therefore depend on opt without causing cyclical dependencies (which Go does not allow).

# Packages

Package bench houses benchmarks for the SQL optimizer.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

ColListToSet converts a column id list to a column id set.
FormatCatalogTable nicely formats a catalog table using a treeprinter for debugging and testing.
MakeOrderingColumn initializes an ordering column with a ColumnID and a flag indicating whether the direction is descending.
NewMetadata constructs a new instance of metadata for the optimizer.

# Constants

AggregationsOp is a set of aggregate expressions that will become output columns for a containing GroupBy operator.
AndOp is the boolean conjunction operator that evalutes to true if all of its conditions evaluate to true.
No description provided by the author
No description provided by the author
AnyOp is a special operator that does not exist in SQL.
ArrayOp is an ARRAY literal of the form ARRAY[<expr1>, <expr2>, ..., <exprN>].
No description provided by the author
No description provided by the author
No description provided by the author
CaseOp is a CASE statement of the form: CASE [ <Input> ] WHEN <condval1> THEN <expr1> [ WHEN <condval2> THEN <expr2> ] ..
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ConstOp is a typed scalar constant value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
------------------------------------------------------------ Normalize Rule Names ------------------------------------------------------------.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ExceptAllOp is an operator used to perform a set difference between the Left and Right input relations.
ExceptOp is an operator used to perform a set difference between the Left and Right input relations.
No description provided by the author
FalseOp is the boolean false value that is equivalent to the tree.DBoolFalse datum value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
FiltersOp is a boolean And operator that only appears as the Filters child of a Select operator, or the On child of a Join operator.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
FunctionOp invokes a builtin SQL function like CONCAT or NOW, passing the given arguments.
No description provided by the author
No description provided by the author
GroupByOp is an operator that is used for performing aggregations (for queries with aggregate functions, HAVING clauses and/or group by expressions).
No description provided by the author
No description provided by the author
InnerJoinApplyOp has the same join semantics as InnerJoin.
InnerJoinOp creates a result set that combines columns from its left and right inputs, based upon its "on" join predicate.
No description provided by the author
IntersectAllOp is an operator used to perform an intersection between the Left and Right input relations.
IntersectOp is an operator used to perform an intersection between the Left and Right input relations.
Enumeration of all manual rule names.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
LimitOp returns a limited subset of the results in the input relation.
No description provided by the author
No description provided by the author
Max1RowOp is an operator which enforces that its input must return at most one row.
MaxOperands is the maximum number of operands that an operator can have.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NotOp is the boolean negation operator that evaluates to true if its input evalutes to false.
No description provided by the author
No description provided by the author
No description provided by the author
NullOp is the constant SQL null value that has "unknown value" semantics.
NumManualRules tracks the number of manually-defined rules.
NumOperators tracks the total count of operators.
NumRuleNames tracks the total count of rule names.
OffsetOp filters out the first Offset rows of the input relation; used in conjunction with Limit.
OrOp is the boolean disjunction operator that evalutes to true if any of its conditions evaluate to true.
No description provided by the author
No description provided by the author
No description provided by the author
PrimaryIndex selects the primary index of a table when calling the Table.Index method.
ProjectionsOp is a set of typed scalar expressions that will become output columns for a containing Project operator.
ProjectOp modifies the set of columns returned by the input result set.
No description provided by the author
No description provided by the author
No description provided by the author
------------------------------------------------------------ Explore Rule Names ------------------------------------------------------------.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ScanOp returns a result set containing every row in the specified table, by scanning one of the table's indexes according to its ordering.
SelectOp filters rows from its input result set, based on the boolean filter predicate expression.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SortOp enforces the ordering of rows returned by its input expression.
SubqueryOp is a subquery in a single-row context such as `SELECT 1 = (SELECT 1)` or `SELECT (1, 'a') = (SELECT 1, 'a')`.
TrueOp is the boolean true value that is equivalent to the tree.DBoolTrue datum value.
No description provided by the author
No description provided by the author
No description provided by the author
UnionAllOp is an operator used to combine the Left and Right input relations into a single set containing rows from both inputs.
UnionOp is an operator used to combine the Left and Right input relations into a single set containing rows from both inputs.
No description provided by the author
UnsupportedExprOp is used for interfacing with the old planner code.
ValuesOp returns a manufactured result set containing a constant number of rows.
VariableOp is the typed scalar value of a column in the query.
WhenOp represents a single WHEN ..

# Variables

No description provided by the author
BinaryOpReverseMap maps from an optimizer operator type to a semantic tree binary operator type.
No description provided by the author
No description provided by the author
ComparisonOpReverseMap maps from an optimizer operator type to a semantic tree comparison operator type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UnaryOpReverseMap maps from an optimizer operator type to a semantic tree unary operator type.

# Structs

IndexColumn describes a single column that is part of an index definition.
LabeledColumn specifies the label and id of a column.
Metadata assigns unique ids to the columns, tables, and other metadata used within the scope of a particular query.

# Interfaces

Catalog is an interface to a database catalog, exposing only the information needed by the query optimizer.
Column is an interface to a table column, exposing only the information needed by the query optimizer.
Index is an interface to a database index, exposing only the information needed by the query optimizer.
Table is an interface to a database table, exposing only the information needed by the query optimizer.
TableStatistic is an interface to a table statistic.

# Type aliases

ColList is a list of column ids.
ColMap provides a 1:1 mapping from one column id to another.
ColSet efficiently stores an unordered set of column ids.
ColumnID uniquely identifies the usage of a column within the scope of a query.
ColumnName is the type of a column name.
Operator describes the type of operation that a memo expression performs.
OrderingColumn is the ColumnID for a column that is part of an ordering, except that it can be negated to indicate a descending ordering on that column.
RuleName enumerates the names of all the optimizer rules.
TableID uniquely identifies the usage of a table within the scope of a query.
TableName is the type of a table name.
WeakKeys are combinations of columns that form a weak key.