blob: f6e82e742393c5a5a554aa1c81c3a286e96970f5 [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/schema_util.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_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">schema_util.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Provide schema projection utilities.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;memory&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;variant&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &quot;<a class="el" href="literal_8h_source.html">iceberg/expression/literal.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="iceberg__export_8h_source.html">iceberg/iceberg_export.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="result_8h_source.html">iceberg/result.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="type__fwd_8h_source.html">iceberg/type_fwd.h</a>&quot;</code><br />
</div>
<p><a href="schema__util_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_1FieldProjection.html">iceberg::FieldProjection</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A field schema partner to carry projection information. <a href="structiceberg_1_1FieldProjection.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1FieldProjection_1_1ExtraAttributes.html">iceberg::FieldProjection::ExtraAttributes</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Format-specific attributes for the field. For example, for Parquet it might store column id and level info of the projected leaf field. <a href="structiceberg_1_1FieldProjection_1_1ExtraAttributes.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1SchemaProjection.html">iceberg::SchemaProjection</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A schema partner to carry projection information. <a href="structiceberg_1_1SchemaProjection.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="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceiceberg" id="r_namespaceiceberg"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html">iceberg</a></td></tr>
<tr class="memdesc:namespaceiceberg"><td class="mdescLeft">&#160;</td><td class="mdescRight">Core Apache Iceberg C++ APIs. <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:a3b1a267c8d95870654d74edee09e7b7e" id="r_a3b1a267c8d95870654d74edee09e7b7e"><td class="memItemLeft" align="right" valign="top">ICEBERG_EXPORT <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; <a class="el" href="structiceberg_1_1SchemaProjection.html">SchemaProjection</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html#a3b1a267c8d95870654d74edee09e7b7e">iceberg::Project</a> (const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &amp;expected_schema, const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &amp;source_schema, bool prune_source)</td></tr>
<tr class="memdesc:a3b1a267c8d95870654d74edee09e7b7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Project the expected schema on top of the source schema. <br /></td></tr>
<tr class="separator:a3b1a267c8d95870654d74edee09e7b7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40720e1964ff41e9f0600d3aa5d13bd4" id="r_a40720e1964ff41e9f0600d3aa5d13bd4"><td class="memItemLeft" align="right" valign="top"><a id="a40720e1964ff41e9f0600d3aa5d13bd4" name="a40720e1964ff41e9f0600d3aa5d13bd4"></a>
ICEBERG_EXPORT std::string_view&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::ToString</b> (<a class="el" href="structiceberg_1_1FieldProjection.html#a99745e34381f167e29f057e2045942ad">FieldProjection::Kind</a> kind)</td></tr>
<tr class="separator:a40720e1964ff41e9f0600d3aa5d13bd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc5585154c243c8c4768579c6f673a0f" id="r_adc5585154c243c8c4768579c6f673a0f"><td class="memItemLeft" align="right" valign="top"><a id="adc5585154c243c8c4768579c6f673a0f" name="adc5585154c243c8c4768579c6f673a0f"></a>
ICEBERG_EXPORT std::string&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::ToString</b> (const <a class="el" href="structiceberg_1_1FieldProjection.html">FieldProjection</a> &amp;projection)</td></tr>
<tr class="separator:adc5585154c243c8c4768579c6f673a0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ad85dcbbd6c926ff5b6946863c04327" id="r_a0ad85dcbbd6c926ff5b6946863c04327"><td class="memItemLeft" align="right" valign="top"><a id="a0ad85dcbbd6c926ff5b6946863c04327" name="a0ad85dcbbd6c926ff5b6946863c04327"></a>
ICEBERG_EXPORT std::string&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::ToString</b> (const <a class="el" href="structiceberg_1_1SchemaProjection.html">SchemaProjection</a> &amp;projection)</td></tr>
<tr class="separator:a0ad85dcbbd6c926ff5b6946863c04327"><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>Provide schema projection utilities. </p>
</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>