| <!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/file_reader.h Source File</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> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- 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="dir_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">file_reader.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="file__reader_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <cstdint></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <functional></span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include <optional></span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include "<a class="code" href="arrow__c__data_8h.html">iceberg/arrow_c_data.h</a>"</span></div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include "<a class="code" href="file__format_8h.html">iceberg/file_format.h</a>"</span></div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include "<a class="code" href="result_8h.html">iceberg/result.h</a>"</span></div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include "<a class="code" href="type__fwd_8h.html">iceberg/type_fwd.h</a>"</span></div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#include "<a class="code" href="config_8h.html">iceberg/util/config.h</a>"</span></div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg.html">iceberg</a> {</div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div> |
| <div class="foldopen" id="foldopen00039" data-start="{" data-end="};"> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classiceberg_1_1Reader.html"> 39</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1Reader.html">Reader</a> {</div> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classiceberg_1_1Reader.html">~Reader</a>() = <span class="keywordflow">default</span>;</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_class" href="classiceberg_1_1Reader.html">Reader</a>() = <span class="keywordflow">default</span>;</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <a class="code hl_class" href="classiceberg_1_1Reader.html">Reader</a>(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Reader.html">Reader</a>&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_class" href="classiceberg_1_1Reader.html">Reader</a>& operator=(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Reader.html">Reader</a>&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="classiceberg_1_1Reader.html#ad79601bfcecf30aae808c6ffd972cc65"> 47</a></span> <span class="keyword">virtual</span> Status <a class="code hl_function" href="classiceberg_1_1Reader.html#ad79601bfcecf30aae808c6ffd972cc65">Open</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1ReaderOptions.html">ReaderOptions</a>& options) = 0;</div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classiceberg_1_1Reader.html#ae85c73b2e7864feb1fe9b7395bf2bda6"> 50</a></span> <span class="keyword">virtual</span> Status <a class="code hl_function" href="classiceberg_1_1Reader.html#ae85c73b2e7864feb1fe9b7395bf2bda6">Close</a>() = 0;</div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="classiceberg_1_1Reader.html#a28632e4930a68070106075a570f381b8"> 55</a></span> <span class="keyword">virtual</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<std::optional<ArrowArray></a>> <a class="code hl_function" href="classiceberg_1_1Reader.html#a28632e4930a68070106075a570f381b8">Next</a>() = 0;</div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="classiceberg_1_1Reader.html#a782ec85ef9bd7bcbe901b35520305dc7"> 58</a></span> <span class="keyword">virtual</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<ArrowSchema></a> <a class="code hl_function" href="classiceberg_1_1Reader.html#a782ec85ef9bd7bcbe901b35520305dc7">Schema</a>() = 0;</div> |
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="classiceberg_1_1Reader.html#ad732e05d7be7c6ce460e56b54ddf4736"> 61</a></span> <span class="keyword">virtual</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<std::unordered_map<std::string, std::string></a>> <a class="code hl_function" href="classiceberg_1_1Reader.html#ad732e05d7be7c6ce460e56b54ddf4736">Metadata</a>() = 0;</div> |
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span>};</div> |
| </div> |
| <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div> |
| <div class="foldopen" id="foldopen00065" data-start="{" data-end="};"> |
| <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="structiceberg_1_1Split.html"> 65</a></span><span class="keyword">struct </span>ICEBERG_EXPORT <a class="code hl_struct" href="structiceberg_1_1Split.html">Split</a> {</div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="structiceberg_1_1Split.html#a481b7cbaf8b03f529d6bcbfec9700632"> 67</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structiceberg_1_1Split.html#a481b7cbaf8b03f529d6bcbfec9700632">offset</a>;</div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="structiceberg_1_1Split.html#aed304e2e09b04f9fb52cc08edbb3f0bb"> 69</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structiceberg_1_1Split.html#aed304e2e09b04f9fb52cc08edbb3f0bb">length</a>;</div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span>};</div> |
| </div> |
| <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div> |
| <div class="foldopen" id="foldopen00072" data-start="{" data-end="};"> |
| <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="classiceberg_1_1ReaderProperties.html"> 72</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1ReaderProperties.html">ReaderProperties</a> : <span class="keyword">public</span> <a class="code hl_class" href="classiceberg_1_1ConfigBase.html">ConfigBase</a><ReaderProperties> {</div> |
| <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">using </span>Entry = <span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1ConfigBase_1_1Entry.html">ConfigBase<ReaderProperties>::Entry</a><T>;</div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classiceberg_1_1ReaderProperties.html#ac41dca455600b179913525bb79b2cd60"> 78</a></span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<int64_t> kBatchSize{<span class="stringliteral">"read.batch-size"</span>, 4096};</div> |
| <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="classiceberg_1_1ReaderProperties.html#acd2d67afddc7078a168e6fc54a07d4eb"> 82</a></span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<bool> kAvroSkipDatum{<span class="stringliteral">"read.avro.skip-datum"</span>, <span class="keyword">true</span>};</div> |
| <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="classiceberg_1_1ReaderProperties.html#a6bc67dd5a6ab5a6abf2e6b1b7d461dc3"> 84</a></span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<int64_t> kAvroBufferSize{<span class="stringliteral">"read.avro.buffer-size"</span>, 1024 * 1024};</div> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div> |
| <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="classiceberg_1_1ReaderProperties.html#a8389e72100ca01b318070833534511c0"> 87</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classiceberg_1_1ReaderProperties.html">ReaderProperties</a> <a class="code hl_function" href="classiceberg_1_1ReaderProperties.html#a8389e72100ca01b318070833534511c0">FromMap</a>(</div> |
| <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">const</span> std::unordered_map<std::string, std::string>& properties);</div> |
| <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span>};</div> |
| </div> |
| <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div> |
| <div class="foldopen" id="foldopen00092" data-start="{" data-end="};"> |
| <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="structiceberg_1_1ReaderOptions.html"> 92</a></span><span class="keyword">struct </span>ICEBERG_EXPORT <a class="code hl_struct" href="structiceberg_1_1ReaderOptions.html">ReaderOptions</a> {</div> |
| <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="structiceberg_1_1ReaderOptions.html#a959dc0c774f0a3d55991f1eb73753b2c"> 94</a></span> std::string <a class="code hl_variable" href="structiceberg_1_1ReaderOptions.html#a959dc0c774f0a3d55991f1eb73753b2c">path</a>;</div> |
| <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="structiceberg_1_1ReaderOptions.html#a774ae321e3063b7ae0bbb92c9d552a74"> 96</a></span> std::optional<size_t> <a class="code hl_variable" href="structiceberg_1_1ReaderOptions.html#a774ae321e3063b7ae0bbb92c9d552a74">length</a>;</div> |
| <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="structiceberg_1_1ReaderOptions.html#ad23066ad0bd76b9bddf201e5b9bbeb0e"> 98</a></span> std::optional<Split> <a class="code hl_variable" href="structiceberg_1_1ReaderOptions.html#ad23066ad0bd76b9bddf201e5b9bbeb0e">split</a>;</div> |
| <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"><a class="line" href="structiceberg_1_1ReaderOptions.html#a49992ba965f62ff27631e8131ed657ea"> 100</a></span> std::shared_ptr<class FileIO> <a class="code hl_variable" href="structiceberg_1_1ReaderOptions.html#a49992ba965f62ff27631e8131ed657ea">io</a>;</div> |
| <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="structiceberg_1_1ReaderOptions.html#a418c6556965b0db7f12131e4f0070304"> 102</a></span> std::shared_ptr<class Schema> <a class="code hl_variable" href="structiceberg_1_1ReaderOptions.html#a418c6556965b0db7f12131e4f0070304">projection</a>;</div> |
| <div class="line"><a id="l00105" name="l00105"></a><span class="lineno"><a class="line" href="structiceberg_1_1ReaderOptions.html#af6504634d4bf0a406fb091d9e10dc8fc"> 105</a></span> std::shared_ptr<class Expression> <a class="code hl_variable" href="structiceberg_1_1ReaderOptions.html#af6504634d4bf0a406fb091d9e10dc8fc">filter</a>;</div> |
| <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="structiceberg_1_1ReaderOptions.html#ab2824fcc77efcfdd2810ff3945f2a519"> 108</a></span> std::shared_ptr<class NameMapping> <a class="code hl_variable" href="structiceberg_1_1ReaderOptions.html#ab2824fcc77efcfdd2810ff3945f2a519">name_mapping</a>;</div> |
| <div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="structiceberg_1_1ReaderOptions.html#abd8f65fec71b99ed50d0c23c90ed85f0"> 110</a></span> std::optional<int64_t> <a class="code hl_variable" href="structiceberg_1_1ReaderOptions.html#abd8f65fec71b99ed50d0c23c90ed85f0">first_row_id</a>;</div> |
| <div class="line"><a id="l00112" name="l00112"></a><span class="lineno"><a class="line" href="structiceberg_1_1ReaderOptions.html#a35be5c08c9e20dd8f8f146c90f6c1675"> 112</a></span> std::optional<int64_t> <a class="code hl_variable" href="structiceberg_1_1ReaderOptions.html#a35be5c08c9e20dd8f8f146c90f6c1675">data_sequence_number</a>;</div> |
| <div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="structiceberg_1_1ReaderOptions.html#abfe412d377c1207df04c3a2c4fe23d55"> 114</a></span> <a class="code hl_class" href="classiceberg_1_1ReaderProperties.html">ReaderProperties</a> <a class="code hl_variable" href="structiceberg_1_1ReaderOptions.html#abfe412d377c1207df04c3a2c4fe23d55">properties</a>;</div> |
| <div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span>};</div> |
| </div> |
| <div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> </div> |
| <div class="line"><a id="l00118" name="l00118"></a><span class="lineno"><a class="line" href="namespaceiceberg.html#aadcea35e8b45a436a61aaf23684b939f"> 118</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceiceberg.html#aadcea35e8b45a436a61aaf23684b939f">ReaderFactory</a> = std::function<Result<std::unique_ptr<Reader>>()>;</div> |
| <div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> </div> |
| <div class="foldopen" id="foldopen00121" data-start="{" data-end="};"> |
| <div class="line"><a id="l00121" name="l00121"></a><span class="lineno"><a class="line" href="structiceberg_1_1ReaderFactoryRegistry.html"> 121</a></span><span class="keyword">struct </span>ICEBERG_EXPORT <a class="code hl_struct" href="structiceberg_1_1ReaderFactoryRegistry.html">ReaderFactoryRegistry</a> {</div> |
| <div class="line"><a id="l00123" name="l00123"></a><span class="lineno"><a class="line" href="structiceberg_1_1ReaderFactoryRegistry.html#ace424a125cc78a10d05f23a69238720a"> 123</a></span> <a class="code hl_function" href="structiceberg_1_1ReaderFactoryRegistry.html#ace424a125cc78a10d05f23a69238720a">ReaderFactoryRegistry</a>(FileFormatType format_type, <a class="code hl_typedef" href="namespaceiceberg.html#aadcea35e8b45a436a61aaf23684b939f">ReaderFactory</a> factory);</div> |
| <div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </div> |
| <div class="line"><a id="l00126" name="l00126"></a><span class="lineno"><a class="line" href="structiceberg_1_1ReaderFactoryRegistry.html#a668d3e40a0e7eb3d38021173e58357be"> 126</a></span> <span class="keyword">static</span> <a class="code hl_typedef" href="namespaceiceberg.html#aadcea35e8b45a436a61aaf23684b939f">ReaderFactory</a>& <a class="code hl_function" href="structiceberg_1_1ReaderFactoryRegistry.html#a668d3e40a0e7eb3d38021173e58357be">GetFactory</a>(FileFormatType format_type);</div> |
| <div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div> |
| <div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="structiceberg_1_1ReaderFactoryRegistry.html#a80e41477b5d762a73b1bb14f9e8c18e4"> 129</a></span> <span class="keyword">static</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<std::unique_ptr<Reader></a>> <a class="code hl_function" href="structiceberg_1_1ReaderFactoryRegistry.html#a80e41477b5d762a73b1bb14f9e8c18e4">Open</a>(FileFormatType format_type,</div> |
| <div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> <span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1ReaderOptions.html">ReaderOptions</a>& options);</div> |
| <div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span>};</div> |
| </div> |
| <div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div> |
| <div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span>} <span class="comment">// namespace iceberg</span></div> |
| <div class="ttc" id="aarrow__c__data_8h_html"><div class="ttname"><a href="arrow__c__data_8h.html">arrow_c_data.h</a></div></div> |
| <div class="ttc" id="aclassiceberg_1_1ConfigBase_1_1Entry_html"><div class="ttname"><a href="classiceberg_1_1ConfigBase_1_1Entry.html">iceberg::ConfigBase::Entry</a></div><div class="ttdef"><b>Definition</b> config.h:73</div></div> |
| <div class="ttc" id="aclassiceberg_1_1ConfigBase_html"><div class="ttname"><a href="classiceberg_1_1ConfigBase.html">iceberg::ConfigBase</a></div><div class="ttdef"><b>Definition</b> config.h:70</div></div> |
| <div class="ttc" id="aclassiceberg_1_1ReaderProperties_html"><div class="ttname"><a href="classiceberg_1_1ReaderProperties.html">iceberg::ReaderProperties</a></div><div class="ttdef"><b>Definition</b> file_reader.h:72</div></div> |
| <div class="ttc" id="aclassiceberg_1_1ReaderProperties_html_a8389e72100ca01b318070833534511c0"><div class="ttname"><a href="classiceberg_1_1ReaderProperties.html#a8389e72100ca01b318070833534511c0">iceberg::ReaderProperties::FromMap</a></div><div class="ttdeci">static ReaderProperties FromMap(const std::unordered_map< std::string, std::string > &properties)</div><div class="ttdoc">Create a ReaderProperties instance from a map of key-value pairs.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Reader_html"><div class="ttname"><a href="classiceberg_1_1Reader.html">iceberg::Reader</a></div><div class="ttdoc">Base reader class to read data from different file formats.</div><div class="ttdef"><b>Definition</b> file_reader.h:39</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Reader_html_a28632e4930a68070106075a570f381b8"><div class="ttname"><a href="classiceberg_1_1Reader.html#a28632e4930a68070106075a570f381b8">iceberg::Reader::Next</a></div><div class="ttdeci">virtual Result< std::optional< ArrowArray > > Next()=0</div><div class="ttdoc">Read next data from file.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Reader_html_a782ec85ef9bd7bcbe901b35520305dc7"><div class="ttname"><a href="classiceberg_1_1Reader.html#a782ec85ef9bd7bcbe901b35520305dc7">iceberg::Reader::Schema</a></div><div class="ttdeci">virtual Result< ArrowSchema > Schema()=0</div><div class="ttdoc">Get the schema of the data.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Reader_html_ad732e05d7be7c6ce460e56b54ddf4736"><div class="ttname"><a href="classiceberg_1_1Reader.html#ad732e05d7be7c6ce460e56b54ddf4736">iceberg::Reader::Metadata</a></div><div class="ttdeci">virtual Result< std::unordered_map< std::string, std::string > > Metadata()=0</div><div class="ttdoc">Get the metadata of the file.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Reader_html_ad79601bfcecf30aae808c6ffd972cc65"><div class="ttname"><a href="classiceberg_1_1Reader.html#ad79601bfcecf30aae808c6ffd972cc65">iceberg::Reader::Open</a></div><div class="ttdeci">virtual Status Open(const ReaderOptions &options)=0</div><div class="ttdoc">Open the reader.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Reader_html_ae85c73b2e7864feb1fe9b7395bf2bda6"><div class="ttname"><a href="classiceberg_1_1Reader.html#ae85c73b2e7864feb1fe9b7395bf2bda6">iceberg::Reader::Close</a></div><div class="ttdeci">virtual Status Close()=0</div><div class="ttdoc">Close the reader.</div></div> |
| <div class="ttc" id="aconfig_8h_html"><div class="ttname"><a href="config_8h.html">config.h</a></div><div class="ttdoc">Provide typed configuration helpers.</div></div> |
| <div class="ttc" id="afile__format_8h_html"><div class="ttname"><a href="file__format_8h.html">file_format.h</a></div></div> |
| <div class="ttc" id="anamespaceiceberg_html"><div class="ttname"><a href="namespaceiceberg.html">iceberg</a></div><div class="ttdoc">Core Apache Iceberg C++ APIs.</div><div class="ttdef"><b>Definition</b> arrow_io_util.h:33</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_a9d5594e371beb516b0120e07e69d3af6"><div class="ttname"><a href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">iceberg::Result</a></div><div class="ttdeci">std::expected< T, E > Result</div><div class="ttdoc">Result alias.</div><div class="ttdef"><b>Definition</b> result.h:88</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_aadcea35e8b45a436a61aaf23684b939f"><div class="ttname"><a href="namespaceiceberg.html#aadcea35e8b45a436a61aaf23684b939f">iceberg::ReaderFactory</a></div><div class="ttdeci">std::function< Result< std::unique_ptr< Reader > >()> ReaderFactory</div><div class="ttdoc">Factory function to create a reader of a specific file format.</div><div class="ttdef"><b>Definition</b> file_reader.h:118</div></div> |
| <div class="ttc" id="aresult_8h_html"><div class="ttname"><a href="result_8h.html">result.h</a></div><div class="ttdoc">Define Result, Status, and error helpers.</div></div> |
| <div class="ttc" id="astructiceberg_1_1ReaderFactoryRegistry_html"><div class="ttname"><a href="structiceberg_1_1ReaderFactoryRegistry.html">iceberg::ReaderFactoryRegistry</a></div><div class="ttdoc">Registry of reader factories for different file formats.</div><div class="ttdef"><b>Definition</b> file_reader.h:121</div></div> |
| <div class="ttc" id="astructiceberg_1_1ReaderFactoryRegistry_html_a668d3e40a0e7eb3d38021173e58357be"><div class="ttname"><a href="structiceberg_1_1ReaderFactoryRegistry.html#a668d3e40a0e7eb3d38021173e58357be">iceberg::ReaderFactoryRegistry::GetFactory</a></div><div class="ttdeci">static ReaderFactory & GetFactory(FileFormatType format_type)</div><div class="ttdoc">Get the factory function for a specific file format.</div></div> |
| <div class="ttc" id="astructiceberg_1_1ReaderFactoryRegistry_html_a80e41477b5d762a73b1bb14f9e8c18e4"><div class="ttname"><a href="structiceberg_1_1ReaderFactoryRegistry.html#a80e41477b5d762a73b1bb14f9e8c18e4">iceberg::ReaderFactoryRegistry::Open</a></div><div class="ttdeci">static Result< std::unique_ptr< Reader > > Open(FileFormatType format_type, const ReaderOptions &options)</div><div class="ttdoc">Open a reader for a specific file format.</div></div> |
| <div class="ttc" id="astructiceberg_1_1ReaderFactoryRegistry_html_ace424a125cc78a10d05f23a69238720a"><div class="ttname"><a href="structiceberg_1_1ReaderFactoryRegistry.html#ace424a125cc78a10d05f23a69238720a">iceberg::ReaderFactoryRegistry::ReaderFactoryRegistry</a></div><div class="ttdeci">ReaderFactoryRegistry(FileFormatType format_type, ReaderFactory factory)</div><div class="ttdoc">Register a factory function for a specific file format.</div></div> |
| <div class="ttc" id="astructiceberg_1_1ReaderOptions_html"><div class="ttname"><a href="structiceberg_1_1ReaderOptions.html">iceberg::ReaderOptions</a></div><div class="ttdoc">Options for creating a reader.</div><div class="ttdef"><b>Definition</b> file_reader.h:92</div></div> |
| <div class="ttc" id="astructiceberg_1_1ReaderOptions_html_a35be5c08c9e20dd8f8f146c90f6c1675"><div class="ttname"><a href="structiceberg_1_1ReaderOptions.html#a35be5c08c9e20dd8f8f146c90f6c1675">iceberg::ReaderOptions::data_sequence_number</a></div><div class="ttdeci">std::optional< int64_t > data_sequence_number</div><div class="ttdoc">Data sequence number inherited by the manifest entry, if assigned.</div><div class="ttdef"><b>Definition</b> file_reader.h:112</div></div> |
| <div class="ttc" id="astructiceberg_1_1ReaderOptions_html_a418c6556965b0db7f12131e4f0070304"><div class="ttname"><a href="structiceberg_1_1ReaderOptions.html#a418c6556965b0db7f12131e4f0070304">iceberg::ReaderOptions::projection</a></div><div class="ttdeci">std::shared_ptr< class Schema > projection</div><div class="ttdoc">The projection schema to read from the file. This field is required.</div><div class="ttdef"><b>Definition</b> file_reader.h:102</div></div> |
| <div class="ttc" id="astructiceberg_1_1ReaderOptions_html_a49992ba965f62ff27631e8131ed657ea"><div class="ttname"><a href="structiceberg_1_1ReaderOptions.html#a49992ba965f62ff27631e8131ed657ea">iceberg::ReaderOptions::io</a></div><div class="ttdeci">std::shared_ptr< class FileIO > io</div><div class="ttdoc">FileIO instance to open the file.</div><div class="ttdef"><b>Definition</b> file_reader.h:100</div></div> |
| <div class="ttc" id="astructiceberg_1_1ReaderOptions_html_a774ae321e3063b7ae0bbb92c9d552a74"><div class="ttname"><a href="structiceberg_1_1ReaderOptions.html#a774ae321e3063b7ae0bbb92c9d552a74">iceberg::ReaderOptions::length</a></div><div class="ttdeci">std::optional< size_t > length</div><div class="ttdoc">The total length of the file.</div><div class="ttdef"><b>Definition</b> file_reader.h:96</div></div> |
| <div class="ttc" id="astructiceberg_1_1ReaderOptions_html_a959dc0c774f0a3d55991f1eb73753b2c"><div class="ttname"><a href="structiceberg_1_1ReaderOptions.html#a959dc0c774f0a3d55991f1eb73753b2c">iceberg::ReaderOptions::path</a></div><div class="ttdeci">std::string path</div><div class="ttdoc">The path to the file to read.</div><div class="ttdef"><b>Definition</b> file_reader.h:94</div></div> |
| <div class="ttc" id="astructiceberg_1_1ReaderOptions_html_ab2824fcc77efcfdd2810ff3945f2a519"><div class="ttname"><a href="structiceberg_1_1ReaderOptions.html#ab2824fcc77efcfdd2810ff3945f2a519">iceberg::ReaderOptions::name_mapping</a></div><div class="ttdeci">std::shared_ptr< class NameMapping > name_mapping</div><div class="ttdoc">Name mapping for schema evolution compatibility. Used when reading files that may have different fiel...</div><div class="ttdef"><b>Definition</b> file_reader.h:108</div></div> |
| <div class="ttc" id="astructiceberg_1_1ReaderOptions_html_abd8f65fec71b99ed50d0c23c90ed85f0"><div class="ttname"><a href="structiceberg_1_1ReaderOptions.html#abd8f65fec71b99ed50d0c23c90ed85f0">iceberg::ReaderOptions::first_row_id</a></div><div class="ttdeci">std::optional< int64_t > first_row_id</div><div class="ttdoc">First row ID inherited by the data file, if assigned.</div><div class="ttdef"><b>Definition</b> file_reader.h:110</div></div> |
| <div class="ttc" id="astructiceberg_1_1ReaderOptions_html_abfe412d377c1207df04c3a2c4fe23d55"><div class="ttname"><a href="structiceberg_1_1ReaderOptions.html#abfe412d377c1207df04c3a2c4fe23d55">iceberg::ReaderOptions::properties</a></div><div class="ttdeci">ReaderProperties properties</div><div class="ttdoc">Format-specific or implementation-specific properties.</div><div class="ttdef"><b>Definition</b> file_reader.h:114</div></div> |
| <div class="ttc" id="astructiceberg_1_1ReaderOptions_html_ad23066ad0bd76b9bddf201e5b9bbeb0e"><div class="ttname"><a href="structiceberg_1_1ReaderOptions.html#ad23066ad0bd76b9bddf201e5b9bbeb0e">iceberg::ReaderOptions::split</a></div><div class="ttdeci">std::optional< Split > split</div><div class="ttdoc">The split to read.</div><div class="ttdef"><b>Definition</b> file_reader.h:98</div></div> |
| <div class="ttc" id="astructiceberg_1_1ReaderOptions_html_af6504634d4bf0a406fb091d9e10dc8fc"><div class="ttname"><a href="structiceberg_1_1ReaderOptions.html#af6504634d4bf0a406fb091d9e10dc8fc">iceberg::ReaderOptions::filter</a></div><div class="ttdeci">std::shared_ptr< class Expression > filter</div><div class="ttdoc">The filter to apply to the data. Reader implementations may ignore this if the file format does not s...</div><div class="ttdef"><b>Definition</b> file_reader.h:105</div></div> |
| <div class="ttc" id="astructiceberg_1_1Split_html"><div class="ttname"><a href="structiceberg_1_1Split.html">iceberg::Split</a></div><div class="ttdoc">A split of the file to read.</div><div class="ttdef"><b>Definition</b> file_reader.h:65</div></div> |
| <div class="ttc" id="astructiceberg_1_1Split_html_a481b7cbaf8b03f529d6bcbfec9700632"><div class="ttname"><a href="structiceberg_1_1Split.html#a481b7cbaf8b03f529d6bcbfec9700632">iceberg::Split::offset</a></div><div class="ttdeci">size_t offset</div><div class="ttdoc">The offset of the split.</div><div class="ttdef"><b>Definition</b> file_reader.h:67</div></div> |
| <div class="ttc" id="astructiceberg_1_1Split_html_aed304e2e09b04f9fb52cc08edbb3f0bb"><div class="ttname"><a href="structiceberg_1_1Split.html#aed304e2e09b04f9fb52cc08edbb3f0bb">iceberg::Split::length</a></div><div class="ttdeci">size_t length</div><div class="ttdoc">The length of the split.</div><div class="ttdef"><b>Definition</b> file_reader.h:69</div></div> |
| <div class="ttc" id="atype__fwd_8h_html"><div class="ttname"><a href="type__fwd_8h.html">type_fwd.h</a></div></div> |
| </div><!-- fragment --></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> |
