| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>org.apache.calcite.rel (Apache Calcite API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.calcite.rel (Apache Calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.calcite.rel</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <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> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></th> |
| <td class="colLast"> |
| <div class="block">Description of the physical ordering of a relational expression.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a></th> |
| <td class="colLast"> |
| <div class="block">Description of the physical distribution of a relational expression.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelInput.html" title="interface in org.apache.calcite.rel">RelInput</a></th> |
| <td class="colLast"> |
| <div class="block">Context from which a relational expression can initialize itself, |
| reading from a serialized form of the relational expression.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></th> |
| <td class="colLast"> |
| <div class="block">A <code>RelNode</code> is a relational expression.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a></th> |
| <td class="colLast"> |
| <div class="block">Context of a relational expression, for purposes of checking validity.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RelReferentialConstraint.html" title="interface in org.apache.calcite.rel">RelReferentialConstraint</a></th> |
| <td class="colLast"> |
| <div class="block">Interface for a referential constraint, i.e., Foreign-Key - Unique-Key relationship, |
| between two tables.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelShuttle.html" title="interface in org.apache.calcite.rel">RelShuttle</a></th> |
| <td class="colLast"> |
| <div class="block">Visitor that has methods for the common logical relational expressions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a></th> |
| <td class="colLast"> |
| <div class="block">Callback for an expression to dump itself to.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractRelNode.RelDigestWriter.html" title="class in org.apache.calcite.rel">AbstractRelNode.RelDigestWriter</a></th> |
| <td class="colLast"> |
| <div class="block">A writer object used exclusively for computing the digest of a RelNode.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="BiRel.html" title="class in org.apache.calcite.rel">BiRel</a></th> |
| <td class="colLast"> |
| <div class="block">Abstract base class for relational expressions with a two inputs.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RelCollationImpl.html" title="class in org.apache.calcite.rel">RelCollationImpl</a></th> |
| <td class="colLast"> |
| <div class="block">Simple implementation of <a href="RelCollation.html" title="interface in org.apache.calcite.rel"><code>RelCollation</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelCollations.html" title="class in org.apache.calcite.rel">RelCollations</a></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RelCollationTraitDef.html" title="class in org.apache.calcite.rel">RelCollationTraitDef</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the ordering trait.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelDistributions.html" title="class in org.apache.calcite.rel">RelDistributions</a></th> |
| <td class="colLast"> |
| <div class="block">Utilities concerning <a href="RelDistribution.html" title="interface in org.apache.calcite.rel"><code>RelDistribution</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RelDistributions.RelDistributionImpl.html" title="class in org.apache.calcite.rel">RelDistributions.RelDistributionImpl</a></th> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="RelDistribution.html" title="interface in org.apache.calcite.rel"><code>RelDistribution</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelDistributionTraitDef.html" title="class in org.apache.calcite.rel">RelDistributionTraitDef</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the distribution trait.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelHomogeneousShuttle.html" title="class in org.apache.calcite.rel">RelHomogeneousShuttle</a></th> |
| <td class="colLast"> |
| <div class="block">Visits all the relations in a homogeneous way: always redirects calls to |
| <code>accept(RelNode)</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RelNodes.html" title="class in org.apache.calcite.rel">RelNodes</a></th> |
| <td class="colLast"> |
| <div class="block">Utilities concerning relational expressions.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelNodes.RelNodeComparator.html" title="class in org.apache.calcite.rel">RelNodes.RelNodeComparator</a></th> |
| <td class="colLast"> |
| <div class="block">Arbitrary stable comparator for <a href="RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a>s.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RelReferentialConstraintImpl.html" title="class in org.apache.calcite.rel">RelReferentialConstraintImpl</a></th> |
| <td class="colLast"> |
| <div class="block">RelOptReferentialConstraint base implementation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelRoot.html" title="class in org.apache.calcite.rel">RelRoot</a></th> |
| <td class="colLast"> |
| <div class="block">Root of a tree of <a href="RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RelShuttleImpl.html" title="class in org.apache.calcite.rel">RelShuttleImpl</a></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelVisitor.html" title="class in org.apache.calcite.rel">RelVisitor</a></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SingleRel.html" title="class in org.apache.calcite.rel">SingleRel</a></th> |
| <td class="colLast"> |
| <div class="block">Abstract base class for relational expressions with a single input.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelDistribution.Type.html" title="enum in org.apache.calcite.rel">RelDistribution.Type</a></th> |
| <td class="colLast"> |
| <div class="block">Type of distribution.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RelFieldCollation.Direction.html" title="enum in org.apache.calcite.rel">RelFieldCollation.Direction</a></th> |
| <td class="colLast"> |
| <div class="block">Direction that a field is ordered in.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelFieldCollation.NullDirection.html" title="enum in org.apache.calcite.rel">RelFieldCollation.NullDirection</a></th> |
| <td class="colLast"> |
| <div class="block">Ordering of nulls.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="InvalidRelException.html" title="class in org.apache.calcite.rel">InvalidRelException</a></th> |
| <td class="colLast"> |
| <div class="block">Exception that indicates that a relational expression would be invalid |
| with given parameters.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
