Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./api/classiceberg_1_1SnapshotsTable.html
blob: e9fa950f5db5547b1fb71fa91cb8e70a69e90664 [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::SnapshotsTable 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"><a class="el" href="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1SnapshotsTable.html">SnapshotsTable</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classiceberg_1_1SnapshotsTable-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::SnapshotsTable Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Snapshots metadata table.
<a href="classiceberg_1_1SnapshotsTable.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="snapshots__table_8h_source.html">snapshots_table.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::SnapshotsTable:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1SnapshotsTable.png" usemap="#iceberg::SnapshotsTable_map" alt=""/>
<map id="iceberg::SnapshotsTable_map" name="iceberg::SnapshotsTable_map">
<area href="classiceberg_1_1MetadataTable.html" title="Base class for Iceberg metadata tables." alt="iceberg::MetadataTable" shape="rect" coords="0,0,150,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:a197bd0da420c42393fea2fb0385b0e9e" id="r_a197bd0da420c42393fea2fb0385b0e9e"><td class="memItemLeft" align="right" valign="top">Kind&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SnapshotsTable.html#a197bd0da420c42393fea2fb0385b0e9e">kind</a> () const noexcept override</td></tr>
<tr class="separator:a197bd0da420c42393fea2fb0385b0e9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classiceberg_1_1MetadataTable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1MetadataTable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classiceberg_1_1MetadataTable.html">iceberg::MetadataTable</a></td></tr>
<tr class="memitem:a80ffbf5773285c4cfffd87e3f3aa135a inherit pub_methods_classiceberg_1_1MetadataTable" id="r_a80ffbf5773285c4cfffd87e3f3aa135a"><td class="memItemLeft" align="right" valign="top">
const <a class="el" href="structiceberg_1_1TableIdentifier.html">TableIdentifier</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>name</b> () const</td></tr>
<tr class="separator:a80ffbf5773285c4cfffd87e3f3aa135a inherit pub_methods_classiceberg_1_1MetadataTable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6af80c78f61c912d3a0adc82e31abe55 inherit pub_methods_classiceberg_1_1MetadataTable" id="r_a6af80c78f61c912d3a0adc82e31abe55"><td class="memItemLeft" align="right" valign="top">
const std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>schema</b> () const</td></tr>
<tr class="separator:a6af80c78f61c912d3a0adc82e31abe55 inherit pub_methods_classiceberg_1_1MetadataTable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2a8830064cb79a84440e656c66d246e inherit pub_methods_classiceberg_1_1MetadataTable" id="r_aa2a8830064cb79a84440e656c66d246e"><td class="memItemLeft" align="right" valign="top">
const std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Table.html">Table</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>source_table</b> () const</td></tr>
<tr class="separator:aa2a8830064cb79a84440e656c66d246e inherit pub_methods_classiceberg_1_1MetadataTable"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a0a67ad556bee2d87598a8776f2ab947e" id="r_a0a67ad556bee2d87598a8776f2ab947e"><td class="memItemLeft" align="right" valign="top"><a id="a0a67ad556bee2d87598a8776f2ab947e" name="a0a67ad556bee2d87598a8776f2ab947e"></a>
static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1SnapshotsTable.html">SnapshotsTable</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Make</b> (std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Table.html">Table</a> &gt; table)</td></tr>
<tr class="separator:a0a67ad556bee2d87598a8776f2ab947e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_static_methods_classiceberg_1_1MetadataTable"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classiceberg_1_1MetadataTable')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classiceberg_1_1MetadataTable.html">iceberg::MetadataTable</a></td></tr>
<tr class="memitem:a2e1fe7d202001034922dfa5f59ebbca7 inherit pub_static_methods_classiceberg_1_1MetadataTable" id="r_a2e1fe7d202001034922dfa5f59ebbca7"><td class="memItemLeft" align="right" valign="top">
static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1MetadataTable.html">MetadataTable</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Make</b> (std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Table.html">Table</a> &gt; table, Kind kind)</td></tr>
<tr class="separator:a2e1fe7d202001034922dfa5f59ebbca7 inherit pub_static_methods_classiceberg_1_1MetadataTable"><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_1MetadataTable"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classiceberg_1_1MetadataTable')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classiceberg_1_1MetadataTable.html">iceberg::MetadataTable</a></td></tr>
<tr class="memitem:ab415f49673094ebf56b168856fc912dc inherit pub_types_classiceberg_1_1MetadataTable" id="r_ab415f49673094ebf56b168856fc912dc"><td class="memItemLeft" align="right" valign="top"><a id="ab415f49673094ebf56b168856fc912dc" name="ab415f49673094ebf56b168856fc912dc"></a>enum class &#160;</td><td class="memItemRight" valign="bottom"><b>Kind</b> { <b>kSnapshots</b>
, <b>kHistory</b>
}</td></tr>
<tr class="separator:ab415f49673094ebf56b168856fc912dc inherit pub_types_classiceberg_1_1MetadataTable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classiceberg_1_1MetadataTable"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classiceberg_1_1MetadataTable')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classiceberg_1_1MetadataTable.html">iceberg::MetadataTable</a></td></tr>
<tr class="memitem:aea6acd268225e31f16e64fb885de3e93 inherit pro_methods_classiceberg_1_1MetadataTable" id="r_aea6acd268225e31f16e64fb885de3e93"><td class="memItemLeft" align="right" valign="top">
&#160;</td><td class="memItemRight" valign="bottom"><b>MetadataTable</b> (std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Table.html">Table</a> &gt; source_table, <a class="el" href="structiceberg_1_1TableIdentifier.html">TableIdentifier</a> identifier, std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &gt; schema)</td></tr>
<tr class="separator:aea6acd268225e31f16e64fb885de3e93 inherit pro_methods_classiceberg_1_1MetadataTable"><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>Snapshots metadata table. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a197bd0da420c42393fea2fb0385b0e9e" name="a197bd0da420c42393fea2fb0385b0e9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a197bd0da420c42393fea2fb0385b0e9e">&#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::SnapshotsTable::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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classiceberg_1_1MetadataTable.html">iceberg::MetadataTable</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/inspect/<a class="el" href="snapshots__table_8h_source.html">snapshots_table.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>