| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>PositionDeleteWriter</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.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.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.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PositionDeleteWriter"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"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"; |
| 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 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">org.apache.iceberg.deletes</a></div> |
| <h2 title="Class PositionDeleteWriter" class="title">Class PositionDeleteWriter<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.deletes.PositionDeleteWriter<T></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="../io/FileWriter.html" title="interface in org.apache.iceberg.io">FileWriter</a><<a href="PositionDelete.html" title="class in org.apache.iceberg.deletes">PositionDelete</a><T>,​<a href="../io/DeleteWriteResult.html" title="class in org.apache.iceberg.io">DeleteWriteResult</a>></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">PositionDeleteWriter<T></span> |
| extends java.lang.Object |
| implements <a href="../io/FileWriter.html" title="interface in org.apache.iceberg.io">FileWriter</a><<a href="PositionDelete.html" title="class in org.apache.iceberg.deletes">PositionDelete</a><T>,​<a href="../io/DeleteWriteResult.html" title="class in org.apache.iceberg.io">DeleteWriteResult</a>></pre> |
| <div class="block">A position delete writer that can handle deletes ordered by file and position. |
| |
| <p>This writer does not keep track of seen deletes and assumes all incoming records are ordered |
| by file and position as required by the spec. If there is no external process to order the |
| records, consider using <a href="SortingPositionOnlyDeleteWriter.html" title="class in org.apache.iceberg.deletes"><code>SortingPositionOnlyDeleteWriter</code></a> instead.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section> |
| <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"> </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.FileAppender,org.apache.iceberg.FileFormat,java.lang.String,org.apache.iceberg.PartitionSpec,org.apache.iceberg.StructLike,org.apache.iceberg.encryption.EncryptionKeyMetadata)">PositionDeleteWriter</a></span>​(<a href="../io/FileAppender.html" title="interface in org.apache.iceberg.io">FileAppender</a><<a href="../StructLike.html" title="interface in org.apache.iceberg">StructLike</a>> appender, |
| <a href="../FileFormat.html" title="enum in org.apache.iceberg">FileFormat</a> format, |
| java.lang.String location, |
| <a href="../PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| <a href="../StructLike.html" title="interface in org.apache.iceberg">StructLike</a> partition, |
| <a href="../encryption/EncryptionKeyMetadata.html" title="interface in org.apache.iceberg.encryption">EncryptionKeyMetadata</a> keyMetadata)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" 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"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#length()">length</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the number of bytes that were currently written by this writer.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../util/CharSequenceSet.html" title="class in org.apache.iceberg.util">CharSequenceSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#referencedDataFiles()">referencedDataFiles</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../io/DeleteWriteResult.html" title="class in org.apache.iceberg.io">DeleteWriteResult</a></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="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../DeleteFile.html" title="interface in org.apache.iceberg">DeleteFile</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toDeleteFile()">toDeleteFile</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#write(org.apache.iceberg.deletes.PositionDelete)">write</a></span>​(<a href="PositionDelete.html" title="class in org.apache.iceberg.deletes">PositionDelete</a><<a href="PositionDeleteWriter.html" title="type parameter in PositionDeleteWriter">T</a>> positionDelete)</code></th> |
| <td class="colLast"> |
| <div class="block">Writes a row to a predefined 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 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 id="methods.inherited.from.class.org.apache.iceberg.io.FileWriter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.iceberg.io.<a href="../io/FileWriter.html" title="interface in org.apache.iceberg.io">FileWriter</a></h3> |
| <code><a href="../io/FileWriter.html#write(java.lang.Iterable)">write</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.iceberg.io.FileAppender,org.apache.iceberg.FileFormat,java.lang.String,org.apache.iceberg.PartitionSpec,org.apache.iceberg.StructLike,org.apache.iceberg.encryption.EncryptionKeyMetadata)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PositionDeleteWriter</h4> |
| <pre>public PositionDeleteWriter​(<a href="../io/FileAppender.html" title="interface in org.apache.iceberg.io">FileAppender</a><<a href="../StructLike.html" title="interface in org.apache.iceberg">StructLike</a>> appender, |
| <a href="../FileFormat.html" title="enum in org.apache.iceberg">FileFormat</a> format, |
| java.lang.String location, |
| <a href="../PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| <a href="../StructLike.html" title="interface in org.apache.iceberg">StructLike</a> partition, |
| <a href="../encryption/EncryptionKeyMetadata.html" title="interface in org.apache.iceberg.encryption">EncryptionKeyMetadata</a> keyMetadata)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="write(org.apache.iceberg.deletes.PositionDelete)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre class="methodSignature">public void write​(<a href="PositionDelete.html" title="class in org.apache.iceberg.deletes">PositionDelete</a><<a href="PositionDeleteWriter.html" title="type parameter in PositionDeleteWriter">T</a>> positionDelete)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../io/FileWriter.html#write(T)">FileWriter</a></code></span></div> |
| <div class="block">Writes a row to a predefined spec/partition.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../io/FileWriter.html#write(T)">write</a></code> in interface <code><a href="../io/FileWriter.html" title="interface in org.apache.iceberg.io">FileWriter</a><<a href="PositionDelete.html" title="class in org.apache.iceberg.deletes">PositionDelete</a><<a href="PositionDeleteWriter.html" title="type parameter in PositionDeleteWriter">T</a>>,​<a href="../io/DeleteWriteResult.html" title="class in org.apache.iceberg.io">DeleteWriteResult</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>positionDelete</code> - a data or delete record</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="length()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>length</h4> |
| <pre class="methodSignature">public long length()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../io/FileWriter.html#length()">FileWriter</a></code></span></div> |
| <div class="block">Returns the number of bytes that were currently written by this writer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../io/FileWriter.html#length()">length</a></code> in interface <code><a href="../io/FileWriter.html" title="interface in org.apache.iceberg.io">FileWriter</a><<a href="PositionDelete.html" title="class in org.apache.iceberg.deletes">PositionDelete</a><<a href="PositionDeleteWriter.html" title="type parameter in PositionDeleteWriter">T</a>>,​<a href="../io/DeleteWriteResult.html" title="class in org.apache.iceberg.io">DeleteWriteResult</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of written bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">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.lang.AutoCloseable</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <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="referencedDataFiles()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>referencedDataFiles</h4> |
| <pre class="methodSignature">public <a href="../util/CharSequenceSet.html" title="class in org.apache.iceberg.util">CharSequenceSet</a> referencedDataFiles()</pre> |
| </li> |
| </ul> |
| <a id="toDeleteFile()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toDeleteFile</h4> |
| <pre class="methodSignature">public <a href="../DeleteFile.html" title="interface in org.apache.iceberg">DeleteFile</a> toDeleteFile()</pre> |
| </li> |
| </ul> |
| <a id="result()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>result</h4> |
| <pre class="methodSignature">public <a href="../io/DeleteWriteResult.html" title="class in org.apache.iceberg.io">DeleteWriteResult</a> result()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../io/FileWriter.html#result()">FileWriter</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="../io/FileWriter.html#result()">result</a></code> in interface <code><a href="../io/FileWriter.html" title="interface in org.apache.iceberg.io">FileWriter</a><<a href="PositionDelete.html" title="class in org.apache.iceberg.deletes">PositionDelete</a><<a href="PositionDeleteWriter.html" title="type parameter in PositionDeleteWriter">T</a>>,​<a href="../io/DeleteWriteResult.html" title="class in org.apache.iceberg.io">DeleteWriteResult</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the file writer result</dd> |
| </dl> |
| </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 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |
