blob: dbad221dae17c3913e9722572dd5553e7b01ee4a [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.12) on Wed Aug 18 10:34:26 PDT 2021 -->
<title>org.apache.iceberg.actions</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2021-08-18">
<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="org.apache.iceberg.actions";
}
}
catch(err) {
}
//-->
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 class="navBarCell1Rev">Package</li>
<li>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>
<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>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.iceberg.actions</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Action.html" title="interface in org.apache.iceberg.actions">Action</a>&lt;ThisT,&#8203;R&gt;</th>
<td class="colLast">
<div class="block">An action performed on a table.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ActionsProvider.html" title="interface in org.apache.iceberg.actions">ActionsProvider</a></th>
<td class="colLast">
<div class="block">An API that should be implemented by query engine integrations for providing actions.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CreateAction.html" title="interface in org.apache.iceberg.actions">CreateAction</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">since 0.12.0, will be removed in 0.13.0; use <a href="SnapshotTable.html" title="interface in org.apache.iceberg.actions"><code>SnapshotTable</code></a> or <a href="MigrateTable.html" title="interface in org.apache.iceberg.actions"><code>MigrateTable</code></a> instead.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DeleteOrphanFiles.html" title="interface in org.apache.iceberg.actions">DeleteOrphanFiles</a></th>
<td class="colLast">
<div class="block">An action that deletes orphan files in a table.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DeleteOrphanFiles.Result.html" title="interface in org.apache.iceberg.actions">DeleteOrphanFiles.Result</a></th>
<td class="colLast">
<div class="block">The action result that contains a summary of the execution.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DeleteReachableFiles.html" title="interface in org.apache.iceberg.actions">DeleteReachableFiles</a></th>
<td class="colLast">
<div class="block">An action that deletes all files referenced by a table metadata file.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DeleteReachableFiles.Result.html" title="interface in org.apache.iceberg.actions">DeleteReachableFiles.Result</a></th>
<td class="colLast">
<div class="block">The action result that contains a summary of the execution.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ExpireSnapshots.html" title="interface in org.apache.iceberg.actions">ExpireSnapshots</a></th>
<td class="colLast">
<div class="block">An action that expires snapshots in a table.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ExpireSnapshots.Result.html" title="interface in org.apache.iceberg.actions">ExpireSnapshots.Result</a></th>
<td class="colLast">
<div class="block">The action result that contains a summary of the execution.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MigrateTable.html" title="interface in org.apache.iceberg.actions">MigrateTable</a></th>
<td class="colLast">
<div class="block">An action that migrates an existing table to Iceberg.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MigrateTable.Result.html" title="interface in org.apache.iceberg.actions">MigrateTable.Result</a></th>
<td class="colLast">
<div class="block">The action result that contains a summary of the execution.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RewriteDataFiles.html" title="interface in org.apache.iceberg.actions">RewriteDataFiles</a></th>
<td class="colLast">
<div class="block">An action for rewriting data files according to a rewrite strategy.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RewriteDataFiles.FileGroupInfo.html" title="interface in org.apache.iceberg.actions">RewriteDataFiles.FileGroupInfo</a></th>
<td class="colLast">
<div class="block">A description of a file group, when it was processed, and within which partition.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RewriteDataFiles.FileGroupRewriteResult.html" title="interface in org.apache.iceberg.actions">RewriteDataFiles.FileGroupRewriteResult</a></th>
<td class="colLast">
<div class="block">For a particular file group, the number of files which are newly created and the number of files
which were formerly part of the table but have been rewritten.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RewriteDataFiles.Result.html" title="interface in org.apache.iceberg.actions">RewriteDataFiles.Result</a></th>
<td class="colLast">
<div class="block">A map of file group information to the results of rewriting that file group.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RewriteManifests.html" title="interface in org.apache.iceberg.actions">RewriteManifests</a></th>
<td class="colLast">
<div class="block">An action that rewrites manifests.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RewriteManifests.Result.html" title="interface in org.apache.iceberg.actions">RewriteManifests.Result</a></th>
<td class="colLast">
<div class="block">The action result that contains a summary of the execution.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RewriteStrategy.html" title="interface in org.apache.iceberg.actions">RewriteStrategy</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SnapshotAction.html" title="interface in org.apache.iceberg.actions">SnapshotAction</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">since 0.12.0, will be removed in 0.13.0; use <a href="SnapshotTable.html" title="interface in org.apache.iceberg.actions"><code>SnapshotTable</code></a> instead.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SnapshotTable.html" title="interface in org.apache.iceberg.actions">SnapshotTable</a></th>
<td class="colLast">
<div class="block">An action that creates an independent snapshot of an existing table.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SnapshotTable.Result.html" title="interface in org.apache.iceberg.actions">SnapshotTable.Result</a></th>
<td class="colLast">
<div class="block">The action result that contains a summary of the execution.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SnapshotUpdate.html" title="interface in org.apache.iceberg.actions">SnapshotUpdate</a>&lt;ThisT,&#8203;R&gt;</th>
<td class="colLast">
<div class="block">An action that produces snapshots.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SnapshotUpdateAction.html" title="interface in org.apache.iceberg.actions">SnapshotUpdateAction</a>&lt;ThisT,&#8203;R&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Actions.html" title="class in org.apache.iceberg.actions">Actions</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">since 0.12.0, will be removed in 0.13.0; use an implementation of <a href="ActionsProvider.html" title="interface in org.apache.iceberg.actions"><code>ActionsProvider</code></a> instead.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="BaseDeleteOrphanFilesActionResult.html" title="class in org.apache.iceberg.actions">BaseDeleteOrphanFilesActionResult</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="BaseDeleteReachableFilesActionResult.html" title="class in org.apache.iceberg.actions">BaseDeleteReachableFilesActionResult</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="BaseExpireSnapshotsActionResult.html" title="class in org.apache.iceberg.actions">BaseExpireSnapshotsActionResult</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="BaseFileGroupRewriteResult.html" title="class in org.apache.iceberg.actions">BaseFileGroupRewriteResult</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="BaseMigrateTableActionResult.html" title="class in org.apache.iceberg.actions">BaseMigrateTableActionResult</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="BaseRewriteDataFilesAction.html" title="class in org.apache.iceberg.actions">BaseRewriteDataFilesAction</a>&lt;ThisT&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="BaseRewriteDataFilesFileGroupInfo.html" title="class in org.apache.iceberg.actions">BaseRewriteDataFilesFileGroupInfo</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="BaseRewriteDataFilesResult.html" title="class in org.apache.iceberg.actions">BaseRewriteDataFilesResult</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="BaseRewriteManifestsActionResult.html" title="class in org.apache.iceberg.actions">BaseRewriteManifestsActionResult</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="BaseSnapshotTableActionResult.html" title="class in org.apache.iceberg.actions">BaseSnapshotTableActionResult</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="BinPackStrategy.html" title="class in org.apache.iceberg.actions">BinPackStrategy</a></th>
<td class="colLast">
<div class="block">A rewrite strategy for data files which determines which files to rewrite
based on their size.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ExpireSnapshotsAction.html" title="class in org.apache.iceberg.actions">ExpireSnapshotsAction</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">since 0.12.0, will be removed in 0.13.0; use <a href="../spark/actions/BaseExpireSnapshotsSparkAction.html" title="class in org.apache.iceberg.spark.actions"><code>BaseExpireSnapshotsSparkAction</code></a> instead.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ExpireSnapshotsActionResult.html" title="class in org.apache.iceberg.actions">ExpireSnapshotsActionResult</a></th>
<td class="colLast">Deprecated.</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ManifestFileBean.html" title="class in org.apache.iceberg.actions">ManifestFileBean</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RemoveOrphanFilesAction.html" title="class in org.apache.iceberg.actions">RemoveOrphanFilesAction</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">since 0.12.0, will be removed in 0.13.0; use <a href="DeleteOrphanFiles.html" title="interface in org.apache.iceberg.actions"><code>DeleteOrphanFiles</code></a> instead.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RewriteDataFilesAction.html" title="class in org.apache.iceberg.actions">RewriteDataFilesAction</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">since 0.12.0, will be removed in 0.13.0; use <a href="RewriteDataFilesAction.html" title="class in org.apache.iceberg.actions"><code>RewriteDataFilesAction</code></a> instead.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RewriteDataFilesActionResult.html" title="class in org.apache.iceberg.actions">RewriteDataFilesActionResult</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RewriteDataFilesCommitManager.html" title="class in org.apache.iceberg.actions">RewriteDataFilesCommitManager</a></th>
<td class="colLast">
<div class="block">Functionality used by RewriteDataFile Actions from different platforms to handle commits.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RewriteFileGroup.html" title="class in org.apache.iceberg.actions">RewriteFileGroup</a></th>
<td class="colLast">
<div class="block">Container class representing a set of files to be rewritten by a RewriteAction and the new files which have been
written by the action.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RewriteManifestsAction.html" title="class in org.apache.iceberg.actions">RewriteManifestsAction</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">since 0.12.0, will be removed in 0.13.0; use <a href="RewriteManifests.html" title="interface in org.apache.iceberg.actions"><code>RewriteManifests</code></a> instead.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RewriteManifestsActionResult.html" title="class in org.apache.iceberg.actions">RewriteManifestsActionResult</a></th>
<td class="colLast">Deprecated.</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SortStrategy.html" title="class in org.apache.iceberg.actions">SortStrategy</a></th>
<td class="colLast">
<div class="block">A rewrite strategy for data files which aims to reorder data with data files to optimally lay them out
in relation to a column.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Spark3MigrateAction.html" title="class in org.apache.iceberg.actions">Spark3MigrateAction</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">since 0.12.0, will be removed in 0.13.0; use <a href="MigrateTable.html" title="interface in org.apache.iceberg.actions"><code>MigrateTable</code></a> instead.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Spark3SnapshotAction.html" title="class in org.apache.iceberg.actions">Spark3SnapshotAction</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">since 0.12.0, will be removed in 0.13.0; use <a href="SnapshotTable.html" title="interface in org.apache.iceberg.actions"><code>SnapshotTable</code></a> instead.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SparkActions.html" title="class in org.apache.iceberg.actions">SparkActions</a></th>
<td class="colLast">Deprecated.</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<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 class="navBarCell1Rev">Package</li>
<li>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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>