| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>VolcanoPlanner (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.plan.volcano, class: VolcanoPlanner"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.plan.volcano</a></div> |
| <h1 title="Class VolcanoPlanner" class="title">Class VolcanoPlanner</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">org.apache.calcite.plan.AbstractRelOptPlanner</a> |
| <div class="inheritance">org.apache.calcite.plan.volcano.VolcanoPlanner</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">VolcanoPlanner</span> |
| <span class="extends-implements">extends <a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></span></div> |
| <div class="block">VolcanoPlanner optimizes queries by transforming expressions selectively |
| according to a dynamic programming algorithm.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.calcite.plan.RelOptPlanner">Nested classes/interfaces inherited from interface org.apache.calcite.plan.<a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></h2> |
| <code><a href="../RelOptPlanner.CannotPlanException.html" title="class in org.apache.calcite.plan">RelOptPlanner.CannotPlanException</a>, <a href="../RelOptPlanner.Executor.html" title="interface in org.apache.calcite.plan">RelOptPlanner.Executor</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected @MonotonicNonNull <a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#root" class="member-name-link">root</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.plan.AbstractRelOptPlanner">Fields inherited from class org.apache.calcite.plan.<a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></h3> |
| <code><a href="../AbstractRelOptPlanner.html#cancelFlag">cancelFlag</a>, <a href="../AbstractRelOptPlanner.html#context">context</a>, <a href="../AbstractRelOptPlanner.html#costFactory">costFactory</a>, <a href="../AbstractRelOptPlanner.html#mapDescToRule">mapDescToRule</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.plan.RelOptPlanner">Fields inherited from interface org.apache.calcite.plan.<a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></h3> |
| <code><a href="../RelOptPlanner.html#LOGGER">LOGGER</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">VolcanoPlanner</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a uninitialized <code>VolcanoPlanner</code>.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.plan.RelOptCostFactory,org.apache.calcite.plan.Context)" class="member-name-link">VolcanoPlanner</a><wbr>(@Nullable <a href="../RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a> costFactory, |
| @Nullable <a href="../Context.html" title="interface in org.apache.calcite.plan">Context</a> externalContext)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a <code>VolcanoPlanner</code> with a given cost factory.</div> |
| </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.plan.Context)" class="member-name-link">VolcanoPlanner</a><wbr>(<a href="../Context.html" title="interface in org.apache.calcite.plan">Context</a> externalContext)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a uninitialized <code>VolcanoPlanner</code>.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addLattice(org.apache.calcite.plan.RelOptLattice)" class="member-name-link">addLattice</a><wbr>(<a href="../RelOptLattice.html" title="class in org.apache.calcite.plan">RelOptLattice</a> lattice)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Defines a lattice.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addMaterialization(org.apache.calcite.plan.RelOptMaterialization)" class="member-name-link">addMaterialization</a><wbr>(<a href="../RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a> materialization)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Defines a pair of relational expressions that are equivalent.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addRelTraitDef(org.apache.calcite.plan.RelTraitDef)" class="member-name-link">addRelTraitDef</a><wbr>(<a href="../RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a> relTraitDef)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Registers a rel trait definition.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addRule(org.apache.calcite.plan.RelOptRule)" class="member-name-link">addRule</a><wbr>(<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> rule)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Registers a rule.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#changeTraits(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)" class="member-name-link">changeTraits</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> toTraits)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Changes a relational expression to an equivalent one with a different set |
| of traits.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkCancel()" class="member-name-link">checkCancel</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Checks to see whether cancellation has been requested, and if so, throws |
| an exception.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#chooseDelegate()" class="member-name-link">chooseDelegate</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Negotiates an appropriate planner to deal with distributed queries.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes all internal state, including all registered rules, |
| materialized views, and lattices.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearRelTraitDefs()" class="member-name-link">clearRelTraitDefs</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Clear all the registered RelTraitDef.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#dump(java.io.PrintWriter)" class="member-name-link">dump</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pw)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Dumps the internal state of this VolcanoPlanner to a writer.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#emptyTraitSet()" class="member-name-link">emptyTraitSet</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates an empty trait set.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#ensureRegistered(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)" class="member-name-link">ensureRegistered</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| @Nullable <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> equivRel)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Registers a relational expression if it is not already registered.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#findBestExp()" class="member-name-link">findBestExp</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Finds the most efficient expression to implement the query given via |
| <a href="../RelOptPlanner.html#setRoot(org.apache.calcite.rel.RelNode)"><code>RelOptPlanner.setRoot(org.apache.calcite.rel.RelNode)</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCost(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.metadata.RelMetadataQuery)" class="member-name-link">getCost</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../../rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a> mq)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Computes the cost of a RelNode.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../RelOptLattice.html" title="class in org.apache.calcite.plan">RelOptLattice</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLattice(org.apache.calcite.plan.RelOptTable)" class="member-name-link">getLattice</a><wbr>(<a href="../RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Retrieves a lattice, given its star table.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerBound(org.apache.calcite.rel.RelNode)" class="member-name-link">getLowerBound</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the lower bound cost of a relational operator.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaterializations()" class="member-name-link">getMaterializations</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the materializations that have been registered with the planner.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)" class="member-name-link">getRelMetadataTimestamp</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRelTraitDefs()" class="member-name-link">getRelTraitDefs</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the list of active trait types.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRoot()" class="member-name-link">getRoot</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the root node of this query.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable org.apache.calcite.plan.volcano.RelSet</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSet(org.apache.calcite.rel.RelNode)" class="member-name-link">getSet</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Finds an expression's equivalence set.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSubset(org.apache.calcite.rel.RelNode)" class="member-name-link">getSubset</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the subset that a relational expression belongs to.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSubset(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)" class="member-name-link">getSubset</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traits)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSubsetNonNull(org.apache.calcite.rel.RelNode)" class="member-name-link">getSubsetNonNull</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the subset that a relational expression belongs to.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isLogical(org.apache.calcite.rel.RelNode)" class="member-name-link">isLogical</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Decide whether a rule is logical or not.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isRegistered(org.apache.calcite.rel.RelNode)" class="member-name-link">isRegistered</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Determines whether a relational expression has been registered.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSubstituteRule(org.apache.calcite.plan.volcano.VolcanoRuleCall)" class="member-name-link">isSubstituteRule</a><wbr>(<a href="VolcanoRuleCall.html" title="class in org.apache.calcite.plan.volcano">VolcanoRuleCall</a> match)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Checks whether a rule match is a substitution rule match.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isTransformationRule(org.apache.calcite.plan.volcano.VolcanoRuleCall)" class="member-name-link">isTransformationRule</a><wbr>(<a href="VolcanoRuleCall.html" title="class in org.apache.calcite.plan.volcano">VolcanoRuleCall</a> match)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Checks whether a rule match is a transformation rule match.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isValid(org.apache.calcite.util.Litmus)" class="member-name-link">isValid</a><wbr>(<a href="../../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Checks internal consistency.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @PolyNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#normalizePlan(java.lang.String)" class="member-name-link">normalizePlan</a><wbr>(@PolyNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> plan)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Normalizes references to subsets within the string representation of a |
| plan.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onNewClass(org.apache.calcite.rel.RelNode)" class="member-name-link">onNewClass</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> node)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Called when a new class of <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> is seen.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#prune(org.apache.calcite.rel.RelNode)" class="member-name-link">prune</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Prunes a node from the planner.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#register(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)" class="member-name-link">register</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| @Nullable <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> equivRel)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Registers a relational expression in the expression bank.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerAbstractRelationalRules()" class="member-name-link">registerAbstractRelationalRules</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerMaterializations()" class="member-name-link">registerMaterializations</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#registerMetadataProviders(java.util.List)" class="member-name-link">registerMetadataProviders</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>> list)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerSchema(org.apache.calcite.plan.RelOptSchema)" class="member-name-link">registerSchema</a><wbr>(<a href="../RelOptSchema.html" title="interface in org.apache.calcite.plan">RelOptSchema</a> schema)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Tells this planner that a schema exists.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeRule(org.apache.calcite.plan.RelOptRule)" class="member-name-link">removeRule</a><wbr>(<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> rule)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes a rule.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLocked(boolean)" class="member-name-link">setLocked</a><wbr>(boolean locked)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets whether this planner is locked.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNoneConventionHasInfiniteCost(boolean)" class="member-name-link">setNoneConventionHasInfiniteCost</a><wbr>(boolean infinite)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets whether this planner should consider rel nodes with Convention.NONE |
| to have infinite cost or not.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRoot(org.apache.calcite.rel.RelNode)" class="member-name-link">setRoot</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the root node of this query.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTopDownOpt(boolean)" class="member-name-link">setTopDownOpt</a><wbr>(boolean value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Enable or disable top-down optimization.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toDot()" class="member-name-link">toDot</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#upperBoundForInputs(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelOptCost)" class="member-name-link">upperBoundForInputs</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> mExpr, |
| <a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a> upperBound)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the upper bound of its inputs.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.plan.AbstractRelOptPlanner">Methods inherited from class org.apache.calcite.plan.<a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></h3> |
| <code><a href="../AbstractRelOptPlanner.html#addListener(org.apache.calcite.plan.RelOptListener)">addListener</a>, <a href="../AbstractRelOptPlanner.html#dumpRuleAttemptsInfo()">dumpRuleAttemptsInfo</a>, <a href="../AbstractRelOptPlanner.html#fireRule(org.apache.calcite.plan.RelOptRuleCall)">fireRule</a>, <a href="../AbstractRelOptPlanner.html#getContext()">getContext</a>, <a href="../AbstractRelOptPlanner.html#getCost(org.apache.calcite.rel.RelNode)">getCost</a>, <a href="../AbstractRelOptPlanner.html#getCostFactory()">getCostFactory</a>, <a href="../AbstractRelOptPlanner.html#getExecutor()">getExecutor</a>, <a href="../AbstractRelOptPlanner.html#getListener()">getListener</a>, <a href="../AbstractRelOptPlanner.html#getRuleByDescription(java.lang.String)">getRuleByDescription</a>, <a href="../AbstractRelOptPlanner.html#getRules()">getRules</a>, <a href="../AbstractRelOptPlanner.html#isRuleExcluded(org.apache.calcite.plan.RelOptRule)">isRuleExcluded</a>, <a href="../AbstractRelOptPlanner.html#notifyChosen(org.apache.calcite.rel.RelNode)">notifyChosen</a>, <a href="../AbstractRelOptPlanner.html#notifyDiscard(org.apache.calcite.rel.RelNode)">notifyDiscard</a>, <a href="../AbstractRelOptPlanner.html#notifyEquivalence(org.apache.calcite.rel.RelNode,java.lang.Object,boolean)">notifyEquivalence</a>, <a href="../AbstractRelOptPlanner.html#notifyTransformation(org.apache.calcite.plan.RelOptRuleCall,org.apache.calcite.rel.RelNode,boolean)">notifyTransformation</a>, <a href="../AbstractRelOptPlanner.html#onCopy(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">onCopy</a>, <a href="../AbstractRelOptPlanner.html#registerClass(org.apache.calcite.rel.RelNode)">registerClass</a>, <a href="../AbstractRelOptPlanner.html#setCancelFlag(org.apache.calcite.util.CancelFlag)">setCancelFlag</a>, <a href="../AbstractRelOptPlanner.html#setExecutor(org.apache.calcite.rex.RexExecutor)">setExecutor</a>, <a href="../AbstractRelOptPlanner.html#setRuleDescExclusionFilter(java.util.regex.Pattern)">setRuleDescExclusionFilter</a>, <a href="../AbstractRelOptPlanner.html#subClasses(java.lang.Class)">subClasses</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="root"> |
| <h3>root</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">@MonotonicNonNull <a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a></span> <span class="element-name">root</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>VolcanoPlanner</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">VolcanoPlanner</span>()</div> |
| <div class="block">Creates a uninitialized <code>VolcanoPlanner</code>. To fully initialize |
| it, the caller must register the desired set of relations, rules, and |
| calling conventions.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.plan.Context)"> |
| <h3>VolcanoPlanner</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">VolcanoPlanner</span><wbr><span class="parameters">(<a href="../Context.html" title="interface in org.apache.calcite.plan">Context</a> externalContext)</span></div> |
| <div class="block">Creates a uninitialized <code>VolcanoPlanner</code>. To fully initialize |
| it, the caller must register the desired set of relations, rules, and |
| calling conventions.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.plan.RelOptCostFactory,org.apache.calcite.plan.Context)"> |
| <h3>VolcanoPlanner</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">VolcanoPlanner</span><wbr><span class="parameters">(@Nullable <a href="../RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a> costFactory, |
| @Nullable <a href="../Context.html" title="interface in org.apache.calcite.plan">Context</a> externalContext)</span></div> |
| <div class="block">Creates a <code>VolcanoPlanner</code> with a given cost factory.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="setTopDownOpt(boolean)"> |
| <h3>setTopDownOpt</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setTopDownOpt</span><wbr><span class="parameters">(boolean value)</span></div> |
| <div class="block">Enable or disable top-down optimization. |
| |
| <p>Note: Enabling top-down optimization will automatically enable |
| top-down trait propagation.</p></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRegistered(org.apache.calcite.rel.RelNode)"> |
| <h3>isRegistered</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isRegistered</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#isRegistered(org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div> |
| <div class="block">Determines whether a relational expression has been registered.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - expression to test</dd> |
| <dt>Returns:</dt> |
| <dd>whether rel has been registered</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRoot(org.apache.calcite.rel.RelNode)"> |
| <h3>setRoot</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRoot</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#setRoot(org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div> |
| <div class="block">Sets the root node of this query.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - Relational expression</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRoot()"> |
| <h3>getRoot</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">getRoot</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#getRoot()">RelOptPlanner</a></code></span></div> |
| <div class="block">Returns the root node of this query.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Root node</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaterializations()"> |
| <h3>getMaterializations</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a>></span> <span class="element-name">getMaterializations</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#getMaterializations()">RelOptPlanner</a></code></span></div> |
| <div class="block">Returns the materializations that have been registered with the planner.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelOptPlanner.html#getMaterializations()">getMaterializations</a></code> in interface <code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#getMaterializations()">getMaterializations</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addMaterialization(org.apache.calcite.plan.RelOptMaterialization)"> |
| <h3>addMaterialization</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addMaterialization</span><wbr><span class="parameters">(<a href="../RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a> materialization)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#addMaterialization(org.apache.calcite.plan.RelOptMaterialization)">RelOptPlanner</a></code></span></div> |
| <div class="block">Defines a pair of relational expressions that are equivalent. |
| |
| <p>Typically <code>tableRel</code> is a |
| <a href="../../rel/logical/LogicalTableScan.html" title="class in org.apache.calcite.rel.logical"><code>LogicalTableScan</code></a> representing a |
| table that is a materialized view and <code>queryRel</code> is the SQL |
| expression that populates that view. The intention is that |
| <code>tableRel</code> is cheaper to evaluate and therefore if the query being |
| optimized uses (or can be rewritten to use) <code>queryRel</code> as a |
| sub-expression then it can be optimized by using <code>tableRel</code> |
| instead.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelOptPlanner.html#addMaterialization(org.apache.calcite.plan.RelOptMaterialization)">addMaterialization</a></code> in interface <code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#addMaterialization(org.apache.calcite.plan.RelOptMaterialization)">addMaterialization</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addLattice(org.apache.calcite.plan.RelOptLattice)"> |
| <h3>addLattice</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addLattice</span><wbr><span class="parameters">(<a href="../RelOptLattice.html" title="class in org.apache.calcite.plan">RelOptLattice</a> lattice)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#addLattice(org.apache.calcite.plan.RelOptLattice)">RelOptPlanner</a></code></span></div> |
| <div class="block">Defines a lattice. |
| |
| <p>The lattice may have materializations; it is not necessary to call |
| <a href="../RelOptPlanner.html#addMaterialization(org.apache.calcite.plan.RelOptMaterialization)"><code>RelOptPlanner.addMaterialization(org.apache.calcite.plan.RelOptMaterialization)</code></a> for these; they are registered implicitly.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelOptPlanner.html#addLattice(org.apache.calcite.plan.RelOptLattice)">addLattice</a></code> in interface <code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#addLattice(org.apache.calcite.plan.RelOptLattice)">addLattice</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLattice(org.apache.calcite.plan.RelOptTable)"> |
| <h3>getLattice</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../RelOptLattice.html" title="class in org.apache.calcite.plan">RelOptLattice</a></span> <span class="element-name">getLattice</span><wbr><span class="parameters">(<a href="../RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#getLattice(org.apache.calcite.plan.RelOptTable)">RelOptPlanner</a></code></span></div> |
| <div class="block">Retrieves a lattice, given its star table.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelOptPlanner.html#getLattice(org.apache.calcite.plan.RelOptTable)">getLattice</a></code> in interface <code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#getLattice(org.apache.calcite.plan.RelOptTable)">getLattice</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="registerMaterializations()"> |
| <h3>registerMaterializations</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">registerMaterializations</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSet(org.apache.calcite.rel.RelNode)"> |
| <h3>getSet</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable org.apache.calcite.plan.volcano.RelSet</span> <span class="element-name">getSet</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <div class="block">Finds an expression's equivalence set. If the expression is not |
| registered, returns null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - Relational expression</dd> |
| <dt>Returns:</dt> |
| <dd>Equivalence set that expression belongs to, or null if it is not |
| registered</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addRelTraitDef(org.apache.calcite.plan.RelTraitDef)"> |
| <h3>addRelTraitDef</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">addRelTraitDef</span><wbr><span class="parameters">(<a href="../RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a> relTraitDef)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#addRelTraitDef(org.apache.calcite.plan.RelTraitDef)">RelOptPlanner</a></code></span></div> |
| <div class="block">Registers a rel trait definition. If the <a href="../RelTraitDef.html" title="class in org.apache.calcite.plan"><code>RelTraitDef</code></a> has already |
| been registered, does nothing.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelOptPlanner.html#addRelTraitDef(org.apache.calcite.plan.RelTraitDef)">addRelTraitDef</a></code> in interface <code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#addRelTraitDef(org.apache.calcite.plan.RelTraitDef)">addRelTraitDef</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>whether the RelTraitDef was added, as per |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html#add(E)" title="class or interface in java.util" class="external-link"><code>Collection.add(E)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clearRelTraitDefs()"> |
| <h3>clearRelTraitDefs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clearRelTraitDefs</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#clearRelTraitDefs()">RelOptPlanner</a></code></span></div> |
| <div class="block">Clear all the registered RelTraitDef.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelOptPlanner.html#clearRelTraitDefs()">clearRelTraitDefs</a></code> in interface <code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#clearRelTraitDefs()">clearRelTraitDefs</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRelTraitDefs()"> |
| <h3>getRelTraitDefs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>></span> <span class="element-name">getRelTraitDefs</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#getRelTraitDefs()">RelOptPlanner</a></code></span></div> |
| <div class="block">Returns the list of active trait types.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelOptPlanner.html#getRelTraitDefs()">getRelTraitDefs</a></code> in interface <code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#getRelTraitDefs()">getRelTraitDefs</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="emptyTraitSet()"> |
| <h3>emptyTraitSet</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></span> <span class="element-name">emptyTraitSet</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#emptyTraitSet()">RelOptPlanner</a></code></span></div> |
| <div class="block">Creates an empty trait set. It contains all registered traits, and the |
| default values of any traits that have them. |
| |
| <p>The empty trait set acts as the prototype (a kind of factory) for all |
| subsequently created trait sets.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelOptPlanner.html#emptyTraitSet()">emptyTraitSet</a></code> in interface <code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#emptyTraitSet()">emptyTraitSet</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Empty trait set</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clear()"> |
| <h3>clear</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clear</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#clear()">RelOptPlanner</a></code></span></div> |
| <div class="block">Removes all internal state, including all registered rules, |
| materialized views, and lattices.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelOptPlanner.html#clear()">clear</a></code> in interface <code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#clear()">clear</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addRule(org.apache.calcite.plan.RelOptRule)"> |
| <h3>addRule</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">addRule</span><wbr><span class="parameters">(<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> rule)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#addRule(org.apache.calcite.plan.RelOptRule)">RelOptPlanner</a></code></span></div> |
| <div class="block">Registers a rule. |
| |
| <p>If the rule has already been registered, does nothing. |
| This method determines if the given rule is a |
| <a href="../../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert"><code>ConverterRule</code></a> and pass the |
| ConverterRule to all |
| <a href="../RelOptPlanner.html#addRelTraitDef(org.apache.calcite.plan.RelTraitDef)"><code>registered</code></a> RelTraitDef |
| instances.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelOptPlanner.html#addRule(org.apache.calcite.plan.RelOptRule)">addRule</a></code> in interface <code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#addRule(org.apache.calcite.plan.RelOptRule)">addRule</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>whether the rule was added, as per |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html#add(E)" title="class or interface in java.util" class="external-link"><code>Collection.add(E)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeRule(org.apache.calcite.plan.RelOptRule)"> |
| <h3>removeRule</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">removeRule</span><wbr><span class="parameters">(<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> rule)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#removeRule(org.apache.calcite.plan.RelOptRule)">RelOptPlanner</a></code></span></div> |
| <div class="block">Removes a rule.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelOptPlanner.html#removeRule(org.apache.calcite.plan.RelOptRule)">removeRule</a></code> in interface <code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#removeRule(org.apache.calcite.plan.RelOptRule)">removeRule</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if the rule was present, as per |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html#remove(java.lang.Object)" title="class or interface in java.util" class="external-link"><code>Collection.remove(Object)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onNewClass(org.apache.calcite.rel.RelNode)"> |
| <h3>onNewClass</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">onNewClass</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> node)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../AbstractRelOptPlanner.html#onNewClass(org.apache.calcite.rel.RelNode)">AbstractRelOptPlanner</a></code></span></div> |
| <div class="block">Called when a new class of <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> is seen.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#onNewClass(org.apache.calcite.rel.RelNode)">onNewClass</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="changeTraits(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)"> |
| <h3>changeTraits</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">changeTraits</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> toTraits)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#changeTraits(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)">RelOptPlanner</a></code></span></div> |
| <div class="block">Changes a relational expression to an equivalent one with a different set |
| of traits.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - Relational expression (may or may not have been registered; must |
| not have the desired traits)</dd> |
| <dd><code>toTraits</code> - Trait set to convert the relational expression to</dd> |
| <dt>Returns:</dt> |
| <dd>Relational expression with desired traits. Never null, but may be |
| abstract</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="chooseDelegate()"> |
| <h3>chooseDelegate</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></span> <span class="element-name">chooseDelegate</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#chooseDelegate()">RelOptPlanner</a></code></span></div> |
| <div class="block">Negotiates an appropriate planner to deal with distributed queries. The |
| idea is that the schemas decide among themselves which has the most |
| knowledge. Right now, the local planner retains control.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelOptPlanner.html#chooseDelegate()">chooseDelegate</a></code> in interface <code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#chooseDelegate()">chooseDelegate</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="findBestExp()"> |
| <h3>findBestExp</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">findBestExp</span>()</div> |
| <div class="block">Finds the most efficient expression to implement the query given via |
| <a href="../RelOptPlanner.html#setRoot(org.apache.calcite.rel.RelNode)"><code>RelOptPlanner.setRoot(org.apache.calcite.rel.RelNode)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the most efficient RelNode tree found for implementing the given |
| query</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkCancel()"> |
| <h3>checkCancel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">checkCancel</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../AbstractRelOptPlanner.html#checkCancel()">AbstractRelOptPlanner</a></code></span></div> |
| <div class="block">Checks to see whether cancellation has been requested, and if so, throws |
| an exception.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#checkCancel()">checkCancel</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="register(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)"> |
| <h3>register</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a></span> <span class="element-name">register</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| @Nullable <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> equivRel)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#register(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div> |
| <div class="block">Registers a relational expression in the expression bank. |
| |
| <p>After it has been registered, you may not modify it. |
| |
| <p>The expression must not already have been registered. If you are not |
| sure whether it has been registered, call |
| <a href="../RelOptPlanner.html#ensureRegistered(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)"><code>RelOptPlanner.ensureRegistered(RelNode, RelNode)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - Relational expression to register (must not already be |
| registered)</dd> |
| <dd><code>equivRel</code> - Relational expression it is equivalent to (may be null)</dd> |
| <dt>Returns:</dt> |
| <dd>the same expression, or an equivalent existing expression</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureRegistered(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)"> |
| <h3>ensureRegistered</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a></span> <span class="element-name">ensureRegistered</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| @Nullable <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> equivRel)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#ensureRegistered(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div> |
| <div class="block">Registers a relational expression if it is not already registered. |
| |
| <p>If <code>equivRel</code> is specified, <code>rel</code> is placed in the same |
| equivalence set. It is OK if <code>equivRel</code> has different traits; |
| <code>rel</code> will end up in a different subset of the same set. |
| |
| <p>It is OK if <code>rel</code> is a subset.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - Relational expression to register</dd> |
| <dd><code>equivRel</code> - Relational expression it is equivalent to (may be null)</dd> |
| <dt>Returns:</dt> |
| <dd>Registered relational expression</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isValid(org.apache.calcite.util.Litmus)"> |
| <h3>isValid</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">isValid</span><wbr><span class="parameters">(<a href="../../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus)</span></div> |
| <div class="block">Checks internal consistency.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="registerAbstractRelationalRules()"> |
| <h3>registerAbstractRelationalRules</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">registerAbstractRelationalRules</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="registerSchema(org.apache.calcite.plan.RelOptSchema)"> |
| <h3>registerSchema</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">registerSchema</span><wbr><span class="parameters">(<a href="../RelOptSchema.html" title="interface in org.apache.calcite.plan">RelOptSchema</a> schema)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#registerSchema(org.apache.calcite.plan.RelOptSchema)">RelOptPlanner</a></code></span></div> |
| <div class="block">Tells this planner that a schema exists. This is the schema's chance to |
| tell the planner about all of the special transformation rules.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelOptPlanner.html#registerSchema(org.apache.calcite.plan.RelOptSchema)">registerSchema</a></code> in interface <code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#registerSchema(org.apache.calcite.plan.RelOptSchema)">registerSchema</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setNoneConventionHasInfiniteCost(boolean)"> |
| <h3>setNoneConventionHasInfiniteCost</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setNoneConventionHasInfiniteCost</span><wbr><span class="parameters">(boolean infinite)</span></div> |
| <div class="block">Sets whether this planner should consider rel nodes with Convention.NONE |
| to have infinite cost or not.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>infinite</code> - Whether to make none convention rel nodes infinite cost</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCost(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.metadata.RelMetadataQuery)"> |
| <h3>getCost</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></span> <span class="element-name">getCost</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../../rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a> mq)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#getCost(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.metadata.RelMetadataQuery)">RelOptPlanner</a></code></span></div> |
| <div class="block">Computes the cost of a RelNode. In most cases, this just dispatches to |
| <a href="../../rel/metadata/RelMetadataQuery.html#getCumulativeCost(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getCumulativeCost(org.apache.calcite.rel.RelNode)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelOptPlanner.html#getCost(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.metadata.RelMetadataQuery)">getCost</a></code> in interface <code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#getCost(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.metadata.RelMetadataQuery)">getCost</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - Relational expression of interest</dd> |
| <dd><code>mq</code> - Metadata query</dd> |
| <dt>Returns:</dt> |
| <dd>estimated cost</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSubset(org.apache.calcite.rel.RelNode)"> |
| <h3>getSubset</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a></span> <span class="element-name">getSubset</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <div class="block">Returns the subset that a relational expression belongs to.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - Relational expression</dd> |
| <dt>Returns:</dt> |
| <dd>Subset it belongs to, or null if it is not registered</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSubsetNonNull(org.apache.calcite.rel.RelNode)"> |
| <h3>getSubsetNonNull</h3> |
| <div class="member-signature"><span class="annotations">@API(since="1.26", |
| status=EXPERIMENTAL) |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a></span> <span class="element-name">getSubsetNonNull</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <div class="block">Returns the subset that a relational expression belongs to.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - Relational expression</dd> |
| <dt>Returns:</dt> |
| <dd>Subset it belongs to, or null if it is not registered</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AssertionError.html" title="class or interface in java.lang" class="external-link">AssertionError</a></code> - in case subset is not found</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSubset(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)"> |
| <h3>getSubset</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a></span> <span class="element-name">getSubset</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traits)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="prune(org.apache.calcite.rel.RelNode)"> |
| <h3>prune</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">prune</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#prune(org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div> |
| <div class="block">Prunes a node from the planner. |
| |
| <p>When a node is pruned, the related pending rule |
| calls are cancelled, and future rules will not fire. |
| This can be used to reduce the search space. </p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelOptPlanner.html#prune(org.apache.calcite.rel.RelNode)">prune</a></code> in interface <code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#prune(org.apache.calcite.rel.RelNode)">prune</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - the node to prune.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dump(java.io.PrintWriter)"> |
| <h3>dump</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">dump</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pw)</span></div> |
| <div class="block">Dumps the internal state of this VolcanoPlanner to a writer.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pw</code> - Print writer</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#normalizePlan(java.lang.String)"><code>normalizePlan(String)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toDot()"> |
| <h3>toDot</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toDot</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="registerMetadataProviders(java.util.List)"> |
| <h3>registerMetadataProviders</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">registerMetadataProviders</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>> list)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#registerMetadataProviders(java.util.List)">RelOptPlanner</a></code></span></div> |
| <div class="block">Gives this planner a chance to register one or more |
| <a href="../../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata"><code>RelMetadataProvider</code></a>s in the chain which will be used to answer |
| metadata queries. |
| |
| <p>Planners which use their own relational expressions internally |
| to represent concepts such as equivalence classes will generally need to |
| supply corresponding metadata providers.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelOptPlanner.html#registerMetadataProviders(java.util.List)">registerMetadataProviders</a></code> in interface <code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#registerMetadataProviders(java.util.List)">registerMetadataProviders</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>list</code> - receives planner's custom providers, if any</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)"> |
| <h3>getRelMetadataTimestamp</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getRelMetadataTimestamp</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptPlanner.html#getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div> |
| <div class="block">Gets a timestamp for a given rel's metadata. This timestamp is used by |
| <a href="../../rel/metadata/CachingRelMetadataProvider.html" title="class in org.apache.calcite.rel.metadata"><code>CachingRelMetadataProvider</code></a> to decide whether cached metadata has |
| gone stale.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelOptPlanner.html#getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)">getRelMetadataTimestamp</a></code> in interface <code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelOptPlanner.html#getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)">getRelMetadataTimestamp</a></code> in class <code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - rel of interest</dd> |
| <dt>Returns:</dt> |
| <dd>timestamp of last change which might affect metadata derivation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="normalizePlan(java.lang.String)"> |
| <h3>normalizePlan</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">@PolyNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">normalizePlan</span><wbr><span class="parameters">(@PolyNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> plan)</span></div> |
| <div class="block">Normalizes references to subsets within the string representation of a |
| plan. |
| |
| <p>This is useful when writing tests: it helps to ensure that tests don't |
| break when an extra rule is introduced that generates a new subset and |
| causes subsequent subset numbers to be off by one. |
| |
| <p>For example, |
| |
| <blockquote> |
| FennelAggRel.FENNEL_EXEC(child=Subset#17.FENNEL_EXEC,groupCount=1, |
| EXPR$1=COUNT())<br> |
| FennelSortRel.FENNEL_EXEC(child=Subset#2.FENNEL_EXEC, |
| key=[0], discardDuplicates=false)<br> |
| FennelCalcRel.FENNEL_EXEC( |
| child=Subset#4.FENNEL_EXEC, expr#0..8={inputs}, expr#9=3456, |
| DEPTNO=$t7, $f0=$t9)<br> |
| MockTableImplRel.FENNEL_EXEC( |
| table=[CATALOG, SALES, EMP])</blockquote> |
| |
| <p>becomes |
| |
| <blockquote> |
| FennelAggRel.FENNEL_EXEC(child=Subset#{0}.FENNEL_EXEC, groupCount=1, |
| EXPR$1=COUNT())<br> |
| FennelSortRel.FENNEL_EXEC(child=Subset#{1}.FENNEL_EXEC, |
| key=[0], discardDuplicates=false)<br> |
| FennelCalcRel.FENNEL_EXEC( |
| child=Subset#{2}.FENNEL_EXEC,expr#0..8={inputs},expr#9=3456,DEPTNO=$t7, |
| $f0=$t9)<br> |
| MockTableImplRel.FENNEL_EXEC( |
| table=[CATALOG, SALES, EMP])</blockquote> |
| |
| <p>Returns null if and only if <code>plan</code> is null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>plan</code> - Plan</dd> |
| <dt>Returns:</dt> |
| <dd>Normalized plan</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLocked(boolean)"> |
| <h3>setLocked</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setLocked</span><wbr><span class="parameters">(boolean locked)</span></div> |
| <div class="block">Sets whether this planner is locked. A locked planner does not accept |
| new rules. <a href="#addRule(org.apache.calcite.plan.RelOptRule)"><code>addRule(org.apache.calcite.plan.RelOptRule)</code></a> will do |
| nothing and return false.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>locked</code> - Whether planner is locked</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isLogical(org.apache.calcite.rel.RelNode)"> |
| <h3>isLogical</h3> |
| <div class="member-signature"><span class="annotations">@API(since="1.24", |
| status=EXPERIMENTAL) |
| </span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isLogical</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <div class="block">Decide whether a rule is logical or not.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - The specific rel node</dd> |
| <dt>Returns:</dt> |
| <dd>True if the relnode is a logical node</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSubstituteRule(org.apache.calcite.plan.volcano.VolcanoRuleCall)"> |
| <h3>isSubstituteRule</h3> |
| <div class="member-signature"><span class="annotations">@API(since="1.24", |
| status=EXPERIMENTAL) |
| </span><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">isSubstituteRule</span><wbr><span class="parameters">(<a href="VolcanoRuleCall.html" title="class in org.apache.calcite.plan.volcano">VolcanoRuleCall</a> match)</span></div> |
| <div class="block">Checks whether a rule match is a substitution rule match.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>match</code> - The rule match to check</dd> |
| <dt>Returns:</dt> |
| <dd>True if the rule match is a substitution rule match</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isTransformationRule(org.apache.calcite.plan.volcano.VolcanoRuleCall)"> |
| <h3>isTransformationRule</h3> |
| <div class="member-signature"><span class="annotations">@API(since="1.24", |
| status=EXPERIMENTAL) |
| </span><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">isTransformationRule</span><wbr><span class="parameters">(<a href="VolcanoRuleCall.html" title="class in org.apache.calcite.plan.volcano">VolcanoRuleCall</a> match)</span></div> |
| <div class="block">Checks whether a rule match is a transformation rule match.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>match</code> - The rule match to check</dd> |
| <dt>Returns:</dt> |
| <dd>True if the rule match is a transformation rule match</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLowerBound(org.apache.calcite.rel.RelNode)"> |
| <h3>getLowerBound</h3> |
| <div class="member-signature"><span class="annotations">@API(since="1.24", |
| status=EXPERIMENTAL) |
| </span><span class="modifiers">protected</span> <span class="return-type"><a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></span> <span class="element-name">getLowerBound</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <div class="block">Gets the lower bound cost of a relational operator.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - The rel node</dd> |
| <dt>Returns:</dt> |
| <dd>The lower bound cost of the given rel. The value is ensured NOT NULL.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="upperBoundForInputs(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelOptCost)"> |
| <h3>upperBoundForInputs</h3> |
| <div class="member-signature"><span class="annotations">@API(since="1.24", |
| status=EXPERIMENTAL) |
| </span><span class="modifiers">protected</span> <span class="return-type"><a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></span> <span class="element-name">upperBoundForInputs</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> mExpr, |
| <a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a> upperBound)</span></div> |
| <div class="block">Gets the upper bound of its inputs. |
| Allow users to overwrite this method as some implementations may have |
| different cost model on some RelNodes, like Spool.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
