| <!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/data/file_scan_task_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><li class="navelem"><a class="el" href="dir_40a892c7cf92893422212651b7511047.html">data</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">file_scan_task_reader.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="file__scan__task__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 <memory></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include <unordered_map></span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include <vector></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="iceberg__data__export_8h.html">iceberg/iceberg_data_export.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> </div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg.html">iceberg</a> {</div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div> |
| <div class="foldopen" id="foldopen00045" data-start="{" data-end="};"> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classiceberg_1_1FileScanTaskReader.html"> 45</a></span><span class="keyword">class </span>ICEBERG_DATA_EXPORT <a class="code hl_class" href="classiceberg_1_1FileScanTaskReader.html">FileScanTaskReader</a> {</div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">public</span>:</div> |
| <div class="foldopen" id="foldopen00048" data-start="{" data-end="};"> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="structiceberg_1_1FileScanTaskReader_1_1Options.html"> 48</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structiceberg_1_1FileScanTaskReader_1_1Options.html">Options</a> {</div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="structiceberg_1_1FileScanTaskReader_1_1Options.html#aac8b57f4669e4dcd0a62f61a3d1ba1f4"> 50</a></span> std::shared_ptr<FileIO> <a class="code hl_variable" href="structiceberg_1_1FileScanTaskReader_1_1Options.html#aac8b57f4669e4dcd0a62f61a3d1ba1f4">io</a>;</div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="structiceberg_1_1FileScanTaskReader_1_1Options.html#a904c85055745341d4dcef628e1e66e7f"> 52</a></span> std::shared_ptr<Schema> <a class="code hl_variable" href="structiceberg_1_1FileScanTaskReader_1_1Options.html#a904c85055745341d4dcef628e1e66e7f">table_schema</a>;</div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="structiceberg_1_1FileScanTaskReader_1_1Options.html#aaa6a107b0b6952aafb4f2a1de701ae5c"> 54</a></span> std::vector<std::shared_ptr<Schema>> <a class="code hl_variable" href="structiceberg_1_1FileScanTaskReader_1_1Options.html#aaa6a107b0b6952aafb4f2a1de701ae5c">schemas</a>;</div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="structiceberg_1_1FileScanTaskReader_1_1Options.html#a07fc7c34e0484ecec603e835d2ad8792"> 57</a></span> std::shared_ptr<Schema> <a class="code hl_variable" href="structiceberg_1_1FileScanTaskReader_1_1Options.html#a07fc7c34e0484ecec603e835d2ad8792">projected_schema</a>;</div> |
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="structiceberg_1_1FileScanTaskReader_1_1Options.html#a764208b60c3d864db5c2448942318582"> 59</a></span> std::shared_ptr<NameMapping> <a class="code hl_variable" href="structiceberg_1_1FileScanTaskReader_1_1Options.html#a764208b60c3d864db5c2448942318582">name_mapping</a>;</div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="structiceberg_1_1FileScanTaskReader_1_1Options.html#abfbb4ef4e9b10a03cc7c45cae02d4e4b"> 61</a></span> std::unordered_map<std::string, std::string> <a class="code hl_variable" href="structiceberg_1_1FileScanTaskReader_1_1Options.html#abfbb4ef4e9b10a03cc7c45cae02d4e4b">properties</a>;</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="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="classiceberg_1_1FileScanTaskReader.html#aa83cd9553f2346bced071066c4eb987e"> 65</a></span> <span class="keyword">static</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<std::unique_ptr<FileScanTaskReader></a>> <a class="code hl_function" href="classiceberg_1_1FileScanTaskReader.html#aa83cd9553f2346bced071066c4eb987e">Make</a>(<a class="code hl_struct" href="structiceberg_1_1FileScanTaskReader_1_1Options.html">Options</a> options);</div> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <a class="code hl_class" href="classiceberg_1_1FileScanTaskReader.html">~FileScanTaskReader</a>();</div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="classiceberg_1_1FileScanTaskReader.html#a5bc4ec48bcb4b53c1f74ad25ac32ffd7"> 70</a></span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<ArrowArrayStream></a> <a class="code hl_function" href="classiceberg_1_1FileScanTaskReader.html#a5bc4ec48bcb4b53c1f74ad25ac32ffd7">Open</a>(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1FileScanTask.html">FileScanTask</a>& task);</div> |
| <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div> |
| <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <a class="code hl_class" href="classiceberg_1_1FileScanTaskReader.html">FileScanTaskReader</a>(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1FileScanTaskReader.html">FileScanTaskReader</a>&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <a class="code hl_class" href="classiceberg_1_1FileScanTaskReader.html">FileScanTaskReader</a>& operator=(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1FileScanTaskReader.html">FileScanTaskReader</a>&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">class </span>Impl;</div> |
| <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classiceberg_1_1FileScanTaskReader.html">FileScanTaskReader</a>(std::unique_ptr<Impl> impl);</div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> std::unique_ptr<Impl> impl_;</div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span>};</div> |
| </div> |
| <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div> |
| <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</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_1FileScanTaskReader_html"><div class="ttname"><a href="classiceberg_1_1FileScanTaskReader.html">iceberg::FileScanTaskReader</a></div><div class="ttdoc">Opens a FileScanTask as an ArrowArrayStream.</div><div class="ttdef"><b>Definition</b> file_scan_task_reader.h:45</div></div> |
| <div class="ttc" id="aclassiceberg_1_1FileScanTaskReader_html_a5bc4ec48bcb4b53c1f74ad25ac32ffd7"><div class="ttname"><a href="classiceberg_1_1FileScanTaskReader.html#a5bc4ec48bcb4b53c1f74ad25ac32ffd7">iceberg::FileScanTaskReader::Open</a></div><div class="ttdeci">Result< ArrowArrayStream > Open(const FileScanTask &task)</div><div class="ttdoc">Open a task and return an Arrow C stream for its projected live rows.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1FileScanTaskReader_html_aa83cd9553f2346bced071066c4eb987e"><div class="ttname"><a href="classiceberg_1_1FileScanTaskReader.html#aa83cd9553f2346bced071066c4eb987e">iceberg::FileScanTaskReader::Make</a></div><div class="ttdeci">static Result< std::unique_ptr< FileScanTaskReader > > Make(Options options)</div><div class="ttdoc">Create a reusable task reader from shared read context.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1FileScanTask_html"><div class="ttname"><a href="classiceberg_1_1FileScanTask.html">iceberg::FileScanTask</a></div><div class="ttdoc">Task representing a data file and its corresponding delete files.</div><div class="ttdef"><b>Definition</b> table_scan.h:66</div></div> |
| <div class="ttc" id="aiceberg__data__export_8h_html"><div class="ttname"><a href="iceberg__data__export_8h.html">iceberg_data_export.h</a></div><div class="ttdoc">Define symbol visibility macros for data APIs.</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="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_1FileScanTaskReader_1_1Options_html"><div class="ttname"><a href="structiceberg_1_1FileScanTaskReader_1_1Options.html">iceberg::FileScanTaskReader::Options</a></div><div class="ttdoc">Options shared by all tasks opened by this reader.</div><div class="ttdef"><b>Definition</b> file_scan_task_reader.h:48</div></div> |
| <div class="ttc" id="astructiceberg_1_1FileScanTaskReader_1_1Options_html_a07fc7c34e0484ecec603e835d2ad8792"><div class="ttname"><a href="structiceberg_1_1FileScanTaskReader_1_1Options.html#a07fc7c34e0484ecec603e835d2ad8792">iceberg::FileScanTaskReader::Options::projected_schema</a></div><div class="ttdeci">std::shared_ptr< Schema > projected_schema</div><div class="ttdef"><b>Definition</b> file_scan_task_reader.h:57</div></div> |
| <div class="ttc" id="astructiceberg_1_1FileScanTaskReader_1_1Options_html_a764208b60c3d864db5c2448942318582"><div class="ttname"><a href="structiceberg_1_1FileScanTaskReader_1_1Options.html#a764208b60c3d864db5c2448942318582">iceberg::FileScanTaskReader::Options::name_mapping</a></div><div class="ttdeci">std::shared_ptr< NameMapping > name_mapping</div><div class="ttdoc">Optional name mapping for files written without field IDs.</div><div class="ttdef"><b>Definition</b> file_scan_task_reader.h:59</div></div> |
| <div class="ttc" id="astructiceberg_1_1FileScanTaskReader_1_1Options_html_a904c85055745341d4dcef628e1e66e7f"><div class="ttname"><a href="structiceberg_1_1FileScanTaskReader_1_1Options.html#a904c85055745341d4dcef628e1e66e7f">iceberg::FileScanTaskReader::Options::table_schema</a></div><div class="ttdeci">std::shared_ptr< Schema > table_schema</div><div class="ttdoc">The table schema. Used as the primary field lookup for delete file resolution.</div><div class="ttdef"><b>Definition</b> file_scan_task_reader.h:52</div></div> |
| <div class="ttc" id="astructiceberg_1_1FileScanTaskReader_1_1Options_html_aaa6a107b0b6952aafb4f2a1de701ae5c"><div class="ttname"><a href="structiceberg_1_1FileScanTaskReader_1_1Options.html#aaa6a107b0b6952aafb4f2a1de701ae5c">iceberg::FileScanTaskReader::Options::schemas</a></div><div class="ttdeci">std::vector< std::shared_ptr< Schema > > schemas</div><div class="ttdoc">Optional list of historical table schemas for field lookup.</div><div class="ttdef"><b>Definition</b> file_scan_task_reader.h:54</div></div> |
| <div class="ttc" id="astructiceberg_1_1FileScanTaskReader_1_1Options_html_aac8b57f4669e4dcd0a62f61a3d1ba1f4"><div class="ttname"><a href="structiceberg_1_1FileScanTaskReader_1_1Options.html#aac8b57f4669e4dcd0a62f61a3d1ba1f4">iceberg::FileScanTaskReader::Options::io</a></div><div class="ttdeci">std::shared_ptr< FileIO > io</div><div class="ttdoc">FileIO instance for reading data and delete files.</div><div class="ttdef"><b>Definition</b> file_scan_task_reader.h:50</div></div> |
| <div class="ttc" id="astructiceberg_1_1FileScanTaskReader_1_1Options_html_abfbb4ef4e9b10a03cc7c45cae02d4e4b"><div class="ttname"><a href="structiceberg_1_1FileScanTaskReader_1_1Options.html#abfbb4ef4e9b10a03cc7c45cae02d4e4b">iceberg::FileScanTaskReader::Options::properties</a></div><div class="ttdeci">std::unordered_map< std::string, std::string > properties</div><div class="ttdoc">Format-specific or implementation-specific options for data readers.</div><div class="ttdef"><b>Definition</b> file_scan_task_reader.h:61</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> |
