Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./api/metadata__column__util__internal_8h.html
blob: 48edd127ce21aca016b85cd68a673f6c98d822f6 [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/arrow/metadata_column_util_internal.h File 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="dir_f51fe74ea6bc2b1b900619895eaa63be.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_f4d027612078328dc1681a60f28d52c0.html">arrow</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">metadata_column_util_internal.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;cstdint&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;arrow/type_fwd.h&gt;</code><br />
<code>#include &quot;iceberg/result.h&quot;</code><br />
</div>
<p><a href="metadata__column__util__internal_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1arrow_1_1MetadataColumnContext.html">iceberg::arrow::MetadataColumnContext</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Context for populating metadata columns during reading. <a href="structiceberg_1_1arrow_1_1MetadataColumnContext.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ac4fb744e0e7a79fd72afce17641fe57b" id="r_ac4fb744e0e7a79fd72afce17641fe57b"><td class="memItemLeft" align="right" valign="top">Result&lt; std::shared_ptr&lt;::arrow::Array &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="metadata__column__util_8cc.html#ac4fb744e0e7a79fd72afce17641fe57b">iceberg::arrow::MakeFilePathArray</a> (const std::string &amp;file_path, int64_t num_rows, ::arrow::MemoryPool *pool)</td></tr>
<tr class="memdesc:ac4fb744e0e7a79fd72afce17641fe57b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a constant string array for _file column. <br /></td></tr>
<tr class="separator:ac4fb744e0e7a79fd72afce17641fe57b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ab51cdcc6d48ed5c3f15f3b25baf815" id="r_a2ab51cdcc6d48ed5c3f15f3b25baf815"><td class="memItemLeft" align="right" valign="top">Result&lt; std::shared_ptr&lt;::arrow::Array &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="metadata__column__util_8cc.html#a2ab51cdcc6d48ed5c3f15f3b25baf815">iceberg::arrow::MakeRowPositionArray</a> (int64_t start_position, int64_t num_rows, ::arrow::MemoryPool *pool)</td></tr>
<tr class="memdesc:a2ab51cdcc6d48ed5c3f15f3b25baf815"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a sequential int64 array for _pos column. <br /></td></tr>
<tr class="separator:a2ab51cdcc6d48ed5c3f15f3b25baf815"><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 populating metadata columns (_file and _pos) in readers. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ac4fb744e0e7a79fd72afce17641fe57b" name="ac4fb744e0e7a79fd72afce17641fe57b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4fb744e0e7a79fd72afce17641fe57b">&#9670;&#160;</a></span>MakeFilePathArray()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Result&lt; std::shared_ptr&lt;::arrow::Array &gt; &gt; iceberg::arrow::MakeFilePathArray </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>file_path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>num_rows</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">::arrow::MemoryPool *&#160;</td>
<td class="paramname"><em>pool</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a constant string array for _file column. </p>
<p>Creates an Arrow StringArray where all values are the same file path string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_path</td><td>The file path value. </td></tr>
<tr><td class="paramname">num_rows</td><td>Number of rows in the batch. </td></tr>
<tr><td class="paramname">pool</td><td>Arrow memory pool. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Arrow StringArray with constant file_path value. </dd></dl>
</div>
</div>
<a id="a2ab51cdcc6d48ed5c3f15f3b25baf815" name="a2ab51cdcc6d48ed5c3f15f3b25baf815"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ab51cdcc6d48ed5c3f15f3b25baf815">&#9670;&#160;</a></span>MakeRowPositionArray()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Result&lt; std::shared_ptr&lt;::arrow::Array &gt; &gt; iceberg::arrow::MakeRowPositionArray </td>
<td>(</td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>start_position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>num_rows</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">::arrow::MemoryPool *&#160;</td>
<td class="paramname"><em>pool</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a sequential int64 array for _pos column. </p>
<p>Creates an Arrow Int64Array with sequential values starting from start_position.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">start_position</td><td>Starting row position (inclusive). </td></tr>
<tr><td class="paramname">num_rows</td><td>Number of rows in the batch. </td></tr>
<tr><td class="paramname">pool</td><td>Arrow memory pool. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Arrow Int64Array with values [start_position, start_position + num_rows). </dd></dl>
</div>
</div>
</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>