| <!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::PartitionFieldSummary 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_1PartitionFieldSummary.html">PartitionFieldSummary</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-attribs">Public Attributes</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="structiceberg_1_1PartitionFieldSummary-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::PartitionFieldSummary Struct Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Field summary for partition field in the spec. |
| <a href="structiceberg_1_1PartitionFieldSummary.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="manifest__list_8h_source.html">manifest_list.h</a>></code></p> |
| <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:a77945a14da9ad7619de7f43111e6a000" id="r_a77945a14da9ad7619de7f43111e6a000"><td class="memItemLeft" align="right" valign="top"><a id="a77945a14da9ad7619de7f43111e6a000" name="a77945a14da9ad7619de7f43111e6a000"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="structiceberg_1_1PartitionFieldSummary.html">PartitionFieldSummary</a> &other) const =default</td></tr> |
| <tr class="separator:a77945a14da9ad7619de7f43111e6a000"><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:aaba2f2c59dc1f481c2c1fa400f8f44a0" id="r_aaba2f2c59dc1f481c2c1fa400f8f44a0"><td class="memItemLeft" align="right" valign="top"><a id="aaba2f2c59dc1f481c2c1fa400f8f44a0" name="aaba2f2c59dc1f481c2c1fa400f8f44a0"></a> |
| static const std::shared_ptr< <a class="el" href="classiceberg_1_1StructType.html">StructType</a> > & </td><td class="memItemRight" valign="bottom"><b>Type</b> ()</td></tr> |
| <tr class="separator:aaba2f2c59dc1f481c2c1fa400f8f44a0"><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:a4c6d214a5137f194549c2d41d95341d7" id="r_a4c6d214a5137f194549c2d41d95341d7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1PartitionFieldSummary.html#a4c6d214a5137f194549c2d41d95341d7">contains_null</a> = true</td></tr> |
| <tr class="separator:a4c6d214a5137f194549c2d41d95341d7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae9eb0a96032cdc17af89551c19dac602" id="r_ae9eb0a96032cdc17af89551c19dac602"><td class="memItemLeft" align="right" valign="top">std::optional< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1PartitionFieldSummary.html#ae9eb0a96032cdc17af89551c19dac602">contains_nan</a></td></tr> |
| <tr class="separator:ae9eb0a96032cdc17af89551c19dac602"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8c12978875b97dd4f555b86db605c104" id="r_a8c12978875b97dd4f555b86db605c104"><td class="memItemLeft" align="right" valign="top">std::optional< std::vector< uint8_t > > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1PartitionFieldSummary.html#a8c12978875b97dd4f555b86db605c104">lower_bound</a></td></tr> |
| <tr class="separator:a8c12978875b97dd4f555b86db605c104"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abacf2fd506572ceed3ce049661aa3033" id="r_abacf2fd506572ceed3ce049661aa3033"><td class="memItemLeft" align="right" valign="top">std::optional< std::vector< uint8_t > > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1PartitionFieldSummary.html#abacf2fd506572ceed3ce049661aa3033">upper_bound</a></td></tr> |
| <tr class="separator:abacf2fd506572ceed3ce049661aa3033"><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:a9256b9ba3269f92ed89a075137dd907f" id="r_a9256b9ba3269f92ed89a075137dd907f"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1PartitionFieldSummary.html#a9256b9ba3269f92ed89a075137dd907f">kContainsNull</a></td></tr> |
| <tr class="separator:a9256b9ba3269f92ed89a075137dd907f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a007e05556def63020c1b800eb2bbae09" id="r_a007e05556def63020c1b800eb2bbae09"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1PartitionFieldSummary.html#a007e05556def63020c1b800eb2bbae09">kContainsNaN</a></td></tr> |
| <tr class="separator:a007e05556def63020c1b800eb2bbae09"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af6e4e8ead77bd7705ca6c31b5f77fa1b" id="r_af6e4e8ead77bd7705ca6c31b5f77fa1b"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1PartitionFieldSummary.html#af6e4e8ead77bd7705ca6c31b5f77fa1b">kLowerBound</a></td></tr> |
| <tr class="separator:af6e4e8ead77bd7705ca6c31b5f77fa1b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6fee72f41d8674b1497267c72b951a9e" id="r_a6fee72f41d8674b1497267c72b951a9e"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1PartitionFieldSummary.html#a6fee72f41d8674b1497267c72b951a9e">kUpperBound</a></td></tr> |
| <tr class="separator:a6fee72f41d8674b1497267c72b951a9e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Field summary for partition field in the spec. </p> |
| <p>Each field of this corresponds to a field in the manifest file's partition spec. </p> |
| </div><h2 class="groupheader">Member Data Documentation</h2> |
| <a id="ae9eb0a96032cdc17af89551c19dac602" name="ae9eb0a96032cdc17af89551c19dac602"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae9eb0a96032cdc17af89551c19dac602">◆ </a></span>contains_nan</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::optional<bool> iceberg::PartitionFieldSummary::contains_nan</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Field id: 518 Whether the manifest contains at least one partition with a NaN value for the field </p> |
| |
| </div> |
| </div> |
| <a id="a4c6d214a5137f194549c2d41d95341d7" name="a4c6d214a5137f194549c2d41d95341d7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4c6d214a5137f194549c2d41d95341d7">◆ </a></span>contains_null</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool iceberg::PartitionFieldSummary::contains_null = true</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Field id: 509 Whether the manifest contains at least one partition with a null value for the field </p> |
| |
| </div> |
| </div> |
| <a id="a007e05556def63020c1b800eb2bbae09" name="a007e05556def63020c1b800eb2bbae09"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a007e05556def63020c1b800eb2bbae09">◆ </a></span>kContainsNaN</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> iceberg::PartitionFieldSummary::kContainsNaN</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <b>Initial value:</b><div class="fragment"><div class="line">=</div> |
| <div class="line"> <a class="code hl_function" href="classiceberg_1_1SchemaField.html#a0c8382f6e164b76f45e4b4c26028a872">SchemaField::MakeOptional</a>(518, <span class="stringliteral">"contains_nan"</span>, <a class="code hl_function" href="group__type-factories.html#gafb5f5aec1d1d6218809ee512e2f87e83">iceberg::boolean</a>(),</div> |
| <div class="line"> <span class="stringliteral">"True if any file has a nan partition value"</span>)</div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_a0c8382f6e164b76f45e4b4c26028a872"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#a0c8382f6e164b76f45e4b4c26028a872">iceberg::SchemaField::MakeOptional</a></div><div class="ttdeci">static SchemaField MakeOptional(int32_t field_id, std::string_view name, std::shared_ptr< Type > type, std::string_view doc={})</div><div class="ttdoc">Construct an optional (nullable) field.</div><div class="ttdef"><b>Definition</b> schema_field.cc:38</div></div> |
| <div class="ttc" id="agroup__type-factories_html_gafb5f5aec1d1d6218809ee512e2f87e83"><div class="ttname"><a href="group__type-factories.html#gafb5f5aec1d1d6218809ee512e2f87e83">iceberg::boolean</a></div><div class="ttdeci">ICEBERG_EXPORT const std::shared_ptr< BooleanType > & boolean()</div><div class="ttdoc">Return a BooleanType instance.</div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a id="a9256b9ba3269f92ed89a075137dd907f" name="a9256b9ba3269f92ed89a075137dd907f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9256b9ba3269f92ed89a075137dd907f">◆ </a></span>kContainsNull</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> iceberg::PartitionFieldSummary::kContainsNull</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <b>Initial value:</b><div class="fragment"><div class="line">=</div> |
| <div class="line"> <a class="code hl_function" href="classiceberg_1_1SchemaField.html#a4ad7baa4dedd37e2f699a2f32deef942">SchemaField::MakeRequired</a>(509, <span class="stringliteral">"contains_null"</span>, <a class="code hl_function" href="group__type-factories.html#gafb5f5aec1d1d6218809ee512e2f87e83">iceberg::boolean</a>(),</div> |
| <div class="line"> <span class="stringliteral">"True if any file has a null partition value"</span>)</div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_a4ad7baa4dedd37e2f699a2f32deef942"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#a4ad7baa4dedd37e2f699a2f32deef942">iceberg::SchemaField::MakeRequired</a></div><div class="ttdeci">static SchemaField MakeRequired(int32_t field_id, std::string_view name, std::shared_ptr< Type > type, std::string_view doc={})</div><div class="ttdoc">Construct a required (non-null) field.</div><div class="ttdef"><b>Definition</b> schema_field.cc:43</div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a id="af6e4e8ead77bd7705ca6c31b5f77fa1b" name="af6e4e8ead77bd7705ca6c31b5f77fa1b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af6e4e8ead77bd7705ca6c31b5f77fa1b">◆ </a></span>kLowerBound</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> iceberg::PartitionFieldSummary::kLowerBound</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <b>Initial value:</b><div class="fragment"><div class="line">= <a class="code hl_function" href="classiceberg_1_1SchemaField.html#a0c8382f6e164b76f45e4b4c26028a872">SchemaField::MakeOptional</a>(</div> |
| <div class="line"> 510, <span class="stringliteral">"lower_bound"</span>, <a class="code hl_function" href="group__type-factories.html#ga33cd0c2e979eebcccc89cdbcd3f6af99">iceberg::binary</a>(), <span class="stringliteral">"Partition lower bound for all files"</span>)</div> |
| <div class="ttc" id="agroup__type-factories_html_ga33cd0c2e979eebcccc89cdbcd3f6af99"><div class="ttname"><a href="group__type-factories.html#ga33cd0c2e979eebcccc89cdbcd3f6af99">iceberg::binary</a></div><div class="ttdeci">ICEBERG_EXPORT const std::shared_ptr< BinaryType > & binary()</div><div class="ttdoc">Return a BinaryType instance.</div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a id="a6fee72f41d8674b1497267c72b951a9e" name="a6fee72f41d8674b1497267c72b951a9e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6fee72f41d8674b1497267c72b951a9e">◆ </a></span>kUpperBound</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> iceberg::PartitionFieldSummary::kUpperBound</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <b>Initial value:</b><div class="fragment"><div class="line">= <a class="code hl_function" href="classiceberg_1_1SchemaField.html#a0c8382f6e164b76f45e4b4c26028a872">SchemaField::MakeOptional</a>(</div> |
| <div class="line"> 511, <span class="stringliteral">"upper_bound"</span>, <a class="code hl_function" href="group__type-factories.html#ga33cd0c2e979eebcccc89cdbcd3f6af99">iceberg::binary</a>(), <span class="stringliteral">"Partition upper bound for all files"</span>)</div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a id="a8c12978875b97dd4f555b86db605c104" name="a8c12978875b97dd4f555b86db605c104"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8c12978875b97dd4f555b86db605c104">◆ </a></span>lower_bound</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::optional<std::vector<uint8_t> > iceberg::PartitionFieldSummary::lower_bound</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Field id: 510 Lower bound for the non-null, non-NaN values in the partition field, or null if all values are null or NaN </p> |
| |
| </div> |
| </div> |
| <a id="abacf2fd506572ceed3ce049661aa3033" name="abacf2fd506572ceed3ce049661aa3033"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abacf2fd506572ceed3ce049661aa3033">◆ </a></span>upper_bound</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::optional<std::vector<uint8_t> > iceberg::PartitionFieldSummary::upper_bound</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Field id: 511 Upper bound for the non-null, non-NaN values in the partition field, or null if all values are null or NaN </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following files:<ul> |
| <li>iceberg/manifest/<a class="el" href="manifest__list_8h_source.html">manifest_list.h</a></li> |
| <li>iceberg/manifest/<b>manifest_list.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> |
