| <!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_update.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_update.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <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 <functional></span></div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <optional></span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <span></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include <unordered_map></span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include <unordered_set></span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include <vector></span></div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include "iceberg/iceberg_export.h"</span></div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include "iceberg/result.h"</span></div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include "iceberg/snapshot.h"</span></div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</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="l00035" name="l00035"></a><span class="lineno"> 35</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="l00036" name="l00036"></a><span class="lineno"> 36</span> </div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">namespace </span>iceberg {</div> |
| <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div> |
| <div class="foldopen" id="foldopen00043" data-start="{" data-end="};"> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="classiceberg_1_1SnapshotUpdate.html"> 43</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1SnapshotUpdate.html">SnapshotUpdate</a> : <span class="keyword">public</span> <a class="code hl_class" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a> {</div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">public</span>:</div> |
| <div class="foldopen" id="foldopen00046" data-start="{" data-end="};"> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="structiceberg_1_1SnapshotUpdate_1_1ApplyResult.html"> 46</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structiceberg_1_1SnapshotUpdate_1_1ApplyResult.html">ApplyResult</a> {</div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> std::shared_ptr<Snapshot> snapshot;</div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> std::string target_branch;</div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">bool</span> stage_only = <span class="keyword">false</span>;</div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> };</div> |
| </div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <a class="code hl_class" href="classiceberg_1_1SnapshotUpdate.html">~SnapshotUpdate</a>() <span class="keyword">override</span>;</div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="classiceberg_1_1SnapshotUpdate.html#ae194773e0ce37df3780121314322f440"> 54</a></span> Kind <a class="code hl_function" href="classiceberg_1_1SnapshotUpdate.html#ae194773e0ce37df3780121314322f440">kind</a>()<span class="keyword"> const override </span>{ <span class="keywordflow">return</span> Kind::kUpdateSnapshot; }</div> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div> |
| <div class="foldopen" id="foldopen00061" data-start="{" data-end="}"> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="classiceberg_1_1SnapshotUpdate.html#af5a84c539ec3c559260b3c6b868943c7"> 61</a></span> <span class="keyword">auto</span>& <a class="code hl_function" href="classiceberg_1_1SnapshotUpdate.html#af5a84c539ec3c559260b3c6b868943c7">DeleteWith</a>(<span class="keyword">this</span> <span class="keyword">auto</span>& self,</div> |
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> std::function<Status(<span class="keyword">const</span> std::string&)> delete_func) {</div> |
| <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keywordflow">if</span> (self.delete_func_) {</div> |
| <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keywordflow">return</span> self.AddError(ErrorKind::kInvalidArgument,</div> |
| <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="stringliteral">"Cannot set delete callback more than once"</span>);</div> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> }</div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> self.delete_func_ = std::move(delete_func);</div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keywordflow">return</span> self;</div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> }</div> |
| </div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div> |
| <div class="foldopen" id="foldopen00074" data-start="{" data-end="}"> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="classiceberg_1_1SnapshotUpdate.html#a43f427fe952631fffdd3c19e0c5ef434"> 74</a></span> <span class="keyword">auto</span>& <a class="code hl_function" href="classiceberg_1_1SnapshotUpdate.html#a43f427fe952631fffdd3c19e0c5ef434">StageOnly</a>(<span class="keyword">this</span> <span class="keyword">auto</span>& self) {</div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> self.stage_only_ = <span class="keyword">true</span>;</div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keywordflow">return</span> self;</div> |
| <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> }</div> |
| </div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div> |
| <div class="foldopen" id="foldopen00083" data-start="{" data-end="}"> |
| <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="classiceberg_1_1SnapshotUpdate.html#a54d0274b7b6cc60f212182265c331293"> 83</a></span> <span class="keyword">auto</span>& <a class="code hl_function" href="classiceberg_1_1SnapshotUpdate.html#a54d0274b7b6cc60f212182265c331293">SetTargetBranch</a>(<span class="keyword">this</span> <span class="keyword">auto</span>& self, <span class="keyword">const</span> std::string& branch) {</div> |
| <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordflow">if</span> (branch.empty()) [[unlikely]] {</div> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="keywordflow">return</span> self.AddError(ErrorKind::kInvalidArgument, <span class="stringliteral">"Branch name cannot be empty"</span>);</div> |
| <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> }</div> |
| <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div> |
| <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordflow">if</span> (<span class="keyword">auto</span> ref_it = self.base().refs.find(branch); ref_it != self.base().refs.end()) {</div> |
| <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keywordflow">if</span> (ref_it->second->type() != SnapshotRefType::kBranch) {</div> |
| <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keywordflow">return</span> self.AddError(ErrorKind::kInvalidArgument,</div> |
| <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="stringliteral">"{} is a tag, not a branch. Tags cannot be targets for "</span></div> |
| <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="stringliteral">"producing snapshots"</span>,</div> |
| <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> branch);</div> |
| <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> }</div> |
| <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> }</div> |
| <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div> |
| <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> self.target_branch_ = branch;</div> |
| <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keywordflow">return</span> self;</div> |
| <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> }</div> |
| </div> |
| <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div> |
| <div class="foldopen" id="foldopen00106" data-start="{" data-end="}"> |
| <div class="line"><a id="l00106" name="l00106"></a><span class="lineno"><a class="line" href="classiceberg_1_1SnapshotUpdate.html#ae19b638ceb6b7e57e4096ec943db223b"> 106</a></span> <span class="keyword">auto</span>& <a class="code hl_function" href="classiceberg_1_1SnapshotUpdate.html#ae19b638ceb6b7e57e4096ec943db223b">Set</a>(<span class="keyword">this</span> <span class="keyword">auto</span>& self, <span class="keyword">const</span> std::string& property, <span class="keyword">const</span> std::string& value) {</div> |
| <div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> self.summary_.Set(property, value);</div> |
| <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <span class="keywordflow">return</span> self;</div> |
| <div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> }</div> |
| </div> |
| <div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div> |
| <div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> Result<ApplyResult> Apply();</div> |
| <div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> </div> |
| <div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> Status Finalize(std::optional<Error> commit_error) <span class="keyword">override</span>;</div> |
| <div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> </div> |
| <div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <span class="keyword">protected</span>:</div> |
| <div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classiceberg_1_1SnapshotUpdate.html">SnapshotUpdate</a>(std::shared_ptr<Transaction> transaction);</div> |
| <div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div> |
| <div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> Result<std::vector<ManifestFile>> WriteDataManifests(</div> |
| <div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> std::span<<span class="keyword">const</span> std::shared_ptr<DataFile>> files,</div> |
| <div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <span class="keyword">const</span> std::shared_ptr<PartitionSpec>& spec,</div> |
| <div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> std::optional<int64_t> data_sequence_number = std::nullopt);</div> |
| <div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> </div> |
| <div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> Result<std::vector<ManifestFile>> WriteDeleteManifests(</div> |
| <div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> std::span<<span class="keyword">const</span> std::shared_ptr<DataFile>> files,</div> |
| <div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> <span class="keyword">const</span> std::shared_ptr<PartitionSpec>& spec);</div> |
| <div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> </div> |
| <div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> <span class="keyword">const</span> std::string& target_branch()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> target_branch_; }</div> |
| <div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> <span class="keywordtype">bool</span> can_inherit_snapshot_id()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> can_inherit_snapshot_id_; }</div> |
| <div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> <span class="keyword">const</span> std::string& commit_uuid()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> commit_uuid_; }</div> |
| <div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> int32_t manifest_count()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> manifest_count_; }</div> |
| <div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> int32_t attempt()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> attempt_; }</div> |
| <div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> int64_t target_manifest_size_bytes()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> target_manifest_size_bytes_; }</div> |
| <div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> </div> |
| <div class="line"><a id="l00163" name="l00163"></a><span class="lineno"><a class="line" href="classiceberg_1_1SnapshotUpdate.html#a582e2766881ada1c8d07aa0c738449e6"> 163</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classiceberg_1_1SnapshotUpdate.html#a582e2766881ada1c8d07aa0c738449e6">CleanUncommitted</a>(<span class="keyword">const</span> std::unordered_set<std::string>& committed) = 0;</div> |
| <div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> </div> |
| <div class="line"><a id="l00168" name="l00168"></a><span class="lineno"><a class="line" href="classiceberg_1_1SnapshotUpdate.html#a7e5cb52a426032eebf3b602b5674c5e0"> 168</a></span> <span class="keyword">virtual</span> std::string <a class="code hl_function" href="classiceberg_1_1SnapshotUpdate.html#a7e5cb52a426032eebf3b602b5674c5e0">operation</a>() = 0;</div> |
| <div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> </div> |
| <div class="foldopen" id="foldopen00176" data-start="{" data-end="}"> |
| <div class="line"><a id="l00176" name="l00176"></a><span class="lineno"><a class="line" href="classiceberg_1_1SnapshotUpdate.html#aa2d22d7708df6b17bfa53e40abb32f86"> 176</a></span> <span class="keyword">virtual</span> Status <a class="code hl_function" href="classiceberg_1_1SnapshotUpdate.html#aa2d22d7708df6b17bfa53e40abb32f86">Validate</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1TableMetadata.html">TableMetadata</a>& current_metadata,</div> |
| <div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> <span class="keyword">const</span> std::shared_ptr<Snapshot>& snapshot) {</div> |
| <div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> <span class="keywordflow">return</span> {};</div> |
| <div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> };</div> |
| </div> |
| <div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> </div> |
| <div class="line"><a id="l00186" name="l00186"></a><span class="lineno"><a class="line" href="classiceberg_1_1SnapshotUpdate.html#a0d1e461184dd3aa553269ef736202ced"> 186</a></span> <span class="keyword">virtual</span> Result<std::vector<ManifestFile>> <a class="code hl_function" href="classiceberg_1_1SnapshotUpdate.html#a0d1e461184dd3aa553269ef736202ced">Apply</a>(</div> |
| <div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> <span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1TableMetadata.html">TableMetadata</a>& metadata_to_update,</div> |
| <div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> <span class="keyword">const</span> std::shared_ptr<Snapshot>& snapshot) = 0;</div> |
| <div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> </div> |
| <div class="line"><a id="l00193" name="l00193"></a><span class="lineno"><a class="line" href="classiceberg_1_1SnapshotUpdate.html#a193bc595ce86911870731a8eebf5950e"> 193</a></span> <span class="keyword">virtual</span> std::unordered_map<std::string, std::string> <a class="code hl_function" href="classiceberg_1_1SnapshotUpdate.html#a193bc595ce86911870731a8eebf5950e">Summary</a>() = 0;</div> |
| <div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> </div> |
| <div class="line"><a id="l00198" name="l00198"></a><span class="lineno"><a class="line" href="classiceberg_1_1SnapshotUpdate.html#aeb89f2ceb3a0fb2abfba3faa6a32e5ac"> 198</a></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classiceberg_1_1SnapshotUpdate.html#aeb89f2ceb3a0fb2abfba3faa6a32e5ac">CleanupAfterCommit</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">true</span>; }</div> |
| <div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> </div> |
| <div class="line"><a id="l00201" name="l00201"></a><span class="lineno"> 201</span> int64_t SnapshotId();</div> |
| <div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span> </div> |
| <div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> Status DeleteFile(<span class="keyword">const</span> std::string& path);</div> |
| <div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span> </div> |
| <div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span> std::string ManifestPath();</div> |
| <div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span> std::string ManifestListPath();</div> |
| <div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> <a class="code hl_class" href="classiceberg_1_1SnapshotSummaryBuilder.html">SnapshotSummaryBuilder</a>& summary_builder() { <span class="keywordflow">return</span> summary_; }</div> |
| <div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> </div> |
| <div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> Result<std::unordered_map<std::string, std::string>> ComputeSummary(</div> |
| <div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> <span class="keyword">const</span> TableMetadata& previous);</div> |
| <div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span> </div> |
| <div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span> <span class="keywordtype">void</span> CleanAll();</div> |
| <div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> </div> |
| <div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> <span class="keyword">protected</span>:</div> |
| <div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> SnapshotSummaryBuilder summary_;</div> |
| <div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> </div> |
| <div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> can_inherit_snapshot_id_{<span class="keyword">true</span>};</div> |
| <div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> <span class="keyword">const</span> std::string commit_uuid_;</div> |
| <div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span> int32_t manifest_count_{0};</div> |
| <div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span> int32_t attempt_{0};</div> |
| <div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span> std::vector<std::string> manifest_lists_;</div> |
| <div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> <span class="keyword">const</span> int64_t target_manifest_size_bytes_;</div> |
| <div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> std::optional<int64_t> snapshot_id_;</div> |
| <div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span> <span class="keywordtype">bool</span> stage_only_{<span class="keyword">false</span>};</div> |
| <div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> std::function<Status(<span class="keyword">const</span> std::string&)> delete_func_;</div> |
| <div class="line"><a id="l00234" name="l00234"></a><span class="lineno"> 234</span> std::string target_branch_{SnapshotRef::kMainBranch};</div> |
| <div class="line"><a id="l00235" name="l00235"></a><span class="lineno"> 235</span> std::shared_ptr<Snapshot> staged_snapshot_;</div> |
| <div class="line"><a id="l00236" name="l00236"></a><span class="lineno"> 236</span>};</div> |
| </div> |
| <div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span> </div> |
| <div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</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_1SnapshotSummaryBuilder_html"><div class="ttname"><a href="classiceberg_1_1SnapshotSummaryBuilder.html">iceberg::SnapshotSummaryBuilder</a></div><div class="ttdoc">Helper class for building snapshot summaries.</div><div class="ttdef"><b>Definition</b> snapshot.h:260</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SnapshotUpdate_html"><div class="ttname"><a href="classiceberg_1_1SnapshotUpdate.html">iceberg::SnapshotUpdate</a></div><div class="ttdoc">Base class for operations that produce snapshots.</div><div class="ttdef"><b>Definition</b> snapshot_update.h:43</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SnapshotUpdate_html_a0d1e461184dd3aa553269ef736202ced"><div class="ttname"><a href="classiceberg_1_1SnapshotUpdate.html#a0d1e461184dd3aa553269ef736202ced">iceberg::SnapshotUpdate::Apply</a></div><div class="ttdeci">virtual Result< std::vector< ManifestFile > > Apply(const TableMetadata &metadata_to_update, const std::shared_ptr< Snapshot > &snapshot)=0</div><div class="ttdoc">Apply the update's changes to the given metadata and snapshot.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SnapshotUpdate_html_a193bc595ce86911870731a8eebf5950e"><div class="ttname"><a href="classiceberg_1_1SnapshotUpdate.html#a193bc595ce86911870731a8eebf5950e">iceberg::SnapshotUpdate::Summary</a></div><div class="ttdeci">virtual std::unordered_map< std::string, std::string > Summary()=0</div><div class="ttdoc">Get the summary map for this operation.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SnapshotUpdate_html_a43f427fe952631fffdd3c19e0c5ef434"><div class="ttname"><a href="classiceberg_1_1SnapshotUpdate.html#a43f427fe952631fffdd3c19e0c5ef434">iceberg::SnapshotUpdate::StageOnly</a></div><div class="ttdeci">auto & StageOnly(this auto &self)</div><div class="ttdoc">Stage a snapshot in table metadata, but not update the current snapshot id.</div><div class="ttdef"><b>Definition</b> snapshot_update.h:74</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SnapshotUpdate_html_a54d0274b7b6cc60f212182265c331293"><div class="ttname"><a href="classiceberg_1_1SnapshotUpdate.html#a54d0274b7b6cc60f212182265c331293">iceberg::SnapshotUpdate::SetTargetBranch</a></div><div class="ttdeci">auto & SetTargetBranch(this auto &self, const std::string &branch)</div><div class="ttdoc">Perform operations on a particular branch.</div><div class="ttdef"><b>Definition</b> snapshot_update.h:83</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SnapshotUpdate_html_a582e2766881ada1c8d07aa0c738449e6"><div class="ttname"><a href="classiceberg_1_1SnapshotUpdate.html#a582e2766881ada1c8d07aa0c738449e6">iceberg::SnapshotUpdate::CleanUncommitted</a></div><div class="ttdeci">virtual void CleanUncommitted(const std::unordered_set< std::string > &committed)=0</div><div class="ttdoc">Clean up any uncommitted manifests that were created.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SnapshotUpdate_html_a7e5cb52a426032eebf3b602b5674c5e0"><div class="ttname"><a href="classiceberg_1_1SnapshotUpdate.html#a7e5cb52a426032eebf3b602b5674c5e0">iceberg::SnapshotUpdate::operation</a></div><div class="ttdeci">virtual std::string operation()=0</div><div class="ttdoc">A string that describes the action that produced the new snapshot.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SnapshotUpdate_html_aa2d22d7708df6b17bfa53e40abb32f86"><div class="ttname"><a href="classiceberg_1_1SnapshotUpdate.html#aa2d22d7708df6b17bfa53e40abb32f86">iceberg::SnapshotUpdate::Validate</a></div><div class="ttdeci">virtual Status Validate(const TableMetadata &current_metadata, const std::shared_ptr< Snapshot > &snapshot)</div><div class="ttdoc">Validate the current metadata.</div><div class="ttdef"><b>Definition</b> snapshot_update.h:176</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SnapshotUpdate_html_ae194773e0ce37df3780121314322f440"><div class="ttname"><a href="classiceberg_1_1SnapshotUpdate.html#ae194773e0ce37df3780121314322f440">iceberg::SnapshotUpdate::kind</a></div><div class="ttdeci">Kind kind() const override</div><div class="ttdoc">Return the kind of this pending update.</div><div class="ttdef"><b>Definition</b> snapshot_update.h:54</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SnapshotUpdate_html_ae19b638ceb6b7e57e4096ec943db223b"><div class="ttname"><a href="classiceberg_1_1SnapshotUpdate.html#ae19b638ceb6b7e57e4096ec943db223b">iceberg::SnapshotUpdate::Set</a></div><div class="ttdeci">auto & Set(this auto &self, const std::string &property, const std::string &value)</div><div class="ttdoc">Set a summary property.</div><div class="ttdef"><b>Definition</b> snapshot_update.h:106</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SnapshotUpdate_html_aeb89f2ceb3a0fb2abfba3faa6a32e5ac"><div class="ttname"><a href="classiceberg_1_1SnapshotUpdate.html#aeb89f2ceb3a0fb2abfba3faa6a32e5ac">iceberg::SnapshotUpdate::CleanupAfterCommit</a></div><div class="ttdeci">virtual bool CleanupAfterCommit() const</div><div class="ttdoc">Check if cleanup should happen after commit.</div><div class="ttdef"><b>Definition</b> snapshot_update.h:198</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SnapshotUpdate_html_af5a84c539ec3c559260b3c6b868943c7"><div class="ttname"><a href="classiceberg_1_1SnapshotUpdate.html#af5a84c539ec3c559260b3c6b868943c7">iceberg::SnapshotUpdate::DeleteWith</a></div><div class="ttdeci">auto & DeleteWith(this auto &self, std::function< Status(const std::string &)> delete_func)</div><div class="ttdoc">Set a callback to delete files instead of the table's default.</div><div class="ttdef"><b>Definition</b> snapshot_update.h:61</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_1SnapshotUpdate_1_1ApplyResult_html"><div class="ttname"><a href="structiceberg_1_1SnapshotUpdate_1_1ApplyResult.html">iceberg::SnapshotUpdate::ApplyResult</a></div><div class="ttdoc">Result of applying a snapshot update.</div><div class="ttdef"><b>Definition</b> snapshot_update.h:46</div></div> |
| <div class="ttc" id="astructiceberg_1_1TableMetadata_html"><div class="ttname"><a href="structiceberg_1_1TableMetadata.html">iceberg::TableMetadata</a></div><div class="ttdoc">Represents the metadata for an Iceberg table.</div><div class="ttdef"><b>Definition</b> table_metadata.h:72</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> |
