| <!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_201) on Tue Aug 25 16:06:03 PDT 2020 --> |
| <title>ManifestWriter</title> |
| <meta name="date" content="2020-08-25"> |
| <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="ManifestWriter"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":6,"i8":6,"i9":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ManifestsTable.html" title="class in org.apache.iceberg"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/iceberg/MetadataTableType.html" title="enum in org.apache.iceberg"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/iceberg/ManifestWriter.html" target="_top">Frames</a></li> |
| <li><a href="ManifestWriter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 ManifestWriter" class="title">Class ManifestWriter<F extends <a href="../../../org/apache/iceberg/ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><F>></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.ManifestWriter<F></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>F</code> - Java class of files written to the manifest, either <a href="../../../org/apache/iceberg/DataFile.html" title="interface in org.apache.iceberg"><code>DataFile</code></a> or <a href="../../../org/apache/iceberg/DeleteFile.html" title="interface in org.apache.iceberg"><code>DeleteFile</code></a>.</dd> |
| </dl> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Closeable, java.lang.AutoCloseable, <a href="../../../org/apache/iceberg/io/FileAppender.html" title="interface in org.apache.iceberg.io">FileAppender</a><F></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">ManifestWriter<F extends <a href="../../../org/apache/iceberg/ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><F>></span> |
| extends java.lang.Object |
| implements <a href="../../../org/apache/iceberg/io/FileAppender.html" title="interface in org.apache.iceberg.io">FileAppender</a><F></pre> |
| <div class="block">Writer for manifest files.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/ManifestWriter.html#add-F-">add</a></span>(<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a> 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/ManifestWriter.html#close--">close</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../org/apache/iceberg/ManifestContent.html" title="enum in org.apache.iceberg">ManifestContent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ManifestWriter.html#content--">content</a></span>()</code> </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/ManifestWriter.html#delete-F-">delete</a></span>(<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a> deletedFile)</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/ManifestWriter.html#existing-F-long-long-">existing</a></span>(<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a> existingFile, |
| long fileSnapshotId, |
| long sequenceNumber)</code> |
| <div class="block">Add an existing entry for a file.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ManifestWriter.html#length--">length</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/Metrics.html" title="class in org.apache.iceberg">Metrics</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ManifestWriter.html#metrics--">metrics</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected abstract <a href="../../../org/apache/iceberg/io/FileAppender.html" title="interface in org.apache.iceberg.io">FileAppender</a><org.apache.iceberg.ManifestEntry<<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ManifestWriter.html#newAppender-org.apache.iceberg.PartitionSpec-org.apache.iceberg.io.OutputFile-">newAppender</a></span>(<a href="../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| <a href="../../../org/apache/iceberg/io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a> outputFile)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected abstract org.apache.iceberg.ManifestEntry<<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ManifestWriter.html#prepare-org.apache.iceberg.ManifestEntry-">prepare</a></span>(org.apache.iceberg.ManifestEntry<<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a>> entry)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ManifestWriter.html#toManifestFile--">toManifestFile</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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.iceberg.io.FileAppender"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.iceberg.io.<a href="../../../org/apache/iceberg/io/FileAppender.html" title="interface in org.apache.iceberg.io">FileAppender</a></h3> |
| <code><a href="../../../org/apache/iceberg/io/FileAppender.html#addAll-java.lang.Iterable-">addAll</a>, <a href="../../../org/apache/iceberg/io/FileAppender.html#addAll-java.util.Iterator-">addAll</a>, <a href="../../../org/apache/iceberg/io/FileAppender.html#splitOffsets--">splitOffsets</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="prepare-org.apache.iceberg.ManifestEntry-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepare</h4> |
| <pre>protected abstract org.apache.iceberg.ManifestEntry<<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a>> prepare(org.apache.iceberg.ManifestEntry<<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a>> entry)</pre> |
| </li> |
| </ul> |
| <a name="newAppender-org.apache.iceberg.PartitionSpec-org.apache.iceberg.io.OutputFile-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newAppender</h4> |
| <pre>protected abstract <a href="../../../org/apache/iceberg/io/FileAppender.html" title="interface in org.apache.iceberg.io">FileAppender</a><org.apache.iceberg.ManifestEntry<<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a>>> newAppender(<a href="../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| <a href="../../../org/apache/iceberg/io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a> outputFile)</pre> |
| </li> |
| </ul> |
| <a name="content--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>content</h4> |
| <pre>protected <a href="../../../org/apache/iceberg/ManifestContent.html" title="enum in org.apache.iceberg">ManifestContent</a> content()</pre> |
| </li> |
| </ul> |
| <a name="add-org.apache.iceberg.ContentFile-"> |
| <!-- --> |
| </a><a name="add-F-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre>public void add(<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a> 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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/iceberg/io/FileAppender.html#add-D-">add</a></code> in interface <code><a href="../../../org/apache/iceberg/io/FileAppender.html" title="interface in org.apache.iceberg.io">FileAppender</a><<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a> extends <a href="../../../org/apache/iceberg/ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>addedFile</code> - a data file</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="existing-org.apache.iceberg.ContentFile-long-long-"> |
| <!-- --> |
| </a><a name="existing-F-long-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>existing</h4> |
| <pre>public void existing(<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a> existingFile, |
| long fileSnapshotId, |
| long sequenceNumber)</pre> |
| <div class="block">Add an existing entry for a file.</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>sequenceNumber</code> - sequence number for the data file</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="delete-org.apache.iceberg.ContentFile-"> |
| <!-- --> |
| </a><a name="delete-F-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>delete</h4> |
| <pre>public void delete(<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a> deletedFile)</pre> |
| <div class="block">Add a delete entry for a file. |
| <p> |
| The entry's snapshot ID will be this manifest's snapshot ID.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>deletedFile</code> - a file</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="metrics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>metrics</h4> |
| <pre>public <a href="../../../org/apache/iceberg/Metrics.html" title="class in org.apache.iceberg">Metrics</a> metrics()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/iceberg/io/FileAppender.html#metrics--">metrics</a></code> in interface <code><a href="../../../org/apache/iceberg/io/FileAppender.html" title="interface in org.apache.iceberg.io">FileAppender</a><<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a> extends <a href="../../../org/apache/iceberg/ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><a href="../../../org/apache/iceberg/Metrics.html" title="class in org.apache.iceberg"><code>Metrics</code></a> for this file. Only valid after the file is closed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="length--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>length</h4> |
| <pre>public long length()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/iceberg/io/FileAppender.html#length--">length</a></code> in interface <code><a href="../../../org/apache/iceberg/io/FileAppender.html" title="interface in org.apache.iceberg.io">FileAppender</a><<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a> extends <a href="../../../org/apache/iceberg/ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../../../org/apache/iceberg/ManifestWriter.html" title="type parameter in ManifestWriter">F</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the length of this file.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toManifestFile--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toManifestFile</h4> |
| <pre>public <a href="../../../org/apache/iceberg/ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a> toManifestFile()</pre> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close() |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.io.Closeable</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</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/ManifestsTable.html" title="class in org.apache.iceberg"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/iceberg/MetadataTableType.html" title="enum in org.apache.iceberg"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/iceberg/ManifestWriter.html" target="_top">Frames</a></li> |
| <li><a href="ManifestWriter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
