javadocAggregate/org/apache/calcite/schema/ScannableTable.html - calcite-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>ScannableTable (Apache Calcite API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: package: org.apache.calcite.schema, interface: ScannableTable">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var evenRowColor = "even-row-color";
 var oddRowColor = "odd-row-color";
 var tableTab = "table-tab";
 var activeTableTab = "active-table-tab";
 var pathtoroot = "../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top">
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <div class="about-language"><b>Apache Calcite</b></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">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#class">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
 <div>
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </div>
 <div class="nav-list-search"><label for="search-input">SEARCH:</label>
 <input type="text" id="search-input" value="search" disabled="disabled">
 <input type="reset" id="reset-button" value="reset" disabled="disabled">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.schema</a></div>
 <h1 title="Interface ScannableTable" class="title">Interface ScannableTable</h1>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Superinterfaces:</dt>
 <dd><code><a href="Table.html" title="interface in org.apache.calcite.schema">Table</a></code></dd>
 </dl>
 <dl class="notes">
 <dt>All Known Implementing Classes:</dt>
 <dd><code><a href="../test/schemata/orderstream/BaseOrderStreamTable.html" title="class in org.apache.calcite.test.schemata.orderstream">BaseOrderStreamTable</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/geode/simple/GeodeSimpleScannableTable.html" title="class in org.apache.calcite.adapter.geode.simple">GeodeSimpleScannableTable</a></code>, <code><a href="../test/schemata/orderstream/InfiniteOrdersTable.html" title="class in org.apache.calcite.test.schemata.orderstream">InfiniteOrdersTable</a></code>, <code><a href="../adapter/jdbc/JdbcTable.html" title="class in org.apache.calcite.adapter.jdbc">JdbcTable</a></code>, <code><a href="../adapter/file/JsonScannableTable.html" title="class in org.apache.calcite.adapter.file">JsonScannableTable</a></code>, <code><a href="../adapter/kafka/KafkaStreamTable.html" title="class in org.apache.calcite.adapter.kafka">KafkaStreamTable</a></code>, <code><a href="impl/ListTransientTable.html" title="class in org.apache.calcite.schema.impl">ListTransientTable</a></code>, <code><a href="../example/maze/MazeTable.html" title="class in org.apache.calcite.example.maze">MazeTable</a></code>, <code><a href="../test/schemata/orderstream/OrdersHistoryTable.html" title="class in org.apache.calcite.test.schemata.orderstream">OrdersHistoryTable</a></code>, <code><a href="../test/schemata/orderstream/OrdersTable.html" title="class in org.apache.calcite.test.schemata.orderstream">OrdersTable</a></code>, <code><a href="../piglet/PigTable.html" title="class in org.apache.calcite.piglet">PigTable</a></code>, <code><a href="../test/schemata/orderstream/ProductsTable.html" title="class in org.apache.calcite.test.schemata.orderstream">ProductsTable</a></code>, <code><a href="../adapter/redis/RedisTable.html" title="class in org.apache.calcite.adapter.redis">RedisTable</a></code>, <code><a href="../util/Smalls.MazeTable.html" title="class in org.apache.calcite.util">Smalls.MazeTable</a></code>, <code><a href="../sql/fun/SqlSpatialTypeFunctions.ExplodeTable.html" title="class in org.apache.calcite.sql.fun">SqlSpatialTypeFunctions.ExplodeTable</a></code>, <code><a href="../sql/fun/SqlSpatialTypeFunctions.GridTable.html" title="class in org.apache.calcite.sql.fun">SqlSpatialTypeFunctions.GridTable</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ScannableTable</span><span class="extends-implements">
 extends <a href="Table.html" title="interface in org.apache.calcite.schema">Table</a></span></div>
 <div class="block">Table that can be scanned without creating an intermediate relational
  expression.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../linq4j/Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]&gt;</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#scan(org.apache.calcite.DataContext)" class="member-name-link">scan</a><wbr>(<a href="../DataContext.html" title="interface in org.apache.calcite">DataContext</a>&nbsp;root)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Returns an enumerator over the rows in this Table.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.calcite.schema.Table">Methods inherited from interface&nbsp;org.apache.calcite.schema.<a href="Table.html" title="interface in org.apache.calcite.schema">Table</a></h3>
 <code><a href="Table.html#getJdbcTableType()">getJdbcTableType</a>, <a href="Table.html#getRowType(org.apache.calcite.rel.type.RelDataTypeFactory)">getRowType</a>, <a href="Table.html#getStatistic()">getStatistic</a>, <a href="Table.html#isRolledUp(java.lang.String)">isRolledUp</a>, <a href="Table.html#rolledUpColumnValidInsideAgg(java.lang.String,org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.SqlNode,org.apache.calcite.config.CalciteConnectionConfig)">rolledUpColumnValidInsideAgg</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="scan(org.apache.calcite.DataContext)">
 <h3>scan</h3>
 <div class="member-signature"><span class="return-type"><a href="../linq4j/Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]&gt;</span>&nbsp;<span class="element-name">scan</span><wbr><span class="parameters">(<a href="../DataContext.html" title="interface in org.apache.calcite">DataContext</a>&nbsp;root)</span></div>
 <div class="block">Returns an enumerator over the rows in this Table. Each row is represented
  as an array of its column values.</div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>
	<!DOCTYPE HTML>
	<html lang="en">
	<head>
	<!-- Generated by javadoc (17) -->
	<title>ScannableTable (Apache Calcite API)</title>
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	<meta name="description" content="declaration: package: org.apache.calcite.schema, interface: ScannableTable">
	<meta name="generator" content="javadoc/ClassWriterImpl">
	<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
	<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
	<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
	<script type="text/javascript" src="../../../../script.js"></script>
	<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
	<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
	</head>
	<body class="class-declaration-page">
	<script type="text/javascript">var evenRowColor = "even-row-color";
	var oddRowColor = "odd-row-color";
	var tableTab = "table-tab";
	var activeTableTab = "active-table-tab";
	var pathtoroot = "../../../../";
	loadScripts(document, 'script');</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	<div class="flex-box">
	<header role="banner" class="flex-header">
	<nav role="navigation">
	<!-- ========= START OF TOP NAVBAR ======= -->
	<div class="top-nav" id="navbar-top">
	<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
	<div class="about-language"><b>Apache Calcite</b></div>
	<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
	<li><a href="../../../../index.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="nav-bar-cell1-rev">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#class">Help</a></li>
	</ul>
	</div>
	<div class="sub-nav">
	<div>
	<ul class="sub-nav-list">
	<li>Summary: </li>
	<li>Nested \| </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method-summary">Method</a></li>
	</ul>
	<ul class="sub-nav-list">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method-detail">Method</a></li>
	</ul>
	</div>
	<div class="nav-list-search"><label for="search-input">SEARCH:</label>
	<input type="text" id="search-input" value="search" disabled="disabled">
	<input type="reset" id="reset-button" value="reset" disabled="disabled">
	</div>
	</div>
	<!-- ========= END OF TOP NAVBAR ========= -->
	<span class="skip-nav" id="skip-navbar-top"></span></nav>
	</header>
	<div class="flex-content">
	<main role="main">
	<!-- ======== START OF CLASS DATA ======== -->
	<div class="header">
	<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.schema</a></div>
	<h1 title="Interface ScannableTable" class="title">Interface ScannableTable</h1>
	</div>
	<section class="class-description" id="class-description">
	<dl class="notes">
	<dt>All Superinterfaces:</dt>
	<dd><code><a href="Table.html" title="interface in org.apache.calcite.schema">Table</a></code></dd>
	</dl>
	<dl class="notes">
	<dt>All Known Implementing Classes:</dt>
	<dd><code><a href="../test/schemata/orderstream/BaseOrderStreamTable.html" title="class in org.apache.calcite.test.schemata.orderstream">BaseOrderStreamTable</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/geode/simple/GeodeSimpleScannableTable.html" title="class in org.apache.calcite.adapter.geode.simple">GeodeSimpleScannableTable</a></code>, <code><a href="../test/schemata/orderstream/InfiniteOrdersTable.html" title="class in org.apache.calcite.test.schemata.orderstream">InfiniteOrdersTable</a></code>, <code><a href="../adapter/jdbc/JdbcTable.html" title="class in org.apache.calcite.adapter.jdbc">JdbcTable</a></code>, <code><a href="../adapter/file/JsonScannableTable.html" title="class in org.apache.calcite.adapter.file">JsonScannableTable</a></code>, <code><a href="../adapter/kafka/KafkaStreamTable.html" title="class in org.apache.calcite.adapter.kafka">KafkaStreamTable</a></code>, <code><a href="impl/ListTransientTable.html" title="class in org.apache.calcite.schema.impl">ListTransientTable</a></code>, <code><a href="../example/maze/MazeTable.html" title="class in org.apache.calcite.example.maze">MazeTable</a></code>, <code><a href="../test/schemata/orderstream/OrdersHistoryTable.html" title="class in org.apache.calcite.test.schemata.orderstream">OrdersHistoryTable</a></code>, <code><a href="../test/schemata/orderstream/OrdersTable.html" title="class in org.apache.calcite.test.schemata.orderstream">OrdersTable</a></code>, <code><a href="../piglet/PigTable.html" title="class in org.apache.calcite.piglet">PigTable</a></code>, <code><a href="../test/schemata/orderstream/ProductsTable.html" title="class in org.apache.calcite.test.schemata.orderstream">ProductsTable</a></code>, <code><a href="../adapter/redis/RedisTable.html" title="class in org.apache.calcite.adapter.redis">RedisTable</a></code>, <code><a href="../util/Smalls.MazeTable.html" title="class in org.apache.calcite.util">Smalls.MazeTable</a></code>, <code><a href="../sql/fun/SqlSpatialTypeFunctions.ExplodeTable.html" title="class in org.apache.calcite.sql.fun">SqlSpatialTypeFunctions.ExplodeTable</a></code>, <code><a href="../sql/fun/SqlSpatialTypeFunctions.GridTable.html" title="class in org.apache.calcite.sql.fun">SqlSpatialTypeFunctions.GridTable</a></code></dd>
	</dl>
	<hr>
	<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ScannableTable</span><span class="extends-implements">
	extends <a href="Table.html" title="interface in org.apache.calcite.schema">Table</a></span></div>
	<div class="block">Table that can be scanned without creating an intermediate relational
	expression.</div>
	</section>
	<section class="summary">
	<ul class="summary-list">
	<!-- ========== METHOD SUMMARY =========== -->
	<li>
	<section class="method-summary" id="method-summary">
	<h2>Method Summary</h2>
	<div id="method-summary-table">
	<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
	<div id="method-summary-table.tabpanel" role="tabpanel">
	<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
	<div class="table-header col-first">Modifier and Type</div>
	<div class="table-header col-second">Method</div>
	<div class="table-header col-last">Description</div>
	<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../linq4j/Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a><@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]></code></div>
	<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#scan(org.apache.calcite.DataContext)" class="member-name-link">scan</a><wbr>(<a href="../DataContext.html" title="interface in org.apache.calcite">DataContext</a> root)</code></div>
	<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
	<div class="block">Returns an enumerator over the rows in this Table.</div>
	</div>
	</div>
	</div>
	</div>
	<div class="inherited-list">
	<h3 id="methods-inherited-from-class-org.apache.calcite.schema.Table">Methods inherited from interface org.apache.calcite.schema.<a href="Table.html" title="interface in org.apache.calcite.schema">Table</a></h3>
	<code><a href="Table.html#getJdbcTableType()">getJdbcTableType</a>, <a href="Table.html#getRowType(org.apache.calcite.rel.type.RelDataTypeFactory)">getRowType</a>, <a href="Table.html#getStatistic()">getStatistic</a>, <a href="Table.html#isRolledUp(java.lang.String)">isRolledUp</a>, <a href="Table.html#rolledUpColumnValidInsideAgg(java.lang.String,org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.SqlNode,org.apache.calcite.config.CalciteConnectionConfig)">rolledUpColumnValidInsideAgg</a></code></div>
	</section>
	</li>
	</ul>
	</section>
	<section class="details">
	<ul class="details-list">
	<!-- ============ METHOD DETAIL ========== -->
	<li>
	<section class="method-details" id="method-detail">
	<h2>Method Details</h2>
	<ul class="member-list">
	<li>
	<section class="detail" id="scan(org.apache.calcite.DataContext)">
	<h3>scan</h3>
	<div class="member-signature"><span class="return-type"><a href="../linq4j/Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a><@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]></span> <span class="element-name">scan</span><wbr><span class="parameters">(<a href="../DataContext.html" title="interface in org.apache.calcite">DataContext</a> root)</span></div>
	<div class="block">Returns an enumerator over the rows in this Table. Each row is represented
	as an array of its column values.</div>
	</section>
	</li>
	</ul>
	</section>
	</li>
	</ul>
	</section>
	<!-- ========= END OF CLASS DATA ========= -->
	</main>
	<footer role="contentinfo">
	<hr>
	<p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
	</footer>
	</div>
	</div>
	</body>
	</html>