| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>PhysicalNode (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.rel, interface: PhysicalNode"> |
| <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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </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.rel</a></div> |
| <h1 title="Interface PhysicalNode" class="title">Interface PhysicalNode</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code>, <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code>, <code><a href="../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="../adapter/enumerable/EnumerableRel.html" title="interface in org.apache.calcite.adapter.enumerable">EnumerableRel</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../adapter/cassandra/CassandraToEnumerableConverter.html" title="class in org.apache.calcite.adapter.cassandra">CassandraToEnumerableConverter</a></code>, <code><a href="../adapter/csv/CsvTableScan.html" title="class in org.apache.calcite.adapter.csv">CsvTableScan</a></code>, <code><a href="../adapter/file/CsvTableScan.html" title="class in org.apache.calcite.adapter.file">CsvTableScan</a></code>, <code><a href="../adapter/elasticsearch/ElasticsearchToEnumerableConverter.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchToEnumerableConverter</a></code>, <code><a href="../adapter/enumerable/EnumerableAggregate.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableAggregate</a></code>, <code><a href="../adapter/enumerable/EnumerableBatchNestedLoopJoin.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableBatchNestedLoopJoin</a></code>, <code><a href="../adapter/enumerable/EnumerableCalc.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableCalc</a></code>, <code><a href="../adapter/enumerable/EnumerableCollect.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableCollect</a></code>, <code><a href="../adapter/enumerable/EnumerableCorrelate.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableCorrelate</a></code>, <code><a href="../adapter/enumerable/EnumerableFilter.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableFilter</a></code>, <code><a href="../adapter/enumerable/EnumerableHashJoin.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableHashJoin</a></code>, <code><a href="../adapter/enumerable/EnumerableInterpreter.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableInterpreter</a></code>, <code><a href="../adapter/enumerable/EnumerableIntersect.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableIntersect</a></code>, <code><a href="../adapter/enumerable/EnumerableLimit.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableLimit</a></code>, <code><a href="../adapter/enumerable/EnumerableLimitSort.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableLimitSort</a></code>, <code><a href="../adapter/enumerable/EnumerableMatch.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableMatch</a></code>, <code><a href="../adapter/enumerable/EnumerableMergeJoin.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableMergeJoin</a></code>, <code><a href="../adapter/enumerable/EnumerableMergeUnion.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableMergeUnion</a></code>, <code><a href="../adapter/enumerable/EnumerableMinus.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableMinus</a></code>, <code><a href="../adapter/enumerable/EnumerableNestedLoopJoin.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableNestedLoopJoin</a></code>, <code><a href="../adapter/enumerable/EnumerableProject.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableProject</a></code>, <code><a href="../adapter/enumerable/EnumerableRepeatUnion.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableRepeatUnion</a></code>, <code><a href="../adapter/enumerable/EnumerableSort.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableSort</a></code>, <code><a href="../adapter/enumerable/EnumerableSortedAggregate.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableSortedAggregate</a></code>, <code><a href="../adapter/enumerable/EnumerableTableFunctionScan.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableTableFunctionScan</a></code>, <code><a href="../adapter/enumerable/EnumerableTableModify.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableTableModify</a></code>, <code><a href="../adapter/enumerable/EnumerableTableScan.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableTableScan</a></code>, <code><a href="../adapter/enumerable/EnumerableTableSpool.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableTableSpool</a></code>, <code><a href="../adapter/enumerable/EnumerableUncollect.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableUncollect</a></code>, <code><a href="../adapter/enumerable/EnumerableUnion.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableUnion</a></code>, <code><a href="../adapter/enumerable/EnumerableValues.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableValues</a></code>, <code><a href="../adapter/enumerable/EnumerableWindow.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableWindow</a></code>, <code><a href="../adapter/geode/rel/GeodeToEnumerableConverter.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeToEnumerableConverter</a></code>, <code><a href="../adapter/innodb/InnodbToEnumerableConverter.html" title="class in org.apache.calcite.adapter.innodb">InnodbToEnumerableConverter</a></code>, <code><a href="../adapter/jdbc/JdbcToEnumerableConverter.html" title="class in org.apache.calcite.adapter.jdbc">JdbcToEnumerableConverter</a></code>, <code><a href="../adapter/mongodb/MongoToEnumerableConverter.html" title="class in org.apache.calcite.adapter.mongodb">MongoToEnumerableConverter</a></code>, <code><a href="../adapter/pig/PigToEnumerableConverter.html" title="class in org.apache.calcite.adapter.pig">PigToEnumerableConverter</a></code>, <code><a href="../adapter/spark/SparkToEnumerableConverter.html" title="class in org.apache.calcite.adapter.spark">SparkToEnumerableConverter</a></code>, <code><a href="../adapter/splunk/SplunkTableScan.html" title="class in org.apache.calcite.adapter.splunk">SplunkTableScan</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">PhysicalNode</span><span class="extends-implements"> |
| extends <a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span></div> |
| <div class="block">Physical node in a planner that is capable of doing |
| physical trait propagation and derivation. |
| |
| <p>How to use?</p> |
| |
| <ol> |
| <li>Enable top-down optimization by setting |
| <a href="../plan/volcano/VolcanoPlanner.html#setTopDownOpt(boolean)"><code>VolcanoPlanner.setTopDownOpt(boolean)</code></a>. |
| </li> |
| |
| <li>Let your convention's rel interface extends <a href="PhysicalNode.html" title="interface in org.apache.calcite.rel"><code>PhysicalNode</code></a>, |
| see <a href="../adapter/enumerable/EnumerableRel.html" title="interface in org.apache.calcite.adapter.enumerable"><code>EnumerableRel</code></a> as |
| an example.</li> |
| |
| <li>Each physical operator overrides any one of the two methods: |
| <a href="#passThrough(org.apache.calcite.plan.RelTraitSet)"><code>passThrough(RelTraitSet)</code></a> or |
| <a href="#passThroughTraits(org.apache.calcite.plan.RelTraitSet)"><code>passThroughTraits(RelTraitSet)</code></a> depending on |
| your needs.</li> |
| |
| <li>Choose derive mode for each physical operator by overriding |
| <a href="#getDeriveMode()"><code>getDeriveMode()</code></a>.</li> |
| |
| <li>If the derive mode is <a href="../plan/DeriveMode.html#OMAKASE"><code>DeriveMode.OMAKASE</code></a>, override |
| method <a href="#derive(java.util.List)"><code>derive(List)</code></a> in the physical operator, |
| otherwise, override <a href="#derive(org.apache.calcite.plan.RelTraitSet,int)"><code>derive(RelTraitSet, int)</code></a> |
| or <a href="#deriveTraits(org.apache.calcite.plan.RelTraitSet,int)"><code>deriveTraits(RelTraitSet, int)</code></a>.</li> |
| |
| <li>Mark your enforcer operator by overriding <a href="RelNode.html#isEnforcer()"><code>RelNode.isEnforcer()</code></a>, |
| see <a href="core/Sort.html#isEnforcer()"><code>Sort.isEnforcer()</code></a> as an example. This is important, |
| because it can help <code>VolcanoPlanner</code> avoid unnecessary |
| trait propagation and derivation, therefore improve optimization |
| efficiency.</li> |
| |
| <li>Implement <a href="../plan/Convention.html#enforce(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)"><code>Convention.enforce(RelNode, RelTraitSet)</code></a> |
| in your convention, which generates appropriate physical enforcer. |
| See <a href="../adapter/enumerable/EnumerableConvention.html" title="enum in org.apache.calcite.adapter.enumerable"><code>EnumerableConvention</code></a> |
| as example. Simply return <code>null</code> if you don't want physical |
| trait enforcement.</li> |
| </ol></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.rel.RelNode">Nested classes/interfaces inherited from interface org.apache.calcite.rel.<a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></h2> |
| <code><a href="RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a></code></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-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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-tab5"><code>default <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="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-tab5"><code><a href="#derive(java.util.List)" class="member-name-link">derive</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="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="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>>> inputTraits)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Given a list of child traitsets, |
| inputTraits.size() == getInput().size(), |
| returns node list after traits derivation.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default @Nullable <a href="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-tab5"><code><a href="#derive(org.apache.calcite.plan.RelTraitSet,int)" class="member-name-link">derive</a><wbr>(<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> childTraits, |
| int childId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Derive traitset from child node, returns new node after |
| traits derivation.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default @Nullable <a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a><<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</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="../plan/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-tab5"><code><a href="#deriveTraits(org.apache.calcite.plan.RelTraitSet,int)" class="member-name-link">deriveTraits</a><wbr>(<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> childTraits, |
| int childId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Derive traitset from child node, returns a pair of traits after |
| traits derivation.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="../plan/DeriveMode.html" title="enum in org.apache.calcite.plan">DeriveMode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getDeriveMode()" class="member-name-link">getDeriveMode</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns mode of derivation.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default @Nullable <a href="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-tab5"><code><a href="#passThrough(org.apache.calcite.plan.RelTraitSet)" class="member-name-link">passThrough</a><wbr>(<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> required)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Pass required traitset from parent node to child nodes, |
| returns new node after traits is passed down.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default @Nullable <a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a><<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</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="../plan/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-tab5"><code><a href="#passThroughTraits(org.apache.calcite.plan.RelTraitSet)" class="member-name-link">passThroughTraits</a><wbr>(<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> required)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Pass required traitset from parent node to child nodes, |
| returns a pair of traits after traits is passed down.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.rel.RelNode">Methods inherited from interface org.apache.calcite.rel.<a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></h3> |
| <code><a href="RelNode.html#accept(org.apache.calcite.rel.RelShuttle)">accept</a>, <a href="RelNode.html#accept(org.apache.calcite.rex.RexShuttle)">accept</a>, <a href="RelNode.html#childrenAccept(org.apache.calcite.rel.RelVisitor)">childrenAccept</a>, <a href="RelNode.html#collectVariablesSet(java.util.Set)">collectVariablesSet</a>, <a href="RelNode.html#collectVariablesUsed(java.util.Set)">collectVariablesUsed</a>, <a href="RelNode.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">computeSelfCost</a>, <a href="RelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</a>, <a href="RelNode.html#deepEquals(java.lang.Object)">deepEquals</a>, <a href="RelNode.html#deepHashCode()">deepHashCode</a>, <a href="RelNode.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">estimateRowCount</a>, <a href="RelNode.html#explain()">explain</a>, <a href="RelNode.html#explain(org.apache.calcite.rel.RelWriter)">explain</a>, <a href="RelNode.html#fieldIsNullable(int)">fieldIsNullable</a>, <a href="RelNode.html#getConvention()">getConvention</a>, <a href="RelNode.html#getCorrelVariable()">getCorrelVariable</a>, <a href="RelNode.html#getDigest()">getDigest</a>, <a href="RelNode.html#getExpectedInputRowType(int)">getExpectedInputRowType</a>, <a href="RelNode.html#getInput(int)">getInput</a>, <a href="RelNode.html#getInputs()">getInputs</a>, <a href="RelNode.html#getRelDigest()">getRelDigest</a>, <a href="RelNode.html#getRelTypeName()">getRelTypeName</a>, <a href="RelNode.html#getRowType()">getRowType</a>, <a href="RelNode.html#getTable()">getTable</a>, <a href="RelNode.html#getVariablesSet()">getVariablesSet</a>, <a href="RelNode.html#isEnforcer()">isEnforcer</a>, <a href="RelNode.html#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">isValid</a>, <a href="RelNode.html#metadata(java.lang.Class,org.apache.calcite.rel.metadata.RelMetadataQuery)">metadata</a>, <a href="RelNode.html#onRegister(org.apache.calcite.plan.RelOptPlanner)">onRegister</a>, <a href="RelNode.html#recomputeDigest()">recomputeDigest</a>, <a href="RelNode.html#register(org.apache.calcite.plan.RelOptPlanner)">register</a>, <a href="RelNode.html#replaceInput(int,org.apache.calcite.rel.RelNode)">replaceInput</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.plan.RelOptNode">Methods inherited from interface org.apache.calcite.plan.<a href="../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></h3> |
| <code><a href="../plan/RelOptNode.html#getCluster()">getCluster</a>, <a href="../plan/RelOptNode.html#getDescription()">getDescription</a>, <a href="../plan/RelOptNode.html#getId()">getId</a>, <a href="../plan/RelOptNode.html#getTraitSet()">getTraitSet</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="passThrough(org.apache.calcite.plan.RelTraitSet)"> |
| <h3>passThrough</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">@Nullable <a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">passThrough</span><wbr><span class="parameters">(<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> required)</span></div> |
| <div class="block">Pass required traitset from parent node to child nodes, |
| returns new node after traits is passed down.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="passThroughTraits(org.apache.calcite.plan.RelTraitSet)"> |
| <h3>passThroughTraits</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">@Nullable <a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a><<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</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="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>>></span> <span class="element-name">passThroughTraits</span><wbr><span class="parameters">(<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> required)</span></div> |
| <div class="block">Pass required traitset from parent node to child nodes, |
| returns a pair of traits after traits is passed down. |
| |
| <p>Pair.left: the new traitset |
| <p>Pair.right: the list of required traitsets for child nodes</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="derive(org.apache.calcite.plan.RelTraitSet,int)"> |
| <h3>derive</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">@Nullable <a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">derive</span><wbr><span class="parameters">(<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> childTraits, |
| int childId)</span></div> |
| <div class="block">Derive traitset from child node, returns new node after |
| traits derivation.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deriveTraits(org.apache.calcite.plan.RelTraitSet,int)"> |
| <h3>deriveTraits</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">@Nullable <a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a><<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</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="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>>></span> <span class="element-name">deriveTraits</span><wbr><span class="parameters">(<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> childTraits, |
| int childId)</span></div> |
| <div class="block">Derive traitset from child node, returns a pair of traits after |
| traits derivation. |
| |
| <p>Pair.left: the new traitset |
| <p>Pair.right: the list of required traitsets for child nodes</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="derive(java.util.List)"> |
| <h3>derive</h3> |
| <div class="member-signature"><span class="modifiers">default</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="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></span> <span class="element-name">derive</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="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="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>>> inputTraits)</span></div> |
| <div class="block">Given a list of child traitsets, |
| inputTraits.size() == getInput().size(), |
| returns node list after traits derivation. This method is called |
| ONLY when the derive mode is OMAKASE.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDeriveMode()"> |
| <h3>getDeriveMode</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="../plan/DeriveMode.html" title="enum in org.apache.calcite.plan">DeriveMode</a></span> <span class="element-name">getDeriveMode</span>()</div> |
| <div class="block">Returns mode of derivation.</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> |
