Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./api/classiceberg_1_1TableRequirement.html
blob: ac868d533f558650e818f29a97a8efc971f0f392 [file]
<!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::TableRequirement 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&amp;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&amp;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_1TableRequirement.html">TableRequirement</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classiceberg_1_1TableRequirement-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::TableRequirement Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Base class for update requirement operations.
<a href="classiceberg_1_1TableRequirement.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="table__requirement_8h_source.html">table_requirement.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::TableRequirement:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1TableRequirement.png" usemap="#iceberg::TableRequirement_map" alt=""/>
<map id="iceberg::TableRequirement_map" name="iceberg::TableRequirement_map">
<area href="classiceberg_1_1table_1_1AssertCurrentSchemaID.html" title="Requirement that the current schema ID matches." alt="iceberg::table::AssertCurrentSchemaID" shape="rect" coords="271,56,532,80"/>
<area href="classiceberg_1_1table_1_1AssertDefaultSortOrderID.html" title="Requirement that the default sort order ID matches." alt="iceberg::table::AssertDefaultSortOrderID" shape="rect" coords="271,112,532,136"/>
<area href="classiceberg_1_1table_1_1AssertDefaultSpecID.html" title="Requirement that the default partition spec ID matches." alt="iceberg::table::AssertDefaultSpecID" shape="rect" coords="271,168,532,192"/>
<area href="classiceberg_1_1table_1_1AssertDoesNotExist.html" title="Requirement that the table does not exist." alt="iceberg::table::AssertDoesNotExist" shape="rect" coords="271,224,532,248"/>
<area href="classiceberg_1_1table_1_1AssertLastAssignedFieldId.html" title="Requirement that the last assigned field ID matches." alt="iceberg::table::AssertLastAssignedFieldId" shape="rect" coords="271,280,532,304"/>
<area href="classiceberg_1_1table_1_1AssertLastAssignedPartitionId.html" title="Requirement that the last assigned partition ID matches." alt="iceberg::table::AssertLastAssignedPartitionId" shape="rect" coords="271,336,532,360"/>
<area href="classiceberg_1_1table_1_1AssertRefSnapshotID.html" title="Requirement that a reference (branch or tag) points to a specific snapshot." alt="iceberg::table::AssertRefSnapshotID" shape="rect" coords="271,392,532,416"/>
<area href="classiceberg_1_1table_1_1AssertUUID.html" title="Requirement that the table UUID matches the expected value." alt="iceberg::table::AssertUUID" shape="rect" coords="271,448,532,472"/>
</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:a6e4147c3e1ec7bc343634699f4cbec79" id="r_a6e4147c3e1ec7bc343634699f4cbec79"><td class="memItemLeft" align="right" valign="top"><a id="a6e4147c3e1ec7bc343634699f4cbec79" name="a6e4147c3e1ec7bc343634699f4cbec79"></a>enum class &#160;</td><td class="memItemRight" valign="bottom"><b>Kind</b> : uint8_t { <br />
&#160;&#160;<b>kAssertDoesNotExist</b>
, <b>kAssertUUID</b>
, <b>kAssertRefSnapshotID</b>
, <b>kAssertLastAssignedFieldId</b>
, <br />
&#160;&#160;<b>kAssertCurrentSchemaID</b>
, <b>kAssertLastAssignedPartitionId</b>
, <b>kAssertDefaultSpecID</b>
, <b>kAssertDefaultSortOrderID</b>
<br />
}</td></tr>
<tr class="separator:a6e4147c3e1ec7bc343634699f4cbec79"><td class="memSeparator" colspan="2">&#160;</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:ae1792bd660df2370dffc5474b4e0a264" id="r_ae1792bd660df2370dffc5474b4e0a264"><td class="memItemLeft" align="right" valign="top">virtual Kind&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TableRequirement.html#ae1792bd660df2370dffc5474b4e0a264">kind</a> () const =0</td></tr>
<tr class="memdesc:ae1792bd660df2370dffc5474b4e0a264"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the kind of requirement. <br /></td></tr>
<tr class="separator:ae1792bd660df2370dffc5474b4e0a264"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae122a03307e1dc67692d8e98b389fb15" id="r_ae122a03307e1dc67692d8e98b389fb15"><td class="memItemLeft" align="right" valign="top">virtual Status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TableRequirement.html#ae122a03307e1dc67692d8e98b389fb15">Validate</a> (const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> *base) const =0</td></tr>
<tr class="memdesc:ae122a03307e1dc67692d8e98b389fb15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Validate this requirement against table metadata. <br /></td></tr>
<tr class="separator:ae122a03307e1dc67692d8e98b389fb15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67955bc471d761a5a19c2e7ed6858e08" id="r_a67955bc471d761a5a19c2e7ed6858e08"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TableRequirement.html#a67955bc471d761a5a19c2e7ed6858e08">Equals</a> (const <a class="el" href="classiceberg_1_1TableRequirement.html">TableRequirement</a> &amp;other) const =0</td></tr>
<tr class="memdesc:a67955bc471d761a5a19c2e7ed6858e08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check equality with another <a class="el" href="classiceberg_1_1TableRequirement.html" title="Base class for update requirement operations.">TableRequirement</a>. <br /></td></tr>
<tr class="separator:a67955bc471d761a5a19c2e7ed6858e08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bbf72ce6649e04a8dc1bc2f7bcff353" id="r_a2bbf72ce6649e04a8dc1bc2f7bcff353"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr&lt; <a class="el" href="classiceberg_1_1TableRequirement.html">TableRequirement</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TableRequirement.html#a2bbf72ce6649e04a8dc1bc2f7bcff353">Clone</a> () const =0</td></tr>
<tr class="memdesc:a2bbf72ce6649e04a8dc1bc2f7bcff353"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a deep copy of this requirement. <br /></td></tr>
<tr class="separator:a2bbf72ce6649e04a8dc1bc2f7bcff353"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ac213585c11e319f539feff8bcea80b55" id="r_ac213585c11e319f539feff8bcea80b55"><td class="memItemLeft" align="right" valign="top"><a id="ac213585c11e319f539feff8bcea80b55" name="ac213585c11e319f539feff8bcea80b55"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classiceberg_1_1TableRequirement.html">TableRequirement</a> &amp;lhs, const <a class="el" href="classiceberg_1_1TableRequirement.html">TableRequirement</a> &amp;rhs)</td></tr>
<tr class="memdesc:ac213585c11e319f539feff8bcea80b55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare two <a class="el" href="classiceberg_1_1TableRequirement.html" title="Base class for update requirement operations.">TableRequirement</a> instances for equality. <br /></td></tr>
<tr class="separator:ac213585c11e319f539feff8bcea80b55"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for update requirement operations. </p>
<p>Represents a requirement that must be validated before applying metadata updates to a table. Each concrete subclass represents a specific type of requirement check. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a2bbf72ce6649e04a8dc1bc2f7bcff353" name="a2bbf72ce6649e04a8dc1bc2f7bcff353"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bbf72ce6649e04a8dc1bc2f7bcff353">&#9670;&#160;</a></span>Clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::unique_ptr&lt; <a class="el" href="classiceberg_1_1TableRequirement.html">TableRequirement</a> &gt; iceberg::TableRequirement::Clone </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>Create a deep copy of this requirement. </p>
<dl class="section return"><dt>Returns</dt><dd>A unique_ptr to a new <a class="el" href="classiceberg_1_1TableRequirement.html" title="Base class for update requirement operations.">TableRequirement</a> that is a copy of this one </dd></dl>
<p>Implemented in <a class="el" href="classiceberg_1_1table_1_1AssertDoesNotExist.html#ae532d37abd08aee583179a0b541f15bb">iceberg::table::AssertDoesNotExist</a>, <a class="el" href="classiceberg_1_1table_1_1AssertUUID.html#ae88f244b6ba758d2466e4d2accd1405a">iceberg::table::AssertUUID</a>, <a class="el" href="classiceberg_1_1table_1_1AssertRefSnapshotID.html#a199301cef5b50cffde62d8df4dbc795e">iceberg::table::AssertRefSnapshotID</a>, <a class="el" href="classiceberg_1_1table_1_1AssertLastAssignedFieldId.html#a2a8991a4d543738c35bcc8a5428d8d13">iceberg::table::AssertLastAssignedFieldId</a>, <a class="el" href="classiceberg_1_1table_1_1AssertCurrentSchemaID.html#a56c489b00e42218bd00a7c91e5992119">iceberg::table::AssertCurrentSchemaID</a>, <a class="el" href="classiceberg_1_1table_1_1AssertLastAssignedPartitionId.html#a8280f7ec79356ccbdc3e9bb02b5b5c3e">iceberg::table::AssertLastAssignedPartitionId</a>, <a class="el" href="classiceberg_1_1table_1_1AssertDefaultSpecID.html#aa07e5193d1f1c4f9e4c018e7f6796b64">iceberg::table::AssertDefaultSpecID</a>, and <a class="el" href="classiceberg_1_1table_1_1AssertDefaultSortOrderID.html#a24bb4e71aed99b7b30b4764e20499bda">iceberg::table::AssertDefaultSortOrderID</a>.</p>
</div>
</div>
<a id="a67955bc471d761a5a19c2e7ed6858e08" name="a67955bc471d761a5a19c2e7ed6858e08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67955bc471d761a5a19c2e7ed6858e08">&#9670;&#160;</a></span>Equals()</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::TableRequirement::Equals </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classiceberg_1_1TableRequirement.html">TableRequirement</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></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>Check equality with another <a class="el" href="classiceberg_1_1TableRequirement.html" title="Base class for update requirement operations.">TableRequirement</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The requirement to compare with </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the requirements are equal, false otherwise </dd></dl>
<p>Implemented in <a class="el" href="classiceberg_1_1table_1_1AssertDoesNotExist.html#aee5f9a9ed9194746461c8ba8e18dc8c1">iceberg::table::AssertDoesNotExist</a>, <a class="el" href="classiceberg_1_1table_1_1AssertUUID.html#a11766552aaf57d52404300e5ec45892b">iceberg::table::AssertUUID</a>, <a class="el" href="classiceberg_1_1table_1_1AssertRefSnapshotID.html#ad22739ba88ea05d467f1105fb9b9e55b">iceberg::table::AssertRefSnapshotID</a>, <a class="el" href="classiceberg_1_1table_1_1AssertLastAssignedFieldId.html#ad580056e238db7c5629717e76d3d023b">iceberg::table::AssertLastAssignedFieldId</a>, <a class="el" href="classiceberg_1_1table_1_1AssertCurrentSchemaID.html#a45888a72ad08f6467d1668ad7a201b73">iceberg::table::AssertCurrentSchemaID</a>, <a class="el" href="classiceberg_1_1table_1_1AssertLastAssignedPartitionId.html#a656dabe37b2a092a8363e2823b4f3bba">iceberg::table::AssertLastAssignedPartitionId</a>, <a class="el" href="classiceberg_1_1table_1_1AssertDefaultSpecID.html#a7a08fc9e7b895702df5528cc03377373">iceberg::table::AssertDefaultSpecID</a>, and <a class="el" href="classiceberg_1_1table_1_1AssertDefaultSortOrderID.html#af50939744fff79c6d03c993a5c813717">iceberg::table::AssertDefaultSortOrderID</a>.</p>
</div>
</div>
<a id="ae1792bd660df2370dffc5474b4e0a264" name="ae1792bd660df2370dffc5474b4e0a264"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1792bd660df2370dffc5474b4e0a264">&#9670;&#160;</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::TableRequirement::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 requirement. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1table_1_1AssertDoesNotExist.html#a08089dd64501dff1b719d3f85ab9301f">iceberg::table::AssertDoesNotExist</a>, <a class="el" href="classiceberg_1_1table_1_1AssertUUID.html#a71761cc1d765eee5f58610df23ad51cd">iceberg::table::AssertUUID</a>, <a class="el" href="classiceberg_1_1table_1_1AssertRefSnapshotID.html#ae82fe0cad009d912649472fe20339a26">iceberg::table::AssertRefSnapshotID</a>, <a class="el" href="classiceberg_1_1table_1_1AssertLastAssignedFieldId.html#ad04553595685868da40dfdf7f2f325a1">iceberg::table::AssertLastAssignedFieldId</a>, <a class="el" href="classiceberg_1_1table_1_1AssertCurrentSchemaID.html#ac6601384b7541ab4a85e638e27e773f8">iceberg::table::AssertCurrentSchemaID</a>, <a class="el" href="classiceberg_1_1table_1_1AssertLastAssignedPartitionId.html#a02cbc7be388d73a7b727fab48d6e3f91">iceberg::table::AssertLastAssignedPartitionId</a>, <a class="el" href="classiceberg_1_1table_1_1AssertDefaultSpecID.html#a38c00a713f91c90a3945931083fe730b">iceberg::table::AssertDefaultSpecID</a>, and <a class="el" href="classiceberg_1_1table_1_1AssertDefaultSortOrderID.html#a2db247d9bd0eb82c952fee85a7df0f19">iceberg::table::AssertDefaultSortOrderID</a>.</p>
</div>
</div>
<a id="ae122a03307e1dc67692d8e98b389fb15" name="ae122a03307e1dc67692d8e98b389fb15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae122a03307e1dc67692d8e98b389fb15">&#9670;&#160;</a></span>Validate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Status iceberg::TableRequirement::Validate </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> *&#160;</td>
<td class="paramname"><em>base</em></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>Validate this requirement against table metadata. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">base</td><td>The base table metadata to validate against (may be nullptr) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Status indicating success or failure with error details </dd></dl>
<p>Implemented in <a class="el" href="classiceberg_1_1table_1_1AssertDoesNotExist.html#ad05eda57ccb7f7273834640779a73d40">iceberg::table::AssertDoesNotExist</a>, <a class="el" href="classiceberg_1_1table_1_1AssertUUID.html#a40a0b6fda5e482c8c23d7807dc19f0a5">iceberg::table::AssertUUID</a>, <a class="el" href="classiceberg_1_1table_1_1AssertRefSnapshotID.html#a55299e43bc5a41ca0af1dbcba9e2d090">iceberg::table::AssertRefSnapshotID</a>, <a class="el" href="classiceberg_1_1table_1_1AssertLastAssignedFieldId.html#af7fa8cf94c3ae72cfa9e2d842fea42c2">iceberg::table::AssertLastAssignedFieldId</a>, <a class="el" href="classiceberg_1_1table_1_1AssertCurrentSchemaID.html#aa7fd0eb9539d1e55ddc68c0f2b4ee3b8">iceberg::table::AssertCurrentSchemaID</a>, <a class="el" href="classiceberg_1_1table_1_1AssertLastAssignedPartitionId.html#ad53e8b2b1b2f3add9c79eb08d6744e2a">iceberg::table::AssertLastAssignedPartitionId</a>, <a class="el" href="classiceberg_1_1table_1_1AssertDefaultSpecID.html#a204aab5a48395e44877cacdb2f571bf7">iceberg::table::AssertDefaultSpecID</a>, and <a class="el" href="classiceberg_1_1table_1_1AssertDefaultSortOrderID.html#a85024195b579589dae3240f493cfa6fb">iceberg::table::AssertDefaultSortOrderID</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/<a class="el" href="table__requirement_8h_source.html">table_requirement.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>