Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/name__mapping_8h.html
blob: f43876950fc42b4b420838962eacee0d441df1a4 [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/name_mapping.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="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">name_mapping.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Define schema name mapping APIs.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;functional&gt;</code><br />
<code>#include &lt;map&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &lt;optional&gt;</code><br />
<code>#include &lt;span&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;unordered_map&gt;</code><br />
<code>#include &lt;unordered_set&gt;</code><br />
<code>#include &lt;vector&gt;</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="schema_8h_source.html">iceberg/schema.h</a>&quot;</code><br />
</div>
<p><a href="name__mapping_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_1MappedField.html">iceberg::MappedField</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An immutable mapping between a field ID and a set of names. <a href="structiceberg_1_1MappedField.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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1MappedFields.html">iceberg::MappedFields</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A list of field mappings for child field of structs, maps, and lists. <a href="classiceberg_1_1MappedFields.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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1NameMapping.html">iceberg::NameMapping</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a mapping from external schema names to Iceberg type IDs. <a href="classiceberg_1_1NameMapping.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="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ad5bb43cad4c733b1692c2038be9f40fd" id="r_ad5bb43cad4c733b1692c2038be9f40fd"><td class="memItemLeft" align="right" valign="top"><a id="ad5bb43cad4c733b1692c2038be9f40fd" name="ad5bb43cad4c733b1692c2038be9f40fd"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::MappedFieldConstRef</b> = std::reference_wrapper&lt; const <a class="el" href="structiceberg_1_1MappedField.html">MappedField</a> &gt;</td></tr>
<tr class="separator:ad5bb43cad4c733b1692c2038be9f40fd"><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:a8b947fc7280e03e5838d4e7ea88cf429" id="r_a8b947fc7280e03e5838d4e7ea88cf429"><td class="memItemLeft" align="right" valign="top"><a id="a8b947fc7280e03e5838d4e7ea88cf429" name="a8b947fc7280e03e5838d4e7ea88cf429"></a>
ICEBERG_EXPORT std::string&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::ToString</b> (const <a class="el" href="structiceberg_1_1MappedField.html">MappedField</a> &amp;field)</td></tr>
<tr class="separator:a8b947fc7280e03e5838d4e7ea88cf429"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aade3fc3730f324faa39e06e6050a48c5" id="r_aade3fc3730f324faa39e06e6050a48c5"><td class="memItemLeft" align="right" valign="top"><a id="aade3fc3730f324faa39e06e6050a48c5" name="aade3fc3730f324faa39e06e6050a48c5"></a>
ICEBERG_EXPORT std::string&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::ToString</b> (const <a class="el" href="classiceberg_1_1MappedFields.html">MappedFields</a> &amp;fields)</td></tr>
<tr class="separator:aade3fc3730f324faa39e06e6050a48c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c5188c02caef30056d973ab0836798c" id="r_a1c5188c02caef30056d973ab0836798c"><td class="memItemLeft" align="right" valign="top"><a id="a1c5188c02caef30056d973ab0836798c" name="a1c5188c02caef30056d973ab0836798c"></a>
ICEBERG_EXPORT std::string&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::ToString</b> (const <a class="el" href="classiceberg_1_1NameMapping.html">NameMapping</a> &amp;mapping)</td></tr>
<tr class="separator:a1c5188c02caef30056d973ab0836798c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44f19b655883ab0f951ee133a641a932" id="r_a44f19b655883ab0f951ee133a641a932"><td class="memItemLeft" align="right" valign="top">ICEBERG_EXPORT <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1NameMapping.html">NameMapping</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html#a44f19b655883ab0f951ee133a641a932">iceberg::CreateMapping</a> (const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &amp;schema)</td></tr>
<tr class="memdesc:a44f19b655883ab0f951ee133a641a932"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a name-based mapping for a schema. <br /></td></tr>
<tr class="separator:a44f19b655883ab0f951ee133a641a932"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ed6c89ed6d5a75e604fd05d4abb1d8a" id="r_a1ed6c89ed6d5a75e604fd05d4abb1d8a"><td class="memItemLeft" align="right" valign="top">ICEBERG_EXPORT <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1NameMapping.html">NameMapping</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html#a1ed6c89ed6d5a75e604fd05d4abb1d8a">iceberg::UpdateMapping</a> (const <a class="el" href="classiceberg_1_1NameMapping.html">NameMapping</a> &amp;mapping, const std::unordered_map&lt; int32_t, std::shared_ptr&lt; <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> &gt; &gt; &amp;updates, const std::multimap&lt; int32_t, int32_t &gt; &amp;adds)</td></tr>
<tr class="memdesc:a1ed6c89ed6d5a75e604fd05d4abb1d8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update a name-based mapping using changes to a schema. <br /></td></tr>
<tr class="separator:a1ed6c89ed6d5a75e604fd05d4abb1d8a"><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>Define schema name mapping APIs. </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>