Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1ScanTask.html
blob: ba24d6e8434dafce898903153cd99a419bdf9332 [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::ScanTask 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"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1ScanTask.html">ScanTask</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classiceberg_1_1ScanTask-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::ScanTask Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>An abstract scan task.
<a href="classiceberg_1_1ScanTask.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="table__scan_8h_source.html">table_scan.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::ScanTask:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1ScanTask.png" usemap="#iceberg::ScanTask_map" alt=""/>
<map id="iceberg::ScanTask_map" name="iceberg::ScanTask_map">
<area href="classiceberg_1_1ChangelogScanTask.html" title="A scan task for reading changelog entries between snapshots." alt="iceberg::ChangelogScanTask" shape="rect" coords="0,56,177,80"/>
<area href="classiceberg_1_1FileScanTask.html" title="Task representing a data file and its corresponding delete files." alt="iceberg::FileScanTask" shape="rect" coords="187,56,364,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ab28bdbcb5d183627dfec1ef4d3321c1f" id="r_ab28bdbcb5d183627dfec1ef4d3321c1f"><td class="memItemLeft" align="right" valign="top"><a id="ab28bdbcb5d183627dfec1ef4d3321c1f" name="ab28bdbcb5d183627dfec1ef4d3321c1f"></a>enum class &#160;</td><td class="memItemRight" valign="bottom"><b>Kind</b> : uint8_t { <b>kFileScanTask</b>
, <b>kChangelogScanTask</b>
}</td></tr>
<tr class="separator:ab28bdbcb5d183627dfec1ef4d3321c1f"><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:a3e223ab9964f78b6e99791567c82e1b6" id="r_a3e223ab9964f78b6e99791567c82e1b6"><td class="memItemLeft" align="right" valign="top">virtual Kind&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ScanTask.html#a3e223ab9964f78b6e99791567c82e1b6">kind</a> () const =0</td></tr>
<tr class="memdesc:a3e223ab9964f78b6e99791567c82e1b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The kind of scan task. <br /></td></tr>
<tr class="separator:a3e223ab9964f78b6e99791567c82e1b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a196044bb4a1fc867fb9dbece6ae3f47c" id="r_a196044bb4a1fc867fb9dbece6ae3f47c"><td class="memItemLeft" align="right" valign="top">virtual int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ScanTask.html#a196044bb4a1fc867fb9dbece6ae3f47c">size_bytes</a> () const =0</td></tr>
<tr class="memdesc:a196044bb4a1fc867fb9dbece6ae3f47c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of bytes that should be read by this scan task. <br /></td></tr>
<tr class="separator:a196044bb4a1fc867fb9dbece6ae3f47c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a014e83fb779a07601b71dd503871986b" id="r_a014e83fb779a07601b71dd503871986b"><td class="memItemLeft" align="right" valign="top">virtual int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ScanTask.html#a014e83fb779a07601b71dd503871986b">files_count</a> () const =0</td></tr>
<tr class="memdesc:a014e83fb779a07601b71dd503871986b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of files that should be read by this scan task. <br /></td></tr>
<tr class="separator:a014e83fb779a07601b71dd503871986b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1065f2e9db3b7d9d42f861bfca839232" id="r_a1065f2e9db3b7d9d42f861bfca839232"><td class="memItemLeft" align="right" valign="top">virtual int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ScanTask.html#a1065f2e9db3b7d9d42f861bfca839232">estimated_row_count</a> () const =0</td></tr>
<tr class="memdesc:a1065f2e9db3b7d9d42f861bfca839232"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of rows that should be read by this scan task. <br /></td></tr>
<tr class="separator:a1065f2e9db3b7d9d42f861bfca839232"><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>An abstract scan task. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a1065f2e9db3b7d9d42f861bfca839232" name="a1065f2e9db3b7d9d42f861bfca839232"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1065f2e9db3b7d9d42f861bfca839232">&#9670;&#160;</a></span>estimated_row_count()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int64_t iceberg::ScanTask::estimated_row_count </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of rows that should be read by this scan task. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1FileScanTask.html#a40c1b4c68a2b3fe147afcbad05a5b624">iceberg::FileScanTask</a>, and <a class="el" href="classiceberg_1_1ChangelogScanTask.html#a84246b65ec7e10024d3bdf159aea243f">iceberg::ChangelogScanTask</a>.</p>
</div>
</div>
<a id="a014e83fb779a07601b71dd503871986b" name="a014e83fb779a07601b71dd503871986b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a014e83fb779a07601b71dd503871986b">&#9670;&#160;</a></span>files_count()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t iceberg::ScanTask::files_count </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of files that should be read by this scan task. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1FileScanTask.html#a5222b5f4cc30a36bf058745d9ae9f1d9">iceberg::FileScanTask</a>, and <a class="el" href="classiceberg_1_1ChangelogScanTask.html#af173a61632f2b88e4da007a0859100f4">iceberg::ChangelogScanTask</a>.</p>
</div>
</div>
<a id="a3e223ab9964f78b6e99791567c82e1b6" name="a3e223ab9964f78b6e99791567c82e1b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e223ab9964f78b6e99791567c82e1b6">&#9670;&#160;</a></span>kind()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Kind iceberg::ScanTask::kind </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The kind of scan task. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1FileScanTask.html#a98a4912bc062e02fcdb26b71b9e79480">iceberg::FileScanTask</a>, and <a class="el" href="classiceberg_1_1ChangelogScanTask.html#ace10d0cf9753b1b3dbb0289071c2d155">iceberg::ChangelogScanTask</a>.</p>
</div>
</div>
<a id="a196044bb4a1fc867fb9dbece6ae3f47c" name="a196044bb4a1fc867fb9dbece6ae3f47c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a196044bb4a1fc867fb9dbece6ae3f47c">&#9670;&#160;</a></span>size_bytes()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int64_t iceberg::ScanTask::size_bytes </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of bytes that should be read by this scan task. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1FileScanTask.html#ab9cafa54598c24e7278ecf1ffc58163e">iceberg::FileScanTask</a>, and <a class="el" href="classiceberg_1_1ChangelogScanTask.html#a0a3b4dd22854acb631e33271dd9a1250">iceberg::ChangelogScanTask</a>.</p>
</div>
</div>
<hr/>The documentation for this class 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>