blob: 12d65d6af9640b9f9cd7b1f9149da44d0e0331a5 [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 -->
<title>RollingManifestWriter</title>
<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="RollingManifestWriter";
}
}
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/RewriteManifests.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/apache/iceberg/RowDelta.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/iceberg/RollingManifestWriter.html" target="_top">Frames</a></li>
<li><a href="RollingManifestWriter.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</div>
<h2 title="Class RollingManifestWriter" class="title">Class RollingManifestWriter&lt;F extends <a href="../../../org/apache/iceberg/ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a>&lt;F&gt;&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.RollingManifestWriter&lt;F&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Closeable, java.lang.AutoCloseable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">RollingManifestWriter&lt;F extends <a href="../../../org/apache/iceberg/ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a>&lt;F&gt;&gt;</span>
extends java.lang.Object
implements java.io.Closeable</pre>
<div class="block">As opposed to <a href="../../../org/apache/iceberg/ManifestWriter.html" title="class in org.apache.iceberg"><code>ManifestWriter</code></a>, a rolling writer could produce multiple manifest files.</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/RollingManifestWriter.html#RollingManifestWriter-java.util.function.Supplier-long-">RollingManifestWriter</a></span>(java.util.function.Supplier&lt;<a href="../../../org/apache/iceberg/ManifestWriter.html" title="class in org.apache.iceberg">ManifestWriter</a>&lt;<a href="../../../org/apache/iceberg/RollingManifestWriter.html" title="type parameter in RollingManifestWriter">F</a>&gt;&gt;&nbsp;manifestWriterSupplier,
long&nbsp;targetFileSizeInBytes)</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/RollingManifestWriter.html#add-F-">add</a></span>(<a href="../../../org/apache/iceberg/RollingManifestWriter.html" title="type parameter in RollingManifestWriter">F</a>&nbsp;addedFile)</code>
<div class="block">Add an added entry for a file.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/RollingManifestWriter.html#add-F-long-">add</a></span>(<a href="../../../org/apache/iceberg/RollingManifestWriter.html" title="type parameter in RollingManifestWriter">F</a>&nbsp;addedFile,
long&nbsp;dataSequenceNumber)</code>
<div class="block">Add an added entry for a file with a specific sequence number.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/RollingManifestWriter.html#close--">close</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/RollingManifestWriter.html#delete-F-long-java.lang.Long-">delete</a></span>(<a href="../../../org/apache/iceberg/RollingManifestWriter.html" title="type parameter in RollingManifestWriter">F</a>&nbsp;deletedFile,
long&nbsp;dataSequenceNumber,
java.lang.Long&nbsp;fileSequenceNumber)</code>
<div class="block">Add a delete entry for a file.</div>
</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/RollingManifestWriter.html#existing-F-long-long-java.lang.Long-">existing</a></span>(<a href="../../../org/apache/iceberg/RollingManifestWriter.html" title="type parameter in RollingManifestWriter">F</a>&nbsp;existingFile,
long&nbsp;fileSnapshotId,
long&nbsp;dataSequenceNumber,
java.lang.Long&nbsp;fileSequenceNumber)</code>
<div class="block">Add an existing entry for a file.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../org/apache/iceberg/ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/RollingManifestWriter.html#toManifestFiles--">toManifestFiles</a></span>()</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>
</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="RollingManifestWriter-java.util.function.Supplier-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RollingManifestWriter</h4>
<pre>public&nbsp;RollingManifestWriter(java.util.function.Supplier&lt;<a href="../../../org/apache/iceberg/ManifestWriter.html" title="class in org.apache.iceberg">ManifestWriter</a>&lt;<a href="../../../org/apache/iceberg/RollingManifestWriter.html" title="type parameter in RollingManifestWriter">F</a>&gt;&gt;&nbsp;manifestWriterSupplier,
long&nbsp;targetFileSizeInBytes)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="add-org.apache.iceberg.ContentFile-">
<!-- -->
</a><a name="add-F-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public&nbsp;void&nbsp;add(<a href="../../../org/apache/iceberg/RollingManifestWriter.html" title="type parameter in RollingManifestWriter">F</a>&nbsp;addedFile)</pre>
<div class="block">Add an added entry for a file.
<p>The entry's snapshot ID will be this manifest's snapshot ID. The data and file sequence
numbers will be assigned at commit.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>addedFile</code> - a data file</dd>
</dl>
</li>
</ul>
<a name="add-org.apache.iceberg.ContentFile-long-">
<!-- -->
</a><a name="add-F-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public&nbsp;void&nbsp;add(<a href="../../../org/apache/iceberg/RollingManifestWriter.html" title="type parameter in RollingManifestWriter">F</a>&nbsp;addedFile,
long&nbsp;dataSequenceNumber)</pre>
<div class="block">Add an added entry for a file with a specific sequence number.
<p>The entry's snapshot ID will be this manifest's snapshot ID. The entry's data sequence
number will be the provided data sequence number. The entry's file sequence number will be
assigned at commit.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>addedFile</code> - a data file</dd>
<dd><code>dataSequenceNumber</code> - a data sequence number for the file</dd>
</dl>
</li>
</ul>
<a name="existing-org.apache.iceberg.ContentFile-long-long-java.lang.Long-">
<!-- -->
</a><a name="existing-F-long-long-java.lang.Long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>existing</h4>
<pre>public&nbsp;void&nbsp;existing(<a href="../../../org/apache/iceberg/RollingManifestWriter.html" title="type parameter in RollingManifestWriter">F</a>&nbsp;existingFile,
long&nbsp;fileSnapshotId,
long&nbsp;dataSequenceNumber,
java.lang.Long&nbsp;fileSequenceNumber)</pre>
<div class="block">Add an existing entry for a file.
<p>The original data and file sequence numbers, snapshot ID, which were assigned at commit,
must be preserved when adding an existing entry.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>existingFile</code> - a file</dd>
<dd><code>fileSnapshotId</code> - snapshot ID when the data file was added to the table</dd>
<dd><code>dataSequenceNumber</code> - a data sequence number of the file (assigned when the file was added)</dd>
<dd><code>fileSequenceNumber</code> - a file sequence number (assigned when the file was added)</dd>
</dl>
</li>
</ul>
<a name="delete-org.apache.iceberg.ContentFile-long-java.lang.Long-">
<!-- -->
</a><a name="delete-F-long-java.lang.Long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>delete</h4>
<pre>public&nbsp;void&nbsp;delete(<a href="../../../org/apache/iceberg/RollingManifestWriter.html" title="type parameter in RollingManifestWriter">F</a>&nbsp;deletedFile,
long&nbsp;dataSequenceNumber,
java.lang.Long&nbsp;fileSequenceNumber)</pre>
<div class="block">Add a delete entry for a file.
<p>The entry's snapshot ID will be this manifest's snapshot ID. However, the original data and
file sequence numbers of the file must be preserved when the file is marked as deleted.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>deletedFile</code> - a file</dd>
<dd><code>dataSequenceNumber</code> - a data sequence number of the file (assigned when the file was added)</dd>
<dd><code>fileSequenceNumber</code> - a file sequence number (assigned when the file was added)</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>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.io.Closeable</code></dd>
<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="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="toManifestFiles--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toManifestFiles</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../org/apache/iceberg/ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a>&gt;&nbsp;toManifestFiles()</pre>
</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/RewriteManifests.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/apache/iceberg/RowDelta.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/iceberg/RollingManifestWriter.html" target="_top">Frames</a></li>
<li><a href="RollingManifestWriter.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>