| <!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::MetricsConfig 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_1MetricsConfig.html">MetricsConfig</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="classiceberg_1_1MetricsConfig-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::MetricsConfig Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Configuration for collecting column metrics for an Iceberg table. |
| <a href="classiceberg_1_1MetricsConfig.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="metrics__config_8h_source.html">metrics_config.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:a57e3b1a810e758d681531b890ce593f3" id="r_a57e3b1a810e758d681531b890ce593f3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structiceberg_1_1MetricsMode.html">MetricsMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1MetricsConfig.html#a57e3b1a810e758d681531b890ce593f3">ColumnMode</a> (std::string_view column_name) const</td></tr> |
| <tr class="memdesc:a57e3b1a810e758d681531b890ce593f3"><td class="mdescLeft"> </td><td class="mdescRight">Get the metrics mode for a specific column. <br /></td></tr> |
| <tr class="separator:a57e3b1a810e758d681531b890ce593f3"><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:a88c50b04209242aaed6441025d9f462c" id="r_a88c50b04209242aaed6441025d9f462c"><td class="memItemLeft" align="right" valign="top"><a id="a88c50b04209242aaed6441025d9f462c" name="a88c50b04209242aaed6441025d9f462c"></a> |
| static const std::shared_ptr< <a class="el" href="classiceberg_1_1MetricsConfig.html">MetricsConfig</a> > & </td><td class="memItemRight" valign="bottom"><b>Default</b> ()</td></tr> |
| <tr class="memdesc:a88c50b04209242aaed6441025d9f462c"><td class="mdescLeft"> </td><td class="mdescRight">Get the default metrics config. <br /></td></tr> |
| <tr class="separator:a88c50b04209242aaed6441025d9f462c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a653bc98b5da8bf8598da6c28acb02614" id="r_a653bc98b5da8bf8598da6c28acb02614"><td class="memItemLeft" align="right" valign="top"><a id="a653bc98b5da8bf8598da6c28acb02614" name="a653bc98b5da8bf8598da6c28acb02614"></a> |
| static Result< std::shared_ptr< <a class="el" href="classiceberg_1_1MetricsConfig.html">MetricsConfig</a> > > </td><td class="memItemRight" valign="bottom"><b>Make</b> (const <a class="el" href="classiceberg_1_1Table.html">Table</a> &table)</td></tr> |
| <tr class="memdesc:a653bc98b5da8bf8598da6c28acb02614"><td class="mdescLeft"> </td><td class="mdescRight">Creates a metrics config from a table. <br /></td></tr> |
| <tr class="separator:a653bc98b5da8bf8598da6c28acb02614"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adc1457efff0493d71f213588c0945c71" id="r_adc1457efff0493d71f213588c0945c71"><td class="memItemLeft" align="right" valign="top"><a id="adc1457efff0493d71f213588c0945c71" name="adc1457efff0493d71f213588c0945c71"></a> |
| static Result< std::unordered_set< int32_t > > </td><td class="memItemRight" valign="bottom"><b>LimitFieldIds</b> (const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &schema, int32_t limit)</td></tr> |
| <tr class="memdesc:adc1457efff0493d71f213588c0945c71"><td class="mdescLeft"> </td><td class="mdescRight">Get <code>limit</code> num of primitive field ids from schema. <br /></td></tr> |
| <tr class="separator:adc1457efff0493d71f213588c0945c71"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a67ce9ae32b86c984e05eeeb35080d8f6" id="r_a67ce9ae32b86c984e05eeeb35080d8f6"><td class="memItemLeft" align="right" valign="top">static Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1MetricsConfig.html#a67ce9ae32b86c984e05eeeb35080d8f6">VerifyReferencedColumns</a> (const std::unordered_map< std::string, std::string > &updates, const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &schema)</td></tr> |
| <tr class="memdesc:a67ce9ae32b86c984e05eeeb35080d8f6"><td class="mdescLeft"> </td><td class="mdescRight">Verify that all referenced columns are valid. <br /></td></tr> |
| <tr class="separator:a67ce9ae32b86c984e05eeeb35080d8f6"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Configuration for collecting column metrics for an Iceberg table. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a57e3b1a810e758d681531b890ce593f3" name="a57e3b1a810e758d681531b890ce593f3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a57e3b1a810e758d681531b890ce593f3">◆ </a></span>ColumnMode()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="structiceberg_1_1MetricsMode.html">MetricsMode</a> iceberg::MetricsConfig::ColumnMode </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>column_name</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the metrics mode for a specific column. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">column_name</td><td>The full name of the column </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The metrics mode for the column </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a67ce9ae32b86c984e05eeeb35080d8f6" name="a67ce9ae32b86c984e05eeeb35080d8f6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a67ce9ae32b86c984e05eeeb35080d8f6">◆ </a></span>VerifyReferencedColumns()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Status iceberg::MetricsConfig::VerifyReferencedColumns </td> |
| <td>(</td> |
| <td class="paramtype">const std::unordered_map< std::string, std::string > & </td> |
| <td class="paramname"><em>updates</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></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>Verify that all referenced columns are valid. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">updates</td><td>The updates to verify </td></tr> |
| <tr><td class="paramname">schema</td><td>The schema to verify against </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>OK if all referenced columns are valid </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>iceberg/<a class="el" href="metrics__config_8h_source.html">metrics_config.h</a></li> |
| <li>iceberg/<b>metrics_config.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> |
