blob: 3734f8e1fdfb1c675b7654dfa36896b28121c4b0 [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 (1.8.0_181-google-v7) on Wed Aug 14 17:37:11 PDT 2019 -->
<title>KafkaTableProvider (Apache Beam 2.15.0-SNAPSHOT)</title>
<meta name="date" content="2019-08-14">
<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="KafkaTableProvider (Apache Beam 2.15.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/kafka/BeamKafkaTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.kafka"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/meta/provider/kafka/KafkaTableProvider.html" target="_top">Frames</a></li>
<li><a href="KafkaTableProvider.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.kafka</div>
<h2 title="Class KafkaTableProvider" class="title">Class KafkaTableProvider</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/InMemoryMetaTableProvider.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider">org.apache.beam.sdk.extensions.sql.meta.provider.InMemoryMetaTableProvider</a></li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.extensions.sql.meta.provider.kafka.KafkaTableProvider</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><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></dd>
</dl>
<hr>
<br>
<pre>@AutoService(value=<a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html" title="interface in org.apache.beam.sdk.extensions.sql.meta.provider">TableProvider.class</a>)
public class <span class="typeNameLabel">KafkaTableProvider</span>
extends <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></pre>
<div class="block">Kafka table provider.
<p>A sample of text table is:
<pre><code>
CREATE TABLE ORDERS(
ID INT COMMENT 'this is the primary key',
NAME VARCHAR(127) COMMENT 'this is the name'
)
COMMENT 'this is the table orders'
LOCATION 'kafka://localhost:2181/brokers?topic=test'
TBLPROPERTIES '{"bootstrap.servers":"localhost:9092", "topics": ["topic1", "topic2"]}'
</code></pre></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/kafka/KafkaTableProvider.html#KafkaTableProvider--">KafkaTableProvider</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/BeamSqlTable.html" title="interface in org.apache.beam.sdk.extensions.sql">BeamSqlTable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/kafka/KafkaTableProvider.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/BeamSqlTable.html" title="interface in org.apache.beam.sdk.extensions.sql"><code>BeamSqlTable</code></a> using the given table meta info.</div>
</td>
</tr>
<tr id="i1" 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/kafka/KafkaTableProvider.html#getTableType--">getTableType</a></span>()</code>
<div class="block">Gets the table type this provider handles.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.extensions.sql.meta.provider.InMemoryMetaTableProvider">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.extensions.sql.meta.provider.<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></h3>
<code><a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/InMemoryMetaTableProvider.html#createTable-org.apache.beam.sdk.extensions.sql.meta.Table-">createTable</a>, <a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/InMemoryMetaTableProvider.html#dropTable-java.lang.String-">dropTable</a>, <a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/InMemoryMetaTableProvider.html#getTables--">getTables</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.extensions.sql.meta.provider.TableProvider">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.beam.sdk.extensions.sql.meta.provider.<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></h3>
<code><a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html#getSubProvider-java.lang.String-">getSubProvider</a>, <a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html#getSubProviders--">getSubProviders</a>, <a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html#getTable-java.lang.String-">getTable</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="KafkaTableProvider--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>KafkaTableProvider</h4>
<pre>public&nbsp;KafkaTableProvider()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="buildBeamSqlTable-org.apache.beam.sdk.extensions.sql.meta.Table-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildBeamSqlTable</h4>
<pre>public&nbsp;<a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/BeamSqlTable.html" title="interface in org.apache.beam.sdk.extensions.sql">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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html#buildBeamSqlTable-org.apache.beam.sdk.extensions.sql.meta.Table-">TableProvider</a></code></span></div>
<div class="block">Build a <a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/BeamSqlTable.html" title="interface in org.apache.beam.sdk.extensions.sql"><code>BeamSqlTable</code></a> using the given table meta info.</div>
</li>
</ul>
<a name="getTableType--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTableType</h4>
<pre>public&nbsp;java.lang.String&nbsp;getTableType()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html#getTableType--">TableProvider</a></code></span></div>
<div class="block">Gets the table type this provider handles.</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/kafka/BeamKafkaTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.kafka"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/meta/provider/kafka/KafkaTableProvider.html" target="_top">Frames</a></li>
<li><a href="KafkaTableProvider.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>