blob: 3ed4eb82d6ddb089810a862cbae129364cdbca45 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.calcite.schema (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.schema (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.schema</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">Schema SPI.
<p>The interfaces in this package define the objects used by the
SQL validator to validate SQL abstract syntax trees and resolve
identifiers to objects.</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="AggregateFunction.html" title="interface in org.apache.calcite.schema">AggregateFunction</a></th>
<td class="colLast">
<div class="block">Function that combines several values into a scalar result.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CustomColumnResolvingTable.html" title="interface in org.apache.calcite.schema">CustomColumnResolvingTable</a></th>
<td class="colLast">
<div class="block">Extension to <a href="Table.html" title="interface in org.apache.calcite.schema"><code>Table</code></a> that specifies a custom way to resolve column
names.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ExtensibleTable.html" title="interface in org.apache.calcite.schema">ExtensibleTable</a></th>
<td class="colLast">
<div class="block">Table whose row type can be extended to include extra fields.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="FilterableTable.html" title="interface in org.apache.calcite.schema">FilterableTable</a></th>
<td class="colLast">
<div class="block">Table that can be scanned, optionally applying supplied filter expressions,
without creating an intermediate relational expression.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Function.html" title="interface in org.apache.calcite.schema">Function</a></th>
<td class="colLast">
<div class="block">Named expression that accepts parameters and returns a result.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="FunctionParameter.html" title="interface in org.apache.calcite.schema">FunctionParameter</a></th>
<td class="colLast">
<div class="block">Parameter to a <a href="Function.html" title="interface in org.apache.calcite.schema"><code>Function</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ImplementableAggFunction.html" title="interface in org.apache.calcite.schema">ImplementableAggFunction</a></th>
<td class="colLast">
<div class="block">Function that can be translated to java code.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ImplementableFunction.html" title="interface in org.apache.calcite.schema">ImplementableFunction</a></th>
<td class="colLast">
<div class="block">Function that can be translated to java code.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Member.html" title="interface in org.apache.calcite.schema">Member</a></th>
<td class="colLast">
<div class="block">A named expression in a schema.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ModifiableTable.html" title="interface in org.apache.calcite.schema">ModifiableTable</a></th>
<td class="colLast">
<div class="block">A table that can be modified.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ModifiableView.html" title="interface in org.apache.calcite.schema">ModifiableView</a></th>
<td class="colLast">
<div class="block">A modifiable view onto <a href="ModifiableTable.html" title="interface in org.apache.calcite.schema"><code>ModifiableTable</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Path.html" title="interface in org.apache.calcite.schema">Path</a></th>
<td class="colLast">
<div class="block">Path from a root schema to a particular object (schema, table, function).</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ProjectableFilterableTable.html" title="interface in org.apache.calcite.schema">ProjectableFilterableTable</a></th>
<td class="colLast">
<div class="block">Table that can be scanned, optionally applying supplied filter expressions,
and projecting a given list of columns,
without creating an intermediate relational expression.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="QueryableTable.html" title="interface in org.apache.calcite.schema">QueryableTable</a></th>
<td class="colLast">
<div class="block">Extension to <a href="Table.html" title="interface in org.apache.calcite.schema"><code>Table</code></a> that can translate itself to a <a href="../linq4j/Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></th>
<td class="colLast">
<div class="block">Function that returns a scalar result.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ScannableTable.html" title="interface in org.apache.calcite.schema">ScannableTable</a></th>
<td class="colLast">
<div class="block">Table that can be scanned without creating an intermediate relational
expression.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Schema.html" title="interface in org.apache.calcite.schema">Schema</a></th>
<td class="colLast">
<div class="block">A namespace for tables and functions.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SchemaFactory.html" title="interface in org.apache.calcite.schema">SchemaFactory</a></th>
<td class="colLast">
<div class="block">Factory for <a href="Schema.html" title="interface in org.apache.calcite.schema"><code>Schema</code></a> objects.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a></th>
<td class="colLast">
<div class="block">Extension to the <a href="Schema.html" title="interface in org.apache.calcite.schema"><code>Schema</code></a> interface.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SchemaVersion.html" title="interface in org.apache.calcite.schema">SchemaVersion</a></th>
<td class="colLast">
<div class="block">An interface to represent a version ID that can be used to create a
read-consistent view of a Schema.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SemiMutableSchema.html" title="interface in org.apache.calcite.schema">SemiMutableSchema</a></th>
<td class="colLast">
<div class="block">Schema to which materializations can be added.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Statistic.html" title="interface in org.apache.calcite.schema">Statistic</a></th>
<td class="colLast">
<div class="block">Statistics about a <a href="Table.html" title="interface in org.apache.calcite.schema"><code>Table</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="StreamableTable.html" title="interface in org.apache.calcite.schema">StreamableTable</a></th>
<td class="colLast">
<div class="block">Table that can be converted to a stream.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Table.html" title="interface in org.apache.calcite.schema">Table</a></th>
<td class="colLast">
<div class="block">Table.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="TableFactory.html" title="interface in org.apache.calcite.schema">TableFactory</a>&lt;T extends <a href="Table.html" title="interface in org.apache.calcite.schema">Table</a>&gt;</th>
<td class="colLast">
<div class="block">Factory for <a href="Table.html" title="interface in org.apache.calcite.schema"><code>Table</code></a> objects.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TableFunction.html" title="interface in org.apache.calcite.schema">TableFunction</a></th>
<td class="colLast">
<div class="block">Function that returns a table during execution time.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="TableMacro.html" title="interface in org.apache.calcite.schema">TableMacro</a></th>
<td class="colLast">
<div class="block">Function that returns a <a href="Table.html" title="interface in org.apache.calcite.schema"><code>Table</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TemporalTable.html" title="interface in org.apache.calcite.schema">TemporalTable</a></th>
<td class="colLast">
<div class="block">Table that is temporal.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="TransientTable.html" title="interface in org.apache.calcite.schema">TransientTable</a></th>
<td class="colLast">
<div class="block">A transient table is a named table that may come into existence implicitly during the
evaluation of a query expression or the execution of a trigger.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TranslatableTable.html" title="interface in org.apache.calcite.schema">TranslatableTable</a></th>
<td class="colLast">
<div class="block">Extension to <a href="Table.html" title="interface in org.apache.calcite.schema"><code>Table</code></a> that specifies how it is to be translated to
a <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>relational expression</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Wrapper.html" title="interface in org.apache.calcite.schema">Wrapper</a></th>
<td class="colLast">
<div class="block">Mix-in interface that allows you to find sub-objects.</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="Schemas.html" title="class in org.apache.calcite.schema">Schemas</a></th>
<td class="colLast">
<div class="block">Utility functions for schemas.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Schemas.DummyDataContext.html" title="class in org.apache.calcite.schema">Schemas.DummyDataContext</a></th>
<td class="colLast">
<div class="block">Dummy data context that has no variables.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Schemas.PathImpl.html" title="class in org.apache.calcite.schema">Schemas.PathImpl</a></th>
<td class="colLast">
<div class="block">Implementation of <a href="Path.html" title="interface in org.apache.calcite.schema"><code>Path</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Statistics.html" title="class in org.apache.calcite.schema">Statistics</a></th>
<td class="colLast">
<div class="block">Utility functions regarding <a href="Statistic.html" title="interface in org.apache.calcite.schema"><code>Statistic</code></a>.</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="ColumnStrategy.html" title="enum in org.apache.calcite.schema">ColumnStrategy</a></th>
<td class="colLast">
<div class="block">Describes how a column gets populated.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Schema.TableType.html" title="enum in org.apache.calcite.schema">Schema.TableType</a></th>
<td class="colLast">
<div class="block">Table type.</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>