blob: a9ee77a54ab84caad7b5d01e831b2baef91c0fb2 [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::DeleteLoader 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_1DeleteLoader.html">DeleteLoader</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_1DeleteLoader-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::DeleteLoader Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Loads delete files and constructs in-memory delete indexes.
<a href="classiceberg_1_1DeleteLoader.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="delete__loader_8h_source.html">delete_loader.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:a6b7c34d6dbd2c1ba2ff1c21b11ff07eb" id="r_a6b7c34d6dbd2c1ba2ff1c21b11ff07eb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DeleteLoader.html#a6b7c34d6dbd2c1ba2ff1c21b11ff07eb">DeleteLoader</a> (std::shared_ptr&lt; <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> &gt; io)</td></tr>
<tr class="memdesc:a6b7c34d6dbd2c1ba2ff1c21b11ff07eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a <a class="el" href="classiceberg_1_1DeleteLoader.html" title="Loads delete files and constructs in-memory delete indexes.">DeleteLoader</a>. <br /></td></tr>
<tr class="separator:a6b7c34d6dbd2c1ba2ff1c21b11ff07eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb3f9974fdcfe3b36e863264daf6d990" id="r_abb3f9974fdcfe3b36e863264daf6d990"><td class="memItemLeft" align="right" valign="top">Result&lt; <a class="el" href="classiceberg_1_1PositionDeleteIndex.html">PositionDeleteIndex</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DeleteLoader.html#abb3f9974fdcfe3b36e863264daf6d990">LoadPositionDeletes</a> (std::span&lt; const std::shared_ptr&lt; <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &gt; &gt; delete_files, std::string_view data_file_path) const</td></tr>
<tr class="memdesc:abb3f9974fdcfe3b36e863264daf6d990"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load position deletes for a specific data file. <br /></td></tr>
<tr class="separator:abb3f9974fdcfe3b36e863264daf6d990"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37fbf5e8ee0d659770564a0ed7f7ad65" id="r_a37fbf5e8ee0d659770564a0ed7f7ad65"><td class="memItemLeft" align="right" valign="top">Result&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1StructLikeSet.html">UncheckedStructLikeSet</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DeleteLoader.html#a37fbf5e8ee0d659770564a0ed7f7ad65">LoadEqualityDeletes</a> (std::span&lt; const std::shared_ptr&lt; <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &gt; &gt; delete_files, const <a class="el" href="classiceberg_1_1StructType.html">StructType</a> &amp;equality_type) const</td></tr>
<tr class="memdesc:a37fbf5e8ee0d659770564a0ed7f7ad65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load equality deletes into an in-memory set. <br /></td></tr>
<tr class="separator:a37fbf5e8ee0d659770564a0ed7f7ad65"><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>Loads delete files and constructs in-memory delete indexes. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a6b7c34d6dbd2c1ba2ff1c21b11ff07eb" name="a6b7c34d6dbd2c1ba2ff1c21b11ff07eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b7c34d6dbd2c1ba2ff1c21b11ff07eb">&#9670;&#160;</a></span>DeleteLoader()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">iceberg::DeleteLoader::DeleteLoader </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><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a <a class="el" href="classiceberg_1_1DeleteLoader.html" title="Loads delete files and constructs in-memory delete indexes.">DeleteLoader</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">io</td><td><a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> instance for reading delete files </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a37fbf5e8ee0d659770564a0ed7f7ad65" name="a37fbf5e8ee0d659770564a0ed7f7ad65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37fbf5e8ee0d659770564a0ed7f7ad65">&#9670;&#160;</a></span>LoadEqualityDeletes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Result&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1StructLikeSet.html">UncheckedStructLikeSet</a> &gt; &gt; iceberg::DeleteLoader::LoadEqualityDeletes </td>
<td>(</td>
<td class="paramtype">std::span&lt; const std::shared_ptr&lt; <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &gt; &gt;&#160;</td>
<td class="paramname"><em>delete_files</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classiceberg_1_1StructType.html">StructType</a> &amp;&#160;</td>
<td class="paramname"><em>equality_type</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Load equality deletes into an in-memory set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">delete_files</td><td>Equality delete files to load (must have content == Content::kEqualityDeletes) </td></tr>
<tr><td class="paramname">equality_type</td><td>The struct type describing the equality columns </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classiceberg_1_1StructLikeSet.html" title="A set of StructLike rows with type-aware hashing and equality.">StructLikeSet</a> containing the deleted rows </dd></dl>
</div>
</div>
<a id="abb3f9974fdcfe3b36e863264daf6d990" name="abb3f9974fdcfe3b36e863264daf6d990"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb3f9974fdcfe3b36e863264daf6d990">&#9670;&#160;</a></span>LoadPositionDeletes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Result&lt; <a class="el" href="classiceberg_1_1PositionDeleteIndex.html">PositionDeleteIndex</a> &gt; iceberg::DeleteLoader::LoadPositionDeletes </td>
<td>(</td>
<td class="paramtype">std::span&lt; const std::shared_ptr&lt; <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &gt; &gt;&#160;</td>
<td class="paramname"><em>delete_files</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string_view&#160;</td>
<td class="paramname"><em>data_file_path</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Load position deletes for a specific data file. </p>
<p>Reads the given position delete files and returns a <a class="el" href="classiceberg_1_1PositionDeleteIndex.html" title="Tracks deleted row positions using a bitmap.">PositionDeleteIndex</a> containing only the positions that apply to the specified data file path. Supports both regular position delete files and deletion vectors.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">delete_files</td><td>Position delete files to load (must have content == Content::kPositionDeletes) </td></tr>
<tr><td class="paramname">data_file_path</td><td>Path of the data file to filter positions for </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classiceberg_1_1PositionDeleteIndex.html" title="Tracks deleted row positions using a bitmap.">PositionDeleteIndex</a> with deleted positions for the data file </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/data/<a class="el" href="delete__loader_8h_source.html">delete_loader.h</a></li>
<li>iceberg/data/<b>delete_loader.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>