blob: 6e67093efe711038f2a59b0f5889da4ba911e7cf [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_192) on Tue Apr 06 11:46:36 PDT 2021 -->
<title>IcebergTableSource</title>
<meta name="date" content="2021-04-06">
<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="IcebergTableSource";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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/iceberg/flink/IcebergTableSink.html" title="class in org.apache.iceberg.flink"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/iceberg/flink/RowDataWrapper.html" title="class in org.apache.iceberg.flink"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/iceberg/flink/IcebergTableSource.html" target="_top">Frames</a></li>
<li><a href="IcebergTableSource.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.iceberg.flink</div>
<h2 title="Class IcebergTableSource" class="title">Class IcebergTableSource</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.flink.IcebergTableSource</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.apache.flink.table.sources.FilterableTableSource&lt;org.apache.flink.table.data.RowData&gt;, org.apache.flink.table.sources.LimitableTableSource&lt;org.apache.flink.table.data.RowData&gt;, org.apache.flink.table.sources.ProjectableTableSource&lt;org.apache.flink.table.data.RowData&gt;, org.apache.flink.table.sources.StreamTableSource&lt;org.apache.flink.table.data.RowData&gt;, org.apache.flink.table.sources.TableSource&lt;org.apache.flink.table.data.RowData&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">IcebergTableSource</span>
extends java.lang.Object
implements org.apache.flink.table.sources.StreamTableSource&lt;org.apache.flink.table.data.RowData&gt;, org.apache.flink.table.sources.ProjectableTableSource&lt;org.apache.flink.table.data.RowData&gt;, org.apache.flink.table.sources.FilterableTableSource&lt;org.apache.flink.table.data.RowData&gt;, org.apache.flink.table.sources.LimitableTableSource&lt;org.apache.flink.table.data.RowData&gt;</pre>
<div class="block">Flink Iceberg table source.</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/iceberg/flink/IcebergTableSource.html#IcebergTableSource-org.apache.iceberg.flink.TableLoader-org.apache.flink.table.api.TableSchema-java.util.Map-org.apache.flink.configuration.ReadableConfig-">IcebergTableSource</a></span>(<a href="../../../../org/apache/iceberg/flink/TableLoader.html" title="interface in org.apache.iceberg.flink">TableLoader</a>&nbsp;loader,
org.apache.flink.table.api.TableSchema&nbsp;schema,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;properties,
org.apache.flink.configuration.ReadableConfig&nbsp;readableConfig)</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>org.apache.flink.table.sources.TableSource&lt;org.apache.flink.table.data.RowData&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/flink/IcebergTableSource.html#applyLimit-long-">applyLimit</a></span>(long&nbsp;newLimit)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.apache.flink.table.sources.TableSource&lt;org.apache.flink.table.data.RowData&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/flink/IcebergTableSource.html#applyPredicate-java.util.List-">applyPredicate</a></span>(java.util.List&lt;org.apache.flink.table.expressions.Expression&gt;&nbsp;predicates)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/flink/IcebergTableSource.html#explainSource--">explainSource</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.apache.flink.streaming.api.datastream.DataStream&lt;org.apache.flink.table.data.RowData&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/flink/IcebergTableSource.html#getDataStream-org.apache.flink.streaming.api.environment.StreamExecutionEnvironment-">getDataStream</a></span>(org.apache.flink.streaming.api.environment.StreamExecutionEnvironment&nbsp;execEnv)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>org.apache.flink.table.types.DataType</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/flink/IcebergTableSource.html#getProducedDataType--">getProducedDataType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>org.apache.flink.table.api.TableSchema</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/flink/IcebergTableSource.html#getTableSchema--">getTableSchema</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/flink/IcebergTableSource.html#isBounded--">isBounded</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/flink/IcebergTableSource.html#isFilterPushedDown--">isFilterPushedDown</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/flink/IcebergTableSource.html#isLimitPushedDown--">isLimitPushedDown</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>org.apache.flink.table.sources.TableSource&lt;org.apache.flink.table.data.RowData&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/flink/IcebergTableSource.html#projectFields-int:A-">projectFields</a></span>(int[]&nbsp;fields)</code>&nbsp;</td>
</tr>
</table>
<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.flink.table.sources.TableSource">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.flink.table.sources.TableSource</h3>
<code>getReturnType</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="IcebergTableSource-org.apache.iceberg.flink.TableLoader-org.apache.flink.table.api.TableSchema-java.util.Map-org.apache.flink.configuration.ReadableConfig-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IcebergTableSource</h4>
<pre>public&nbsp;IcebergTableSource(<a href="../../../../org/apache/iceberg/flink/TableLoader.html" title="interface in org.apache.iceberg.flink">TableLoader</a>&nbsp;loader,
org.apache.flink.table.api.TableSchema&nbsp;schema,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;properties,
org.apache.flink.configuration.ReadableConfig&nbsp;readableConfig)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isBounded--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBounded</h4>
<pre>public&nbsp;boolean&nbsp;isBounded()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>isBounded</code>&nbsp;in interface&nbsp;<code>org.apache.flink.table.sources.StreamTableSource&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
</dl>
</li>
</ul>
<a name="projectFields-int:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>projectFields</h4>
<pre>public&nbsp;org.apache.flink.table.sources.TableSource&lt;org.apache.flink.table.data.RowData&gt;&nbsp;projectFields(int[]&nbsp;fields)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>projectFields</code>&nbsp;in interface&nbsp;<code>org.apache.flink.table.sources.ProjectableTableSource&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
</dl>
</li>
</ul>
<a name="getDataStream-org.apache.flink.streaming.api.environment.StreamExecutionEnvironment-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataStream</h4>
<pre>public&nbsp;org.apache.flink.streaming.api.datastream.DataStream&lt;org.apache.flink.table.data.RowData&gt;&nbsp;getDataStream(org.apache.flink.streaming.api.environment.StreamExecutionEnvironment&nbsp;execEnv)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getDataStream</code>&nbsp;in interface&nbsp;<code>org.apache.flink.table.sources.StreamTableSource&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
</dl>
</li>
</ul>
<a name="getTableSchema--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableSchema</h4>
<pre>public&nbsp;org.apache.flink.table.api.TableSchema&nbsp;getTableSchema()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getTableSchema</code>&nbsp;in interface&nbsp;<code>org.apache.flink.table.sources.TableSource&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
</dl>
</li>
</ul>
<a name="getProducedDataType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProducedDataType</h4>
<pre>public&nbsp;org.apache.flink.table.types.DataType&nbsp;getProducedDataType()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getProducedDataType</code>&nbsp;in interface&nbsp;<code>org.apache.flink.table.sources.TableSource&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
</dl>
</li>
</ul>
<a name="explainSource--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>explainSource</h4>
<pre>public&nbsp;java.lang.String&nbsp;explainSource()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>explainSource</code>&nbsp;in interface&nbsp;<code>org.apache.flink.table.sources.TableSource&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
</dl>
</li>
</ul>
<a name="isLimitPushedDown--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLimitPushedDown</h4>
<pre>public&nbsp;boolean&nbsp;isLimitPushedDown()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>isLimitPushedDown</code>&nbsp;in interface&nbsp;<code>org.apache.flink.table.sources.LimitableTableSource&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
</dl>
</li>
</ul>
<a name="applyLimit-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyLimit</h4>
<pre>public&nbsp;org.apache.flink.table.sources.TableSource&lt;org.apache.flink.table.data.RowData&gt;&nbsp;applyLimit(long&nbsp;newLimit)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>applyLimit</code>&nbsp;in interface&nbsp;<code>org.apache.flink.table.sources.LimitableTableSource&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
</dl>
</li>
</ul>
<a name="applyPredicate-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyPredicate</h4>
<pre>public&nbsp;org.apache.flink.table.sources.TableSource&lt;org.apache.flink.table.data.RowData&gt;&nbsp;applyPredicate(java.util.List&lt;org.apache.flink.table.expressions.Expression&gt;&nbsp;predicates)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>applyPredicate</code>&nbsp;in interface&nbsp;<code>org.apache.flink.table.sources.FilterableTableSource&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
</dl>
</li>
</ul>
<a name="isFilterPushedDown--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isFilterPushedDown</h4>
<pre>public&nbsp;boolean&nbsp;isFilterPushedDown()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>isFilterPushedDown</code>&nbsp;in interface&nbsp;<code>org.apache.flink.table.sources.FilterableTableSource&lt;org.apache.flink.table.data.RowData&gt;</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/iceberg/flink/IcebergTableSink.html" title="class in org.apache.iceberg.flink"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/iceberg/flink/RowDataWrapper.html" title="class in org.apache.iceberg.flink"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/iceberg/flink/IcebergTableSource.html" target="_top">Frames</a></li>
<li><a href="IcebergTableSource.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>