blob: e6b66bd00611d3644e9feb013fdc83c34092c4e7 [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 Mon Jan 27 16:42:28 PST 2020 -->
<title>SchemaBaseBeamTable (Apache Beam 2.20.0-SNAPSHOT)</title>
<meta name="date" content="2020-01-27">
<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="SchemaBaseBeamTable (Apache Beam 2.20.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":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/ProjectSupport.html" title="enum in org.apache.beam.sdk.extensions.sql.meta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/Table.html" title="class in org.apache.beam.sdk.extensions.sql.meta"><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/SchemaBaseBeamTable.html" target="_top">Frames</a></li>
<li><a href="SchemaBaseBeamTable.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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</div>
<h2 title="Class SchemaBaseBeamTable" class="title">Class SchemaBaseBeamTable</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/BaseBeamTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta">org.apache.beam.sdk.extensions.sql.meta.BaseBeamTable</a></li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.extensions.sql.meta.SchemaBaseBeamTable</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BeamSqlTable.html" title="interface in org.apache.beam.sdk.extensions.sql.meta">BeamSqlTable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/avro/AvroTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.avro">AvroTable</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/mongodb/MongoDbTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.mongodb">MongoDbTable</a>, <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/parquet/ParquetTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.parquet">ParquetTable</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/text/TextTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.text">TextTable</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">SchemaBaseBeamTable</span>
extends <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BaseBeamTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta">BaseBeamTable</a>
implements java.io.Serializable</pre>
<div class="block">Each IO in Beam has one table schema, by extending <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/SchemaBaseBeamTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta"><code>SchemaBaseBeamTable</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../serialized-form.html#org.apache.beam.sdk.extensions.sql.meta.SchemaBaseBeamTable">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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/meta/SchemaBaseBeamTable.html#schema">schema</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/SchemaBaseBeamTable.html#SchemaBaseBeamTable-org.apache.beam.sdk.schemas.Schema-">SchemaBaseBeamTable</a></span>(<a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a>&nbsp;schema)</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/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/meta/SchemaBaseBeamTable.html#getSchema--">getSchema</a></span>()</code>
<div class="block">Get the schema info of the table.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.extensions.sql.meta.BaseBeamTable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.extensions.sql.meta.<a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BaseBeamTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta">BaseBeamTable</a></h3>
<code><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BaseBeamTable.html#buildIOReader-org.apache.beam.sdk.values.PBegin-org.apache.beam.sdk.extensions.sql.meta.BeamSqlTableFilter-java.util.List-">buildIOReader</a>, <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BaseBeamTable.html#constructFilter-java.util.List-">constructFilter</a>, <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BaseBeamTable.html#supportsProjects--">supportsProjects</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.BeamSqlTable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.beam.sdk.extensions.sql.meta.<a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BeamSqlTable.html" title="interface in org.apache.beam.sdk.extensions.sql.meta">BeamSqlTable</a></h3>
<code><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BeamSqlTable.html#buildIOReader-org.apache.beam.sdk.values.PBegin-">buildIOReader</a>, <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BeamSqlTable.html#buildIOWriter-org.apache.beam.sdk.values.PCollection-">buildIOWriter</a>, <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BeamSqlTable.html#getTableStatistics-org.apache.beam.sdk.options.PipelineOptions-">getTableStatistics</a>, <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BeamSqlTable.html#isBounded--">isBounded</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="schema">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>schema</h4>
<pre>protected&nbsp;<a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> schema</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SchemaBaseBeamTable-org.apache.beam.sdk.schemas.Schema-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SchemaBaseBeamTable</h4>
<pre>public&nbsp;SchemaBaseBeamTable(<a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a>&nbsp;schema)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getSchema--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSchema</h4>
<pre>public&nbsp;<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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BeamSqlTable.html#getSchema--">BeamSqlTable</a></code></span></div>
<div class="block">Get the schema info of the table.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BeamSqlTable.html#getSchema--">getSchema</a></code>&nbsp;in interface&nbsp;<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></dd>
</dl>
</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/ProjectSupport.html" title="enum in org.apache.beam.sdk.extensions.sql.meta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/Table.html" title="class in org.apache.beam.sdk.extensions.sql.meta"><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/SchemaBaseBeamTable.html" target="_top">Frames</a></li>
<li><a href="SchemaBaseBeamTable.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>