Google GitGoogle Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/site/api/classiceberg_1_1avro_1_1AvroReader.html
blob: 836031014f04ce887f31ce82b6a0457eefc3f2d6 [file]
<!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::avro::AvroReader 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"><a class="el" href="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="namespaceiceberg_1_1avro.html">avro</a></li><li class="navelem"><a class="el" href="classiceberg_1_1avro_1_1AvroReader.html">AvroReader</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_1avro_1_1AvroReader-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::avro::AvroReader Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A reader that reads <a class="el" href="structArrowArray.html">ArrowArray</a> from Avro files.
<a href="classiceberg_1_1avro_1_1AvroReader.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="avro__reader_8h_source.html">avro_reader.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::avro::AvroReader:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1avro_1_1AvroReader.png" usemap="#iceberg::avro::AvroReader_map" alt=""/>
<map id="iceberg::avro::AvroReader_map" name="iceberg::avro::AvroReader_map">
<area href="classiceberg_1_1Reader.html" title="Base reader class to read data from different file formats." alt="iceberg::Reader" shape="rect" coords="0,0,162,24"/>
</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:a0a7dfbbd7f261a82f651c75f8060fb24" id="r_a0a7dfbbd7f261a82f651c75f8060fb24"><td class="memItemLeft" align="right" valign="top">Status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1avro_1_1AvroReader.html#a0a7dfbbd7f261a82f651c75f8060fb24">Open</a> (const <a class="el" href="structiceberg_1_1ReaderOptions.html">ReaderOptions</a> &amp;options) final</td></tr>
<tr class="memdesc:a0a7dfbbd7f261a82f651c75f8060fb24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open the reader. <br /></td></tr>
<tr class="separator:a0a7dfbbd7f261a82f651c75f8060fb24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d0f89b1e854ac1ea0468d4ad6799bec" id="r_a1d0f89b1e854ac1ea0468d4ad6799bec"><td class="memItemLeft" align="right" valign="top">Status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1avro_1_1AvroReader.html#a1d0f89b1e854ac1ea0468d4ad6799bec">Close</a> () final</td></tr>
<tr class="memdesc:a1d0f89b1e854ac1ea0468d4ad6799bec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the reader. <br /></td></tr>
<tr class="separator:a1d0f89b1e854ac1ea0468d4ad6799bec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02002ba0b0f9255b011e1d6d9122399e" id="r_a02002ba0b0f9255b011e1d6d9122399e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&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_1avro_1_1AvroReader.html#a02002ba0b0f9255b011e1d6d9122399e">Next</a> () final</td></tr>
<tr class="memdesc:a02002ba0b0f9255b011e1d6d9122399e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read next data from file. <br /></td></tr>
<tr class="separator:a02002ba0b0f9255b011e1d6d9122399e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a839419ad546f8c9e59bacb9b1f91e138" id="r_a839419ad546f8c9e59bacb9b1f91e138"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; <a class="el" href="structArrowSchema.html">ArrowSchema</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1avro_1_1AvroReader.html#a839419ad546f8c9e59bacb9b1f91e138">Schema</a> () final</td></tr>
<tr class="memdesc:a839419ad546f8c9e59bacb9b1f91e138"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the schema of the data. <br /></td></tr>
<tr class="separator:a839419ad546f8c9e59bacb9b1f91e138"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4842dfce45d6b093a49ae5f328dd688d" id="r_a4842dfce45d6b093a49ae5f328dd688d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::unordered_map&lt; std::string, std::string &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1avro_1_1AvroReader.html#a4842dfce45d6b093a49ae5f328dd688d">Metadata</a> () final</td></tr>
<tr class="memdesc:a4842dfce45d6b093a49ae5f328dd688d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the metadata of the file. <br /></td></tr>
<tr class="separator:a4842dfce45d6b093a49ae5f328dd688d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classiceberg_1_1Reader"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1Reader')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classiceberg_1_1Reader.html">iceberg::Reader</a></td></tr>
<tr class="memitem:aaa6eea6c5e3265e32123f5e7eb7b21fe inherit pub_methods_classiceberg_1_1Reader" id="r_aaa6eea6c5e3265e32123f5e7eb7b21fe"><td class="memItemLeft" align="right" valign="top">
&#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 inherit pub_methods_classiceberg_1_1Reader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a977c6f67bd254521229a5d8f56ba7042 inherit pub_methods_classiceberg_1_1Reader" id="r_a977c6f67bd254521229a5d8f56ba7042"><td class="memItemLeft" align="right" valign="top">
<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 inherit pub_methods_classiceberg_1_1Reader"><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>A reader that reads <a class="el" href="structArrowArray.html">ArrowArray</a> from Avro files. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a1d0f89b1e854ac1ea0468d4ad6799bec" name="a1d0f89b1e854ac1ea0468d4ad6799bec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d0f89b1e854ac1ea0468d4ad6799bec">&#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">Status iceberg::avro::AvroReader::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">final</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the reader. </p>
<p>Implements <a class="el" href="classiceberg_1_1Reader.html#ae85c73b2e7864feb1fe9b7395bf2bda6">iceberg::Reader</a>.</p>
</div>
</div>
<a id="a4842dfce45d6b093a49ae5f328dd688d" name="a4842dfce45d6b093a49ae5f328dd688d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4842dfce45d6b093a49ae5f328dd688d">&#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"><a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::unordered_map&lt; std::string, std::string &gt; &gt; iceberg::avro::AvroReader::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">final</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the metadata of the file. </p>
<p>Implements <a class="el" href="classiceberg_1_1Reader.html#ad732e05d7be7c6ce460e56b54ddf4736">iceberg::Reader</a>.</p>
</div>
</div>
<a id="a02002ba0b0f9255b011e1d6d9122399e" name="a02002ba0b0f9255b011e1d6d9122399e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02002ba0b0f9255b011e1d6d9122399e">&#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"><a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::optional&lt; <a class="el" href="structArrowArray.html">ArrowArray</a> &gt; &gt; iceberg::avro::AvroReader::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">final</span><span class="mlabel">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>Implements <a class="el" href="classiceberg_1_1Reader.html#a28632e4930a68070106075a570f381b8">iceberg::Reader</a>.</p>
</div>
</div>
<a id="a0a7dfbbd7f261a82f651c75f8060fb24" name="a0a7dfbbd7f261a82f651c75f8060fb24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a7dfbbd7f261a82f651c75f8060fb24">&#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">Status iceberg::avro::AvroReader::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">final</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Open the reader. </p>
<p>Implements <a class="el" href="classiceberg_1_1Reader.html#ad79601bfcecf30aae808c6ffd972cc65">iceberg::Reader</a>.</p>
</div>
</div>
<a id="a839419ad546f8c9e59bacb9b1f91e138" name="a839419ad546f8c9e59bacb9b1f91e138"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a839419ad546f8c9e59bacb9b1f91e138">&#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"><a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; <a class="el" href="structArrowSchema.html">ArrowSchema</a> &gt; iceberg::avro::AvroReader::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">final</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the schema of the data. </p>
<p>Implements <a class="el" href="classiceberg_1_1Reader.html#a782ec85ef9bd7bcbe901b35520305dc7">iceberg::Reader</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/avro/<a class="el" href="avro__reader_8h_source.html">avro_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>