blob: 6cd3c4844304561bcb68d5d3221684cbf85745dd [file]
<!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::Options Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">iceberg-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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><li class="navelem"><a class="el" href="structiceberg_1_1FileScanTaskReader_1_1Options.html">Options</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structiceberg_1_1FileScanTaskReader_1_1Options-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::FileScanTaskReader::Options Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><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></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="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aac8b57f4669e4dcd0a62f61a3d1ba1f4" id="r_aac8b57f4669e4dcd0a62f61a3d1ba1f4"><td class="memItemLeft" align="right" valign="top"><a id="aac8b57f4669e4dcd0a62f61a3d1ba1f4" name="aac8b57f4669e4dcd0a62f61a3d1ba1f4"></a>
std::shared_ptr&lt; <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>io</b></td></tr>
<tr class="memdesc:aac8b57f4669e4dcd0a62f61a3d1ba1f4"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> instance for reading data and delete files. <br /></td></tr>
<tr class="separator:aac8b57f4669e4dcd0a62f61a3d1ba1f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a904c85055745341d4dcef628e1e66e7f" id="r_a904c85055745341d4dcef628e1e66e7f"><td class="memItemLeft" align="right" valign="top"><a id="a904c85055745341d4dcef628e1e66e7f" name="a904c85055745341d4dcef628e1e66e7f"></a>
std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>table_schema</b></td></tr>
<tr class="memdesc:a904c85055745341d4dcef628e1e66e7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The table schema. Used as the primary field lookup for delete file resolution. <br /></td></tr>
<tr class="separator:a904c85055745341d4dcef628e1e66e7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa6a107b0b6952aafb4f2a1de701ae5c" id="r_aaa6a107b0b6952aafb4f2a1de701ae5c"><td class="memItemLeft" align="right" valign="top"><a id="aaa6a107b0b6952aafb4f2a1de701ae5c" name="aaa6a107b0b6952aafb4f2a1de701ae5c"></a>
std::vector&lt; std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>schemas</b></td></tr>
<tr class="memdesc:aaa6a107b0b6952aafb4f2a1de701ae5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional list of historical table schemas for field lookup. <br /></td></tr>
<tr class="separator:aaa6a107b0b6952aafb4f2a1de701ae5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07fc7c34e0484ecec603e835d2ad8792" id="r_a07fc7c34e0484ecec603e835d2ad8792"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1FileScanTaskReader_1_1Options.html#a07fc7c34e0484ecec603e835d2ad8792">projected_schema</a></td></tr>
<tr class="separator:a07fc7c34e0484ecec603e835d2ad8792"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a764208b60c3d864db5c2448942318582" id="r_a764208b60c3d864db5c2448942318582"><td class="memItemLeft" align="right" valign="top"><a id="a764208b60c3d864db5c2448942318582" name="a764208b60c3d864db5c2448942318582"></a>
std::shared_ptr&lt; <a class="el" href="classiceberg_1_1NameMapping.html">NameMapping</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>name_mapping</b></td></tr>
<tr class="memdesc:a764208b60c3d864db5c2448942318582"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional name mapping for files written without field IDs. <br /></td></tr>
<tr class="separator:a764208b60c3d864db5c2448942318582"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfbb4ef4e9b10a03cc7c45cae02d4e4b" id="r_abfbb4ef4e9b10a03cc7c45cae02d4e4b"><td class="memItemLeft" align="right" valign="top"><a id="abfbb4ef4e9b10a03cc7c45cae02d4e4b" name="abfbb4ef4e9b10a03cc7c45cae02d4e4b"></a>
std::unordered_map&lt; std::string, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>properties</b></td></tr>
<tr class="memdesc:abfbb4ef4e9b10a03cc7c45cae02d4e4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Format-specific or implementation-specific options for data readers. <br /></td></tr>
<tr class="separator:abfbb4ef4e9b10a03cc7c45cae02d4e4b"><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><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. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a07fc7c34e0484ecec603e835d2ad8792" name="a07fc7c34e0484ecec603e835d2ad8792"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07fc7c34e0484ecec603e835d2ad8792">&#9670;&#160;</a></span>projected_schema</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt;<a class="el" href="classiceberg_1_1Schema.html">Schema</a>&gt; iceberg::FileScanTaskReader::Options::projected_schema</td>
</tr>
</table>
</div><div class="memdoc">
<p>The output schema for the returned <a class="el" href="structArrowArrayStream.html">ArrowArrayStream</a>. Must be a projection of table_schema. </p>
</div>
</div>
<hr/>The documentation for this struct 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>