blob: 2e949e0acd2763bbccf17f64806b47b9c52a4778 [file] [log] [blame]
<!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 -->
<title>TableProvider (Apache Beam 2.38.0-SNAPSHOT)</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="TableProvider (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":18,"i4":18,"i5":18,"i6":6,"i7":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/SchemaIOTableProviderWrapper.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/UdfUdafProvider.html" title="interface in org.apache.beam.sdk.extensions.sql.meta.provider"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html" target="_top">Frames</a></li>
<li><a href="TableProvider.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;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:&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="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.beam.sdk.extensions.sql.meta.provider</div>
<h2 title="Interface TableProvider" class="title">Interface TableProvider</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/beam/sdk/extensions/sql/meta/CustomTableResolver.html" title="interface in org.apache.beam.sdk.extensions.sql.meta">CustomTableResolver</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/store/MetaStore.html" title="interface in org.apache.beam.sdk.extensions.sql.meta.store">MetaStore</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/avro/AvroTableProvider.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.avro">AvroTableProvider</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/bigquery/BigQueryTableProvider.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.bigquery">BigQueryTableProvider</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/bigtable/BigtableTableProvider.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.bigtable">BigtableTableProvider</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/datacatalog/DataCatalogTableProvider.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.datacatalog">DataCatalogTableProvider</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/datastore/DataStoreV1TableProvider.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.datastore">DataStoreV1TableProvider</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/FullNameTableProvider.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider">FullNameTableProvider</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/seqgen/GenerateSequenceTableProvider.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.seqgen">GenerateSequenceTableProvider</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/store/InMemoryMetaStore.html" title="class in org.apache.beam.sdk.extensions.sql.meta.store">InMemoryMetaStore</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/InMemoryMetaTableProvider.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider">InMemoryMetaTableProvider</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/kafka/KafkaTableProvider.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.kafka">KafkaTableProvider</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/mongodb/MongoDbTableProvider.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.mongodb">MongoDbTableProvider</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/parquet/ParquetTableProvider.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.parquet">ParquetTableProvider</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/pubsublite/PubsubLiteTableProvider.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.pubsublite">PubsubLiteTableProvider</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/pubsub/PubsubTableProvider.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.pubsub">PubsubTableProvider</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/ReadOnlyTableProvider.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider">ReadOnlyTableProvider</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/SchemaIOTableProviderWrapper.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider">SchemaIOTableProviderWrapper</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/test/TestTableProvider.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.test">TestTableProvider</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/text/TextTableProvider.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.text">TextTableProvider</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">TableProvider</span></pre>
<div class="block">A <code>TableProvider</code> handles the metadata CRUD of a specified kind of tables.
<p>So there will be a provider to handle textfile(CSV) based tables, there is a provider to
handle MySQL based tables, a provider to handle Casandra based tables etc.
<p><i>Note:</i> all implementations marked with <code>@AutoService(TableProvider.class)</code> are
automatically loaded by CLI or other cases when <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/JdbcDriver.html" title="class in org.apache.beam.sdk.extensions.sql.impl"><code>JdbcDriver</code></a> is used with default
connection parameters.</div>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</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/beam/sdk/extensions/sql/meta/BeamSqlTable.html" title="interface in org.apache.beam.sdk.extensions.sql.meta">BeamSqlTable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html#buildBeamSqlTable-org.apache.beam.sdk.extensions.sql.meta.Table-">buildBeamSqlTable</a></span>(<a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/Table.html" title="class in org.apache.beam.sdk.extensions.sql.meta">Table</a>&nbsp;table)</code>
<div class="block">Build a <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BeamSqlTable.html" title="interface in org.apache.beam.sdk.extensions.sql.meta"><code>BeamSqlTable</code></a> using the given table meta info.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html#createTable-org.apache.beam.sdk.extensions.sql.meta.Table-">createTable</a></span>(<a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/Table.html" title="class in org.apache.beam.sdk.extensions.sql.meta">Table</a>&nbsp;table)</code>
<div class="block">Creates a table.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html#dropTable-java.lang.String-">dropTable</a></span>(java.lang.String&nbsp;tableName)</code>
<div class="block">Drops a table.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>default <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html" title="interface in org.apache.beam.sdk.extensions.sql.meta.provider">TableProvider</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html#getSubProvider-java.lang.String-">getSubProvider</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Returns a sub-provider, e.g.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>default java.util.Set&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html#getSubProviders--">getSubProviders</a></span>()</code>
<div class="block">Returns all sub-providers, e.g.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>default <a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/Table.html" title="class in org.apache.beam.sdk.extensions.sql.meta">Table</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html#getTable-java.lang.String-">getTable</a></span>(java.lang.String&nbsp;tableName)</code>
<div class="block">Get a specific table from this provider it is present, or null if it is not present.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,<a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/Table.html" title="class in org.apache.beam.sdk.extensions.sql.meta">Table</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html#getTables--">getTables</a></span>()</code>
<div class="block">Get all tables from this provider.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html#getTableType--">getTableType</a></span>()</code>
<div class="block">Gets the table type this provider handles.</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="getTableType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableType</h4>
<pre>java.lang.String&nbsp;getTableType()</pre>
<div class="block">Gets the table type this provider handles.</div>
</li>
</ul>
<a name="createTable-org.apache.beam.sdk.extensions.sql.meta.Table-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTable</h4>
<pre>void&nbsp;createTable(<a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/Table.html" title="class in org.apache.beam.sdk.extensions.sql.meta">Table</a>&nbsp;table)</pre>
<div class="block">Creates a table.</div>
</li>
</ul>
<a name="dropTable-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dropTable</h4>
<pre>void&nbsp;dropTable(java.lang.String&nbsp;tableName)</pre>
<div class="block">Drops a table.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tableName</code> - </dd>
</dl>
</li>
</ul>
<a name="getTables--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTables</h4>
<pre>java.util.Map&lt;java.lang.String,<a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/Table.html" title="class in org.apache.beam.sdk.extensions.sql.meta">Table</a>&gt;&nbsp;getTables()</pre>
<div class="block">Get all tables from this provider.</div>
</li>
</ul>
<a name="getTable-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTable</h4>
<pre>default&nbsp;<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/Table.html" title="class in org.apache.beam.sdk.extensions.sql.meta">Table</a>&nbsp;getTable(java.lang.String&nbsp;tableName)</pre>
<div class="block">Get a specific table from this provider it is present, or null if it is not present.</div>
</li>
</ul>
<a name="buildBeamSqlTable-org.apache.beam.sdk.extensions.sql.meta.Table-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildBeamSqlTable</h4>
<pre><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BeamSqlTable.html" title="interface in org.apache.beam.sdk.extensions.sql.meta">BeamSqlTable</a>&nbsp;buildBeamSqlTable(<a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/Table.html" title="class in org.apache.beam.sdk.extensions.sql.meta">Table</a>&nbsp;table)</pre>
<div class="block">Build a <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BeamSqlTable.html" title="interface in org.apache.beam.sdk.extensions.sql.meta"><code>BeamSqlTable</code></a> using the given table meta info.</div>
</li>
</ul>
<a name="getSubProviders--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSubProviders</h4>
<pre>default&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getSubProviders()</pre>
<div class="block">Returns all sub-providers, e.g. sub-schemas. Temporary, this logic needs to live in <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamCalciteSchema.html" title="class in org.apache.beam.sdk.extensions.sql.impl"><code>BeamCalciteSchema</code></a>.</div>
</li>
</ul>
<a name="getSubProvider-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSubProvider</h4>
<pre>default&nbsp;<a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html" title="interface in org.apache.beam.sdk.extensions.sql.meta.provider">TableProvider</a>&nbsp;getSubProvider(java.lang.String&nbsp;name)</pre>
<div class="block">Returns a sub-provider, e.g. sub-schema. Temporary, this logic needs to live in <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamCalciteSchema.html" title="class in org.apache.beam.sdk.extensions.sql.impl"><code>BeamCalciteSchema</code></a>.</div>
</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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/SchemaIOTableProviderWrapper.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/UdfUdafProvider.html" title="interface in org.apache.beam.sdk.extensions.sql.meta.provider"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html" target="_top">Frames</a></li>
<li><a href="TableProvider.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;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:&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="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>