| <!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::SnapshotRef Struct 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&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&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="structiceberg_1_1SnapshotRef.html">SnapshotRef</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="#friends">Friends</a> | |
| <a href="structiceberg_1_1SnapshotRef-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::SnapshotRef Struct Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A reference to a snapshot, either a branch or a tag. |
| <a href="structiceberg_1_1SnapshotRef.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="snapshot_8h_source.html">snapshot.h</a>></code></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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1SnapshotRef_1_1Branch.html">Branch</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1SnapshotRef_1_1Tag.html">Tag</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><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:a9d6b5d8784e00362d94ccb35c54e9be6" id="r_a9d6b5d8784e00362d94ccb35c54e9be6"><td class="memItemLeft" align="right" valign="top"><a id="a9d6b5d8784e00362d94ccb35c54e9be6" name="a9d6b5d8784e00362d94ccb35c54e9be6"></a> |
| SnapshotRefType </td><td class="memItemRight" valign="bottom"><b>type</b> () const noexcept</td></tr> |
| <tr class="separator:a9d6b5d8784e00362d94ccb35c54e9be6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a44c8fa194f7b90a6303d2b9d6ebb7a5a" id="r_a44c8fa194f7b90a6303d2b9d6ebb7a5a"><td class="memItemLeft" align="right" valign="top"><a id="a44c8fa194f7b90a6303d2b9d6ebb7a5a" name="a44c8fa194f7b90a6303d2b9d6ebb7a5a"></a> |
| std::optional< int64_t > </td><td class="memItemRight" valign="bottom"><b>max_ref_age_ms</b> () const noexcept</td></tr> |
| <tr class="separator:a44c8fa194f7b90a6303d2b9d6ebb7a5a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a873b9724bd77edbf12dbabdb98a37523" id="r_a873b9724bd77edbf12dbabdb98a37523"><td class="memItemLeft" align="right" valign="top">std::unique_ptr< <a class="el" href="structiceberg_1_1SnapshotRef.html">SnapshotRef</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1SnapshotRef.html#a873b9724bd77edbf12dbabdb98a37523">Clone</a> (std::optional< int64_t > new_snapshot_id=std::nullopt) const</td></tr> |
| <tr class="memdesc:a873b9724bd77edbf12dbabdb98a37523"><td class="mdescLeft"> </td><td class="mdescRight">Clone this <a class="el" href="structiceberg_1_1SnapshotRef.html" title="A reference to a snapshot, either a branch or a tag.">SnapshotRef</a> with an optional new snapshot ID. <br /></td></tr> |
| <tr class="separator:a873b9724bd77edbf12dbabdb98a37523"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a50cdaf229521f701109fd99d6f51fb32" id="r_a50cdaf229521f701109fd99d6f51fb32"><td class="memItemLeft" align="right" valign="top"><a id="a50cdaf229521f701109fd99d6f51fb32" name="a50cdaf229521f701109fd99d6f51fb32"></a> |
| Status </td><td class="memItemRight" valign="bottom"><b>Validate</b> () const</td></tr> |
| <tr class="memdesc:a50cdaf229521f701109fd99d6f51fb32"><td class="mdescLeft"> </td><td class="mdescRight">Validate the <a class="el" href="structiceberg_1_1SnapshotRef.html" title="A reference to a snapshot, either a branch or a tag.">SnapshotRef</a>. <br /></td></tr> |
| <tr class="separator:a50cdaf229521f701109fd99d6f51fb32"><td class="memSeparator" colspan="2"> </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:ae0d62ab650d10cd4381332760464e187" id="r_ae0d62ab650d10cd4381332760464e187"><td class="memItemLeft" align="right" valign="top">static Result< std::unique_ptr< <a class="el" href="structiceberg_1_1SnapshotRef.html">SnapshotRef</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1SnapshotRef.html#ae0d62ab650d10cd4381332760464e187">MakeBranch</a> (int64_t <a class="el" href="structiceberg_1_1SnapshotRef.html#a63ac8ff0babbe68126fb52e54e7e1adb">snapshot_id</a>, std::optional< int32_t > min_snapshots_to_keep=std::nullopt, std::optional< int64_t > max_snapshot_age_ms=std::nullopt, std::optional< int64_t > max_ref_age_ms=std::nullopt)</td></tr> |
| <tr class="memdesc:ae0d62ab650d10cd4381332760464e187"><td class="mdescLeft"> </td><td class="mdescRight">Create a branch reference. <br /></td></tr> |
| <tr class="separator:ae0d62ab650d10cd4381332760464e187"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a91fa5ae1565099c173a1c0e0e7851f7c" id="r_a91fa5ae1565099c173a1c0e0e7851f7c"><td class="memItemLeft" align="right" valign="top">static Result< std::unique_ptr< <a class="el" href="structiceberg_1_1SnapshotRef.html">SnapshotRef</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1SnapshotRef.html#a91fa5ae1565099c173a1c0e0e7851f7c">MakeTag</a> (int64_t <a class="el" href="structiceberg_1_1SnapshotRef.html#a63ac8ff0babbe68126fb52e54e7e1adb">snapshot_id</a>, std::optional< int64_t > max_ref_age_ms=std::nullopt)</td></tr> |
| <tr class="memdesc:a91fa5ae1565099c173a1c0e0e7851f7c"><td class="mdescLeft"> </td><td class="mdescRight">Create a tag reference. <br /></td></tr> |
| <tr class="separator:a91fa5ae1565099c173a1c0e0e7851f7c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:a63ac8ff0babbe68126fb52e54e7e1adb" id="r_a63ac8ff0babbe68126fb52e54e7e1adb"><td class="memItemLeft" align="right" valign="top"><a id="a63ac8ff0babbe68126fb52e54e7e1adb" name="a63ac8ff0babbe68126fb52e54e7e1adb"></a> |
| int64_t </td><td class="memItemRight" valign="bottom"><b>snapshot_id</b></td></tr> |
| <tr class="memdesc:a63ac8ff0babbe68126fb52e54e7e1adb"><td class="mdescLeft"> </td><td class="mdescRight">A reference's snapshot ID. The tagged snapshot or latest snapshot of a branch. <br /></td></tr> |
| <tr class="separator:a63ac8ff0babbe68126fb52e54e7e1adb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae89f6fb03dacc07e6cde3c81a133add1" id="r_ae89f6fb03dacc07e6cde3c81a133add1"><td class="memItemLeft" align="right" valign="top"><a id="ae89f6fb03dacc07e6cde3c81a133add1" name="ae89f6fb03dacc07e6cde3c81a133add1"></a> |
| std::variant< <a class="el" href="structiceberg_1_1SnapshotRef_1_1Branch.html">Branch</a>, <a class="el" href="structiceberg_1_1SnapshotRef_1_1Tag.html">Tag</a> > </td><td class="memItemRight" valign="bottom"><b>retention</b></td></tr> |
| <tr class="memdesc:ae89f6fb03dacc07e6cde3c81a133add1"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structiceberg_1_1Snapshot.html" title="A snapshot of the data in a table at a point in time.">Snapshot</a> retention policy. <br /></td></tr> |
| <tr class="separator:ae89f6fb03dacc07e6cde3c81a133add1"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr class="memitem:aba3c18bb45dd519bab94ea9998f11406" id="r_aba3c18bb45dd519bab94ea9998f11406"><td class="memItemLeft" align="right" valign="top"><a id="aba3c18bb45dd519bab94ea9998f11406" name="aba3c18bb45dd519bab94ea9998f11406"></a> |
| static constexpr std::string_view </td><td class="memItemRight" valign="bottom"><b>kMainBranch</b> = "main"</td></tr> |
| <tr class="separator:aba3c18bb45dd519bab94ea9998f11406"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a> |
| Friends</h2></td></tr> |
| <tr class="memitem:a01bf700dbfb0e7307921d30795db8819" id="r_a01bf700dbfb0e7307921d30795db8819"><td class="memItemLeft" align="right" valign="top"><a id="a01bf700dbfb0e7307921d30795db8819" name="a01bf700dbfb0e7307921d30795db8819"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="structiceberg_1_1SnapshotRef.html">SnapshotRef</a> &lhs, const <a class="el" href="structiceberg_1_1SnapshotRef.html">SnapshotRef</a> &rhs)</td></tr> |
| <tr class="memdesc:a01bf700dbfb0e7307921d30795db8819"><td class="mdescLeft"> </td><td class="mdescRight">Compare two snapshot refs for equality. <br /></td></tr> |
| <tr class="separator:a01bf700dbfb0e7307921d30795db8819"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A reference to a snapshot, either a branch or a tag. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a873b9724bd77edbf12dbabdb98a37523" name="a873b9724bd77edbf12dbabdb98a37523"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a873b9724bd77edbf12dbabdb98a37523">◆ </a></span>Clone()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::unique_ptr< <a class="el" href="structiceberg_1_1SnapshotRef.html">SnapshotRef</a> > iceberg::SnapshotRef::Clone </td> |
| <td>(</td> |
| <td class="paramtype">std::optional< int64_t > </td> |
| <td class="paramname"><em>new_snapshot_id</em> = <code>std::nullopt</code></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Clone this <a class="el" href="structiceberg_1_1SnapshotRef.html" title="A reference to a snapshot, either a branch or a tag.">SnapshotRef</a> with an optional new snapshot ID. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">new_snapshot_id</td><td>Optional new snapshot ID. If not provided, uses the current snapshot_id </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A unique_ptr to the cloned <a class="el" href="structiceberg_1_1SnapshotRef.html" title="A reference to a snapshot, either a branch or a tag.">SnapshotRef</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ae0d62ab650d10cd4381332760464e187" name="ae0d62ab650d10cd4381332760464e187"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae0d62ab650d10cd4381332760464e187">◆ </a></span>MakeBranch()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::unique_ptr< <a class="el" href="structiceberg_1_1SnapshotRef.html">SnapshotRef</a> > > iceberg::SnapshotRef::MakeBranch </td> |
| <td>(</td> |
| <td class="paramtype">int64_t </td> |
| <td class="paramname"><em>snapshot_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::optional< int32_t > </td> |
| <td class="paramname"><em>min_snapshots_to_keep</em> = <code>std::nullopt</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::optional< int64_t > </td> |
| <td class="paramname"><em>max_snapshot_age_ms</em> = <code>std::nullopt</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::optional< int64_t > </td> |
| <td class="paramname"><em>max_ref_age_ms</em> = <code>std::nullopt</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a branch reference. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">snapshot_id</td><td>The snapshot ID for the branch </td></tr> |
| <tr><td class="paramname">min_snapshots_to_keep</td><td>Optional minimum number of snapshots to keep </td></tr> |
| <tr><td class="paramname">max_snapshot_age_ms</td><td>Optional maximum snapshot age in milliseconds </td></tr> |
| <tr><td class="paramname">max_ref_age_ms</td><td>Optional maximum reference age in milliseconds </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A Result containing a unique_ptr to the <a class="el" href="structiceberg_1_1SnapshotRef.html" title="A reference to a snapshot, either a branch or a tag.">SnapshotRef</a>, or an error if validation failed </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a91fa5ae1565099c173a1c0e0e7851f7c" name="a91fa5ae1565099c173a1c0e0e7851f7c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a91fa5ae1565099c173a1c0e0e7851f7c">◆ </a></span>MakeTag()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::unique_ptr< <a class="el" href="structiceberg_1_1SnapshotRef.html">SnapshotRef</a> > > iceberg::SnapshotRef::MakeTag </td> |
| <td>(</td> |
| <td class="paramtype">int64_t </td> |
| <td class="paramname"><em>snapshot_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::optional< int64_t > </td> |
| <td class="paramname"><em>max_ref_age_ms</em> = <code>std::nullopt</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a tag reference. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">snapshot_id</td><td>The snapshot ID for the tag </td></tr> |
| <tr><td class="paramname">max_ref_age_ms</td><td>Optional maximum reference age in milliseconds </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A Result containing a unique_ptr to the <a class="el" href="structiceberg_1_1SnapshotRef.html" title="A reference to a snapshot, either a branch or a tag.">SnapshotRef</a>, or an error if validation failed </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following files:<ul> |
| <li>iceberg/<a class="el" href="snapshot_8h_source.html">snapshot.h</a></li> |
| <li>iceberg/<b>snapshot.cc</b></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
