blob: dee2c4eda6860882383712df36f29aecedc0ac5e [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.7) on Tue Jul 14 14:13:05 PDT 2020 -->
<title>RewriteManifestsAction</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2020-07-14">
<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.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.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="RewriteManifestsAction";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.iceberg.actions</a></div>
<h2 title="Class RewriteManifestsAction" class="title">Class RewriteManifestsAction</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.actions.RewriteManifestsAction</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="Action.html" title="interface in org.apache.iceberg.actions">Action</a>&lt;<a href="RewriteManifestsActionResult.html" title="class in org.apache.iceberg.actions">RewriteManifestsActionResult</a>&gt;</code>, <code><a href="SnapshotUpdateAction.html" title="interface in org.apache.iceberg.actions">SnapshotUpdateAction</a>&lt;<a href="RewriteManifestsAction.html" title="class in org.apache.iceberg.actions">RewriteManifestsAction</a>,&#8203;<a href="RewriteManifestsActionResult.html" title="class in org.apache.iceberg.actions">RewriteManifestsActionResult</a>&gt;</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">RewriteManifestsAction</span>
extends java.lang.Object</pre>
<div class="block">An action that rewrites manifests in a distributed manner and co-locates metadata for partitions.
<p>
By default, this action rewrites all manifests for the current partition spec and writes the result
to the metadata folder. The behavior can be modified by passing a custom predicate to <a href="#rewriteIf(java.util.function.Predicate)"><code>rewriteIf(Predicate)</code></a>
and a custom spec id to <a href="#specId(int)"><code>specId(int)</code></a>. In addition, there is a way to configure a custom location
for new manifests via <a href="#stagingLocation"><code>stagingLocation</code></a>.</div>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#commit(org.apache.iceberg.SnapshotUpdate)">commit</a></span>&#8203;(<a href="../SnapshotUpdate.html" title="interface in org.apache.iceberg">SnapshotUpdate</a>&lt;?&gt;&nbsp;update)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="RewriteManifestsActionResult.html" title="class in org.apache.iceberg.actions">RewriteManifestsActionResult</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute()">execute</a></span>()</code></th>
<td class="colLast">
<div class="block">Executes this action.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#metadataTableName(org.apache.iceberg.MetadataTableType)">metadataTableName</a></span>&#8203;(<a href="../MetadataTableType.html" title="enum in org.apache.iceberg">MetadataTableType</a>&nbsp;type)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="RewriteManifestsAction.html" title="class in org.apache.iceberg.actions">RewriteManifestsAction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rewriteIf(java.util.function.Predicate)">rewriteIf</a></span>&#8203;(java.util.function.Predicate&lt;<a href="../ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a>&gt;&nbsp;newPredicate)</code></th>
<td class="colLast">
<div class="block">Rewrites only manifests that match the given predicate.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected <a href="RewriteManifestsAction.html" title="class in org.apache.iceberg.actions">RewriteManifestsAction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#self()">self</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>ThisT</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#set(java.lang.String,java.lang.String)">set</a></span>&#8203;(java.lang.String&nbsp;property,
java.lang.String&nbsp;value)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="RewriteManifestsAction.html" title="class in org.apache.iceberg.actions">RewriteManifestsAction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#specId(int)">specId</a></span>&#8203;(int&nbsp;specId)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="RewriteManifestsAction.html" title="class in org.apache.iceberg.actions">RewriteManifestsAction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stagingLocation(java.lang.String)">stagingLocation</a></span>&#8203;(java.lang.String&nbsp;newStagingLocation)</code></th>
<td class="colLast">
<div class="block">Passes a location where the manifests should be written.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected <a href="../Table.html" title="interface in org.apache.iceberg">Table</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#table()">table</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="RewriteManifestsAction.html" title="class in org.apache.iceberg.actions">RewriteManifestsAction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#useCaching(boolean)">useCaching</a></span>&#8203;(boolean&nbsp;newUseCaching)</code></th>
<td class="colLast">
<div class="block">Configures whether the action should cache manifest entries used in multiple jobs.</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&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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&nbsp;<a href="RewriteManifestsAction.html" title="class in org.apache.iceberg.actions">RewriteManifestsAction</a>&nbsp;self()</pre>
</li>
</ul>
<a id="table()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>table</h4>
<pre class="methodSignature">protected&nbsp;<a href="../Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table()</pre>
</li>
</ul>
<a id="specId(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>specId</h4>
<pre class="methodSignature">public&nbsp;<a href="RewriteManifestsAction.html" title="class in org.apache.iceberg.actions">RewriteManifestsAction</a>&nbsp;specId&#8203;(int&nbsp;specId)</pre>
</li>
</ul>
<a id="rewriteIf(java.util.function.Predicate)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rewriteIf</h4>
<pre class="methodSignature">public&nbsp;<a href="RewriteManifestsAction.html" title="class in org.apache.iceberg.actions">RewriteManifestsAction</a>&nbsp;rewriteIf&#8203;(java.util.function.Predicate&lt;<a href="../ManifestFile.html" title="interface in org.apache.iceberg">ManifestFile</a>&gt;&nbsp;newPredicate)</pre>
<div class="block">Rewrites only manifests that match the given predicate.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newPredicate</code> - a predicate</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this for method chaining</dd>
</dl>
</li>
</ul>
<a id="stagingLocation(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stagingLocation</h4>
<pre class="methodSignature">public&nbsp;<a href="RewriteManifestsAction.html" title="class in org.apache.iceberg.actions">RewriteManifestsAction</a>&nbsp;stagingLocation&#8203;(java.lang.String&nbsp;newStagingLocation)</pre>
<div class="block">Passes a location where the manifests should be written.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newStagingLocation</code> - a staging location</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this for method chaining</dd>
</dl>
</li>
</ul>
<a id="useCaching(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useCaching</h4>
<pre class="methodSignature">public&nbsp;<a href="RewriteManifestsAction.html" title="class in org.apache.iceberg.actions">RewriteManifestsAction</a>&nbsp;useCaching&#8203;(boolean&nbsp;newUseCaching)</pre>
<div class="block">Configures whether the action should cache manifest entries used in multiple jobs.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newUseCaching</code> - a flag whether to use caching</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this for method chaining</dd>
</dl>
</li>
</ul>
<a id="execute()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre class="methodSignature">public&nbsp;<a href="RewriteManifestsActionResult.html" title="class in org.apache.iceberg.actions">RewriteManifestsActionResult</a>&nbsp;execute()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Action.html#execute()">Action</a></code></span></div>
<div class="block">Executes this action.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the result of this action</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&nbsp;ThisT&nbsp;set&#8203;(java.lang.String&nbsp;property,
java.lang.String&nbsp;value)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SnapshotUpdateAction.html#set(java.lang.String,java.lang.String)">set</a></code>&nbsp;in interface&nbsp;<code><a href="SnapshotUpdateAction.html" title="interface in org.apache.iceberg.actions">SnapshotUpdateAction</a>&lt;ThisT,&#8203;R&gt;</code></dd>
</dl>
</li>
</ul>
<a id="commit(org.apache.iceberg.SnapshotUpdate)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commit</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;commit&#8203;(<a href="../SnapshotUpdate.html" title="interface in org.apache.iceberg">SnapshotUpdate</a>&lt;?&gt;&nbsp;update)</pre>
</li>
</ul>
<a id="metadataTableName(org.apache.iceberg.MetadataTableType)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>metadataTableName</h4>
<pre class="methodSignature">protected&nbsp;java.lang.String&nbsp;metadataTableName&#8203;(<a href="../MetadataTableType.html" title="enum in org.apache.iceberg">MetadataTableType</a>&nbsp;type)</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&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>