org.apache.calcite.plan (Apache Calcite API)

Interface Summary
Interface	Description
Context	Provides library users a way to store data within the planner session and access it within rules.
Convention	Calling convention trait.
RelImplementor	This is a marker interface for a callback used to convert a tree of `relational expressions` into a plan.
RelMultipleTrait	Trait for which a given relational expression can have multiple values.
RelOptConnection	The planner's view of a connection to a database.
RelOptCost	RelOptCost defines an interface for optimizer cost in terms of number of rows processed, CPU cost, and I/O cost.
RelOptCostFactory	Cost model for query planning.
RelOptListener	RelOptListener defines an interface for listening to events which occur during the optimization process.
RelOptNode	Node in a planner.
RelOptPlanner	A `RelOptPlanner` is a query optimizer: it transforms a relational expression into a semantically equivalent relational expression, according to a given set of rules and a cost model.
RelOptPlanner.Executor	Deprecated Use `RexExecutor`
RelOptSchema	A `RelOptSchema` is a set of `RelOptTable` objects.
RelOptSchemaWithSampling	Extension to `RelOptSchema` with support for sample data-sets.
RelOptTable	Represents a relational dataset in a `RelOptSchema`.
RelOptTable.ToRelContext	Contains the context needed to convert a a table into a relational expression.
RelOptTable.ViewExpander	Can expand a view into relational expressions.
RelTrait	RelTrait represents the manifestation of a relational expression trait within a trait definition.

