Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./api/classiceberg_1_1table_1_1UpgradeFormatVersion.html
blob: 7645b169e87d2121fda8ca61b598ab1786a9fa1a [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::UpgradeFormatVersion 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_1UpgradeFormatVersion.html">UpgradeFormatVersion</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_1UpgradeFormatVersion-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::table::UpgradeFormatVersion Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Represents an upgrade of the table format version.
<a href="classiceberg_1_1table_1_1UpgradeFormatVersion.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="table__update_8h_source.html">table_update.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::table::UpgradeFormatVersion:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1table_1_1UpgradeFormatVersion.png" usemap="#iceberg::table::UpgradeFormatVersion_map" alt=""/>
<map id="iceberg::table::UpgradeFormatVersion_map" name="iceberg::table::UpgradeFormatVersion_map">
<area href="classiceberg_1_1TableUpdate.html" title="Base class for metadata update operations." alt="iceberg::TableUpdate" shape="rect" coords="0,0,225,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:a516fe0c7356afade204ce291c4573960" id="r_a516fe0c7356afade204ce291c4573960"><td class="memItemLeft" align="right" valign="top"><a id="a516fe0c7356afade204ce291c4573960" name="a516fe0c7356afade204ce291c4573960"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>UpgradeFormatVersion</b> (int8_t format_version)</td></tr>
<tr class="separator:a516fe0c7356afade204ce291c4573960"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af95382ae105c425960e1600d3cf711e1" id="r_af95382ae105c425960e1600d3cf711e1"><td class="memItemLeft" align="right" valign="top"><a id="af95382ae105c425960e1600d3cf711e1" name="af95382ae105c425960e1600d3cf711e1"></a>
int8_t&#160;</td><td class="memItemRight" valign="bottom"><b>format_version</b> () const</td></tr>
<tr class="separator:af95382ae105c425960e1600d3cf711e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d2cdf7ea6d5a8ce8f70ea52e6ea0514" id="r_a4d2cdf7ea6d5a8ce8f70ea52e6ea0514"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1table_1_1UpgradeFormatVersion.html#a4d2cdf7ea6d5a8ce8f70ea52e6ea0514">ApplyTo</a> (<a class="el" href="classiceberg_1_1TableMetadataBuilder.html">TableMetadataBuilder</a> &amp;builder) const override</td></tr>
<tr class="memdesc:a4d2cdf7ea6d5a8ce8f70ea52e6ea0514"><td class="mdescLeft">&#160;</td><td class="mdescRight">Apply this update to a <a class="el" href="classiceberg_1_1TableMetadataBuilder.html" title="Builder class for constructing TableMetadata objects.">TableMetadataBuilder</a>. <br /></td></tr>
<tr class="separator:a4d2cdf7ea6d5a8ce8f70ea52e6ea0514"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a78db6ae8580316f30911982ecfcfd6" id="r_a2a78db6ae8580316f30911982ecfcfd6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1table_1_1UpgradeFormatVersion.html#a2a78db6ae8580316f30911982ecfcfd6">GenerateRequirements</a> (<a class="el" href="classiceberg_1_1TableUpdateContext.html">TableUpdateContext</a> &amp;context) const override</td></tr>
<tr class="memdesc:a2a78db6ae8580316f30911982ecfcfd6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate update requirements for this metadata update. <br /></td></tr>
<tr class="separator:a2a78db6ae8580316f30911982ecfcfd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fd1492ca5fa6376ecef5ed32c845591" id="r_a3fd1492ca5fa6376ecef5ed32c845591"><td class="memItemLeft" align="right" valign="top">Kind&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1table_1_1UpgradeFormatVersion.html#a3fd1492ca5fa6376ecef5ed32c845591">kind</a> () const override</td></tr>
<tr class="memdesc:a3fd1492ca5fa6376ecef5ed32c845591"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the kind of this update. <br /></td></tr>
<tr class="separator:a3fd1492ca5fa6376ecef5ed32c845591"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a352aaa5b079b3feb6dc91f6bae293e54" id="r_a352aaa5b079b3feb6dc91f6bae293e54"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1table_1_1UpgradeFormatVersion.html#a352aaa5b079b3feb6dc91f6bae293e54">Equals</a> (const <a class="el" href="classiceberg_1_1TableUpdate.html">TableUpdate</a> &amp;other) const override</td></tr>
<tr class="memdesc:a352aaa5b079b3feb6dc91f6bae293e54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check equality with another <a class="el" href="classiceberg_1_1TableUpdate.html" title="Base class for metadata update operations.">TableUpdate</a>. <br /></td></tr>
<tr class="separator:a352aaa5b079b3feb6dc91f6bae293e54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52d742bc01e2fd4588ac8e91eb3dd5a7" id="r_a52d742bc01e2fd4588ac8e91eb3dd5a7"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classiceberg_1_1TableUpdate.html">TableUpdate</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1table_1_1UpgradeFormatVersion.html#a52d742bc01e2fd4588ac8e91eb3dd5a7">Clone</a> () const override</td></tr>
<tr class="memdesc:a52d742bc01e2fd4588ac8e91eb3dd5a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a deep copy of this update. <br /></td></tr>
<tr class="separator:a52d742bc01e2fd4588ac8e91eb3dd5a7"><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_1TableUpdate"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classiceberg_1_1TableUpdate')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classiceberg_1_1TableUpdate.html">iceberg::TableUpdate</a></td></tr>
<tr class="memitem:ad8c72b1755b111ad20acff6ae6d4974d inherit pub_types_classiceberg_1_1TableUpdate" id="r_ad8c72b1755b111ad20acff6ae6d4974d"><td class="memItemLeft" align="right" valign="top"><a id="ad8c72b1755b111ad20acff6ae6d4974d" name="ad8c72b1755b111ad20acff6ae6d4974d"></a>enum class &#160;</td><td class="memItemRight" valign="bottom"><b>Kind</b> : uint8_t { <br />
&#160;&#160;<b>kAssignUUID</b>
, <b>kUpgradeFormatVersion</b>
, <b>kAddSchema</b>
, <b>kSetCurrentSchema</b>
, <br />
&#160;&#160;<b>kAddPartitionSpec</b>
, <b>kSetDefaultPartitionSpec</b>
, <b>kRemovePartitionSpecs</b>
, <b>kRemoveSchemas</b>
, <br />
&#160;&#160;<b>kAddSortOrder</b>
, <b>kSetDefaultSortOrder</b>
, <b>kAddSnapshot</b>
, <b>kRemoveSnapshots</b>
, <br />
&#160;&#160;<b>kRemoveSnapshotRef</b>
, <b>kSetSnapshotRef</b>
, <b>kSetProperties</b>
, <b>kRemoveProperties</b>
, <br />
&#160;&#160;<b>kSetLocation</b>
, <b>kSetStatistics</b>
, <b>kRemoveStatistics</b>
, <b>kSetPartitionStatistics</b>
, <br />
&#160;&#160;<b>kRemovePartitionStatistics</b>
<br />
}</td></tr>
<tr class="separator:ad8c72b1755b111ad20acff6ae6d4974d inherit pub_types_classiceberg_1_1TableUpdate"><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>Represents an upgrade of the table format version. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a4d2cdf7ea6d5a8ce8f70ea52e6ea0514" name="a4d2cdf7ea6d5a8ce8f70ea52e6ea0514"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d2cdf7ea6d5a8ce8f70ea52e6ea0514">&#9670;&#160;</a></span>ApplyTo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void iceberg::table::UpgradeFormatVersion::ApplyTo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classiceberg_1_1TableMetadataBuilder.html">TableMetadataBuilder</a> &amp;&#160;</td>
<td class="paramname"><em>builder</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>Apply this update to a <a class="el" href="classiceberg_1_1TableMetadataBuilder.html" title="Builder class for constructing TableMetadata objects.">TableMetadataBuilder</a>. </p>
<p>This method modifies the builder by applying the update operation it represents. Each subclass implements this to apply its specific type of update.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">builder</td><td>The builder to apply this update to </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classiceberg_1_1TableUpdate.html#af07326d407ad45eb6072b586ee6c9485">iceberg::TableUpdate</a>.</p>
</div>
</div>
<a id="a52d742bc01e2fd4588ac8e91eb3dd5a7" name="a52d742bc01e2fd4588ac8e91eb3dd5a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52d742bc01e2fd4588ac8e91eb3dd5a7">&#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_1TableUpdate.html">TableUpdate</a> &gt; iceberg::table::UpgradeFormatVersion::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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a deep copy of this update. </p>
<dl class="section return"><dt>Returns</dt><dd>A unique_ptr to a new <a class="el" href="classiceberg_1_1TableUpdate.html" title="Base class for metadata update operations.">TableUpdate</a> that is a copy of this one </dd></dl>
<p>Implements <a class="el" href="classiceberg_1_1TableUpdate.html#affb4be490ac63849864bf8ed636363aa">iceberg::TableUpdate</a>.</p>
</div>
</div>
<a id="a352aaa5b079b3feb6dc91f6bae293e54" name="a352aaa5b079b3feb6dc91f6bae293e54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a352aaa5b079b3feb6dc91f6bae293e54">&#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::UpgradeFormatVersion::Equals </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classiceberg_1_1TableUpdate.html">TableUpdate</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">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_1TableUpdate.html" title="Base class for metadata update operations.">TableUpdate</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The update to compare with </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the updates are equal, false otherwise </dd></dl>
<p>Implements <a class="el" href="classiceberg_1_1TableUpdate.html#afd0780e6106546f7462e8e66d62db1f2">iceberg::TableUpdate</a>.</p>
</div>
</div>
<a id="a2a78db6ae8580316f30911982ecfcfd6" name="a2a78db6ae8580316f30911982ecfcfd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a78db6ae8580316f30911982ecfcfd6">&#9670;&#160;</a></span>GenerateRequirements()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void iceberg::table::UpgradeFormatVersion::GenerateRequirements </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classiceberg_1_1TableUpdateContext.html">TableUpdateContext</a> &amp;&#160;</td>
<td class="paramname"><em>context</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>Generate update requirements for this metadata update. </p>
<p>This method generates the appropriate UpdateRequirement instances that must be validated before this update can be applied. The context provides information about the base metadata and operation mode.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>The context containing base metadata and operation state </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classiceberg_1_1TableUpdate.html#adddc714f83cea93141bc5b771e326e05">iceberg::TableUpdate</a>.</p>
</div>
</div>
<a id="a3fd1492ca5fa6376ecef5ed32c845591" name="a3fd1492ca5fa6376ecef5ed32c845591"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fd1492ca5fa6376ecef5ed32c845591">&#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::UpgradeFormatVersion::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 this update. </p>
<p>Implements <a class="el" href="classiceberg_1_1TableUpdate.html#acf1e83fa9835010cda68a6a3387a08a5">iceberg::TableUpdate</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/<a class="el" href="table__update_8h_source.html">table_update.h</a></li>
<li>iceberg/<b>table_update.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>