| <!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::PendingUpdate Class Reference</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> |
| <!-- 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"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="#pro-attribs">Protected Attributes</a> | |
| <a href="classiceberg_1_1PendingUpdate-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::PendingUpdate Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Base class for all kinds of table metadata updates. |
| <a href="classiceberg_1_1PendingUpdate.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="pending__update_8h_source.html">pending_update.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::PendingUpdate:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1PendingUpdate.png" usemap="#iceberg::PendingUpdate_map" alt=""/> |
| <map id="iceberg::PendingUpdate_map" name="iceberg::PendingUpdate_map"> |
| <area href="classiceberg_1_1ErrorCollector.html" title="Base class for collecting errors in the builder pattern." alt="iceberg::ErrorCollector" shape="rect" coords="0,0,211,24"/> |
| <area href="classiceberg_1_1ExpireSnapshots.html" title="API for removing old snapshots from a table." alt="iceberg::ExpireSnapshots" shape="rect" coords="221,112,432,136"/> |
| <area href="classiceberg_1_1SetSnapshot.html" title="Sets the current snapshot directly or by rolling back." alt="iceberg::SetSnapshot" shape="rect" coords="221,168,432,192"/> |
| <area href="classiceberg_1_1SnapshotUpdate.html" title="Base class for operations that produce snapshots." alt="iceberg::SnapshotUpdate" shape="rect" coords="221,224,432,248"/> |
| <area href="classiceberg_1_1UpdateLocation.html" title="Updating table location with a new base location." alt="iceberg::UpdateLocation" shape="rect" coords="221,280,432,304"/> |
| <area href="classiceberg_1_1UpdatePartitionSpec.html" title="API for partition spec evolution." alt="iceberg::UpdatePartitionSpec" shape="rect" coords="221,336,432,360"/> |
| <area href="classiceberg_1_1UpdatePartitionStatistics.html" title="Updates table partition statistics." alt="iceberg::UpdatePartitionStatistics" shape="rect" coords="221,392,432,416"/> |
| <area href="classiceberg_1_1UpdateProperties.html" title="Updates table properties." alt="iceberg::UpdateProperties" shape="rect" coords="221,448,432,472"/> |
| <area href="classiceberg_1_1UpdateSchema.html" title="API for schema evolution." alt="iceberg::UpdateSchema" shape="rect" coords="221,504,432,528"/> |
| <area href="classiceberg_1_1UpdateSnapshotReference.html" title="Updates snapshot references." alt="iceberg::UpdateSnapshotReference" shape="rect" coords="221,560,432,584"/> |
| <area href="classiceberg_1_1UpdateSortOrder.html" title="Updating table sort order with a newly created order." alt="iceberg::UpdateSortOrder" shape="rect" coords="221,616,432,640"/> |
| <area href="classiceberg_1_1UpdateStatistics.html" title="Updates table statistics." alt="iceberg::UpdateStatistics" shape="rect" coords="221,672,432,696"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:a5bac3f32c6a0790ba222399fed5c1944" id="r_a5bac3f32c6a0790ba222399fed5c1944"><td class="memItemLeft" align="right" valign="top"><a id="a5bac3f32c6a0790ba222399fed5c1944" name="a5bac3f32c6a0790ba222399fed5c1944"></a>enum class  </td><td class="memItemRight" valign="bottom"><b>Kind</b> : uint8_t { <br /> |
|   <b>kExpireSnapshots</b> |
| , <b>kSetSnapshot</b> |
| , <b>kUpdateLocation</b> |
| , <b>kUpdatePartitionSpec</b> |
| , <br /> |
|   <b>kUpdatePartitionStatistics</b> |
| , <b>kUpdateProperties</b> |
| , <b>kUpdateSchema</b> |
| , <b>kUpdateSnapshot</b> |
| , <br /> |
|   <b>kUpdateSnapshotReference</b> |
| , <b>kUpdateSortOrder</b> |
| , <b>kUpdateStatistics</b> |
| <br /> |
| }</td></tr> |
| <tr class="separator:a5bac3f32c6a0790ba222399fed5c1944"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a33fba65ffa4a85fd7c5b9984cb892812" id="r_a33fba65ffa4a85fd7c5b9984cb892812"><td class="memItemLeft" align="right" valign="top">virtual Kind </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1PendingUpdate.html#a33fba65ffa4a85fd7c5b9984cb892812">kind</a> () const =0</td></tr> |
| <tr class="memdesc:a33fba65ffa4a85fd7c5b9984cb892812"><td class="mdescLeft"> </td><td class="mdescRight">Return the kind of this pending update. <br /></td></tr> |
| <tr class="separator:a33fba65ffa4a85fd7c5b9984cb892812"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa2a0ff4c156fe5852d1d52bf5827db7e" id="r_aa2a0ff4c156fe5852d1d52bf5827db7e"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1PendingUpdate.html#aa2a0ff4c156fe5852d1d52bf5827db7e">IsRetryable</a> () const =0</td></tr> |
| <tr class="memdesc:aa2a0ff4c156fe5852d1d52bf5827db7e"><td class="mdescLeft"> </td><td class="mdescRight">Whether this update can be retried after a commit conflict. <br /></td></tr> |
| <tr class="separator:aa2a0ff4c156fe5852d1d52bf5827db7e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4a5df6d83b7a4a3c4dac19a77945be71" id="r_a4a5df6d83b7a4a3c4dac19a77945be71"><td class="memItemLeft" align="right" valign="top">virtual Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1PendingUpdate.html#a4a5df6d83b7a4a3c4dac19a77945be71">Commit</a> ()</td></tr> |
| <tr class="memdesc:a4a5df6d83b7a4a3c4dac19a77945be71"><td class="mdescLeft"> </td><td class="mdescRight">Apply the pending changes and commit. <br /></td></tr> |
| <tr class="separator:a4a5df6d83b7a4a3c4dac19a77945be71"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a60cfd4550ad0d06af250dd03c26bddb3" id="r_a60cfd4550ad0d06af250dd03c26bddb3"><td class="memItemLeft" align="right" valign="top">virtual Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1PendingUpdate.html#a60cfd4550ad0d06af250dd03c26bddb3">Finalize</a> (Result< const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> * > commit_result)</td></tr> |
| <tr class="memdesc:a60cfd4550ad0d06af250dd03c26bddb3"><td class="mdescLeft"> </td><td class="mdescRight">Finalize the pending update. <br /></td></tr> |
| <tr class="separator:a60cfd4550ad0d06af250dd03c26bddb3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac5c3549e22869ad7f6abd417ffcabbe2" id="r_ac5c3549e22869ad7f6abd417ffcabbe2"><td class="memItemLeft" align="right" valign="top"><a id="ac5c3549e22869ad7f6abd417ffcabbe2" name="ac5c3549e22869ad7f6abd417ffcabbe2"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>PendingUpdate</b> (const <a class="el" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a> &)=delete</td></tr> |
| <tr class="separator:ac5c3549e22869ad7f6abd417ffcabbe2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3314053bba6a86931feb39c1487e2c8b" id="r_a3314053bba6a86931feb39c1487e2c8b"><td class="memItemLeft" align="right" valign="top"><a id="a3314053bba6a86931feb39c1487e2c8b" name="a3314053bba6a86931feb39c1487e2c8b"></a> |
| <a class="el" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a> &)=delete</td></tr> |
| <tr class="separator:a3314053bba6a86931feb39c1487e2c8b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a18521611dee09ce7f85477f38d85e75d" id="r_a18521611dee09ce7f85477f38d85e75d"><td class="memItemLeft" align="right" valign="top"><a id="a18521611dee09ce7f85477f38d85e75d" name="a18521611dee09ce7f85477f38d85e75d"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>PendingUpdate</b> (<a class="el" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a> &&) noexcept=default</td></tr> |
| <tr class="separator:a18521611dee09ce7f85477f38d85e75d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9e71d56c145591059c7e2f6ee0305295" id="r_a9e71d56c145591059c7e2f6ee0305295"><td class="memItemLeft" align="right" valign="top"><a id="a9e71d56c145591059c7e2f6ee0305295" name="a9e71d56c145591059c7e2f6ee0305295"></a> |
| <a class="el" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classiceberg_1_1PendingUpdate.html">PendingUpdate</a> &&) noexcept=default</td></tr> |
| <tr class="separator:a9e71d56c145591059c7e2f6ee0305295"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classiceberg_1_1ErrorCollector"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1ErrorCollector')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classiceberg_1_1ErrorCollector.html">iceberg::ErrorCollector</a></td></tr> |
| <tr class="memitem:a827c296a8527f87f76d7f9321e7ee68f inherit pub_methods_classiceberg_1_1ErrorCollector" id="r_a827c296a8527f87f76d7f9321e7ee68f"><td class="memItemLeft" align="right" valign="top"> |
|  </td><td class="memItemRight" valign="bottom"><b>ErrorCollector</b> (<a class="el" href="classiceberg_1_1ErrorCollector.html">ErrorCollector</a> &&)=default</td></tr> |
| <tr class="separator:a827c296a8527f87f76d7f9321e7ee68f inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a22311658715152d8e6e27834240ce446 inherit pub_methods_classiceberg_1_1ErrorCollector" id="r_a22311658715152d8e6e27834240ce446"><td class="memItemLeft" align="right" valign="top"> |
| <a class="el" href="classiceberg_1_1ErrorCollector.html">ErrorCollector</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classiceberg_1_1ErrorCollector.html">ErrorCollector</a> &&)=default</td></tr> |
| <tr class="separator:a22311658715152d8e6e27834240ce446 inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab3fa546cd2748fe418db9c0933542755 inherit pub_methods_classiceberg_1_1ErrorCollector" id="r_ab3fa546cd2748fe418db9c0933542755"><td class="memItemLeft" align="right" valign="top"> |
|  </td><td class="memItemRight" valign="bottom"><b>ErrorCollector</b> (const <a class="el" href="classiceberg_1_1ErrorCollector.html">ErrorCollector</a> &)=default</td></tr> |
| <tr class="separator:ab3fa546cd2748fe418db9c0933542755 inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaba366560be481bfa9538735f3a38e3e inherit pub_methods_classiceberg_1_1ErrorCollector" id="r_aaba366560be481bfa9538735f3a38e3e"><td class="memItemLeft" align="right" valign="top"> |
| <a class="el" href="classiceberg_1_1ErrorCollector.html">ErrorCollector</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classiceberg_1_1ErrorCollector.html">ErrorCollector</a> &)=default</td></tr> |
| <tr class="separator:aaba366560be481bfa9538735f3a38e3e inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3a20345150b136c918ffe8947a7d75e1 inherit pub_methods_classiceberg_1_1ErrorCollector" id="r_a3a20345150b136c918ffe8947a7d75e1"><td class="memTemplParams" colspan="2">template<typename... Args> </td></tr> |
| <tr class="memitem:a3a20345150b136c918ffe8947a7d75e1 inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="memTemplItemLeft" align="right" valign="top">auto & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ErrorCollector.html#a3a20345150b136c918ffe8947a7d75e1">AddError</a> (this auto &self, ErrorKind kind, const std::format_string< Args... > fmt, Args &&... args)</td></tr> |
| <tr class="memdesc:a3a20345150b136c918ffe8947a7d75e1 inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="mdescLeft"> </td><td class="mdescRight">Add a specific error and return reference to derived class. <br /></td></tr> |
| <tr class="separator:a3a20345150b136c918ffe8947a7d75e1 inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5e555954de121d0908dcf4648da446e3 inherit pub_methods_classiceberg_1_1ErrorCollector" id="r_a5e555954de121d0908dcf4648da446e3"><td class="memItemLeft" align="right" valign="top">auto & </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ErrorCollector.html#a5e555954de121d0908dcf4648da446e3">AddError</a> (this auto &self, <a class="el" href="structiceberg_1_1Error.html">Error</a> err)</td></tr> |
| <tr class="memdesc:a5e555954de121d0908dcf4648da446e3 inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="mdescLeft"> </td><td class="mdescRight">Add an existing error object and return reference to derived class. <br /></td></tr> |
| <tr class="separator:a5e555954de121d0908dcf4648da446e3 inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5749264a2234092a5246056a1c72ee51 inherit pub_methods_classiceberg_1_1ErrorCollector" id="r_a5749264a2234092a5246056a1c72ee51"><td class="memItemLeft" align="right" valign="top">auto & </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ErrorCollector.html#a5749264a2234092a5246056a1c72ee51">AddError</a> (this auto &self, std::unexpected< <a class="el" href="structiceberg_1_1Error.html">Error</a> > err)</td></tr> |
| <tr class="memdesc:a5749264a2234092a5246056a1c72ee51 inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="mdescLeft"> </td><td class="mdescRight">Add an unexpected result's error and return reference to derived class. <br /></td></tr> |
| <tr class="separator:a5749264a2234092a5246056a1c72ee51 inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8813b3fe2a3cc112e6db19c87b8422ae inherit pub_methods_classiceberg_1_1ErrorCollector" id="r_a8813b3fe2a3cc112e6db19c87b8422ae"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ErrorCollector.html#a8813b3fe2a3cc112e6db19c87b8422ae">has_errors</a> () const</td></tr> |
| <tr class="memdesc:a8813b3fe2a3cc112e6db19c87b8422ae inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="mdescLeft"> </td><td class="mdescRight">Check if any errors have been collected. <br /></td></tr> |
| <tr class="separator:a8813b3fe2a3cc112e6db19c87b8422ae inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afae10739a78bbffc2609a63e52821195 inherit pub_methods_classiceberg_1_1ErrorCollector" id="r_afae10739a78bbffc2609a63e52821195"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ErrorCollector.html#afae10739a78bbffc2609a63e52821195">error_count</a> () const</td></tr> |
| <tr class="memdesc:afae10739a78bbffc2609a63e52821195 inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of errors collected. <br /></td></tr> |
| <tr class="separator:afae10739a78bbffc2609a63e52821195 inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a16cbe7b6d423a372c9e68d970ff2c3ea inherit pub_methods_classiceberg_1_1ErrorCollector" id="r_a16cbe7b6d423a372c9e68d970ff2c3ea"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ErrorCollector.html#a16cbe7b6d423a372c9e68d970ff2c3ea">CheckErrors</a> () const</td></tr> |
| <tr class="memdesc:a16cbe7b6d423a372c9e68d970ff2c3ea inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="mdescLeft"> </td><td class="mdescRight">Check for accumulated errors and return them if any exist. <br /></td></tr> |
| <tr class="separator:a16cbe7b6d423a372c9e68d970ff2c3ea inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a274df2b90b0c22156a4c339aa30a4401 inherit pub_methods_classiceberg_1_1ErrorCollector" id="r_a274df2b90b0c22156a4c339aa30a4401"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ErrorCollector.html#a274df2b90b0c22156a4c339aa30a4401">ClearErrors</a> ()</td></tr> |
| <tr class="memdesc:a274df2b90b0c22156a4c339aa30a4401 inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="mdescLeft"> </td><td class="mdescRight">Clear all accumulated errors. <br /></td></tr> |
| <tr class="separator:a274df2b90b0c22156a4c339aa30a4401 inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a101fb70f2ad50a6023de932dc2eca96c inherit pub_methods_classiceberg_1_1ErrorCollector" id="r_a101fb70f2ad50a6023de932dc2eca96c"><td class="memItemLeft" align="right" valign="top"> |
| const std::vector< <a class="el" href="structiceberg_1_1Error.html">Error</a> > & </td><td class="memItemRight" valign="bottom"><b>errors</b> () const</td></tr> |
| <tr class="memdesc:a101fb70f2ad50a6023de932dc2eca96c inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="mdescLeft"> </td><td class="mdescRight">Get read-only access to all collected errors. <br /></td></tr> |
| <tr class="separator:a101fb70f2ad50a6023de932dc2eca96c inherit pub_methods_classiceberg_1_1ErrorCollector"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:a1bc9b1eb7bfa1c832c65331b2e6bba6f" id="r_a1bc9b1eb7bfa1c832c65331b2e6bba6f"><td class="memItemLeft" align="right" valign="top"><a id="a1bc9b1eb7bfa1c832c65331b2e6bba6f" name="a1bc9b1eb7bfa1c832c65331b2e6bba6f"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>PendingUpdate</b> (std::shared_ptr< <a class="el" href="classiceberg_1_1TransactionContext.html">TransactionContext</a> > ctx)</td></tr> |
| <tr class="separator:a1bc9b1eb7bfa1c832c65331b2e6bba6f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a93721051561748b1a29e75b7d4cbbd86" id="r_a93721051561748b1a29e75b7d4cbbd86"><td class="memItemLeft" align="right" valign="top"><a id="a93721051561748b1a29e75b7d4cbbd86" name="a93721051561748b1a29e75b7d4cbbd86"></a> |
| const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> & </td><td class="memItemRight" valign="bottom"><b>base</b> () const</td></tr> |
| <tr class="separator:a93721051561748b1a29e75b7d4cbbd86"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a> |
| Protected Attributes</h2></td></tr> |
| <tr class="memitem:a48306a581b00f16c85af172a41b7dcee" id="r_a48306a581b00f16c85af172a41b7dcee"><td class="memItemLeft" align="right" valign="top"><a id="a48306a581b00f16c85af172a41b7dcee" name="a48306a581b00f16c85af172a41b7dcee"></a> |
| std::shared_ptr< <a class="el" href="classiceberg_1_1TransactionContext.html">TransactionContext</a> > </td><td class="memItemRight" valign="bottom"><b>ctx_</b></td></tr> |
| <tr class="separator:a48306a581b00f16c85af172a41b7dcee"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pro_attribs_classiceberg_1_1ErrorCollector"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classiceberg_1_1ErrorCollector')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classiceberg_1_1ErrorCollector.html">iceberg::ErrorCollector</a></td></tr> |
| <tr class="memitem:a354d1e7287bb45926a4b563f80d0c623 inherit pro_attribs_classiceberg_1_1ErrorCollector" id="r_a354d1e7287bb45926a4b563f80d0c623"><td class="memItemLeft" align="right" valign="top"> |
| std::vector< <a class="el" href="structiceberg_1_1Error.html">Error</a> > </td><td class="memItemRight" valign="bottom"><b>errors_</b></td></tr> |
| <tr class="separator:a354d1e7287bb45926a4b563f80d0c623 inherit pro_attribs_classiceberg_1_1ErrorCollector"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Base class for all kinds of table metadata updates. </p> |
| <p>Any created <code><a class="el" href="classiceberg_1_1PendingUpdate.html" title="Base class for all kinds of table metadata updates.">PendingUpdate</a></code> instance is tracked by the <code><a class="el" href="classiceberg_1_1Transaction.html" title="A transaction for performing multiple updates to a table.">Transaction</a></code> instance and commit is also delegated to the <code><a class="el" href="classiceberg_1_1Transaction.html" title="A transaction for performing multiple updates to a table.">Transaction</a></code> instance.</p> |
| <dl class="section note"><dt>Note</dt><dd>Implementations are expected to use builder pattern and errors should be handled by the <a class="el" href="classiceberg_1_1ErrorCollector.html" title="Base class for collecting errors in the builder pattern.">ErrorCollector</a> base class. </dd></dl> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a4a5df6d83b7a4a3c4dac19a77945be71" name="a4a5df6d83b7a4a3c4dac19a77945be71"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4a5df6d83b7a4a3c4dac19a77945be71">◆ </a></span>Commit()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Status iceberg::PendingUpdate::Commit </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Apply the pending changes and commit. </p> |
| <dl class="section return"><dt>Returns</dt><dd>An OK status if the commit was successful, or an error:<ul> |
| <li>ValidationFailed: if it cannot be applied to the current table metadata.</li> |
| <li>CommitFailed: if it cannot be committed due to conflicts.</li> |
| <li>CommitStateUnknown: unknown status, no cleanup should be done. </li> |
| </ul> |
| </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a60cfd4550ad0d06af250dd03c26bddb3" name="a60cfd4550ad0d06af250dd03c26bddb3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a60cfd4550ad0d06af250dd03c26bddb3">◆ </a></span>Finalize()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Status iceberg::PendingUpdate::Finalize </td> |
| <td>(</td> |
| <td class="paramtype">Result< const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> * > </td> |
| <td class="paramname"><em>commit_result</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Finalize the pending update. </p> |
| <p>This method is called after the update is committed. Implementations should override this method to clean up any resources.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">commit_result</td><td>The committed table metadata when the commit succeeds, or the commit error when it fails. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Status indicating success or failure </dd></dl> |
| |
| <p>Reimplemented in <a class="el" href="classiceberg_1_1ExpireSnapshots.html#a364947643027e15ce866184cba1afdb6">iceberg::ExpireSnapshots</a>, and <a class="el" href="classiceberg_1_1SnapshotUpdate.html#ad942dda206e9c6454493a63eb48df0e0">iceberg::SnapshotUpdate</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aa2a0ff4c156fe5852d1d52bf5827db7e" name="aa2a0ff4c156fe5852d1d52bf5827db7e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa2a0ff4c156fe5852d1d52bf5827db7e">◆ </a></span>IsRetryable()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool iceberg::PendingUpdate::IsRetryable </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Whether this update can be retried after a commit conflict. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1ExpireSnapshots.html#a8d677add7f52334b97770d67b144b52c">iceberg::ExpireSnapshots</a>, <a class="el" href="classiceberg_1_1SetSnapshot.html#af5f018a0c0b7693c4a66346576e5cc83">iceberg::SetSnapshot</a>, <a class="el" href="classiceberg_1_1SnapshotUpdate.html#a97b2753654e1304914509f29dcf0a7ff">iceberg::SnapshotUpdate</a>, <a class="el" href="classiceberg_1_1UpdateLocation.html#a910a0c066d90a1afdd02ff7c2df09049">iceberg::UpdateLocation</a>, <a class="el" href="classiceberg_1_1UpdatePartitionSpec.html#a3acf18c5554a5ad2896438c67c21e640">iceberg::UpdatePartitionSpec</a>, <a class="el" href="classiceberg_1_1UpdatePartitionStatistics.html#a2fb34d7d713d8435e37aa180a92f6e79">iceberg::UpdatePartitionStatistics</a>, <a class="el" href="classiceberg_1_1UpdateProperties.html#a68ef80ef9bf9b05e5610dfa900c416a3">iceberg::UpdateProperties</a>, <a class="el" href="classiceberg_1_1UpdateSchema.html#aa4758f53a5c789d70a32d62dae40addb">iceberg::UpdateSchema</a>, <a class="el" href="classiceberg_1_1UpdateSnapshotReference.html#a93ec2b5eb604f1cb33c9b3fc09a60345">iceberg::UpdateSnapshotReference</a>, <a class="el" href="classiceberg_1_1UpdateSortOrder.html#ae6de4e251d7ffa6b3f1c5435bd11aae7">iceberg::UpdateSortOrder</a>, and <a class="el" href="classiceberg_1_1UpdateStatistics.html#aa59f74741a668abb29aa1f801421edd6">iceberg::UpdateStatistics</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a33fba65ffa4a85fd7c5b9984cb892812" name="a33fba65ffa4a85fd7c5b9984cb892812"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a33fba65ffa4a85fd7c5b9984cb892812">◆ </a></span>kind()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual Kind iceberg::PendingUpdate::kind </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return the kind of this pending update. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1ExpireSnapshots.html#ad2d859da01c54f38b741f3e97aef9b70">iceberg::ExpireSnapshots</a>, <a class="el" href="classiceberg_1_1SetSnapshot.html#ad453605d3b56053d37f5a227c8385585">iceberg::SetSnapshot</a>, <a class="el" href="classiceberg_1_1UpdateLocation.html#aaf4a907185bf48cce7d84cd57147e9da">iceberg::UpdateLocation</a>, <a class="el" href="classiceberg_1_1UpdatePartitionSpec.html#a6f438d6aaa000f06347b0ae44e29e23c">iceberg::UpdatePartitionSpec</a>, <a class="el" href="classiceberg_1_1UpdatePartitionStatistics.html#acb3c652016e0016b2d1ec98eda7b2533">iceberg::UpdatePartitionStatistics</a>, <a class="el" href="classiceberg_1_1UpdateProperties.html#ad4a7eac6a75b0a950c41bb18eda1eab5">iceberg::UpdateProperties</a>, <a class="el" href="classiceberg_1_1UpdateSchema.html#a6e69f3190d5c89c1c76ca357f39c7af5">iceberg::UpdateSchema</a>, <a class="el" href="classiceberg_1_1UpdateSnapshotReference.html#a607504fa70250fcbacd8abf5c009dec6">iceberg::UpdateSnapshotReference</a>, <a class="el" href="classiceberg_1_1UpdateSortOrder.html#a0eebd552bb09815015f758f69e4975e1">iceberg::UpdateSortOrder</a>, <a class="el" href="classiceberg_1_1UpdateStatistics.html#a7bdf59fd1eb3866a5f6840f6c36d4d1a">iceberg::UpdateStatistics</a>, and <a class="el" href="classiceberg_1_1SnapshotUpdate.html#ae194773e0ce37df3780121314322f440">iceberg::SnapshotUpdate</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>iceberg/update/<a class="el" href="pending__update_8h_source.html">pending_update.h</a></li> |
| <li>iceberg/update/<b>pending_update.cc</b></li> |
| </ul> |
| </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> |
