blob: 9c9ef7700eaf5b82151b33bd0fb76df7ae6145f0 [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_231) on Tue Jan 26 14:32:13 PST 2021 -->
<title>IcebergTableSink</title>
<meta name="date" content="2021-01-26">
<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="IcebergTableSink";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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/FlinkTypeVisitor.html" title="class in org.apache.iceberg.flink"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/iceberg/flink/IcebergTableSource.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/IcebergTableSink.html" target="_top">Frames</a></li>
<li><a href="IcebergTableSink.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 IcebergTableSink" class="title">Class IcebergTableSink</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.flink.IcebergTableSink</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.apache.flink.table.sinks.AppendStreamTableSink&lt;org.apache.flink.table.data.RowData&gt;, org.apache.flink.table.sinks.OverwritableTableSink, org.apache.flink.table.sinks.PartitionableTableSink, org.apache.flink.table.sinks.StreamTableSink&lt;org.apache.flink.table.data.RowData&gt;, org.apache.flink.table.sinks.TableSink&lt;org.apache.flink.table.data.RowData&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">IcebergTableSink</span>
extends java.lang.Object
implements org.apache.flink.table.sinks.AppendStreamTableSink&lt;org.apache.flink.table.data.RowData&gt;, org.apache.flink.table.sinks.OverwritableTableSink, org.apache.flink.table.sinks.PartitionableTableSink</pre>
</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/IcebergTableSink.html#IcebergTableSink-boolean-org.apache.iceberg.flink.TableLoader-org.apache.flink.table.api.TableSchema-">IcebergTableSink</a></span>(boolean&nbsp;isBounded,
<a href="../../../../org/apache/iceberg/flink/TableLoader.html" title="interface in org.apache.iceberg.flink">TableLoader</a>&nbsp;tableLoader,
org.apache.flink.table.api.TableSchema&nbsp;tableSchema)</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.sinks.TableSink&lt;org.apache.flink.table.data.RowData&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/flink/IcebergTableSink.html#configure-java.lang.String:A-org.apache.flink.api.common.typeinfo.TypeInformation:A-">configure</a></span>(java.lang.String[]&nbsp;fieldNames,
org.apache.flink.api.common.typeinfo.TypeInformation&lt;?&gt;[]&nbsp;fieldTypes)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.apache.flink.streaming.api.datastream.DataStreamSink&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/flink/IcebergTableSink.html#consumeDataStream-org.apache.flink.streaming.api.datastream.DataStream-">consumeDataStream</a></span>(org.apache.flink.streaming.api.datastream.DataStream&lt;org.apache.flink.table.data.RowData&gt;&nbsp;dataStream)</code>&nbsp;</td>
</tr>
<tr id="i2" 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/IcebergTableSink.html#getConsumedDataType--">getConsumedDataType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" 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/IcebergTableSink.html#getTableSchema--">getTableSchema</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/flink/IcebergTableSink.html#setOverwrite-boolean-">setOverwrite</a></span>(boolean&nbsp;overwrite)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/flink/IcebergTableSink.html#setStaticPartition-java.util.Map-">setStaticPartition</a></span>(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;partitions)</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.sinks.TableSink">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.flink.table.sinks.TableSink</h3>
<code>getFieldNames, getFieldTypes, getOutputType</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.flink.table.sinks.PartitionableTableSink">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.flink.table.sinks.PartitionableTableSink</h3>
<code>configurePartitionGrouping</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="IcebergTableSink-boolean-org.apache.iceberg.flink.TableLoader-org.apache.flink.table.api.TableSchema-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IcebergTableSink</h4>
<pre>public&nbsp;IcebergTableSink(boolean&nbsp;isBounded,
<a href="../../../../org/apache/iceberg/flink/TableLoader.html" title="interface in org.apache.iceberg.flink">TableLoader</a>&nbsp;tableLoader,
org.apache.flink.table.api.TableSchema&nbsp;tableSchema)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="consumeDataStream-org.apache.flink.streaming.api.datastream.DataStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>consumeDataStream</h4>
<pre>public&nbsp;org.apache.flink.streaming.api.datastream.DataStreamSink&lt;?&gt;&nbsp;consumeDataStream(org.apache.flink.streaming.api.datastream.DataStream&lt;org.apache.flink.table.data.RowData&gt;&nbsp;dataStream)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>consumeDataStream</code>&nbsp;in interface&nbsp;<code>org.apache.flink.table.sinks.StreamTableSink&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
</dl>
</li>
</ul>
<a name="getConsumedDataType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConsumedDataType</h4>
<pre>public&nbsp;org.apache.flink.table.types.DataType&nbsp;getConsumedDataType()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getConsumedDataType</code>&nbsp;in interface&nbsp;<code>org.apache.flink.table.sinks.TableSink&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.sinks.TableSink&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
</dl>
</li>
</ul>
<a name="configure-java.lang.String:A-org.apache.flink.api.common.typeinfo.TypeInformation:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre>public&nbsp;org.apache.flink.table.sinks.TableSink&lt;org.apache.flink.table.data.RowData&gt;&nbsp;configure(java.lang.String[]&nbsp;fieldNames,
org.apache.flink.api.common.typeinfo.TypeInformation&lt;?&gt;[]&nbsp;fieldTypes)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>configure</code>&nbsp;in interface&nbsp;<code>org.apache.flink.table.sinks.TableSink&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
</dl>
</li>
</ul>
<a name="setOverwrite-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOverwrite</h4>
<pre>public&nbsp;void&nbsp;setOverwrite(boolean&nbsp;overwrite)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>setOverwrite</code>&nbsp;in interface&nbsp;<code>org.apache.flink.table.sinks.OverwritableTableSink</code></dd>
</dl>
</li>
</ul>
<a name="setStaticPartition-java.util.Map-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setStaticPartition</h4>
<pre>public&nbsp;void&nbsp;setStaticPartition(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;partitions)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>setStaticPartition</code>&nbsp;in interface&nbsp;<code>org.apache.flink.table.sinks.PartitionableTableSink</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/FlinkTypeVisitor.html" title="class in org.apache.iceberg.flink"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/iceberg/flink/IcebergTableSource.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/IcebergTableSink.html" target="_top">Frames</a></li>
<li><a href="IcebergTableSink.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>