| <!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::TableRequirements 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_1TableRequirements.html">TableRequirements</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classiceberg_1_1TableRequirements-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::TableRequirements Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Factory class for generating table requirements. |
| <a href="classiceberg_1_1TableRequirements.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="table__requirements_8h_source.html">table_requirements.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a3ec73cafe440067c2f9f46485113786e" id="r_a3ec73cafe440067c2f9f46485113786e"><td class="memItemLeft" align="right" valign="top">static Result< std::vector< std::unique_ptr< <a class="el" href="classiceberg_1_1TableRequirement.html">TableRequirement</a> > > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TableRequirements.html#a3ec73cafe440067c2f9f46485113786e">ForCreateTable</a> (const std::vector< std::unique_ptr< <a class="el" href="classiceberg_1_1TableUpdate.html">TableUpdate</a> > > &table_updates)</td></tr> |
| <tr class="memdesc:a3ec73cafe440067c2f9f46485113786e"><td class="mdescLeft"> </td><td class="mdescRight">Generate requirements for creating a new table. <br /></td></tr> |
| <tr class="separator:a3ec73cafe440067c2f9f46485113786e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a36e610485b3545404eb8c4faec3d1b4b" id="r_a36e610485b3545404eb8c4faec3d1b4b"><td class="memItemLeft" align="right" valign="top">static Result< std::vector< std::unique_ptr< <a class="el" href="classiceberg_1_1TableRequirement.html">TableRequirement</a> > > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TableRequirements.html#a36e610485b3545404eb8c4faec3d1b4b">ForReplaceTable</a> (const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> &base, const std::vector< std::unique_ptr< <a class="el" href="classiceberg_1_1TableUpdate.html">TableUpdate</a> > > &table_updates)</td></tr> |
| <tr class="memdesc:a36e610485b3545404eb8c4faec3d1b4b"><td class="mdescLeft"> </td><td class="mdescRight">Generate requirements for replacing an existing table. <br /></td></tr> |
| <tr class="separator:a36e610485b3545404eb8c4faec3d1b4b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aed36640e6c4ee1e1b9bead582faf4b20" id="r_aed36640e6c4ee1e1b9bead582faf4b20"><td class="memItemLeft" align="right" valign="top">static Result< std::vector< std::unique_ptr< <a class="el" href="classiceberg_1_1TableRequirement.html">TableRequirement</a> > > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TableRequirements.html#aed36640e6c4ee1e1b9bead582faf4b20">ForUpdateTable</a> (const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> &base, const std::vector< std::unique_ptr< <a class="el" href="classiceberg_1_1TableUpdate.html">TableUpdate</a> > > &table_updates)</td></tr> |
| <tr class="memdesc:aed36640e6c4ee1e1b9bead582faf4b20"><td class="mdescLeft"> </td><td class="mdescRight">Generate requirements for updating an existing table. <br /></td></tr> |
| <tr class="separator:aed36640e6c4ee1e1b9bead582faf4b20"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a53fbc822029aae8f6f42a0db4c452b13" id="r_a53fbc822029aae8f6f42a0db4c452b13"><td class="memItemLeft" align="right" valign="top"><a id="a53fbc822029aae8f6f42a0db4c452b13" name="a53fbc822029aae8f6f42a0db4c452b13"></a> |
| static Result< bool > </td><td class="memItemRight" valign="bottom"><b>IsCreate</b> (const std::vector< std::unique_ptr< <a class="el" href="classiceberg_1_1TableRequirement.html">TableRequirement</a> > > &requirements)</td></tr> |
| <tr class="memdesc:a53fbc822029aae8f6f42a0db4c452b13"><td class="mdescLeft"> </td><td class="mdescRight">Check if the requirements are for table creation. <br /></td></tr> |
| <tr class="separator:a53fbc822029aae8f6f42a0db4c452b13"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Factory class for generating table requirements. </p> |
| <p>This class analyzes a sequence of table updates and generates the appropriate table requirements to ensure safe concurrent modifications. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a3ec73cafe440067c2f9f46485113786e" name="a3ec73cafe440067c2f9f46485113786e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3ec73cafe440067c2f9f46485113786e">◆ </a></span>ForCreateTable()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::vector< std::unique_ptr< <a class="el" href="classiceberg_1_1TableRequirement.html">TableRequirement</a> > > > iceberg::TableRequirements::ForCreateTable </td> |
| <td>(</td> |
| <td class="paramtype">const std::vector< std::unique_ptr< <a class="el" href="classiceberg_1_1TableUpdate.html">TableUpdate</a> > > & </td> |
| <td class="paramname"><em>table_updates</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Generate requirements for creating a new table. </p> |
| <p>For table creation, this requires that the table does not already exist.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">table_updates</td><td>The list of table updates for table creation </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A list of table requirements to validate before creation </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a36e610485b3545404eb8c4faec3d1b4b" name="a36e610485b3545404eb8c4faec3d1b4b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a36e610485b3545404eb8c4faec3d1b4b">◆ </a></span>ForReplaceTable()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::vector< std::unique_ptr< <a class="el" href="classiceberg_1_1TableRequirement.html">TableRequirement</a> > > > iceberg::TableRequirements::ForReplaceTable </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> & </td> |
| <td class="paramname"><em>base</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< std::unique_ptr< <a class="el" href="classiceberg_1_1TableUpdate.html">TableUpdate</a> > > & </td> |
| <td class="paramname"><em>table_updates</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Generate requirements for replacing an existing table. </p> |
| <p>For table replacement, this requires that the table UUID matches but allows more aggressive changes than a regular update.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">base</td><td>The base table metadata </td></tr> |
| <tr><td class="paramname">table_updates</td><td>The list of table updates for replacement </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A list of table requirements to validate before replacement </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aed36640e6c4ee1e1b9bead582faf4b20" name="aed36640e6c4ee1e1b9bead582faf4b20"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aed36640e6c4ee1e1b9bead582faf4b20">◆ </a></span>ForUpdateTable()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::vector< std::unique_ptr< <a class="el" href="classiceberg_1_1TableRequirement.html">TableRequirement</a> > > > iceberg::TableRequirements::ForUpdateTable </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> & </td> |
| <td class="paramname"><em>base</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< std::unique_ptr< <a class="el" href="classiceberg_1_1TableUpdate.html">TableUpdate</a> > > & </td> |
| <td class="paramname"><em>table_updates</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Generate requirements for updating an existing table. </p> |
| <p>For table updates, this generates requirements to ensure that key metadata properties haven't changed concurrently.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">base</td><td>The base table metadata </td></tr> |
| <tr><td class="paramname">table_updates</td><td>The list of table updates </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A list of table requirements to validate before update </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>iceberg/<a class="el" href="table__requirements_8h_source.html">table_requirements.h</a></li> |
| <li>iceberg/<b>table_requirements.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> |
