| <!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>Table (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="Table (Apache Calcite calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"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"; |
| </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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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/schema/StreamableTable.html" title="interface in org.apache.calcite.schema"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/calcite/schema/TableFactory.html" title="interface in org.apache.calcite.schema"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/schema/Table.html" target="_top">Frames</a></li> |
| <li><a href="Table.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> |
| <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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.calcite.schema</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><a href="../../../../org/apache/calcite/schema/CustomColumnResolvingTable.html" title="interface in org.apache.calcite.schema">CustomColumnResolvingTable</a>, <a href="../../../../org/apache/calcite/schema/ExtensibleTable.html" title="interface in org.apache.calcite.schema">ExtensibleTable</a>, <a href="../../../../org/apache/calcite/schema/FilterableTable.html" title="interface in org.apache.calcite.schema">FilterableTable</a>, <a href="../../../../org/apache/calcite/schema/ModifiableTable.html" title="interface in org.apache.calcite.schema">ModifiableTable</a>, <a href="../../../../org/apache/calcite/schema/ModifiableView.html" title="interface in org.apache.calcite.schema">ModifiableView</a>, <a href="../../../../org/apache/calcite/schema/ProjectableFilterableTable.html" title="interface in org.apache.calcite.schema">ProjectableFilterableTable</a>, <a href="../../../../org/apache/calcite/schema/QueryableTable.html" title="interface in org.apache.calcite.schema">QueryableTable</a>, <a href="../../../../org/apache/calcite/schema/ScannableTable.html" title="interface in org.apache.calcite.schema">ScannableTable</a>, <a href="../../../../org/apache/calcite/schema/StreamableTable.html" title="interface in org.apache.calcite.schema">StreamableTable</a>, <a href="../../../../org/apache/calcite/schema/TemporalTable.html" title="interface in org.apache.calcite.schema">TemporalTable</a>, <a href="../../../../org/apache/calcite/schema/TransientTable.html" title="interface in org.apache.calcite.schema">TransientTable</a>, <a href="../../../../org/apache/calcite/schema/TranslatableTable.html" title="interface in org.apache.calcite.schema">TranslatableTable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/calcite/adapter/java/AbstractQueryableTable.html" title="class in org.apache.calcite.adapter.java">AbstractQueryableTable</a>, <a href="../../../../org/apache/calcite/schema/impl/AbstractTable.html" title="class in org.apache.calcite.schema.impl">AbstractTable</a>, <a href="../../../../org/apache/calcite/adapter/cassandra/CassandraTable.html" title="class in org.apache.calcite.adapter.cassandra">CassandraTable</a>, <a href="../../../../org/apache/calcite/adapter/csv/CsvFilterableTable.html" title="class in org.apache.calcite.adapter.csv">CsvFilterableTable</a>, <a href="../../../../org/apache/calcite/adapter/csv/CsvScannableTable.html" title="class in org.apache.calcite.adapter.csv">CsvScannableTable</a>, <a href="../../../../org/apache/calcite/adapter/csv/CsvStreamScannableTable.html" title="class in org.apache.calcite.adapter.csv">CsvStreamScannableTable</a>, <a href="../../../../org/apache/calcite/adapter/csv/CsvTable.html" title="class in org.apache.calcite.adapter.csv">CsvTable</a>, <a href="../../../../org/apache/calcite/adapter/csv/CsvTranslatableTable.html" title="class in org.apache.calcite.adapter.csv">CsvTranslatableTable</a>, <a href="../../../../org/apache/calcite/adapter/druid/DruidTable.html" title="class in org.apache.calcite.adapter.druid">DruidTable</a>, <a href="../../../../org/apache/calcite/adapter/elasticsearch/ElasticsearchTable.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchTable</a>, <a href="../../../../org/apache/calcite/adapter/geode/simple/GeodeSimpleScannableTable.html" title="class in org.apache.calcite.adapter.geode.simple">GeodeSimpleScannableTable</a>, <a href="../../../../org/apache/calcite/adapter/geode/rel/GeodeTable.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeTable</a>, <a href="../../../../org/apache/calcite/adapter/jdbc/JdbcTable.html" title="class in org.apache.calcite.adapter.jdbc">JdbcTable</a>, <a href="../../../../org/apache/calcite/adapter/csv/JsonScannableTable.html" title="class in org.apache.calcite.adapter.csv">JsonScannableTable</a>, <a href="../../../../org/apache/calcite/adapter/csv/JsonTable.html" title="class in org.apache.calcite.adapter.csv">JsonTable</a>, <a href="../../../../org/apache/calcite/adapter/kafka/KafkaStreamTable.html" title="class in org.apache.calcite.adapter.kafka">KafkaStreamTable</a>, <a href="../../../../org/apache/calcite/schema/impl/ListTransientTable.html" title="class in org.apache.calcite.schema.impl">ListTransientTable</a>, <a href="../../../../org/apache/calcite/schema/impl/MaterializedViewTable.html" title="class in org.apache.calcite.schema.impl">MaterializedViewTable</a>, <a href="../../../../org/apache/calcite/example/maze/MazeTable.html" title="class in org.apache.calcite.example.maze">MazeTable</a>, <a href="../../../../org/apache/calcite/schema/impl/ModifiableViewTable.html" title="class in org.apache.calcite.schema.impl">ModifiableViewTable</a>, <a href="../../../../org/apache/calcite/adapter/mongodb/MongoTable.html" title="class in org.apache.calcite.adapter.mongodb">MongoTable</a>, <a href="../../../../org/apache/calcite/adapter/pig/PigTable.html" title="class in org.apache.calcite.adapter.pig">PigTable</a>, <a href="../../../../org/apache/calcite/piglet/PigTable.html" title="class in org.apache.calcite.piglet">PigTable</a>, <a href="../../../../org/apache/calcite/adapter/redis/RedisTable.html" title="class in org.apache.calcite.adapter.redis">RedisTable</a>, <a href="../../../../org/apache/calcite/schema/impl/StarTable.html" title="class in org.apache.calcite.schema.impl">StarTable</a>, <a href="../../../../org/apache/calcite/schema/impl/ViewTable.html" title="class in org.apache.calcite.schema.impl">ViewTable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <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="../../../../org/apache/calcite/schema/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="../../../../org/apache/calcite/schema/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="../../../../org/apache/calcite/schema/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="../../../../org/apache/calcite/schema/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 =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/calcite/schema/Schema.TableType.html" title="enum in org.apache.calcite.schema">Schema.TableType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/schema/Table.html#getJdbcTableType--">getJdbcTableType</a></span>()</code> |
| <div class="block">Type of table.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/calcite/rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/schema/Table.html#getRowType-org.apache.calcite.rel.type.RelDataTypeFactory-">getRowType</a></span>(<a href="../../../../org/apache/calcite/rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory)</code> |
| <div class="block">Returns this table's row type.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/calcite/schema/Statistic.html" title="interface in org.apache.calcite.schema">Statistic</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/schema/Table.html#getStatistic--">getStatistic</a></span>()</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/schema/Table.html#isRolledUp-java.lang.String-">isRolledUp</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> column)</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/schema/Table.html#rolledUpColumnValidInsideAgg-java.lang.String-org.apache.calcite.sql.SqlCall-org.apache.calcite.sql.SqlNode-org.apache.calcite.config.CalciteConnectionConfig-">rolledUpColumnValidInsideAgg</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> column, |
| <a href="../../../../org/apache/calcite/sql/SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="../../../../org/apache/calcite/sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> parent, |
| <a href="../../../../org/apache/calcite/config/CalciteConnectionConfig.html" title="interface in org.apache.calcite.config">CalciteConnectionConfig</a> config)</code> |
| <div class="block">Determines whether the given rolled up column can be used inside the given aggregate function.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getRowType-org.apache.calcite.rel.type.RelDataTypeFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRowType</h4> |
| <pre><a href="../../../../org/apache/calcite/rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> getRowType(<a href="../../../../org/apache/calcite/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 name="getStatistic--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatistic</h4> |
| <pre><a href="../../../../org/apache/calcite/schema/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 name="getJdbcTableType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJdbcTableType</h4> |
| <pre><a href="../../../../org/apache/calcite/schema/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 name="isRolledUp-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRolledUp</h4> |
| <pre>boolean isRolledUp(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> column)</pre> |
| <div class="block">Determines whether the given <code>column</code> has been rolled up.</div> |
| </li> |
| </ul> |
| <a name="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>boolean rolledUpColumnValidInsideAgg(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> column, |
| <a href="../../../../org/apache/calcite/sql/SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="../../../../org/apache/calcite/sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> parent, |
| <a href="../../../../org/apache/calcite/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="../../../../org/apache/calcite/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> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= 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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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/schema/StreamableTable.html" title="interface in org.apache.calcite.schema"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/calcite/schema/TableFactory.html" title="interface in org.apache.calcite.schema"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/schema/Table.html" target="_top">Frames</a></li> |
| <li><a href="Table.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> |
| <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 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> |