| <!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/update_snapshot_reference.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">update_snapshot_reference.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="update__snapshot__reference_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><span class="preprocessor">#include <unordered_map></span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include "iceberg/iceberg_export.h"</span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include "iceberg/result.h"</span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</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="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include "<a class="code" href="pending__update_8h.html">iceberg/update/pending_update.h</a>"</span></div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</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="foldopen00039" data-start="{" data-end="};"> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classiceberg_1_1UpdateSnapshotReference.html"> 39</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1UpdateSnapshotReference.html">UpdateSnapshotReference</a> : <span class="keyword">public</span> <a class="code hl_class" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a> {</div> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">static</span> Result<std::shared_ptr<UpdateSnapshotReference>> Make(</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> std::shared_ptr<Transaction> transaction);</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_class" href="classiceberg_1_1UpdateSnapshotReference.html">~UpdateSnapshotReference</a>() <span class="keyword">override</span>;</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <a class="code hl_class" href="classiceberg_1_1UpdateSnapshotReference.html">UpdateSnapshotReference</a>& CreateBranch(<span class="keyword">const</span> std::string& name, int64_t snapshot_id);</div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <a class="code hl_class" href="classiceberg_1_1UpdateSnapshotReference.html">UpdateSnapshotReference</a>& CreateTag(<span class="keyword">const</span> std::string& name, int64_t snapshot_id);</div> |
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div> |
| <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <a class="code hl_class" href="classiceberg_1_1UpdateSnapshotReference.html">UpdateSnapshotReference</a>& RemoveBranch(<span class="keyword">const</span> std::string& name);</div> |
| <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <a class="code hl_class" href="classiceberg_1_1UpdateSnapshotReference.html">UpdateSnapshotReference</a>& RemoveTag(<span class="keyword">const</span> std::string& name);</div> |
| <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div> |
| <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <a class="code hl_class" href="classiceberg_1_1UpdateSnapshotReference.html">UpdateSnapshotReference</a>& RenameBranch(<span class="keyword">const</span> std::string& name,</div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keyword">const</span> std::string& new_name);</div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <a class="code hl_class" href="classiceberg_1_1UpdateSnapshotReference.html">UpdateSnapshotReference</a>& ReplaceBranch(<span class="keyword">const</span> std::string& name, int64_t snapshot_id);</div> |
| <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div> |
| <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <a class="code hl_class" href="classiceberg_1_1UpdateSnapshotReference.html">UpdateSnapshotReference</a>& ReplaceBranch(<span class="keyword">const</span> std::string& from, <span class="keyword">const</span> std::string& to);</div> |
| <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div> |
| <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <a class="code hl_class" href="classiceberg_1_1UpdateSnapshotReference.html">UpdateSnapshotReference</a>& FastForward(<span class="keyword">const</span> std::string& from, <span class="keyword">const</span> std::string& to);</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_1UpdateSnapshotReference.html">UpdateSnapshotReference</a>& ReplaceTag(<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="l00116" name="l00116"></a><span class="lineno"> 116</span> <a class="code hl_class" href="classiceberg_1_1UpdateSnapshotReference.html">UpdateSnapshotReference</a>& SetMinSnapshotsToKeep(<span class="keyword">const</span> std::string& name,</div> |
| <div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> int32_t min_snapshots_to_keep);</div> |
| <div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> </div> |
| <div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> <a class="code hl_class" href="classiceberg_1_1UpdateSnapshotReference.html">UpdateSnapshotReference</a>& SetMaxSnapshotAgeMs(<span class="keyword">const</span> std::string& name,</div> |
| <div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> int64_t max_snapshot_age_ms);</div> |
| <div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div> |
| <div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> <a class="code hl_class" href="classiceberg_1_1UpdateSnapshotReference.html">UpdateSnapshotReference</a>& SetMaxRefAgeMs(<span class="keyword">const</span> std::string& name,</div> |
| <div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> int64_t max_ref_age_ms);</div> |
| <div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> </div> |
| <div class="line"><a id="l00135" name="l00135"></a><span class="lineno"><a class="line" href="classiceberg_1_1UpdateSnapshotReference.html#a607504fa70250fcbacd8abf5c009dec6"> 135</a></span> Kind <a class="code hl_function" href="classiceberg_1_1UpdateSnapshotReference.html#a607504fa70250fcbacd8abf5c009dec6">kind</a>() const final { <span class="keywordflow">return</span> Kind::kUpdateSnapshotReference; }</div> |
| <div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> </div> |
| <div class="foldopen" id="foldopen00137" data-start="{" data-end="};"> |
| <div class="line"><a id="l00137" name="l00137"></a><span class="lineno"><a class="line" href="structiceberg_1_1UpdateSnapshotReference_1_1ApplyResult.html"> 137</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structiceberg_1_1UpdateSnapshotReference_1_1ApplyResult.html">ApplyResult</a> {</div> |
| <div class="line"><a id="l00139" name="l00139"></a><span class="lineno"><a class="line" href="structiceberg_1_1UpdateSnapshotReference_1_1ApplyResult.html#ad54ce3759a395f19564c67024f235edb"> 139</a></span> std::vector<std::pair<std::string, std::shared_ptr<SnapshotRef>>> <a class="code hl_variable" href="structiceberg_1_1UpdateSnapshotReference_1_1ApplyResult.html#ad54ce3759a395f19564c67024f235edb">to_set</a>;</div> |
| <div class="line"><a id="l00141" name="l00141"></a><span class="lineno"><a class="line" href="structiceberg_1_1UpdateSnapshotReference_1_1ApplyResult.html#ac23bc318d4101f8c3b9be298abc9a3a7"> 141</a></span> std::vector<std::string> <a class="code hl_variable" href="structiceberg_1_1UpdateSnapshotReference_1_1ApplyResult.html#ac23bc318d4101f8c3b9be298abc9a3a7">to_remove</a>;</div> |
| <div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> };</div> |
| </div> |
| <div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> </div> |
| <div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> Result<ApplyResult> Apply();</div> |
| <div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> </div> |
| <div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classiceberg_1_1UpdateSnapshotReference.html">UpdateSnapshotReference</a>(std::shared_ptr<Transaction> transaction);</div> |
| <div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> </div> |
| <div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> <a class="code hl_class" href="classiceberg_1_1UpdateSnapshotReference.html">UpdateSnapshotReference</a>& ReplaceBranchInternal(<span class="keyword">const</span> std::string& from,</div> |
| <div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> <span class="keyword">const</span> std::string& to,</div> |
| <div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> <span class="keywordtype">bool</span> fast_forward);</div> |
| <div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> </div> |
| <div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> std::unordered_map<std::string, std::shared_ptr<SnapshotRef>> updated_refs_;</div> |
| <div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span>};</div> |
| </div> |
| <div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> </div> |
| <div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span>} <span class="comment">// namespace iceberg</span></div> |
| <div class="ttc" id="aclassiceberg_1_1PendingUpdate_html"><div class="ttname"><a href="classiceberg_1_1PendingUpdate.html">iceberg::PendingUpdate</a></div><div class="ttdoc">Base class for all kinds of table metadata updates.</div><div class="ttdef"><b>Definition</b> pending_update.h:42</div></div> |
| <div class="ttc" id="aclassiceberg_1_1UpdateSnapshotReference_html"><div class="ttname"><a href="classiceberg_1_1UpdateSnapshotReference.html">iceberg::UpdateSnapshotReference</a></div><div class="ttdoc">Updates snapshot references.</div><div class="ttdef"><b>Definition</b> update_snapshot_reference.h:39</div></div> |
| <div class="ttc" id="aclassiceberg_1_1UpdateSnapshotReference_html_a607504fa70250fcbacd8abf5c009dec6"><div class="ttname"><a href="classiceberg_1_1UpdateSnapshotReference.html#a607504fa70250fcbacd8abf5c009dec6">iceberg::UpdateSnapshotReference::kind</a></div><div class="ttdeci">Kind kind() const final</div><div class="ttdoc">Return the kind of this pending update.</div><div class="ttdef"><b>Definition</b> update_snapshot_reference.h:135</div></div> |
| <div class="ttc" id="apending__update_8h_html"><div class="ttname"><a href="pending__update_8h.html">pending_update.h</a></div></div> |
| <div class="ttc" id="astructiceberg_1_1UpdateSnapshotReference_1_1ApplyResult_html"><div class="ttname"><a href="structiceberg_1_1UpdateSnapshotReference_1_1ApplyResult.html">iceberg::UpdateSnapshotReference::ApplyResult</a></div><div class="ttdef"><b>Definition</b> update_snapshot_reference.h:137</div></div> |
| <div class="ttc" id="astructiceberg_1_1UpdateSnapshotReference_1_1ApplyResult_html_ac23bc318d4101f8c3b9be298abc9a3a7"><div class="ttname"><a href="structiceberg_1_1UpdateSnapshotReference_1_1ApplyResult.html#ac23bc318d4101f8c3b9be298abc9a3a7">iceberg::UpdateSnapshotReference::ApplyResult::to_remove</a></div><div class="ttdeci">std::vector< std::string > to_remove</div><div class="ttdoc">Reference names to remove.</div><div class="ttdef"><b>Definition</b> update_snapshot_reference.h:141</div></div> |
| <div class="ttc" id="astructiceberg_1_1UpdateSnapshotReference_1_1ApplyResult_html_ad54ce3759a395f19564c67024f235edb"><div class="ttname"><a href="structiceberg_1_1UpdateSnapshotReference_1_1ApplyResult.html#ad54ce3759a395f19564c67024f235edb">iceberg::UpdateSnapshotReference::ApplyResult::to_set</a></div><div class="ttdeci">std::vector< std::pair< std::string, std::shared_ptr< SnapshotRef > > > to_set</div><div class="ttdoc">References to set or update (name, ref pairs)</div><div class="ttdef"><b>Definition</b> update_snapshot_reference.h:139</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> |
