Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1TableUpdateContext.html
blob: b4fa78487e69eff9e7acd6e0d34dd8c5857e0085 [file] [log] [blame]
<!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::TableUpdateContext 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_1TableUpdateContext.html">TableUpdateContext</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_1TableUpdateContext-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::TableUpdateContext Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Context for generating table requirements.
<a href="classiceberg_1_1TableUpdateContext.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="table__requirements_8h_source.html">table_requirements.h</a>&gt;</code></p>
<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:a4e5fc09d6eb180ae69b59fc560fa22a9" id="r_a4e5fc09d6eb180ae69b59fc560fa22a9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TableUpdateContext.html#a4e5fc09d6eb180ae69b59fc560fa22a9">TableUpdateContext</a> (const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> *<a class="el" href="classiceberg_1_1TableUpdateContext.html#ac9ce6af878c98278aa07a5f717787819">base</a>, bool <a class="el" href="classiceberg_1_1TableUpdateContext.html#a827a358a71924bca13c591e7f15e4aaf">is_replace</a>)</td></tr>
<tr class="memdesc:a4e5fc09d6eb180ae69b59fc560fa22a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a context for requirement generation. <br /></td></tr>
<tr class="separator:a4e5fc09d6eb180ae69b59fc560fa22a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe12076b9704bd28dc14d1c4c7983481" id="r_afe12076b9704bd28dc14d1c4c7983481"><td class="memItemLeft" align="right" valign="top"><a id="afe12076b9704bd28dc14d1c4c7983481" name="afe12076b9704bd28dc14d1c4c7983481"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>TableUpdateContext</b> (const <a class="el" href="classiceberg_1_1TableUpdateContext.html">TableUpdateContext</a> &amp;)=delete</td></tr>
<tr class="separator:afe12076b9704bd28dc14d1c4c7983481"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2497205f83a3634a49ea46d86cc1242" id="r_ad2497205f83a3634a49ea46d86cc1242"><td class="memItemLeft" align="right" valign="top"><a id="ad2497205f83a3634a49ea46d86cc1242" name="ad2497205f83a3634a49ea46d86cc1242"></a>
<a class="el" href="classiceberg_1_1TableUpdateContext.html">TableUpdateContext</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classiceberg_1_1TableUpdateContext.html">TableUpdateContext</a> &amp;)=delete</td></tr>
<tr class="separator:ad2497205f83a3634a49ea46d86cc1242"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38064dea13bcb5a0407a8a0321b6cfae" id="r_a38064dea13bcb5a0407a8a0321b6cfae"><td class="memItemLeft" align="right" valign="top"><a id="a38064dea13bcb5a0407a8a0321b6cfae" name="a38064dea13bcb5a0407a8a0321b6cfae"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>TableUpdateContext</b> (<a class="el" href="classiceberg_1_1TableUpdateContext.html">TableUpdateContext</a> &amp;&amp;) noexcept=default</td></tr>
<tr class="separator:a38064dea13bcb5a0407a8a0321b6cfae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7262ec670474b9f76c80697b1152254" id="r_ac7262ec670474b9f76c80697b1152254"><td class="memItemLeft" align="right" valign="top"><a id="ac7262ec670474b9f76c80697b1152254" name="ac7262ec670474b9f76c80697b1152254"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>AddRequirement</b> (std::unique_ptr&lt; <a class="el" href="classiceberg_1_1TableRequirement.html">TableRequirement</a> &gt; requirement)</td></tr>
<tr class="memdesc:ac7262ec670474b9f76c80697b1152254"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a requirement to the list. <br /></td></tr>
<tr class="separator:ac7262ec670474b9f76c80697b1152254"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9ce6af878c98278aa07a5f717787819" id="r_ac9ce6af878c98278aa07a5f717787819"><td class="memItemLeft" align="right" valign="top"><a id="ac9ce6af878c98278aa07a5f717787819" name="ac9ce6af878c98278aa07a5f717787819"></a>
const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>base</b> () const</td></tr>
<tr class="memdesc:ac9ce6af878c98278aa07a5f717787819"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the base table metadata. <br /></td></tr>
<tr class="separator:ac9ce6af878c98278aa07a5f717787819"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a827a358a71924bca13c591e7f15e4aaf" id="r_a827a358a71924bca13c591e7f15e4aaf"><td class="memItemLeft" align="right" valign="top"><a id="a827a358a71924bca13c591e7f15e4aaf" name="a827a358a71924bca13c591e7f15e4aaf"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_replace</b> () const</td></tr>
<tr class="memdesc:a827a358a71924bca13c591e7f15e4aaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if this is a replace operation. <br /></td></tr>
<tr class="separator:a827a358a71924bca13c591e7f15e4aaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd97d5656c2eed82d153e8140debe14a" id="r_acd97d5656c2eed82d153e8140debe14a"><td class="memItemLeft" align="right" valign="top"><a id="acd97d5656c2eed82d153e8140debe14a" name="acd97d5656c2eed82d153e8140debe14a"></a>
Result&lt; std::vector&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1TableRequirement.html">TableRequirement</a> &gt; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Build</b> ()</td></tr>
<tr class="memdesc:acd97d5656c2eed82d153e8140debe14a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build and return the list of requirements. <br /></td></tr>
<tr class="separator:acd97d5656c2eed82d153e8140debe14a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef35c480c8299ba87150b4a3729ade81" id="r_aef35c480c8299ba87150b4a3729ade81"><td class="memItemLeft" align="right" valign="top"><a id="aef35c480c8299ba87150b4a3729ade81" name="aef35c480c8299ba87150b4a3729ade81"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>RequireLastAssignedFieldIdUnchanged</b> ()</td></tr>
<tr class="memdesc:aef35c480c8299ba87150b4a3729ade81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Require that the last assigned field ID remains unchanged. <br /></td></tr>
<tr class="separator:aef35c480c8299ba87150b4a3729ade81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00de0f6a825ec080bd4013dd2c2dd9cc" id="r_a00de0f6a825ec080bd4013dd2c2dd9cc"><td class="memItemLeft" align="right" valign="top"><a id="a00de0f6a825ec080bd4013dd2c2dd9cc" name="a00de0f6a825ec080bd4013dd2c2dd9cc"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>RequireCurrentSchemaIdUnchanged</b> ()</td></tr>
<tr class="memdesc:a00de0f6a825ec080bd4013dd2c2dd9cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Require that the current schema ID remains unchanged. <br /></td></tr>
<tr class="separator:a00de0f6a825ec080bd4013dd2c2dd9cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42c42aefdc63614a88de0baa4d760d17" id="r_a42c42aefdc63614a88de0baa4d760d17"><td class="memItemLeft" align="right" valign="top"><a id="a42c42aefdc63614a88de0baa4d760d17" name="a42c42aefdc63614a88de0baa4d760d17"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>RequireLastAssignedPartitionIdUnchanged</b> ()</td></tr>
<tr class="memdesc:a42c42aefdc63614a88de0baa4d760d17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Require that the last assigned partition ID remains unchanged. <br /></td></tr>
<tr class="separator:a42c42aefdc63614a88de0baa4d760d17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a057f2ae6ccff69435ec89ab880f02e8c" id="r_a057f2ae6ccff69435ec89ab880f02e8c"><td class="memItemLeft" align="right" valign="top"><a id="a057f2ae6ccff69435ec89ab880f02e8c" name="a057f2ae6ccff69435ec89ab880f02e8c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>RequireDefaultSpecIdUnchanged</b> ()</td></tr>
<tr class="memdesc:a057f2ae6ccff69435ec89ab880f02e8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Require that the default spec ID remains unchanged. <br /></td></tr>
<tr class="separator:a057f2ae6ccff69435ec89ab880f02e8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bd7b7090d15ed0871350996fa1b08bd" id="r_a1bd7b7090d15ed0871350996fa1b08bd"><td class="memItemLeft" align="right" valign="top"><a id="a1bd7b7090d15ed0871350996fa1b08bd" name="a1bd7b7090d15ed0871350996fa1b08bd"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>RequireDefaultSortOrderIdUnchanged</b> ()</td></tr>
<tr class="memdesc:a1bd7b7090d15ed0871350996fa1b08bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Require that the default sort order ID remains unchanged. <br /></td></tr>
<tr class="separator:a1bd7b7090d15ed0871350996fa1b08bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f080a4cf68fb7f973b657a062402979" id="r_a8f080a4cf68fb7f973b657a062402979"><td class="memItemLeft" align="right" valign="top"><a id="a8f080a4cf68fb7f973b657a062402979" name="a8f080a4cf68fb7f973b657a062402979"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>RequireNoBranchesChanged</b> ()</td></tr>
<tr class="memdesc:a8f080a4cf68fb7f973b657a062402979"><td class="mdescLeft">&#160;</td><td class="mdescRight">Require that no branches have been changed. <br /></td></tr>
<tr class="separator:a8f080a4cf68fb7f973b657a062402979"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a510a3fb9d39f40238a5c5cc2f2fccaa7" id="r_a510a3fb9d39f40238a5c5cc2f2fccaa7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TableUpdateContext.html#a510a3fb9d39f40238a5c5cc2f2fccaa7">AddChangedRef</a> (const std::string &amp;ref_name)</td></tr>
<tr class="memdesc:a510a3fb9d39f40238a5c5cc2f2fccaa7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Track a changed ref and return whether it was newly added. <br /></td></tr>
<tr class="separator:a510a3fb9d39f40238a5c5cc2f2fccaa7"><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>Context for generating table requirements. </p>
<p>This context is passed to each <a class="el" href="classiceberg_1_1TableUpdate.html" title="Base class for metadata update operations.">TableUpdate</a>'s GenerateRequirements method and maintains state about what requirements have already been added to avoid duplicates. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a4e5fc09d6eb180ae69b59fc560fa22a9" name="a4e5fc09d6eb180ae69b59fc560fa22a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e5fc09d6eb180ae69b59fc560fa22a9">&#9670;&#160;</a></span>TableUpdateContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">iceberg::TableUpdateContext::TableUpdateContext </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_replace</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a context for requirement generation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">base</td><td>The base table metadata (maybe nullptr for table creation) </td></tr>
<tr><td class="paramname">is_replace</td><td>Whether this is a replace operation (more permissive) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a510a3fb9d39f40238a5c5cc2f2fccaa7" name="a510a3fb9d39f40238a5c5cc2f2fccaa7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a510a3fb9d39f40238a5c5cc2f2fccaa7">&#9670;&#160;</a></span>AddChangedRef()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool iceberg::TableUpdateContext::AddChangedRef </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>ref_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Track a changed ref and return whether it was newly added. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ref_name</td><td>The name of the ref being changed </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if this is the first time the ref is being changed </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&#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>