| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>org.apache.calcite.tools (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.tools"> |
| <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.tools" class="title">Package org.apache.calcite.tools</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.tools</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Provides utility classes.</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> |
| </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-tab1"><a href="FrameworkConfig.html" title="interface in org.apache.calcite.tools">FrameworkConfig</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Interface that describes how to configure planning sessions generated |
| using the Frameworks tools.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Frameworks.html" title="class in org.apache.calcite.tools">Frameworks</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Tools for invoking Calcite functionality without initializing a container / |
| server first.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Frameworks.BasePrepareAction.html" title="interface in org.apache.calcite.tools">Frameworks.BasePrepareAction</a><R></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Piece of code to be run in a context where a planner and statement are |
| available.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Frameworks.ConfigBuilder.html" title="class in org.apache.calcite.tools">Frameworks.ConfigBuilder</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <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> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Frameworks.PlannerAction.html" title="interface in org.apache.calcite.tools">Frameworks.PlannerAction</a><R></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Piece of code to be run in a context where a planner is available.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Frameworks.PrepareAction.html" title="class in org.apache.calcite.tools">Frameworks.PrepareAction</a><R></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2">Deprecated.</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Hoist.html" title="class in org.apache.calcite.tools">Hoist</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Utility that extracts constants from a SQL query.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Hoist.Config.html" title="interface in org.apache.calcite.tools">Hoist.Config</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Configuration.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Hoist.Hoisted.html" title="class in org.apache.calcite.tools">Hoist.Hoisted</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Result of hoisting.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Hoist.Variable.html" title="class in org.apache.calcite.tools">Hoist.Variable</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Variable.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="PigRelBuilder.html" title="class in org.apache.calcite.tools">PigRelBuilder</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="PigRelBuilder.GroupOption.html" title="enum in org.apache.calcite.tools">PigRelBuilder.GroupOption</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Option for performing group efficiently if data set is already sorted.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Planner.html" title="interface in org.apache.calcite.tools">Planner</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Program that transforms a relational expression into another relational |
| expression.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Programs.html" title="class in org.apache.calcite.tools">Programs</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Utilities for creating <a href="Program.html" title="interface in org.apache.calcite.tools"><code>Program</code></a>s.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RelBuilder.html" title="class in org.apache.calcite.tools">RelBuilder</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Builder for relational expressions.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Information necessary to create a call to an aggregate function.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="RelBuilder.Config.html" title="interface in org.apache.calcite.tools">RelBuilder.Config</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Configuration of RelBuilder.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="RelBuilder.GroupKey.html" title="interface in org.apache.calcite.tools">RelBuilder.GroupKey</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Information necessary to create the GROUP BY clause of an Aggregate.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Call to a windowed aggregate function.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="RelBuilderFactory.html" title="interface in org.apache.calcite.tools">RelBuilderFactory</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">A partially-created RelBuilder.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab5"><a href="RelConversionException.html" title="class in org.apache.calcite.tools">RelConversionException</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab5"> |
| <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> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="RelRunner.html" title="interface in org.apache.calcite.tools">RelRunner</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Runs a relational expression.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RelRunners.html" title="class in org.apache.calcite.tools">RelRunners</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Implementations of <a href="RelRunner.html" title="interface in org.apache.calcite.tools"><code>RelRunner</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RuleSets.html" title="class in org.apache.calcite.tools">RuleSets</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Utilities for creating and composing rule sets.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab5"><a href="ValidationException.html" title="class in org.apache.calcite.tools">ValidationException</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab5"> |
| <div class="block">An Exception thrown when attempting to validate a SQL parse tree.</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> |
