| <!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 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&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"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1Schema.html">Schema</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="#friends">Friends</a> | |
| <a href="classiceberg_1_1Schema-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::Schema Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A schema for a <a class="el" href="classiceberg_1_1Table.html" title="Represents an Iceberg table.">Table</a>. |
| <a href="classiceberg_1_1Schema.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="schema_8h_source.html">schema.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::Schema:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1Schema.png" usemap="#iceberg::Schema_map" alt=""/> |
| <map id="iceberg::Schema_map" name="iceberg::Schema_map"> |
| <area href="classiceberg_1_1StructType.html" title="A data type representing a struct with nested fields." alt="iceberg::StructType" shape="rect" coords="0,168,149,192"/> |
| <area href="classiceberg_1_1NestedType.html" title="A data type that has child fields." alt="iceberg::NestedType" shape="rect" coords="0,112,149,136"/> |
| <area href="classiceberg_1_1Type.html" title="Interface for a data type for a field." alt="iceberg::Type" shape="rect" coords="0,56,149,80"/> |
| <area href="classiceberg_1_1util_1_1Formattable.html" title="Interface for objects that can be formatted via std::format." alt="iceberg::util::Formattable" shape="rect" coords="0,0,149,24"/> |
| </map> |
| </div></div> |
| <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:a747c14b624cf7db75a33cc42d98b18c9" id="r_a747c14b624cf7db75a33cc42d98b18c9"><td class="memItemLeft" align="right" valign="top"><a id="a747c14b624cf7db75a33cc42d98b18c9" name="a747c14b624cf7db75a33cc42d98b18c9"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>Schema</b> (std::vector< <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> > <a class="el" href="classiceberg_1_1StructType.html#a450d536bde2a559ac3781cd6c5ebc719">fields</a>, int32_t <a class="el" href="classiceberg_1_1Schema.html#a74844202dab943691671e5d40bcf3f72">schema_id</a>=kInitialSchemaId)</td></tr> |
| <tr class="separator:a747c14b624cf7db75a33cc42d98b18c9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a74844202dab943691671e5d40bcf3f72" id="r_a74844202dab943691671e5d40bcf3f72"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Schema.html#a74844202dab943691671e5d40bcf3f72">schema_id</a> () const</td></tr> |
| <tr class="memdesc:a74844202dab943691671e5d40bcf3f72"><td class="mdescLeft"> </td><td class="mdescRight">Get the schema ID. <br /></td></tr> |
| <tr class="separator:a74844202dab943691671e5d40bcf3f72"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0dc4ba1d458b21509013a1b3ad388f09" id="r_a0dc4ba1d458b21509013a1b3ad388f09"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Schema.html#a0dc4ba1d458b21509013a1b3ad388f09">ToString</a> () const override</td></tr> |
| <tr class="memdesc:a0dc4ba1d458b21509013a1b3ad388f09"><td class="mdescLeft"> </td><td class="mdescRight">Get a user-readable string representation. <br /></td></tr> |
| <tr class="separator:a0dc4ba1d458b21509013a1b3ad388f09"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4db920889e6f3fb26a17361e9e2c382c" id="r_a4db920889e6f3fb26a17361e9e2c382c"><td class="memItemLeft" align="right" valign="top">Result< std::optional< std::reference_wrapper< const <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> > > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Schema.html#a4db920889e6f3fb26a17361e9e2c382c">FindFieldByName</a> (std::string_view name, bool case_sensitive=true) const</td></tr> |
| <tr class="memdesc:a4db920889e6f3fb26a17361e9e2c382c"><td class="mdescLeft"> </td><td class="mdescRight">Recursively find the <a class="el" href="classiceberg_1_1SchemaField.html" title="A type combined with a name.">SchemaField</a> by field name. <br /></td></tr> |
| <tr class="separator:a4db920889e6f3fb26a17361e9e2c382c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8ad01359cfbc11d0d018d30615cbdf1a" id="r_a8ad01359cfbc11d0d018d30615cbdf1a"><td class="memItemLeft" align="right" valign="top">Result< std::optional< std::reference_wrapper< const <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> > > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Schema.html#a8ad01359cfbc11d0d018d30615cbdf1a">FindFieldById</a> (int32_t field_id) const</td></tr> |
| <tr class="memdesc:a8ad01359cfbc11d0d018d30615cbdf1a"><td class="mdescLeft"> </td><td class="mdescRight">Recursively find the <a class="el" href="classiceberg_1_1SchemaField.html" title="A type combined with a name.">SchemaField</a> by field id. <br /></td></tr> |
| <tr class="separator:a8ad01359cfbc11d0d018d30615cbdf1a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4cacef30daaff6ac57d50fc617f0db96" id="r_a4cacef30daaff6ac57d50fc617f0db96"><td class="memItemLeft" align="right" valign="top">Result< std::optional< std::string_view > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Schema.html#a4cacef30daaff6ac57d50fc617f0db96">FindColumnNameById</a> (int32_t field_id) const</td></tr> |
| <tr class="memdesc:a4cacef30daaff6ac57d50fc617f0db96"><td class="mdescLeft"> </td><td class="mdescRight">Returns the canonical field name for the given id. <br /></td></tr> |
| <tr class="separator:a4cacef30daaff6ac57d50fc617f0db96"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab519cd9bf2437f45bc9db98336a55c52" id="r_ab519cd9bf2437f45bc9db98336a55c52"><td class="memItemLeft" align="right" valign="top">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1StructLikeAccessor.html">StructLikeAccessor</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Schema.html#ab519cd9bf2437f45bc9db98336a55c52">GetAccessorById</a> (int32_t field_id) const</td></tr> |
| <tr class="memdesc:ab519cd9bf2437f45bc9db98336a55c52"><td class="mdescLeft"> </td><td class="mdescRight">Get the accessor to access the field by field id. <br /></td></tr> |
| <tr class="separator:ab519cd9bf2437f45bc9db98336a55c52"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1a2d0f2c8770c303e6fb59d0101d48cd" id="r_a1a2d0f2c8770c303e6fb59d0101d48cd"><td class="memItemLeft" align="right" valign="top">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Schema.html#a1a2d0f2c8770c303e6fb59d0101d48cd">Select</a> (std::span< const std::string > names, bool case_sensitive=true) const</td></tr> |
| <tr class="memdesc:a1a2d0f2c8770c303e6fb59d0101d48cd"><td class="mdescLeft"> </td><td class="mdescRight">Creates a projected schema from selected field names. <br /></td></tr> |
| <tr class="separator:a1a2d0f2c8770c303e6fb59d0101d48cd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a29b8bda082c94f3c5cbe7db451245ece" id="r_a29b8bda082c94f3c5cbe7db451245ece"><td class="memItemLeft" align="right" valign="top">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Schema.html#a29b8bda082c94f3c5cbe7db451245ece">Project</a> (const std::unordered_set< int32_t > &field_ids) const</td></tr> |
| <tr class="memdesc:a29b8bda082c94f3c5cbe7db451245ece"><td class="mdescLeft"> </td><td class="mdescRight">Creates a projected schema from selected field IDs. <br /></td></tr> |
| <tr class="separator:a29b8bda082c94f3c5cbe7db451245ece"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa2498adcc7ace7b838d9d6273b1b2842" id="r_aa2498adcc7ace7b838d9d6273b1b2842"><td class="memItemLeft" align="right" valign="top"><a id="aa2498adcc7ace7b838d9d6273b1b2842" name="aa2498adcc7ace7b838d9d6273b1b2842"></a> |
| const std::vector< int32_t > & </td><td class="memItemRight" valign="bottom"><b>IdentifierFieldIds</b> () const</td></tr> |
| <tr class="memdesc:aa2498adcc7ace7b838d9d6273b1b2842"><td class="mdescLeft"> </td><td class="mdescRight">Return the field IDs of the identifier fields. <br /></td></tr> |
| <tr class="separator:aa2498adcc7ace7b838d9d6273b1b2842"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a78a9542cedee0edcc6a031b0f41384e0" id="r_a78a9542cedee0edcc6a031b0f41384e0"><td class="memItemLeft" align="right" valign="top"><a id="a78a9542cedee0edcc6a031b0f41384e0" name="a78a9542cedee0edcc6a031b0f41384e0"></a> |
| Result< std::vector< std::string > > </td><td class="memItemRight" valign="bottom"><b>IdentifierFieldNames</b> () const</td></tr> |
| <tr class="memdesc:a78a9542cedee0edcc6a031b0f41384e0"><td class="mdescLeft"> </td><td class="mdescRight">Return the canonical field names of the identifier fields. <br /></td></tr> |
| <tr class="separator:a78a9542cedee0edcc6a031b0f41384e0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af45ff02c07de236324ea0e6cb600c8f8" id="r_af45ff02c07de236324ea0e6cb600c8f8"><td class="memItemLeft" align="right" valign="top">Result< int32_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Schema.html#af45ff02c07de236324ea0e6cb600c8f8">HighestFieldId</a> () const</td></tr> |
| <tr class="memdesc:af45ff02c07de236324ea0e6cb600c8f8"><td class="mdescLeft"> </td><td class="mdescRight">Get the highest field ID in the schema. <br /></td></tr> |
| <tr class="separator:af45ff02c07de236324ea0e6cb600c8f8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5e343e652b2bddb8fd7cc1b0aa8bef8a" id="r_a5e343e652b2bddb8fd7cc1b0aa8bef8a"><td class="memItemLeft" align="right" valign="top"><a id="a5e343e652b2bddb8fd7cc1b0aa8bef8a" name="a5e343e652b2bddb8fd7cc1b0aa8bef8a"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>SameSchema</b> (const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &other) const</td></tr> |
| <tr class="memdesc:a5e343e652b2bddb8fd7cc1b0aa8bef8a"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether this schema is equivalent to another schema while ignoring the schema id. <br /></td></tr> |
| <tr class="separator:a5e343e652b2bddb8fd7cc1b0aa8bef8a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4fa72378d68d58c188362e265950dcb0" id="r_a4fa72378d68d58c188362e265950dcb0"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Schema.html#a4fa72378d68d58c188362e265950dcb0">Validate</a> (int32_t format_version) const</td></tr> |
| <tr class="memdesc:a4fa72378d68d58c188362e265950dcb0"><td class="mdescLeft"> </td><td class="mdescRight">Validate the schema for a given format version. <br /></td></tr> |
| <tr class="separator:a4fa72378d68d58c188362e265950dcb0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classiceberg_1_1StructType"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1StructType')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classiceberg_1_1StructType.html">iceberg::StructType</a></td></tr> |
| <tr class="memitem:ae302f07109f0f1a519653e43fc745032 inherit pub_methods_classiceberg_1_1StructType" id="r_ae302f07109f0f1a519653e43fc745032"><td class="memItemLeft" align="right" valign="top"> |
|  </td><td class="memItemRight" valign="bottom"><b>StructType</b> (std::vector< <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> > <a class="el" href="classiceberg_1_1StructType.html#a450d536bde2a559ac3781cd6c5ebc719">fields</a>)</td></tr> |
| <tr class="separator:ae302f07109f0f1a519653e43fc745032 inherit pub_methods_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1281cfc082575d9656a1e72ba07bdbd1 inherit pub_methods_classiceberg_1_1StructType" id="r_a1281cfc082575d9656a1e72ba07bdbd1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="type__fwd_8h.html#afd7801064886b233ca23eadf5ba2c1b8">TypeId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1StructType.html#a1281cfc082575d9656a1e72ba07bdbd1">type_id</a> () const override</td></tr> |
| <tr class="memdesc:a1281cfc082575d9656a1e72ba07bdbd1 inherit pub_methods_classiceberg_1_1StructType"><td class="mdescLeft"> </td><td class="mdescRight">Get the type ID. <br /></td></tr> |
| <tr class="separator:a1281cfc082575d9656a1e72ba07bdbd1 inherit pub_methods_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5f17aa7e1e75de4893b77f0ad574cb58 inherit pub_methods_classiceberg_1_1StructType" id="r_a5f17aa7e1e75de4893b77f0ad574cb58"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1StructType.html#a5f17aa7e1e75de4893b77f0ad574cb58">ToString</a> () const override</td></tr> |
| <tr class="memdesc:a5f17aa7e1e75de4893b77f0ad574cb58 inherit pub_methods_classiceberg_1_1StructType"><td class="mdescLeft"> </td><td class="mdescRight">Get a user-readable string representation. <br /></td></tr> |
| <tr class="separator:a5f17aa7e1e75de4893b77f0ad574cb58 inherit pub_methods_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a450d536bde2a559ac3781cd6c5ebc719 inherit pub_methods_classiceberg_1_1StructType" id="r_a450d536bde2a559ac3781cd6c5ebc719"><td class="memItemLeft" align="right" valign="top">std::span< const <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1StructType.html#a450d536bde2a559ac3781cd6c5ebc719">fields</a> () const override</td></tr> |
| <tr class="memdesc:a450d536bde2a559ac3781cd6c5ebc719 inherit pub_methods_classiceberg_1_1StructType"><td class="mdescLeft"> </td><td class="mdescRight">Get a view of the child fields. <br /></td></tr> |
| <tr class="separator:a450d536bde2a559ac3781cd6c5ebc719 inherit pub_methods_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a29472346ff0ab4cd57b6bbebe2168d52 inherit pub_methods_classiceberg_1_1StructType" id="r_a29472346ff0ab4cd57b6bbebe2168d52"><td class="memItemLeft" align="right" valign="top">Result< std::optional< SchemaFieldConstRef > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1StructType.html#a29472346ff0ab4cd57b6bbebe2168d52">GetFieldById</a> (int32_t field_id) const override</td></tr> |
| <tr class="memdesc:a29472346ff0ab4cd57b6bbebe2168d52 inherit pub_methods_classiceberg_1_1StructType"><td class="mdescLeft"> </td><td class="mdescRight">Get a field by field ID. <br /></td></tr> |
| <tr class="separator:a29472346ff0ab4cd57b6bbebe2168d52 inherit pub_methods_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6839caa3cd828fc09282e9cf4f6b69cd inherit pub_methods_classiceberg_1_1StructType" id="r_a6839caa3cd828fc09282e9cf4f6b69cd"><td class="memItemLeft" align="right" valign="top">Result< std::optional< SchemaFieldConstRef > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1StructType.html#a6839caa3cd828fc09282e9cf4f6b69cd">GetFieldByIndex</a> (int32_t index) const override</td></tr> |
| <tr class="memdesc:a6839caa3cd828fc09282e9cf4f6b69cd inherit pub_methods_classiceberg_1_1StructType"><td class="mdescLeft"> </td><td class="mdescRight">Get a field by index. <br /></td></tr> |
| <tr class="separator:a6839caa3cd828fc09282e9cf4f6b69cd inherit pub_methods_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3fd3403e743eba662f0ed50681e015b4 inherit pub_methods_classiceberg_1_1StructType" id="r_a3fd3403e743eba662f0ed50681e015b4"><td class="memItemLeft" align="right" valign="top">Result< std::optional< SchemaFieldConstRef > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1StructType.html#a3fd3403e743eba662f0ed50681e015b4">GetFieldByName</a> (std::string_view name, bool case_sensitive) const override</td></tr> |
| <tr class="memdesc:a3fd3403e743eba662f0ed50681e015b4 inherit pub_methods_classiceberg_1_1StructType"><td class="mdescLeft"> </td><td class="mdescRight">Get a field by name. Return an error Status if the field name is not unique; prefer GetFieldById or GetFieldByIndex when possible. <br /></td></tr> |
| <tr class="separator:a3fd3403e743eba662f0ed50681e015b4 inherit pub_methods_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a65f155223e50ca85d206e50ceee928b8 inherit pub_methods_classiceberg_1_1StructType" id="r_a65f155223e50ca85d206e50ceee928b8"><td class="memItemLeft" align="right" valign="top"> |
| std::unique_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > </td><td class="memItemRight" valign="bottom"><b>ToSchema</b> () const</td></tr> |
| <tr class="separator:a65f155223e50ca85d206e50ceee928b8 inherit pub_methods_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2213c2a9f6606cfc7276faac253d8753 inherit pub_methods_classiceberg_1_1StructType" id="r_a2213c2a9f6606cfc7276faac253d8753"><td class="memItemLeft" align="right" valign="top">virtual Result< std::optional< SchemaFieldConstRef > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1StructType.html#a2213c2a9f6606cfc7276faac253d8753">GetFieldByName</a> (std::string_view name, bool case_sensitive) const=0</td></tr> |
| <tr class="memdesc:a2213c2a9f6606cfc7276faac253d8753 inherit pub_methods_classiceberg_1_1StructType"><td class="mdescLeft"> </td><td class="mdescRight">Get a field by name. Return an error Status if the field name is not unique; prefer GetFieldById or GetFieldByIndex when possible. <br /></td></tr> |
| <tr class="separator:a2213c2a9f6606cfc7276faac253d8753 inherit pub_methods_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4eaddf68ef7fbdf4ae44d3a67f1fc99d inherit pub_methods_classiceberg_1_1StructType" id="r_a4eaddf68ef7fbdf4ae44d3a67f1fc99d"><td class="memItemLeft" align="right" valign="top"> |
| Result< std::optional< SchemaFieldConstRef > > </td><td class="memItemRight" valign="bottom"><b>GetFieldByName</b> (std::string_view name) const</td></tr> |
| <tr class="memdesc:a4eaddf68ef7fbdf4ae44d3a67f1fc99d inherit pub_methods_classiceberg_1_1StructType"><td class="mdescLeft"> </td><td class="mdescRight">Get a field by name (case-sensitive). <br /></td></tr> |
| <tr class="separator:a4eaddf68ef7fbdf4ae44d3a67f1fc99d inherit pub_methods_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classiceberg_1_1NestedType"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1NestedType')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classiceberg_1_1NestedType.html">iceberg::NestedType</a></td></tr> |
| <tr class="memitem:a973f9a2e897d90e2f7be02c953bc2246 inherit pub_methods_classiceberg_1_1NestedType" id="r_a973f9a2e897d90e2f7be02c953bc2246"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1NestedType.html#a973f9a2e897d90e2f7be02c953bc2246">is_primitive</a> () const override</td></tr> |
| <tr class="memdesc:a973f9a2e897d90e2f7be02c953bc2246 inherit pub_methods_classiceberg_1_1NestedType"><td class="mdescLeft"> </td><td class="mdescRight">Is this a primitive type (may not have child fields)? <br /></td></tr> |
| <tr class="separator:a973f9a2e897d90e2f7be02c953bc2246 inherit pub_methods_classiceberg_1_1NestedType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad658681f880385907591f637fb20f44b inherit pub_methods_classiceberg_1_1NestedType" id="r_ad658681f880385907591f637fb20f44b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1NestedType.html#ad658681f880385907591f637fb20f44b">is_nested</a> () const override</td></tr> |
| <tr class="memdesc:ad658681f880385907591f637fb20f44b inherit pub_methods_classiceberg_1_1NestedType"><td class="mdescLeft"> </td><td class="mdescRight">Is this a nested type (may have child fields)? <br /></td></tr> |
| <tr class="separator:ad658681f880385907591f637fb20f44b inherit pub_methods_classiceberg_1_1NestedType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4eaddf68ef7fbdf4ae44d3a67f1fc99d inherit pub_methods_classiceberg_1_1NestedType" id="r_a4eaddf68ef7fbdf4ae44d3a67f1fc99d"><td class="memItemLeft" align="right" valign="top"> |
| Result< std::optional< SchemaFieldConstRef > > </td><td class="memItemRight" valign="bottom"><b>GetFieldByName</b> (std::string_view name) const</td></tr> |
| <tr class="memdesc:a4eaddf68ef7fbdf4ae44d3a67f1fc99d inherit pub_methods_classiceberg_1_1NestedType"><td class="mdescLeft"> </td><td class="mdescRight">Get a field by name (case-sensitive). <br /></td></tr> |
| <tr class="separator:a4eaddf68ef7fbdf4ae44d3a67f1fc99d inherit pub_methods_classiceberg_1_1NestedType"><td class="memSeparator" colspan="2"> </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:a607f4d7fc75bc77e9a4640df7d67a121" id="r_a607f4d7fc75bc77e9a4640df7d67a121"><td class="memItemLeft" align="right" valign="top">static Result< std::unique_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Schema.html#a607f4d7fc75bc77e9a4640df7d67a121">Make</a> (std::vector< <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> > <a class="el" href="classiceberg_1_1StructType.html#a450d536bde2a559ac3781cd6c5ebc719">fields</a>, int32_t <a class="el" href="classiceberg_1_1Schema.html#a74844202dab943691671e5d40bcf3f72">schema_id</a>, std::vector< int32_t > identifier_field_ids)</td></tr> |
| <tr class="memdesc:a607f4d7fc75bc77e9a4640df7d67a121"><td class="mdescLeft"> </td><td class="mdescRight">Create a schema. <br /></td></tr> |
| <tr class="separator:a607f4d7fc75bc77e9a4640df7d67a121"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8dee51d686a1c8170658dcbf087ea0f6" id="r_a8dee51d686a1c8170658dcbf087ea0f6"><td class="memItemLeft" align="right" valign="top">static Result< std::unique_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Schema.html#a8dee51d686a1c8170658dcbf087ea0f6">Make</a> (std::vector< <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> > <a class="el" href="classiceberg_1_1StructType.html#a450d536bde2a559ac3781cd6c5ebc719">fields</a>, int32_t <a class="el" href="classiceberg_1_1Schema.html#a74844202dab943691671e5d40bcf3f72">schema_id</a>, const std::vector< std::string > &identifier_field_names)</td></tr> |
| <tr class="memdesc:a8dee51d686a1c8170658dcbf087ea0f6"><td class="mdescLeft"> </td><td class="mdescRight">Create a schema. <br /></td></tr> |
| <tr class="separator:a8dee51d686a1c8170658dcbf087ea0f6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9d15737406aa67d927bfc8358a363f70" id="r_a9d15737406aa67d927bfc8358a363f70"><td class="memItemLeft" align="right" valign="top">static Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Schema.html#a9d15737406aa67d927bfc8358a363f70">ValidateIdentifierFields</a> (int32_t field_id, const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &schema, const std::unordered_map< int32_t, int32_t > &id_to_parent)</td></tr> |
| <tr class="memdesc:a9d15737406aa67d927bfc8358a363f70"><td class="mdescLeft"> </td><td class="mdescRight">Validate that the identifier field with the given ID is valid for the schema. <br /></td></tr> |
| <tr class="separator:a9d15737406aa67d927bfc8358a363f70"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3fcd7158ae7cbd43e12228a066c30c6e" id="r_a3fcd7158ae7cbd43e12228a066c30c6e"><td class="memItemLeft" align="right" valign="top">static const std::shared_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Schema.html#a3fcd7158ae7cbd43e12228a066c30c6e">EmptySchema</a> ()</td></tr> |
| <tr class="memdesc:a3fcd7158ae7cbd43e12228a066c30c6e"><td class="mdescLeft"> </td><td class="mdescRight">Get an empty schema. <br /></td></tr> |
| <tr class="separator:a3fcd7158ae7cbd43e12228a066c30c6e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr class="memitem:a1274a5d2d95c7a6a34754f435b4d77c0" id="r_a1274a5d2d95c7a6a34754f435b4d77c0"><td class="memItemLeft" align="right" valign="top"><a id="a1274a5d2d95c7a6a34754f435b4d77c0" name="a1274a5d2d95c7a6a34754f435b4d77c0"></a> |
| static constexpr int32_t </td><td class="memItemRight" valign="bottom"><b>kInitialSchemaId</b> = 0</td></tr> |
| <tr class="separator:a1274a5d2d95c7a6a34754f435b4d77c0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad4a7d4715560c9f414e805f7130dc465" id="r_ad4a7d4715560c9f414e805f7130dc465"><td class="memItemLeft" align="right" valign="top"><a id="ad4a7d4715560c9f414e805f7130dc465" name="ad4a7d4715560c9f414e805f7130dc465"></a> |
| static constexpr int32_t </td><td class="memItemRight" valign="bottom"><b>kInitialColumnId</b> = 0</td></tr> |
| <tr class="separator:ad4a7d4715560c9f414e805f7130dc465"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af73c881a3a7b8943d1566782f732f000" id="r_af73c881a3a7b8943d1566782f732f000"><td class="memItemLeft" align="right" valign="top"><a id="af73c881a3a7b8943d1566782f732f000" name="af73c881a3a7b8943d1566782f732f000"></a> |
| static constexpr int32_t </td><td class="memItemRight" valign="bottom"><b>kInvalidColumnId</b> = -1</td></tr> |
| <tr class="separator:af73c881a3a7b8943d1566782f732f000"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5990379e54feaca6629e832dfc052de5" id="r_a5990379e54feaca6629e832dfc052de5"><td class="memItemLeft" align="right" valign="top"><a id="a5990379e54feaca6629e832dfc052de5" name="a5990379e54feaca6629e832dfc052de5"></a> |
| static constexpr std::string_view </td><td class="memItemRight" valign="bottom"><b>kAllColumns</b> = "*"</td></tr> |
| <tr class="memdesc:a5990379e54feaca6629e832dfc052de5"><td class="mdescLeft"> </td><td class="mdescRight">Special value to select all columns from manifest files. <br /></td></tr> |
| <tr class="separator:a5990379e54feaca6629e832dfc052de5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_static_attribs_classiceberg_1_1StructType"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_classiceberg_1_1StructType')"><img src="closed.png" alt="-"/> Static Public Attributes inherited from <a class="el" href="classiceberg_1_1StructType.html">iceberg::StructType</a></td></tr> |
| <tr class="memitem:a9ffc6c8564bbc187bef15933de34c3cd inherit pub_static_attribs_classiceberg_1_1StructType" id="r_a9ffc6c8564bbc187bef15933de34c3cd"><td class="memItemLeft" align="right" valign="top"> |
| static constexpr <a class="el" href="type__fwd_8h.html#afd7801064886b233ca23eadf5ba2c1b8">TypeId</a> </td><td class="memItemRight" valign="bottom"><b>kTypeId</b> = TypeId::kStruct</td></tr> |
| <tr class="separator:a9ffc6c8564bbc187bef15933de34c3cd inherit pub_static_attribs_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a> |
| Friends</h2></td></tr> |
| <tr class="memitem:adc6812cd69b9ba15f65777902a289262" id="r_adc6812cd69b9ba15f65777902a289262"><td class="memItemLeft" align="right" valign="top"><a id="adc6812cd69b9ba15f65777902a289262" name="adc6812cd69b9ba15f65777902a289262"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &lhs, const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &rhs)</td></tr> |
| <tr class="separator:adc6812cd69b9ba15f65777902a289262"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a> |
| Additional Inherited Members</h2></td></tr> |
| <tr class="inherit_header pub_types_classiceberg_1_1NestedType"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classiceberg_1_1NestedType')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classiceberg_1_1NestedType.html">iceberg::NestedType</a></td></tr> |
| <tr class="memitem:a2c000477a9f8bd01766fffc5aeefd309 inherit pub_types_classiceberg_1_1NestedType" id="r_a2c000477a9f8bd01766fffc5aeefd309"><td class="memItemLeft" align="right" valign="top"> |
| using </td><td class="memItemRight" valign="bottom"><b>SchemaFieldConstRef</b> = std::reference_wrapper< const <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> ></td></tr> |
| <tr class="separator:a2c000477a9f8bd01766fffc5aeefd309 inherit pub_types_classiceberg_1_1NestedType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pro_methods_classiceberg_1_1StructType"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classiceberg_1_1StructType')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classiceberg_1_1StructType.html">iceberg::StructType</a></td></tr> |
| <tr class="memitem:ac409fbe5fd9f8f37b398bb737795da7f inherit pro_methods_classiceberg_1_1StructType" id="r_ac409fbe5fd9f8f37b398bb737795da7f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1StructType.html#ac409fbe5fd9f8f37b398bb737795da7f">Equals</a> (const <a class="el" href="classiceberg_1_1Type.html">Type</a> &other) const override</td></tr> |
| <tr class="memdesc:ac409fbe5fd9f8f37b398bb737795da7f inherit pro_methods_classiceberg_1_1StructType"><td class="mdescLeft"> </td><td class="mdescRight">Compare two types for equality. <br /></td></tr> |
| <tr class="separator:ac409fbe5fd9f8f37b398bb737795da7f inherit pro_methods_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pro_static_methods_classiceberg_1_1StructType"><td colspan="2" onclick="javascript:toggleInherit('pro_static_methods_classiceberg_1_1StructType')"><img src="closed.png" alt="-"/> Static Protected Member Functions inherited from <a class="el" href="classiceberg_1_1StructType.html">iceberg::StructType</a></td></tr> |
| <tr class="memitem:a18f9f394cb75a590d848dd3735c344a7 inherit pro_static_methods_classiceberg_1_1StructType" id="r_a18f9f394cb75a590d848dd3735c344a7"><td class="memItemLeft" align="right" valign="top"> |
| static Result< std::unordered_map< int32_t, SchemaFieldConstRef > > </td><td class="memItemRight" valign="bottom"><b>InitFieldById</b> (const <a class="el" href="classiceberg_1_1StructType.html">StructType</a> &)</td></tr> |
| <tr class="separator:a18f9f394cb75a590d848dd3735c344a7 inherit pro_static_methods_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4a88a995db7cf27e9b338137cac34d98 inherit pro_static_methods_classiceberg_1_1StructType" id="r_a4a88a995db7cf27e9b338137cac34d98"><td class="memItemLeft" align="right" valign="top"> |
| static Result< std::unordered_map< std::string_view, SchemaFieldConstRef > > </td><td class="memItemRight" valign="bottom"><b>InitFieldByName</b> (const <a class="el" href="classiceberg_1_1StructType.html">StructType</a> &)</td></tr> |
| <tr class="separator:a4a88a995db7cf27e9b338137cac34d98 inherit pro_static_methods_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab476b47b25cbe844fa5299e5f5cf11d1 inherit pro_static_methods_classiceberg_1_1StructType" id="r_ab476b47b25cbe844fa5299e5f5cf11d1"><td class="memItemLeft" align="right" valign="top"> |
| static Result< std::unordered_map< std::string, SchemaFieldConstRef > > </td><td class="memItemRight" valign="bottom"><b>InitFieldByLowerCaseName</b> (const <a class="el" href="classiceberg_1_1StructType.html">StructType</a> &)</td></tr> |
| <tr class="separator:ab476b47b25cbe844fa5299e5f5cf11d1 inherit pro_static_methods_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pro_attribs_classiceberg_1_1StructType"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classiceberg_1_1StructType')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classiceberg_1_1StructType.html">iceberg::StructType</a></td></tr> |
| <tr class="memitem:a327c88bf1366c1ff8df01ee92b55a8ca inherit pro_attribs_classiceberg_1_1StructType" id="r_a327c88bf1366c1ff8df01ee92b55a8ca"><td class="memItemLeft" align="right" valign="top"> |
| std::vector< <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> > </td><td class="memItemRight" valign="bottom"><b>fields_</b></td></tr> |
| <tr class="separator:a327c88bf1366c1ff8df01ee92b55a8ca inherit pro_attribs_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5655beee2ab506fc7d3146d2946d26b2 inherit pro_attribs_classiceberg_1_1StructType" id="r_a5655beee2ab506fc7d3146d2946d26b2"><td class="memItemLeft" align="right" valign="top"> |
| <a class="el" href="classiceberg_1_1Lazy.html">Lazy</a>< InitFieldById > </td><td class="memItemRight" valign="bottom"><b>field_by_id_</b></td></tr> |
| <tr class="separator:a5655beee2ab506fc7d3146d2946d26b2 inherit pro_attribs_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa77c6676945a053932ce5b799b979453 inherit pro_attribs_classiceberg_1_1StructType" id="r_aa77c6676945a053932ce5b799b979453"><td class="memItemLeft" align="right" valign="top"> |
| <a class="el" href="classiceberg_1_1Lazy.html">Lazy</a>< InitFieldByName > </td><td class="memItemRight" valign="bottom"><b>field_by_name_</b></td></tr> |
| <tr class="separator:aa77c6676945a053932ce5b799b979453 inherit pro_attribs_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a085ae2da9c1b842d0c86eca458d8f431 inherit pro_attribs_classiceberg_1_1StructType" id="r_a085ae2da9c1b842d0c86eca458d8f431"><td class="memItemLeft" align="right" valign="top"> |
| <a class="el" href="classiceberg_1_1Lazy.html">Lazy</a>< InitFieldByLowerCaseName > </td><td class="memItemRight" valign="bottom"><b>field_by_lowercase_name_</b></td></tr> |
| <tr class="separator:a085ae2da9c1b842d0c86eca458d8f431 inherit pro_attribs_classiceberg_1_1StructType"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A schema for a <a class="el" href="classiceberg_1_1Table.html" title="Represents an Iceberg table.">Table</a>. </p> |
| <p>A schema is a list of typed columns, along with a unique integer ID. A <a class="el" href="classiceberg_1_1Table.html" title="Represents an Iceberg table.">Table</a> may have different schemas over its lifetime due to schema evolution. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a3fcd7158ae7cbd43e12228a066c30c6e" name="a3fcd7158ae7cbd43e12228a066c30c6e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3fcd7158ae7cbd43e12228a066c30c6e">◆ </a></span>EmptySchema()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::shared_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > & iceberg::Schema::EmptySchema </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get an empty schema. </p> |
| <p>An empty schema has no fields and a schema ID of 0. </p> |
| |
| </div> |
| </div> |
| <a id="a4cacef30daaff6ac57d50fc617f0db96" name="a4cacef30daaff6ac57d50fc617f0db96"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4cacef30daaff6ac57d50fc617f0db96">◆ </a></span>FindColumnNameById()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::optional< std::string_view > > iceberg::Schema::FindColumnNameById </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>field_id</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the canonical field name for the given id. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">field_id</td><td>The id of the field to get the canonical name for. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The canocinal column name of the field with the given id, or std::nullopt if not found. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a8ad01359cfbc11d0d018d30615cbdf1a" name="a8ad01359cfbc11d0d018d30615cbdf1a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8ad01359cfbc11d0d018d30615cbdf1a">◆ </a></span>FindFieldById()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::optional< std::reference_wrapper< const <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> > > > iceberg::Schema::FindFieldById </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>field_id</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Recursively find the <a class="el" href="classiceberg_1_1SchemaField.html" title="A type combined with a name.">SchemaField</a> by field id. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">field_id</td><td>The id of the field to get the accessor for. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The field with the given id, or std::nullopt if not found. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a4db920889e6f3fb26a17361e9e2c382c" name="a4db920889e6f3fb26a17361e9e2c382c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4db920889e6f3fb26a17361e9e2c382c">◆ </a></span>FindFieldByName()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::optional< std::reference_wrapper< const <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> > > > iceberg::Schema::FindFieldByName </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>case_sensitive</em> = <code>true</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Recursively find the <a class="el" href="classiceberg_1_1SchemaField.html" title="A type combined with a name.">SchemaField</a> by field name. </p> |
| <p>Short names for maps and lists are included for any name that does not conflict with a canonical name. For example, a list, 'l', of structs with field 'x' will produce short name 'l.x' in addition to canonical name 'l.element.x'. A map 'm', if its value includes a struct with field 'x' will produce short name 'm.x' in addition to canonical name 'm.value.x'. FIXME: Currently only handles ASCII lowercase conversion; extend to support non-ASCII characters (e.g., using std::towlower or ICU) </p> |
| |
| </div> |
| </div> |
| <a id="ab519cd9bf2437f45bc9db98336a55c52" name="ab519cd9bf2437f45bc9db98336a55c52"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab519cd9bf2437f45bc9db98336a55c52">◆ </a></span>GetAccessorById()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1StructLikeAccessor.html">StructLikeAccessor</a> > > iceberg::Schema::GetAccessorById </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>field_id</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the accessor to access the field by field id. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">field_id</td><td>The id of the field to get the accessor for. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The accessor to access the field, or NotFound if the field is not found. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="af45ff02c07de236324ea0e6cb600c8f8" name="af45ff02c07de236324ea0e6cb600c8f8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af45ff02c07de236324ea0e6cb600c8f8">◆ </a></span>HighestFieldId()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< int32_t > iceberg::Schema::HighestFieldId </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the highest field ID in the schema. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The highest field ID. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a8dee51d686a1c8170658dcbf087ea0f6" name="a8dee51d686a1c8170658dcbf087ea0f6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8dee51d686a1c8170658dcbf087ea0f6">◆ </a></span>Make() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > > iceberg::Schema::Make </td> |
| <td>(</td> |
| <td class="paramtype">std::vector< <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> > </td> |
| <td class="paramname"><em>fields</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>schema_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< std::string > & </td> |
| <td class="paramname"><em>identifier_field_names</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a schema. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">fields</td><td>The fields that make up the schema. </td></tr> |
| <tr><td class="paramname">schema_id</td><td>The unique identifier for this schema (default: kInitialSchemaId). </td></tr> |
| <tr><td class="paramname">identifier_field_names</td><td>Canonical names of fields that uniquely identify rows in the table. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="classiceberg_1_1Schema.html" title="A schema for a Table.">Schema</a> instance or Status if failed. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a607f4d7fc75bc77e9a4640df7d67a121" name="a607f4d7fc75bc77e9a4640df7d67a121"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a607f4d7fc75bc77e9a4640df7d67a121">◆ </a></span>Make() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > > iceberg::Schema::Make </td> |
| <td>(</td> |
| <td class="paramtype">std::vector< <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> > </td> |
| <td class="paramname"><em>fields</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>schema_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< int32_t > </td> |
| <td class="paramname"><em>identifier_field_ids</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a schema. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">fields</td><td>The fields that make up the schema. </td></tr> |
| <tr><td class="paramname">schema_id</td><td>The unique identifier for this schema (default:kInitialSchemaId). </td></tr> |
| <tr><td class="paramname">identifier_field_ids</td><td>Field IDs that uniquely identify rows in the table. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="classiceberg_1_1Schema.html" title="A schema for a Table.">Schema</a> instance or Status if failed. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a29b8bda082c94f3c5cbe7db451245ece" name="a29b8bda082c94f3c5cbe7db451245ece"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a29b8bda082c94f3c5cbe7db451245ece">◆ </a></span>Project()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > > iceberg::Schema::Project </td> |
| <td>(</td> |
| <td class="paramtype">const std::unordered_set< int32_t > & </td> |
| <td class="paramname"><em>field_ids</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a projected schema from selected field IDs. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">field_ids</td><td>Set of field IDs to select </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Projected schema containing only the specified fields. </dd></dl> |
| <dl class="section note"><dt>Note</dt><dd>Field ID of a nested field may not be projected unless at least one of its sub-fields has been projected. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a74844202dab943691671e5d40bcf3f72" name="a74844202dab943691671e5d40bcf3f72"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a74844202dab943691671e5d40bcf3f72">◆ </a></span>schema_id()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int32_t iceberg::Schema::schema_id </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the schema ID. </p> |
| <p>A schema is identified by a unique ID for the purposes of schema evolution. </p> |
| |
| </div> |
| </div> |
| <a id="a1a2d0f2c8770c303e6fb59d0101d48cd" name="a1a2d0f2c8770c303e6fb59d0101d48cd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1a2d0f2c8770c303e6fb59d0101d48cd">◆ </a></span>Select()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > > iceberg::Schema::Select </td> |
| <td>(</td> |
| <td class="paramtype">std::span< const std::string > </td> |
| <td class="paramname"><em>names</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>case_sensitive</em> = <code>true</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a projected schema from selected field names. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">names</td><td>Selected field names and nested names are dot-concatenated. </td></tr> |
| <tr><td class="paramname">case_sensitive</td><td>Whether name matching is case-sensitive (default: true). </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Projected schema containing only selected fields. </dd></dl> |
| <dl class="section note"><dt>Note</dt><dd>If the field name of a nested type has been selected, all of its sub-fields will be selected. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a0dc4ba1d458b21509013a1b3ad388f09" name="a0dc4ba1d458b21509013a1b3ad388f09"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0dc4ba1d458b21509013a1b3ad388f09">◆ </a></span>ToString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string iceberg::Schema::ToString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get a user-readable string representation. </p> |
| |
| <p>Implements <a class="el" href="classiceberg_1_1util_1_1Formattable.html#a79618aca5b3bf63610d9c87ac5ae0386">iceberg::util::Formattable</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a4fa72378d68d58c188362e265950dcb0" name="a4fa72378d68d58c188362e265950dcb0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4fa72378d68d58c188362e265950dcb0">◆ </a></span>Validate()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Status iceberg::Schema::Validate </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>format_version</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Validate the schema for a given format version. </p> |
| <p>This validates that the schema does not contain types that were released in later format versions.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">format_version</td><td>The format version to validate against. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structiceberg_1_1Error.html" title="Error with a kind and a message.">Error</a> status if the schema is invalid. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a9d15737406aa67d927bfc8358a363f70" name="a9d15737406aa67d927bfc8358a363f70"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9d15737406aa67d927bfc8358a363f70">◆ </a></span>ValidateIdentifierFields()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Status iceberg::Schema::ValidateIdentifierFields </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>field_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> & </td> |
| <td class="paramname"><em>schema</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::unordered_map< int32_t, int32_t > & </td> |
| <td class="paramname"><em>id_to_parent</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Validate that the identifier field with the given ID is valid for the schema. </p> |
| <p>This method checks that the specified field ID represents a valid identifier field according to Iceberg's identifier field requirements. It verifies that the field:</p><ul> |
| <li>exists in the schema</li> |
| <li>is a primitive type</li> |
| <li>is not optional (required field)</li> |
| <li>is not a float or double type</li> |
| <li>is not nested within optional or non-struct parent fields</li> |
| </ul> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">field_id</td><td>The ID of the field to validate as an identifier field. </td></tr> |
| <tr><td class="paramname">schema</td><td>The schema containing the field to validate. </td></tr> |
| <tr><td class="paramname">id_to_parent</td><td>A mapping from field IDs to their parent field IDs for nested field validation. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Status indicating success or failure of the validation. </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>iceberg/<a class="el" href="schema_8h_source.html">schema.h</a></li> |
| <li>iceberg/<b>schema.cc</b></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> |
