| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RelOptPlanner (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, interface: RelOptPlanner"> |
| <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>Constr | </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>Constr | </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</a></div> |
| <h1 title="Interface RelOptPlanner" class="title">Interface RelOptPlanner</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code>, <code><a href="hep/HepPlanner.html" title="class in org.apache.calcite.plan.hep">HepPlanner</a></code>, <code><a href="../test/MockRelOptPlanner.html" title="class in org.apache.calcite.test">MockRelOptPlanner</a></code>, <code><a href="volcano/VolcanoPlanner.html" title="class in org.apache.calcite.plan.volcano">VolcanoPlanner</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">RelOptPlanner</span></div> |
| <div class="block">A <code>RelOptPlanner</code> is a query optimizer: it transforms a relational |
| expression into a semantically equivalent relational expression, according to |
| a given set of rules and a cost model.</div> |
| </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="caption"><span>Nested Classes</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">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="RelOptPlanner.CannotPlanException.html" class="type-name-link" title="class in org.apache.calcite.plan">RelOptPlanner.CannotPlanException</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Thrown by <a href="#findBestExp()"><code>findBestExp()</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static interface </code></div> |
| <div class="col-second odd-row-color"><code><a href="RelOptPlanner.Executor.html" class="type-name-link" title="interface in org.apache.calcite.plan">RelOptPlanner.Executor</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex"><code>RexExecutor</code></a></div> |
| </div> |
| </div> |
| </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>static final org.slf4j.Logger</code></div> |
| <div class="col-second even-row-color"><code><a href="#LOGGER" class="member-name-link">LOGGER</a></code></div> |
| <div class="col-last even-row-color"> </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-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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"> |
| <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-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addListener(org.apache.calcite.plan.RelOptListener)" class="member-name-link">addListener</a><wbr>(<a href="RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a> newListener)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Adds a listener to this planner.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Defines a pair of relational expressions that are equivalent.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Registers a rel trait definition.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Registers a rule.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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-tab3"><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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Changes a relational expression to an equivalent one with a different set |
| of traits.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"><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-tab3"> |
| <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-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"> |
| <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-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"> |
| <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-tab3"><code><a href="RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#emptyTraitSet()" class="member-name-link">emptyTraitSet</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates an empty trait set.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"><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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Registers a relational expression if it is not already registered.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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-tab3"><code><a href="#findBestExp()" class="member-name-link">findBestExp</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Finds the most efficient expression to implement this query.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Context.html" title="interface in org.apache.calcite.plan">Context</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getContext()" class="member-name-link">getContext</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Provides the Context created when this planner was constructed.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><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-tab3 method-summary-table-tab6"><code><a href="#getCost(org.apache.calcite.rel.RelNode)" class="member-name-link">getCost</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-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#getCost(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.metadata.RelMetadataQuery)"><code>getCost(RelNode, RelMetadataQuery)</code></a> |
| or, better, call <a href="../rel/metadata/RelMetadataQuery.html#getCumulativeCost(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getCumulativeCost(RelNode)</code></a>.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Computes the cost of a RelNode.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCostFactory()" class="member-name-link">getCostFactory</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the factory that creates |
| <a href="RelOptCost.html" title="interface in org.apache.calcite.plan"><code>RelOptCost</code></a>s.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex">RexExecutor</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getExecutor()" class="member-name-link">getExecutor</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the executor used to evaluate constant expressions.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="RelOptLattice.html" title="class in org.apache.calcite.plan">RelOptLattice</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Retrieves a lattice, given its star table.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"><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-tab3"> |
| <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-tab3 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-tab3 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-tab3 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-tab3"><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-tab3"><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-tab3"> |
| <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-tab3"><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-tab3"><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-tab3"> |
| <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-tab3"><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="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRules()" class="member-name-link">getRules</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the list of all registered rules.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"> |
| <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-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#onCopy(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)" class="member-name-link">onCopy</a><wbr>(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> newRel)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Called when a relational expression is copied to a similar expression.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"> |
| <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-tab3"><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-tab3"><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-tab3"> |
| <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-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#registerClass(org.apache.calcite.rel.RelNode)" class="member-name-link">registerClass</a><wbr>(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> node)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Registers a class of RelNode.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Tells this planner that a schema exists.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Removes a rule.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 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-tab3 method-summary-table-tab6"><code><a href="#setCancelFlag(org.apache.calcite.util.CancelFlag)" class="member-name-link">setCancelFlag</a><wbr>(<a href="../util/CancelFlag.html" title="class in org.apache.calcite.util">CancelFlag</a> cancelFlag)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Previously, this method installed the cancellation-checking |
| flag for this planner, but is now deprecated.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setExecutor(org.apache.calcite.rex.RexExecutor)" class="member-name-link">setExecutor</a><wbr>(@Nullable <a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex">RexExecutor</a> executor)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the object that can execute scalar expressions.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets 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-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setRuleDescExclusionFilter(java.util.regex.Pattern)" class="member-name-link">setRuleDescExclusionFilter</a><wbr>(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html" title="class or interface in java.util.regex" class="external-link">Pattern</a> exclusionFilter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the exclusion filter to use for this planner.</div> |
| </div> |
| </div> |
| </div> |
| </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="LOGGER"> |
| <h3>LOGGER</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type">org.slf4j.Logger</span> <span class="element-name">LOGGER</span></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="setRoot(org.apache.calcite.rel.RelNode)"> |
| <h3>setRoot</h3> |
| <div class="member-signature"><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">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="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">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="addRelTraitDef(org.apache.calcite.plan.RelTraitDef)"> |
| <h3>addRelTraitDef</h3> |
| <div class="member-signature"><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">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>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="return-type">void</span> <span class="element-name">clearRelTraitDefs</span>()</div> |
| <div class="block">Clear all the registered RelTraitDef.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRelTraitDefs()"> |
| <h3>getRelTraitDefs</h3> |
| <div class="member-signature"><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">Returns the list of active trait types.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clear()"> |
| <h3>clear</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">clear</span>()</div> |
| <div class="block">Removes all internal state, including all registered rules, |
| materialized views, and lattices.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRules()"> |
| <h3>getRules</h3> |
| <div class="member-signature"><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="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>></span> <span class="element-name">getRules</span>()</div> |
| <div class="block">Returns the list of all registered rules.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addRule(org.apache.calcite.plan.RelOptRule)"> |
| <h3>addRule</h3> |
| <div class="member-signature"><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">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="#addRelTraitDef(org.apache.calcite.plan.RelTraitDef)"><code>registered</code></a> RelTraitDef |
| instances.</div> |
| <dl class="notes"> |
| <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="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">Removes a rule.</div> |
| <dl class="notes"> |
| <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="getContext()"> |
| <h3>getContext</h3> |
| <div class="member-signature"><span class="return-type"><a href="Context.html" title="interface in org.apache.calcite.plan">Context</a></span> <span class="element-name">getContext</span>()</div> |
| <div class="block">Provides the Context created when this planner was constructed.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Never null; either an externally defined context, or a dummy |
| context that returns null for each requested interface</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRuleDescExclusionFilter(java.util.regex.Pattern)"> |
| <h3>setRuleDescExclusionFilter</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setRuleDescExclusionFilter</span><wbr><span class="parameters">(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html" title="class or interface in java.util.regex" class="external-link">Pattern</a> exclusionFilter)</span></div> |
| <div class="block">Sets the exclusion filter to use for this planner. Rules which match the |
| given pattern will not be fired regardless of whether or when they are |
| added to the planner.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>exclusionFilter</code> - pattern to match for exclusion; null to disable |
| filtering</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCancelFlag(org.apache.calcite.util.CancelFlag)"> |
| <h3>setCancelFlag</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="return-type">void</span> <span class="element-name">setCancelFlag</span><wbr><span class="parameters">(<a href="../util/CancelFlag.html" title="class in org.apache.calcite.util">CancelFlag</a> cancelFlag)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Previously, this method installed the cancellation-checking |
| flag for this planner, but is now deprecated. Now, you should add a |
| <a href="../util/CancelFlag.html" title="class in org.apache.calcite.util"><code>CancelFlag</code></a> to the <a href="Context.html" title="interface in org.apache.calcite.plan"><code>Context</code></a> passed to the constructor.</div> |
| </div> |
| <div class="block">Does nothing.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>cancelFlag</code> - flag which the planner should periodically check</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="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">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="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">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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addMaterialization(org.apache.calcite.plan.RelOptMaterialization)"> |
| <h3>addMaterialization</h3> |
| <div class="member-signature"><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">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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaterializations()"> |
| <h3>getMaterializations</h3> |
| <div class="member-signature"><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">Returns the materializations that have been registered with the planner.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addLattice(org.apache.calcite.plan.RelOptLattice)"> |
| <h3>addLattice</h3> |
| <div class="member-signature"><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">Defines a lattice. |
| |
| <p>The lattice may have materializations; it is not necessary to call |
| <a href="#addMaterialization(org.apache.calcite.plan.RelOptMaterialization)"><code>addMaterialization(org.apache.calcite.plan.RelOptMaterialization)</code></a> for these; they are registered implicitly.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLattice(org.apache.calcite.plan.RelOptTable)"> |
| <h3>getLattice</h3> |
| <div class="member-signature"><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">Retrieves a lattice, given its star table.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="findBestExp()"> |
| <h3>findBestExp</h3> |
| <div class="member-signature"><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 this query.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="RelOptPlanner.CannotPlanException.html" title="class in org.apache.calcite.plan">RelOptPlanner.CannotPlanException</a></code> - if cannot find a plan</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCostFactory()"> |
| <h3>getCostFactory</h3> |
| <div class="member-signature"><span class="return-type"><a href="RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a></span> <span class="element-name">getCostFactory</span>()</div> |
| <div class="block">Returns the factory that creates |
| <a href="RelOptCost.html" title="interface in org.apache.calcite.plan"><code>RelOptCost</code></a>s.</div> |
| </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="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">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>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="getCost(org.apache.calcite.rel.RelNode)"> |
| <h3>getCost</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="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)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#getCost(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.metadata.RelMetadataQuery)"><code>getCost(RelNode, RelMetadataQuery)</code></a> |
| or, better, call <a href="../rel/metadata/RelMetadataQuery.html#getCumulativeCost(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getCumulativeCost(RelNode)</code></a>.</div> |
| </div> |
| </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="return-type"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</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">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="#ensureRegistered(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)"><code>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="return-type"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</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">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="isRegistered(org.apache.calcite.rel.RelNode)"> |
| <h3>isRegistered</h3> |
| <div class="member-signature"><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">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="registerSchema(org.apache.calcite.plan.RelOptSchema)"> |
| <h3>registerSchema</h3> |
| <div class="member-signature"><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">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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addListener(org.apache.calcite.plan.RelOptListener)"> |
| <h3>addListener</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">addListener</span><wbr><span class="parameters">(<a href="RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a> newListener)</span></div> |
| <div class="block">Adds a listener to this planner.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>newListener</code> - new listener to be notified of events</dd> |
| </dl> |
| </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="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">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>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="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">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>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="prune(org.apache.calcite.rel.RelNode)"> |
| <h3>prune</h3> |
| <div class="member-signature"><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">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>Parameters:</dt> |
| <dd><code>rel</code> - the node to prune.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="registerClass(org.apache.calcite.rel.RelNode)"> |
| <h3>registerClass</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">registerClass</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">Registers a class of RelNode. If this class of RelNode has been seen |
| before, does nothing.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>node</code> - Relational expression</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="emptyTraitSet()"> |
| <h3>emptyTraitSet</h3> |
| <div class="member-signature"><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">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>Returns:</dt> |
| <dd>Empty trait set</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setExecutor(org.apache.calcite.rex.RexExecutor)"> |
| <h3>setExecutor</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setExecutor</span><wbr><span class="parameters">(@Nullable <a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex">RexExecutor</a> executor)</span></div> |
| <div class="block">Sets the object that can execute scalar expressions.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getExecutor()"> |
| <h3>getExecutor</h3> |
| <div class="member-signature"><span class="return-type">@Nullable <a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex">RexExecutor</a></span> <span class="element-name">getExecutor</span>()</div> |
| <div class="block">Returns the executor used to evaluate constant expressions.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onCopy(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)"> |
| <h3>onCopy</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">onCopy</span><wbr><span class="parameters">(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> newRel)</span></div> |
| <div class="block">Called when a relational expression is copied to a similar expression.</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> |
