blob: 9515649836ee7779eb8c6982fe18f6d9ef0c06f8 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.calcite.prepare (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.prepare (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&nbsp;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">&nbsp;</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&nbsp;org.apache.calcite.prepare</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">Preparation of queries (parsing, planning and implementation).</div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<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">
<th class="colFirst" scope="row"><a href="CalcitePrepareImpl.ScalarTranslator.html" title="interface in org.apache.calcite.prepare">CalcitePrepareImpl.ScalarTranslator</a></th>
<td class="colLast">
<div class="block">Translator from Java AST to <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Prepare.CatalogReader.html" title="interface in org.apache.calcite.prepare">Prepare.CatalogReader</a></th>
<td class="colLast">
<div class="block">Interface by which validator and planner can read table metadata.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Prepare.PreparedResult.html" title="interface in org.apache.calcite.prepare">Prepare.PreparedResult</a></th>
<td class="colLast">
<div class="block">Result of a call to <a href="Prepare.html#prepareSql(org.apache.calcite.sql.SqlNode,java.lang.Class,org.apache.calcite.sql.validate.SqlValidator,boolean)"><code>Prepare.prepareSql(org.apache.calcite.sql.SqlNode, java.lang.Class, org.apache.calcite.sql.validate.SqlValidator, boolean)</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Prepare.PreparingTable.html" title="interface in org.apache.calcite.prepare">Prepare.PreparingTable</a></th>
<td class="colLast">
<div class="block">Definition of a table, for the purposes of the validator and planner.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<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">
<th class="colFirst" scope="row"><a href="CalciteCatalogReader.html" title="class in org.apache.calcite.prepare">CalciteCatalogReader</a></th>
<td class="colLast">
<div class="block">Implementation of <a href="Prepare.CatalogReader.html" title="interface in org.apache.calcite.prepare"><code>Prepare.CatalogReader</code></a>
and also <a href="../sql/SqlOperatorTable.html" title="interface in org.apache.calcite.sql"><code>SqlOperatorTable</code></a> based on tables and
functions defined schemas.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CalciteMaterializer.html" title="class in org.apache.calcite.prepare">CalciteMaterializer</a></th>
<td class="colLast">
<div class="block">Context for populating a <a href="Prepare.Materialization.html" title="class in org.apache.calcite.prepare"><code>Prepare.Materialization</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CalciteMaterializer.Callback.html" title="class in org.apache.calcite.prepare">CalciteMaterializer.Callback</a></th>
<td class="colLast">
<div class="block">Called when we discover a star table that matches.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CalciteMaterializer.RelNullShuttle.html" title="class in org.apache.calcite.prepare">CalciteMaterializer.RelNullShuttle</a></th>
<td class="colLast">
<div class="block">Implementation of <a href="../rel/RelShuttle.html" title="interface in org.apache.calcite.rel"><code>RelShuttle</code></a> that returns each relational
expression unchanged.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CalcitePrepareImpl.html" title="class in org.apache.calcite.prepare">CalcitePrepareImpl</a></th>
<td class="colLast">
<div class="block">Shit just got real.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CalcitePrepareImpl.CalcitePreparedExplain.html" title="class in org.apache.calcite.prepare">CalcitePrepareImpl.CalcitePreparedExplain</a></th>
<td class="colLast">
<div class="block">An <code>EXPLAIN</code> statement, prepared and ready to execute.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CalcitePrepareImpl.CalcitePreparingStmt.html" title="class in org.apache.calcite.prepare">CalcitePrepareImpl.CalcitePreparingStmt</a></th>
<td class="colLast">
<div class="block">Holds state for the process of preparing a SQL statement.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CalcitePrepareImpl.EmptyScalarTranslator.html" title="class in org.apache.calcite.prepare">CalcitePrepareImpl.EmptyScalarTranslator</a></th>
<td class="colLast">
<div class="block">Basic translator.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CalcitePrepareImpl.LambdaScalarTranslator.html" title="class in org.apache.calcite.prepare">CalcitePrepareImpl.LambdaScalarTranslator</a></th>
<td class="colLast">
<div class="block">Translator that looks for parameters.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CalciteSqlValidator.html" title="class in org.apache.calcite.prepare">CalciteSqlValidator</a></th>
<td class="colLast">
<div class="block">Validator.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LixToRelTranslator.html" title="class in org.apache.calcite.prepare">LixToRelTranslator</a></th>
<td class="colLast">
<div class="block">Translates a tree of linq4j <a href="../linq4j/Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a> nodes to a tree of
<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> planner nodes.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PlannerImpl.html" title="class in org.apache.calcite.prepare">PlannerImpl</a></th>
<td class="colLast">
<div class="block">Implementation of <a href="../tools/Planner.html" title="interface in org.apache.calcite.tools"><code>Planner</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Prepare.html" title="class in org.apache.calcite.prepare">Prepare</a></th>
<td class="colLast">
<div class="block">Abstract base for classes that implement
the process of preparing and executing SQL expressions.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Prepare.AbstractPreparingTable.html" title="class in org.apache.calcite.prepare">Prepare.AbstractPreparingTable</a></th>
<td class="colLast">
<div class="block">Abstract implementation of <a href="Prepare.PreparingTable.html" title="interface in org.apache.calcite.prepare"><code>Prepare.PreparingTable</code></a> with an implementation
for <a href="Prepare.AbstractPreparingTable.html#columnHasDefaultValue(org.apache.calcite.rel.type.RelDataType,int,org.apache.calcite.sql2rel.InitializerContext)"><code>Prepare.AbstractPreparingTable.columnHasDefaultValue(org.apache.calcite.rel.type.RelDataType, int, org.apache.calcite.sql2rel.InitializerContext)</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Prepare.Materialization.html" title="class in org.apache.calcite.prepare">Prepare.Materialization</a></th>
<td class="colLast">
<div class="block">Describes that a given SQL query is materialized by a given table.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Prepare.PreparedExplain.html" title="class in org.apache.calcite.prepare">Prepare.PreparedExplain</a></th>
<td class="colLast">
<div class="block">PreparedExplanation is a PreparedResult for an EXPLAIN PLAN statement.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Prepare.PreparedResultImpl.html" title="class in org.apache.calcite.prepare">Prepare.PreparedResultImpl</a></th>
<td class="colLast">
<div class="block">Abstract implementation of <a href="Prepare.PreparedResult.html" title="interface in org.apache.calcite.prepare"><code>Prepare.PreparedResult</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="QueryableRelBuilder.html" title="class in org.apache.calcite.prepare">QueryableRelBuilder</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">Implementation of <a href="../linq4j/QueryableFactory.html" title="interface in org.apache.calcite.linq4j"><code>QueryableFactory</code></a>
that builds a tree of <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> planner nodes.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RelOptTableImpl.html" title="class in org.apache.calcite.prepare">RelOptTableImpl</a></th>
<td class="colLast">
<div class="block">Implementation of <a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan"><code>RelOptTable</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RelOptTableImpl.MySchemaPlus.html" title="class in org.apache.calcite.prepare">RelOptTableImpl.MySchemaPlus</a></th>
<td class="colLast">
<div class="block">Implementation of <a href="../schema/SchemaPlus.html" title="interface in org.apache.calcite.schema"><code>SchemaPlus</code></a> that wraps a regular schema and knows
its name and parent.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<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">
<th class="colFirst" scope="row"><a href="PlannerImpl.State.html" title="enum in org.apache.calcite.prepare">PlannerImpl.State</a></th>
<td class="colLast">
<div class="block">Stage of a statement in the query-preparation lifecycle.</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&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>
<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 &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>