Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1Reader.html
blob: d28141f398bf6b72e8cbd67e0211ba6dff86ed48 [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::Reader 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_1Reader.html">Reader</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classiceberg_1_1Reader-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::Reader Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Base reader class to read data from different file formats.
<a href="classiceberg_1_1Reader.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="file__reader_8h_source.html">file_reader.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::Reader:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1Reader.png" usemap="#iceberg::Reader_map" alt=""/>
<map id="iceberg::Reader_map" name="iceberg::Reader_map">
<area href="classiceberg_1_1avro_1_1AvroReader.html" title="A reader that reads ArrowArray from Avro files." alt="iceberg::avro::AvroReader" shape="rect" coords="0,56,193,80"/>
<area href="classiceberg_1_1parquet_1_1ParquetReader.html" title="A reader that reads ArrowArray from Parquet files." alt="iceberg::parquet::ParquetReader" shape="rect" coords="203,56,396,80"/>
</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:aaa6eea6c5e3265e32123f5e7eb7b21fe" id="r_aaa6eea6c5e3265e32123f5e7eb7b21fe"><td class="memItemLeft" align="right" valign="top"><a id="aaa6eea6c5e3265e32123f5e7eb7b21fe" name="aaa6eea6c5e3265e32123f5e7eb7b21fe"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Reader</b> (const <a class="el" href="classiceberg_1_1Reader.html">Reader</a> &amp;)=delete</td></tr>
<tr class="separator:aaa6eea6c5e3265e32123f5e7eb7b21fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a977c6f67bd254521229a5d8f56ba7042" id="r_a977c6f67bd254521229a5d8f56ba7042"><td class="memItemLeft" align="right" valign="top"><a id="a977c6f67bd254521229a5d8f56ba7042" name="a977c6f67bd254521229a5d8f56ba7042"></a>
<a class="el" href="classiceberg_1_1Reader.html">Reader</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classiceberg_1_1Reader.html">Reader</a> &amp;)=delete</td></tr>
<tr class="separator:a977c6f67bd254521229a5d8f56ba7042"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad79601bfcecf30aae808c6ffd972cc65" id="r_ad79601bfcecf30aae808c6ffd972cc65"><td class="memItemLeft" align="right" valign="top">virtual Status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Reader.html#ad79601bfcecf30aae808c6ffd972cc65">Open</a> (const <a class="el" href="structiceberg_1_1ReaderOptions.html">ReaderOptions</a> &amp;options)=0</td></tr>
<tr class="memdesc:ad79601bfcecf30aae808c6ffd972cc65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open the reader. <br /></td></tr>
<tr class="separator:ad79601bfcecf30aae808c6ffd972cc65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae85c73b2e7864feb1fe9b7395bf2bda6" id="r_ae85c73b2e7864feb1fe9b7395bf2bda6"><td class="memItemLeft" align="right" valign="top">virtual Status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Reader.html#ae85c73b2e7864feb1fe9b7395bf2bda6">Close</a> ()=0</td></tr>
<tr class="memdesc:ae85c73b2e7864feb1fe9b7395bf2bda6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the reader. <br /></td></tr>
<tr class="separator:ae85c73b2e7864feb1fe9b7395bf2bda6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28632e4930a68070106075a570f381b8" id="r_a28632e4930a68070106075a570f381b8"><td class="memItemLeft" align="right" valign="top">virtual Result&lt; std::optional&lt; <a class="el" href="structArrowArray.html">ArrowArray</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Reader.html#a28632e4930a68070106075a570f381b8">Next</a> ()=0</td></tr>
<tr class="memdesc:a28632e4930a68070106075a570f381b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read next data from file. <br /></td></tr>
<tr class="separator:a28632e4930a68070106075a570f381b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a782ec85ef9bd7bcbe901b35520305dc7" id="r_a782ec85ef9bd7bcbe901b35520305dc7"><td class="memItemLeft" align="right" valign="top">virtual Result&lt; <a class="el" href="structArrowSchema.html">ArrowSchema</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Reader.html#a782ec85ef9bd7bcbe901b35520305dc7">Schema</a> ()=0</td></tr>
<tr class="memdesc:a782ec85ef9bd7bcbe901b35520305dc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the schema of the data. <br /></td></tr>
<tr class="separator:a782ec85ef9bd7bcbe901b35520305dc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad732e05d7be7c6ce460e56b54ddf4736" id="r_ad732e05d7be7c6ce460e56b54ddf4736"><td class="memItemLeft" align="right" valign="top">virtual Result&lt; std::unordered_map&lt; std::string, std::string &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Reader.html#ad732e05d7be7c6ce460e56b54ddf4736">Metadata</a> ()=0</td></tr>
<tr class="memdesc:ad732e05d7be7c6ce460e56b54ddf4736"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the metadata of the file. <br /></td></tr>
<tr class="separator:ad732e05d7be7c6ce460e56b54ddf4736"><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>Base reader class to read data from different file formats. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae85c73b2e7864feb1fe9b7395bf2bda6" name="ae85c73b2e7864feb1fe9b7395bf2bda6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae85c73b2e7864feb1fe9b7395bf2bda6">&#9670;&#160;</a></span>Close()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Status iceberg::Reader::Close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the reader. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1avro_1_1AvroReader.html#a1d0f89b1e854ac1ea0468d4ad6799bec">iceberg::avro::AvroReader</a>, and <a class="el" href="classiceberg_1_1parquet_1_1ParquetReader.html#a4aecbbf7865ac94054fe5c9f559c6aea">iceberg::parquet::ParquetReader</a>.</p>
</div>
</div>
<a id="ad732e05d7be7c6ce460e56b54ddf4736" name="ad732e05d7be7c6ce460e56b54ddf4736"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad732e05d7be7c6ce460e56b54ddf4736">&#9670;&#160;</a></span>Metadata()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Result&lt; std::unordered_map&lt; std::string, std::string &gt; &gt; iceberg::Reader::Metadata </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the metadata of the file. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1avro_1_1AvroReader.html#a4842dfce45d6b093a49ae5f328dd688d">iceberg::avro::AvroReader</a>, and <a class="el" href="classiceberg_1_1parquet_1_1ParquetReader.html#ab372da8bb16449db4ff59a319981947a">iceberg::parquet::ParquetReader</a>.</p>
</div>
</div>
<a id="a28632e4930a68070106075a570f381b8" name="a28632e4930a68070106075a570f381b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28632e4930a68070106075a570f381b8">&#9670;&#160;</a></span>Next()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Result&lt; std::optional&lt; <a class="el" href="structArrowArray.html">ArrowArray</a> &gt; &gt; iceberg::Reader::Next </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read next data from file. </p>
<dl class="section return"><dt>Returns</dt><dd>std::nullopt if the reader has no more data, otherwise <code><a class="el" href="structArrowArray.html">ArrowArray</a></code>. </dd></dl>
<p>Implemented in <a class="el" href="classiceberg_1_1avro_1_1AvroReader.html#a02002ba0b0f9255b011e1d6d9122399e">iceberg::avro::AvroReader</a>, and <a class="el" href="classiceberg_1_1parquet_1_1ParquetReader.html#a34c1a71ce9d5eaf14c1854ca85575bac">iceberg::parquet::ParquetReader</a>.</p>
</div>
</div>
<a id="ad79601bfcecf30aae808c6ffd972cc65" name="ad79601bfcecf30aae808c6ffd972cc65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad79601bfcecf30aae808c6ffd972cc65">&#9670;&#160;</a></span>Open()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Status iceberg::Reader::Open </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structiceberg_1_1ReaderOptions.html">ReaderOptions</a> &amp;&#160;</td>
<td class="paramname"><em>options</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Open the reader. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1avro_1_1AvroReader.html#a0a7dfbbd7f261a82f651c75f8060fb24">iceberg::avro::AvroReader</a>, and <a class="el" href="classiceberg_1_1parquet_1_1ParquetReader.html#ab75a19e9370963e6790f4f523e5ced32">iceberg::parquet::ParquetReader</a>.</p>
</div>
</div>
<a id="a782ec85ef9bd7bcbe901b35520305dc7" name="a782ec85ef9bd7bcbe901b35520305dc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a782ec85ef9bd7bcbe901b35520305dc7">&#9670;&#160;</a></span>Schema()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Result&lt; <a class="el" href="structArrowSchema.html">ArrowSchema</a> &gt; iceberg::Reader::Schema </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the schema of the data. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1avro_1_1AvroReader.html#a839419ad546f8c9e59bacb9b1f91e138">iceberg::avro::AvroReader</a>, and <a class="el" href="classiceberg_1_1parquet_1_1ParquetReader.html#a24fd6d5fcf479c6f6b51db925ad1b25e">iceberg::parquet::ParquetReader</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/<a class="el" href="file__reader_8h_source.html">file_reader.h</a></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>