| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>org.apache.calcite.plan (Apache Calcite calcite API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.calcite.plan (Apache Calcite calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/calcite/piglet/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/apache/calcite/plan/hep/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/plan/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.calcite.plan</h1> |
| <div class="docSummary"> |
| <div class="block">Defines interfaces for constructing rule-based optimizers of |
| relational expressions.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/Context.html" title="interface in org.apache.calcite.plan">Context</a></td> |
| <td class="colLast"> |
| <div class="block">Provides library users a way to store data within the planner session and |
| access it within rules.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></td> |
| <td class="colLast"> |
| <div class="block">Calling convention trait.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelDigest.html" title="interface in org.apache.calcite.plan">RelDigest</a></td> |
| <td class="colLast"> |
| <div class="block">The digest is the exact representation of the corresponding <code>RelNode</code>, |
| at anytime, anywhere.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelHintsPropagator.html" title="interface in org.apache.calcite.plan">RelHintsPropagator</a></td> |
| <td class="colLast"> |
| <div class="block">Customize the propagation of the <a href="../../../../org/apache/calcite/rel/hint/RelHint.html" title="class in org.apache.calcite.rel.hint"><code>RelHint</code></a>s |
| from the root relational expression of a rule call <a href="../../../../org/apache/calcite/plan/RelOptRuleCall.html" title="class in org.apache.calcite.plan"><code>RelOptRuleCall</code></a> to |
| the new equivalent expression.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelImplementor.html" title="interface in org.apache.calcite.plan">RelImplementor</a></td> |
| <td class="colLast"> |
| <div class="block">This is a marker interface for a callback used to convert a tree of |
| <a href="../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>relational expressions</code></a> into a plan.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelMultipleTrait.html" title="interface in org.apache.calcite.plan">RelMultipleTrait</a></td> |
| <td class="colLast"> |
| <div class="block">Trait for which a given relational expression can have multiple values.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptConnection.html" title="interface in org.apache.calcite.plan">RelOptConnection</a></td> |
| <td class="colLast"> |
| <div class="block">The planner's view of a connection to a database.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></td> |
| <td class="colLast"> |
| <div class="block">RelOptCost defines an interface for optimizer cost in terms of number of rows |
| processed, CPU cost, and I/O cost.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Cost model for query planning.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a></td> |
| <td class="colLast"> |
| <div class="block">RelOptListener defines an interface for listening to events which occur |
| during the optimization process.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></td> |
| <td class="colLast"> |
| <div class="block">Node in a planner.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>RelOptPlanner</code> 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.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptPlanner.Executor.html" title="interface in org.apache.calcite.plan">RelOptPlanner.Executor</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/calcite/rex/RexExecutor.html" title="interface in org.apache.calcite.rex"><code>RexExecutor</code></a></span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptSchema.html" title="interface in org.apache.calcite.plan">RelOptSchema</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>RelOptSchema</code> is a set of <a href="../../../../org/apache/calcite/plan/RelOptTable.html" title="interface in org.apache.calcite.plan"><code>RelOptTable</code></a> objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptSchemaWithSampling.html" title="interface in org.apache.calcite.plan">RelOptSchemaWithSampling</a></td> |
| <td class="colLast"> |
| <div class="block">Extension to <a href="../../../../org/apache/calcite/plan/RelOptSchema.html" title="interface in org.apache.calcite.plan"><code>RelOptSchema</code></a> with support for sample data-sets.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a></td> |
| <td class="colLast"> |
| <div class="block">Represents a relational dataset in a <a href="../../../../org/apache/calcite/plan/RelOptSchema.html" title="interface in org.apache.calcite.plan"><code>RelOptSchema</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptTable.ToRelContext.html" title="interface in org.apache.calcite.plan">RelOptTable.ToRelContext</a></td> |
| <td class="colLast"> |
| <div class="block">Contains the context needed to convert a a table into a relational |
| expression.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptTable.ViewExpander.html" title="interface in org.apache.calcite.plan">RelOptTable.ViewExpander</a></td> |
| <td class="colLast"> |
| <div class="block">Can expand a view into relational expressions.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></td> |
| <td class="colLast"> |
| <div class="block">RelTrait represents the manifestation of a relational expression trait within |
| a trait definition.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></td> |
| <td class="colLast"> |
| <div class="block">Abstract base for implementations of the <a href="../../../../org/apache/calcite/plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan"><code>RelOptPlanner</code></a> interface.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/CommonRelSubExprRule.html" title="class in org.apache.calcite.plan">CommonRelSubExprRule</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>CommonRelSubExprRule</code> is an abstract base class for rules |
| that are fired only on relational expressions that appear more than once |
| in a query tree.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/Contexts.html" title="class in org.apache.calcite.plan">Contexts</a></td> |
| <td class="colLast"> |
| <div class="block">Utilities for <a href="../../../../org/apache/calcite/plan/Context.html" title="interface in org.apache.calcite.plan"><code>Context</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/Convention.Impl.html" title="class in org.apache.calcite.plan">Convention.Impl</a></td> |
| <td class="colLast"> |
| <div class="block">Default implementation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/ConventionTraitDef.html" title="class in org.apache.calcite.plan">ConventionTraitDef</a></td> |
| <td class="colLast"> |
| <div class="block">Definition of the convention trait.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/MaterializedViewSubstitutionVisitor.html" title="class in org.apache.calcite.plan">MaterializedViewSubstitutionVisitor</a></td> |
| <td class="colLast">Deprecated</td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/MulticastRelOptListener.html" title="class in org.apache.calcite.plan">MulticastRelOptListener</a></td> |
| <td class="colLast"> |
| <div class="block">MulticastRelOptListener implements the <a href="../../../../org/apache/calcite/plan/RelOptListener.html" title="interface in org.apache.calcite.plan"><code>RelOptListener</code></a> interface by |
| forwarding events on to a collection of other listeners.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptAbstractTable.html" title="class in org.apache.calcite.plan">RelOptAbstractTable</a></td> |
| <td class="colLast"> |
| <div class="block">Partial implementation of <a href="../../../../org/apache/calcite/plan/RelOptTable.html" title="interface in org.apache.calcite.plan"><code>RelOptTable</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a></td> |
| <td class="colLast"> |
| <div class="block">An environment for related relational expressions during the |
| optimization of a query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptCostImpl.html" title="class in org.apache.calcite.plan">RelOptCostImpl</a></td> |
| <td class="colLast"> |
| <div class="block">RelOptCostImpl provides a default implementation for the <a href="../../../../org/apache/calcite/plan/RelOptCost.html" title="interface in org.apache.calcite.plan"><code>RelOptCost</code></a> |
| interface.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptLattice.html" title="class in org.apache.calcite.plan">RelOptLattice</a></td> |
| <td class="colLast"> |
| <div class="block">Use of a lattice by the query optimizer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptListener.RelChosenEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RelChosenEvent</a></td> |
| <td class="colLast"> |
| <div class="block">Event indicating that a relational expression has been chosen.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptListener.RelDiscardedEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RelDiscardedEvent</a></td> |
| <td class="colLast"> |
| <div class="block">Event indicating that a relational expression has been discarded.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptListener.RelEquivalenceEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RelEquivalenceEvent</a></td> |
| <td class="colLast"> |
| <div class="block">Event indicating that a relational expression has been found to |
| be equivalent to an equivalence class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptListener.RelEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RelEvent</a></td> |
| <td class="colLast"> |
| <div class="block">Event class for abstract event dealing with a relational expression.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptListener.RuleAttemptedEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RuleAttemptedEvent</a></td> |
| <td class="colLast"> |
| <div class="block">Event indicating that a planner rule has been attempted.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptListener.RuleEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RuleEvent</a></td> |
| <td class="colLast"> |
| <div class="block">Event indicating that a planner rule has fired.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptListener.RuleProductionEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RuleProductionEvent</a></td> |
| <td class="colLast"> |
| <div class="block">Event indicating that a planner rule has produced a result.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a></td> |
| <td class="colLast"> |
| <div class="block">Records that a particular query is materialized by a particular table.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptMaterializations.html" title="class in org.apache.calcite.plan">RelOptMaterializations</a></td> |
| <td class="colLast"> |
| <div class="block">Utility methods for using |
| materialized views and lattices for queries.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></td> |
| <td class="colLast"> |
| <div class="block">Predicates that are known to hold in the output of a particular relational |
| expression.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptQuery.html" title="class in org.apache.calcite.plan">RelOptQuery</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>RelOptQuery</code> represents a set of |
| <a href="../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>relational expressions</code></a> which derive from the same |
| <code>select</code> statement.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>RelOptRule</code> transforms an expression into another.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>RelOptRuleCall</code> is an invocation of a <a href="../../../../org/apache/calcite/plan/RelOptRule.html" title="class in org.apache.calcite.plan"><code>RelOptRule</code></a> with a |
| set of <a href="../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>relational expression</code></a>s as arguments.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a></td> |
| <td class="colLast"> |
| <div class="block">Operand that determines whether a <a href="../../../../org/apache/calcite/plan/RelOptRule.html" title="class in org.apache.calcite.plan"><code>RelOptRule</code></a> |
| can be applied to a particular expression.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a></td> |
| <td class="colLast"> |
| <div class="block">Children of a <a href="../../../../org/apache/calcite/plan/RelOptRuleOperand.html" title="class in org.apache.calcite.plan"><code>RelOptRuleOperand</code></a> and the |
| policy for matching them.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptRules.html" title="class in org.apache.calcite.plan">RelOptRules</a></td> |
| <td class="colLast"> |
| <div class="block">A utility class for organizing built-in rules and rule related |
| methods.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptSamplingParameters.html" title="class in org.apache.calcite.plan">RelOptSamplingParameters</a></td> |
| <td class="colLast"> |
| <div class="block">RelOptSamplingParameters represents the parameters necessary to produce a |
| sample of a relation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptUtil.html" title="class in org.apache.calcite.plan">RelOptUtil</a></td> |
| <td class="colLast"> |
| <div class="block"><code>RelOptUtil</code> defines static utility methods for use in optimizing |
| <a href="../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a>s.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptUtil.Exists.html" title="class in org.apache.calcite.plan">RelOptUtil.Exists</a></td> |
| <td class="colLast"> |
| <div class="block">Result of calling |
| <a href="../../../../org/apache/calcite/plan/RelOptUtil.html#createExistsPlan-org.apache.calcite.plan.RelOptCluster-org.apache.calcite.rel.RelNode-java.util.List-org.apache.calcite.rex.RexLiteral-java.lang.String-"><code>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)</code></a></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptUtil.InputFinder.html" title="class in org.apache.calcite.plan">RelOptUtil.InputFinder</a></td> |
| <td class="colLast"> |
| <div class="block">Visitor which builds a bitmap of the inputs used by an expression.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptUtil.InputReferencedVisitor.html" title="class in org.apache.calcite.plan">RelOptUtil.InputReferencedVisitor</a></td> |
| <td class="colLast"> |
| <div class="block">Shuttle that finds the set of inputs that are used.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptUtil.RexInputConverter.html" title="class in org.apache.calcite.plan">RelOptUtil.RexInputConverter</a></td> |
| <td class="colLast"> |
| <div class="block">Walks an expression tree, converting the index of RexInputRefs based on |
| some adjustment factor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptUtil.TypeDumper.html" title="class in org.apache.calcite.plan">RelOptUtil.TypeDumper</a></td> |
| <td class="colLast"> |
| <div class="block">Converts types to descriptive strings.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptUtil.VariableUsedVisitor.html" title="class in org.apache.calcite.plan">RelOptUtil.VariableUsedVisitor</a></td> |
| <td class="colLast"> |
| <div class="block">Visitor that finds all variables used in an expression.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a><T extends <a href="../../../../org/apache/calcite/plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>></td> |
| <td class="colLast"> |
| <div class="block">RelTraitDef represents a class of <a href="../../../../org/apache/calcite/plan/RelTrait.html" title="interface in org.apache.calcite.plan"><code>RelTrait</code></a>s.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelTraitPropagationVisitor.html" title="class in org.apache.calcite.plan">RelTraitPropagationVisitor</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">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 |
| <a href="../../../../org/apache/calcite/rel/RelShuttle.html" title="interface in org.apache.calcite.rel"><code>RelShuttle</code></a> directly.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></td> |
| <td class="colLast"> |
| <div class="block">RelTraitSet represents an ordered set of <a href="../../../../org/apache/calcite/plan/RelTrait.html" title="interface in org.apache.calcite.plan"><code>RelTrait</code></a>s.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RexImplicationChecker.html" title="class in org.apache.calcite.plan">RexImplicationChecker</a></td> |
| <td class="colLast"> |
| <div class="block">Checks whether one condition logically implies another.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/Strong.html" title="class in org.apache.calcite.plan">Strong</a></td> |
| <td class="colLast"> |
| <div class="block">Utilities for strong predicates.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/SubstitutionVisitor.html" title="class in org.apache.calcite.plan">SubstitutionVisitor</a></td> |
| <td class="colLast"> |
| <div class="block">Substitutes part of a tree of relational expressions with another tree.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/SubstitutionVisitor.AbstractUnifyRule.html" title="class in org.apache.calcite.plan">SubstitutionVisitor.AbstractUnifyRule</a></td> |
| <td class="colLast"> |
| <div class="block">Abstract base class for implementing <a href="../../../../org/apache/calcite/plan/SubstitutionVisitor.UnifyRule.html" title="class in org.apache.calcite.plan"><code>SubstitutionVisitor.UnifyRule</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/SubstitutionVisitor.Operand.html" title="class in org.apache.calcite.plan">SubstitutionVisitor.Operand</a></td> |
| <td class="colLast"> |
| <div class="block">Operand to a <a href="../../../../org/apache/calcite/plan/SubstitutionVisitor.UnifyRule.html" title="class in org.apache.calcite.plan"><code>SubstitutionVisitor.UnifyRule</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/SubstitutionVisitor.UnifyResult.html" title="class in org.apache.calcite.plan">SubstitutionVisitor.UnifyResult</a></td> |
| <td class="colLast"> |
| <div class="block">Result of an application of a <a href="../../../../org/apache/calcite/plan/SubstitutionVisitor.UnifyRule.html" title="class in org.apache.calcite.plan"><code>SubstitutionVisitor.UnifyRule</code></a> indicating that the |
| rule successfully matched <code>query</code> against <code>target</code> and |
| generated a <code>result</code> that is equivalent to <code>query</code> and |
| contains <code>target</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/SubstitutionVisitor.UnifyRule.html" title="class in org.apache.calcite.plan">SubstitutionVisitor.UnifyRule</a></td> |
| <td class="colLast"> |
| <div class="block">Rule that attempts to match a query relational expression |
| against a target relational expression.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/TableAccessMap.html" title="class in org.apache.calcite.plan">TableAccessMap</a></td> |
| <td class="colLast"> |
| <div class="block"><code>TableAccessMap</code> represents the tables accessed by a query plan, |
| with READ/WRITE information.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/ViewExpanders.html" title="class in org.apache.calcite.plan">ViewExpanders</a></td> |
| <td class="colLast"> |
| <div class="block">Utilities for <a href="../../../../org/apache/calcite/plan/RelOptTable.ViewExpander.html" title="interface in org.apache.calcite.plan"><code>RelOptTable.ViewExpander</code></a> and |
| <a href="../../../../org/apache/calcite/plan/RelOptTable.ToRelContext.html" title="interface in org.apache.calcite.plan"><code>RelOptTable.ToRelContext</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/VisitorDataContext.html" title="class in org.apache.calcite.plan">VisitorDataContext</a></td> |
| <td class="colLast"> |
| <div class="block">DataContext for evaluating an RexExpression</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/DeriveMode.html" title="enum in org.apache.calcite.plan">DeriveMode</a></td> |
| <td class="colLast"> |
| <div class="block">The mode of trait derivation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptRuleOperandChildPolicy.html" title="enum in org.apache.calcite.plan">RelOptRuleOperandChildPolicy</a></td> |
| <td class="colLast"> |
| <div class="block">Policy by which operands will be matched by relational expressions with |
| any number of children.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptUtil.Logic.html" title="enum in org.apache.calcite.plan">RelOptUtil.Logic</a></td> |
| <td class="colLast"> |
| <div class="block">Policies for handling two- and three-valued boolean logic.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptUtil.SubQueryType.html" title="enum in org.apache.calcite.plan">RelOptUtil.SubQueryType</a></td> |
| <td class="colLast"> |
| <div class="block">What kind of sub-query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/Strong.Policy.html" title="enum in org.apache.calcite.plan">Strong.Policy</a></td> |
| <td class="colLast"> |
| <div class="block">How whether an operator's operands are null affects whether a call to |
| that operator evaluates to null.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/TableAccessMap.Mode.html" title="enum in org.apache.calcite.plan">TableAccessMap.Mode</a></td> |
| <td class="colLast"> |
| <div class="block">Access mode.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/RelOptPlanner.CannotPlanException.html" title="class in org.apache.calcite.plan">RelOptPlanner.CannotPlanException</a></td> |
| <td class="colLast"> |
| <div class="block">Thrown by <a href="../../../../org/apache/calcite/plan/RelOptPlanner.html#findBestExp--"><code>RelOptPlanner.findBestExp()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/plan/SubstitutionVisitor.MatchFailed.html" title="class in org.apache.calcite.plan">SubstitutionVisitor.MatchFailed</a></td> |
| <td class="colLast"> |
| <div class="block">Exception thrown to exit a matcher.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.calcite.plan Description">Package org.apache.calcite.plan Description</h2> |
| <div class="block">Defines interfaces for constructing rule-based optimizers of |
| relational expressions.</div> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/calcite/piglet/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/apache/calcite/plan/hep/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/plan/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </body> |
| </html> |