| <!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::TableMetadataUtil 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_1TableMetadataUtil.html">TableMetadataUtil</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="structiceberg_1_1TableMetadataUtil-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::TableMetadataUtil Struct Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Utility class for table metadata. |
| <a href="structiceberg_1_1TableMetadataUtil.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="table__metadata_8h_source.html">table_metadata.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_1TableMetadataUtil_1_1Codec.html">Codec</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-static-methods" name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:abb843dbd12997d229100f74924a9c8e1" id="r_abb843dbd12997d229100f74924a9c8e1"><td class="memItemLeft" align="right" valign="top">static Result< std::unique_ptr< <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1TableMetadataUtil.html#abb843dbd12997d229100f74924a9c8e1">Read</a> (class <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> &io, const std::string &location, std::optional< size_t > length=std::nullopt)</td></tr> |
| <tr class="memdesc:abb843dbd12997d229100f74924a9c8e1"><td class="mdescLeft"> </td><td class="mdescRight">Read the table metadata file. <br /></td></tr> |
| <tr class="separator:abb843dbd12997d229100f74924a9c8e1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aeaf367eba6c09c9f811c2721eb40b350" id="r_aeaf367eba6c09c9f811c2721eb40b350"><td class="memItemLeft" align="right" valign="top">static Result< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1TableMetadataUtil.html#aeaf367eba6c09c9f811c2721eb40b350">Write</a> (<a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> &io, const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> *base, const std::string &base_metadata_location, <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> &metadata)</td></tr> |
| <tr class="memdesc:aeaf367eba6c09c9f811c2721eb40b350"><td class="mdescLeft"> </td><td class="mdescRight">Write a new metadata file to storage. <br /></td></tr> |
| <tr class="separator:aeaf367eba6c09c9f811c2721eb40b350"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0f46fe1cb007221c62083601be5f3d8e" id="r_a0f46fe1cb007221c62083601be5f3d8e"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1TableMetadataUtil.html#a0f46fe1cb007221c62083601be5f3d8e">DeleteRemovedMetadataFiles</a> (<a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> &io, const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> *base, const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> &metadata)</td></tr> |
| <tr class="memdesc:a0f46fe1cb007221c62083601be5f3d8e"><td class="mdescLeft"> </td><td class="mdescRight">Delete removed metadata files based on retention policy. <br /></td></tr> |
| <tr class="separator:a0f46fe1cb007221c62083601be5f3d8e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0fc746f383f30260753e3e5834fcf42a" id="r_a0fc746f383f30260753e3e5834fcf42a"><td class="memItemLeft" align="right" valign="top">static Status </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1TableMetadataUtil.html#a0fc746f383f30260753e3e5834fcf42a">Write</a> (<a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> &io, const std::string &location, const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> &metadata)</td></tr> |
| <tr class="memdesc:a0fc746f383f30260753e3e5834fcf42a"><td class="mdescLeft"> </td><td class="mdescRight">Write the table metadata to a file. <br /></td></tr> |
| <tr class="separator:a0fc746f383f30260753e3e5834fcf42a"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Utility class for table metadata. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a0f46fe1cb007221c62083601be5f3d8e" name="a0f46fe1cb007221c62083601be5f3d8e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0f46fe1cb007221c62083601be5f3d8e">◆ </a></span>DeleteRemovedMetadataFiles()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void iceberg::TableMetadataUtil::DeleteRemovedMetadataFiles </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> & </td> |
| <td class="paramname"><em>io</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> * </td> |
| <td class="paramname"><em>base</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> & </td> |
| <td class="paramname"><em>metadata</em> </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>Delete removed metadata files based on retention policy. </p> |
| <p>Removes obsolete metadata files that are no longer referenced in the current metadata log, based on the metadata.delete-after-commit.enabled property.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">io</td><td>The <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> instance for deleting files </td></tr> |
| <tr><td class="paramname">base</td><td>The previous metadata version </td></tr> |
| <tr><td class="paramname">metadata</td><td>The current metadata containing the updated log </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="abb843dbd12997d229100f74924a9c8e1" name="abb843dbd12997d229100f74924a9c8e1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abb843dbd12997d229100f74924a9c8e1">◆ </a></span>Read()</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_1TableMetadata.html">TableMetadata</a> > > iceberg::TableMetadataUtil::Read </td> |
| <td>(</td> |
| <td class="paramtype">class <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> & </td> |
| <td class="paramname"><em>io</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>location</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::optional< size_t > </td> |
| <td class="paramname"><em>length</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>Read the table metadata file. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">io</td><td>The file IO to use to read the table metadata. </td></tr> |
| <tr><td class="paramname">location</td><td>The location of the table metadata file. </td></tr> |
| <tr><td class="paramname">length</td><td>The optional length of the table metadata file. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The table metadata. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a0fc746f383f30260753e3e5834fcf42a" name="a0fc746f383f30260753e3e5834fcf42a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0fc746f383f30260753e3e5834fcf42a">◆ </a></span>Write() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Status iceberg::TableMetadataUtil::Write </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> & </td> |
| <td class="paramname"><em>io</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>location</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> & </td> |
| <td class="paramname"><em>metadata</em> </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>Write the table metadata to a file. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">io</td><td>The file IO to use to write the table metadata. </td></tr> |
| <tr><td class="paramname">location</td><td>The location of the table metadata file. </td></tr> |
| <tr><td class="paramname">metadata</td><td>The table metadata to write. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="aeaf367eba6c09c9f811c2721eb40b350" name="aeaf367eba6c09c9f811c2721eb40b350"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aeaf367eba6c09c9f811c2721eb40b350">◆ </a></span>Write() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::string > iceberg::TableMetadataUtil::Write </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> & </td> |
| <td class="paramname"><em>io</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> * </td> |
| <td class="paramname"><em>base</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>base_metadata_location</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> & </td> |
| <td class="paramname"><em>metadata</em> </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>Write a new metadata file to storage. </p> |
| <p>Serializes the table metadata to JSON and writes it to a new metadata file. If no location is specified in the metadata, generates a new file path based on the version number.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">io</td><td>The <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> instance for writing files </td></tr> |
| <tr><td class="paramname">base</td><td>The base metadata (can be null for new tables) </td></tr> |
| <tr><td class="paramname">metadata</td><td>The metadata to write, which will be updated with the new location </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The new metadata location </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following files:<ul> |
| <li>iceberg/<a class="el" href="table__metadata_8h_source.html">table_metadata.h</a></li> |
| <li>iceberg/<b>table_metadata.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> |
