Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./api/table__scan_8h.html
blob: 147fd5863224cc40349bed18e8351016e5e57212 [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/table_scan.h File 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="dir_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#concepts">Concepts</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">table_scan.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Define table scan APIs and scan task types.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;functional&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &lt;optional&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;unordered_map&gt;</code><br />
<code>#include &lt;unordered_set&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &quot;<a class="el" href="iceberg__export_8h_source.html">iceberg/iceberg_export.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="result_8h_source.html">iceberg/result.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="table__metadata_8h_source.html">iceberg/table_metadata.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="type__fwd_8h_source.html">iceberg/type_fwd.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="error__collector_8h_source.html">iceberg/util/error_collector.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="executor_8h_source.html">iceberg/util/executor.h</a>&quot;</code><br />
</div>
<p><a href="table__scan_8h_source.html">Go to the source code of this file.</a></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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ScanTask.html">iceberg::ScanTask</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An abstract scan task. <a href="classiceberg_1_1ScanTask.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileScanTask.html">iceberg::FileScanTask</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Task representing a data file and its corresponding delete files. <a href="classiceberg_1_1FileScanTask.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ChangelogScanTask.html">iceberg::ChangelogScanTask</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A scan task for reading changelog entries between snapshots. <a href="classiceberg_1_1ChangelogScanTask.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1AddedRowsScanTask.html">iceberg::AddedRowsScanTask</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A scan task for inserts generated by adding a data file to the table. <a href="classiceberg_1_1AddedRowsScanTask.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DeletedDataFileScanTask.html">iceberg::DeletedDataFileScanTask</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A scan task for deletes generated by removing a data file from the table. <a href="classiceberg_1_1DeletedDataFileScanTask.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1internal_1_1TableScanContext.html">iceberg::internal::TableScanContext</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TableScanBuilder.html">iceberg::TableScanBuilder&lt; ScanType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builder class for creating <a class="el" href="classiceberg_1_1TableScan.html" title="Represents a configured scan operation on a table.">TableScan</a> instances. <a href="classiceberg_1_1TableScanBuilder.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TableScan.html">iceberg::TableScan</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a configured scan operation on a table. <a href="classiceberg_1_1TableScan.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DataTableScan.html">iceberg::DataTableScan</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A scan that reads data files and applies delete files to filter rows. <a href="classiceberg_1_1DataTableScan.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1IncrementalScan.html">iceberg::IncrementalScan&lt; ScanTaskType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A base template class for incremental scans that read changes between snapshots, and return scan tasks of the specified type. <a href="classiceberg_1_1IncrementalScan.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1IncrementalAppendScan.html">iceberg::IncrementalAppendScan</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A scan that reads data files added between snapshots (incremental appends). <a href="classiceberg_1_1IncrementalAppendScan.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1IncrementalChangelogScan.html">iceberg::IncrementalChangelogScan</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A scan that reads changelog entries between snapshots. <a href="classiceberg_1_1IncrementalChangelogScan.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="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceiceberg" id="r_namespaceiceberg"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html">iceberg</a></td></tr>
<tr class="memdesc:namespaceiceberg"><td class="mdescLeft">&#160;</td><td class="mdescRight">Core Apache Iceberg C++ APIs. <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="concepts" name="concepts"></a>
Concepts</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">concept &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="concepticeberg_1_1IsIncrementalScan.html">iceberg::IsIncrementalScan</a></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="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:add183f4ce92f2401272be251f22658e9" id="r_add183f4ce92f2401272be251f22658e9"><td class="memItemLeft" align="right" valign="top"><a id="add183f4ce92f2401272be251f22658e9" name="add183f4ce92f2401272be251f22658e9"></a>enum class &#160;</td><td class="memItemRight" valign="bottom"><b>ChangelogOperation</b> : uint8_t { <b>kInsert</b>
, <b>kDelete</b>
, <b>kUpdateBefore</b>
, <b>kUpdateAfter</b>
}</td></tr>
<tr class="separator:add183f4ce92f2401272be251f22658e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:abd103134727dc0f73727444ab36c313e" id="r_abd103134727dc0f73727444ab36c313e"><td class="memItemLeft" align="right" valign="top"><a id="abd103134727dc0f73727444ab36c313e" name="abd103134727dc0f73727444ab36c313e"></a>
template class ICEBERG_EXTERN_TEMPLATE_CLASS_EXPORT&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::TableScanBuilder&lt; DataTableScan &gt;</b></td></tr>
<tr class="separator:abd103134727dc0f73727444ab36c313e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43518c59b62a30a81fbb8cf0e41f76f4" id="r_a43518c59b62a30a81fbb8cf0e41f76f4"><td class="memItemLeft" align="right" valign="top"><a id="a43518c59b62a30a81fbb8cf0e41f76f4" name="a43518c59b62a30a81fbb8cf0e41f76f4"></a>
template class ICEBERG_EXTERN_TEMPLATE_CLASS_EXPORT&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::TableScanBuilder&lt; IncrementalAppendScan &gt;</b></td></tr>
<tr class="separator:a43518c59b62a30a81fbb8cf0e41f76f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f87db2ff4197aed1b0eb193b9fe6434" id="r_a9f87db2ff4197aed1b0eb193b9fe6434"><td class="memItemLeft" align="right" valign="top"><a id="a9f87db2ff4197aed1b0eb193b9fe6434" name="a9f87db2ff4197aed1b0eb193b9fe6434"></a>
template class ICEBERG_EXTERN_TEMPLATE_CLASS_EXPORT&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::TableScanBuilder&lt; IncrementalChangelogScan &gt;</b></td></tr>
<tr class="separator:a9f87db2ff4197aed1b0eb193b9fe6434"><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>Define table scan APIs and scan task types. </p>
</div></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>