blob: 9545278435868bfd5ff8f8e79801ac0855dd223f [file] [log] [blame]
<!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::internal::TableScanContext 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"><b>iceberg</b></li><li class="navelem"><b>internal</b></li><li class="navelem"><a class="el" href="structiceberg_1_1internal_1_1TableScanContext.html">TableScanContext</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structiceberg_1_1internal_1_1TableScanContext-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::internal::TableScanContext Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<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:a7f446d04361278494edf186c1fcb11ae" id="r_a7f446d04361278494edf186c1fcb11ae"><td class="memItemLeft" align="right" valign="top"><a id="a7f446d04361278494edf186c1fcb11ae" name="a7f446d04361278494edf186c1fcb11ae"></a>
Status&#160;</td><td class="memItemRight" valign="bottom"><b>Validate</b> () const</td></tr>
<tr class="separator:a7f446d04361278494edf186c1fcb11ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a289117fca201ead433081d98880ba0eb" id="r_a289117fca201ead433081d98880ba0eb"><td class="memItemLeft" align="right" valign="top"><a id="a289117fca201ead433081d98880ba0eb" name="a289117fca201ead433081d98880ba0eb"></a>
std::optional&lt; int64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>snapshot_id</b></td></tr>
<tr class="separator:a289117fca201ead433081d98880ba0eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a7023a567f1048ca4017c802df72e95" id="r_a8a7023a567f1048ca4017c802df72e95"><td class="memItemLeft" align="right" valign="top"><a id="a8a7023a567f1048ca4017c802df72e95" name="a8a7023a567f1048ca4017c802df72e95"></a>
std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Expression.html">Expression</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>filter</b></td></tr>
<tr class="separator:a8a7023a567f1048ca4017c802df72e95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d7641dbdaac1fd162481c901fc4e1f9" id="r_a6d7641dbdaac1fd162481c901fc4e1f9"><td class="memItemLeft" align="right" valign="top"><a id="a6d7641dbdaac1fd162481c901fc4e1f9" name="a6d7641dbdaac1fd162481c901fc4e1f9"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>ignore_residuals</b> {false}</td></tr>
<tr class="separator:a6d7641dbdaac1fd162481c901fc4e1f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab268004641259baa6c3b5999dc13649b" id="r_ab268004641259baa6c3b5999dc13649b"><td class="memItemLeft" align="right" valign="top"><a id="ab268004641259baa6c3b5999dc13649b" name="ab268004641259baa6c3b5999dc13649b"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>case_sensitive</b> {true}</td></tr>
<tr class="separator:ab268004641259baa6c3b5999dc13649b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaba43d23ee4e9df0dd9c985ad60464da" id="r_aaba43d23ee4e9df0dd9c985ad60464da"><td class="memItemLeft" align="right" valign="top"><a id="aaba43d23ee4e9df0dd9c985ad60464da" name="aaba43d23ee4e9df0dd9c985ad60464da"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>return_column_stats</b> {false}</td></tr>
<tr class="separator:aaba43d23ee4e9df0dd9c985ad60464da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a432184da4e9e7f380653e3946b056352" id="r_a432184da4e9e7f380653e3946b056352"><td class="memItemLeft" align="right" valign="top"><a id="a432184da4e9e7f380653e3946b056352" name="a432184da4e9e7f380653e3946b056352"></a>
std::unordered_set&lt; int32_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>columns_to_keep_stats</b></td></tr>
<tr class="separator:a432184da4e9e7f380653e3946b056352"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10ecddc9378990070b7fa9abd12eafa7" id="r_a10ecddc9378990070b7fa9abd12eafa7"><td class="memItemLeft" align="right" valign="top"><a id="a10ecddc9378990070b7fa9abd12eafa7" name="a10ecddc9378990070b7fa9abd12eafa7"></a>
std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>selected_columns</b></td></tr>
<tr class="separator:a10ecddc9378990070b7fa9abd12eafa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a001d3651ce3f486c6fd26a0bc9b85316" id="r_a001d3651ce3f486c6fd26a0bc9b85316"><td class="memItemLeft" align="right" valign="top"><a id="a001d3651ce3f486c6fd26a0bc9b85316" name="a001d3651ce3f486c6fd26a0bc9b85316"></a>
std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>projected_schema</b></td></tr>
<tr class="separator:a001d3651ce3f486c6fd26a0bc9b85316"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a973ddb2b3677ae489410d4d1d40535" id="r_a6a973ddb2b3677ae489410d4d1d40535"><td class="memItemLeft" align="right" valign="top"><a id="a6a973ddb2b3677ae489410d4d1d40535" name="a6a973ddb2b3677ae489410d4d1d40535"></a>
std::unordered_map&lt; std::string, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>options</b></td></tr>
<tr class="separator:a6a973ddb2b3677ae489410d4d1d40535"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2bae94a4fa8f1a96bb2d798b1c9822c" id="r_ae2bae94a4fa8f1a96bb2d798b1c9822c"><td class="memItemLeft" align="right" valign="top"><a id="ae2bae94a4fa8f1a96bb2d798b1c9822c" name="ae2bae94a4fa8f1a96bb2d798b1c9822c"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>from_snapshot_id_inclusive</b> {false}</td></tr>
<tr class="separator:ae2bae94a4fa8f1a96bb2d798b1c9822c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a539d047b9ca0226f1df11d3bc685cb4a" id="r_a539d047b9ca0226f1df11d3bc685cb4a"><td class="memItemLeft" align="right" valign="top"><a id="a539d047b9ca0226f1df11d3bc685cb4a" name="a539d047b9ca0226f1df11d3bc685cb4a"></a>
std::optional&lt; int64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>from_snapshot_id</b></td></tr>
<tr class="separator:a539d047b9ca0226f1df11d3bc685cb4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc238f823562c566a525f5c121329d65" id="r_acc238f823562c566a525f5c121329d65"><td class="memItemLeft" align="right" valign="top"><a id="acc238f823562c566a525f5c121329d65" name="acc238f823562c566a525f5c121329d65"></a>
std::optional&lt; int64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>to_snapshot_id</b></td></tr>
<tr class="separator:acc238f823562c566a525f5c121329d65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae83b81268c5dfae6e95153ea6c22bf1d" id="r_ae83b81268c5dfae6e95153ea6c22bf1d"><td class="memItemLeft" align="right" valign="top"><a id="ae83b81268c5dfae6e95153ea6c22bf1d" name="ae83b81268c5dfae6e95153ea6c22bf1d"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>branch</b> {}</td></tr>
<tr class="separator:ae83b81268c5dfae6e95153ea6c22bf1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a0a6fa53b5eee17102e08337bc9471c" id="r_a9a0a6fa53b5eee17102e08337bc9471c"><td class="memItemLeft" align="right" valign="top"><a id="a9a0a6fa53b5eee17102e08337bc9471c" name="a9a0a6fa53b5eee17102e08337bc9471c"></a>
std::optional&lt; int64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>min_rows_requested</b></td></tr>
<tr class="separator:a9a0a6fa53b5eee17102e08337bc9471c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this struct 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&#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>