| <!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::SnapshotCache 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&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="classiceberg_1_1SnapshotCache.html">SnapshotCache</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classiceberg_1_1SnapshotCache-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::SnapshotCache Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A snapshot with cached manifest loading capabilities. |
| <a href="classiceberg_1_1SnapshotCache.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="pub-methods" name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a16833bcc6e2b4036d813f62ce7e9571e" id="r_a16833bcc6e2b4036d813f62ce7e9571e"><td class="memItemLeft" align="right" valign="top"><a id="a16833bcc6e2b4036d813f62ce7e9571e" name="a16833bcc6e2b4036d813f62ce7e9571e"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>SnapshotCache</b> (const <a class="el" href="structiceberg_1_1Snapshot.html">Snapshot</a> *<a class="el" href="classiceberg_1_1SnapshotCache.html#a673648c4ae8593852e7d7bf762cb9df3">snapshot</a>)</td></tr> |
| <tr class="separator:a16833bcc6e2b4036d813f62ce7e9571e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a673648c4ae8593852e7d7bf762cb9df3" id="r_a673648c4ae8593852e7d7bf762cb9df3"><td class="memItemLeft" align="right" valign="top"><a id="a673648c4ae8593852e7d7bf762cb9df3" name="a673648c4ae8593852e7d7bf762cb9df3"></a> |
| const <a class="el" href="structiceberg_1_1Snapshot.html">Snapshot</a> & </td><td class="memItemRight" valign="bottom"><b>snapshot</b> () const</td></tr> |
| <tr class="memdesc:a673648c4ae8593852e7d7bf762cb9df3"><td class="mdescLeft"> </td><td class="mdescRight">Get the underlying <a class="el" href="structiceberg_1_1Snapshot.html" title="A snapshot of the data in a table at a point in time.">Snapshot</a> reference. <br /></td></tr> |
| <tr class="separator:a673648c4ae8593852e7d7bf762cb9df3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a831934b6a12ce637f7aecd80b0c2fa8e" id="r_a831934b6a12ce637f7aecd80b0c2fa8e"><td class="memItemLeft" align="right" valign="top">Result< std::span< <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SnapshotCache.html#a831934b6a12ce637f7aecd80b0c2fa8e">Manifests</a> (std::shared_ptr< <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> > file_io) const</td></tr> |
| <tr class="memdesc:a831934b6a12ce637f7aecd80b0c2fa8e"><td class="mdescLeft"> </td><td class="mdescRight">Returns all <a class="el" href="structiceberg_1_1ManifestFile.html" title="Entry in a manifest list.">ManifestFile</a> instances for either data or delete manifests in this snapshot. <br /></td></tr> |
| <tr class="separator:a831934b6a12ce637f7aecd80b0c2fa8e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae4cae94c907194ca293dc7dd0f554e95" id="r_ae4cae94c907194ca293dc7dd0f554e95"><td class="memItemLeft" align="right" valign="top">Result< std::span< <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SnapshotCache.html#ae4cae94c907194ca293dc7dd0f554e95">DataManifests</a> (std::shared_ptr< <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> > file_io) const</td></tr> |
| <tr class="memdesc:ae4cae94c907194ca293dc7dd0f554e95"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="structiceberg_1_1ManifestFile.html" title="Entry in a manifest list.">ManifestFile</a> for each data manifest in this snapshot. <br /></td></tr> |
| <tr class="separator:ae4cae94c907194ca293dc7dd0f554e95"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aac4d585d74577958db24c559e421a450" id="r_aac4d585d74577958db24c559e421a450"><td class="memItemLeft" align="right" valign="top">Result< std::span< <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SnapshotCache.html#aac4d585d74577958db24c559e421a450">DeleteManifests</a> (std::shared_ptr< <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> > file_io) const</td></tr> |
| <tr class="memdesc:aac4d585d74577958db24c559e421a450"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="structiceberg_1_1ManifestFile.html" title="Entry in a manifest list.">ManifestFile</a> for each delete manifest in this snapshot. <br /></td></tr> |
| <tr class="separator:aac4d585d74577958db24c559e421a450"><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 snapshot with cached manifest loading capabilities. </p> |
| <p>This class wraps a <a class="el" href="structiceberg_1_1Snapshot.html" title="A snapshot of the data in a table at a point in time.">Snapshot</a> pointer and provides lazy-loading of manifests. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ae4cae94c907194ca293dc7dd0f554e95" name="ae4cae94c907194ca293dc7dd0f554e95"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae4cae94c907194ca293dc7dd0f554e95">◆ </a></span>DataManifests()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::span< <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> > > iceberg::SnapshotCache::DataManifests </td> |
| <td>(</td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> > </td> |
| <td class="paramname"><em>file_io</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a <a class="el" href="structiceberg_1_1ManifestFile.html" title="Entry in a manifest list.">ManifestFile</a> for each data manifest in this snapshot. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">file_io</td><td>The <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> instance to use for reading the manifest list </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A span of <a class="el" href="structiceberg_1_1ManifestFile.html" title="Entry in a manifest list.">ManifestFile</a> instances, or an error </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aac4d585d74577958db24c559e421a450" name="aac4d585d74577958db24c559e421a450"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aac4d585d74577958db24c559e421a450">◆ </a></span>DeleteManifests()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::span< <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> > > iceberg::SnapshotCache::DeleteManifests </td> |
| <td>(</td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> > </td> |
| <td class="paramname"><em>file_io</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a <a class="el" href="structiceberg_1_1ManifestFile.html" title="Entry in a manifest list.">ManifestFile</a> for each delete manifest in this snapshot. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">file_io</td><td>The <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> instance to use for reading the manifest list </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A span of <a class="el" href="structiceberg_1_1ManifestFile.html" title="Entry in a manifest list.">ManifestFile</a> instances, or an error </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a831934b6a12ce637f7aecd80b0c2fa8e" name="a831934b6a12ce637f7aecd80b0c2fa8e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a831934b6a12ce637f7aecd80b0c2fa8e">◆ </a></span>Manifests()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::span< <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> > > iceberg::SnapshotCache::Manifests </td> |
| <td>(</td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> > </td> |
| <td class="paramname"><em>file_io</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns all <a class="el" href="structiceberg_1_1ManifestFile.html" title="Entry in a manifest list.">ManifestFile</a> instances for either data or delete manifests in this snapshot. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">file_io</td><td>The <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> instance to use for reading the manifest list </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A span of <a class="el" href="structiceberg_1_1ManifestFile.html" title="Entry in a manifest list.">ManifestFile</a> instances, or an error </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class 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> |
