blob: 937c06840eb8e1e41ef7521be12459002cb39def [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.schema (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.schema (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/runtime/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/calcite/schema/impl/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/schema/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.schema</h1>
<div class="docSummary">
<div class="block">Schema SPI.</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/schema/AggregateFunction.html" title="interface in org.apache.calcite.schema">AggregateFunction</a></td>
<td class="colLast">
<div class="block">Function that combines several values into a scalar result.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/CustomColumnResolvingTable.html" title="interface in org.apache.calcite.schema">CustomColumnResolvingTable</a></td>
<td class="colLast">
<div class="block">Extension to <a href="../../../../org/apache/calcite/schema/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">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/ExtensibleTable.html" title="interface in org.apache.calcite.schema">ExtensibleTable</a></td>
<td class="colLast">
<div class="block">Table whose row type can be extended to include extra fields.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/FilterableTable.html" title="interface in org.apache.calcite.schema">FilterableTable</a></td>
<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">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/Function.html" title="interface in org.apache.calcite.schema">Function</a></td>
<td class="colLast">
<div class="block">Named expression that accepts parameters and returns a result.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/FunctionParameter.html" title="interface in org.apache.calcite.schema">FunctionParameter</a></td>
<td class="colLast">
<div class="block">Parameter to a <a href="../../../../org/apache/calcite/schema/Function.html" title="interface in org.apache.calcite.schema"><code>Function</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/ImplementableAggFunction.html" title="interface in org.apache.calcite.schema">ImplementableAggFunction</a></td>
<td class="colLast">
<div class="block">Function that can be translated to java code.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/ImplementableFunction.html" title="interface in org.apache.calcite.schema">ImplementableFunction</a></td>
<td class="colLast">
<div class="block">Function that can be translated to java code.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/Member.html" title="interface in org.apache.calcite.schema">Member</a></td>
<td class="colLast">
<div class="block">A named expression in a schema.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/ModifiableTable.html" title="interface in org.apache.calcite.schema">ModifiableTable</a></td>
<td class="colLast">
<div class="block">A table that can be modified.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/ModifiableView.html" title="interface in org.apache.calcite.schema">ModifiableView</a></td>
<td class="colLast">
<div class="block">A modifiable view onto <a href="../../../../org/apache/calcite/schema/ModifiableTable.html" title="interface in org.apache.calcite.schema"><code>ModifiableTable</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/Path.html" title="interface in org.apache.calcite.schema">Path</a></td>
<td class="colLast">
<div class="block">Path from a root schema to a particular object (schema, table, function).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/ProjectableFilterableTable.html" title="interface in org.apache.calcite.schema">ProjectableFilterableTable</a></td>
<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">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/QueryableTable.html" title="interface in org.apache.calcite.schema">QueryableTable</a></td>
<td class="colLast">
<div class="block">Extension to <a href="../../../../org/apache/calcite/schema/Table.html" title="interface in org.apache.calcite.schema"><code>Table</code></a> that can translate itself to a <a href="../../../../org/apache/calcite/linq4j/Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></td>
<td class="colLast">
<div class="block">Function that returns a scalar result.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/ScannableTable.html" title="interface in org.apache.calcite.schema">ScannableTable</a></td>
<td class="colLast">
<div class="block">Table that can be scanned without creating an intermediate relational
expression.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/Schema.html" title="interface in org.apache.calcite.schema">Schema</a></td>
<td class="colLast">
<div class="block">A namespace for tables and functions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/SchemaFactory.html" title="interface in org.apache.calcite.schema">SchemaFactory</a></td>
<td class="colLast">
<div class="block">Factory for <a href="../../../../org/apache/calcite/schema/Schema.html" title="interface in org.apache.calcite.schema"><code>Schema</code></a> objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a></td>
<td class="colLast">
<div class="block">Extension to the <a href="../../../../org/apache/calcite/schema/Schema.html" title="interface in org.apache.calcite.schema"><code>Schema</code></a> interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/SchemaVersion.html" title="interface in org.apache.calcite.schema">SchemaVersion</a></td>
<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">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/SemiMutableSchema.html" title="interface in org.apache.calcite.schema">SemiMutableSchema</a></td>
<td class="colLast">
<div class="block">Schema to which materializations can be added.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/Statistic.html" title="interface in org.apache.calcite.schema">Statistic</a></td>
<td class="colLast">
<div class="block">Statistics about a <a href="../../../../org/apache/calcite/schema/Table.html" title="interface in org.apache.calcite.schema"><code>Table</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/StreamableTable.html" title="interface in org.apache.calcite.schema">StreamableTable</a></td>
<td class="colLast">
<div class="block">Table that can be converted to a stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/Table.html" title="interface in org.apache.calcite.schema">Table</a></td>
<td class="colLast">
<div class="block">Table.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/TableFactory.html" title="interface in org.apache.calcite.schema">TableFactory</a>&lt;T extends <a href="../../../../org/apache/calcite/schema/Table.html" title="interface in org.apache.calcite.schema">Table</a>&gt;</td>
<td class="colLast">
<div class="block">Factory for <a href="../../../../org/apache/calcite/schema/Table.html" title="interface in org.apache.calcite.schema"><code>Table</code></a> objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/TableFunction.html" title="interface in org.apache.calcite.schema">TableFunction</a></td>
<td class="colLast">
<div class="block">Function that returns a table during execution time.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/TableMacro.html" title="interface in org.apache.calcite.schema">TableMacro</a></td>
<td class="colLast">
<div class="block">Function that returns a <a href="../../../../org/apache/calcite/schema/Table.html" title="interface in org.apache.calcite.schema"><code>Table</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/TemporalTable.html" title="interface in org.apache.calcite.schema">TemporalTable</a></td>
<td class="colLast">
<div class="block">Table that is temporal.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/TransientTable.html" title="interface in org.apache.calcite.schema">TransientTable</a></td>
<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">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/TranslatableTable.html" title="interface in org.apache.calcite.schema">TranslatableTable</a></td>
<td class="colLast">
<div class="block">Extension to <a href="../../../../org/apache/calcite/schema/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="../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>relational expression</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/Wrapper.html" title="interface in org.apache.calcite.schema">Wrapper</a></td>
<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" 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/schema/Schemas.html" title="class in org.apache.calcite.schema">Schemas</a></td>
<td class="colLast">
<div class="block">Utility functions for schemas.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/Statistics.html" title="class in org.apache.calcite.schema">Statistics</a></td>
<td class="colLast">
<div class="block">Utility functions regarding <a href="../../../../org/apache/calcite/schema/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" 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/schema/ColumnStrategy.html" title="enum in org.apache.calcite.schema">ColumnStrategy</a></td>
<td class="colLast">
<div class="block">Describes how a column gets populated.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/schema/Schema.TableType.html" title="enum in org.apache.calcite.schema">Schema.TableType</a></td>
<td class="colLast">
<div class="block">Table type.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.calcite.schema Description">Package org.apache.calcite.schema Description</h2>
<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>
</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/runtime/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/calcite/schema/impl/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/schema/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>