Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/snapshot_8h.html
blob: d1aefb14cbb216989d9758b31b5166b7307eba7b [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/snapshot.h File 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="dir_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">snapshot.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Define snapshot metadata types.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;memory&gt;</code><br />
<code>#include &lt;optional&gt;</code><br />
<code>#include &lt;span&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;string_view&gt;</code><br />
<code>#include &lt;unordered_map&gt;</code><br />
<code>#include &lt;variant&gt;</code><br />
<code>#include &quot;<a class="el" href="iceberg__export_8h_source.html">iceberg/iceberg_export.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="manifest__list_8h_source.html">iceberg/manifest/manifest_list.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="result_8h_source.html">iceberg/result.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="type__fwd_8h_source.html">iceberg/type_fwd.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="lazy_8h_source.html">iceberg/util/lazy.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="timepoint_8h_source.html">iceberg/util/timepoint.h</a>&quot;</code><br />
</div>
<p><a href="snapshot_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1SnapshotRef.html">iceberg::SnapshotRef</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A reference to a snapshot, either a branch or a tag. <a href="structiceberg_1_1SnapshotRef.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1SnapshotRef_1_1Branch.html">iceberg::SnapshotRef::Branch</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1SnapshotRef_1_1Tag.html">iceberg::SnapshotRef::Tag</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1SnapshotSummaryFields.html">iceberg::SnapshotSummaryFields</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional <a class="el" href="structiceberg_1_1Snapshot.html" title="A snapshot of the data in a table at a point in time.">Snapshot</a> Summary Fields. <a href="structiceberg_1_1SnapshotSummaryFields.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SnapshotSummaryBuilder.html">iceberg::SnapshotSummaryBuilder</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper class for building snapshot summaries. <a href="classiceberg_1_1SnapshotSummaryBuilder.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1DataOperation.html">iceberg::DataOperation</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data operation that produce snapshots. <a href="structiceberg_1_1DataOperation.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1Snapshot.html">iceberg::Snapshot</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A snapshot of the data in a table at a point in time. <a href="structiceberg_1_1Snapshot.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SnapshotCache.html">iceberg::SnapshotCache</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A snapshot with cached manifest loading capabilities. <a href="classiceberg_1_1SnapshotCache.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceiceberg" id="r_namespaceiceberg"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html">iceberg</a></td></tr>
<tr class="memdesc:namespaceiceberg"><td class="mdescLeft">&#160;</td><td class="mdescRight">Core Apache Iceberg C++ APIs. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a8671d0926630b93487784772a49991c9" id="r_a8671d0926630b93487784772a49991c9"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html#a8671d0926630b93487784772a49991c9">iceberg::SnapshotRefType</a> { <a class="el" href="namespaceiceberg.html#a8671d0926630b93487784772a49991c9a10a4bd395ede64152b6ef02ce999cab9">iceberg::kBranch</a>
, <a class="el" href="namespaceiceberg.html#a8671d0926630b93487784772a49991c9a7b4a510071e5153ab98f54144688b0aa">iceberg::kTag</a>
}</td></tr>
<tr class="memdesc:a8671d0926630b93487784772a49991c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type of snapshot reference. <a href="namespaceiceberg.html#a8671d0926630b93487784772a49991c9">More...</a><br /></td></tr>
<tr class="separator:a8671d0926630b93487784772a49991c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a66c712314b7f24e819af7cb09429b4f5" id="r_a66c712314b7f24e819af7cb09429b4f5"><td class="memItemLeft" align="right" valign="top"><a id="a66c712314b7f24e819af7cb09429b4f5" name="a66c712314b7f24e819af7cb09429b4f5"></a>
ICEBERG_EXPORT constexpr std::string_view&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::ToString</b> (<a class="el" href="namespaceiceberg.html#a8671d0926630b93487784772a49991c9">SnapshotRefType</a> type) noexcept</td></tr>
<tr class="memdesc:a66c712314b7f24e819af7cb09429b4f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the relative snapshot reference type name. <br /></td></tr>
<tr class="separator:a66c712314b7f24e819af7cb09429b4f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5028419abfe2479746086ccf712ce7d7" id="r_a5028419abfe2479746086ccf712ce7d7"><td class="memItemLeft" align="right" valign="top"><a id="a5028419abfe2479746086ccf712ce7d7" name="a5028419abfe2479746086ccf712ce7d7"></a>
ICEBERG_EXPORT constexpr <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; <a class="el" href="namespaceiceberg.html#a8671d0926630b93487784772a49991c9">SnapshotRefType</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::SnapshotRefTypeFromString</b> (std::string_view str) noexcept</td></tr>
<tr class="memdesc:a5028419abfe2479746086ccf712ce7d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the relative snapshot reference type from name. <br /></td></tr>
<tr class="separator:a5028419abfe2479746086ccf712ce7d7"><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>Define snapshot metadata types. </p>
</div></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>