| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.9.8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>iceberg-cpp: iceberg/update/snapshot_manager.h Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">iceberg-cpp |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_f51fe74ea6bc2b1b900619895eaa63be.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_7c4d2c18b625e3dc315ec9d8fd8e35c1.html">update</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">snapshot_manager.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="snapshot__manager_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include "iceberg/iceberg_export.h"</span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include "iceberg/result.h"</span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include "<a class="code" href="type__fwd_8h.html">iceberg/type_fwd.h</a>"</span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include "<a class="code" href="error__collector_8h.html">iceberg/util/error_collector.h</a>"</span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="keyword">namespace </span>iceberg {</div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div> |
| <div class="foldopen" id="foldopen00050" data-start="{" data-end="};"> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classiceberg_1_1SnapshotManager.html"> 50</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a> : <span class="keyword">public</span> <a class="code hl_class" href="classiceberg_1_1ErrorCollector.html">ErrorCollector</a> {</div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">static</span> Result<std::shared_ptr<SnapshotManager>> Make(std::shared_ptr<Table> table);</div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">static</span> Result<std::shared_ptr<SnapshotManager>> Make(</div> |
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> std::shared_ptr<Transaction> transaction);</div> |
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">~SnapshotManager</a>() <span class="keyword">override</span>;</div> |
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>& Cherrypick(int64_t snapshot_id);</div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>& SetCurrentSnapshot(int64_t snapshot_id);</div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div> |
| <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>& RollbackToTime(int64_t timestamp_ms);</div> |
| <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div> |
| <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>& RollbackTo(int64_t snapshot_id);</div> |
| <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div> |
| <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>& CreateBranch(<span class="keyword">const</span> std::string& name);</div> |
| <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div> |
| <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>& CreateBranch(<span class="keyword">const</span> std::string& name, int64_t snapshot_id);</div> |
| <div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> </div> |
| <div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>& CreateTag(<span class="keyword">const</span> std::string& name, int64_t snapshot_id);</div> |
| <div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div> |
| <div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>& RemoveBranch(<span class="keyword">const</span> std::string& name);</div> |
| <div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> </div> |
| <div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>& RemoveTag(<span class="keyword">const</span> std::string& name);</div> |
| <div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> </div> |
| <div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>& ReplaceTag(<span class="keyword">const</span> std::string& name, int64_t snapshot_id);</div> |
| <div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> </div> |
| <div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>& ReplaceBranch(<span class="keyword">const</span> std::string& name, int64_t snapshot_id);</div> |
| <div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> </div> |
| <div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>& ReplaceBranch(<span class="keyword">const</span> std::string& from, <span class="keyword">const</span> std::string& to);</div> |
| <div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> </div> |
| <div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>& FastForwardBranch(<span class="keyword">const</span> std::string& from, <span class="keyword">const</span> std::string& to);</div> |
| <div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> </div> |
| <div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>& RenameBranch(<span class="keyword">const</span> std::string& name, <span class="keyword">const</span> std::string& new_name);</div> |
| <div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> </div> |
| <div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>& SetMinSnapshotsToKeep(<span class="keyword">const</span> std::string& branch_name,</div> |
| <div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> int32_t min_snapshots_to_keep);</div> |
| <div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> </div> |
| <div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>& SetMaxSnapshotAgeMs(<span class="keyword">const</span> std::string& branch_name,</div> |
| <div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> int64_t max_snapshot_age_ms);</div> |
| <div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> </div> |
| <div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>& SetMaxRefAgeMs(<span class="keyword">const</span> std::string& name, int64_t max_ref_age_ms);</div> |
| <div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> </div> |
| <div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> Status Commit();</div> |
| <div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> </div> |
| <div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span> <a class="code hl_class" href="classiceberg_1_1SnapshotManager.html">SnapshotManager</a>(std::shared_ptr<Transaction> transaction, <span class="keywordtype">bool</span> is_external_transaction);</div> |
| <div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span> </div> |
| <div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span> Result<std::shared_ptr<UpdateSnapshotReference>> UpdateSnapshotReferencesOperation();</div> |
| <div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> </div> |
| <div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span> Status CommitIfRefUpdatesExist();</div> |
| <div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span> </div> |
| <div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span> std::shared_ptr<Transaction> transaction_;</div> |
| <div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> is_external_transaction_;</div> |
| <div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span> std::shared_ptr<UpdateSnapshotReference> update_snap_refs_;</div> |
| <div class="line"><a id="l00201" name="l00201"></a><span class="lineno"> 201</span>};</div> |
| </div> |
| <div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span> </div> |
| <div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span>} <span class="comment">// namespace iceberg</span></div> |
| <div class="ttc" id="aclassiceberg_1_1ErrorCollector_html"><div class="ttname"><a href="classiceberg_1_1ErrorCollector.html">iceberg::ErrorCollector</a></div><div class="ttdoc">Base class for collecting errors in the builder pattern.</div><div class="ttdef"><b>Definition</b> error_collector.h:93</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SnapshotManager_html"><div class="ttname"><a href="classiceberg_1_1SnapshotManager.html">iceberg::SnapshotManager</a></div><div class="ttdoc">API for managing snapshots.</div><div class="ttdef"><b>Definition</b> snapshot_manager.h:50</div></div> |
| <div class="ttc" id="aerror__collector_8h_html"><div class="ttname"><a href="error__collector_8h.html">error_collector.h</a></div></div> |
| <div class="ttc" id="atype__fwd_8h_html"><div class="ttname"><a href="type__fwd_8h.html">type_fwd.h</a></div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 |
| </small></address> |
| </body> |
| </html> |
