blob: 2c1f90ac23166be5bb6e2179b74573743f3c42ce [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>TableFactory (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: TableFactory">
<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 TableFactory" class="title">Interface TableFactory&lt;T extends <a href="Table.html" title="interface in org.apache.calcite.schema">Table</a>&gt;</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>T</code> - Sub-type of table created by this factory</dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../adapter/csv/CsvStreamTableFactory.html" title="class in org.apache.calcite.adapter.csv">CsvStreamTableFactory</a></code>, <code><a href="../adapter/csv/CsvTableFactory.html" title="class in org.apache.calcite.adapter.csv">CsvTableFactory</a></code>, <code><a href="../adapter/file/CsvTableFactory.html" title="class in org.apache.calcite.adapter.file">CsvTableFactory</a></code>, <code><a href="../adapter/druid/DruidTableFactory.html" title="class in org.apache.calcite.adapter.druid">DruidTableFactory</a></code>, <code><a href="../test/schemata/orderstream/InfiniteOrdersStreamTableFactory.html" title="class in org.apache.calcite.test.schemata.orderstream">InfiniteOrdersStreamTableFactory</a></code>, <code><a href="../adapter/kafka/KafkaTableFactory.html" title="class in org.apache.calcite.adapter.kafka">KafkaTableFactory</a></code>, <code><a href="../test/schemata/orderstream/OrdersStreamTableFactory.html" title="class in org.apache.calcite.test.schemata.orderstream">OrdersStreamTableFactory</a></code>, <code><a href="../adapter/pig/PigTableFactory.html" title="class in org.apache.calcite.adapter.pig">PigTableFactory</a></code>, <code><a href="../chinook/PreferredAlbumsTableFactory.html" title="class in org.apache.calcite.chinook">PreferredAlbumsTableFactory</a></code>, <code><a href="../chinook/PreferredGenresTableFactory.html" title="class in org.apache.calcite.chinook">PreferredGenresTableFactory</a></code>, <code><a href="../test/schemata/orderstream/ProductsTableFactory.html" title="class in org.apache.calcite.test.schemata.orderstream">ProductsTableFactory</a></code>, <code><a href="../adapter/redis/RedisTableFactory.html" title="class in org.apache.calcite.adapter.redis">RedisTableFactory</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">TableFactory&lt;T extends <a href="Table.html" title="interface in org.apache.calcite.schema">Table</a>&gt;</span></div>
<div class="block">Factory for <a href="Table.html" title="interface in org.apache.calcite.schema"><code>Table</code></a> objects.
<p>A table factory allows you to include custom tables in a model file.
For example, here is a model that contains a custom table that generates
a range of integers.</p>
<blockquote><pre>{
version: '1.0',
defaultSchema: 'MATH',
schemas: [
{
name: 'MATH',
tables: [
{
name: 'INTEGERS',
type: 'custom',
factory: 'com.acme.IntegerTable',
operand: {
start: 3,
end: 7,
column: 'N'
}
}
]
}
]
}</pre></blockquote>
<p>Given that schema, the query</p>
<blockquote><pre>SELECT * FROM math.integers</pre></blockquote>
<p>returns</p>
<blockquote><pre>
+---+
| N |
+---+
| 3 |
| 4 |
| 5 |
| 6 |
+---+
</pre></blockquote>
<p>A class that implements TableFactory specified in a schema must have a
public default constructor.</p></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="TableFactory.html" title="type parameter in TableFactory">T</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#create(org.apache.calcite.schema.SchemaPlus,java.lang.String,java.util.Map,org.apache.calcite.rel.type.RelDataType)" class="member-name-link">create</a><wbr>(<a href="SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a>&nbsp;schema,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><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;&nbsp;operand,
@Nullable <a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;rowType)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Creates a Table.</div>
</div>
</div>
</div>
</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="create(org.apache.calcite.schema.SchemaPlus,java.lang.String,java.util.Map,org.apache.calcite.rel.type.RelDataType)">
<h3>create</h3>
<div class="member-signature"><span class="return-type"><a href="TableFactory.html" title="type parameter in TableFactory">T</a></span>&nbsp;<span class="element-name">create</span><wbr><span class="parameters">(<a href="SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a>&nbsp;schema,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><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;&nbsp;operand,
@Nullable <a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;rowType)</span></div>
<div class="block">Creates a Table.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>schema</code> - Schema this table belongs to</dd>
<dd><code>name</code> - Name of this table</dd>
<dd><code>operand</code> - The "operand" JSON property</dd>
<dd><code>rowType</code> - Row type. Specified if the "columns" JSON property.</dd>
<dt>Returns:</dt>
<dd>created table</dd>
</dl>
</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>