blob: 125c0f45577355df7c52726aff3763b6de13cad7 [file] [log] [blame]
<!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 (1.8.0_192) on Tue Apr 06 11:46:38 PDT 2021 -->
<title>Actions</title>
<meta name="date" content="2021-04-06">
<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="Actions";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":9,"i3":9,"i4":9,"i5":10,"i6":10,"i7":10,"i8":9,"i9":9,"i10":10,"i11":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/actions/Action.html" title="interface in org.apache.iceberg.actions"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/iceberg/actions/BaseRewriteDataFilesAction.html" title="class in org.apache.iceberg.actions"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/iceberg/actions/Actions.html" target="_top">Frames</a></li>
<li><a href="Actions.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.actions</div>
<h2 title="Class Actions" class="title">Class Actions</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.actions.Actions</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">Actions</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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">&nbsp;</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/actions/Actions.html#Actions-org.apache.spark.sql.SparkSession-org.apache.iceberg.Table-">Actions</a></span>(org.apache.spark.sql.SparkSession&nbsp;spark,
<a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table)</code>&nbsp;</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/iceberg/actions/ExpireSnapshotsAction.html" title="class in org.apache.iceberg.actions">ExpireSnapshotsAction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/actions/Actions.html#expireSnapshots--">expireSnapshots</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/iceberg/actions/Actions.html" title="class in org.apache.iceberg.actions">Actions</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/actions/Actions.html#forTable-org.apache.spark.sql.SparkSession-org.apache.iceberg.Table-">forTable</a></span>(org.apache.spark.sql.SparkSession&nbsp;spark,
<a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/iceberg/actions/Actions.html" title="class in org.apache.iceberg.actions">Actions</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/actions/Actions.html#forTable-org.apache.iceberg.Table-">forTable</a></span>(<a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/iceberg/actions/CreateAction.html" title="interface in org.apache.iceberg.actions">CreateAction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/actions/Actions.html#migrate-org.apache.spark.sql.SparkSession-java.lang.String-">migrate</a></span>(org.apache.spark.sql.SparkSession&nbsp;spark,
java.lang.String&nbsp;tableName)</code>
<div class="block">Converts the provided table into an Iceberg table in place.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/iceberg/actions/CreateAction.html" title="interface in org.apache.iceberg.actions">CreateAction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/actions/Actions.html#migrate-java.lang.String-">migrate</a></span>(java.lang.String&nbsp;tableName)</code>
<div class="block">Converts the provided table into an Iceberg table in place.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/iceberg/actions/RemoveOrphanFilesAction.html" title="class in org.apache.iceberg.actions">RemoveOrphanFilesAction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/actions/Actions.html#removeOrphanFiles--">removeOrphanFiles</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/iceberg/actions/RewriteDataFilesAction.html" title="class in org.apache.iceberg.actions">RewriteDataFilesAction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/actions/Actions.html#rewriteDataFiles--">rewriteDataFiles</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/iceberg/actions/RewriteManifestsAction.html" title="class in org.apache.iceberg.actions">RewriteManifestsAction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/actions/Actions.html#rewriteManifests--">rewriteManifests</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/iceberg/actions/SnapshotAction.html" title="interface in org.apache.iceberg.actions">SnapshotAction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/actions/Actions.html#snapshot-org.apache.spark.sql.SparkSession-java.lang.String-java.lang.String-">snapshot</a></span>(org.apache.spark.sql.SparkSession&nbsp;spark,
java.lang.String&nbsp;sourceTable,
java.lang.String&nbsp;destTable)</code>
<div class="block">Creates an independent Iceberg table based on a given table.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/iceberg/actions/SnapshotAction.html" title="interface in org.apache.iceberg.actions">SnapshotAction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/actions/Actions.html#snapshot-java.lang.String-java.lang.String-">snapshot</a></span>(java.lang.String&nbsp;sourceTable,
java.lang.String&nbsp;destTable)</code>
<div class="block">Creates an independent Iceberg table based on a given table.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected org.apache.spark.sql.SparkSession</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/actions/Actions.html#spark--">spark</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/actions/Actions.html#table--">table</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="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>
</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="Actions-org.apache.spark.sql.SparkSession-org.apache.iceberg.Table-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Actions</h4>
<pre>protected&nbsp;Actions(org.apache.spark.sql.SparkSession&nbsp;spark,
<a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="forTable-org.apache.spark.sql.SparkSession-org.apache.iceberg.Table-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forTable</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/iceberg/actions/Actions.html" title="class in org.apache.iceberg.actions">Actions</a>&nbsp;forTable(org.apache.spark.sql.SparkSession&nbsp;spark,
<a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table)</pre>
</li>
</ul>
<a name="forTable-org.apache.iceberg.Table-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forTable</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/iceberg/actions/Actions.html" title="class in org.apache.iceberg.actions">Actions</a>&nbsp;forTable(<a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table)</pre>
</li>
</ul>
<a name="removeOrphanFiles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeOrphanFiles</h4>
<pre>public&nbsp;<a href="../../../../org/apache/iceberg/actions/RemoveOrphanFilesAction.html" title="class in org.apache.iceberg.actions">RemoveOrphanFilesAction</a>&nbsp;removeOrphanFiles()</pre>
</li>
</ul>
<a name="rewriteManifests--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rewriteManifests</h4>
<pre>public&nbsp;<a href="../../../../org/apache/iceberg/actions/RewriteManifestsAction.html" title="class in org.apache.iceberg.actions">RewriteManifestsAction</a>&nbsp;rewriteManifests()</pre>
</li>
</ul>
<a name="rewriteDataFiles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rewriteDataFiles</h4>
<pre>public&nbsp;<a href="../../../../org/apache/iceberg/actions/RewriteDataFilesAction.html" title="class in org.apache.iceberg.actions">RewriteDataFilesAction</a>&nbsp;rewriteDataFiles()</pre>
</li>
</ul>
<a name="expireSnapshots--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>expireSnapshots</h4>
<pre>public&nbsp;<a href="../../../../org/apache/iceberg/actions/ExpireSnapshotsAction.html" title="class in org.apache.iceberg.actions">ExpireSnapshotsAction</a>&nbsp;expireSnapshots()</pre>
</li>
</ul>
<a name="migrate-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>migrate</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/iceberg/actions/CreateAction.html" title="interface in org.apache.iceberg.actions">CreateAction</a>&nbsp;migrate(java.lang.String&nbsp;tableName)</pre>
<div class="block">Converts the provided table into an Iceberg table in place. The table will no longer be accessible by it's
previous implementation</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tableName</code> - Table to be converted</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../org/apache/iceberg/actions/CreateAction.html" title="interface in org.apache.iceberg.actions"><code>CreateAction</code></a> to perform migration</dd>
</dl>
</li>
</ul>
<a name="migrate-org.apache.spark.sql.SparkSession-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>migrate</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/iceberg/actions/CreateAction.html" title="interface in org.apache.iceberg.actions">CreateAction</a>&nbsp;migrate(org.apache.spark.sql.SparkSession&nbsp;spark,
java.lang.String&nbsp;tableName)</pre>
<div class="block">Converts the provided table into an Iceberg table in place. The table will no longer be accessible by it's
previous implementation</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tableName</code> - Table to be converted</dd>
<dd><code>spark</code> - Spark session to use for looking up table</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../org/apache/iceberg/actions/CreateAction.html" title="interface in org.apache.iceberg.actions"><code>CreateAction</code></a> to perform migration</dd>
</dl>
</li>
</ul>
<a name="snapshot-org.apache.spark.sql.SparkSession-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>snapshot</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/iceberg/actions/SnapshotAction.html" title="interface in org.apache.iceberg.actions">SnapshotAction</a>&nbsp;snapshot(org.apache.spark.sql.SparkSession&nbsp;spark,
java.lang.String&nbsp;sourceTable,
java.lang.String&nbsp;destTable)</pre>
<div class="block">Creates an independent Iceberg table based on a given table. The new Iceberg table can be altered, appended or
deleted without causing any change to the original. New data and metadata will be created in the default
location for tables of this name in the destination catalog.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sourceTable</code> - Original table which is the basis for the new Iceberg table</dd>
<dd><code>destTable</code> - New Iceberg table being created</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../org/apache/iceberg/actions/SnapshotAction.html" title="interface in org.apache.iceberg.actions"><code>SnapshotAction</code></a> to perform snapshot</dd>
</dl>
</li>
</ul>
<a name="snapshot-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>snapshot</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/iceberg/actions/SnapshotAction.html" title="interface in org.apache.iceberg.actions">SnapshotAction</a>&nbsp;snapshot(java.lang.String&nbsp;sourceTable,
java.lang.String&nbsp;destTable)</pre>
<div class="block">Creates an independent Iceberg table based on a given table. The new Iceberg table can be altered, appended or
deleted without causing any change to the original. New data and metadata will be created in the default
location for tables of this name in the destination catalog.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sourceTable</code> - Original table which is the basis for the new Iceberg table</dd>
<dd><code>destTable</code> - New Iceberg table being created</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../org/apache/iceberg/actions/SnapshotAction.html" title="interface in org.apache.iceberg.actions"><code>SnapshotAction</code></a> to perform snapshot</dd>
</dl>
</li>
</ul>
<a name="spark--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>spark</h4>
<pre>protected&nbsp;org.apache.spark.sql.SparkSession&nbsp;spark()</pre>
</li>
</ul>
<a name="table--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>table</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table()</pre>
</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/actions/Action.html" title="interface in org.apache.iceberg.actions"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/iceberg/actions/BaseRewriteDataFilesAction.html" title="class in org.apache.iceberg.actions"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/iceberg/actions/Actions.html" target="_top">Frames</a></li>
<li><a href="Actions.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>