| <!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::FileScanTask 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&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="classiceberg_1_1FileScanTask.html">FileScanTask</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classiceberg_1_1FileScanTask-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::FileScanTask Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Task representing a data file and its corresponding delete files. |
| <a href="classiceberg_1_1FileScanTask.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="table__scan_8h_source.html">table_scan.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::FileScanTask:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1FileScanTask.png" usemap="#iceberg::FileScanTask_map" alt=""/> |
| <map id="iceberg::FileScanTask_map" name="iceberg::FileScanTask_map"> |
| <area href="classiceberg_1_1ScanTask.html" title="An abstract scan task." alt="iceberg::ScanTask" shape="rect" coords="0,0,137,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:ac3c2ad71911295e9b98f7f9f70064dd6" id="r_ac3c2ad71911295e9b98f7f9f70064dd6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileScanTask.html#ac3c2ad71911295e9b98f7f9f70064dd6">FileScanTask</a> (std::shared_ptr< <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> > <a class="el" href="classiceberg_1_1FileScanTask.html#aa01703278a2d290967f5bfcb887a0c49">data_file</a>, std::vector< std::shared_ptr< <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> > > <a class="el" href="classiceberg_1_1FileScanTask.html#ac460cab44912a93e186703987d3bd6e7">delete_files</a>={}, std::shared_ptr< <a class="el" href="classiceberg_1_1Expression.html">Expression</a> > filter=nullptr)</td></tr> |
| <tr class="memdesc:ac3c2ad71911295e9b98f7f9f70064dd6"><td class="mdescLeft"> </td><td class="mdescRight">Construct with data file, delete files, and residual filter. <br /></td></tr> |
| <tr class="separator:ac3c2ad71911295e9b98f7f9f70064dd6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa01703278a2d290967f5bfcb887a0c49" id="r_aa01703278a2d290967f5bfcb887a0c49"><td class="memItemLeft" align="right" valign="top"><a id="aa01703278a2d290967f5bfcb887a0c49" name="aa01703278a2d290967f5bfcb887a0c49"></a> |
| const std::shared_ptr< <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> > & </td><td class="memItemRight" valign="bottom"><b>data_file</b> () const</td></tr> |
| <tr class="memdesc:aa01703278a2d290967f5bfcb887a0c49"><td class="mdescLeft"> </td><td class="mdescRight">The data file that should be read by this scan task. <br /></td></tr> |
| <tr class="separator:aa01703278a2d290967f5bfcb887a0c49"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac460cab44912a93e186703987d3bd6e7" id="r_ac460cab44912a93e186703987d3bd6e7"><td class="memItemLeft" align="right" valign="top"><a id="ac460cab44912a93e186703987d3bd6e7" name="ac460cab44912a93e186703987d3bd6e7"></a> |
| const std::vector< std::shared_ptr< <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> > > & </td><td class="memItemRight" valign="bottom"><b>delete_files</b> () const</td></tr> |
| <tr class="memdesc:ac460cab44912a93e186703987d3bd6e7"><td class="mdescLeft"> </td><td class="mdescRight">Delete files that apply to this data file. <br /></td></tr> |
| <tr class="separator:ac460cab44912a93e186703987d3bd6e7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa4a9be432f54a1dcf932cdbb3b1180e5" id="r_aa4a9be432f54a1dcf932cdbb3b1180e5"><td class="memItemLeft" align="right" valign="top"><a id="aa4a9be432f54a1dcf932cdbb3b1180e5" name="aa4a9be432f54a1dcf932cdbb3b1180e5"></a> |
| const std::shared_ptr< <a class="el" href="classiceberg_1_1Expression.html">Expression</a> > & </td><td class="memItemRight" valign="bottom"><b>residual_filter</b> () const</td></tr> |
| <tr class="memdesc:aa4a9be432f54a1dcf932cdbb3b1180e5"><td class="mdescLeft"> </td><td class="mdescRight">Residual filter to apply after reading. <br /></td></tr> |
| <tr class="separator:aa4a9be432f54a1dcf932cdbb3b1180e5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a98a4912bc062e02fcdb26b71b9e79480" id="r_a98a4912bc062e02fcdb26b71b9e79480"><td class="memItemLeft" align="right" valign="top">Kind </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileScanTask.html#a98a4912bc062e02fcdb26b71b9e79480">kind</a> () const override</td></tr> |
| <tr class="memdesc:a98a4912bc062e02fcdb26b71b9e79480"><td class="mdescLeft"> </td><td class="mdescRight">The kind of scan task. <br /></td></tr> |
| <tr class="separator:a98a4912bc062e02fcdb26b71b9e79480"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab9cafa54598c24e7278ecf1ffc58163e" id="r_ab9cafa54598c24e7278ecf1ffc58163e"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileScanTask.html#ab9cafa54598c24e7278ecf1ffc58163e">size_bytes</a> () const override</td></tr> |
| <tr class="memdesc:ab9cafa54598c24e7278ecf1ffc58163e"><td class="mdescLeft"> </td><td class="mdescRight">The number of bytes that should be read by this scan task. <br /></td></tr> |
| <tr class="separator:ab9cafa54598c24e7278ecf1ffc58163e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5222b5f4cc30a36bf058745d9ae9f1d9" id="r_a5222b5f4cc30a36bf058745d9ae9f1d9"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileScanTask.html#a5222b5f4cc30a36bf058745d9ae9f1d9">files_count</a> () const override</td></tr> |
| <tr class="memdesc:a5222b5f4cc30a36bf058745d9ae9f1d9"><td class="mdescLeft"> </td><td class="mdescRight">The number of files that should be read by this scan task. <br /></td></tr> |
| <tr class="separator:a5222b5f4cc30a36bf058745d9ae9f1d9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a40c1b4c68a2b3fe147afcbad05a5b624" id="r_a40c1b4c68a2b3fe147afcbad05a5b624"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileScanTask.html#a40c1b4c68a2b3fe147afcbad05a5b624">estimated_row_count</a> () const override</td></tr> |
| <tr class="memdesc:a40c1b4c68a2b3fe147afcbad05a5b624"><td class="mdescLeft"> </td><td class="mdescRight">The number of rows that should be read by this scan task. <br /></td></tr> |
| <tr class="separator:a40c1b4c68a2b3fe147afcbad05a5b624"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac10db5da7600207ec2cc6ca11025b152" id="r_ac10db5da7600207ec2cc6ca11025b152"><td class="memItemLeft" align="right" valign="top">Result< <a class="el" href="structArrowArrayStream.html">ArrowArrayStream</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileScanTask.html#ac10db5da7600207ec2cc6ca11025b152">ToArrow</a> (const std::shared_ptr< <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> > &io, std::shared_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > projected_schema) const</td></tr> |
| <tr class="memdesc:ac10db5da7600207ec2cc6ca11025b152"><td class="mdescLeft"> </td><td class="mdescRight">Returns a C-ABI compatible <a class="el" href="structArrowArrayStream.html">ArrowArrayStream</a> to read the data for this task. <br /></td></tr> |
| <tr class="separator:ac10db5da7600207ec2cc6ca11025b152"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a> |
| Additional Inherited Members</h2></td></tr> |
| <tr class="inherit_header pub_types_classiceberg_1_1ScanTask"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classiceberg_1_1ScanTask')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classiceberg_1_1ScanTask.html">iceberg::ScanTask</a></td></tr> |
| <tr class="memitem:ab28bdbcb5d183627dfec1ef4d3321c1f inherit pub_types_classiceberg_1_1ScanTask" id="r_ab28bdbcb5d183627dfec1ef4d3321c1f"><td class="memItemLeft" align="right" valign="top"><a id="ab28bdbcb5d183627dfec1ef4d3321c1f" name="ab28bdbcb5d183627dfec1ef4d3321c1f"></a>enum class  </td><td class="memItemRight" valign="bottom"><b>Kind</b> : uint8_t { <b>kFileScanTask</b> |
| , <b>kChangelogScanTask</b> |
| }</td></tr> |
| <tr class="separator:ab28bdbcb5d183627dfec1ef4d3321c1f inherit pub_types_classiceberg_1_1ScanTask"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Task representing a data file and its corresponding delete files. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="ac3c2ad71911295e9b98f7f9f70064dd6" name="ac3c2ad71911295e9b98f7f9f70064dd6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac3c2ad71911295e9b98f7f9f70064dd6">◆ </a></span>FileScanTask()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">iceberg::FileScanTask::FileScanTask </td> |
| <td>(</td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> > </td> |
| <td class="paramname"><em>data_file</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< std::shared_ptr< <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> > > </td> |
| <td class="paramname"><em>delete_files</em> = <code>{}</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classiceberg_1_1Expression.html">Expression</a> > </td> |
| <td class="paramname"><em>filter</em> = <code>nullptr</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Construct with data file, delete files, and residual filter. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">data_file</td><td>The data file to read. </td></tr> |
| <tr><td class="paramname">delete_files</td><td>Delete files that apply to this data file. </td></tr> |
| <tr><td class="paramname">filter</td><td>Optional residual filter to apply after reading. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a40c1b4c68a2b3fe147afcbad05a5b624" name="a40c1b4c68a2b3fe147afcbad05a5b624"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a40c1b4c68a2b3fe147afcbad05a5b624">◆ </a></span>estimated_row_count()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int64_t iceberg::FileScanTask::estimated_row_count </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The number of rows that should be read by this scan task. </p> |
| |
| <p>Implements <a class="el" href="classiceberg_1_1ScanTask.html#a1065f2e9db3b7d9d42f861bfca839232">iceberg::ScanTask</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a5222b5f4cc30a36bf058745d9ae9f1d9" name="a5222b5f4cc30a36bf058745d9ae9f1d9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5222b5f4cc30a36bf058745d9ae9f1d9">◆ </a></span>files_count()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int32_t iceberg::FileScanTask::files_count </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The number of files that should be read by this scan task. </p> |
| |
| <p>Implements <a class="el" href="classiceberg_1_1ScanTask.html#a014e83fb779a07601b71dd503871986b">iceberg::ScanTask</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a98a4912bc062e02fcdb26b71b9e79480" name="a98a4912bc062e02fcdb26b71b9e79480"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a98a4912bc062e02fcdb26b71b9e79480">◆ </a></span>kind()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Kind iceberg::FileScanTask::kind </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The kind of scan task. </p> |
| |
| <p>Implements <a class="el" href="classiceberg_1_1ScanTask.html#a3e223ab9964f78b6e99791567c82e1b6">iceberg::ScanTask</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ab9cafa54598c24e7278ecf1ffc58163e" name="ab9cafa54598c24e7278ecf1ffc58163e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab9cafa54598c24e7278ecf1ffc58163e">◆ </a></span>size_bytes()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int64_t iceberg::FileScanTask::size_bytes </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The number of bytes that should be read by this scan task. </p> |
| |
| <p>Implements <a class="el" href="classiceberg_1_1ScanTask.html#a196044bb4a1fc867fb9dbece6ae3f47c">iceberg::ScanTask</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ac10db5da7600207ec2cc6ca11025b152" name="ac10db5da7600207ec2cc6ca11025b152"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac10db5da7600207ec2cc6ca11025b152">◆ </a></span>ToArrow()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< <a class="el" href="structArrowArrayStream.html">ArrowArrayStream</a> > iceberg::FileScanTask::ToArrow </td> |
| <td>(</td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> > & </td> |
| <td class="paramname"><em>io</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > </td> |
| <td class="paramname"><em>projected_schema</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a C-ABI compatible <a class="el" href="structArrowArrayStream.html">ArrowArrayStream</a> to read the data for this task. </p> |
| <p>TODO(gangwu): move it to iceberg/data/task_scanner.h</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">io</td><td>The <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> instance for accessing the file data. </td></tr> |
| <tr><td class="paramname">projected_schema</td><td>The projected schema for reading the data. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A Result containing an <a class="el" href="structArrowArrayStream.html">ArrowArrayStream</a>, or an error on failure. </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>iceberg/<a class="el" href="table__scan_8h_source.html">table_scan.h</a></li> |
| <li>iceberg/<b>table_scan.cc</b></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> |
