| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.12) on Wed Aug 18 10:34:26 PDT 2021 --> |
| <title>SparkActions</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="SparkActions"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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"; |
| 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.spark.actions</a></div> |
| <h2 title="Class SparkActions" class="title">Class SparkActions</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.spark.actions.SparkActions</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../../actions/ActionsProvider.html" title="interface in org.apache.iceberg.actions">ActionsProvider</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">SparkActions</span> |
| extends java.lang.Object</pre> |
| <div class="block">An implementation of <a href="../../actions/ActionsProvider.html" title="interface in org.apache.iceberg.actions"><code>ActionsProvider</code></a> for Spark. |
| <p> |
| This class is the primary API for interacting with actions in Spark that users should use |
| to instantiate particular actions.</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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="../../actions/DeleteOrphanFiles.html" title="interface in org.apache.iceberg.actions">DeleteOrphanFiles</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteOrphanFiles(org.apache.iceberg.Table)">deleteOrphanFiles</a></span>​(<a href="../../Table.html" title="interface in org.apache.iceberg">Table</a> table)</code></th> |
| <td class="colLast"> |
| <div class="block">Instantiates an action to delete orphan files.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../actions/DeleteReachableFiles.html" title="interface in org.apache.iceberg.actions">DeleteReachableFiles</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteReachableFiles(java.lang.String)">deleteReachableFiles</a></span>​(java.lang.String metadataLocation)</code></th> |
| <td class="colLast"> |
| <div class="block">Instantiates an action to delete all the files reachable from given metadata location.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../actions/ExpireSnapshots.html" title="interface in org.apache.iceberg.actions">ExpireSnapshots</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#expireSnapshots(org.apache.iceberg.Table)">expireSnapshots</a></span>​(<a href="../../Table.html" title="interface in org.apache.iceberg">Table</a> table)</code></th> |
| <td class="colLast"> |
| <div class="block">Instantiates an action to expire snapshots.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="SparkActions.html" title="class in org.apache.iceberg.spark.actions">SparkActions</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get()">get</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="SparkActions.html" title="class in org.apache.iceberg.spark.actions">SparkActions</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(org.apache.spark.sql.SparkSession)">get</a></span>​(org.apache.spark.sql.SparkSession spark)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../actions/MigrateTable.html" title="interface in org.apache.iceberg.actions">MigrateTable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#migrateTable(java.lang.String)">migrateTable</a></span>​(java.lang.String tableIdent)</code></th> |
| <td class="colLast"> |
| <div class="block">Instantiates an action to migrate an existing table to Iceberg.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../actions/RewriteDataFiles.html" title="interface in org.apache.iceberg.actions">RewriteDataFiles</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rewriteDataFiles(org.apache.iceberg.Table)">rewriteDataFiles</a></span>​(<a href="../../Table.html" title="interface in org.apache.iceberg">Table</a> table)</code></th> |
| <td class="colLast"> |
| <div class="block">Instantiates an action to rewrite data files.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../actions/RewriteManifests.html" title="interface in org.apache.iceberg.actions">RewriteManifests</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rewriteManifests(org.apache.iceberg.Table)">rewriteManifests</a></span>​(<a href="../../Table.html" title="interface in org.apache.iceberg">Table</a> table)</code></th> |
| <td class="colLast"> |
| <div class="block">Instantiates an action to rewrite manifests.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../actions/SnapshotTable.html" title="interface in org.apache.iceberg.actions">SnapshotTable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#snapshotTable(java.lang.String)">snapshotTable</a></span>​(java.lang.String tableIdent)</code></th> |
| <td class="colLast"> |
| <div class="block">Instantiates an action to snapshot an existing table as a new Iceberg table.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.spark.sql.SparkSession</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#spark()">spark</a></span>()</code></th> |
| <td class="colLast"> </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> |
| </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="get(org.apache.spark.sql.SparkSession)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre class="methodSignature">public static <a href="SparkActions.html" title="class in org.apache.iceberg.spark.actions">SparkActions</a> get​(org.apache.spark.sql.SparkSession spark)</pre> |
| </li> |
| </ul> |
| <a id="get()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre class="methodSignature">public static <a href="SparkActions.html" title="class in org.apache.iceberg.spark.actions">SparkActions</a> get()</pre> |
| </li> |
| </ul> |
| <a id="snapshotTable(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>snapshotTable</h4> |
| <pre class="methodSignature">public <a href="../../actions/SnapshotTable.html" title="interface in org.apache.iceberg.actions">SnapshotTable</a> snapshotTable​(java.lang.String tableIdent)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../actions/ActionsProvider.html#snapshotTable(java.lang.String)">ActionsProvider</a></code></span></div> |
| <div class="block">Instantiates an action to snapshot an existing table as a new Iceberg table.</div> |
| </li> |
| </ul> |
| <a id="migrateTable(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>migrateTable</h4> |
| <pre class="methodSignature">public <a href="../../actions/MigrateTable.html" title="interface in org.apache.iceberg.actions">MigrateTable</a> migrateTable​(java.lang.String tableIdent)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../actions/ActionsProvider.html#migrateTable(java.lang.String)">ActionsProvider</a></code></span></div> |
| <div class="block">Instantiates an action to migrate an existing table to Iceberg.</div> |
| </li> |
| </ul> |
| <a id="rewriteDataFiles(org.apache.iceberg.Table)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rewriteDataFiles</h4> |
| <pre class="methodSignature">public <a href="../../actions/RewriteDataFiles.html" title="interface in org.apache.iceberg.actions">RewriteDataFiles</a> rewriteDataFiles​(<a href="../../Table.html" title="interface in org.apache.iceberg">Table</a> table)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../actions/ActionsProvider.html#rewriteDataFiles(org.apache.iceberg.Table)">ActionsProvider</a></code></span></div> |
| <div class="block">Instantiates an action to rewrite data files.</div> |
| </li> |
| </ul> |
| <a id="spark()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>spark</h4> |
| <pre class="methodSignature">protected org.apache.spark.sql.SparkSession spark()</pre> |
| </li> |
| </ul> |
| <a id="deleteOrphanFiles(org.apache.iceberg.Table)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteOrphanFiles</h4> |
| <pre class="methodSignature">public <a href="../../actions/DeleteOrphanFiles.html" title="interface in org.apache.iceberg.actions">DeleteOrphanFiles</a> deleteOrphanFiles​(<a href="../../Table.html" title="interface in org.apache.iceberg">Table</a> table)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../actions/ActionsProvider.html#deleteOrphanFiles(org.apache.iceberg.Table)">ActionsProvider</a></code></span></div> |
| <div class="block">Instantiates an action to delete orphan files.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../actions/ActionsProvider.html#deleteOrphanFiles(org.apache.iceberg.Table)">deleteOrphanFiles</a></code> in interface <code><a href="../../actions/ActionsProvider.html" title="interface in org.apache.iceberg.actions">ActionsProvider</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="rewriteManifests(org.apache.iceberg.Table)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rewriteManifests</h4> |
| <pre class="methodSignature">public <a href="../../actions/RewriteManifests.html" title="interface in org.apache.iceberg.actions">RewriteManifests</a> rewriteManifests​(<a href="../../Table.html" title="interface in org.apache.iceberg">Table</a> table)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../actions/ActionsProvider.html#rewriteManifests(org.apache.iceberg.Table)">ActionsProvider</a></code></span></div> |
| <div class="block">Instantiates an action to rewrite manifests.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../actions/ActionsProvider.html#rewriteManifests(org.apache.iceberg.Table)">rewriteManifests</a></code> in interface <code><a href="../../actions/ActionsProvider.html" title="interface in org.apache.iceberg.actions">ActionsProvider</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="expireSnapshots(org.apache.iceberg.Table)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>expireSnapshots</h4> |
| <pre class="methodSignature">public <a href="../../actions/ExpireSnapshots.html" title="interface in org.apache.iceberg.actions">ExpireSnapshots</a> expireSnapshots​(<a href="../../Table.html" title="interface in org.apache.iceberg">Table</a> table)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../actions/ActionsProvider.html#expireSnapshots(org.apache.iceberg.Table)">ActionsProvider</a></code></span></div> |
| <div class="block">Instantiates an action to expire snapshots.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../actions/ActionsProvider.html#expireSnapshots(org.apache.iceberg.Table)">expireSnapshots</a></code> in interface <code><a href="../../actions/ActionsProvider.html" title="interface in org.apache.iceberg.actions">ActionsProvider</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deleteReachableFiles(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>deleteReachableFiles</h4> |
| <pre class="methodSignature">public <a href="../../actions/DeleteReachableFiles.html" title="interface in org.apache.iceberg.actions">DeleteReachableFiles</a> deleteReachableFiles​(java.lang.String metadataLocation)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../actions/ActionsProvider.html#deleteReachableFiles(java.lang.String)">ActionsProvider</a></code></span></div> |
| <div class="block">Instantiates an action to delete all the files reachable from given metadata location.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../actions/ActionsProvider.html#deleteReachableFiles(java.lang.String)">deleteReachableFiles</a></code> in interface <code><a href="../../actions/ActionsProvider.html" title="interface in org.apache.iceberg.actions">ActionsProvider</a></code></dd> |
| </dl> |
| </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> |