blob: efedb0a6801ab30ab4fb6fa630482d49d9735fb5 [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::DeleteFileIndex 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_1DeleteFileIndex.html">DeleteFileIndex</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classiceberg_1_1DeleteFileIndex-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::DeleteFileIndex Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>An index of delete files by sequence number.
<a href="classiceberg_1_1DeleteFileIndex.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="delete__file__index_8h_source.html">delete_file_index.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::DeleteFileIndex:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1DeleteFileIndex.png" alt=""/>
</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:a60f63261401afb774a78f42a9288e2e9" id="r_a60f63261401afb774a78f42a9288e2e9"><td class="memItemLeft" align="right" valign="top"><a id="a60f63261401afb774a78f42a9288e2e9" name="a60f63261401afb774a78f42a9288e2e9"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>DeleteFileIndex</b> (<a class="el" href="classiceberg_1_1DeleteFileIndex.html">DeleteFileIndex</a> &amp;&amp;) noexcept</td></tr>
<tr class="separator:a60f63261401afb774a78f42a9288e2e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18b8d3f7e1f7d8da3f7c12b81e1a3eee" id="r_a18b8d3f7e1f7d8da3f7c12b81e1a3eee"><td class="memItemLeft" align="right" valign="top"><a id="a18b8d3f7e1f7d8da3f7c12b81e1a3eee" name="a18b8d3f7e1f7d8da3f7c12b81e1a3eee"></a>
<a class="el" href="classiceberg_1_1DeleteFileIndex.html">DeleteFileIndex</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classiceberg_1_1DeleteFileIndex.html">DeleteFileIndex</a> &amp;&amp;) noexcept</td></tr>
<tr class="separator:a18b8d3f7e1f7d8da3f7c12b81e1a3eee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae08e2418f023518c0f7895ce6ec356dc" id="r_ae08e2418f023518c0f7895ce6ec356dc"><td class="memItemLeft" align="right" valign="top"><a id="ae08e2418f023518c0f7895ce6ec356dc" name="ae08e2418f023518c0f7895ce6ec356dc"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>DeleteFileIndex</b> (const <a class="el" href="classiceberg_1_1DeleteFileIndex.html">DeleteFileIndex</a> &amp;)=delete</td></tr>
<tr class="separator:ae08e2418f023518c0f7895ce6ec356dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c91854afeb8ec10066a77cc976af1ea" id="r_a1c91854afeb8ec10066a77cc976af1ea"><td class="memItemLeft" align="right" valign="top"><a id="a1c91854afeb8ec10066a77cc976af1ea" name="a1c91854afeb8ec10066a77cc976af1ea"></a>
<a class="el" href="classiceberg_1_1DeleteFileIndex.html">DeleteFileIndex</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classiceberg_1_1DeleteFileIndex.html">DeleteFileIndex</a> &amp;)=delete</td></tr>
<tr class="separator:a1c91854afeb8ec10066a77cc976af1ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4108cf374396498f7e7a8eb83e6bce72" id="r_a4108cf374396498f7e7a8eb83e6bce72"><td class="memItemLeft" align="right" valign="top"><a id="a4108cf374396498f7e7a8eb83e6bce72" name="a4108cf374396498f7e7a8eb83e6bce72"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>empty</b> () const</td></tr>
<tr class="memdesc:a4108cf374396498f7e7a8eb83e6bce72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if this index is empty (has no delete files). <br /></td></tr>
<tr class="separator:a4108cf374396498f7e7a8eb83e6bce72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af908abf6e0a3f9dcac838fcaa1521396" id="r_af908abf6e0a3f9dcac838fcaa1521396"><td class="memItemLeft" align="right" valign="top"><a id="af908abf6e0a3f9dcac838fcaa1521396" name="af908abf6e0a3f9dcac838fcaa1521396"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>has_equality_deletes</b> () const</td></tr>
<tr class="memdesc:af908abf6e0a3f9dcac838fcaa1521396"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if this index has any equality delete files. <br /></td></tr>
<tr class="separator:af908abf6e0a3f9dcac838fcaa1521396"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4736cc46da463db0ac7b67b824a68f3" id="r_ae4736cc46da463db0ac7b67b824a68f3"><td class="memItemLeft" align="right" valign="top"><a id="ae4736cc46da463db0ac7b67b824a68f3" name="ae4736cc46da463db0ac7b67b824a68f3"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>has_position_deletes</b> () const</td></tr>
<tr class="memdesc:ae4736cc46da463db0ac7b67b824a68f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if this index has any position delete files. <br /></td></tr>
<tr class="separator:ae4736cc46da463db0ac7b67b824a68f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d12f5eccbff979611d9040cbe572a32" id="r_a6d12f5eccbff979611d9040cbe572a32"><td class="memItemLeft" align="right" valign="top"><a id="a6d12f5eccbff979611d9040cbe572a32" name="a6d12f5eccbff979611d9040cbe572a32"></a>
std::vector&lt; std::shared_ptr&lt; <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>ReferencedDeleteFiles</b> () const</td></tr>
<tr class="memdesc:a6d12f5eccbff979611d9040cbe572a32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get all delete files referenced by this index. TODO(gangwu): use lazy iterator to avoid large memory allocation. <br /></td></tr>
<tr class="separator:a6d12f5eccbff979611d9040cbe572a32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac15d713286e0740dfd225f9ab2e22fa9" id="r_ac15d713286e0740dfd225f9ab2e22fa9"><td class="memItemLeft" align="right" valign="top">Result&lt; std::vector&lt; std::shared_ptr&lt; <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &gt; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DeleteFileIndex.html#ac15d713286e0740dfd225f9ab2e22fa9">ForEntry</a> (const <a class="el" href="structiceberg_1_1ManifestEntry.html">ManifestEntry</a> &amp;entry) const</td></tr>
<tr class="memdesc:ac15d713286e0740dfd225f9ab2e22fa9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the delete files that apply to a manifest entry. <br /></td></tr>
<tr class="separator:ac15d713286e0740dfd225f9ab2e22fa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a3035e6457edce65d570e6d0304b077" id="r_a3a3035e6457edce65d570e6d0304b077"><td class="memItemLeft" align="right" valign="top">Result&lt; std::vector&lt; std::shared_ptr&lt; <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &gt; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DeleteFileIndex.html#a3a3035e6457edce65d570e6d0304b077">ForDataFile</a> (int64_t sequence_number, const <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &amp;file) const</td></tr>
<tr class="memdesc:a3a3035e6457edce65d570e6d0304b077"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the delete files that apply to a data file with a specific sequence number. <br /></td></tr>
<tr class="separator:a3a3035e6457edce65d570e6d0304b077"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b3da4d66ecebeea4e3fd3a1a7cbde7e" id="r_a0b3da4d66ecebeea4e3fd3a1a7cbde7e"><td class="memItemLeft" align="right" valign="top"><a id="a0b3da4d66ecebeea4e3fd3a1a7cbde7e" name="a0b3da4d66ecebeea4e3fd3a1a7cbde7e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Builder</b> (std::shared_ptr&lt; <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> &gt; io, std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &gt; schema, std::unordered_map&lt; int32_t, std::shared_ptr&lt; <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> &gt; &gt; specs_by_id, std::vector&lt; <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> &gt; delete_manifests)</td></tr>
<tr class="memdesc:a0b3da4d66ecebeea4e3fd3a1a7cbde7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a builder from manifest files. <br /></td></tr>
<tr class="separator:a0b3da4d66ecebeea4e3fd3a1a7cbde7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72fe46a70526200f164900d99193c303" id="r_a72fe46a70526200f164900d99193c303"><td class="memItemLeft" align="right" valign="top"><a id="a72fe46a70526200f164900d99193c303" name="a72fe46a70526200f164900d99193c303"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Builder</b> (Builder &amp;&amp;) noexcept</td></tr>
<tr class="separator:a72fe46a70526200f164900d99193c303"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4e991537d2c902dac02d06c13ebfba8" id="r_ac4e991537d2c902dac02d06c13ebfba8"><td class="memItemLeft" align="right" valign="top"><a id="ac4e991537d2c902dac02d06c13ebfba8" name="ac4e991537d2c902dac02d06c13ebfba8"></a>
Builder &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (Builder &amp;&amp;) noexcept</td></tr>
<tr class="separator:ac4e991537d2c902dac02d06c13ebfba8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c771647d5124558c580615177047806" id="r_a1c771647d5124558c580615177047806"><td class="memItemLeft" align="right" valign="top"><a id="a1c771647d5124558c580615177047806" name="a1c771647d5124558c580615177047806"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Builder</b> (const Builder &amp;)=delete</td></tr>
<tr class="separator:a1c771647d5124558c580615177047806"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7e5a753c054cee893d657d307d7b444" id="r_af7e5a753c054cee893d657d307d7b444"><td class="memItemLeft" align="right" valign="top"><a id="af7e5a753c054cee893d657d307d7b444" name="af7e5a753c054cee893d657d307d7b444"></a>
Builder &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const Builder &amp;)=delete</td></tr>
<tr class="separator:af7e5a753c054cee893d657d307d7b444"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90815e423f00c95cc539f9158ec51ef7" id="r_a90815e423f00c95cc539f9158ec51ef7"><td class="memItemLeft" align="right" valign="top">Builder &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DeleteFileIndex.html#a90815e423f00c95cc539f9158ec51ef7">AfterSequenceNumber</a> (int64_t seq)</td></tr>
<tr class="memdesc:a90815e423f00c95cc539f9158ec51ef7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the minimum sequence number for delete files. <br /></td></tr>
<tr class="separator:a90815e423f00c95cc539f9158ec51ef7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91372e1ad57ee20bc7e5b30210b9c0d1" id="r_a91372e1ad57ee20bc7e5b30210b9c0d1"><td class="memItemLeft" align="right" valign="top">Builder &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DeleteFileIndex.html#a91372e1ad57ee20bc7e5b30210b9c0d1">DataFilter</a> (std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Expression.html">Expression</a> &gt; filter)</td></tr>
<tr class="memdesc:a91372e1ad57ee20bc7e5b30210b9c0d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a row-level data filter. <br /></td></tr>
<tr class="separator:a91372e1ad57ee20bc7e5b30210b9c0d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cce1869ad9677a708607f21db81efa9" id="r_a7cce1869ad9677a708607f21db81efa9"><td class="memItemLeft" align="right" valign="top"><a id="a7cce1869ad9677a708607f21db81efa9" name="a7cce1869ad9677a708607f21db81efa9"></a>
Builder &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>PartitionFilter</b> (std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Expression.html">Expression</a> &gt; filter)</td></tr>
<tr class="memdesc:a7cce1869ad9677a708607f21db81efa9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a partition filter expression. <br /></td></tr>
<tr class="separator:a7cce1869ad9677a708607f21db81efa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c22236f43e121db704de1acabb53c4f" id="r_a2c22236f43e121db704de1acabb53c4f"><td class="memItemLeft" align="right" valign="top"><a id="a2c22236f43e121db704de1acabb53c4f" name="a2c22236f43e121db704de1acabb53c4f"></a>
Builder &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>FilterPartitions</b> (std::shared_ptr&lt; <a class="el" href="classiceberg_1_1PartitionSet.html">PartitionSet</a> &gt; partition_set)</td></tr>
<tr class="memdesc:a2c22236f43e121db704de1acabb53c4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a partition set to filter manifests. <br /></td></tr>
<tr class="separator:a2c22236f43e121db704de1acabb53c4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7fa5ca109db792cf19adb6903ea5d2cc" id="r_a7fa5ca109db792cf19adb6903ea5d2cc"><td class="memItemLeft" align="right" valign="top"><a id="a7fa5ca109db792cf19adb6903ea5d2cc" name="a7fa5ca109db792cf19adb6903ea5d2cc"></a>
Builder &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>CaseSensitive</b> (bool case_sensitive)</td></tr>
<tr class="memdesc:a7fa5ca109db792cf19adb6903ea5d2cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set case sensitivity for column name matching. <br /></td></tr>
<tr class="separator:a7fa5ca109db792cf19adb6903ea5d2cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9687d425c3c108f232927a57065058ba" id="r_a9687d425c3c108f232927a57065058ba"><td class="memItemLeft" align="right" valign="top"><a id="a9687d425c3c108f232927a57065058ba" name="a9687d425c3c108f232927a57065058ba"></a>
Builder &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>IgnoreResiduals</b> ()</td></tr>
<tr class="memdesc:a9687d425c3c108f232927a57065058ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ignore residual expressions after partition filtering. <br /></td></tr>
<tr class="separator:a9687d425c3c108f232927a57065058ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3dbf497d376ed904689a8bb1c7d3b535" id="r_a3dbf497d376ed904689a8bb1c7d3b535"><td class="memItemLeft" align="right" valign="top"><a id="a3dbf497d376ed904689a8bb1c7d3b535" name="a3dbf497d376ed904689a8bb1c7d3b535"></a>
Result&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1DeleteFileIndex.html">DeleteFileIndex</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Build</b> ()</td></tr>
<tr class="memdesc:a3dbf497d376ed904689a8bb1c7d3b535"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build the <a class="el" href="classiceberg_1_1DeleteFileIndex.html" title="An index of delete files by sequence number.">DeleteFileIndex</a>. <br /></td></tr>
<tr class="separator:a3dbf497d376ed904689a8bb1c7d3b535"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a31e5926d930fb28cbcfecdd01b1ac524" id="r_a31e5926d930fb28cbcfecdd01b1ac524"><td class="memItemLeft" align="right" valign="top">static Result&lt; Builder &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DeleteFileIndex.html#a31e5926d930fb28cbcfecdd01b1ac524">BuilderFor</a> (std::shared_ptr&lt; <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> &gt; io, std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &gt; schema, std::unordered_map&lt; int32_t, std::shared_ptr&lt; <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> &gt; &gt; specs_by_id, std::vector&lt; <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> &gt; delete_manifests)</td></tr>
<tr class="memdesc:a31e5926d930fb28cbcfecdd01b1ac524"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a builder for constructing a <a class="el" href="classiceberg_1_1DeleteFileIndex.html" title="An index of delete files by sequence number.">DeleteFileIndex</a> from manifest files. <br /></td></tr>
<tr class="separator:a31e5926d930fb28cbcfecdd01b1ac524"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a870e4066b979b9cef642eb091f8f3d95" id="r_a870e4066b979b9cef642eb091f8f3d95"><td class="memItemLeft" align="right" valign="top"><a id="a870e4066b979b9cef642eb091f8f3d95" name="a870e4066b979b9cef642eb091f8f3d95"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>Builder</b></td></tr>
<tr class="separator:a870e4066b979b9cef642eb091f8f3d95"><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 index of delete files by sequence number. </p>
<p>Use <code>DeleteFileIndex::Builder</code> to construct an index, and <code><a class="el" href="classiceberg_1_1DeleteFileIndex.html#a3a3035e6457edce65d570e6d0304b077" title="Get the delete files that apply to a data file with a specific sequence number.">ForDataFile()</a></code> or <code><a class="el" href="classiceberg_1_1DeleteFileIndex.html#ac15d713286e0740dfd225f9ab2e22fa9" title="Get the delete files that apply to a manifest entry.">ForEntry()</a></code> to get the delete files to apply to a given data file.</p>
<p>The index organizes delete files by:</p><ul>
<li>Global equality deletes (apply to all partitions)</li>
<li>Partitioned equality deletes (apply to specific partitions)</li>
<li>Partitioned position deletes (apply to specific partitions)</li>
<li>File-scoped position deletes (apply to specific data files)</li>
<li>Deletion vectors (DVs) that reference specific data files </li>
</ul>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a90815e423f00c95cc539f9158ec51ef7" name="a90815e423f00c95cc539f9158ec51ef7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90815e423f00c95cc539f9158ec51ef7">&#9670;&#160;</a></span>AfterSequenceNumber()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Builder &amp; iceberg::DeleteFileIndex::AfterSequenceNumber </td>
<td>(</td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>seq</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the minimum sequence number for delete files. </p>
<p>Only delete files with sequence number &gt; min_sequence_number will be included. </p>
</div>
</div>
<a id="a31e5926d930fb28cbcfecdd01b1ac524" name="a31e5926d930fb28cbcfecdd01b1ac524"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31e5926d930fb28cbcfecdd01b1ac524">&#9670;&#160;</a></span>BuilderFor()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Result&lt; DeleteFileIndex::Builder &gt; iceberg::DeleteFileIndex::BuilderFor </td>
<td>(</td>
<td class="paramtype">std::shared_ptr&lt; <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> &gt;&#160;</td>
<td class="paramname"><em>io</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &gt;&#160;</td>
<td class="paramname"><em>schema</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::unordered_map&lt; int32_t, std::shared_ptr&lt; <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> &gt; &gt;&#160;</td>
<td class="paramname"><em>specs_by_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> &gt;&#160;</td>
<td class="paramname"><em>delete_manifests</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a builder for constructing a <a class="el" href="classiceberg_1_1DeleteFileIndex.html" title="An index of delete files by sequence number.">DeleteFileIndex</a> from manifest files. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">io</td><td>The <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> to use for reading manifests </td></tr>
<tr><td class="paramname">schema</td><td>Current table schema </td></tr>
<tr><td class="paramname">specs_by_id</td><td>Partition specs by their IDs </td></tr>
<tr><td class="paramname">delete_manifests</td><td>The delete manifests to index </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A Builder instance </dd></dl>
</div>
</div>
<a id="a91372e1ad57ee20bc7e5b30210b9c0d1" name="a91372e1ad57ee20bc7e5b30210b9c0d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91372e1ad57ee20bc7e5b30210b9c0d1">&#9670;&#160;</a></span>DataFilter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Builder &amp; iceberg::DeleteFileIndex::DataFilter </td>
<td>(</td>
<td class="paramtype">std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Expression.html">Expression</a> &gt;&#160;</td>
<td class="paramname"><em>filter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a row-level data filter. </p>
<p>This filter is projected to partition expressions for manifest pruning and then residuals are applied to data files. </p>
</div>
</div>
<a id="a3a3035e6457edce65d570e6d0304b077" name="a3a3035e6457edce65d570e6d0304b077"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a3035e6457edce65d570e6d0304b077">&#9670;&#160;</a></span>ForDataFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Result&lt; std::vector&lt; std::shared_ptr&lt; <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &gt; &gt; &gt; iceberg::DeleteFileIndex::ForDataFile </td>
<td>(</td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>sequence_number</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &amp;&#160;</td>
<td class="paramname"><em>file</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the delete files that apply to a data file with a specific sequence number. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sequence_number</td><td>The data sequence number of the data file </td></tr>
<tr><td class="paramname">file</td><td>The data file to find delete files for </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Delete files that should be applied when reading the data file </dd></dl>
</div>
</div>
<a id="ac15d713286e0740dfd225f9ab2e22fa9" name="ac15d713286e0740dfd225f9ab2e22fa9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac15d713286e0740dfd225f9ab2e22fa9">&#9670;&#160;</a></span>ForEntry()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Result&lt; std::vector&lt; std::shared_ptr&lt; <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &gt; &gt; &gt; iceberg::DeleteFileIndex::ForEntry </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structiceberg_1_1ManifestEntry.html">ManifestEntry</a> &amp;&#160;</td>
<td class="paramname"><em>entry</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the delete files that apply to a manifest entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entry</td><td>The manifest entry to find delete files for </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Delete files that should be applied when reading the data file </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/<a class="el" href="delete__file__index_8h_source.html">delete_file_index.h</a></li>
<li>iceberg/<b>delete_file_index.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>