| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Correlate (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.core, class: Correlate"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.rel.core</a></div> |
| <h1 title="Class Correlate" class="title">Class Correlate</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">org.apache.calcite.rel.AbstractRelNode</a> |
| <div class="inheritance"><a href="../BiRel.html" title="class in org.apache.calcite.rel">org.apache.calcite.rel.BiRel</a> |
| <div class="inheritance">org.apache.calcite.rel.core.Correlate</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</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="../../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code>, <code><a href="../hint/Hintable.html" title="interface in org.apache.calcite.rel.hint">Hintable</a></code>, <code><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../../adapter/enumerable/EnumerableCorrelate.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableCorrelate</a></code>, <code><a href="../logical/LogicalCorrelate.html" title="class in org.apache.calcite.rel.logical">LogicalCorrelate</a></code>, <code><a href="../../test/SqlToRelTestBase.CustomCorrelate.html" title="class in org.apache.calcite.test">SqlToRelTestBase.CustomCorrelate</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">Correlate</span> |
| <span class="extends-implements">extends <a href="../BiRel.html" title="class in org.apache.calcite.rel">BiRel</a> |
| implements <a href="../hint/Hintable.html" title="interface in org.apache.calcite.rel.hint">Hintable</a></span></div> |
| <div class="block">A relational operator that performs nested-loop joins. |
| |
| <p>It behaves like a kind of <a href="Join.html" title="class in org.apache.calcite.rel.core"><code>Join</code></a>, |
| but works by setting variables in its environment and restarting its |
| right-hand input. |
| |
| <p>Correlate is not a join since: typical rules should not match Correlate. |
| |
| <p>A Correlate is used to represent a correlated query. One |
| implementation strategy is to de-correlate the expression. |
| |
| <table> |
| <caption>Mapping of physical operations to logical ones</caption> |
| <tr><th>Physical operation</th><th>Logical operation</th></tr> |
| <tr><td>NestedLoops</td><td>Correlate(A, B, regular)</td></tr> |
| <tr><td>NestedLoopsOuter</td><td>Correlate(A, B, outer)</td></tr> |
| <tr><td>NestedLoopsSemi</td><td>Correlate(A, B, semi)</td></tr> |
| <tr><td>NestedLoopsAnti</td><td>Correlate(A, B, anti)</td></tr> |
| <tr><td>HashJoin</td><td>EquiJoin(A, B)</td></tr> |
| <tr><td>HashJoinOuter</td><td>EquiJoin(A, B, outer)</td></tr> |
| <tr><td>HashJoinSemi</td><td>SemiJoin(A, B, semi)</td></tr> |
| <tr><td>HashJoinAnti</td><td>SemiJoin(A, B, anti)</td></tr> |
| </table></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="CorrelationId.html" title="class in org.apache.calcite.rel.core"><code>CorrelationId</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </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> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected final <a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#correlationId" class="member-name-link">correlationId</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final com.google.common.collect.ImmutableList<<a href="../hint/RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#hints" class="member-name-link">hints</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected final <a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#joinType" class="member-name-link">joinType</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#requiredColumns" class="member-name-link">requiredColumns</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.rel.BiRel">Fields inherited from class org.apache.calcite.rel.<a href="../BiRel.html" title="class in org.apache.calcite.rel">BiRel</a></h3> |
| <code><a href="../BiRel.html#left">left</a>, <a href="../BiRel.html#right">right</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.rel.AbstractRelNode">Fields inherited from class org.apache.calcite.rel.<a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></h3> |
| <code><a href="../AbstractRelNode.html#digest">digest</a>, <a href="../AbstractRelNode.html#id">id</a>, <a href="../AbstractRelNode.html#rowType">rowType</a>, <a href="../AbstractRelNode.html#traitSet">traitSet</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelTraitSet,java.util.List,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.core.CorrelationId,org.apache.calcite.util.ImmutableBitSet,org.apache.calcite.rel.core.JoinRelType)" class="member-name-link">Correlate</a><wbr>(<a href="../../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a> cluster, |
| <a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <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="../hint/RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>> hints, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> left, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> right, |
| <a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a> correlationId, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> requiredColumns, |
| <a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a> joinType)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a Correlate.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.core.CorrelationId,org.apache.calcite.util.ImmutableBitSet,org.apache.calcite.rel.core.JoinRelType)" class="member-name-link">Correlate</a><wbr>(<a href="../../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a> cluster, |
| <a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> left, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> right, |
| <a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a> correlationId, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> requiredColumns, |
| <a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a> joinType)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.rel.RelInput)" class="member-name-link">Correlate</a><wbr>(<a href="../RelInput.html" title="interface in org.apache.calcite.rel">RelInput</a> input)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a Correlate by parsing serialized output.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../../plan/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-tab4"><code><a href="#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)" class="member-name-link">computeSelfCost</a><wbr>(<a href="../../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../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-tab4"> |
| <div class="block">Returns the cost of this plan (not including children).</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Correlate.html" title="class in org.apache.calcite.rel.core">Correlate</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)" class="member-name-link">copy</a><wbr>(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <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>> inputs)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a copy of this relational expression, perhaps changing traits and |
| inputs.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="Correlate.html" title="class in org.apache.calcite.rel.core">Correlate</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#copy(org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.core.CorrelationId,org.apache.calcite.util.ImmutableBitSet,org.apache.calcite.rel.core.JoinRelType)" class="member-name-link">copy</a><wbr>(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> left, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> right, |
| <a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a> correlationId, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> requiredColumns, |
| <a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a> joinType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deriveRowType()" class="member-name-link">deriveRowType</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)" class="member-name-link">estimateRowCount</a><wbr>(<a href="../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-tab4"> |
| <div class="block">Returns an estimate of the number of rows this relational expression will |
| return.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#explainTerms(org.apache.calcite.rel.RelWriter)" class="member-name-link">explainTerms</a><wbr>(<a href="../RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a> pw)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Describes the inputs and attributes of this relational expression.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCorrelationId()" class="member-name-link">getCorrelationId</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the correlating expressions.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCorrelVariable()" class="member-name-link">getCorrelVariable</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the name of the variable which is to be implicitly set at runtime |
| each time a row is returned from the first input of this relational |
| expression; or null if there is no variable.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.google.common.collect.ImmutableList<<a href="../hint/RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHints()" class="member-name-link">getHints</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the hints of this relational expressions as an immutable list.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getJoinType()" class="member-name-link">getJoinType</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRequiredColumns()" class="member-name-link">getRequiredColumns</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the required columns in left relation required for the correlation |
| in the right.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVariablesSet()" class="member-name-link">getVariablesSet</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the variables that are set in this relational |
| expression but also used and therefore not available to parents of this |
| relational expression.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)" class="member-name-link">isValid</a><wbr>(<a href="../../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus, |
| @Nullable <a href="../RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a> context)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether this relational expression is valid.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.rel.BiRel">Methods inherited from class org.apache.calcite.rel.<a href="../BiRel.html" title="class in org.apache.calcite.rel">BiRel</a></h3> |
| <code><a href="../BiRel.html#childrenAccept(org.apache.calcite.rel.RelVisitor)">childrenAccept</a>, <a href="../BiRel.html#getInputs()">getInputs</a>, <a href="../BiRel.html#getLeft()">getLeft</a>, <a href="../BiRel.html#getRight()">getRight</a>, <a href="../BiRel.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.rel.AbstractRelNode">Methods inherited from class org.apache.calcite.rel.<a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></h3> |
| <code><a href="../AbstractRelNode.html#accept(org.apache.calcite.rel.RelShuttle)">accept</a>, <a href="../AbstractRelNode.html#accept(org.apache.calcite.rex.RexShuttle)">accept</a>, <a href="../AbstractRelNode.html#collectVariablesSet(java.util.Set)">collectVariablesSet</a>, <a href="../AbstractRelNode.html#collectVariablesUsed(java.util.Set)">collectVariablesUsed</a>, <a href="../AbstractRelNode.html#deepEquals(java.lang.Object)">deepEquals</a>, <a href="../AbstractRelNode.html#deepHashCode()">deepHashCode</a>, <a href="../AbstractRelNode.html#equals(java.lang.Object)">equals</a>, <a href="../AbstractRelNode.html#explain(org.apache.calcite.rel.RelWriter)">explain</a>, <a href="../AbstractRelNode.html#getCluster()">getCluster</a>, <a href="../AbstractRelNode.html#getConvention()">getConvention</a>, <a href="../AbstractRelNode.html#getDescription()">getDescription</a>, <a href="../AbstractRelNode.html#getDigest()">getDigest</a>, <a href="../AbstractRelNode.html#getExpectedInputRowType(int)">getExpectedInputRowType</a>, <a href="../AbstractRelNode.html#getId()">getId</a>, <a href="../AbstractRelNode.html#getInput(int)">getInput</a>, <a href="../AbstractRelNode.html#getRelDigest()">getRelDigest</a>, <a href="../AbstractRelNode.html#getRelTypeName()">getRelTypeName</a>, <a href="../AbstractRelNode.html#getRowType()">getRowType</a>, <a href="../AbstractRelNode.html#getTable()">getTable</a>, <a href="../AbstractRelNode.html#getTraitSet()">getTraitSet</a>, <a href="../AbstractRelNode.html#hashCode()">hashCode</a>, <a href="../AbstractRelNode.html#isEnforcer()">isEnforcer</a>, <a href="../AbstractRelNode.html#metadata(java.lang.Class,org.apache.calcite.rel.metadata.RelMetadataQuery)">metadata</a>, <a href="../AbstractRelNode.html#onRegister(org.apache.calcite.plan.RelOptPlanner)">onRegister</a>, <a href="../AbstractRelNode.html#recomputeDigest()">recomputeDigest</a>, <a href="../AbstractRelNode.html#register(org.apache.calcite.plan.RelOptPlanner)">register</a>, <a href="../AbstractRelNode.html#sole(java.util.List)">sole</a>, <a href="../AbstractRelNode.html#toString()">toString</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.rel.hint.Hintable">Methods inherited from interface org.apache.calcite.rel.hint.<a href="../hint/Hintable.html" title="interface in org.apache.calcite.rel.hint">Hintable</a></h3> |
| <code><a href="../hint/Hintable.html#attachHints(java.util.List)">attachHints</a>, <a href="../hint/Hintable.html#withHints(java.util.List)">withHints</a></code></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#explain()">explain</a>, <a href="../RelNode.html#fieldIsNullable(int)">fieldIsNullable</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="correlationId"> |
| <h3>correlationId</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a></span> <span class="element-name">correlationId</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="requiredColumns"> |
| <h3>requiredColumns</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="element-name">requiredColumns</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="joinType"> |
| <h3>joinType</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a></span> <span class="element-name">joinType</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hints"> |
| <h3>hints</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">com.google.common.collect.ImmutableList<<a href="../hint/RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>></span> <span class="element-name">hints</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelTraitSet,java.util.List,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.core.CorrelationId,org.apache.calcite.util.ImmutableBitSet,org.apache.calcite.rel.core.JoinRelType)"> |
| <h3>Correlate</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">Correlate</span><wbr><span class="parameters">(<a href="../../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a> cluster, |
| <a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <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="../hint/RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>> hints, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> left, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> right, |
| <a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a> correlationId, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> requiredColumns, |
| <a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a> joinType)</span></div> |
| <div class="block">Creates a Correlate.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>cluster</code> - Cluster this relational expression belongs to</dd> |
| <dd><code>left</code> - Left input relational expression</dd> |
| <dd><code>right</code> - Right input relational expression</dd> |
| <dd><code>correlationId</code> - Variable name for the row of left input</dd> |
| <dd><code>requiredColumns</code> - Set of columns that are used by correlation</dd> |
| <dd><code>joinType</code> - Join type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.core.CorrelationId,org.apache.calcite.util.ImmutableBitSet,org.apache.calcite.rel.core.JoinRelType)"> |
| <h3>Correlate</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">protected</span> <span class="element-name">Correlate</span><wbr><span class="parameters">(<a href="../../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a> cluster, |
| <a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> left, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> right, |
| <a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a> correlationId, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> requiredColumns, |
| <a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a> joinType)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.rel.RelInput)"> |
| <h3>Correlate</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">Correlate</span><wbr><span class="parameters">(<a href="../RelInput.html" title="interface in org.apache.calcite.rel">RelInput</a> input)</span></div> |
| <div class="block">Creates a Correlate by parsing serialized output.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>input</code> - Input representation</dd> |
| </dl> |
| </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="isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)"> |
| <h3>isValid</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isValid</span><wbr><span class="parameters">(<a href="../../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus, |
| @Nullable <a href="../RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a> context)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelNode.html#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">RelNode</a></code></span></div> |
| <div class="block">Returns whether this relational expression is valid. |
| |
| <p>If assertions are enabled, this method is typically called with <code> |
| litmus</code> = <code>THROW</code>, as follows: |
| |
| <blockquote> |
| <pre>assert rel.isValid(Litmus.THROW)</pre> |
| </blockquote> |
| |
| <p>This signals that the method can throw an <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AssertionError.html" title="class or interface in java.lang" class="external-link"><code>AssertionError</code></a> if it |
| is not valid.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelNode.html#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">isValid</a></code> in interface <code><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelNode.html#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">isValid</a></code> in class <code><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>litmus</code> - What to do if invalid</dd> |
| <dd><code>context</code> - Context for validity checking</dd> |
| <dt>Returns:</dt> |
| <dd>Whether relational expression is valid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="copy(org.apache.calcite.plan.RelTraitSet,java.util.List)"> |
| <h3>copy</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Correlate.html" title="class in org.apache.calcite.rel.core">Correlate</a></span> <span class="element-name">copy</span><wbr><span class="parameters">(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <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>> inputs)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">RelNode</a></code></span></div> |
| <div class="block">Creates a copy of this relational expression, perhaps changing traits and |
| inputs. |
| |
| <p>Sub-classes with other important attributes are encouraged to create |
| variants of this method with more parameters.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</a></code> in interface <code><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</a></code> in class <code><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>traitSet</code> - Trait set</dd> |
| <dd><code>inputs</code> - Inputs</dd> |
| <dt>Returns:</dt> |
| <dd>Copy of this relational expression, substituting traits and |
| inputs</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="copy(org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.core.CorrelationId,org.apache.calcite.util.ImmutableBitSet,org.apache.calcite.rel.core.JoinRelType)"> |
| <h3>copy</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="Correlate.html" title="class in org.apache.calcite.rel.core">Correlate</a></span> <span class="element-name">copy</span><wbr><span class="parameters">(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> left, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> right, |
| <a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a> correlationId, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> requiredColumns, |
| <a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a> joinType)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJoinType()"> |
| <h3>getJoinType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a></span> <span class="element-name">getJoinType</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deriveRowType()"> |
| <h3>deriveRowType</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">deriveRowType</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelNode.html#deriveRowType()">deriveRowType</a></code> in class <code><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="explainTerms(org.apache.calcite.rel.RelWriter)"> |
| <h3>explainTerms</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a></span> <span class="element-name">explainTerms</span><wbr><span class="parameters">(<a href="../RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a> pw)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../AbstractRelNode.html#explainTerms(org.apache.calcite.rel.RelWriter)">AbstractRelNode</a></code></span></div> |
| <div class="block">Describes the inputs and attributes of this relational expression. |
| Each node should call <code>super.explainTerms</code>, then call the |
| <a href="../RelWriter.html#input(java.lang.String,org.apache.calcite.rel.RelNode)"><code>RelWriter.input(String, RelNode)</code></a> |
| and |
| <a href="../RelWriter.html#item(java.lang.String,java.lang.Object)"><code>RelWriter.item(String, Object)</code></a> |
| methods for each input and attribute.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../BiRel.html#explainTerms(org.apache.calcite.rel.RelWriter)">explainTerms</a></code> in class <code><a href="../BiRel.html" title="class in org.apache.calcite.rel">BiRel</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>pw</code> - Plan writer</dd> |
| <dt>Returns:</dt> |
| <dd>Plan writer for fluent-explain pattern</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCorrelationId()"> |
| <h3>getCorrelationId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a></span> <span class="element-name">getCorrelationId</span>()</div> |
| <div class="block">Returns the correlating expressions.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>correlating expressions</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCorrelVariable()"> |
| <h3>getCorrelVariable</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getCorrelVariable</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelNode.html#getCorrelVariable()">RelNode</a></code></span></div> |
| <div class="block">Returns the name of the variable which is to be implicitly set at runtime |
| each time a row is returned from the first input of this relational |
| expression; or null if there is no variable.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelNode.html#getCorrelVariable()">getCorrelVariable</a></code> in interface <code><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelNode.html#getCorrelVariable()">getCorrelVariable</a></code> in class <code><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Name of correlating variable, or null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequiredColumns()"> |
| <h3>getRequiredColumns</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="element-name">getRequiredColumns</span>()</div> |
| <div class="block">Returns the required columns in left relation required for the correlation |
| in the right.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>columns in left relation required for the correlation in the right</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getVariablesSet()"> |
| <h3>getVariablesSet</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>></span> <span class="element-name">getVariablesSet</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelNode.html#getVariablesSet()">RelNode</a></code></span></div> |
| <div class="block">Returns the variables that are set in this relational |
| expression but also used and therefore not available to parents of this |
| relational expression.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelNode.html#getVariablesSet()">getVariablesSet</a></code> in interface <code><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelNode.html#getVariablesSet()">getVariablesSet</a></code> in class <code><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Names of variables which are set in this relational |
| expression</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)"> |
| <h3>estimateRowCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">estimateRowCount</span><wbr><span class="parameters">(<a href="../metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a> mq)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelNode.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">RelNode</a></code></span></div> |
| <div class="block">Returns an estimate of the number of rows this relational expression will |
| return. |
| |
| <p>NOTE jvs 29-Mar-2006: Don't call this method directly. Instead, use |
| <a href="../metadata/RelMetadataQuery.html#getRowCount(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getRowCount(org.apache.calcite.rel.RelNode)</code></a>, which gives plugins a chance to |
| override the rel's default ideas about row count.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelNode.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">estimateRowCount</a></code> in interface <code><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelNode.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">estimateRowCount</a></code> in class <code><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>mq</code> - Metadata query</dd> |
| <dt>Returns:</dt> |
| <dd>Estimate of the number of rows this relational expression will |
| return</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)"> |
| <h3>computeSelfCost</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../../plan/RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></span> <span class="element-name">computeSelfCost</span><wbr><span class="parameters">(<a href="../../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a> mq)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelNode.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">RelNode</a></code></span></div> |
| <div class="block">Returns the cost of this plan (not including children). The base |
| implementation throws an error; derived classes should override. |
| |
| <p>NOTE jvs 29-Mar-2006: Don't call this method directly. Instead, use |
| <a href="../metadata/RelMetadataQuery.html#getNonCumulativeCost(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getNonCumulativeCost(org.apache.calcite.rel.RelNode)</code></a>, which gives plugins a |
| chance to override the rel's default ideas about cost.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelNode.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">computeSelfCost</a></code> in interface <code><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelNode.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">computeSelfCost</a></code> in class <code><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>planner</code> - Planner for cost calculation</dd> |
| <dd><code>mq</code> - Metadata query</dd> |
| <dt>Returns:</dt> |
| <dd>Cost of this plan (not including children)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHints()"> |
| <h3>getHints</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.google.common.collect.ImmutableList<<a href="../hint/RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>></span> <span class="element-name">getHints</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../hint/Hintable.html#getHints()">Hintable</a></code></span></div> |
| <div class="block">Returns the hints of this relational expressions as an immutable list.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../hint/Hintable.html#getHints()">getHints</a></code> in interface <code><a href="../hint/Hintable.html" title="interface in org.apache.calcite.rel.hint">Hintable</a></code></dd> |
| </dl> |
| </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> |
