mkdocs/docs/api/structiceberg_1_1ContentFileUtil.html - iceberg-cpp - Git at Google

 <!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::ContentFileUtil Struct 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="structiceberg_1_1ContentFileUtil.html">ContentFileUtil</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
   <div class="summary">
 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
 <a href="structiceberg_1_1ContentFileUtil-members.html">List of all members</a>  </div>
   <div class="headertitle"><div class="title">iceberg::ContentFileUtil Struct Reference</div></div>
 </div><!--header-->
 <div class="contents">

 <p>Utility functions for content files.
  <a href="structiceberg_1_1ContentFileUtil.html#details">More...</a></p>

 <p><code>#include &lt;<a class="el" href="content__file__util_8h_source.html">content_file_util.h</a>&gt;</code></p>
 <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:a77dc50c4dfd80d88442b9795fed20c56" id="r_a77dc50c4dfd80d88442b9795fed20c56"><td class="memItemLeft" align="right" valign="top"><a id="a77dc50c4dfd80d88442b9795fed20c56" name="a77dc50c4dfd80d88442b9795fed20c56"></a>
 static bool&#160;</td><td class="memItemRight" valign="bottom"><b>IsDV</b> (const <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &amp;file)</td></tr>
 <tr class="memdesc:a77dc50c4dfd80d88442b9795fed20c56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a delete file is a deletion vector (DV). <br /></td></tr>
 <tr class="separator:a77dc50c4dfd80d88442b9795fed20c56"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ab447b4b00933c5f63c387194a058cbe4" id="r_ab447b4b00933c5f63c387194a058cbe4"><td class="memItemLeft" align="right" valign="top"><a id="ab447b4b00933c5f63c387194a058cbe4" name="ab447b4b00933c5f63c387194a058cbe4"></a>
 static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::optional&lt; std::string &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>ReferencedDataFile</b> (const <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &amp;file)</td></tr>
 <tr class="memdesc:ab447b4b00933c5f63c387194a058cbe4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the referenced data file path from a position delete file. <br /></td></tr>
 <tr class="separator:ab447b4b00933c5f63c387194a058cbe4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a6b5043ceb272b8a62e66b620f1fb1809" id="r_a6b5043ceb272b8a62e66b620f1fb1809"><td class="memItemLeft" align="right" valign="top"><a id="a6b5043ceb272b8a62e66b620f1fb1809" name="a6b5043ceb272b8a62e66b620f1fb1809"></a>
 static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>IsFileScoped</b> (const <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &amp;file)</td></tr>
 <tr class="memdesc:a6b5043ceb272b8a62e66b620f1fb1809"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a delete file is file-scoped. <br /></td></tr>
 <tr class="separator:a6b5043ceb272b8a62e66b620f1fb1809"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a24300ce96515b0309440f615edf5d91a" id="r_a24300ce96515b0309440f615edf5d91a"><td class="memItemLeft" align="right" valign="top"><a id="a24300ce96515b0309440f615edf5d91a" name="a24300ce96515b0309440f615edf5d91a"></a>
 static bool&#160;</td><td class="memItemRight" valign="bottom"><b>ContainsSingleDV</b> (std::span&lt; const std::shared_ptr&lt; <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &gt; &gt; files)</td></tr>
 <tr class="memdesc:a24300ce96515b0309440f615edf5d91a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a collection of delete files contains exactly one DV. <br /></td></tr>
 <tr class="separator:a24300ce96515b0309440f615edf5d91a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a5824f2b06a46b721226c0e1bbd34cde7" id="r_a5824f2b06a46b721226c0e1bbd34cde7"><td class="memItemLeft" align="right" valign="top"><a id="a5824f2b06a46b721226c0e1bbd34cde7" name="a5824f2b06a46b721226c0e1bbd34cde7"></a>
 static std::string&#160;</td><td class="memItemRight" valign="bottom"><b>DVDesc</b> (const <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &amp;file)</td></tr>
 <tr class="memdesc:a5824f2b06a46b721226c0e1bbd34cde7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a description string for a deletion vector. <br /></td></tr>
 <tr class="separator:a5824f2b06a46b721226c0e1bbd34cde7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aa65b4942e8c6adccff6208982ea43786" id="r_aa65b4942e8c6adccff6208982ea43786"><td class="memItemLeft" align="right" valign="top"><a id="aa65b4942e8c6adccff6208982ea43786" name="aa65b4942e8c6adccff6208982ea43786"></a>
 static int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>ContentSizeInBytes</b> (const <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &amp;file)</td></tr>
 <tr class="memdesc:aa65b4942e8c6adccff6208982ea43786"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size in bytes of the portion of <code>file</code> relevant to a scan task — the DV's own content size when set, otherwise the file's total size. <br /></td></tr>
 <tr class="separator:aa65b4942e8c6adccff6208982ea43786"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a3eeb514fcb4ffc60318f1ba633498e35" id="r_a3eeb514fcb4ffc60318f1ba633498e35"><td class="memItemLeft" align="right" valign="top"><a id="a3eeb514fcb4ffc60318f1ba633498e35" name="a3eeb514fcb4ffc60318f1ba633498e35"></a>
 static void&#160;</td><td class="memItemRight" valign="bottom"><b>DropAllStats</b> (<a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &amp;data_file)</td></tr>
 <tr class="memdesc:a3eeb514fcb4ffc60318f1ba633498e35"><td class="mdescLeft">&#160;</td><td class="mdescRight">In-place drop stats. <br /></td></tr>
 <tr class="separator:a3eeb514fcb4ffc60318f1ba633498e35"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a1aad66b6101a393f68c55c481a0997c3" id="r_a1aad66b6101a393f68c55c481a0997c3"><td class="memItemLeft" align="right" valign="top"><a id="a1aad66b6101a393f68c55c481a0997c3" name="a1aad66b6101a393f68c55c481a0997c3"></a>
 static void&#160;</td><td class="memItemRight" valign="bottom"><b>DropUnselectedStats</b> (<a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &amp;data_file, const std::unordered_set&lt; int32_t &gt; &amp;selected_columns)</td></tr>
 <tr class="memdesc:a1aad66b6101a393f68c55c481a0997c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Preserve stats based on selected columns. <br /></td></tr>
 <tr class="separator:a1aad66b6101a393f68c55c481a0997c3"><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>Utility functions for content files. </p>
 </div><hr/>The documentation for this struct was generated from the following file:<ul>
 <li>iceberg/util/<a class="el" href="content__file__util_8h_source.html">content_file_util.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>
	<!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::ContentFileUtil Struct 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&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&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="structiceberg_1_1ContentFileUtil.html">ContentFileUtil</a></li> </ul>
	</div>
	</div><!-- top -->
	<div class="header">
	<div class="summary">
	<a href="#pub-static-methods">Static Public Member Functions</a> \|
	<a href="structiceberg_1_1ContentFileUtil-members.html">List of all members</a> </div>
	<div class="headertitle"><div class="title">iceberg::ContentFileUtil Struct Reference</div></div>
	</div><!--header-->
	<div class="contents">

	<p>Utility functions for content files.
	<a href="structiceberg_1_1ContentFileUtil.html#details">More...</a></p>

	<p><code>#include <<a class="el" href="content__file__util_8h_source.html">content_file_util.h</a>></code></p>
	<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:a77dc50c4dfd80d88442b9795fed20c56" id="r_a77dc50c4dfd80d88442b9795fed20c56"><td class="memItemLeft" align="right" valign="top"><a id="a77dc50c4dfd80d88442b9795fed20c56" name="a77dc50c4dfd80d88442b9795fed20c56"></a>
	static bool </td><td class="memItemRight" valign="bottom"><b>IsDV</b> (const <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &file)</td></tr>
	<tr class="memdesc:a77dc50c4dfd80d88442b9795fed20c56"><td class="mdescLeft"> </td><td class="mdescRight">Check if a delete file is a deletion vector (DV). <br /></td></tr>
	<tr class="separator:a77dc50c4dfd80d88442b9795fed20c56"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:ab447b4b00933c5f63c387194a058cbe4" id="r_ab447b4b00933c5f63c387194a058cbe4"><td class="memItemLeft" align="right" valign="top"><a id="ab447b4b00933c5f63c387194a058cbe4" name="ab447b4b00933c5f63c387194a058cbe4"></a>
	static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::optional< std::string > > </td><td class="memItemRight" valign="bottom"><b>ReferencedDataFile</b> (const <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &file)</td></tr>
	<tr class="memdesc:ab447b4b00933c5f63c387194a058cbe4"><td class="mdescLeft"> </td><td class="mdescRight">Get the referenced data file path from a position delete file. <br /></td></tr>
	<tr class="separator:ab447b4b00933c5f63c387194a058cbe4"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a6b5043ceb272b8a62e66b620f1fb1809" id="r_a6b5043ceb272b8a62e66b620f1fb1809"><td class="memItemLeft" align="right" valign="top"><a id="a6b5043ceb272b8a62e66b620f1fb1809" name="a6b5043ceb272b8a62e66b620f1fb1809"></a>
	static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< bool > </td><td class="memItemRight" valign="bottom"><b>IsFileScoped</b> (const <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &file)</td></tr>
	<tr class="memdesc:a6b5043ceb272b8a62e66b620f1fb1809"><td class="mdescLeft"> </td><td class="mdescRight">Check if a delete file is file-scoped. <br /></td></tr>
	<tr class="separator:a6b5043ceb272b8a62e66b620f1fb1809"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a24300ce96515b0309440f615edf5d91a" id="r_a24300ce96515b0309440f615edf5d91a"><td class="memItemLeft" align="right" valign="top"><a id="a24300ce96515b0309440f615edf5d91a" name="a24300ce96515b0309440f615edf5d91a"></a>
	static bool </td><td class="memItemRight" valign="bottom"><b>ContainsSingleDV</b> (std::span< const std::shared_ptr< <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> > > files)</td></tr>
	<tr class="memdesc:a24300ce96515b0309440f615edf5d91a"><td class="mdescLeft"> </td><td class="mdescRight">Check if a collection of delete files contains exactly one DV. <br /></td></tr>
	<tr class="separator:a24300ce96515b0309440f615edf5d91a"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a5824f2b06a46b721226c0e1bbd34cde7" id="r_a5824f2b06a46b721226c0e1bbd34cde7"><td class="memItemLeft" align="right" valign="top"><a id="a5824f2b06a46b721226c0e1bbd34cde7" name="a5824f2b06a46b721226c0e1bbd34cde7"></a>
	static std::string </td><td class="memItemRight" valign="bottom"><b>DVDesc</b> (const <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &file)</td></tr>
	<tr class="memdesc:a5824f2b06a46b721226c0e1bbd34cde7"><td class="mdescLeft"> </td><td class="mdescRight">Generate a description string for a deletion vector. <br /></td></tr>
	<tr class="separator:a5824f2b06a46b721226c0e1bbd34cde7"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:aa65b4942e8c6adccff6208982ea43786" id="r_aa65b4942e8c6adccff6208982ea43786"><td class="memItemLeft" align="right" valign="top"><a id="aa65b4942e8c6adccff6208982ea43786" name="aa65b4942e8c6adccff6208982ea43786"></a>
	static int64_t </td><td class="memItemRight" valign="bottom"><b>ContentSizeInBytes</b> (const <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &file)</td></tr>
	<tr class="memdesc:aa65b4942e8c6adccff6208982ea43786"><td class="mdescLeft"> </td><td class="mdescRight">Size in bytes of the portion of <code>file</code> relevant to a scan task — the DV's own content size when set, otherwise the file's total size. <br /></td></tr>
	<tr class="separator:aa65b4942e8c6adccff6208982ea43786"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a3eeb514fcb4ffc60318f1ba633498e35" id="r_a3eeb514fcb4ffc60318f1ba633498e35"><td class="memItemLeft" align="right" valign="top"><a id="a3eeb514fcb4ffc60318f1ba633498e35" name="a3eeb514fcb4ffc60318f1ba633498e35"></a>
	static void </td><td class="memItemRight" valign="bottom"><b>DropAllStats</b> (<a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &data_file)</td></tr>
	<tr class="memdesc:a3eeb514fcb4ffc60318f1ba633498e35"><td class="mdescLeft"> </td><td class="mdescRight">In-place drop stats. <br /></td></tr>
	<tr class="separator:a3eeb514fcb4ffc60318f1ba633498e35"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a1aad66b6101a393f68c55c481a0997c3" id="r_a1aad66b6101a393f68c55c481a0997c3"><td class="memItemLeft" align="right" valign="top"><a id="a1aad66b6101a393f68c55c481a0997c3" name="a1aad66b6101a393f68c55c481a0997c3"></a>
	static void </td><td class="memItemRight" valign="bottom"><b>DropUnselectedStats</b> (<a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &data_file, const std::unordered_set< int32_t > &selected_columns)</td></tr>
	<tr class="memdesc:a1aad66b6101a393f68c55c481a0997c3"><td class="mdescLeft"> </td><td class="mdescRight">Preserve stats based on selected columns. <br /></td></tr>
	<tr class="separator:a1aad66b6101a393f68c55c481a0997c3"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
	<div class="textblock"><p>Utility functions for content files. </p>
	</div><hr/>The documentation for this struct was generated from the following file:<ul>
	<li>iceberg/util/<a class="el" href="content__file__util_8h_source.html">content_file_util.h</a></li>
	</ul>
	</div><!-- contents -->
	<!-- start footer part -->
	<hr class="footer"/><address class="footer"><small>
	Generated by <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>