blob: 19ad37760141e3d086d568dea766806979f3b67e [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_161-google-v7) on Thu Oct 18 16:14:30 PDT 2018 -->
<title>BeamSqlTable (Apache Beam 2.8.0-SNAPSHOT)</title>
<meta name="date" content="2018-10-18">
<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="BeamSqlTable (Apache Beam 2.8.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/BeamSqlSeekableTable.html" title="interface in org.apache.beam.sdk.extensions.sql"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/extensions/sql/BeamSqlUdf.html" title="interface in org.apache.beam.sdk.extensions.sql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/sql/BeamSqlTable.html" target="_top">Frames</a></li>
<li><a href="BeamSqlTable.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</div>
<h2 title="Interface BeamSqlTable" class="title">Interface BeamSqlTable</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/beam/sdk/extensions/sql/impl/schema/BaseBeamTable.html" title="class in org.apache.beam.sdk.extensions.sql.impl.schema">BaseBeamTable</a>, <a href="../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/bigquery/BeamBigQueryTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.bigquery">BeamBigQueryTable</a>, <a href="../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/kafka/BeamKafkaCSVTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.kafka">BeamKafkaCSVTable</a>, <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">BeamKafkaTable</a>, <a href="../../../../../../org/apache/beam/sdk/extensions/sql/impl/schema/BeamPCollectionTable.html" title="class in org.apache.beam.sdk.extensions.sql.impl.schema">BeamPCollectionTable</a>, <a href="../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/test/TestBoundedTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.test">TestBoundedTable</a>, <a href="../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/test/TestTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.test">TestTable</a>, <a href="../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/test/TestUnboundedTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.test">TestUnboundedTable</a>, <a href="../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/text/TextTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.text">TextTable</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">BeamSqlTable</span></pre>
<div class="block">This interface defines a Beam Sql Table.</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></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/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sql/BeamSqlTable.html#buildIOReader-org.apache.beam.sdk.values.PBegin-">buildIOReader</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>&nbsp;begin)</code>
<div class="block">create a <code>PCollection&lt;Row&gt;</code> from source.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sql/BeamSqlTable.html#buildIOWriter-org.apache.beam.sdk.values.PCollection-">buildIOWriter</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>&gt;&nbsp;input)</code>
<div class="block">create a <code>IO.write()</code> instance to write to target.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sql/BeamSqlTable.html#getSchema--">getSchema</a></span>()</code>
<div class="block">Get the schema info of the table.</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="buildIOReader-org.apache.beam.sdk.values.PBegin-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildIOReader</h4>
<pre><a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>&gt;&nbsp;buildIOReader(<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>&nbsp;begin)</pre>
<div class="block">create a <code>PCollection&lt;Row&gt;</code> from source.</div>
</li>
</ul>
<a name="buildIOWriter-org.apache.beam.sdk.values.PCollection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildIOWriter</h4>
<pre><a href="../../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>&nbsp;buildIOWriter(<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>&gt;&nbsp;input)</pre>
<div class="block">create a <code>IO.write()</code> instance to write to target.</div>
</li>
</ul>
<a name="getSchema--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSchema</h4>
<pre><a href="../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a>&nbsp;getSchema()</pre>
<div class="block">Get the schema info of the table.</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/BeamSqlSeekableTable.html" title="interface in org.apache.beam.sdk.extensions.sql"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/extensions/sql/BeamSqlUdf.html" title="interface in org.apache.beam.sdk.extensions.sql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/sql/BeamSqlTable.html" target="_top">Frames</a></li>
<li><a href="BeamSqlTable.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>