| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>SnapshotManager</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| <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="SnapshotManager"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":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 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="Class SnapshotManager" class="title">Class SnapshotManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.SnapshotManager</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code>, <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> |
| <hr> |
| <pre>public class <span class="typeNameLabel">SnapshotManager</span> |
| extends java.lang.Object |
| implements <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></pre> |
| </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="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="Snapshot.html" title="interface in org.apache.iceberg">Snapshot</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#apply()">apply</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Apply the pending changes and return the uncommitted changes for validation.</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="#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="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#commit()">commit</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Apply the pending changes and commit.</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="#createBranch(java.lang.String)">createBranch</a></span>​(java.lang.String name)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new branch.</div> |
| </td> |
| </tr> |
| <tr id="i4" 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="#createBranch(java.lang.String,long)">createBranch</a></span>​(java.lang.String name, |
| long snapshotId)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new branch pointing to the given snapshot id.</div> |
| </td> |
| </tr> |
| <tr id="i5" 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="#createTag(java.lang.String,long)">createTag</a></span>​(java.lang.String name, |
| long snapshotId)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new tag pointing to the given snapshot id</div> |
| </td> |
| </tr> |
| <tr id="i6" 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="#fastForwardBranch(java.lang.String,java.lang.String)">fastForwardBranch</a></span>​(java.lang.String name, |
| java.lang.String source)</code></th> |
| <td class="colLast"> |
| <div class="block">Performs a fast-forward of the given target branch up to the source snapshot if target is an |
| ancestor of source.</div> |
| </td> |
| </tr> |
| <tr id="i7" 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="#removeBranch(java.lang.String)">removeBranch</a></span>​(java.lang.String name)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove a branch by name</div> |
| </td> |
| </tr> |
| <tr id="i8" 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="#removeTag(java.lang.String)">removeTag</a></span>​(java.lang.String name)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove the tag with the given name.</div> |
| </td> |
| </tr> |
| <tr id="i9" 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="#renameBranch(java.lang.String,java.lang.String)">renameBranch</a></span>​(java.lang.String name, |
| java.lang.String newName)</code></th> |
| <td class="colLast"> |
| <div class="block">Rename a branch</div> |
| </td> |
| </tr> |
| <tr id="i10" 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="#replaceBranch(java.lang.String,long)">replaceBranch</a></span>​(java.lang.String name, |
| long snapshotId)</code></th> |
| <td class="colLast"> |
| <div class="block">Replaces the branch with the given name to point to the specified snapshot</div> |
| </td> |
| </tr> |
| <tr id="i11" 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="#replaceBranch(java.lang.String,java.lang.String)">replaceBranch</a></span>​(java.lang.String name, |
| java.lang.String source)</code></th> |
| <td class="colLast"> |
| <div class="block">Replaces the branch with the given name to point to the source snapshot.</div> |
| </td> |
| </tr> |
| <tr id="i12" 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="#replaceTag(java.lang.String,long)">replaceTag</a></span>​(java.lang.String name, |
| long snapshotId)</code></th> |
| <td class="colLast"> |
| <div class="block">Replaces the tag with the given name to point to the specified snapshot.</div> |
| </td> |
| </tr> |
| <tr id="i13" 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="i14" 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="i15" 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> |
| <tr id="i16" 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="#setMaxRefAgeMs(java.lang.String,long)">setMaxRefAgeMs</a></span>​(java.lang.String name, |
| long maxRefAgeMs)</code></th> |
| <td class="colLast"> |
| <div class="block">Updates the retention policy for a reference.</div> |
| </td> |
| </tr> |
| <tr id="i17" 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="#setMaxSnapshotAgeMs(java.lang.String,long)">setMaxSnapshotAgeMs</a></span>​(java.lang.String name, |
| long maxSnapshotAgeMs)</code></th> |
| <td class="colLast"> |
| <div class="block">Updates the max snapshot age for a branch.</div> |
| </td> |
| </tr> |
| <tr id="i18" 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="#setMinSnapshotsToKeep(java.lang.String,int)">setMinSnapshotsToKeep</a></span>​(java.lang.String name, |
| int minSnapshotsToKeep)</code></th> |
| <td class="colLast"> |
| <div class="block">Updates the minimum number of snapshots to keep for a branch.</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 java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| <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#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="cherrypick(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cherrypick</h4> |
| <pre class="methodSignature">public <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> cherrypick​(long snapshotId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ManageSnapshots.html#cherrypick(long)">ManageSnapshots</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ManageSnapshots.html#cherrypick(long)">cherrypick</a></code> in interface <code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></dd> |
| <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> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCurrentSnapshot(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCurrentSnapshot</h4> |
| <pre class="methodSignature">public <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> setCurrentSnapshot​(long snapshotId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ManageSnapshots.html#setCurrentSnapshot(long)">ManageSnapshots</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ManageSnapshots.html#setCurrentSnapshot(long)">setCurrentSnapshot</a></code> in interface <code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></dd> |
| <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> |
| </dl> |
| </li> |
| </ul> |
| <a id="rollbackToTime(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rollbackToTime</h4> |
| <pre class="methodSignature">public <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> rollbackToTime​(long timestampMillis)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ManageSnapshots.html#rollbackToTime(long)">ManageSnapshots</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ManageSnapshots.html#rollbackToTime(long)">rollbackToTime</a></code> in interface <code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></dd> |
| <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> |
| </dl> |
| </li> |
| </ul> |
| <a id="rollbackTo(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rollbackTo</h4> |
| <pre class="methodSignature">public <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> rollbackTo​(long snapshotId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ManageSnapshots.html#rollbackTo(long)">ManageSnapshots</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ManageSnapshots.html#rollbackTo(long)">rollbackTo</a></code> in interface <code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></dd> |
| <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> |
| </dl> |
| </li> |
| </ul> |
| <a id="createBranch(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createBranch</h4> |
| <pre class="methodSignature">public <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> createBranch​(java.lang.String name)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ManageSnapshots.html#createBranch(java.lang.String)">ManageSnapshots</a></code></span></div> |
| <div class="block">Create a new branch. The branch will point to current snapshot if the current snapshot is not |
| NULL. Otherwise, the branch will point to a newly created empty snapshot.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ManageSnapshots.html#createBranch(java.lang.String)">createBranch</a></code> in interface <code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - branch name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createBranch(java.lang.String,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createBranch</h4> |
| <pre class="methodSignature">public <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> createBranch​(java.lang.String name, |
| long snapshotId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ManageSnapshots.html#createBranch(java.lang.String,long)">ManageSnapshots</a></code></span></div> |
| <div class="block">Create a new branch pointing to the given snapshot id.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ManageSnapshots.html#createBranch(java.lang.String,long)">createBranch</a></code> in interface <code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - branch name</dd> |
| <dd><code>snapshotId</code> - id of the snapshot which will be the head of the branch</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createTag(java.lang.String,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTag</h4> |
| <pre class="methodSignature">public <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> createTag​(java.lang.String name, |
| long snapshotId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ManageSnapshots.html#createTag(java.lang.String,long)">ManageSnapshots</a></code></span></div> |
| <div class="block">Create a new tag pointing to the given snapshot id</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ManageSnapshots.html#createTag(java.lang.String,long)">createTag</a></code> in interface <code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - tag name</dd> |
| <dd><code>snapshotId</code> - snapshotId for the head of the new branch.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeBranch(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeBranch</h4> |
| <pre class="methodSignature">public <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> removeBranch​(java.lang.String name)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ManageSnapshots.html#removeBranch(java.lang.String)">ManageSnapshots</a></code></span></div> |
| <div class="block">Remove a branch by name</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ManageSnapshots.html#removeBranch(java.lang.String)">removeBranch</a></code> in interface <code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - branch name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeTag(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeTag</h4> |
| <pre class="methodSignature">public <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> removeTag​(java.lang.String name)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ManageSnapshots.html#removeTag(java.lang.String)">ManageSnapshots</a></code></span></div> |
| <div class="block">Remove the tag with the given name.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ManageSnapshots.html#removeTag(java.lang.String)">removeTag</a></code> in interface <code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - tag name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMinSnapshotsToKeep(java.lang.String,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMinSnapshotsToKeep</h4> |
| <pre class="methodSignature">public <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> setMinSnapshotsToKeep​(java.lang.String name, |
| int minSnapshotsToKeep)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ManageSnapshots.html#setMinSnapshotsToKeep(java.lang.String,int)">ManageSnapshots</a></code></span></div> |
| <div class="block">Updates the minimum number of snapshots to keep for a branch.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ManageSnapshots.html#setMinSnapshotsToKeep(java.lang.String,int)">setMinSnapshotsToKeep</a></code> in interface <code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - branch name</dd> |
| <dd><code>minSnapshotsToKeep</code> - minimum number of snapshots to retain on the branch</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMaxSnapshotAgeMs(java.lang.String,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxSnapshotAgeMs</h4> |
| <pre class="methodSignature">public <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> setMaxSnapshotAgeMs​(java.lang.String name, |
| long maxSnapshotAgeMs)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ManageSnapshots.html#setMaxSnapshotAgeMs(java.lang.String,long)">ManageSnapshots</a></code></span></div> |
| <div class="block">Updates the max snapshot age for a branch.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ManageSnapshots.html#setMaxSnapshotAgeMs(java.lang.String,long)">setMaxSnapshotAgeMs</a></code> in interface <code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - branch name</dd> |
| <dd><code>maxSnapshotAgeMs</code> - maximum snapshot age in milliseconds to retain on branch</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMaxRefAgeMs(java.lang.String,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxRefAgeMs</h4> |
| <pre class="methodSignature">public <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> setMaxRefAgeMs​(java.lang.String name, |
| long maxRefAgeMs)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ManageSnapshots.html#setMaxRefAgeMs(java.lang.String,long)">ManageSnapshots</a></code></span></div> |
| <div class="block">Updates the retention policy for a reference.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ManageSnapshots.html#setMaxRefAgeMs(java.lang.String,long)">setMaxRefAgeMs</a></code> in interface <code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - branch name</dd> |
| <dd><code>maxRefAgeMs</code> - retention age in milliseconds of the tag reference itself</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="replaceTag(java.lang.String,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceTag</h4> |
| <pre class="methodSignature">public <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> replaceTag​(java.lang.String name, |
| long snapshotId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ManageSnapshots.html#replaceTag(java.lang.String,long)">ManageSnapshots</a></code></span></div> |
| <div class="block">Replaces the tag with the given name to point to the specified snapshot.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ManageSnapshots.html#replaceTag(java.lang.String,long)">replaceTag</a></code> in interface <code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Tag to replace</dd> |
| <dd><code>snapshotId</code> - new snapshot id for the given tag</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="replaceBranch(java.lang.String,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceBranch</h4> |
| <pre class="methodSignature">public <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> replaceBranch​(java.lang.String name, |
| long snapshotId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ManageSnapshots.html#replaceBranch(java.lang.String,long)">ManageSnapshots</a></code></span></div> |
| <div class="block">Replaces the branch with the given name to point to the specified snapshot</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ManageSnapshots.html#replaceBranch(java.lang.String,long)">replaceBranch</a></code> in interface <code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Branch to replace</dd> |
| <dd><code>snapshotId</code> - new snapshot id for the given branch</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="replaceBranch(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceBranch</h4> |
| <pre class="methodSignature">public <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> replaceBranch​(java.lang.String name, |
| java.lang.String source)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ManageSnapshots.html#replaceBranch(java.lang.String,java.lang.String)">ManageSnapshots</a></code></span></div> |
| <div class="block">Replaces the branch with the given name to point to the source snapshot. The source branch will |
| remain unchanged, the target branch will retain its retention properties.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ManageSnapshots.html#replaceBranch(java.lang.String,java.lang.String)">replaceBranch</a></code> in interface <code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Branch to replace</dd> |
| <dd><code>source</code> - Source reference for the target to be replaced with</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fastForwardBranch(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fastForwardBranch</h4> |
| <pre class="methodSignature">public <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> fastForwardBranch​(java.lang.String name, |
| java.lang.String source)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ManageSnapshots.html#fastForwardBranch(java.lang.String,java.lang.String)">ManageSnapshots</a></code></span></div> |
| <div class="block">Performs a fast-forward of the given target branch up to the source snapshot if target is an |
| ancestor of source. The source branch will remain unchanged, the target branch will retain its |
| retention properties.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ManageSnapshots.html#fastForwardBranch(java.lang.String,java.lang.String)">fastForwardBranch</a></code> in interface <code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Branch to fast-forward</dd> |
| <dd><code>source</code> - Source reference for the target to be fast forwarded to</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="renameBranch(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renameBranch</h4> |
| <pre class="methodSignature">public <a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a> renameBranch​(java.lang.String name, |
| java.lang.String newName)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ManageSnapshots.html#renameBranch(java.lang.String,java.lang.String)">ManageSnapshots</a></code></span></div> |
| <div class="block">Rename a branch</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ManageSnapshots.html#renameBranch(java.lang.String,java.lang.String)">renameBranch</a></code> in interface <code><a href="ManageSnapshots.html" title="interface in org.apache.iceberg">ManageSnapshots</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of branch to rename</dd> |
| <dd><code>newName</code> - the desired new name of the branch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="apply()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>apply</h4> |
| <pre class="methodSignature">public <a href="Snapshot.html" title="interface in org.apache.iceberg">Snapshot</a> apply()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="PendingUpdate.html#apply()">PendingUpdate</a></code></span></div> |
| <div class="block">Apply the pending changes and return the uncommitted changes for validation. |
| |
| <p>This does not result in a permanent update.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="PendingUpdate.html#apply()">apply</a></code> in interface <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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the uncommitted changes that would be committed by calling <a href="PendingUpdate.html#commit()"><code>PendingUpdate.commit()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="commit()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>commit</h4> |
| <pre class="methodSignature">public void commit()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="PendingUpdate.html#commit()">PendingUpdate</a></code></span></div> |
| <div class="block">Apply the pending changes and commit. |
| |
| <p>Changes are committed by calling the underlying table's commit method. |
| |
| <p>Once the commit is successful, the updated table will be refreshed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="PendingUpdate.html#commit()">commit</a></code> in interface <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> |
| </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> |
