| <!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::ReaderOptions 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_1ReaderOptions.html">ReaderOptions</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="structiceberg_1_1ReaderOptions-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::ReaderOptions Struct Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Options for creating a reader. |
| <a href="structiceberg_1_1ReaderOptions.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="file__reader_8h_source.html">file_reader.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:a959dc0c774f0a3d55991f1eb73753b2c" id="r_a959dc0c774f0a3d55991f1eb73753b2c"><td class="memItemLeft" align="right" valign="top"><a id="a959dc0c774f0a3d55991f1eb73753b2c" name="a959dc0c774f0a3d55991f1eb73753b2c"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><b>path</b></td></tr> |
| <tr class="memdesc:a959dc0c774f0a3d55991f1eb73753b2c"><td class="mdescLeft"> </td><td class="mdescRight">The path to the file to read. <br /></td></tr> |
| <tr class="separator:a959dc0c774f0a3d55991f1eb73753b2c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a774ae321e3063b7ae0bbb92c9d552a74" id="r_a774ae321e3063b7ae0bbb92c9d552a74"><td class="memItemLeft" align="right" valign="top"><a id="a774ae321e3063b7ae0bbb92c9d552a74" name="a774ae321e3063b7ae0bbb92c9d552a74"></a> |
| std::optional< size_t > </td><td class="memItemRight" valign="bottom"><b>length</b></td></tr> |
| <tr class="memdesc:a774ae321e3063b7ae0bbb92c9d552a74"><td class="mdescLeft"> </td><td class="mdescRight">The total length of the file. <br /></td></tr> |
| <tr class="separator:a774ae321e3063b7ae0bbb92c9d552a74"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad23066ad0bd76b9bddf201e5b9bbeb0e" id="r_ad23066ad0bd76b9bddf201e5b9bbeb0e"><td class="memItemLeft" align="right" valign="top"><a id="ad23066ad0bd76b9bddf201e5b9bbeb0e" name="ad23066ad0bd76b9bddf201e5b9bbeb0e"></a> |
| std::optional< <a class="el" href="structiceberg_1_1Split.html">Split</a> > </td><td class="memItemRight" valign="bottom"><b>split</b></td></tr> |
| <tr class="memdesc:ad23066ad0bd76b9bddf201e5b9bbeb0e"><td class="mdescLeft"> </td><td class="mdescRight">The split to read. <br /></td></tr> |
| <tr class="separator:ad23066ad0bd76b9bddf201e5b9bbeb0e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a49992ba965f62ff27631e8131ed657ea" id="r_a49992ba965f62ff27631e8131ed657ea"><td class="memItemLeft" align="right" valign="top"><a id="a49992ba965f62ff27631e8131ed657ea" name="a49992ba965f62ff27631e8131ed657ea"></a> |
| std::shared_ptr< class <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> > </td><td class="memItemRight" valign="bottom"><b>io</b></td></tr> |
| <tr class="memdesc:a49992ba965f62ff27631e8131ed657ea"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> instance to open the file. <a class="el" href="classiceberg_1_1Reader.html" title="Base reader class to read data from different file formats.">Reader</a> implementations should down cast it to the specific <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> implementation. By default, the <code>iceberg-bundle</code> library uses <code>ArrowFileSystemFileIO</code> as the default implementation. <br /></td></tr> |
| <tr class="separator:a49992ba965f62ff27631e8131ed657ea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a418c6556965b0db7f12131e4f0070304" id="r_a418c6556965b0db7f12131e4f0070304"><td class="memItemLeft" align="right" valign="top"><a id="a418c6556965b0db7f12131e4f0070304" name="a418c6556965b0db7f12131e4f0070304"></a> |
| std::shared_ptr< class <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > </td><td class="memItemRight" valign="bottom"><b>projection</b></td></tr> |
| <tr class="memdesc:a418c6556965b0db7f12131e4f0070304"><td class="mdescLeft"> </td><td class="mdescRight">The projection schema to read from the file. This field is required. <br /></td></tr> |
| <tr class="separator:a418c6556965b0db7f12131e4f0070304"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af6504634d4bf0a406fb091d9e10dc8fc" id="r_af6504634d4bf0a406fb091d9e10dc8fc"><td class="memItemLeft" align="right" valign="top"><a id="af6504634d4bf0a406fb091d9e10dc8fc" name="af6504634d4bf0a406fb091d9e10dc8fc"></a> |
| std::shared_ptr< class <a class="el" href="classiceberg_1_1Expression.html">Expression</a> > </td><td class="memItemRight" valign="bottom"><b>filter</b></td></tr> |
| <tr class="memdesc:af6504634d4bf0a406fb091d9e10dc8fc"><td class="mdescLeft"> </td><td class="mdescRight">The filter to apply to the data. <a class="el" href="classiceberg_1_1Reader.html" title="Base reader class to read data from different file formats.">Reader</a> implementations may ignore this if the file format does not support filtering. <br /></td></tr> |
| <tr class="separator:af6504634d4bf0a406fb091d9e10dc8fc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab2824fcc77efcfdd2810ff3945f2a519" id="r_ab2824fcc77efcfdd2810ff3945f2a519"><td class="memItemLeft" align="right" valign="top"><a id="ab2824fcc77efcfdd2810ff3945f2a519" name="ab2824fcc77efcfdd2810ff3945f2a519"></a> |
| std::shared_ptr< class <a class="el" href="classiceberg_1_1NameMapping.html">NameMapping</a> > </td><td class="memItemRight" valign="bottom"><b>name_mapping</b></td></tr> |
| <tr class="memdesc:ab2824fcc77efcfdd2810ff3945f2a519"><td class="mdescLeft"> </td><td class="mdescRight">Name mapping for schema evolution compatibility. Used when reading files that may have different field names than the current schema. <br /></td></tr> |
| <tr class="separator:ab2824fcc77efcfdd2810ff3945f2a519"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abfe412d377c1207df04c3a2c4fe23d55" id="r_abfe412d377c1207df04c3a2c4fe23d55"><td class="memItemLeft" align="right" valign="top"><a id="abfe412d377c1207df04c3a2c4fe23d55" name="abfe412d377c1207df04c3a2c4fe23d55"></a> |
| <a class="el" href="classiceberg_1_1ReaderProperties.html">ReaderProperties</a> </td><td class="memItemRight" valign="bottom"><b>properties</b></td></tr> |
| <tr class="memdesc:abfe412d377c1207df04c3a2c4fe23d55"><td class="mdescLeft"> </td><td class="mdescRight">Format-specific or implementation-specific properties. <br /></td></tr> |
| <tr class="separator:abfe412d377c1207df04c3a2c4fe23d55"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Options for creating a reader. </p> |
| </div><hr/>The documentation for this struct 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 <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> |
