| <!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>BaseTaskWriter</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="BaseTaskWriter"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":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/io/BasePositionDeltaWriter.html" title="class in org.apache.iceberg.io"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/io/BaseTaskWriter.BaseEqualityDeltaWriter.html" title="class in org.apache.iceberg.io"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/io/BaseTaskWriter.html" target="_top">Frames</a></li> |
| <li><a href="BaseTaskWriter.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><a href="#nested.class.summary">Nested</a> | </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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.iceberg.io</div> |
| <h2 title="Class BaseTaskWriter" class="title">Class BaseTaskWriter<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.io.BaseTaskWriter<T></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, <a href="../../../../org/apache/iceberg/io/TaskWriter.html" title="interface in org.apache.iceberg.io">TaskWriter</a><T></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/iceberg/io/PartitionedFanoutWriter.html" title="class in org.apache.iceberg.io">PartitionedFanoutWriter</a>, <a href="../../../../org/apache/iceberg/io/PartitionedWriter.html" title="class in org.apache.iceberg.io">PartitionedWriter</a>, <a href="../../../../org/apache/iceberg/io/UnpartitionedWriter.html" title="class in org.apache.iceberg.io">UnpartitionedWriter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">BaseTaskWriter<T></span> |
| extends java.lang.Object |
| implements <a href="../../../../org/apache/iceberg/io/TaskWriter.html" title="interface in org.apache.iceberg.io">TaskWriter</a><T></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/io/BaseTaskWriter.BaseEqualityDeltaWriter.html" title="class in org.apache.iceberg.io">BaseTaskWriter.BaseEqualityDeltaWriter</a></span></code> |
| <div class="block">Base equality delta writer to write both insert records and equality-deletes.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/io/BaseTaskWriter.RollingEqDeleteWriter.html" title="class in org.apache.iceberg.io">BaseTaskWriter.RollingEqDeleteWriter</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/io/BaseTaskWriter.RollingFileWriter.html" title="class in org.apache.iceberg.io">BaseTaskWriter.RollingFileWriter</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/io/BaseTaskWriter.html#BaseTaskWriter-org.apache.iceberg.PartitionSpec-org.apache.iceberg.FileFormat-org.apache.iceberg.io.FileAppenderFactory-org.apache.iceberg.io.OutputFileFactory-org.apache.iceberg.io.FileIO-long-">BaseTaskWriter</a></span>(<a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| <a href="../../../../org/apache/iceberg/FileFormat.html" title="enum in org.apache.iceberg">FileFormat</a> format, |
| <a href="../../../../org/apache/iceberg/io/FileAppenderFactory.html" title="interface in org.apache.iceberg.io">FileAppenderFactory</a><<a href="../../../../org/apache/iceberg/io/BaseTaskWriter.html" title="type parameter in BaseTaskWriter">T</a>> appenderFactory, |
| <a href="../../../../org/apache/iceberg/io/OutputFileFactory.html" title="class in org.apache.iceberg.io">OutputFileFactory</a> fileFactory, |
| <a href="../../../../org/apache/iceberg/io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a> io, |
| long targetFileSize)</code> </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"> </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="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/io/BaseTaskWriter.html#abort--">abort</a></span>()</code> |
| <div class="block">Close the writer and delete the completed files if possible when aborting.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/iceberg/io/WriteResult.html" title="class in org.apache.iceberg.io">WriteResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/io/BaseTaskWriter.html#complete--">complete</a></span>()</code> |
| <div class="block">Close the writer and get the completed data and delete files.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/io/BaseTaskWriter.html#spec--">spec</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.TaskWriter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.iceberg.io.<a href="../../../../org/apache/iceberg/io/TaskWriter.html" title="interface in org.apache.iceberg.io">TaskWriter</a></h3> |
| <code><a href="../../../../org/apache/iceberg/io/TaskWriter.html#dataFiles--">dataFiles</a>, <a href="../../../../org/apache/iceberg/io/TaskWriter.html#write-T-">write</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.io.Closeable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.io.Closeable</h3> |
| <code>close</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="BaseTaskWriter-org.apache.iceberg.PartitionSpec-org.apache.iceberg.FileFormat-org.apache.iceberg.io.FileAppenderFactory-org.apache.iceberg.io.OutputFileFactory-org.apache.iceberg.io.FileIO-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BaseTaskWriter</h4> |
| <pre>protected BaseTaskWriter(<a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| <a href="../../../../org/apache/iceberg/FileFormat.html" title="enum in org.apache.iceberg">FileFormat</a> format, |
| <a href="../../../../org/apache/iceberg/io/FileAppenderFactory.html" title="interface in org.apache.iceberg.io">FileAppenderFactory</a><<a href="../../../../org/apache/iceberg/io/BaseTaskWriter.html" title="type parameter in BaseTaskWriter">T</a>> appenderFactory, |
| <a href="../../../../org/apache/iceberg/io/OutputFileFactory.html" title="class in org.apache.iceberg.io">OutputFileFactory</a> fileFactory, |
| <a href="../../../../org/apache/iceberg/io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a> io, |
| long targetFileSize)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="spec--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>spec</h4> |
| <pre>protected <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec()</pre> |
| </li> |
| </ul> |
| <a name="abort--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>abort</h4> |
| <pre>public void abort() |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/iceberg/io/TaskWriter.html#abort--">TaskWriter</a></code></span></div> |
| <div class="block">Close the writer and delete the completed files if possible when aborting.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/io/TaskWriter.html#abort--">abort</a></code> in interface <code><a href="../../../../org/apache/iceberg/io/TaskWriter.html" title="interface in org.apache.iceberg.io">TaskWriter</a><<a href="../../../../org/apache/iceberg/io/BaseTaskWriter.html" title="type parameter in BaseTaskWriter">T</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if any IO error happen.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="complete--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>complete</h4> |
| <pre>public <a href="../../../../org/apache/iceberg/io/WriteResult.html" title="class in org.apache.iceberg.io">WriteResult</a> complete() |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/iceberg/io/TaskWriter.html#complete--">TaskWriter</a></code></span></div> |
| <div class="block">Close the writer and get the completed data and delete files.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/io/TaskWriter.html#complete--">complete</a></code> in interface <code><a href="../../../../org/apache/iceberg/io/TaskWriter.html" title="interface in org.apache.iceberg.io">TaskWriter</a><<a href="../../../../org/apache/iceberg/io/BaseTaskWriter.html" title="type parameter in BaseTaskWriter">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the completed data and delete files of this task writer.</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/io/BasePositionDeltaWriter.html" title="class in org.apache.iceberg.io"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/io/BaseTaskWriter.BaseEqualityDeltaWriter.html" title="class in org.apache.iceberg.io"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/io/BaseTaskWriter.html" target="_top">Frames</a></li> |
| <li><a href="BaseTaskWriter.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><a href="#nested.class.summary">Nested</a> | </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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
