blob: b8037fb91021a97e495f124955e8a71e1b64a312 [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::DVWriter 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"><a class="el" href="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1DVWriter.html">DVWriter</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="classiceberg_1_1DVWriter-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::DVWriter Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A deletion vector file writer.
<a href="classiceberg_1_1DVWriter.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="dv__writer_8h_source.html">dv_writer.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:ab7b684203a718277301567792edaa73e" id="r_ab7b684203a718277301567792edaa73e"><td class="memItemLeft" align="right" valign="top"><a id="ab7b684203a718277301567792edaa73e" name="ab7b684203a718277301567792edaa73e"></a>
Status&#160;</td><td class="memItemRight" valign="bottom"><b>Delete</b> (std::string_view referenced_data_file, int64_t pos, const std::shared_ptr&lt; <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> &gt; &amp;spec, const <a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a> &amp;partition)</td></tr>
<tr class="memdesc:ab7b684203a718277301567792edaa73e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark a row position as deleted for the given data file. <br /></td></tr>
<tr class="separator:ab7b684203a718277301567792edaa73e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a402b414dda0c2e7f9cf2204a7143af9d" id="r_a402b414dda0c2e7f9cf2204a7143af9d"><td class="memItemLeft" align="right" valign="top"><a id="a402b414dda0c2e7f9cf2204a7143af9d" name="a402b414dda0c2e7f9cf2204a7143af9d"></a>
Status&#160;</td><td class="memItemRight" valign="bottom"><b>Delete</b> (std::string_view referenced_data_file, const <a class="el" href="classiceberg_1_1PositionDeleteIndex.html">PositionDeleteIndex</a> &amp;positions, const std::shared_ptr&lt; <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> &gt; &amp;spec, const <a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a> &amp;partition)</td></tr>
<tr class="memdesc:a402b414dda0c2e7f9cf2204a7143af9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark all positions in the given index as deleted for a data file. <br /></td></tr>
<tr class="separator:a402b414dda0c2e7f9cf2204a7143af9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4781afb358f98ac2709bc9e055bcf19" id="r_aa4781afb358f98ac2709bc9e055bcf19"><td class="memItemLeft" align="right" valign="top"><a id="aa4781afb358f98ac2709bc9e055bcf19" name="aa4781afb358f98ac2709bc9e055bcf19"></a>
Status&#160;</td><td class="memItemRight" valign="bottom"><b>Close</b> ()</td></tr>
<tr class="memdesc:aa4781afb358f98ac2709bc9e055bcf19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write all accumulated deletion vectors to the Puffin file and close. <br /></td></tr>
<tr class="separator:aa4781afb358f98ac2709bc9e055bcf19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a255b4d35acdf38028e714d3c0ae00e3b" id="r_a255b4d35acdf38028e714d3c0ae00e3b"><td class="memItemLeft" align="right" valign="top"><a id="a255b4d35acdf38028e714d3c0ae00e3b" name="a255b4d35acdf38028e714d3c0ae00e3b"></a>
<a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; <a class="el" href="structiceberg_1_1DeleteWriteResult.html">DeleteWriteResult</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Metadata</b> ()</td></tr>
<tr class="memdesc:a255b4d35acdf38028e714d3c0ae00e3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The result of writing; valid only after <a class="el" href="classiceberg_1_1DVWriter.html#aa4781afb358f98ac2709bc9e055bcf19" title="Write all accumulated deletion vectors to the Puffin file and close.">Close()</a>. <br /></td></tr>
<tr class="separator:a255b4d35acdf38028e714d3c0ae00e3b"><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:a724fca0df9e577b6cf5c17421292793e" id="r_a724fca0df9e577b6cf5c17421292793e"><td class="memItemLeft" align="right" valign="top"><a id="a724fca0df9e577b6cf5c17421292793e" name="a724fca0df9e577b6cf5c17421292793e"></a>
static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1DVWriter.html">DVWriter</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Make</b> (<a class="el" href="structiceberg_1_1DVWriterOptions.html">DVWriterOptions</a> options)</td></tr>
<tr class="memdesc:a724fca0df9e577b6cf5c17421292793e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="classiceberg_1_1DVWriter.html" title="A deletion vector file writer.">DVWriter</a>. <br /></td></tr>
<tr class="separator:a724fca0df9e577b6cf5c17421292793e"><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 deletion vector file writer. </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/deletes/<a class="el" href="dv__writer_8h_source.html">dv_writer.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>