| <!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.model (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.model (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/materialize/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/apache/calcite/piglet/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/model/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All 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 org.apache.calcite.model</h1> |
| <div class="docSummary"> |
| <div class="block">Provides model files, in JSON format, defining schemas and other metadata.</div> |
| </div> |
| <p>See: <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="Class Summary table, listing classes, and an explanation"> |
| <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"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonColumn.html" title="class in org.apache.calcite.model">JsonColumn</a></td> |
| <td class="colLast"> |
| <div class="block">JSON object representing a column.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonCustomSchema.html" title="class in org.apache.calcite.model">JsonCustomSchema</a></td> |
| <td class="colLast"> |
| <div class="block">JSON schema element that represents a custom schema.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonCustomTable.html" title="class in org.apache.calcite.model">JsonCustomTable</a></td> |
| <td class="colLast"> |
| <div class="block">Custom table schema element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonFunction.html" title="class in org.apache.calcite.model">JsonFunction</a></td> |
| <td class="colLast"> |
| <div class="block">Function schema element.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonJdbcSchema.html" title="class in org.apache.calcite.model">JsonJdbcSchema</a></td> |
| <td class="colLast"> |
| <div class="block">JSON object representing a schema that maps to a JDBC database.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonLattice.html" title="class in org.apache.calcite.model">JsonLattice</a></td> |
| <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"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonMapSchema.html" title="class in org.apache.calcite.model">JsonMapSchema</a></td> |
| <td class="colLast"> |
| <div class="block">JSON object representing a schema whose tables are explicitly specified.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonMaterialization.html" title="class in org.apache.calcite.model">JsonMaterialization</a></td> |
| <td class="colLast"> |
| <div class="block">Element that describes how a table is a materialization of a query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonMeasure.html" title="class in org.apache.calcite.model">JsonMeasure</a></td> |
| <td class="colLast"> |
| <div class="block">An aggregate function applied to a column (or columns) of a lattice.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonRoot.html" title="class in org.apache.calcite.model">JsonRoot</a></td> |
| <td class="colLast"> |
| <div class="block">Root schema element.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonSchema.html" title="class in org.apache.calcite.model">JsonSchema</a></td> |
| <td class="colLast"> |
| <div class="block">Schema schema element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonStream.html" title="class in org.apache.calcite.model">JsonStream</a></td> |
| <td class="colLast"> |
| <div class="block">Information about whether a table allows streaming.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonTable.html" title="class in org.apache.calcite.model">JsonTable</a></td> |
| <td class="colLast"> |
| <div class="block">Table schema element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonTile.html" title="class in org.apache.calcite.model">JsonTile</a></td> |
| <td class="colLast"> |
| <div class="block">Materialized view within a <a href="../../../../org/apache/calcite/model/JsonLattice.html" title="class in org.apache.calcite.model"><code>JsonLattice</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonType.html" title="class in org.apache.calcite.model">JsonType</a></td> |
| <td class="colLast"> |
| <div class="block">Type schema element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonTypeAttribute.html" title="class in org.apache.calcite.model">JsonTypeAttribute</a></td> |
| <td class="colLast"> |
| <div class="block">JSON object representing a type attribute.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonView.html" title="class in org.apache.calcite.model">JsonView</a></td> |
| <td class="colLast"> |
| <div class="block">View schema element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/ModelHandler.html" title="class in org.apache.calcite.model">ModelHandler</a></td> |
| <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" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <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"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/JsonSchema.Type.html" title="enum in org.apache.calcite.model">JsonSchema.Type</a></td> |
| <td class="colLast"> |
| <div class="block">Built-in schema types.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/calcite/model/ModelHandler.ExtraOperand.html" title="enum in org.apache.calcite.model">ModelHandler.ExtraOperand</a></td> |
| <td class="colLast"> |
| <div class="block">Extra operands automatically injected into a |
| <a href="../../../../org/apache/calcite/model/JsonCustomSchema.html#operand"><code>JsonCustomSchema.operand</code></a>, as extra context for the adapter.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.calcite.model Description">Package org.apache.calcite.model Description</h2> |
| <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="../../../../org/apache/calcite/model/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="../../../../org/apache/calcite/schema/SchemaFactory.html" title="interface in org.apache.calcite.schema"><code>SchemaFactory</code></a> |
| or <a href="../../../../org/apache/calcite/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> |
| </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/materialize/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/apache/calcite/piglet/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/model/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.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> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </body> |
| </html> |