| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>org.apache.calcite.tools (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.tools (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.tools</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block">Provides utility classes.</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="FrameworkConfig.html" title="interface in org.apache.calcite.tools">FrameworkConfig</a></th> |
| <td class="colLast"> |
| <div class="block">Interface that describes how to configure planning sessions generated |
| using the Frameworks tools.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Frameworks.PlannerAction.html" title="interface in org.apache.calcite.tools">Frameworks.PlannerAction</a><R></th> |
| <td class="colLast"> |
| <div class="block">Piece of code to be run in a context where a planner is available.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="PigRelBuilder.Partitioner.html" title="interface in org.apache.calcite.tools">PigRelBuilder.Partitioner</a></th> |
| <td class="colLast"> |
| <div class="block">Partitioner for group and join</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Planner.html" title="interface in org.apache.calcite.tools">Planner</a></th> |
| <td class="colLast"> |
| <div class="block">A façade that covers Calcite's query planning process: parse SQL, |
| validate the parse tree, convert the parse tree to a relational expression, |
| and optimize the relational expression.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></th> |
| <td class="colLast"> |
| <div class="block">Program that transforms a relational expression into another relational |
| expression.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></th> |
| <td class="colLast"> |
| <div class="block">Information necessary to create a call to an aggregate function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelBuilder.GroupKey.html" title="interface in org.apache.calcite.tools">RelBuilder.GroupKey</a></th> |
| <td class="colLast"> |
| <div class="block">Information necessary to create the GROUP BY clause of an Aggregate.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RelBuilderFactory.html" title="interface in org.apache.calcite.tools">RelBuilderFactory</a></th> |
| <td class="colLast"> |
| <div class="block">A partially-created RelBuilder.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelRunner.html" title="interface in org.apache.calcite.tools">RelRunner</a></th> |
| <td class="colLast"> |
| <div class="block">Runs a relational expression.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a></th> |
| <td class="colLast"> |
| <div class="block">A set rules associated with a particular |
| type of invocation of the <a href="Planner.html" title="interface in org.apache.calcite.tools"><code>Planner</code></a>.</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="Frameworks.html" title="class in org.apache.calcite.tools">Frameworks</a></th> |
| <td class="colLast"> |
| <div class="block">Tools for invoking Calcite functionality without initializing a container / |
| server first.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Frameworks.ConfigBuilder.html" title="class in org.apache.calcite.tools">Frameworks.ConfigBuilder</a></th> |
| <td class="colLast"> |
| <div class="block">A builder to help you build a <a href="FrameworkConfig.html" title="interface in org.apache.calcite.tools"><code>FrameworkConfig</code></a> using defaults |
| where values aren't required.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Frameworks.PrepareAction.html" title="class in org.apache.calcite.tools">Frameworks.PrepareAction</a><R></th> |
| <td class="colLast"> |
| <div class="block">Piece of code to be run in a context where a planner and statement are |
| available.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Frameworks.StdFrameworkConfig.html" title="class in org.apache.calcite.tools">Frameworks.StdFrameworkConfig</a></th> |
| <td class="colLast"> |
| <div class="block">An implementation of <a href="FrameworkConfig.html" title="interface in org.apache.calcite.tools"><code>FrameworkConfig</code></a> that uses standard Calcite |
| classes to provide basic planner functionality.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="PigRelBuilder.html" title="class in org.apache.calcite.tools">PigRelBuilder</a></th> |
| <td class="colLast"> |
| <div class="block">Extension to <a href="RelBuilder.html" title="class in org.apache.calcite.tools"><code>RelBuilder</code></a> for Pig relational operators.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Programs.html" title="class in org.apache.calcite.tools">Programs</a></th> |
| <td class="colLast"> |
| <div class="block">Utilities for creating <a href="Program.html" title="interface in org.apache.calcite.tools"><code>Program</code></a>s.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Programs.DecorrelateProgram.html" title="class in org.apache.calcite.tools">Programs.DecorrelateProgram</a></th> |
| <td class="colLast"> |
| <div class="block">Program that de-correlates a query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Programs.RuleSetProgram.html" title="class in org.apache.calcite.tools">Programs.RuleSetProgram</a></th> |
| <td class="colLast"> |
| <div class="block">Program backed by a <a href="RuleSet.html" title="interface in org.apache.calcite.tools"><code>RuleSet</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Programs.SequenceProgram.html" title="class in org.apache.calcite.tools">Programs.SequenceProgram</a></th> |
| <td class="colLast"> |
| <div class="block">Program that runs sub-programs, sending the output of the previous as |
| input to the next.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Programs.TrimFieldsProgram.html" title="class in org.apache.calcite.tools">Programs.TrimFieldsProgram</a></th> |
| <td class="colLast"> |
| <div class="block">Program that trims fields.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelBuilder.html" title="class in org.apache.calcite.tools">RelBuilder</a></th> |
| <td class="colLast"> |
| <div class="block">Builder for relational expressions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RelBuilder.AggCallImpl2.html" title="class in org.apache.calcite.tools">RelBuilder.AggCallImpl2</a></th> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools"><code>RelBuilder.AggCall</code></a> that wraps an |
| <a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core"><code>AggregateCall</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelBuilder.Field.html" title="class in org.apache.calcite.tools">RelBuilder.Field</a></th> |
| <td class="colLast"> |
| <div class="block">A field that belongs to a stack <a href="RelBuilder.Frame.html" title="class in org.apache.calcite.tools"><code>RelBuilder.Frame</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RelBuilder.Frame.html" title="class in org.apache.calcite.tools">RelBuilder.Frame</a></th> |
| <td class="colLast"> |
| <div class="block">Builder stack frame.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelBuilder.GroupKeyImpl.html" title="class in org.apache.calcite.tools">RelBuilder.GroupKeyImpl</a></th> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="RelBuilder.GroupKey.html" title="interface in org.apache.calcite.tools"><code>RelBuilder.GroupKey</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RelBuilder.Registrar.html" title="class in org.apache.calcite.tools">RelBuilder.Registrar</a></th> |
| <td class="colLast"> |
| <div class="block">Collects the extra expressions needed for <a href="RelBuilder.html#aggregate(org.apache.calcite.tools.RelBuilder.GroupKey,org.apache.calcite.tools.RelBuilder.AggCall...)"><code>RelBuilder.aggregate(org.apache.calcite.tools.RelBuilder.GroupKey, org.apache.calcite.tools.RelBuilder.AggCall...)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelRunners.html" title="class in org.apache.calcite.tools">RelRunners</a></th> |
| <td class="colLast"> |
| <div class="block">Implementations of <a href="RelRunner.html" title="interface in org.apache.calcite.tools"><code>RelRunner</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RuleSets.html" title="class in org.apache.calcite.tools">RuleSets</a></th> |
| <td class="colLast"> |
| <div class="block">Utilities for creating and composing rule sets.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RuleSets.ListRuleSet.html" title="class in org.apache.calcite.tools">RuleSets.ListRuleSet</a></th> |
| <td class="colLast"> |
| <div class="block">Rule set that consists of a list of rules.</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="PigRelBuilder.GroupOption.html" title="enum in org.apache.calcite.tools">PigRelBuilder.GroupOption</a></th> |
| <td class="colLast"> |
| <div class="block">Option for performing group efficiently if data set is already sorted</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="RelConversionException.html" title="class in org.apache.calcite.tools">RelConversionException</a></th> |
| <td class="colLast"> |
| <div class="block">An Exception thrown when attempting conversion to a set of |
| <a href="../rel/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="ValidationException.html" title="class in org.apache.calcite.tools">ValidationException</a></th> |
| <td class="colLast"> |
| <div class="block">An Exception thrown when attempting to validate a SQL parse tree.</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> |
