| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.12) on Mon Nov 08 18:33:49 PST 2021 --> |
| <title>BaseRewriteManifests</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| <meta name="dc.created" content="2021-11-08"> |
| <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="BaseRewriteManifests"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":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>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 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</a></div> |
| <h2 title="Class BaseRewriteManifests" class="title">Class BaseRewriteManifests</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.BaseRewriteManifests</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="PendingUpdate.html" title="interface in org.apache.iceberg">PendingUpdate</a><<a href="Snapshot.html" title="interface in org.apache.iceberg">Snapshot</a>></code>, <code><a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a></code>, <code><a href="SnapshotUpdate.html" title="interface in org.apache.iceberg">SnapshotUpdate</a><<a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a>></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">BaseRewriteManifests</span> |
| extends java.lang.Object |
| implements <a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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"> </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><a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addManifest(org.apache.iceberg.ManifestFile)">addManifest</a></span>​(<a href="ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a> manifest)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds a <a href="ManifestFile.html" title="interface in org.apache.iceberg"><code>manifest file</code></a> to the table.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="Snapshot.html" title="interface in org.apache.iceberg">Snapshot</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#apply()">apply</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Apply the pending changes and return the uncommitted changes for validation.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<a href="ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#apply(org.apache.iceberg.TableMetadata)">apply</a></span>​(<a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> base)</code></th> |
| <td class="colLast"> |
| <div class="block">Apply the update's changes to the base table metadata and return the new manifest list.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cleanAll()">cleanAll</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cleanUncommitted(java.util.Set)">cleanUncommitted</a></span>​(java.util.Set<<a href="ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a>> committed)</code></th> |
| <td class="colLast"> |
| <div class="block">Clean up any uncommitted manifests that were created.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clusterBy(java.util.function.Function)">clusterBy</a></span>​(java.util.function.Function<<a href="DataFile.html" title="interface in org.apache.iceberg">DataFile</a>,​java.lang.Object> func)</code></th> |
| <td class="colLast"> |
| <div class="block">Groups an existing <a href="DataFile.html" title="interface in org.apache.iceberg"><code>DataFile</code></a> by a cluster key produced by a function.</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="#commit()">commit</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Apply the pending changes and commit.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#current()">current</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteFile(java.lang.String)">deleteFile</a></span>​(java.lang.String path)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteManifest(org.apache.iceberg.ManifestFile)">deleteManifest</a></span>​(<a href="ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a> manifest)</code></th> |
| <td class="colLast"> |
| <div class="block">Deletes a <a href="ManifestFile.html" title="interface in org.apache.iceberg"><code>manifest file</code></a> from the table.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>ThisT</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteWith(java.util.function.Consumer)">deleteWith</a></span>​(java.util.function.Consumer<java.lang.String> deleteCallback)</code></th> |
| <td class="colLast"> |
| <div class="block">Set a callback to delete files instead of the table's default.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#manifestListPath()">manifestListPath</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>protected <a href="ManifestReader.html" title="class in org.apache.iceberg">ManifestReader</a><<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="#newDeleteManifestReader(org.apache.iceberg.ManifestFile)">newDeleteManifestReader</a></span>​(<a href="ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a> manifest)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="ManifestWriter.html" title="class in org.apache.iceberg">ManifestWriter</a><<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="#newDeleteManifestWriter(org.apache.iceberg.PartitionSpec)">newDeleteManifestWriter</a></span>​(<a href="PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>protected <a href="io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newManifestOutput()">newManifestOutput</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="ManifestReader.html" title="class in org.apache.iceberg">ManifestReader</a><<a href="DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newManifestReader(org.apache.iceberg.ManifestFile)">newManifestReader</a></span>​(<a href="ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a> manifest)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>protected <a href="ManifestWriter.html" title="class in org.apache.iceberg">ManifestWriter</a><<a href="DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newManifestWriter(org.apache.iceberg.PartitionSpec)">newManifestWriter</a></span>​(<a href="PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#operation()">operation</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">A string that describes the action that produced the new snapshot.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>protected <a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#refresh()">refresh</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rewriteIf(java.util.function.Predicate)">rewriteIf</a></span>​(java.util.function.Predicate<<a href="ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a>> pred)</code></th> |
| <td class="colLast"> |
| <div class="block">Determines which existing <a href="ManifestFile.html" title="interface in org.apache.iceberg"><code>ManifestFile</code></a> for the table should be rewritten.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>protected <a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#self()">self</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#set(java.lang.String,java.lang.String)">set</a></span>​(java.lang.String property, |
| java.lang.String value)</code></th> |
| <td class="colLast"> |
| <div class="block">Set a summary property in the snapshot produced by this update.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>protected long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#snapshotId()">snapshotId</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>ThisT</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stageOnly()">stageOnly</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Called to stage a snapshot in table metadata, but not update the current snapshot id.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>protected java.util.Map<java.lang.String,​java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#summary()">summary</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validate(org.apache.iceberg.TableMetadata)">validate</a></span>​(<a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> currentMetadata)</code></th> |
| <td class="colLast"> |
| <div class="block">Validate the current metadata.</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.PendingUpdate"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.iceberg.<a href="PendingUpdate.html" title="interface in org.apache.iceberg">PendingUpdate</a></h3> |
| <code><a href="PendingUpdate.html#apply()">apply</a>, <a href="PendingUpdate.html#commit()">commit</a>, <a href="PendingUpdate.html#updateEvent()">updateEvent</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.iceberg.SnapshotUpdate"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.iceberg.<a href="SnapshotUpdate.html" title="interface in org.apache.iceberg">SnapshotUpdate</a></h3> |
| <code><a href="SnapshotUpdate.html#deleteWith(java.util.function.Consumer)">deleteWith</a>, <a href="SnapshotUpdate.html#stageOnly()">stageOnly</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="self()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>self</h4> |
| <pre class="methodSignature">protected <a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a> self()</pre> |
| </li> |
| </ul> |
| <a id="operation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>operation</h4> |
| <pre class="methodSignature">protected java.lang.String operation()</pre> |
| <div class="block">A string that describes the action that produced the new snapshot.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="set(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>set</h4> |
| <pre class="methodSignature">public <a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a> set​(java.lang.String property, |
| java.lang.String value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="SnapshotUpdate.html#set(java.lang.String,java.lang.String)">SnapshotUpdate</a></code></span></div> |
| <div class="block">Set a summary property in the snapshot produced by this update.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="SnapshotUpdate.html#set(java.lang.String,java.lang.String)">set</a></code> in interface <code><a href="SnapshotUpdate.html" title="interface in org.apache.iceberg">SnapshotUpdate</a><<a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>property</code> - a String property name</dd> |
| <dd><code>value</code> - a String property value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="summary()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>summary</h4> |
| <pre class="methodSignature">protected java.util.Map<java.lang.String,​java.lang.String> summary()</pre> |
| </li> |
| </ul> |
| <a id="clusterBy(java.util.function.Function)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clusterBy</h4> |
| <pre class="methodSignature">public <a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a> clusterBy​(java.util.function.Function<<a href="DataFile.html" title="interface in org.apache.iceberg">DataFile</a>,​java.lang.Object> func)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="RewriteManifests.html#clusterBy(java.util.function.Function)">RewriteManifests</a></code></span></div> |
| <div class="block">Groups an existing <a href="DataFile.html" title="interface in org.apache.iceberg"><code>DataFile</code></a> by a cluster key produced by a function. The cluster key |
| will determine which data file will be associated with a particular manifest. All data files |
| with the same cluster key will be written to the same manifest (unless the file is large and |
| split into multiple files). Manifests deleted via <a href="RewriteManifests.html#deleteManifest(org.apache.iceberg.ManifestFile)"><code>RewriteManifests.deleteManifest(ManifestFile)</code></a> or |
| added via <a href="RewriteManifests.html#addManifest(org.apache.iceberg.ManifestFile)"><code>RewriteManifests.addManifest(ManifestFile)</code></a> are ignored during the rewrite process.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RewriteManifests.html#clusterBy(java.util.function.Function)">clusterBy</a></code> in interface <code><a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>func</code> - Function used to cluster data files to manifests.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="rewriteIf(java.util.function.Predicate)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rewriteIf</h4> |
| <pre class="methodSignature">public <a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a> rewriteIf​(java.util.function.Predicate<<a href="ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a>> pred)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="RewriteManifests.html#rewriteIf(java.util.function.Predicate)">RewriteManifests</a></code></span></div> |
| <div class="block">Determines which existing <a href="ManifestFile.html" title="interface in org.apache.iceberg"><code>ManifestFile</code></a> for the table should be rewritten. Manifests |
| that do not match the predicate are kept as-is. If this is not called and no predicate is set, then |
| all manifests will be rewritten.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RewriteManifests.html#rewriteIf(java.util.function.Predicate)">rewriteIf</a></code> in interface <code><a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pred</code> - Predicate used to determine which manifests to rewrite. If true then the manifest |
| file will be included for rewrite. If false then then manifest is kept as-is.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deleteManifest(org.apache.iceberg.ManifestFile)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteManifest</h4> |
| <pre class="methodSignature">public <a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a> deleteManifest​(<a href="ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a> manifest)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="RewriteManifests.html#deleteManifest(org.apache.iceberg.ManifestFile)">RewriteManifests</a></code></span></div> |
| <div class="block">Deletes a <a href="ManifestFile.html" title="interface in org.apache.iceberg"><code>manifest file</code></a> from the table.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RewriteManifests.html#deleteManifest(org.apache.iceberg.ManifestFile)">deleteManifest</a></code> in interface <code><a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>manifest</code> - a manifest to delete</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addManifest(org.apache.iceberg.ManifestFile)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addManifest</h4> |
| <pre class="methodSignature">public <a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a> addManifest​(<a href="ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a> manifest)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="RewriteManifests.html#addManifest(org.apache.iceberg.ManifestFile)">RewriteManifests</a></code></span></div> |
| <div class="block">Adds a <a href="ManifestFile.html" title="interface in org.apache.iceberg"><code>manifest file</code></a> to the table. The added manifest cannot contain new |
| or deleted files. |
| <p> |
| By default, the manifest will be rewritten to ensure all entries have explicit snapshot IDs. |
| In that case, it is always the responsibility of the caller to manage the lifecycle of |
| the original manifest. |
| <p> |
| If manifest entries are allowed to inherit the snapshot ID assigned on commit, the manifest |
| should never be deleted manually if the commit succeeds as it will become part of the table |
| metadata and will be cleaned up on expiry. If the manifest gets merged with others while |
| preparing a new snapshot, it will be deleted automatically if this operation is successful. |
| If the commit fails, the manifest will never be deleted and it is up to the caller whether |
| to delete or reuse it.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RewriteManifests.html#addManifest(org.apache.iceberg.ManifestFile)">addManifest</a></code> in interface <code><a href="RewriteManifests.html" title="interface in org.apache.iceberg">RewriteManifests</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>manifest</code> - a manifest to add</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="apply(org.apache.iceberg.TableMetadata)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>apply</h4> |
| <pre class="methodSignature">public java.util.List<<a href="ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a>> apply​(<a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> base)</pre> |
| <div class="block">Apply the update's changes to the base table metadata and return the new manifest list.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>base</code> - the base table metadata to apply changes to</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a manifest list for the new snapshot.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="cleanUncommitted(java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cleanUncommitted</h4> |
| <pre class="methodSignature">protected void cleanUncommitted​(java.util.Set<<a href="ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a>> committed)</pre> |
| <div class="block">Clean up any uncommitted manifests that were created. |
| <p> |
| Manifests may not be committed if apply is called more because a commit conflict has occurred. |
| Implementations may keep around manifests because the same changes will be made by both apply |
| calls. This method instructs the implementation to clean up those manifests and passes the |
| paths of the manifests that were actually committed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>committed</code> - a set of manifest paths that were actually committed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="stageOnly()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stageOnly</h4> |
| <pre class="methodSignature">public ThisT stageOnly()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="SnapshotUpdate.html#stageOnly()">SnapshotUpdate</a></code></span></div> |
| <div class="block">Called to stage a snapshot in table metadata, but not update the current snapshot id.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="SnapshotUpdate.html#stageOnly()">stageOnly</a></code> in interface <code><a href="SnapshotUpdate.html" title="interface in org.apache.iceberg">SnapshotUpdate</a><ThisT></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deleteWith(java.util.function.Consumer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteWith</h4> |
| <pre class="methodSignature">public ThisT deleteWith​(java.util.function.Consumer<java.lang.String> deleteCallback)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="SnapshotUpdate.html#deleteWith(java.util.function.Consumer)">SnapshotUpdate</a></code></span></div> |
| <div class="block">Set a callback to delete files instead of the table's default.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="SnapshotUpdate.html#deleteWith(java.util.function.Consumer)">deleteWith</a></code> in interface <code><a href="SnapshotUpdate.html" title="interface in org.apache.iceberg">SnapshotUpdate</a><ThisT></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>deleteCallback</code> - a String consumer used to delete locations.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="validate(org.apache.iceberg.TableMetadata)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre class="methodSignature">protected void validate​(<a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> currentMetadata)</pre> |
| <div class="block">Validate the current metadata. |
| <p> |
| Child operations can override this to add custom validation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>currentMetadata</code> - current table metadata to validate</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="apply()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>apply</h4> |
| <pre class="methodSignature">public <a href="Snapshot.html" title="interface in org.apache.iceberg">Snapshot</a> apply()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="PendingUpdate.html#apply()">PendingUpdate</a></code></span></div> |
| <div class="block">Apply the pending changes and return the uncommitted changes for validation. |
| <p> |
| This does not result in a permanent update.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="PendingUpdate.html#apply()">apply</a></code> in interface <code><a href="PendingUpdate.html" title="interface in org.apache.iceberg">PendingUpdate</a><ThisT></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the uncommitted changes that would be committed by calling <a href="PendingUpdate.html#commit()"><code>PendingUpdate.commit()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="current()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>current</h4> |
| <pre class="methodSignature">protected <a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> current()</pre> |
| </li> |
| </ul> |
| <a id="refresh()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refresh</h4> |
| <pre class="methodSignature">protected <a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> refresh()</pre> |
| </li> |
| </ul> |
| <a id="commit()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commit</h4> |
| <pre class="methodSignature">public void commit()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="PendingUpdate.html#commit()">PendingUpdate</a></code></span></div> |
| <div class="block">Apply the pending changes and commit. |
| <p> |
| Changes are committed by calling the underlying table's commit method. |
| <p> |
| Once the commit is successful, the updated table will be refreshed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="PendingUpdate.html#commit()">commit</a></code> in interface <code><a href="PendingUpdate.html" title="interface in org.apache.iceberg">PendingUpdate</a><ThisT></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="cleanAll()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cleanAll</h4> |
| <pre class="methodSignature">protected void cleanAll()</pre> |
| </li> |
| </ul> |
| <a id="deleteFile(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteFile</h4> |
| <pre class="methodSignature">protected void deleteFile​(java.lang.String path)</pre> |
| </li> |
| </ul> |
| <a id="manifestListPath()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>manifestListPath</h4> |
| <pre class="methodSignature">protected <a href="io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a> manifestListPath()</pre> |
| </li> |
| </ul> |
| <a id="newManifestOutput()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newManifestOutput</h4> |
| <pre class="methodSignature">protected <a href="io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a> newManifestOutput()</pre> |
| </li> |
| </ul> |
| <a id="newManifestWriter(org.apache.iceberg.PartitionSpec)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newManifestWriter</h4> |
| <pre class="methodSignature">protected <a href="ManifestWriter.html" title="class in org.apache.iceberg">ManifestWriter</a><<a href="DataFile.html" title="interface in org.apache.iceberg">DataFile</a>> newManifestWriter​(<a href="PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec)</pre> |
| </li> |
| </ul> |
| <a id="newDeleteManifestWriter(org.apache.iceberg.PartitionSpec)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newDeleteManifestWriter</h4> |
| <pre class="methodSignature">protected <a href="ManifestWriter.html" title="class in org.apache.iceberg">ManifestWriter</a><<a href="DeleteFile.html" title="interface in org.apache.iceberg">DeleteFile</a>> newDeleteManifestWriter​(<a href="PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec)</pre> |
| </li> |
| </ul> |
| <a id="newManifestReader(org.apache.iceberg.ManifestFile)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newManifestReader</h4> |
| <pre class="methodSignature">protected <a href="ManifestReader.html" title="class in org.apache.iceberg">ManifestReader</a><<a href="DataFile.html" title="interface in org.apache.iceberg">DataFile</a>> newManifestReader​(<a href="ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a> manifest)</pre> |
| </li> |
| </ul> |
| <a id="newDeleteManifestReader(org.apache.iceberg.ManifestFile)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newDeleteManifestReader</h4> |
| <pre class="methodSignature">protected <a href="ManifestReader.html" title="class in org.apache.iceberg">ManifestReader</a><<a href="DeleteFile.html" title="interface in org.apache.iceberg">DeleteFile</a>> newDeleteManifestReader​(<a href="ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a> manifest)</pre> |
| </li> |
| </ul> |
| <a id="snapshotId()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>snapshotId</h4> |
| <pre class="methodSignature">protected long snapshotId()</pre> |
| </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>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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |