blob: db2aeb6fb64c0c14aca2d2c8223a3f40b55eb015 [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::rest::PlanTableScanRequest 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="namespaceiceberg_1_1rest.html">rest</a></li><li class="navelem"><a class="el" href="structiceberg_1_1rest_1_1PlanTableScanRequest.html">PlanTableScanRequest</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_1rest_1_1PlanTableScanRequest-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::rest::PlanTableScanRequest Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Request to initiate a server-side scan planning operation.
<a href="structiceberg_1_1rest_1_1PlanTableScanRequest.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="types_8h_source.html">types.h</a>&gt;</code></p>
<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:a18e5bcfbfa166618143c42ae923b3b81" id="r_a18e5bcfbfa166618143c42ae923b3b81"><td class="memItemLeft" align="right" valign="top"><a id="a18e5bcfbfa166618143c42ae923b3b81" name="a18e5bcfbfa166618143c42ae923b3b81"></a>
Status&#160;</td><td class="memItemRight" valign="bottom"><b>Validate</b> () const</td></tr>
<tr class="separator:a18e5bcfbfa166618143c42ae923b3b81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e71899517b45e6249b614f772168599" id="r_a0e71899517b45e6249b614f772168599"><td class="memItemLeft" align="right" valign="top"><a id="a0e71899517b45e6249b614f772168599" name="a0e71899517b45e6249b614f772168599"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="structiceberg_1_1rest_1_1PlanTableScanRequest.html">PlanTableScanRequest</a> &amp;) const</td></tr>
<tr class="separator:a0e71899517b45e6249b614f772168599"><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:a9bc191351498ba9e65f601ff718f18b7" id="r_a9bc191351498ba9e65f601ff718f18b7"><td class="memItemLeft" align="right" valign="top"><a id="a9bc191351498ba9e65f601ff718f18b7" name="a9bc191351498ba9e65f601ff718f18b7"></a>
std::optional&lt; int64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>snapshot_id</b></td></tr>
<tr class="separator:a9bc191351498ba9e65f601ff718f18b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a441ecbe4966020e9529988773694ce4e" id="r_a441ecbe4966020e9529988773694ce4e"><td class="memItemLeft" align="right" valign="top"><a id="a441ecbe4966020e9529988773694ce4e" name="a441ecbe4966020e9529988773694ce4e"></a>
std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>select</b></td></tr>
<tr class="separator:a441ecbe4966020e9529988773694ce4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39e747bb8cc8df8709976c4f04071445" id="r_a39e747bb8cc8df8709976c4f04071445"><td class="memItemLeft" align="right" valign="top"><a id="a39e747bb8cc8df8709976c4f04071445" name="a39e747bb8cc8df8709976c4f04071445"></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:a39e747bb8cc8df8709976c4f04071445"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc3083a052cb5e3fdea44c7d9b995db5" id="r_acc3083a052cb5e3fdea44c7d9b995db5"><td class="memItemLeft" align="right" valign="top"><a id="acc3083a052cb5e3fdea44c7d9b995db5" name="acc3083a052cb5e3fdea44c7d9b995db5"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>case_sensitive</b> = true</td></tr>
<tr class="separator:acc3083a052cb5e3fdea44c7d9b995db5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a795167f95577cb65c52fcc70a9b3be" id="r_a4a795167f95577cb65c52fcc70a9b3be"><td class="memItemLeft" align="right" valign="top"><a id="a4a795167f95577cb65c52fcc70a9b3be" name="a4a795167f95577cb65c52fcc70a9b3be"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>use_snapshot_schema</b> = false</td></tr>
<tr class="separator:a4a795167f95577cb65c52fcc70a9b3be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5683ddbb2ab9373a44457fe403cc1b5" id="r_ac5683ddbb2ab9373a44457fe403cc1b5"><td class="memItemLeft" align="right" valign="top"><a id="ac5683ddbb2ab9373a44457fe403cc1b5" name="ac5683ddbb2ab9373a44457fe403cc1b5"></a>
std::optional&lt; int64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>start_snapshot_id</b></td></tr>
<tr class="separator:ac5683ddbb2ab9373a44457fe403cc1b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51753a5ceeec4dd48c4950a1f482e84f" id="r_a51753a5ceeec4dd48c4950a1f482e84f"><td class="memItemLeft" align="right" valign="top"><a id="a51753a5ceeec4dd48c4950a1f482e84f" name="a51753a5ceeec4dd48c4950a1f482e84f"></a>
std::optional&lt; int64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>end_snapshot_id</b></td></tr>
<tr class="separator:a51753a5ceeec4dd48c4950a1f482e84f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a33c8262348d4f078cc68b95f5c8810" id="r_a3a33c8262348d4f078cc68b95f5c8810"><td class="memItemLeft" align="right" valign="top"><a id="a3a33c8262348d4f078cc68b95f5c8810" name="a3a33c8262348d4f078cc68b95f5c8810"></a>
std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>stats_fields</b></td></tr>
<tr class="separator:a3a33c8262348d4f078cc68b95f5c8810"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69008efd45eac83619604a13f6cc6029" id="r_a69008efd45eac83619604a13f6cc6029"><td class="memItemLeft" align="right" valign="top"><a id="a69008efd45eac83619604a13f6cc6029" name="a69008efd45eac83619604a13f6cc6029"></a>
std::optional&lt; int64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>min_rows_requested</b></td></tr>
<tr class="separator:a69008efd45eac83619604a13f6cc6029"><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>Request to initiate a server-side scan planning operation. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>iceberg/catalog/rest/<a class="el" href="types_8h_source.html">types.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>