| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>org.apache.calcite.model (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.model (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 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"> </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 org.apache.calcite.model</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <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> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </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="JsonColumn.html" title="class in org.apache.calcite.model">JsonColumn</a></th> |
| <td class="colLast"> |
| <div class="block">JSON object representing a column.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JsonCustomSchema.html" title="class in org.apache.calcite.model">JsonCustomSchema</a></th> |
| <td class="colLast"> |
| <div class="block">JSON schema element that represents a custom schema.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonCustomTable.html" title="class in org.apache.calcite.model">JsonCustomTable</a></th> |
| <td class="colLast"> |
| <div class="block">Custom table schema element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JsonFunction.html" title="class in org.apache.calcite.model">JsonFunction</a></th> |
| <td class="colLast"> |
| <div class="block">Function schema element.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonJdbcSchema.html" title="class in org.apache.calcite.model">JsonJdbcSchema</a></th> |
| <td class="colLast"> |
| <div class="block">JSON object representing a schema that maps to a JDBC database.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JsonLattice.html" title="class in org.apache.calcite.model">JsonLattice</a></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonMapSchema.html" title="class in org.apache.calcite.model">JsonMapSchema</a></th> |
| <td class="colLast"> |
| <div class="block">JSON object representing a schema whose tables are explicitly specified.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JsonMaterialization.html" title="class in org.apache.calcite.model">JsonMaterialization</a></th> |
| <td class="colLast"> |
| <div class="block">Element that describes how a table is a materialization of a query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonMeasure.html" title="class in org.apache.calcite.model">JsonMeasure</a></th> |
| <td class="colLast"> |
| <div class="block">An aggregate function applied to a column (or columns) of a lattice.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JsonRoot.html" title="class in org.apache.calcite.model">JsonRoot</a></th> |
| <td class="colLast"> |
| <div class="block">Root schema element.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonSchema.html" title="class in org.apache.calcite.model">JsonSchema</a></th> |
| <td class="colLast"> |
| <div class="block">Schema schema element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JsonStream.html" title="class in org.apache.calcite.model">JsonStream</a></th> |
| <td class="colLast"> |
| <div class="block">Information about whether a table allows streaming.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonTable.html" title="class in org.apache.calcite.model">JsonTable</a></th> |
| <td class="colLast"> |
| <div class="block">Table schema element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JsonTile.html" title="class in org.apache.calcite.model">JsonTile</a></th> |
| <td class="colLast"> |
| <div class="block">Materialized view within a <a href="JsonLattice.html" title="class in org.apache.calcite.model"><code>JsonLattice</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonType.html" title="class in org.apache.calcite.model">JsonType</a></th> |
| <td class="colLast"> |
| <div class="block">Type schema element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JsonTypeAttribute.html" title="class in org.apache.calcite.model">JsonTypeAttribute</a></th> |
| <td class="colLast"> |
| <div class="block">JSON object representing a type attribute.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonView.html" title="class in org.apache.calcite.model">JsonView</a></th> |
| <td class="colLast"> |
| <div class="block">View schema element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ModelHandler.html" title="class in org.apache.calcite.model">ModelHandler</a></th> |
| <td class="colLast"> |
| <div class="block">Reads a model and creates schema objects accordingly.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </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="JsonSchema.Type.html" title="enum in org.apache.calcite.model">JsonSchema.Type</a></th> |
| <td class="colLast"> |
| <div class="block">Built-in schema types.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ModelHandler.ExtraOperand.html" title="enum in org.apache.calcite.model">ModelHandler.ExtraOperand</a></th> |
| <td class="colLast"> |
| <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> |
| </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 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 © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
