Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1ChangelogScanTask.html
blob: 45ee36468f10eaf5ee6d067512bb0069dfffced8 [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::ChangelogScanTask 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_1ChangelogScanTask.html">ChangelogScanTask</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classiceberg_1_1ChangelogScanTask-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::ChangelogScanTask Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A scan task for reading changelog entries between snapshots.
<a href="classiceberg_1_1ChangelogScanTask.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::ChangelogScanTask:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1ChangelogScanTask.png" usemap="#iceberg::ChangelogScanTask_map" alt=""/>
<map id="iceberg::ChangelogScanTask_map" name="iceberg::ChangelogScanTask_map">
<area href="classiceberg_1_1ScanTask.html" title="An abstract scan task." alt="iceberg::ScanTask" shape="rect" coords="0,0,177,24"/>
</map>
</div></div>
<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:ace10d0cf9753b1b3dbb0289071c2d155" id="r_ace10d0cf9753b1b3dbb0289071c2d155"><td class="memItemLeft" align="right" valign="top">Kind&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ChangelogScanTask.html#ace10d0cf9753b1b3dbb0289071c2d155">kind</a> () const override</td></tr>
<tr class="memdesc:ace10d0cf9753b1b3dbb0289071c2d155"><td class="mdescLeft">&#160;</td><td class="mdescRight">The kind of scan task. <br /></td></tr>
<tr class="separator:ace10d0cf9753b1b3dbb0289071c2d155"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a3b4dd22854acb631e33271dd9a1250" id="r_a0a3b4dd22854acb631e33271dd9a1250"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ChangelogScanTask.html#a0a3b4dd22854acb631e33271dd9a1250">size_bytes</a> () const override</td></tr>
<tr class="memdesc:a0a3b4dd22854acb631e33271dd9a1250"><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:a0a3b4dd22854acb631e33271dd9a1250"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af173a61632f2b88e4da007a0859100f4" id="r_af173a61632f2b88e4da007a0859100f4"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ChangelogScanTask.html#af173a61632f2b88e4da007a0859100f4">files_count</a> () const override</td></tr>
<tr class="memdesc:af173a61632f2b88e4da007a0859100f4"><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:af173a61632f2b88e4da007a0859100f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84246b65ec7e10024d3bdf159aea243f" id="r_a84246b65ec7e10024d3bdf159aea243f"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ChangelogScanTask.html#a84246b65ec7e10024d3bdf159aea243f">estimated_row_count</a> () const override</td></tr>
<tr class="memdesc:a84246b65ec7e10024d3bdf159aea243f"><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:a84246b65ec7e10024d3bdf159aea243f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classiceberg_1_1ScanTask"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classiceberg_1_1ScanTask')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classiceberg_1_1ScanTask.html">iceberg::ScanTask</a></td></tr>
<tr class="memitem:ab28bdbcb5d183627dfec1ef4d3321c1f inherit pub_types_classiceberg_1_1ScanTask" 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 inherit pub_types_classiceberg_1_1ScanTask"><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 scan task for reading changelog entries between snapshots. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a84246b65ec7e10024d3bdf159aea243f" name="a84246b65ec7e10024d3bdf159aea243f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84246b65ec7e10024d3bdf159aea243f">&#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">int64_t iceberg::ChangelogScanTask::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>Implements <a class="el" href="classiceberg_1_1ScanTask.html#a1065f2e9db3b7d9d42f861bfca839232">iceberg::ScanTask</a>.</p>
</div>
</div>
<a id="af173a61632f2b88e4da007a0859100f4" name="af173a61632f2b88e4da007a0859100f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af173a61632f2b88e4da007a0859100f4">&#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">int32_t iceberg::ChangelogScanTask::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>Implements <a class="el" href="classiceberg_1_1ScanTask.html#a014e83fb779a07601b71dd503871986b">iceberg::ScanTask</a>.</p>
</div>
</div>
<a id="ace10d0cf9753b1b3dbb0289071c2d155" name="ace10d0cf9753b1b3dbb0289071c2d155"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace10d0cf9753b1b3dbb0289071c2d155">&#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">Kind iceberg::ChangelogScanTask::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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The kind of scan task. </p>
<p>Implements <a class="el" href="classiceberg_1_1ScanTask.html#a3e223ab9964f78b6e99791567c82e1b6">iceberg::ScanTask</a>.</p>
</div>
</div>
<a id="a0a3b4dd22854acb631e33271dd9a1250" name="a0a3b4dd22854acb631e33271dd9a1250"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a3b4dd22854acb631e33271dd9a1250">&#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">int64_t iceberg::ChangelogScanTask::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>Implements <a class="el" href="classiceberg_1_1ScanTask.html#a196044bb4a1fc867fb9dbece6ae3f47c">iceberg::ScanTask</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/<a class="el" href="table__scan_8h_source.html">table_scan.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>