| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>org.apache.calcite.model (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.model"> |
| <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.model" class="title">Package org.apache.calcite.model</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.model</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Provides model files, in JSON format, defining schemas and other metadata. |
| |
| <p>Models are specified using a <code>model=<uri></code> parameter on |
| the JDBC connect string. Calcite loads the model while initializing the |
| connection. It first parses the JSON, then uses a |
| <a href="ModelHandler.html" title="class in org.apache.calcite.model"><code>ModelHandler</code></a> as visitor over the parse |
| tree.</p> |
| |
| <p>There are standard implementations of schema and table, but the user can |
| provide their own by implementing the |
| <a href="../schema/SchemaFactory.html" title="interface in org.apache.calcite.schema"><code>SchemaFactory</code></a> |
| or <a href="../schema/TableFactory.html" title="interface in org.apache.calcite.schema"><code>TableFactory</code></a> |
| interfaces and including a custom schema in the model.</p> |
| |
| <p>There are several examples of schemas in the |
| <a href="https://calcite.apache.org/docs/tutorial.html">tutorial</a>.</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> |
| </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-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-tab2"><a href="JsonColumn.html" title="class in org.apache.calcite.model">JsonColumn</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">JSON object representing a column.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JsonCustomSchema.html" title="class in org.apache.calcite.model">JsonCustomSchema</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">JSON schema element that represents a custom schema.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="JsonCustomTable.html" title="class in org.apache.calcite.model">JsonCustomTable</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Custom table schema element.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JsonFunction.html" title="class in org.apache.calcite.model">JsonFunction</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Function schema element.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="JsonJdbcSchema.html" title="class in org.apache.calcite.model">JsonJdbcSchema</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">JSON object representing a schema that maps to a JDBC database.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JsonLattice.html" title="class in org.apache.calcite.model">JsonLattice</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Element that describes a star schema and provides a framework for defining, |
| recognizing, and recommending materialized views at various levels of |
| aggregation.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="JsonMapSchema.html" title="class in org.apache.calcite.model">JsonMapSchema</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">JSON object representing a schema whose tables are explicitly specified.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JsonMaterialization.html" title="class in org.apache.calcite.model">JsonMaterialization</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Element that describes how a table is a materialization of a query.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="JsonMeasure.html" title="class in org.apache.calcite.model">JsonMeasure</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">An aggregate function applied to a column (or columns) of a lattice.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JsonRoot.html" title="class in org.apache.calcite.model">JsonRoot</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Root schema element.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="JsonSchema.html" title="class in org.apache.calcite.model">JsonSchema</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Schema schema element.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="JsonSchema.Type.html" title="enum in org.apache.calcite.model">JsonSchema.Type</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Built-in schema types.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="JsonStream.html" title="class in org.apache.calcite.model">JsonStream</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Information about whether a table allows streaming.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JsonTable.html" title="class in org.apache.calcite.model">JsonTable</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Table schema element.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="JsonTile.html" title="class in org.apache.calcite.model">JsonTile</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Materialized view within a <a href="JsonLattice.html" title="class in org.apache.calcite.model"><code>JsonLattice</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JsonType.html" title="class in org.apache.calcite.model">JsonType</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Type schema element.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="JsonTypeAttribute.html" title="class in org.apache.calcite.model">JsonTypeAttribute</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">JSON object representing a type attribute.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JsonView.html" title="class in org.apache.calcite.model">JsonView</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">View schema element.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ModelHandler.html" title="class in org.apache.calcite.model">ModelHandler</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Reads a model and creates schema objects accordingly.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="ModelHandler.ExtraOperand.html" title="enum in org.apache.calcite.model">ModelHandler.ExtraOperand</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Extra operands automatically injected into a |
| <a href="JsonCustomSchema.html#operand"><code>JsonCustomSchema.operand</code></a>, as extra context for the adapter.</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> |
