| <!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::FieldProjection 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"><b>iceberg</b></li><li class="navelem"><a class="el" href="structiceberg_1_1FieldProjection.html">FieldProjection</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="structiceberg_1_1FieldProjection-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::FieldProjection Struct Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A field schema partner to carry projection information. |
| <a href="structiceberg_1_1FieldProjection.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="schema__util_8h_source.html">schema_util.h</a>></code></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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1FieldProjection_1_1ExtraAttributes.html">ExtraAttributes</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </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"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:a99745e34381f167e29f057e2045942ad" id="r_a99745e34381f167e29f057e2045942ad"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1FieldProjection.html#a99745e34381f167e29f057e2045942ad">Kind</a> { <br /> |
|   <a class="el" href="structiceberg_1_1FieldProjection.html#a99745e34381f167e29f057e2045942adabbb9b6614134f223d02f032cd529275d">kProjected</a> |
| , <a class="el" href="structiceberg_1_1FieldProjection.html#a99745e34381f167e29f057e2045942adadc744975fcdff37e4159bd60ef0ee5ab">kMetadata</a> |
| , <a class="el" href="structiceberg_1_1FieldProjection.html#a99745e34381f167e29f057e2045942ada043b62a71551e8b511099802b2b59a98">kConstant</a> |
| , <a class="el" href="structiceberg_1_1FieldProjection.html#a99745e34381f167e29f057e2045942ada6867faeaa475fda467e48267db2bb8a8">kDefault</a> |
| , <br /> |
|   <a class="el" href="structiceberg_1_1FieldProjection.html#a99745e34381f167e29f057e2045942adaf2655c2dee87cb9b0646f678a630394b">kNull</a> |
| <br /> |
| }</td></tr> |
| <tr class="memdesc:a99745e34381f167e29f057e2045942ad"><td class="mdescLeft"> </td><td class="mdescRight">How the field is projected. <a href="structiceberg_1_1FieldProjection.html#a99745e34381f167e29f057e2045942ad">More...</a><br /></td></tr> |
| <tr class="separator:a99745e34381f167e29f057e2045942ad"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a12da62c9ae783f234891a8c709df1fd7" id="r_a12da62c9ae783f234891a8c709df1fd7"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1FieldProjection.html#a12da62c9ae783f234891a8c709df1fd7">From</a> = std::variant< std::monostate, size_t, <a class="el" href="classiceberg_1_1Literal.html">Literal</a> ></td></tr> |
| <tr class="memdesc:a12da62c9ae783f234891a8c709df1fd7"><td class="mdescLeft"> </td><td class="mdescRight">A variant to indicate how to set the value of the field. <br /></td></tr> |
| <tr class="separator:a12da62c9ae783f234891a8c709df1fd7"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:a33852da336a2e50a50f18a340505a8c1" id="r_a33852da336a2e50a50f18a340505a8c1"><td class="memItemLeft" align="right" valign="top"><a id="a33852da336a2e50a50f18a340505a8c1" name="a33852da336a2e50a50f18a340505a8c1"></a> |
| <a class="el" href="structiceberg_1_1FieldProjection.html#a99745e34381f167e29f057e2045942ad">Kind</a> </td><td class="memItemRight" valign="bottom"><b>kind</b></td></tr> |
| <tr class="memdesc:a33852da336a2e50a50f18a340505a8c1"><td class="mdescLeft"> </td><td class="mdescRight">The kind of projection of the field it partners with. <br /></td></tr> |
| <tr class="separator:a33852da336a2e50a50f18a340505a8c1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a569ebb40990a81d24a0e58ce65d444d9" id="r_a569ebb40990a81d24a0e58ce65d444d9"><td class="memItemLeft" align="right" valign="top"><a id="a569ebb40990a81d24a0e58ce65d444d9" name="a569ebb40990a81d24a0e58ce65d444d9"></a> |
| <a class="el" href="structiceberg_1_1FieldProjection.html#a12da62c9ae783f234891a8c709df1fd7">From</a> </td><td class="memItemRight" valign="bottom"><b>from</b></td></tr> |
| <tr class="memdesc:a569ebb40990a81d24a0e58ce65d444d9"><td class="mdescLeft"> </td><td class="mdescRight">The source to set the value of the field. <br /></td></tr> |
| <tr class="separator:a569ebb40990a81d24a0e58ce65d444d9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a26bfceb35e63eadd0c757c6344d7bb5d" id="r_a26bfceb35e63eadd0c757c6344d7bb5d"><td class="memItemLeft" align="right" valign="top"><a id="a26bfceb35e63eadd0c757c6344d7bb5d" name="a26bfceb35e63eadd0c757c6344d7bb5d"></a> |
| std::vector< <a class="el" href="structiceberg_1_1FieldProjection.html">FieldProjection</a> > </td><td class="memItemRight" valign="bottom"><b>children</b></td></tr> |
| <tr class="memdesc:a26bfceb35e63eadd0c757c6344d7bb5d"><td class="mdescLeft"> </td><td class="mdescRight">The children of the field if it is a nested field. <br /></td></tr> |
| <tr class="separator:a26bfceb35e63eadd0c757c6344d7bb5d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afd27c64e1fe20a9072469d46d7d102ab" id="r_afd27c64e1fe20a9072469d46d7d102ab"><td class="memItemLeft" align="right" valign="top"><a id="afd27c64e1fe20a9072469d46d7d102ab" name="afd27c64e1fe20a9072469d46d7d102ab"></a> |
| std::shared_ptr< <a class="el" href="structiceberg_1_1FieldProjection_1_1ExtraAttributes.html">ExtraAttributes</a> > </td><td class="memItemRight" valign="bottom"><b>attributes</b></td></tr> |
| <tr class="memdesc:afd27c64e1fe20a9072469d46d7d102ab"><td class="mdescLeft"> </td><td class="mdescRight">Format-specific attributes for the field. <br /></td></tr> |
| <tr class="separator:afd27c64e1fe20a9072469d46d7d102ab"><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 field schema partner to carry projection information. </p> |
| </div><h2 class="groupheader">Member Typedef Documentation</h2> |
| <a id="a12da62c9ae783f234891a8c709df1fd7" name="a12da62c9ae783f234891a8c709df1fd7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a12da62c9ae783f234891a8c709df1fd7">◆ </a></span>From</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">using <a class="el" href="structiceberg_1_1FieldProjection.html#a12da62c9ae783f234891a8c709df1fd7">iceberg::FieldProjection::From</a> = std::variant<std::monostate, size_t, <a class="el" href="classiceberg_1_1Literal.html">Literal</a>></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>A variant to indicate how to set the value of the field. </p> |
| <dl class="section note"><dt>Note</dt><dd><code>std::monostate</code> is used to indicate that the field is not projected. </dd> |
| <dd> |
| <code>size_t</code> is used to indicate the field index in the source schema on the same nesting level when <code>kind</code> is <code>kProjected</code>. </dd> |
| <dd> |
| <code><a class="el" href="classiceberg_1_1Literal.html" title="Literal is a literal value that is associated with a primitive type.">Literal</a></code> is used to indicate the value of the field when <code>kind</code> is <code>kConstant</code> or <code>kDefault</code>. </dd></dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Enumeration Documentation</h2> |
| <a id="a99745e34381f167e29f057e2045942ad" name="a99745e34381f167e29f057e2045942ad"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a99745e34381f167e29f057e2045942ad">◆ </a></span>Kind</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum class <a class="el" href="structiceberg_1_1FieldProjection.html#a99745e34381f167e29f057e2045942ad">iceberg::FieldProjection::Kind</a></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">strong</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>How the field is projected. </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a99745e34381f167e29f057e2045942adabbb9b6614134f223d02f032cd529275d" name="a99745e34381f167e29f057e2045942adabbb9b6614134f223d02f032cd529275d"></a>kProjected </td><td class="fielddoc"><p>The field is projected from the source with possible conversion for supported schema evolution. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a99745e34381f167e29f057e2045942adadc744975fcdff37e4159bd60ef0ee5ab" name="a99745e34381f167e29f057e2045942adadc744975fcdff37e4159bd60ef0ee5ab"></a>kMetadata </td><td class="fielddoc"><p>Metadata column whose value is generated on demand. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a99745e34381f167e29f057e2045942ada043b62a71551e8b511099802b2b59a98" name="a99745e34381f167e29f057e2045942ada043b62a71551e8b511099802b2b59a98"></a>kConstant </td><td class="fielddoc"><p>The field is a constant value (e.g. partition field value) </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a99745e34381f167e29f057e2045942ada6867faeaa475fda467e48267db2bb8a8" name="a99745e34381f167e29f057e2045942ada6867faeaa475fda467e48267db2bb8a8"></a>kDefault </td><td class="fielddoc"><p>The field is missing in the source and should be filled with default value. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a99745e34381f167e29f057e2045942adaf2655c2dee87cb9b0646f678a630394b" name="a99745e34381f167e29f057e2045942adaf2655c2dee87cb9b0646f678a630394b"></a>kNull </td><td class="fielddoc"><p>An optional field that is not present in the source. </p> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following file:<ul> |
| <li>iceberg/<a class="el" href="schema__util_8h_source.html">schema_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> |
