blob: 7c73bd8aa4094c9868503c9458572ef05636afdf [file] [log] [blame]
<!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::ManifestFileAdapter 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"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1ManifestFileAdapter.html">ManifestFileAdapter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-static-methods">Static Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classiceberg_1_1ManifestFileAdapter-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::ManifestFileAdapter Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Adapter for appending a list of <code><a class="el" href="structiceberg_1_1ManifestFile.html" title="Entry in a manifest list.">ManifestFile</a></code>s to an <code><a class="el" href="structArrowArray.html">ArrowArray</a></code>. Implemented by different versions with version-specific schemas.
<a href="classiceberg_1_1ManifestFileAdapter.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="manifest__adapter__internal_8h_source.html">manifest_adapter_internal.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::ManifestFileAdapter:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1ManifestFileAdapter.png" usemap="#iceberg::ManifestFileAdapter_map" alt=""/>
<map id="iceberg::ManifestFileAdapter_map" name="iceberg::ManifestFileAdapter_map">
<area href="classiceberg_1_1ManifestAdapter.html" title="Base class for appending manifest metadata to Arrow arrays." alt="iceberg::ManifestAdapter" shape="rect" coords="201,0,392,24"/>
<area href="classiceberg_1_1ManifestFileAdapterV1.html" title="Adapter to convert V1 ManifestFile to ArrowArray." alt="iceberg::ManifestFileAdapterV1" shape="rect" coords="0,112,191,136"/>
<area href="classiceberg_1_1ManifestFileAdapterV2.html" title="Adapter to convert V2 ManifestFile to ArrowArray." alt="iceberg::ManifestFileAdapterV2" shape="rect" coords="201,112,392,136"/>
<area href="classiceberg_1_1ManifestFileAdapterV3.html" title="Adapter to convert V3 ManifestFile to ArrowArray." alt="iceberg::ManifestFileAdapterV3" shape="rect" coords="402,112,593,136"/>
</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:a9c4b124156e807542044d0a32ed1f2db" id="r_a9c4b124156e807542044d0a32ed1f2db"><td class="memItemLeft" align="right" valign="top"><a id="a9c4b124156e807542044d0a32ed1f2db" name="a9c4b124156e807542044d0a32ed1f2db"></a>
virtual Status&#160;</td><td class="memItemRight" valign="bottom"><b>Append</b> (const <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> &amp;file)=0</td></tr>
<tr class="separator:a9c4b124156e807542044d0a32ed1f2db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20d80d90a8fae3e56f08fa9585c8d024" id="r_a20d80d90a8fae3e56f08fa9585c8d024"><td class="memItemLeft" align="right" valign="top"><a id="a20d80d90a8fae3e56f08fa9585c8d024" name="a20d80d90a8fae3e56f08fa9585c8d024"></a>
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:a20d80d90a8fae3e56f08fa9585c8d024"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09f8a631f7a95069b7dc6f8f523a8706" id="r_a09f8a631f7a95069b7dc6f8f523a8706"><td class="memItemLeft" align="right" valign="top"><a id="a09f8a631f7a95069b7dc6f8f523a8706" name="a09f8a631f7a95069b7dc6f8f523a8706"></a>
virtual std::optional&lt; int64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>next_row_id</b> () const</td></tr>
<tr class="separator:a09f8a631f7a95069b7dc6f8f523a8706"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classiceberg_1_1ManifestAdapter"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1ManifestAdapter')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classiceberg_1_1ManifestAdapter.html">iceberg::ManifestAdapter</a></td></tr>
<tr class="memitem:aca828da0c3c8794dedaa37f22eee1ecb inherit pub_methods_classiceberg_1_1ManifestAdapter" id="r_aca828da0c3c8794dedaa37f22eee1ecb"><td class="memItemLeft" align="right" valign="top">
virtual Status&#160;</td><td class="memItemRight" valign="bottom"><b>Init</b> ()=0</td></tr>
<tr class="separator:aca828da0c3c8794dedaa37f22eee1ecb inherit pub_methods_classiceberg_1_1ManifestAdapter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43756b6c0895ee1431dcf04256e71d07 inherit pub_methods_classiceberg_1_1ManifestAdapter" id="r_a43756b6c0895ee1431dcf04256e71d07"><td class="memItemLeft" align="right" valign="top">
Status&#160;</td><td class="memItemRight" valign="bottom"><b>StartAppending</b> ()</td></tr>
<tr class="separator:a43756b6c0895ee1431dcf04256e71d07 inherit pub_methods_classiceberg_1_1ManifestAdapter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8bac53cf5f1a157a2695b88cbd54615 inherit pub_methods_classiceberg_1_1ManifestAdapter" id="r_ab8bac53cf5f1a157a2695b88cbd54615"><td class="memItemLeft" align="right" valign="top">
Result&lt; <a class="el" href="structArrowArray.html">ArrowArray</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>FinishAppending</b> ()</td></tr>
<tr class="separator:ab8bac53cf5f1a157a2695b88cbd54615 inherit pub_methods_classiceberg_1_1ManifestAdapter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6f6ef4ebd251f87cbe1c079d9397a37 inherit pub_methods_classiceberg_1_1ManifestAdapter" id="r_ac6f6ef4ebd251f87cbe1c079d9397a37"><td class="memItemLeft" align="right" valign="top">
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>size</b> () const</td></tr>
<tr class="separator:ac6f6ef4ebd251f87cbe1c079d9397a37 inherit pub_methods_classiceberg_1_1ManifestAdapter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd45f47723b002e9da2bde8c44082792 inherit pub_methods_classiceberg_1_1ManifestAdapter" id="r_abd45f47723b002e9da2bde8c44082792"><td class="memItemLeft" align="right" valign="top">
const std::unordered_map&lt; std::string, std::string &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>metadata</b> () const</td></tr>
<tr class="separator:abd45f47723b002e9da2bde8c44082792 inherit pub_methods_classiceberg_1_1ManifestAdapter"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ab41eb9bffefa6680b724b12cffb9e296" id="r_ab41eb9bffefa6680b724b12cffb9e296"><td class="memItemLeft" align="right" valign="top"><a id="ab41eb9bffefa6680b724b12cffb9e296" name="ab41eb9bffefa6680b724b12cffb9e296"></a>
Status&#160;</td><td class="memItemRight" valign="bottom"><b>AppendInternal</b> (const <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> &amp;file)</td></tr>
<tr class="separator:ab41eb9bffefa6680b724b12cffb9e296"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb76892c3e376ed945fe47e7f3ab264e" id="r_acb76892c3e376ed945fe47e7f3ab264e"><td class="memItemLeft" align="right" valign="top"><a id="acb76892c3e376ed945fe47e7f3ab264e" name="acb76892c3e376ed945fe47e7f3ab264e"></a>
virtual Result&lt; int64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetSequenceNumber</b> (const <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> &amp;file) const</td></tr>
<tr class="separator:acb76892c3e376ed945fe47e7f3ab264e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab654d9c6fa84e2b8279b84decbd142cf" id="r_ab654d9c6fa84e2b8279b84decbd142cf"><td class="memItemLeft" align="right" valign="top"><a id="ab654d9c6fa84e2b8279b84decbd142cf" name="ab654d9c6fa84e2b8279b84decbd142cf"></a>
virtual Result&lt; int64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetMinSequenceNumber</b> (const <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> &amp;file) const</td></tr>
<tr class="separator:ab654d9c6fa84e2b8279b84decbd142cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8e7c54ada96aaa60ada58d96629bac0" id="r_ae8e7c54ada96aaa60ada58d96629bac0"><td class="memItemLeft" align="right" valign="top"><a id="ae8e7c54ada96aaa60ada58d96629bac0" name="ae8e7c54ada96aaa60ada58d96629bac0"></a>
virtual Result&lt; std::optional&lt; int64_t &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetFirstRowId</b> (const <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> &amp;file) const</td></tr>
<tr class="separator:ae8e7c54ada96aaa60ada58d96629bac0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-static-methods" name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:a4b306535642f6391af5754306212a431" id="r_a4b306535642f6391af5754306212a431"><td class="memItemLeft" align="right" valign="top"><a id="a4b306535642f6391af5754306212a431" name="a4b306535642f6391af5754306212a431"></a>
static Status&#160;</td><td class="memItemRight" valign="bottom"><b>AppendPartitionSummary</b> (<a class="el" href="structArrowArray.html">ArrowArray</a> *array, const std::shared_ptr&lt; <a class="el" href="classiceberg_1_1ListType.html">ListType</a> &gt; &amp;summary_type, const std::vector&lt; <a class="el" href="structiceberg_1_1PartitionFieldSummary.html">PartitionFieldSummary</a> &gt; &amp;summaries)</td></tr>
<tr class="separator:a4b306535642f6391af5754306212a431"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a15b5f15e7952183995ef0a6ab65fd533" id="r_a15b5f15e7952183995ef0a6ab65fd533"><td class="memItemLeft" align="right" valign="top"><a id="a15b5f15e7952183995ef0a6ab65fd533" name="a15b5f15e7952183995ef0a6ab65fd533"></a>
std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>manifest_list_schema_</b></td></tr>
<tr class="separator:a15b5f15e7952183995ef0a6ab65fd533"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classiceberg_1_1ManifestAdapter"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classiceberg_1_1ManifestAdapter')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classiceberg_1_1ManifestAdapter.html">iceberg::ManifestAdapter</a></td></tr>
<tr class="memitem:a741c3bd0bfaac122f12ac4426c46e71a inherit pro_attribs_classiceberg_1_1ManifestAdapter" id="r_a741c3bd0bfaac122f12ac4426c46e71a"><td class="memItemLeft" align="right" valign="top">
<a class="el" href="structArrowArray.html">ArrowArray</a>&#160;</td><td class="memItemRight" valign="bottom"><b>array_</b></td></tr>
<tr class="separator:a741c3bd0bfaac122f12ac4426c46e71a inherit pro_attribs_classiceberg_1_1ManifestAdapter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b5b4970fc9c43d5276d45b7d47f6694 inherit pro_attribs_classiceberg_1_1ManifestAdapter" id="r_a8b5b4970fc9c43d5276d45b7d47f6694"><td class="memItemLeft" align="right" valign="top">
<a class="el" href="structArrowSchema.html">ArrowSchema</a>&#160;</td><td class="memItemRight" valign="bottom"><b>schema_</b></td></tr>
<tr class="separator:a8b5b4970fc9c43d5276d45b7d47f6694 inherit pro_attribs_classiceberg_1_1ManifestAdapter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8400d17002062bc728859ea96fde9cc2 inherit pro_attribs_classiceberg_1_1ManifestAdapter" id="r_a8400d17002062bc728859ea96fde9cc2"><td class="memItemLeft" align="right" valign="top">
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>size_</b> = 0</td></tr>
<tr class="separator:a8400d17002062bc728859ea96fde9cc2 inherit pro_attribs_classiceberg_1_1ManifestAdapter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a883a6a875beefd761010bea778e86e inherit pro_attribs_classiceberg_1_1ManifestAdapter" id="r_a0a883a6a875beefd761010bea778e86e"><td class="memItemLeft" align="right" valign="top">
std::unordered_map&lt; std::string, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>metadata_</b></td></tr>
<tr class="separator:a0a883a6a875beefd761010bea778e86e inherit pro_attribs_classiceberg_1_1ManifestAdapter"><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>Adapter for appending a list of <code><a class="el" href="structiceberg_1_1ManifestFile.html" title="Entry in a manifest list.">ManifestFile</a></code>s to an <code><a class="el" href="structArrowArray.html">ArrowArray</a></code>. Implemented by different versions with version-specific schemas. </p>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/manifest/<a class="el" href="manifest__adapter__internal_8h_source.html">manifest_adapter_internal.h</a></li>
<li>iceberg/manifest/<b>manifest_adapter.cc</b></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>