Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1table_1_1AssertUUID.html
blob: 6c2db4c83e336cff35db93425de107a3d31a3bd2 [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::table::AssertUUID 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"><b>table</b></li><li class="navelem"><a class="el" href="classiceberg_1_1table_1_1AssertUUID.html">AssertUUID</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classiceberg_1_1table_1_1AssertUUID-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::table::AssertUUID Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Requirement that the table UUID matches the expected value.
<a href="classiceberg_1_1table_1_1AssertUUID.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::table::AssertUUID:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1table_1_1AssertUUID.png" usemap="#iceberg::table::AssertUUID_map" alt=""/>
<map id="iceberg::table::AssertUUID_map" name="iceberg::table::AssertUUID_map">
<area href="classiceberg_1_1TableRequirement.html" title="Base class for update requirement operations." alt="iceberg::TableRequirement" shape="rect" coords="0,0,161,24"/>
</map>
</div></div>
<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:a0d2feb219f451bf56a60bdc4779eb185" id="r_a0d2feb219f451bf56a60bdc4779eb185"><td class="memItemLeft" align="right" valign="top"><a id="a0d2feb219f451bf56a60bdc4779eb185" name="a0d2feb219f451bf56a60bdc4779eb185"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>AssertUUID</b> (std::string uuid)</td></tr>
<tr class="separator:a0d2feb219f451bf56a60bdc4779eb185"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5a7c3f00dc5e94edbe64002a690b983" id="r_af5a7c3f00dc5e94edbe64002a690b983"><td class="memItemLeft" align="right" valign="top"><a id="af5a7c3f00dc5e94edbe64002a690b983" name="af5a7c3f00dc5e94edbe64002a690b983"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>uuid</b> () const</td></tr>
<tr class="separator:af5a7c3f00dc5e94edbe64002a690b983"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71761cc1d765eee5f58610df23ad51cd" id="r_a71761cc1d765eee5f58610df23ad51cd"><td class="memItemLeft" align="right" valign="top">Kind&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1table_1_1AssertUUID.html#a71761cc1d765eee5f58610df23ad51cd">kind</a> () const override</td></tr>
<tr class="memdesc:a71761cc1d765eee5f58610df23ad51cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the kind of requirement. <br /></td></tr>
<tr class="separator:a71761cc1d765eee5f58610df23ad51cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40a0b6fda5e482c8c23d7807dc19f0a5" id="r_a40a0b6fda5e482c8c23d7807dc19f0a5"><td class="memItemLeft" align="right" valign="top">Status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1table_1_1AssertUUID.html#a40a0b6fda5e482c8c23d7807dc19f0a5">Validate</a> (const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> *base) const override</td></tr>
<tr class="memdesc:a40a0b6fda5e482c8c23d7807dc19f0a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Validate this requirement against table metadata. <br /></td></tr>
<tr class="separator:a40a0b6fda5e482c8c23d7807dc19f0a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11766552aaf57d52404300e5ec45892b" id="r_a11766552aaf57d52404300e5ec45892b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1table_1_1AssertUUID.html#a11766552aaf57d52404300e5ec45892b">Equals</a> (const <a class="el" href="classiceberg_1_1TableRequirement.html">TableRequirement</a> &amp;other) const override</td></tr>
<tr class="memdesc:a11766552aaf57d52404300e5ec45892b"><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:a11766552aaf57d52404300e5ec45892b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae88f244b6ba758d2466e4d2accd1405a" id="r_ae88f244b6ba758d2466e4d2accd1405a"><td class="memItemLeft" align="right" valign="top">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_1table_1_1AssertUUID.html#ae88f244b6ba758d2466e4d2accd1405a">Clone</a> () const override</td></tr>
<tr class="memdesc:ae88f244b6ba758d2466e4d2accd1405a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a deep copy of this requirement. <br /></td></tr>
<tr class="separator:ae88f244b6ba758d2466e4d2accd1405a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classiceberg_1_1TableRequirement"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classiceberg_1_1TableRequirement')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classiceberg_1_1TableRequirement.html">iceberg::TableRequirement</a></td></tr>
<tr class="memitem:a6e4147c3e1ec7bc343634699f4cbec79 inherit pub_types_classiceberg_1_1TableRequirement" 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 inherit pub_types_classiceberg_1_1TableRequirement"><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>Requirement that the table UUID matches the expected value. </p>
<p>This ensures the table hasn't been replaced or recreated between reading the metadata and attempting to update it. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae88f244b6ba758d2466e4d2accd1405a" name="ae88f244b6ba758d2466e4d2accd1405a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae88f244b6ba758d2466e4d2accd1405a">&#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">std::unique_ptr&lt; <a class="el" href="classiceberg_1_1TableRequirement.html">TableRequirement</a> &gt; iceberg::table::AssertUUID::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>Implements <a class="el" href="classiceberg_1_1TableRequirement.html#a2bbf72ce6649e04a8dc1bc2f7bcff353">iceberg::TableRequirement</a>.</p>
</div>
</div>
<a id="a11766552aaf57d52404300e5ec45892b" name="a11766552aaf57d52404300e5ec45892b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11766552aaf57d52404300e5ec45892b">&#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">bool iceberg::table::AssertUUID::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>Implements <a class="el" href="classiceberg_1_1TableRequirement.html#a67955bc471d761a5a19c2e7ed6858e08">iceberg::TableRequirement</a>.</p>
</div>
</div>
<a id="a71761cc1d765eee5f58610df23ad51cd" name="a71761cc1d765eee5f58610df23ad51cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71761cc1d765eee5f58610df23ad51cd">&#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">Kind iceberg::table::AssertUUID::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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the kind of requirement. </p>
<p>Implements <a class="el" href="classiceberg_1_1TableRequirement.html#ae1792bd660df2370dffc5474b4e0a264">iceberg::TableRequirement</a>.</p>
</div>
</div>
<a id="a40a0b6fda5e482c8c23d7807dc19f0a5" name="a40a0b6fda5e482c8c23d7807dc19f0a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40a0b6fda5e482c8c23d7807dc19f0a5">&#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">Status iceberg::table::AssertUUID::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">override</span><span class="mlabel">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>Implements <a class="el" href="classiceberg_1_1TableRequirement.html#ae122a03307e1dc67692d8e98b389fb15">iceberg::TableRequirement</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/<a class="el" href="table__requirement_8h_source.html">table_requirement.h</a></li>
<li>iceberg/<b>table_requirement.cc</b></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>