| <!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/pending_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_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_6d010e03372010f41233a7d3a31e0117.html">update</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">pending_update.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="pending__update_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="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 <memory></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include "<a class="code" href="iceberg__export_8h.html">iceberg/iceberg_export.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="result_8h.html">iceberg/result.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="type__fwd_8h.html">iceberg/type_fwd.h</a>"</span></div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</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="l00031" name="l00031"></a><span class="lineno"> 31</span> </div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg.html">iceberg</a> {</div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div> |
| <div class="foldopen" id="foldopen00041" data-start="{" data-end="};"> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classiceberg_1_1PendingUpdate.html"> 41</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a> : <span class="keyword">public</span> <a class="code hl_class" href="classiceberg_1_1ErrorCollector.html">ErrorCollector</a> {</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">enum class</span> Kind : uint8_t {</div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> kExpireSnapshots,</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> kSetSnapshot,</div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> kUpdateLocation,</div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> kUpdatePartitionSpec,</div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> kUpdatePartitionStatistics,</div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> kUpdateProperties,</div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> kUpdateSchema,</div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> kUpdateSnapshot,</div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> kUpdateSnapshotReference,</div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> kUpdateSortOrder,</div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> kUpdateStatistics,</div> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> };</div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="classiceberg_1_1PendingUpdate.html#a33fba65ffa4a85fd7c5b9984cb892812"> 58</a></span> <span class="keyword">virtual</span> Kind <a class="code hl_function" href="classiceberg_1_1PendingUpdate.html#a33fba65ffa4a85fd7c5b9984cb892812">kind</a>() <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="classiceberg_1_1PendingUpdate.html#aa2a0ff4c156fe5852d1d52bf5827db7e"> 61</a></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classiceberg_1_1PendingUpdate.html#aa2a0ff4c156fe5852d1d52bf5827db7e">IsRetryable</a>() <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="classiceberg_1_1PendingUpdate.html#afba99263e2feaaca88c7fae906e4f7e3"> 69</a></span> <span class="keyword">virtual</span> Status <a class="code hl_function" href="classiceberg_1_1PendingUpdate.html#afba99263e2feaaca88c7fae906e4f7e3">Commit</a>();</div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="classiceberg_1_1PendingUpdate.html#aba199b10d447c265c7a917568dfa729f"> 79</a></span> <span class="keyword">virtual</span> Status <a class="code hl_function" href="classiceberg_1_1PendingUpdate.html#aba199b10d447c265c7a917568dfa729f">Finalize</a>(<a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<const TableMetadata*></a> commit_result);</div> |
| <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div> |
| <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="comment">// Non-copyable, movable</span></div> |
| <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <a class="code hl_class" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a>(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a>&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <a class="code hl_class" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a>& operator=(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a>&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <a class="code hl_class" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a>(<a class="code hl_class" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a>&&) noexcept = default;</div> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <a class="code hl_class" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a>& operator=(<a class="code hl_class" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a>&&) noexcept = default;</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> ~<a class="code hl_class" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a>() override;</div> |
| <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div> |
| <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> protected:</div> |
| <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> explicit <a class="code hl_class" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a>(<a class="code hl_namespace" href="namespacestd.html">std</a>::shared_ptr<<a class="code hl_class" href="classiceberg_1_1TransactionContext.html">TransactionContext</a>> ctx);</div> |
| <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div> |
| <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> const <a class="code hl_struct" href="structiceberg_1_1TableMetadata.html">TableMetadata</a>& base() const;</div> |
| <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div> |
| <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <a class="code hl_namespace" href="namespacestd.html">std</a>::shared_ptr<<a class="code hl_class" href="classiceberg_1_1TransactionContext.html">TransactionContext</a>> ctx_;</div> |
| <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>};</div> |
| </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>} <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_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:41</div></div> |
| <div class="ttc" id="aclassiceberg_1_1PendingUpdate_html_a33fba65ffa4a85fd7c5b9984cb892812"><div class="ttname"><a href="classiceberg_1_1PendingUpdate.html#a33fba65ffa4a85fd7c5b9984cb892812">iceberg::PendingUpdate::kind</a></div><div class="ttdeci">virtual Kind kind() const =0</div><div class="ttdoc">Return the kind of this pending update.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1PendingUpdate_html_aa2a0ff4c156fe5852d1d52bf5827db7e"><div class="ttname"><a href="classiceberg_1_1PendingUpdate.html#aa2a0ff4c156fe5852d1d52bf5827db7e">iceberg::PendingUpdate::IsRetryable</a></div><div class="ttdeci">virtual bool IsRetryable() const =0</div><div class="ttdoc">Whether this update can be retried after a commit conflict.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1PendingUpdate_html_aba199b10d447c265c7a917568dfa729f"><div class="ttname"><a href="classiceberg_1_1PendingUpdate.html#aba199b10d447c265c7a917568dfa729f">iceberg::PendingUpdate::Finalize</a></div><div class="ttdeci">virtual Status Finalize(Result< const TableMetadata * > commit_result)</div><div class="ttdoc">Finalize the pending update.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1PendingUpdate_html_afba99263e2feaaca88c7fae906e4f7e3"><div class="ttname"><a href="classiceberg_1_1PendingUpdate.html#afba99263e2feaaca88c7fae906e4f7e3">iceberg::PendingUpdate::Commit</a></div><div class="ttdeci">virtual Status Commit()</div><div class="ttdoc">Apply the pending changes and commit.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1TransactionContext_html"><div class="ttname"><a href="classiceberg_1_1TransactionContext.html">iceberg::TransactionContext</a></div><div class="ttdoc">Shared context between Transaction and PendingUpdate instances.</div><div class="ttdef"><b>Definition</b> transaction.h:184</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="aiceberg__export_8h_html"><div class="ttname"><a href="iceberg__export_8h.html">iceberg_export.h</a></div><div class="ttdoc">Define symbol visibility macros for core Iceberg APIs.</div></div> |
| <div class="ttc" id="anamespaceiceberg_html"><div class="ttname"><a href="namespaceiceberg.html">iceberg</a></div><div class="ttdoc">Core Apache Iceberg C++ APIs.</div><div class="ttdef"><b>Definition</b> arrow_io_util.h:33</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_a9d5594e371beb516b0120e07e69d3af6"><div class="ttname"><a href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">iceberg::Result</a></div><div class="ttdeci">std::expected< T, E > Result</div><div class="ttdoc">Result alias.</div><div class="ttdef"><b>Definition</b> result.h:88</div></div> |
| <div class="ttc" id="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdoc">STL namespace.</div></div> |
| <div class="ttc" id="aresult_8h_html"><div class="ttname"><a href="result_8h.html">result.h</a></div><div class="ttdoc">Define Result, Status, and error helpers.</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:73</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> |
