api/classiceberg_1_1FileScanTaskReader.html - iceberg-cpp - Git at Google

 <!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::FileScanTaskReader 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="classiceberg_1_1FileScanTaskReader.html">FileScanTaskReader</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
   <div class="summary">
 <a href="#nested-classes">Classes</a> &#124;
 <a href="#pub-methods">Public Member Functions</a> &#124;
 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
 <a href="classiceberg_1_1FileScanTaskReader-members.html">List of all members</a>  </div>
   <div class="headertitle"><div class="title">iceberg::FileScanTaskReader Class Reference</div></div>
 </div><!--header-->
 <div class="contents">

 <p>Opens a <a class="el" href="classiceberg_1_1FileScanTask.html" title="Task representing a data file and its corresponding delete files.">FileScanTask</a> as an <a class="el" href="structArrowArrayStream.html">ArrowArrayStream</a>.
  <a href="classiceberg_1_1FileScanTaskReader.html#details">More...</a></p>

 <p><code>#include &lt;<a class="el" href="file__scan__task__reader_8h_source.html">file_scan_task_reader.h</a>&gt;</code></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 Classes</h2></td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1FileScanTaskReader_1_1Options.html">Options</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structiceberg_1_1FileScanTaskReader_1_1Options.html" title="Options shared by all tasks opened by this reader.">Options</a> shared by all tasks opened by this reader.  <a href="structiceberg_1_1FileScanTaskReader_1_1Options.html#details">More...</a><br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><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:a5bc4ec48bcb4b53c1f74ad25ac32ffd7" id="r_a5bc4ec48bcb4b53c1f74ad25ac32ffd7"><td class="memItemLeft" align="right" valign="top"><a id="a5bc4ec48bcb4b53c1f74ad25ac32ffd7" name="a5bc4ec48bcb4b53c1f74ad25ac32ffd7"></a>
 <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; <a class="el" href="structArrowArrayStream.html">ArrowArrayStream</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Open</b> (const <a class="el" href="classiceberg_1_1FileScanTask.html">FileScanTask</a> &amp;task)</td></tr>
 <tr class="memdesc:a5bc4ec48bcb4b53c1f74ad25ac32ffd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open a task and return an Arrow C stream for its projected live rows. <br /></td></tr>
 <tr class="separator:a5bc4ec48bcb4b53c1f74ad25ac32ffd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a2900a1c544b33194266b5f75311bfd3d" id="r_a2900a1c544b33194266b5f75311bfd3d"><td class="memItemLeft" align="right" valign="top"><a id="a2900a1c544b33194266b5f75311bfd3d" name="a2900a1c544b33194266b5f75311bfd3d"></a>
 &#160;</td><td class="memItemRight" valign="bottom"><b>FileScanTaskReader</b> (const <a class="el" href="classiceberg_1_1FileScanTaskReader.html">FileScanTaskReader</a> &amp;)=delete</td></tr>
 <tr class="separator:a2900a1c544b33194266b5f75311bfd3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a192f037b901767fbfa11f1e129747965" id="r_a192f037b901767fbfa11f1e129747965"><td class="memItemLeft" align="right" valign="top"><a id="a192f037b901767fbfa11f1e129747965" name="a192f037b901767fbfa11f1e129747965"></a>
 <a class="el" href="classiceberg_1_1FileScanTaskReader.html">FileScanTaskReader</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classiceberg_1_1FileScanTaskReader.html">FileScanTaskReader</a> &amp;)=delete</td></tr>
 <tr class="separator:a192f037b901767fbfa11f1e129747965"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
 Static Public Member Functions</h2></td></tr>
 <tr class="memitem:aa83cd9553f2346bced071066c4eb987e" id="r_aa83cd9553f2346bced071066c4eb987e"><td class="memItemLeft" align="right" valign="top"><a id="aa83cd9553f2346bced071066c4eb987e" name="aa83cd9553f2346bced071066c4eb987e"></a>
 static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1FileScanTaskReader.html">FileScanTaskReader</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Make</b> (<a class="el" href="structiceberg_1_1FileScanTaskReader_1_1Options.html">Options</a> options)</td></tr>
 <tr class="memdesc:aa83cd9553f2346bced071066c4eb987e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a reusable task reader from shared read context. <br /></td></tr>
 <tr class="separator:aa83cd9553f2346bced071066c4eb987e"><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>Opens a <a class="el" href="classiceberg_1_1FileScanTask.html" title="Task representing a data file and its corresponding delete files.">FileScanTask</a> as an <a class="el" href="structArrowArrayStream.html">ArrowArrayStream</a>. </p>
 <p><a class="el" href="classiceberg_1_1FileScanTaskReader.html" title="Opens a FileScanTask as an ArrowArrayStream.">FileScanTaskReader</a> chooses the copy-on-write path for tasks without deletes and the merge-on-read path for tasks with v2 position or equality deletes. The returned stream always exposes <code>projected_schema</code>.</p>
 <p>TODO(gangwu): Add a mode that emits a <code>_deleted</code> column instead of filtering rows. TODO(gangwu): Use evaluator to apply residual expression filters. </p>
 </div><hr/>The documentation for this class was generated from the following file:<ul>
 <li>iceberg/data/<a class="el" href="file__scan__task__reader_8h_source.html">file_scan_task_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>
	<!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::FileScanTaskReader 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"><a class="el" href="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1FileScanTaskReader.html">FileScanTaskReader</a></li> </ul>
	</div>
	</div><!-- top -->
	<div class="header">
	<div class="summary">
	<a href="#nested-classes">Classes</a> \|
	<a href="#pub-methods">Public Member Functions</a> \|
	<a href="#pub-static-methods">Static Public Member Functions</a> \|
	<a href="classiceberg_1_1FileScanTaskReader-members.html">List of all members</a> </div>
	<div class="headertitle"><div class="title">iceberg::FileScanTaskReader Class Reference</div></div>
	</div><!--header-->
	<div class="contents">

	<p>Opens a <a class="el" href="classiceberg_1_1FileScanTask.html" title="Task representing a data file and its corresponding delete files.">FileScanTask</a> as an <a class="el" href="structArrowArrayStream.html">ArrowArrayStream</a>.
	<a href="classiceberg_1_1FileScanTaskReader.html#details">More...</a></p>

	<p><code>#include <<a class="el" href="file__scan__task__reader_8h_source.html">file_scan_task_reader.h</a>></code></p>
	<table class="memberdecls">
	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
	Classes</h2></td></tr>
	<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1FileScanTaskReader_1_1Options.html">Options</a></td></tr>
	<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structiceberg_1_1FileScanTaskReader_1_1Options.html" title="Options shared by all tasks opened by this reader.">Options</a> shared by all tasks opened by this reader. <a href="structiceberg_1_1FileScanTaskReader_1_1Options.html#details">More...</a><br /></td></tr>
	<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
	</table><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:a5bc4ec48bcb4b53c1f74ad25ac32ffd7" id="r_a5bc4ec48bcb4b53c1f74ad25ac32ffd7"><td class="memItemLeft" align="right" valign="top"><a id="a5bc4ec48bcb4b53c1f74ad25ac32ffd7" name="a5bc4ec48bcb4b53c1f74ad25ac32ffd7"></a>
	<a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< <a class="el" href="structArrowArrayStream.html">ArrowArrayStream</a> > </td><td class="memItemRight" valign="bottom"><b>Open</b> (const <a class="el" href="classiceberg_1_1FileScanTask.html">FileScanTask</a> &task)</td></tr>
	<tr class="memdesc:a5bc4ec48bcb4b53c1f74ad25ac32ffd7"><td class="mdescLeft"> </td><td class="mdescRight">Open a task and return an Arrow C stream for its projected live rows. <br /></td></tr>
	<tr class="separator:a5bc4ec48bcb4b53c1f74ad25ac32ffd7"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a2900a1c544b33194266b5f75311bfd3d" id="r_a2900a1c544b33194266b5f75311bfd3d"><td class="memItemLeft" align="right" valign="top"><a id="a2900a1c544b33194266b5f75311bfd3d" name="a2900a1c544b33194266b5f75311bfd3d"></a>
	</td><td class="memItemRight" valign="bottom"><b>FileScanTaskReader</b> (const <a class="el" href="classiceberg_1_1FileScanTaskReader.html">FileScanTaskReader</a> &)=delete</td></tr>
	<tr class="separator:a2900a1c544b33194266b5f75311bfd3d"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a192f037b901767fbfa11f1e129747965" id="r_a192f037b901767fbfa11f1e129747965"><td class="memItemLeft" align="right" valign="top"><a id="a192f037b901767fbfa11f1e129747965" name="a192f037b901767fbfa11f1e129747965"></a>
	<a class="el" href="classiceberg_1_1FileScanTaskReader.html">FileScanTaskReader</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classiceberg_1_1FileScanTaskReader.html">FileScanTaskReader</a> &)=delete</td></tr>
	<tr class="separator:a192f037b901767fbfa11f1e129747965"><td class="memSeparator" colspan="2"> </td></tr>
	</table><table class="memberdecls">
	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
	Static Public Member Functions</h2></td></tr>
	<tr class="memitem:aa83cd9553f2346bced071066c4eb987e" id="r_aa83cd9553f2346bced071066c4eb987e"><td class="memItemLeft" align="right" valign="top"><a id="aa83cd9553f2346bced071066c4eb987e" name="aa83cd9553f2346bced071066c4eb987e"></a>
	static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::unique_ptr< <a class="el" href="classiceberg_1_1FileScanTaskReader.html">FileScanTaskReader</a> > > </td><td class="memItemRight" valign="bottom"><b>Make</b> (<a class="el" href="structiceberg_1_1FileScanTaskReader_1_1Options.html">Options</a> options)</td></tr>
	<tr class="memdesc:aa83cd9553f2346bced071066c4eb987e"><td class="mdescLeft"> </td><td class="mdescRight">Create a reusable task reader from shared read context. <br /></td></tr>
	<tr class="separator:aa83cd9553f2346bced071066c4eb987e"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
	<div class="textblock"><p>Opens a <a class="el" href="classiceberg_1_1FileScanTask.html" title="Task representing a data file and its corresponding delete files.">FileScanTask</a> as an <a class="el" href="structArrowArrayStream.html">ArrowArrayStream</a>. </p>
	<p><a class="el" href="classiceberg_1_1FileScanTaskReader.html" title="Opens a FileScanTask as an ArrowArrayStream.">FileScanTaskReader</a> chooses the copy-on-write path for tasks without deletes and the merge-on-read path for tasks with v2 position or equality deletes. The returned stream always exposes <code>projected_schema</code>.</p>
	<p>TODO(gangwu): Add a mode that emits a <code>_deleted</code> column instead of filtering rows. TODO(gangwu): Use evaluator to apply residual expression filters. </p>
	</div><hr/>The documentation for this class was generated from the following file:<ul>
	<li>iceberg/data/<a class="el" href="file__scan__task__reader_8h_source.html">file_scan_task_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>