Google GitGoogle Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1MetricsConfig.html
blob: df3b6fc148995af58e2e762bafac60bacd6c0856 [file]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iceberg-cpp: iceberg::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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceiceberg.html">iceberg</a></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> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<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 &lt;<a class="el" href="metrics__config_8h_source.html">metrics_config.h</a>&gt;</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>&#160;</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">&#160;</td><td class="mdescRight">Get the metrics mode for a specific column. <br /></td></tr>
<tr class="separator:a57e3b1a810e758d681531b890ce593f3"><td class="memSeparator" colspan="2">&#160;</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:ac6f236b9e6db5174e13fe4a1951e2bc7" id="r_ac6f236b9e6db5174e13fe4a1951e2bc7"><td class="memItemLeft" align="right" valign="top"><a id="ac6f236b9e6db5174e13fe4a1951e2bc7" name="ac6f236b9e6db5174e13fe4a1951e2bc7"></a>
static const std::shared_ptr&lt; <a class="el" href="classiceberg_1_1MetricsConfig.html">MetricsConfig</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>Default</b> ()</td></tr>
<tr class="memdesc:ac6f236b9e6db5174e13fe4a1951e2bc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the default metrics config. <br /></td></tr>
<tr class="separator:ac6f236b9e6db5174e13fe4a1951e2bc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74716f6e652995043996a4e3c6a95c96" id="r_a74716f6e652995043996a4e3c6a95c96"><td class="memItemLeft" align="right" valign="top"><a id="a74716f6e652995043996a4e3c6a95c96" name="a74716f6e652995043996a4e3c6a95c96"></a>
static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::shared_ptr&lt; <a class="el" href="classiceberg_1_1MetricsConfig.html">MetricsConfig</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Make</b> (const <a class="el" href="classiceberg_1_1Table.html">Table</a> &amp;table)</td></tr>
<tr class="memdesc:a74716f6e652995043996a4e3c6a95c96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a metrics config from a table. <br /></td></tr>
<tr class="separator:a74716f6e652995043996a4e3c6a95c96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb79fdb3041017a3f18c779e77a19ac3" id="r_aeb79fdb3041017a3f18c779e77a19ac3"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::shared_ptr&lt; <a class="el" href="classiceberg_1_1MetricsConfig.html">MetricsConfig</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1MetricsConfig.html#aeb79fdb3041017a3f18c779e77a19ac3">Make</a> (std::unordered_map&lt; std::string, std::string &gt; properties)</td></tr>
<tr class="memdesc:aeb79fdb3041017a3f18c779e77a19ac3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a metrics config from properties (for testing) <br /></td></tr>
<tr class="separator:aeb79fdb3041017a3f18c779e77a19ac3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afda18c85e4c319c0d7c179ac01815418" id="r_afda18c85e4c319c0d7c179ac01815418"><td class="memItemLeft" align="right" valign="top"><a id="afda18c85e4c319c0d7c179ac01815418" name="afda18c85e4c319c0d7c179ac01815418"></a>
static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::unordered_set&lt; int32_t &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>LimitFieldIds</b> (const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &amp;schema, int32_t limit)</td></tr>
<tr class="memdesc:afda18c85e4c319c0d7c179ac01815418"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get <code>limit</code> num of primitive field ids from schema. <br /></td></tr>
<tr class="separator:afda18c85e4c319c0d7c179ac01815418"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a706748c89ee79494462c0e61d260b83f" id="r_a706748c89ee79494462c0e61d260b83f"><td class="memItemLeft" align="right" valign="top">static Status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1MetricsConfig.html#a706748c89ee79494462c0e61d260b83f">VerifyReferencedColumns</a> (const std::unordered_map&lt; std::string, std::string &gt; &amp;updates, const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &amp;schema)</td></tr>
<tr class="memdesc:a706748c89ee79494462c0e61d260b83f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Verify that all referenced columns are valid. <br /></td></tr>
<tr class="separator:a706748c89ee79494462c0e61d260b83f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>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">&#9670;&#160;</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&#160;</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="aeb79fdb3041017a3f18c779e77a19ac3" name="aeb79fdb3041017a3f18c779e77a19ac3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb79fdb3041017a3f18c779e77a19ac3">&#9670;&#160;</a></span>Make()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::shared_ptr&lt; <a class="el" href="classiceberg_1_1MetricsConfig.html">MetricsConfig</a> &gt; &gt; iceberg::MetricsConfig::Make </td>
<td>(</td>
<td class="paramtype">std::unordered_map&lt; std::string, std::string &gt;&#160;</td>
<td class="paramname"><em>properties</em></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>Creates a metrics config from properties (for testing) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">properties</td><td>Map of property key-value pairs </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A shared pointer to the created <a class="el" href="classiceberg_1_1MetricsConfig.html" title="Configuration for collecting column metrics for an Iceberg table.">MetricsConfig</a> </dd></dl>
</div>
</div>
<a id="a706748c89ee79494462c0e61d260b83f" name="a706748c89ee79494462c0e61d260b83f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a706748c89ee79494462c0e61d260b83f">&#9670;&#160;</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">static Status iceberg::MetricsConfig::VerifyReferencedColumns </td>
<td>(</td>
<td class="paramtype">const std::unordered_map&lt; std::string, std::string &gt; &amp;&#160;</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> &amp;&#160;</td>
<td class="paramname"><em>schema</em>&#160;</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 file:<ul>
<li>iceberg/<a class="el" href="metrics__config_8h_source.html">metrics_config.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>