Google Git
Sign in
apache / calcite-site / refs/heads/1.24 / . / javadocAggregate / org / apache / calcite / tools / package-summary.html
blob: dd46482c47176506c0db05212eade3d1a3f31c36 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.calcite.tools (Apache Calcite calcite API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.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 calcite API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/calcite/statistic/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/calcite/util/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/tools/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.calcite.tools</h1>
<div class="docSummary">
<div class="block">Provides utility classes.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/FrameworkConfig.html" title="interface in org.apache.calcite.tools">FrameworkConfig</a></td>
<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">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/Frameworks.BasePrepareAction.html" title="interface in org.apache.calcite.tools">Frameworks.BasePrepareAction</a>&lt;R&gt;</td>
<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="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/Frameworks.PlannerAction.html" title="interface in org.apache.calcite.tools">Frameworks.PlannerAction</a>&lt;R&gt;</td>
<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="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/Hoist.Config.html" title="interface in org.apache.calcite.tools">Hoist.Config</a></td>
<td class="colLast">
<div class="block">Configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></td>
<td class="colLast">
<div class="block">A fa&ccedil;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="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a></td>
<td class="colLast">
<div class="block">Program that transforms a relational expression into another relational
expression.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></td>
<td class="colLast">
<div class="block">Information necessary to create a call to an aggregate function.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/RelBuilder.Config.html" title="interface in org.apache.calcite.tools">RelBuilder.Config</a></td>
<td class="colLast">
<div class="block">Configuration of RelBuilder.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/RelBuilder.GroupKey.html" title="interface in org.apache.calcite.tools">RelBuilder.GroupKey</a></td>
<td class="colLast">
<div class="block">Information necessary to create the GROUP BY clause of an Aggregate.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/RelBuilderFactory.html" title="interface in org.apache.calcite.tools">RelBuilderFactory</a></td>
<td class="colLast">
<div class="block">A partially-created RelBuilder.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/RelRunner.html" title="interface in org.apache.calcite.tools">RelRunner</a></td>
<td class="colLast">
<div class="block">Runs a relational expression.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a></td>
<td class="colLast">
<div class="block">A set rules associated with a particular
type of invocation of the <a href="../../../../org/apache/calcite/tools/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" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/Frameworks.html" title="class in org.apache.calcite.tools">Frameworks</a></td>
<td class="colLast">
<div class="block">Tools for invoking Calcite functionality without initializing a container /
server first.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/Frameworks.ConfigBuilder.html" title="class in org.apache.calcite.tools">Frameworks.ConfigBuilder</a></td>
<td class="colLast">
<div class="block">A builder to help you build a <a href="../../../../org/apache/calcite/tools/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">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/Frameworks.PrepareAction.html" title="class in org.apache.calcite.tools">Frameworks.PrepareAction</a>&lt;R&gt;</td>
<td class="colLast">Deprecated</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/Hoist.html" title="class in org.apache.calcite.tools">Hoist</a></td>
<td class="colLast">
<div class="block">Utility that extracts constants from a SQL query.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/Hoist.Hoisted.html" title="class in org.apache.calcite.tools">Hoist.Hoisted</a></td>
<td class="colLast">
<div class="block">Result of hoisting.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/Hoist.Variable.html" title="class in org.apache.calcite.tools">Hoist.Variable</a></td>
<td class="colLast">
<div class="block">Variable.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/PigRelBuilder.html" title="class in org.apache.calcite.tools">PigRelBuilder</a></td>
<td class="colLast">
<div class="block">Extension to <a href="../../../../org/apache/calcite/tools/RelBuilder.html" title="class in org.apache.calcite.tools"><code>RelBuilder</code></a> for Pig relational operators.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/Programs.html" title="class in org.apache.calcite.tools">Programs</a></td>
<td class="colLast">
<div class="block">Utilities for creating <a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools"><code>Program</code></a>s.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/RelBuilder.html" title="class in org.apache.calcite.tools">RelBuilder</a></td>
<td class="colLast">
<div class="block">Builder for relational expressions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/RelBuilder.ConfigBuilder.html" title="class in org.apache.calcite.tools">RelBuilder.ConfigBuilder</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">Use the <code>withXxx</code> methods in
<a href="../../../../org/apache/calcite/tools/RelBuilder.Config.html" title="interface in org.apache.calcite.tools"><code>RelBuilder.Config</code></a>.</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/RelBuilder.GroupKeyImpl.html" title="class in org.apache.calcite.tools">RelBuilder.GroupKeyImpl</a></td>
<td class="colLast">
<div class="block">Implementation of <a href="../../../../org/apache/calcite/tools/RelBuilder.GroupKey.html" title="interface in org.apache.calcite.tools"><code>RelBuilder.GroupKey</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/RelRunners.html" title="class in org.apache.calcite.tools">RelRunners</a></td>
<td class="colLast">
<div class="block">Implementations of <a href="../../../../org/apache/calcite/tools/RelRunner.html" title="interface in org.apache.calcite.tools"><code>RelRunner</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/RuleSets.html" title="class in org.apache.calcite.tools">RuleSets</a></td>
<td class="colLast">
<div class="block">Utilities for creating and composing rule sets.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/PigRelBuilder.GroupOption.html" title="enum in org.apache.calcite.tools">PigRelBuilder.GroupOption</a></td>
<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" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/RelConversionException.html" title="class in org.apache.calcite.tools">RelConversionException</a></td>
<td class="colLast">
<div class="block">An Exception thrown when attempting conversion to a set of
<a href="../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/tools/ValidationException.html" title="class in org.apache.calcite.tools">ValidationException</a></td>
<td class="colLast">
<div class="block">An Exception thrown when attempting to validate a SQL parse tree.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.calcite.tools Description">Package org.apache.calcite.tools Description</h2>
<div class="block">Provides utility classes.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/calcite/statistic/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/calcite/util/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/tools/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>