| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Table (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="Table (Apache Calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| 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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Table.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </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> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.schema</a></div> |
| <h2 title="Interface Table" class="title">Interface Table</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="CustomColumnResolvingTable.html" title="interface in org.apache.calcite.schema">CustomColumnResolvingTable</a></code>, <code><a href="ExtensibleTable.html" title="interface in org.apache.calcite.schema">ExtensibleTable</a></code>, <code><a href="FilterableTable.html" title="interface in org.apache.calcite.schema">FilterableTable</a></code>, <code><a href="ModifiableTable.html" title="interface in org.apache.calcite.schema">ModifiableTable</a></code>, <code><a href="ModifiableView.html" title="interface in org.apache.calcite.schema">ModifiableView</a></code>, <code><a href="ProjectableFilterableTable.html" title="interface in org.apache.calcite.schema">ProjectableFilterableTable</a></code>, <code><a href="QueryableTable.html" title="interface in org.apache.calcite.schema">QueryableTable</a></code>, <code><a href="ScannableTable.html" title="interface in org.apache.calcite.schema">ScannableTable</a></code>, <code><a href="StreamableTable.html" title="interface in org.apache.calcite.schema">StreamableTable</a></code>, <code><a href="TemporalTable.html" title="interface in org.apache.calcite.schema">TemporalTable</a></code>, <code><a href="TransientTable.html" title="interface in org.apache.calcite.schema">TransientTable</a></code>, <code><a href="TranslatableTable.html" title="interface in org.apache.calcite.schema">TranslatableTable</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../adapter/java/AbstractQueryableTable.html" title="class in org.apache.calcite.adapter.java">AbstractQueryableTable</a></code>, <code><a href="impl/AbstractTable.html" title="class in org.apache.calcite.schema.impl">AbstractTable</a></code>, <code><a href="../adapter/clone/ArrayTable.html" title="class in org.apache.calcite.adapter.clone">ArrayTable</a></code>, <code><a href="../jdbc/CalciteMetaImpl.MetadataTable.html" title="class in org.apache.calcite.jdbc">CalciteMetaImpl.MetadataTable</a></code>, <code><a href="../adapter/cassandra/CassandraTable.html" title="class in org.apache.calcite.adapter.cassandra">CassandraTable</a></code>, <code><a href="../adapter/csv/CsvFilterableTable.html" title="class in org.apache.calcite.adapter.csv">CsvFilterableTable</a></code>, <code><a href="../adapter/csv/CsvScannableTable.html" title="class in org.apache.calcite.adapter.csv">CsvScannableTable</a></code>, <code><a href="../adapter/csv/CsvStreamScannableTable.html" title="class in org.apache.calcite.adapter.csv">CsvStreamScannableTable</a></code>, <code><a href="../adapter/csv/CsvTable.html" title="class in org.apache.calcite.adapter.csv">CsvTable</a></code>, <code><a href="../adapter/csv/CsvTranslatableTable.html" title="class in org.apache.calcite.adapter.csv">CsvTranslatableTable</a></code>, <code><a href="../adapter/druid/DruidTable.html" title="class in org.apache.calcite.adapter.druid">DruidTable</a></code>, <code><a href="../adapter/elasticsearch/ElasticsearchTable.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchTable</a></code>, <code><a href="../adapter/file/FileTable.html" title="class in org.apache.calcite.adapter.file">FileTable</a></code>, <code><a href="../adapter/geode/simple/GeodeSimpleScannableTable.html" title="class in org.apache.calcite.adapter.geode.simple">GeodeSimpleScannableTable</a></code>, <code><a href="../adapter/geode/rel/GeodeTable.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeTable</a></code>, <code><a href="../adapter/jdbc/JdbcTable.html" title="class in org.apache.calcite.adapter.jdbc">JdbcTable</a></code>, <code><a href="../adapter/csv/JsonScannableTable.html" title="class in org.apache.calcite.adapter.csv">JsonScannableTable</a></code>, <code><a href="../adapter/csv/JsonTable.html" title="class in org.apache.calcite.adapter.csv">JsonTable</a></code>, <code><a href="../adapter/kafka/KafkaStreamTable.html" title="class in org.apache.calcite.adapter.kafka">KafkaStreamTable</a></code>, <code><a href="../adapter/clone/ListTable.html" title="class in org.apache.calcite.adapter.clone">ListTable</a></code>, <code><a href="impl/ListTransientTable.html" title="class in org.apache.calcite.schema.impl">ListTransientTable</a></code>, <code><a href="impl/MaterializedViewTable.html" title="class in org.apache.calcite.schema.impl">MaterializedViewTable</a></code>, <code><a href="../example/maze/MazeTable.html" title="class in org.apache.calcite.example.maze">MazeTable</a></code>, <code><a href="impl/ModifiableViewTable.html" title="class in org.apache.calcite.schema.impl">ModifiableViewTable</a></code>, <code><a href="../adapter/mongodb/MongoTable.html" title="class in org.apache.calcite.adapter.mongodb">MongoTable</a></code>, <code><a href="../adapter/pig/PigTable.html" title="class in org.apache.calcite.adapter.pig">PigTable</a></code>, <code><a href="../piglet/PigTable.html" title="class in org.apache.calcite.piglet">PigTable</a></code>, <code><a href="../adapter/java/ReflectiveSchema.FieldTable.html" title="class in org.apache.calcite.adapter.java">ReflectiveSchema.FieldTable</a></code>, <code><a href="../adapter/java/ReflectiveSchema.ReflectiveTable.html" title="class in org.apache.calcite.adapter.java">ReflectiveSchema.ReflectiveTable</a></code>, <code><a href="../adapter/splunk/SplunkTable.html" title="class in org.apache.calcite.adapter.splunk">SplunkTable</a></code>, <code><a href="../sql/ddl/SqlCreateMaterializedView.MaterializedViewTable.html" title="class in org.apache.calcite.sql.ddl">SqlCreateMaterializedView.MaterializedViewTable</a></code>, <code><a href="../sql/ddl/SqlCreateTable.AbstractModifiableTable.html" title="class in org.apache.calcite.sql.ddl">SqlCreateTable.AbstractModifiableTable</a></code>, <code><a href="../sql/ddl/SqlCreateTable.MutableArrayTable.html" title="class in org.apache.calcite.sql.ddl">SqlCreateTable.MutableArrayTable</a></code>, <code><a href="impl/StarTable.html" title="class in org.apache.calcite.schema.impl">StarTable</a></code>, <code><a href="../adapter/tpcds/TpcdsSchema.TpcdsQueryableTable.html" title="class in org.apache.calcite.adapter.tpcds">TpcdsSchema.TpcdsQueryableTable</a></code>, <code><a href="../adapter/tpch/TpchSchema.TpchQueryableTable.html" title="class in org.apache.calcite.adapter.tpch">TpchSchema.TpchQueryableTable</a></code>, <code><a href="impl/ViewTable.html" title="class in org.apache.calcite.schema.impl">ViewTable</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Table</span></pre> |
| <div class="block">Table. |
| |
| <p>The typical way for a table to be created is when Calcite interrogates a |
| user-defined schema in order to validate names appearing in a SQL query. |
| Calcite finds the schema by calling <a href="Schema.html#getSubSchema(java.lang.String)"><code>Schema.getSubSchema(String)</code></a> on |
| the connection's root schema, then gets a table by calling |
| <a href="Schema.html#getTable(java.lang.String)"><code>Schema.getTable(String)</code></a>.</p> |
| |
| <p>Note that a table does not know its name. It is in fact possible for |
| a table to be used more than once, perhaps under multiple names or under |
| multiple schemas. (Compare with the |
| <a href="http://en.wikipedia.org/wiki/Inode">i-node</a> concept in the UNIX |
| filesystem.)</p> |
| |
| <p>A particular table instance may also implement <a href="Wrapper.html" title="interface in org.apache.calcite.schema"><code>Wrapper</code></a>, |
| to give access to sub-objects.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="TableMacro.html" title="interface in org.apache.calcite.schema"><code>TableMacro</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="Schema.TableType.html" title="enum in org.apache.calcite.schema">Schema.TableType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJdbcTableType()">getJdbcTableType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Type of table.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRowType(org.apache.calcite.rel.type.RelDataTypeFactory)">getRowType</a></span>​(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns this table's row type.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="Statistic.html" title="interface in org.apache.calcite.schema">Statistic</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStatistic()">getStatistic</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a provider of statistics about this table.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRolledUp(java.lang.String)">isRolledUp</a></span>​(java.lang.String column)</code></th> |
| <td class="colLast"> |
| <div class="block">Determines whether the given <code>column</code> has been rolled up.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rolledUpColumnValidInsideAgg(java.lang.String,org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.SqlNode,org.apache.calcite.config.CalciteConnectionConfig)">rolledUpColumnValidInsideAgg</a></span>​(java.lang.String column, |
| <a href="../sql/SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> parent, |
| <a href="../config/CalciteConnectionConfig.html" title="interface in org.apache.calcite.config">CalciteConnectionConfig</a> config)</code></th> |
| <td class="colLast"> |
| <div class="block">Determines whether the given rolled up column can be used inside the given aggregate function.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getRowType(org.apache.calcite.rel.type.RelDataTypeFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRowType</h4> |
| <pre class="methodSignature"><a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> getRowType​(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory)</pre> |
| <div class="block">Returns this table's row type. |
| |
| <p>This is a struct type whose |
| fields describe the names and types of the columns in this table.</p> |
| |
| <p>The implementer must use the type factory provided. This ensures that |
| the type is converted into a canonical form; other equal types in the same |
| query will use the same object.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>typeFactory</code> - Type factory with which to create the type</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Row type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStatistic()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatistic</h4> |
| <pre class="methodSignature"><a href="Statistic.html" title="interface in org.apache.calcite.schema">Statistic</a> getStatistic()</pre> |
| <div class="block">Returns a provider of statistics about this table.</div> |
| </li> |
| </ul> |
| <a id="getJdbcTableType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJdbcTableType</h4> |
| <pre class="methodSignature"><a href="Schema.TableType.html" title="enum in org.apache.calcite.schema">Schema.TableType</a> getJdbcTableType()</pre> |
| <div class="block">Type of table.</div> |
| </li> |
| </ul> |
| <a id="isRolledUp(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRolledUp</h4> |
| <pre class="methodSignature">boolean isRolledUp​(java.lang.String column)</pre> |
| <div class="block">Determines whether the given <code>column</code> has been rolled up.</div> |
| </li> |
| </ul> |
| <a id="rolledUpColumnValidInsideAgg(java.lang.String,org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.SqlNode,org.apache.calcite.config.CalciteConnectionConfig)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>rolledUpColumnValidInsideAgg</h4> |
| <pre class="methodSignature">boolean rolledUpColumnValidInsideAgg​(java.lang.String column, |
| <a href="../sql/SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> parent, |
| <a href="../config/CalciteConnectionConfig.html" title="interface in org.apache.calcite.config">CalciteConnectionConfig</a> config)</pre> |
| <div class="block">Determines whether the given rolled up column can be used inside the given aggregate function. |
| You can assume that <code>isRolledUp(column)</code> is <code>true</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>column</code> - The column name for which <code>isRolledUp</code> is true</dd> |
| <dd><code>call</code> - The aggregate call</dd> |
| <dd><code>parent</code> - Parent node of <code>call</code> in the <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> tree</dd> |
| <dd><code>config</code> - Config settings. May be null</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true iff the given aggregate call is valid</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Table.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </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> |