Google Git
Sign in
apache / calcite-site / bf7470eb6bf1d52715d1d602e33af45602b82bc0 / . / apidocs / javadocAggregate / org / apache / calcite / schema / Table.html
blob: 6010d9f8d049ebdb93748f97624e50a6d1ae0e0f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="zh">
<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","所有方法"],2:["t2","实例方法"],4:["t3","抽象方法"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>您的浏览器已禁用 JavaScript。</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="跳过导航链接">跳过导航链接</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="导航">
<li><a href="../../../../overview-summary.html">概览</a></li>
<li><a href="package-summary.html">程序包</a></li>
<li class="navBarCell1Rev">类</li>
<li><a href="package-tree.html">树</a></li>
<li><a href="../../../../deprecated-list.html">已过时</a></li>
<li><a href="../../../../index-all.html">索引</a></li>
<li><a href="../../../../help-doc.html">帮助</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="org.apache.calcite.schema中的接口"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../org/apache/calcite/schema/TableFactory.html" title="org.apache.calcite.schema中的接口"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/schema/Table.html" target="_top">框架</a></li>
<li><a href="Table.html" target="_top">无框架</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">所有类</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>概要:&nbsp;</li>
<li>嵌套&nbsp;|&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.detail">方法</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="接口 Table" class="title">接口 Table</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>所有已知子接口:</dt>
<dd><a href="../../../../org/apache/calcite/schema/CustomColumnResolvingTable.html" title="org.apache.calcite.schema中的接口">CustomColumnResolvingTable</a>, <a href="../../../../org/apache/calcite/schema/ExtensibleTable.html" title="org.apache.calcite.schema中的接口">ExtensibleTable</a>, <a href="../../../../org/apache/calcite/schema/FilterableTable.html" title="org.apache.calcite.schema中的接口">FilterableTable</a>, <a href="../../../../org/apache/calcite/schema/ModifiableTable.html" title="org.apache.calcite.schema中的接口">ModifiableTable</a>, <a href="../../../../org/apache/calcite/schema/ModifiableView.html" title="org.apache.calcite.schema中的接口">ModifiableView</a>, <a href="../../../../org/apache/calcite/schema/ProjectableFilterableTable.html" title="org.apache.calcite.schema中的接口">ProjectableFilterableTable</a>, <a href="../../../../org/apache/calcite/schema/QueryableTable.html" title="org.apache.calcite.schema中的接口">QueryableTable</a>, <a href="../../../../org/apache/calcite/schema/ScannableTable.html" title="org.apache.calcite.schema中的接口">ScannableTable</a>, <a href="../../../../org/apache/calcite/schema/StreamableTable.html" title="org.apache.calcite.schema中的接口">StreamableTable</a>, <a href="../../../../org/apache/calcite/schema/TemporalTable.html" title="org.apache.calcite.schema中的接口">TemporalTable</a>, <a href="../../../../org/apache/calcite/schema/TransientTable.html" title="org.apache.calcite.schema中的接口">TransientTable</a>, <a href="../../../../org/apache/calcite/schema/TranslatableTable.html" title="org.apache.calcite.schema中的接口">TranslatableTable</a></dd>
</dl>
<dl>
<dt>所有已知实现类:</dt>
<dd><a href="../../../../org/apache/calcite/adapter/java/AbstractQueryableTable.html" title="org.apache.calcite.adapter.java中的类">AbstractQueryableTable</a>, <a href="../../../../org/apache/calcite/schema/impl/AbstractTable.html" title="org.apache.calcite.schema.impl中的类">AbstractTable</a>, <a href="../../../../org/apache/calcite/adapter/cassandra/CassandraTable.html" title="org.apache.calcite.adapter.cassandra中的类">CassandraTable</a>, <a href="../../../../org/apache/calcite/adapter/csv/CsvFilterableTable.html" title="org.apache.calcite.adapter.csv中的类">CsvFilterableTable</a>, <a href="../../../../org/apache/calcite/adapter/csv/CsvScannableTable.html" title="org.apache.calcite.adapter.csv中的类">CsvScannableTable</a>, <a href="../../../../org/apache/calcite/adapter/csv/CsvStreamScannableTable.html" title="org.apache.calcite.adapter.csv中的类">CsvStreamScannableTable</a>, <a href="../../../../org/apache/calcite/adapter/csv/CsvTable.html" title="org.apache.calcite.adapter.csv中的类">CsvTable</a>, <a href="../../../../org/apache/calcite/adapter/csv/CsvTranslatableTable.html" title="org.apache.calcite.adapter.csv中的类">CsvTranslatableTable</a>, <a href="../../../../org/apache/calcite/adapter/druid/DruidTable.html" title="org.apache.calcite.adapter.druid中的类">DruidTable</a>, <a href="../../../../org/apache/calcite/adapter/elasticsearch/ElasticsearchTable.html" title="org.apache.calcite.adapter.elasticsearch中的类">ElasticsearchTable</a>, <a href="../../../../org/apache/calcite/adapter/geode/simple/GeodeSimpleScannableTable.html" title="org.apache.calcite.adapter.geode.simple中的类">GeodeSimpleScannableTable</a>, <a href="../../../../org/apache/calcite/adapter/geode/rel/GeodeTable.html" title="org.apache.calcite.adapter.geode.rel中的类">GeodeTable</a>, <a href="../../../../org/apache/calcite/adapter/jdbc/JdbcTable.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcTable</a>, <a href="../../../../org/apache/calcite/adapter/csv/JsonScannableTable.html" title="org.apache.calcite.adapter.csv中的类">JsonScannableTable</a>, <a href="../../../../org/apache/calcite/adapter/csv/JsonTable.html" title="org.apache.calcite.adapter.csv中的类">JsonTable</a>, <a href="../../../../org/apache/calcite/adapter/kafka/KafkaStreamTable.html" title="org.apache.calcite.adapter.kafka中的类">KafkaStreamTable</a>, <a href="../../../../org/apache/calcite/schema/impl/ListTransientTable.html" title="org.apache.calcite.schema.impl中的类">ListTransientTable</a>, <a href="../../../../org/apache/calcite/schema/impl/MaterializedViewTable.html" title="org.apache.calcite.schema.impl中的类">MaterializedViewTable</a>, <a href="../../../../org/apache/calcite/example/maze/MazeTable.html" title="org.apache.calcite.example.maze中的类">MazeTable</a>, <a href="../../../../org/apache/calcite/schema/impl/ModifiableViewTable.html" title="org.apache.calcite.schema.impl中的类">ModifiableViewTable</a>, <a href="../../../../org/apache/calcite/adapter/mongodb/MongoTable.html" title="org.apache.calcite.adapter.mongodb中的类">MongoTable</a>, <a href="../../../../org/apache/calcite/adapter/pig/PigTable.html" title="org.apache.calcite.adapter.pig中的类">PigTable</a>, <a href="../../../../org/apache/calcite/piglet/PigTable.html" title="org.apache.calcite.piglet中的类">PigTable</a>, <a href="../../../../org/apache/calcite/adapter/redis/RedisTable.html" title="org.apache.calcite.adapter.redis中的类">RedisTable</a>, <a href="../../../../org/apache/calcite/schema/impl/StarTable.html" title="org.apache.calcite.schema.impl中的类">StarTable</a>, <a href="../../../../org/apache/calcite/schema/impl/ViewTable.html" title="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="org.apache.calcite.schema中的接口"><code>Wrapper</code></a>,
to give access to sub-objects.</div>
<dl>
<dt><span class="seeLabel">另请参阅:</span></dt>
<dd><a href="../../../../org/apache/calcite/schema/TableMacro.html" title="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>方法概要</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="方法概要表, 列表方法和解释">
<caption><span id="t0" class="activeTableTab"><span>所有方法</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">实例方法</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">抽象方法</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">限定符和类型</th>
<th class="colLast" scope="col">方法和说明</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/calcite/schema/Schema.TableType.html" title="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="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="org.apache.calcite.rel.type中的接口">RelDataTypeFactory</a>&nbsp;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="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="java.lang中的类或接口">String</a>&nbsp;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="java.lang中的类或接口">String</a>&nbsp;column,
<a href="../../../../org/apache/calcite/sql/SqlCall.html" title="org.apache.calcite.sql中的类">SqlCall</a>&nbsp;call,
<a href="../../../../org/apache/calcite/sql/SqlNode.html" title="org.apache.calcite.sql中的类">SqlNode</a>&nbsp;parent,
<a href="../../../../org/apache/calcite/config/CalciteConnectionConfig.html" title="org.apache.calcite.config中的接口">CalciteConnectionConfig</a>&nbsp;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>方法详细资料</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="org.apache.calcite.rel.type中的接口">RelDataType</a>&nbsp;getRowType(<a href="../../../../org/apache/calcite/rel/type/RelDataTypeFactory.html" title="org.apache.calcite.rel.type中的接口">RelDataTypeFactory</a>&nbsp;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">参数:</span></dt>
<dd><code>typeFactory</code> - Type factory with which to create the type</dd>
<dt><span class="returnLabel">返回:</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="org.apache.calcite.schema中的接口">Statistic</a>&nbsp;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="org.apache.calcite.schema中的枚举">Schema.TableType</a>&nbsp;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&nbsp;isRolledUp(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;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&nbsp;rolledUpColumnValidInsideAgg(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;column,
<a href="../../../../org/apache/calcite/sql/SqlCall.html" title="org.apache.calcite.sql中的类">SqlCall</a>&nbsp;call,
<a href="../../../../org/apache/calcite/sql/SqlNode.html" title="org.apache.calcite.sql中的类">SqlNode</a>&nbsp;parent,
<a href="../../../../org/apache/calcite/config/CalciteConnectionConfig.html" title="org.apache.calcite.config中的接口">CalciteConnectionConfig</a>&nbsp;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">参数:</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="org.apache.calcite.sql中的类"><code>SqlNode</code></a> tree</dd>
<dd><code>config</code> - Config settings. May be null</dd>
<dt><span class="returnLabel">返回:</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="跳过导航链接">跳过导航链接</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="导航">
<li><a href="../../../../overview-summary.html">概览</a></li>
<li><a href="package-summary.html">程序包</a></li>
<li class="navBarCell1Rev">类</li>
<li><a href="package-tree.html">树</a></li>
<li><a href="../../../../deprecated-list.html">已过时</a></li>
<li><a href="../../../../index-all.html">索引</a></li>
<li><a href="../../../../help-doc.html">帮助</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="org.apache.calcite.schema中的接口"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../org/apache/calcite/schema/TableFactory.html" title="org.apache.calcite.schema中的接口"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/schema/Table.html" target="_top">框架</a></li>
<li><a href="Table.html" target="_top">无框架</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">所有类</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>概要:&nbsp;</li>
<li>嵌套&nbsp;|&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.detail">方法</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>