| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>org.apache.calcite.rel (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"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <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="package-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 class="nav-bar-cell1-rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html#package">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</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"> |
| <div class="header"> |
| <h1 title="Package org.apache.calcite.rel" class="title">Package org.apache.calcite.rel</h1> |
| </div> |
| <hr> |
| <div class="package-signature"><span class="annotations">@DefaultQualifier(value=org.checkerframework.checker.nullness.qual.NonNull.class,locations=FIELD) @DefaultQualifier(value=org.checkerframework.checker.nullness.qual.NonNull.class,locations=PARAMETER) @DefaultQualifier(value=org.checkerframework.checker.nullness.qual.NonNull.class,locations=RETURN) |
| </span>package <span class="element-name">org.apache.calcite.rel</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Defines relational expressions. |
| |
| <h2>Related packages and classes</h2> |
| <ul> |
| |
| <li>Package <code> |
| <a href="../sql/package-summary.html">org.apache.calcite.sql</a></code> |
| is an object model for SQL expressions |
| |
| <li>Package <code> |
| <a href="../sql/package-summary.html">org.apache.calcite.rex</a></code> |
| is an object model for relational row expressions |
| |
| <li>Package <code> |
| <a href="../plan/package-summary.html">org.apache.calcite.plan</a></code> |
| provides an optimizer interface. |
| |
| </ul></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="../package-summary.html">org.apache.calcite</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Main package for Calcite, the dynamic data management platform.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="convert/package-summary.html">org.apache.calcite.rel.convert</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Defines relational expressions and rules for converting between calling |
| conventions.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="core/package-summary.html">org.apache.calcite.rel.core</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Defines core relational expressions.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="externalize/package-summary.html">org.apache.calcite.rel.externalize</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Facilities to externalize <a href="RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a>s to and from |
| XML and JSON format.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="hint/package-summary.html">org.apache.calcite.rel.hint</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Defines hints interfaces and utilities for relational expressions.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="logical/package-summary.html">org.apache.calcite.rel.logical</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Defines logical relational expressions.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="metadata/package-summary.html">org.apache.calcite.rel.metadata</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Defines metadata interfaces and utilities for relational |
| expressions.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="mutable/package-summary.html">org.apache.calcite.rel.mutable</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Defines mutable relational expressions.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="rel2sql/package-summary.html">org.apache.calcite.rel.rel2sql</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Translates a relational expression to SQL parse tree.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="rules/package-summary.html">org.apache.calcite.rel.rules</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Provides a core set of planner rules.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="stream/package-summary.html">org.apache.calcite.rel.stream</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Defines relational expressions for streaming.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="type/package-summary.html">org.apache.calcite.rel.type</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Defines a type system for relational expressions.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enums</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exceptions</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Base class for every relational expression (<a href="RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a>).</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BiRel.html" title="class in org.apache.calcite.rel">BiRel</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Abstract base class for relational expressions with a two inputs.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab5"><a href="InvalidRelException.html" title="class in org.apache.calcite.rel">InvalidRelException</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab5"> |
| <div class="block">Exception that indicates that a relational expression would be invalid |
| with given parameters.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="PhysicalNode.html" title="interface in org.apache.calcite.rel">PhysicalNode</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Physical node in a planner that is capable of doing |
| physical trait propagation and derivation.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Description of the physical ordering of a relational expression.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RelCollationImpl.html" title="class in org.apache.calcite.rel">RelCollationImpl</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Simple implementation of <a href="RelCollation.html" title="interface in org.apache.calcite.rel"><code>RelCollation</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="RelCollations.html" title="class in org.apache.calcite.rel">RelCollations</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Utilities concerning <a href="RelCollation.html" title="interface in org.apache.calcite.rel"><code>RelCollation</code></a> |
| and <a href="RelFieldCollation.html" title="class in org.apache.calcite.rel"><code>RelFieldCollation</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RelCollationTraitDef.html" title="class in org.apache.calcite.rel">RelCollationTraitDef</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Definition of the ordering trait.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Description of the physical distribution of a relational expression.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="RelDistribution.Type.html" title="enum in org.apache.calcite.rel">RelDistribution.Type</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Type of distribution.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="RelDistributions.html" title="class in org.apache.calcite.rel">RelDistributions</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Utilities concerning <a href="RelDistribution.html" title="interface in org.apache.calcite.rel"><code>RelDistribution</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RelDistributionTraitDef.html" title="class in org.apache.calcite.rel">RelDistributionTraitDef</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Definition of the distribution trait.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Definition of the ordering of one field of a <a href="RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> whose |
| output is to be sorted.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="RelFieldCollation.Direction.html" title="enum in org.apache.calcite.rel">RelFieldCollation.Direction</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Direction that a field is ordered in.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab3"><a href="RelFieldCollation.NullDirection.html" title="enum in org.apache.calcite.rel">RelFieldCollation.NullDirection</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab3"> |
| <div class="block">Ordering of nulls.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RelHomogeneousShuttle.html" title="class in org.apache.calcite.rel">RelHomogeneousShuttle</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Visits all the relations in a homogeneous way: always redirects calls to |
| <code>accept(RelNode)</code>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="RelInput.html" title="interface in org.apache.calcite.rel">RelInput</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Context from which a relational expression can initialize itself, |
| reading from a serialized form of the relational expression.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">A <code>RelNode</code> is a relational expression.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Context of a relational expression, for purposes of checking validity.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RelNodes.html" title="class in org.apache.calcite.rel">RelNodes</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Utilities concerning relational expressions.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="RelReferentialConstraint.html" title="interface in org.apache.calcite.rel">RelReferentialConstraint</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Interface for a referential constraint, i.e., Foreign-Key - Unique-Key relationship, |
| between two tables.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RelReferentialConstraintImpl.html" title="class in org.apache.calcite.rel">RelReferentialConstraintImpl</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">RelOptReferentialConstraint base implementation.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="RelRoot.html" title="class in org.apache.calcite.rel">RelRoot</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Root of a tree of <a href="RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="RelShuttle.html" title="interface in org.apache.calcite.rel">RelShuttle</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Visitor that has methods for the common logical relational expressions.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="RelShuttleImpl.html" title="class in org.apache.calcite.rel">RelShuttleImpl</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Basic implementation of <a href="RelShuttle.html" title="interface in org.apache.calcite.rel"><code>RelShuttle</code></a> that calls |
| <a href="RelNode.html#accept(org.apache.calcite.rel.RelShuttle)"><code>RelNode.accept(RelShuttle)</code></a> on each child, and |
| <a href="RelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)"><code>RelNode.copy(org.apache.calcite.plan.RelTraitSet, java.util.List)</code></a> if |
| any children change.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RelValidityChecker.html" title="class in org.apache.calcite.rel">RelValidityChecker</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Visitor that checks that every <a href="RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> in a tree is valid.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="RelVisitor.html" title="class in org.apache.calcite.rel">RelVisitor</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A <code>RelVisitor</code> is a Visitor role in the |
| <a href="../util/Glossary.html#VISITOR_PATTERN"><code>visitor pattern</code></a> and |
| visits <a href="RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> objects as the role of Element.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Callback for an expression to dump itself to.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="SingleRel.html" title="class in org.apache.calcite.rel">SingleRel</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Abstract base class for relational expressions with a single input.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </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> |
