| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>org.apache.calcite.schema (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.schema"> |
| <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.schema" class="title">Package org.apache.calcite.schema</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.schema</span></div> |
| <section class="package-description" id="package-description"> |
| <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> |
| <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 class="col-first odd-row-color"><a href="impl/package-summary.html">org.apache.calcite.schema.impl</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Utilities to help implement Calcite's SPIs.</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></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="AggregateFunction.html" title="interface in org.apache.calcite.schema">AggregateFunction</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Function that combines several values into a scalar result.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="ColumnStrategy.html" title="enum in org.apache.calcite.schema">ColumnStrategy</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Describes how a column gets populated.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="CustomColumnResolvingTable.html" title="interface in org.apache.calcite.schema">CustomColumnResolvingTable</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ExtensibleTable.html" title="interface in org.apache.calcite.schema">ExtensibleTable</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Table whose row type can be extended to include extra fields.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="FilterableTable.html" title="interface in org.apache.calcite.schema">FilterableTable</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Table that can be scanned, optionally applying supplied filter expressions, |
| without creating an intermediate relational expression.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Function.html" title="interface in org.apache.calcite.schema">Function</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Named expression that accepts parameters and returns a result.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="FunctionContext.html" title="interface in org.apache.calcite.schema">FunctionContext</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Information about a function call that is passed to the constructor of a |
| function instance.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="FunctionParameter.html" title="interface in org.apache.calcite.schema">FunctionParameter</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Parameter to a <a href="Function.html" title="interface in org.apache.calcite.schema"><code>Function</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ImplementableAggFunction.html" title="interface in org.apache.calcite.schema">ImplementableAggFunction</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Function that can be translated to java code.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ImplementableFunction.html" title="interface in org.apache.calcite.schema">ImplementableFunction</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Function that can be translated to java code.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Member.html" title="interface in org.apache.calcite.schema">Member</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">A named expression in a schema.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ModifiableTable.html" title="interface in org.apache.calcite.schema">ModifiableTable</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">A table that can be modified.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ModifiableView.html" title="interface in org.apache.calcite.schema">ModifiableView</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">A modifiable view onto <a href="ModifiableTable.html" title="interface in org.apache.calcite.schema"><code>ModifiableTable</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Path.html" title="interface in org.apache.calcite.schema">Path</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Path from a root schema to a particular object (schema, table, function).</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ProjectableFilterableTable.html" title="interface in org.apache.calcite.schema">ProjectableFilterableTable</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="QueryableTable.html" title="interface in org.apache.calcite.schema">QueryableTable</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <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> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Function that returns a scalar result.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ScannableTable.html" title="interface in org.apache.calcite.schema">ScannableTable</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Table that can be scanned without creating an intermediate relational |
| expression.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Schema.html" title="interface in org.apache.calcite.schema">Schema</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">A namespace for tables and functions.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="Schema.TableType.html" title="enum in org.apache.calcite.schema">Schema.TableType</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Table type.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="SchemaFactory.html" title="interface in org.apache.calcite.schema">SchemaFactory</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Factory for <a href="Schema.html" title="interface in org.apache.calcite.schema"><code>Schema</code></a> objects.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Extension to the <a href="Schema.html" title="interface in org.apache.calcite.schema"><code>Schema</code></a> interface.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Schemas.html" title="class in org.apache.calcite.schema">Schemas</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Utility functions for schemas.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="SchemaVersion.html" title="interface in org.apache.calcite.schema">SchemaVersion</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">An interface to represent a version ID that can be used to create a |
| read-consistent view of a Schema.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="SemiMutableSchema.html" title="interface in org.apache.calcite.schema">SemiMutableSchema</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Schema to which materializations can be added.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Statistic.html" title="interface in org.apache.calcite.schema">Statistic</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Statistics about a <a href="Table.html" title="interface in org.apache.calcite.schema"><code>Table</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Statistics.html" title="class in org.apache.calcite.schema">Statistics</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Utility functions regarding <a href="Statistic.html" title="interface in org.apache.calcite.schema"><code>Statistic</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="StreamableTable.html" title="interface in org.apache.calcite.schema">StreamableTable</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Table that can be converted to a stream.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Table.html" title="interface in org.apache.calcite.schema">Table</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Table.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="TableFactory.html" title="interface in org.apache.calcite.schema">TableFactory</a><T extends <a href="Table.html" title="interface in org.apache.calcite.schema">Table</a>></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Factory for <a href="Table.html" title="interface in org.apache.calcite.schema"><code>Table</code></a> objects.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="TableFunction.html" title="interface in org.apache.calcite.schema">TableFunction</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Function that returns a table during execution time.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="TableMacro.html" title="interface in org.apache.calcite.schema">TableMacro</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Function that returns a <a href="Table.html" title="interface in org.apache.calcite.schema"><code>Table</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="TemporalTable.html" title="interface in org.apache.calcite.schema">TemporalTable</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Table that is temporal.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="TransientTable.html" title="interface in org.apache.calcite.schema">TransientTable</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <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> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="TranslatableTable.html" title="interface in org.apache.calcite.schema">TranslatableTable</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Wrapper.html" title="interface in org.apache.calcite.schema">Wrapper</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Mix-in interface that allows you to find sub-objects.</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> |
