| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.12) on Mon Nov 08 18:33:49 PST 2021 --> |
| <title>ManageSnapshots</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="ManageSnapshots"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="Interface ManageSnapshots" class="title">Interface ManageSnapshots</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</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></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="SnapshotManager.html" title="class in org.apache.iceberg">SnapshotManager</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">ManageSnapshots</span> |
| extends <a href="PendingUpdate.html" title="interface in org.apache.iceberg">PendingUpdate</a><<a href="Snapshot.html" title="interface in org.apache.iceberg">Snapshot</a>></pre> |
| <div class="block">API for managing snapshots. Allows rolling table data back to a stated at an older table <a href="Snapshot.html" title="interface in org.apache.iceberg"><code>snapshot</code></a>. |
| Rollback: |
| <p> |
| This API does not allow conflicting calls to <a href="#setCurrentSnapshot(long)"><code>setCurrentSnapshot(long)</code></a> and |
| <a href="#rollbackToTime(long)"><code>rollbackToTime(long)</code></a>. |
| <p> |
| When committing, these changes will be applied to the current table metadata. Commit conflicts |
| will not be resolved and will result in a <a href="exceptions/CommitFailedException.html" title="class in org.apache.iceberg.exceptions"><code>CommitFailedException</code></a>. |
| Cherrypick: |
| <p> |
| In an audit workflow, new data is written to an orphan <a href="Snapshot.html" title="interface in org.apache.iceberg"><code>snapshot</code></a> that is not committed as |
| the table's current state until it is audited. After auditing a change, it may need to be applied or cherry-picked |
| on top of the latest snapshot instead of the one that was current when the audited changes were created. |
| This class adds support for cherry-picking the changes from an orphan snapshot by applying them to |
| the current snapshot. The output of the operation is a new snapshot with the changes from cherry-picked |
| snapshot. |
| <p></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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cherrypick(long)">cherrypick</a></span>​(long snapshotId)</code></th> |
| <td class="colLast"> |
| <div class="block">Apply supported changes in given snapshot and create a new snapshot which will be set as the |
| current snapshot on commit.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rollbackTo(long)">rollbackTo</a></span>​(long snapshotId)</code></th> |
| <td class="colLast"> |
| <div class="block">Rollback table's state to a specific <a href="Snapshot.html" title="interface in org.apache.iceberg"><code>Snapshot</code></a> identified by id.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rollbackToTime(long)">rollbackToTime</a></span>​(long timestampMillis)</code></th> |
| <td class="colLast"> |
| <div class="block">Roll this table's data back to the last <a href="Snapshot.html" title="interface in org.apache.iceberg"><code>Snapshot</code></a> before the given timestamp.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCurrentSnapshot(long)">setCurrentSnapshot</a></span>​(long snapshotId)</code></th> |
| <td class="colLast"> |
| <div class="block">Roll this table's data back to a specific <a href="Snapshot.html" title="interface in org.apache.iceberg"><code>Snapshot</code></a> identified by id.</div> |
| </td> |
| </tr> |
| </table> |
| <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> |
| </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="setCurrentSnapshot(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCurrentSnapshot</h4> |
| <pre class="methodSignature"><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> setCurrentSnapshot​(long snapshotId)</pre> |
| <div class="block">Roll this table's data back to a specific <a href="Snapshot.html" title="interface in org.apache.iceberg"><code>Snapshot</code></a> identified by id.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snapshotId</code> - long id of the snapshot to roll back table data to</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - If the table has no snapshot with the given id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="rollbackToTime(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rollbackToTime</h4> |
| <pre class="methodSignature"><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> rollbackToTime​(long timestampMillis)</pre> |
| <div class="block">Roll this table's data back to the last <a href="Snapshot.html" title="interface in org.apache.iceberg"><code>Snapshot</code></a> before the given timestamp.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timestampMillis</code> - a long timestamp, as returned by <code>System.currentTimeMillis()</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - If the table has no old snapshot before the given timestamp</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="rollbackTo(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rollbackTo</h4> |
| <pre class="methodSignature"><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> rollbackTo​(long snapshotId)</pre> |
| <div class="block">Rollback table's state to a specific <a href="Snapshot.html" title="interface in org.apache.iceberg"><code>Snapshot</code></a> identified by id.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snapshotId</code> - long id of snapshot id to roll back table to. Must be an ancestor of the current snapshot</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - If the table has no snapshot with the given id</dd> |
| <dd><code><a href="exceptions/ValidationException.html" title="class in org.apache.iceberg.exceptions">ValidationException</a></code> - If given snapshot id is not an ancestor of the current state</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="cherrypick(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>cherrypick</h4> |
| <pre class="methodSignature"><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> cherrypick​(long snapshotId)</pre> |
| <div class="block">Apply supported changes in given snapshot and create a new snapshot which will be set as the |
| current snapshot on commit.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snapshotId</code> - a snapshotId whose changes to apply</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - If the table has no snapshot with the given id</dd> |
| <dd><code><a href="exceptions/DuplicateWAPCommitException.html" title="class in org.apache.iceberg.exceptions">DuplicateWAPCommitException</a></code> - In case of a WAP workflow and if the table has has a duplicate commit with same |
| wapId</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> |