Class Summary
Class	Description
AbstractRelOptPlanner	Abstract base for implementations of the `RelOptPlanner` interface.
CommonRelSubExprRule	A `CommonRelSubExprRule` is an abstract base class for rules that are fired only on relational expressions that appear more than once in a query tree.
Contexts	Utilities for `Context`.
Contexts.ChainContext	Context that wraps a chain of contexts.
Contexts.EmptyContext	Empty context.
Contexts.WrapContext	Context that wraps an object.
Convention.Impl	Default implementation.
ConventionTraitDef	Definition of the the convention trait.
ConventionTraitDef.ConversionData	Workspace for converting from one convention to another.
MaterializedViewSubstitutionVisitor	Extension to `SubstitutionVisitor`.
MaterializedViewSubstitutionVisitor.FilterToFilterUnifyRule1	Implementation of `SubstitutionVisitor.UnifyRule` that matches a `MutableFilter` to a `MutableFilter` where the condition of the target relation is weaker.
MaterializedViewSubstitutionVisitor.FilterToProjectUnifyRule1	Implementation of `SubstitutionVisitor.UnifyRule` that matches a `MutableFilter` to a `MutableProject` on top of a `MutableFilter` where the condition of the target relation is weaker.
MaterializedViewSubstitutionVisitor.ProjectToProjectUnifyRule1	Implementation of `SubstitutionVisitor.UnifyRule` that matches a `MutableProject` to a `MutableProject` where the condition of the target relation is weaker.
MulticastRelOptListener	MulticastRelOptListener implements the `RelOptListener` interface by forwarding events on to a collection of other listeners.
RelCompositeTrait<T extends RelMultipleTrait>	A trait that consists of a list of traits, all of the same type.
RelOptAbstractTable	Partial implementation of `RelOptTable`.
RelOptCluster	An environment for related relational expressions during the optimization of a query.
RelOptCostImpl	RelOptCostImpl provides a default implementation for the `RelOptCost` interface.
RelOptCostImpl.Factory	Implementation of `RelOptCostFactory` that creates `RelOptCostImpl`s.
RelOptLattice	Use of a lattice by the query optimizer.
RelOptListener.RelChosenEvent	Event indicating that a relational expression has been chosen.
RelOptListener.RelDiscardedEvent	Event indicating that a relational expression has been discarded.
RelOptListener.RelEquivalenceEvent	Event indicating that a relational expression has been found to be equivalent to an equivalence class.
RelOptListener.RelEvent	Event class for abstract event dealing with a relational expression.
RelOptListener.RuleAttemptedEvent	Event indicating that a planner rule has been attempted.
RelOptListener.RuleEvent	Event indicating that a planner rule has fired.
RelOptListener.RuleProductionEvent	Event indicating that a planner rule has produced a result.
RelOptMaterialization	Records that a particular query is materialized by a particular table.
RelOptMaterialization.ProjectFilterTable	A table scan and optional project mapping and filter condition.
RelOptMaterializations	Utility methods for using materialized views and lattices for queries.
RelOptPredicateList	Predicates that are known to hold in the output of a particular relational expression.
RelOptQuery	A `RelOptQuery` represents a set of `relational expressions` which derive from the same `select` statement.
RelOptRule	A `RelOptRule` transforms an expression into another.
RelOptRule.ConverterRelOptRuleOperand	Operand to an instance of the converter rule.
RelOptRuleCall	A `RelOptRuleCall` is an invocation of a `RelOptRule` with a set of `relational expression`s as arguments.
RelOptRuleOperand	Operand that determines whether a `RelOptRule` can be applied to a particular expression.
RelOptRuleOperandChildren	Children of a `RelOptRuleOperand` and the policy for matching them.
RelOptRules	A utility class for organizing built-in rules and rule related methods.
RelOptSamplingParameters	RelOptSamplingParameters represents the parameters necessary to produce a sample of a relation.
RelOptUtil	`RelOptUtil` defines static utility methods for use in optimizing `RelNode`s.
RelOptUtil.CorrelationCollector	Shuttle that finds correlation variables inside a given relational expression, including those that are inside `sub-queries`.
RelOptUtil.Exists	Result of calling `RelOptUtil.createExistsPlan(org.apache.calcite.plan.RelOptCluster, org.apache.calcite.rel.RelNode, java.util.List<org.apache.calcite.rex.RexNode>, org.apache.calcite.rex.RexLiteral, java.lang.String)`
RelOptUtil.InputFinder	Visitor which builds a bitmap of the inputs used by an expression.
RelOptUtil.InputReferencedVisitor	Shuttle that finds the set of inputs that are used.
RelOptUtil.RexInputConverter	Walks an expression tree, converting the index of RexInputRefs based on some adjustment factor.
RelOptUtil.TypeDumper	Converts types to descriptive strings.
RelOptUtil.VariableSetVisitor	Visitor that finds all variables used but not stopped in an expression.
RelOptUtil.VariableUsedVisitor	Visitor that finds all variables used in an expression.
RelTraitDef<T extends RelTrait>	RelTraitDef represents a class of `RelTrait`s.
RelTraitPropagationVisitor	Deprecated As of 1.19, if you need to perform certain assertions regarding a RelNode tree and the contained traits you are encouraged to implement your own RelVisitor or `RelShuttle` directly.
RelTraitSet	RelTraitSet represents an ordered set of `RelTrait`s.
RelTraitSet.Cache	Cache of trait sets.
RexImplicationChecker	Checks whether one condition logically implies another.
RexImplicationChecker.InputRefUsage<T1,T2>	Usage of a `RexInputRef` in an expression.
RexImplicationChecker.InputUsageFinder	Visitor that builds a usage map of inputs used by an expression.
Strong	Utilities for strong predicates.
SubstitutionVisitor	Substitutes part of a tree of relational expressions with another tree.
SubstitutionVisitor.AbstractUnifyRule	Abstract base class for implementing `SubstitutionVisitor.UnifyRule`.
SubstitutionVisitor.AggregateOnProjectToAggregateUnifyRule	Implementation of `SubstitutionVisitor.UnifyRule` that matches a `MutableAggregate` on a `MutableProject` query to an `MutableAggregate` target.
SubstitutionVisitor.AggregateToAggregateUnifyRule	Implementation of `SubstitutionVisitor.UnifyRule` that matches a `LogicalAggregate` to a `LogicalAggregate`, provided that they have the same child.
SubstitutionVisitor.AnyOperand	Operand to a `SubstitutionVisitor.UnifyRule` that matches a relational expression of a given type.
SubstitutionVisitor.FilterOnProjectRule	Rule that converts a `LogicalFilter` on top of a `LogicalProject` into a trivial filter (on a boolean column).
SubstitutionVisitor.FilterToFilterUnifyRule	Implementation of `SubstitutionVisitor.UnifyRule` that matches a `MutableFilter`.
SubstitutionVisitor.FilterToProjectUnifyRule	Implementation of `SubstitutionVisitor.UnifyRule` that matches a `MutableFilter` to a `MutableProject`.
SubstitutionVisitor.InternalOperand	Operand to a `SubstitutionVisitor.UnifyRule` that matches a relational expression of a given type.
SubstitutionVisitor.Operand	Operand to a `SubstitutionVisitor.UnifyRule`.
SubstitutionVisitor.ProjectToFilterUnifyRule	Implementation of `SubstitutionVisitor.UnifyRule` that matches a `MutableProject` to a `MutableFilter`.
SubstitutionVisitor.ProjectToProjectUnifyRule	Implementation of `SubstitutionVisitor.UnifyRule` that matches `LogicalProject`.
SubstitutionVisitor.QueryOperand	Operand that assigns a particular relational expression to a variable.
SubstitutionVisitor.Replacement	Represents a replacement action: before → after.
SubstitutionVisitor.ScanToProjectUnifyRule	Implementation of `SubstitutionVisitor.UnifyRule` that matches `LogicalTableScan`.
SubstitutionVisitor.SlotCounter	Visitor that counts how many `SubstitutionVisitor.QueryOperand` and `SubstitutionVisitor.TargetOperand` in an operand tree.
SubstitutionVisitor.TargetOperand	Operand that checks that a relational expression matches the corresponding relational expression that was passed to a `SubstitutionVisitor.QueryOperand`.
SubstitutionVisitor.TrivialRule	Implementation of `SubstitutionVisitor.UnifyRule` that matches if the query is already equal to the target.
SubstitutionVisitor.UnifyResult	Result of an application of a `SubstitutionVisitor.UnifyRule` indicating that the rule successfully matched `query` against `target` and generated a `result` that is equivalent to `query` and contains `target`.
SubstitutionVisitor.UnifyRule	Rule that attempts to match a query relational expression against a target relational expression.
TableAccessMap	`TableAccessMap` represents the tables accessed by a query plan, with READ/WRITE information.
ViewExpanders	Utilities for `RelOptTable.ViewExpander` and `RelOptTable.ToRelContext`.
VisitorDataContext	DataContext for evaluating an RexExpression

Enum Summary
Enum	Description
RelOptRuleOperandChildPolicy	Policy by which operands will be matched by relational expressions with any number of children.
RelOptUtil.Logic	Policies for handling two- and three-valued boolean logic.
RelOptUtil.Side	Categorizes whether a bit set contains bits left and right of a line.
RelOptUtil.SubQueryType	What kind of sub-query.
Strong.Policy	How whether an operator's operands are null affects whether a call to that operator evaluates to null.
TableAccessMap.Mode	Access mode.

Exception Summary
Exception Description

RelOptPlanner.CannotPlanException
Thrown by RelOptPlanner.findBestExp().

SubstitutionVisitor.MatchFailed
Exception thrown to exit a matcher.

Exception Summary
Exception	Description
RelOptPlanner.CannotPlanException	Thrown by `RelOptPlanner.findBestExp()`.
SubstitutionVisitor.MatchFailed	Exception thrown to exit a matcher.

Package org.apache.calcite.plan Description

Defines interfaces for constructing rule-based optimizers of relational expressions.