blob: 6599ec69f8a919cee7f6b9ce86892c8f21d1159f [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>FanoutPositionOnlyDeleteWriter</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FanoutPositionOnlyDeleteWriter";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":42,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.iceberg.io</a></div>
<h2 title="Class FanoutPositionOnlyDeleteWriter" class="title">Class FanoutPositionOnlyDeleteWriter&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.io.FanoutPositionOnlyDeleteWriter&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Closeable</code>, <code>java.lang.AutoCloseable</code>, <code><a href="PartitioningWriter.html" title="interface in org.apache.iceberg.io">PartitioningWriter</a>&lt;<a href="../deletes/PositionDelete.html" title="class in org.apache.iceberg.deletes">PositionDelete</a>&lt;T&gt;,&#8203;<a href="DeleteWriteResult.html" title="class in org.apache.iceberg.io">DeleteWriteResult</a>&gt;</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">FanoutPositionOnlyDeleteWriter&lt;T&gt;</span>
extends java.lang.Object</pre>
<div class="block">A position delete writer capable of writing to multiple specs and partitions if the incoming
stream of deletes is not ordered. If the incoming records are ordered by an external process, use
<a href="ClusteredPositionDeleteWriter.html" title="class in org.apache.iceberg.io"><code>ClusteredPositionDeleteWriter</code></a> instead.
<p>Note this writer stores only positions. It does not store deleted records.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.iceberg.io.FileWriterFactory,org.apache.iceberg.io.OutputFileFactory,org.apache.iceberg.io.FileIO,long)">FanoutPositionOnlyDeleteWriter</a></span>&#8203;(<a href="FileWriterFactory.html" title="interface in org.apache.iceberg.io">FileWriterFactory</a>&lt;<a href="FanoutPositionOnlyDeleteWriter.html" title="type parameter in FanoutPositionOnlyDeleteWriter">T</a>&gt;&nbsp;writerFactory,
<a href="OutputFileFactory.html" title="class in org.apache.iceberg.io">OutputFileFactory</a>&nbsp;fileFactory,
<a href="FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a>&nbsp;io,
long&nbsp;targetFileSizeInBytes)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addResult(org.apache.iceberg.io.DeleteWriteResult)">addResult</a></span>&#8203;(<a href="DeleteWriteResult.html" title="class in org.apache.iceberg.io">DeleteWriteResult</a>&nbsp;result)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="DeleteWriteResult.html" title="class in org.apache.iceberg.io">DeleteWriteResult</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#aggregatedResult()">aggregatedResult</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <a href="../encryption/EncryptedOutputFile.html" title="interface in org.apache.iceberg.encryption">EncryptedOutputFile</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newOutputFile(org.apache.iceberg.io.OutputFileFactory,org.apache.iceberg.PartitionSpec,org.apache.iceberg.StructLike)">newOutputFile</a></span>&#8203;(<a href="OutputFileFactory.html" title="class in org.apache.iceberg.io">OutputFileFactory</a>&nbsp;fileFactory,
<a href="../PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a>&nbsp;spec,
<a href="../StructLike.html" title="interface in org.apache.iceberg">StructLike</a>&nbsp;partition)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">will be removed in 1.5.0</div>
</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected <a href="FileWriter.html" title="interface in org.apache.iceberg.io">FileWriter</a>&lt;<a href="../deletes/PositionDelete.html" title="class in org.apache.iceberg.deletes">PositionDelete</a>&lt;<a href="FanoutPositionOnlyDeleteWriter.html" title="type parameter in FanoutPositionOnlyDeleteWriter">T</a>&gt;,&#8203;<a href="DeleteWriteResult.html" title="class in org.apache.iceberg.io">DeleteWriteResult</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newWriter(org.apache.iceberg.PartitionSpec,org.apache.iceberg.StructLike)">newWriter</a></span>&#8203;(<a href="../PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a>&nbsp;spec,
<a href="../StructLike.html" title="interface in org.apache.iceberg">StructLike</a>&nbsp;partition)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>R</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#result()">result</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a result that contains information about written <a href="../DataFile.html" title="interface in org.apache.iceberg"><code>DataFile</code></a>s or <a href="../DeleteFile.html" title="interface in org.apache.iceberg"><code>DeleteFile</code></a>s.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#write(T,org.apache.iceberg.PartitionSpec,org.apache.iceberg.StructLike)">write</a></span>&#8203;(T&nbsp;row,
<a href="../PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a>&nbsp;spec,
<a href="../StructLike.html" title="interface in org.apache.iceberg">StructLike</a>&nbsp;partition)</code></th>
<td class="colLast">
<div class="block">Writes a row to the provided spec/partition.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="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>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.apache.iceberg.io.FileWriterFactory,org.apache.iceberg.io.OutputFileFactory,org.apache.iceberg.io.FileIO,long)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FanoutPositionOnlyDeleteWriter</h4>
<pre>public&nbsp;FanoutPositionOnlyDeleteWriter&#8203;(<a href="FileWriterFactory.html" title="interface in org.apache.iceberg.io">FileWriterFactory</a>&lt;<a href="FanoutPositionOnlyDeleteWriter.html" title="type parameter in FanoutPositionOnlyDeleteWriter">T</a>&gt;&nbsp;writerFactory,
<a href="OutputFileFactory.html" title="class in org.apache.iceberg.io">OutputFileFactory</a>&nbsp;fileFactory,
<a href="FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a>&nbsp;io,
long&nbsp;targetFileSizeInBytes)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="newWriter(org.apache.iceberg.PartitionSpec,org.apache.iceberg.StructLike)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newWriter</h4>
<pre class="methodSignature">protected&nbsp;<a href="FileWriter.html" title="interface in org.apache.iceberg.io">FileWriter</a>&lt;<a href="../deletes/PositionDelete.html" title="class in org.apache.iceberg.deletes">PositionDelete</a>&lt;<a href="FanoutPositionOnlyDeleteWriter.html" title="type parameter in FanoutPositionOnlyDeleteWriter">T</a>&gt;,&#8203;<a href="DeleteWriteResult.html" title="class in org.apache.iceberg.io">DeleteWriteResult</a>&gt;&nbsp;newWriter&#8203;(<a href="../PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a>&nbsp;spec,
<a href="../StructLike.html" title="interface in org.apache.iceberg">StructLike</a>&nbsp;partition)</pre>
</li>
</ul>
<a id="addResult(org.apache.iceberg.io.DeleteWriteResult)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addResult</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;addResult&#8203;(<a href="DeleteWriteResult.html" title="class in org.apache.iceberg.io">DeleteWriteResult</a>&nbsp;result)</pre>
</li>
</ul>
<a id="aggregatedResult()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>aggregatedResult</h4>
<pre class="methodSignature">protected&nbsp;<a href="DeleteWriteResult.html" title="class in org.apache.iceberg.io">DeleteWriteResult</a>&nbsp;aggregatedResult()</pre>
</li>
</ul>
<a id="write(java.lang.Object,org.apache.iceberg.PartitionSpec,org.apache.iceberg.StructLike)">
<!-- -->
</a><a id="write(T,org.apache.iceberg.PartitionSpec,org.apache.iceberg.StructLike)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;write&#8203;(T&nbsp;row,
<a href="../PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a>&nbsp;spec,
<a href="../StructLike.html" title="interface in org.apache.iceberg">StructLike</a>&nbsp;partition)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="PartitioningWriter.html#write(T,org.apache.iceberg.PartitionSpec,org.apache.iceberg.StructLike)">PartitioningWriter</a></code></span></div>
<div class="block">Writes a row to the provided spec/partition.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="PartitioningWriter.html#write(T,org.apache.iceberg.PartitionSpec,org.apache.iceberg.StructLike)">write</a></code>&nbsp;in interface&nbsp;<code><a href="PartitioningWriter.html" title="interface in org.apache.iceberg.io">PartitioningWriter</a>&lt;T,&#8203;R&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>row</code> - a data or delete record</dd>
<dd><code>spec</code> - a partition spec</dd>
<dd><code>partition</code> - a partition or null if the spec is unpartitioned</dd>
</dl>
</li>
</ul>
<a id="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close()
throws java.io.IOException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a id="result()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>result</h4>
<pre class="methodSignature">public final&nbsp;R&nbsp;result()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="PartitioningWriter.html#result()">PartitioningWriter</a></code></span></div>
<div class="block">Returns a result that contains information about written <a href="../DataFile.html" title="interface in org.apache.iceberg"><code>DataFile</code></a>s or <a href="../DeleteFile.html" title="interface in org.apache.iceberg"><code>DeleteFile</code></a>s. The result is valid only after the writer is closed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="PartitioningWriter.html#result()">result</a></code>&nbsp;in interface&nbsp;<code><a href="PartitioningWriter.html" title="interface in org.apache.iceberg.io">PartitioningWriter</a>&lt;T,&#8203;R&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the writer result</dd>
</dl>
</li>
</ul>
<a id="newOutputFile(org.apache.iceberg.io.OutputFileFactory,org.apache.iceberg.PartitionSpec,org.apache.iceberg.StructLike)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>newOutputFile</h4>
<pre class="methodSignature">@Deprecated
protected&nbsp;<a href="../encryption/EncryptedOutputFile.html" title="interface in org.apache.iceberg.encryption">EncryptedOutputFile</a>&nbsp;newOutputFile&#8203;(<a href="OutputFileFactory.html" title="class in org.apache.iceberg.io">OutputFileFactory</a>&nbsp;fileFactory,
<a href="../PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a>&nbsp;spec,
<a href="../StructLike.html" title="interface in org.apache.iceberg">StructLike</a>&nbsp;partition)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">will be removed in 1.5.0</div>
</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>