| <!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::ScanMetricsResult 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"><a class="el" href="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="structiceberg_1_1ScanMetricsResult.html">ScanMetricsResult</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="structiceberg_1_1ScanMetricsResult-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::ScanMetricsResult Struct Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Immutable snapshot of scan metrics for use in <a class="el" href="structiceberg_1_1ScanReport.html" title="Report generated after a table scan operation.">ScanReport</a>. |
| <a href="structiceberg_1_1ScanMetricsResult.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="scan__report_8h_source.html">scan_report.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:a28b277b3e54309d7aa2ad48799fb4fd5" id="r_a28b277b3e54309d7aa2ad48799fb4fd5"><td class="memItemLeft" align="right" valign="top"><a id="a28b277b3e54309d7aa2ad48799fb4fd5" name="a28b277b3e54309d7aa2ad48799fb4fd5"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="structiceberg_1_1ScanMetricsResult.html">ScanMetricsResult</a> &) const =default</td></tr> |
| <tr class="separator:a28b277b3e54309d7aa2ad48799fb4fd5"><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:a155ef530d0bcb6fd1aeaf3c566222cdc" id="r_a155ef530d0bcb6fd1aeaf3c566222cdc"><td class="memItemLeft" align="right" valign="top"><a id="a155ef530d0bcb6fd1aeaf3c566222cdc" name="a155ef530d0bcb6fd1aeaf3c566222cdc"></a> |
| static <a class="el" href="structiceberg_1_1ScanMetricsResult.html">ScanMetricsResult</a> </td><td class="memItemRight" valign="bottom"><b>From</b> (const <a class="el" href="classiceberg_1_1ScanMetrics.html">ScanMetrics</a> &scan_metrics)</td></tr> |
| <tr class="memdesc:a155ef530d0bcb6fd1aeaf3c566222cdc"><td class="mdescLeft"> </td><td class="mdescRight">Build a <a class="el" href="structiceberg_1_1ScanMetricsResult.html" title="Immutable snapshot of scan metrics for use in ScanReport.">ScanMetricsResult</a> from live scan metrics. <br /></td></tr> |
| <tr class="separator:a155ef530d0bcb6fd1aeaf3c566222cdc"><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:a0bad97252ada931792f094064dfe31f4" id="r_a0bad97252ada931792f094064dfe31f4"><td class="memItemLeft" align="right" valign="top"><a id="a0bad97252ada931792f094064dfe31f4" name="a0bad97252ada931792f094064dfe31f4"></a> |
| std::optional< <a class="el" href="structiceberg_1_1TimerResult.html">TimerResult</a> > </td><td class="memItemRight" valign="bottom"><b>total_planning_duration</b></td></tr> |
| <tr class="memdesc:a0bad97252ada931792f094064dfe31f4"><td class="mdescLeft"> </td><td class="mdescRight">Total planning duration (count of recordings + accumulated nanoseconds). <br /></td></tr> |
| <tr class="separator:a0bad97252ada931792f094064dfe31f4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa0d265681bf064b1e1f9d16ceb8984b3" id="r_aa0d265681bf064b1e1f9d16ceb8984b3"><td class="memItemLeft" align="right" valign="top"><a id="aa0d265681bf064b1e1f9d16ceb8984b3" name="aa0d265681bf064b1e1f9d16ceb8984b3"></a> |
| std::optional< <a class="el" href="structiceberg_1_1CounterResult.html">CounterResult</a> > </td><td class="memItemRight" valign="bottom"><b>result_data_files</b></td></tr> |
| <tr class="memdesc:aa0d265681bf064b1e1f9d16ceb8984b3"><td class="mdescLeft"> </td><td class="mdescRight">Number of data files included in the scan result. <br /></td></tr> |
| <tr class="separator:aa0d265681bf064b1e1f9d16ceb8984b3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abae2ba65e6efdc9b3da9ef23a835bd41" id="r_abae2ba65e6efdc9b3da9ef23a835bd41"><td class="memItemLeft" align="right" valign="top"><a id="abae2ba65e6efdc9b3da9ef23a835bd41" name="abae2ba65e6efdc9b3da9ef23a835bd41"></a> |
| std::optional< <a class="el" href="structiceberg_1_1CounterResult.html">CounterResult</a> > </td><td class="memItemRight" valign="bottom"><b>result_delete_files</b></td></tr> |
| <tr class="memdesc:abae2ba65e6efdc9b3da9ef23a835bd41"><td class="mdescLeft"> </td><td class="mdescRight">Number of delete files included in the scan result. <br /></td></tr> |
| <tr class="separator:abae2ba65e6efdc9b3da9ef23a835bd41"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaab4912dac12d249db8d7a7adda35e26" id="r_aaab4912dac12d249db8d7a7adda35e26"><td class="memItemLeft" align="right" valign="top"><a id="aaab4912dac12d249db8d7a7adda35e26" name="aaab4912dac12d249db8d7a7adda35e26"></a> |
| std::optional< <a class="el" href="structiceberg_1_1CounterResult.html">CounterResult</a> > </td><td class="memItemRight" valign="bottom"><b>scanned_data_manifests</b></td></tr> |
| <tr class="memdesc:aaab4912dac12d249db8d7a7adda35e26"><td class="mdescLeft"> </td><td class="mdescRight">Number of data manifests whose files were read (not skipped). <br /></td></tr> |
| <tr class="separator:aaab4912dac12d249db8d7a7adda35e26"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afa0f6d6a3069cb549e2463555d2c1950" id="r_afa0f6d6a3069cb549e2463555d2c1950"><td class="memItemLeft" align="right" valign="top"><a id="afa0f6d6a3069cb549e2463555d2c1950" name="afa0f6d6a3069cb549e2463555d2c1950"></a> |
| std::optional< <a class="el" href="structiceberg_1_1CounterResult.html">CounterResult</a> > </td><td class="memItemRight" valign="bottom"><b>scanned_delete_manifests</b></td></tr> |
| <tr class="memdesc:afa0f6d6a3069cb549e2463555d2c1950"><td class="mdescLeft"> </td><td class="mdescRight">Number of delete manifests whose files were read (not skipped). <br /></td></tr> |
| <tr class="separator:afa0f6d6a3069cb549e2463555d2c1950"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1534e3b0d1cf4994bc9e441d41b178af" id="r_a1534e3b0d1cf4994bc9e441d41b178af"><td class="memItemLeft" align="right" valign="top"><a id="a1534e3b0d1cf4994bc9e441d41b178af" name="a1534e3b0d1cf4994bc9e441d41b178af"></a> |
| std::optional< <a class="el" href="structiceberg_1_1CounterResult.html">CounterResult</a> > </td><td class="memItemRight" valign="bottom"><b>total_data_manifests</b></td></tr> |
| <tr class="memdesc:a1534e3b0d1cf4994bc9e441d41b178af"><td class="mdescLeft"> </td><td class="mdescRight">Total number of data manifests in the snapshot. <br /></td></tr> |
| <tr class="separator:a1534e3b0d1cf4994bc9e441d41b178af"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8db5a4c57d115d451dc63565e1adcbfa" id="r_a8db5a4c57d115d451dc63565e1adcbfa"><td class="memItemLeft" align="right" valign="top"><a id="a8db5a4c57d115d451dc63565e1adcbfa" name="a8db5a4c57d115d451dc63565e1adcbfa"></a> |
| std::optional< <a class="el" href="structiceberg_1_1CounterResult.html">CounterResult</a> > </td><td class="memItemRight" valign="bottom"><b>total_delete_manifests</b></td></tr> |
| <tr class="memdesc:a8db5a4c57d115d451dc63565e1adcbfa"><td class="mdescLeft"> </td><td class="mdescRight">Total number of delete manifests in the snapshot. <br /></td></tr> |
| <tr class="separator:a8db5a4c57d115d451dc63565e1adcbfa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a28cb5434595150a60cdefbb9306384ea" id="r_a28cb5434595150a60cdefbb9306384ea"><td class="memItemLeft" align="right" valign="top"><a id="a28cb5434595150a60cdefbb9306384ea" name="a28cb5434595150a60cdefbb9306384ea"></a> |
| std::optional< <a class="el" href="structiceberg_1_1CounterResult.html">CounterResult</a> > </td><td class="memItemRight" valign="bottom"><b>total_file_size_in_bytes</b></td></tr> |
| <tr class="memdesc:a28cb5434595150a60cdefbb9306384ea"><td class="mdescLeft"> </td><td class="mdescRight">Total byte size of all result data files. <br /></td></tr> |
| <tr class="separator:a28cb5434595150a60cdefbb9306384ea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a95650e9b7986fa718d65904084175277" id="r_a95650e9b7986fa718d65904084175277"><td class="memItemLeft" align="right" valign="top"><a id="a95650e9b7986fa718d65904084175277" name="a95650e9b7986fa718d65904084175277"></a> |
| std::optional< <a class="el" href="structiceberg_1_1CounterResult.html">CounterResult</a> > </td><td class="memItemRight" valign="bottom"><b>total_delete_file_size_in_bytes</b></td></tr> |
| <tr class="memdesc:a95650e9b7986fa718d65904084175277"><td class="mdescLeft"> </td><td class="mdescRight">Total byte size of all result delete files. <br /></td></tr> |
| <tr class="separator:a95650e9b7986fa718d65904084175277"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abee069249143ffccc4a46749ef545f6c" id="r_abee069249143ffccc4a46749ef545f6c"><td class="memItemLeft" align="right" valign="top"><a id="abee069249143ffccc4a46749ef545f6c" name="abee069249143ffccc4a46749ef545f6c"></a> |
| std::optional< <a class="el" href="structiceberg_1_1CounterResult.html">CounterResult</a> > </td><td class="memItemRight" valign="bottom"><b>skipped_data_manifests</b></td></tr> |
| <tr class="memdesc:abee069249143ffccc4a46749ef545f6c"><td class="mdescLeft"> </td><td class="mdescRight">Number of data manifests skipped by partition/stats pruning. <br /></td></tr> |
| <tr class="separator:abee069249143ffccc4a46749ef545f6c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a966945cd62d095f1e4d26e406de17e26" id="r_a966945cd62d095f1e4d26e406de17e26"><td class="memItemLeft" align="right" valign="top"><a id="a966945cd62d095f1e4d26e406de17e26" name="a966945cd62d095f1e4d26e406de17e26"></a> |
| std::optional< <a class="el" href="structiceberg_1_1CounterResult.html">CounterResult</a> > </td><td class="memItemRight" valign="bottom"><b>skipped_delete_manifests</b></td></tr> |
| <tr class="memdesc:a966945cd62d095f1e4d26e406de17e26"><td class="mdescLeft"> </td><td class="mdescRight">Number of delete manifests skipped by partition/stats pruning. <br /></td></tr> |
| <tr class="separator:a966945cd62d095f1e4d26e406de17e26"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0c8c733275745e2690e7759802473f01" id="r_a0c8c733275745e2690e7759802473f01"><td class="memItemLeft" align="right" valign="top"><a id="a0c8c733275745e2690e7759802473f01" name="a0c8c733275745e2690e7759802473f01"></a> |
| std::optional< <a class="el" href="structiceberg_1_1CounterResult.html">CounterResult</a> > </td><td class="memItemRight" valign="bottom"><b>skipped_data_files</b></td></tr> |
| <tr class="memdesc:a0c8c733275745e2690e7759802473f01"><td class="mdescLeft"> </td><td class="mdescRight">Number of individual data files skipped by stats pruning. <br /></td></tr> |
| <tr class="separator:a0c8c733275745e2690e7759802473f01"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1db5aabe44923227008407ef8ef5f55c" id="r_a1db5aabe44923227008407ef8ef5f55c"><td class="memItemLeft" align="right" valign="top"><a id="a1db5aabe44923227008407ef8ef5f55c" name="a1db5aabe44923227008407ef8ef5f55c"></a> |
| std::optional< <a class="el" href="structiceberg_1_1CounterResult.html">CounterResult</a> > </td><td class="memItemRight" valign="bottom"><b>skipped_delete_files</b></td></tr> |
| <tr class="memdesc:a1db5aabe44923227008407ef8ef5f55c"><td class="mdescLeft"> </td><td class="mdescRight">Number of individual delete files skipped by stats pruning. <br /></td></tr> |
| <tr class="separator:a1db5aabe44923227008407ef8ef5f55c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad3f82c94d0869704045774493f1830c7" id="r_ad3f82c94d0869704045774493f1830c7"><td class="memItemLeft" align="right" valign="top"><a id="ad3f82c94d0869704045774493f1830c7" name="ad3f82c94d0869704045774493f1830c7"></a> |
| std::optional< <a class="el" href="structiceberg_1_1CounterResult.html">CounterResult</a> > </td><td class="memItemRight" valign="bottom"><b>indexed_delete_files</b></td></tr> |
| <tr class="memdesc:ad3f82c94d0869704045774493f1830c7"><td class="mdescLeft"> </td><td class="mdescRight">Number of indexed delete files (positional or DV) in the result. <br /></td></tr> |
| <tr class="separator:ad3f82c94d0869704045774493f1830c7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9859494079158f00988e9dd2c6424190" id="r_a9859494079158f00988e9dd2c6424190"><td class="memItemLeft" align="right" valign="top"><a id="a9859494079158f00988e9dd2c6424190" name="a9859494079158f00988e9dd2c6424190"></a> |
| std::optional< <a class="el" href="structiceberg_1_1CounterResult.html">CounterResult</a> > </td><td class="memItemRight" valign="bottom"><b>equality_delete_files</b></td></tr> |
| <tr class="memdesc:a9859494079158f00988e9dd2c6424190"><td class="mdescLeft"> </td><td class="mdescRight">Number of equality delete files in the result. <br /></td></tr> |
| <tr class="separator:a9859494079158f00988e9dd2c6424190"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8a49aa2101e754ac818201243ab6cf95" id="r_a8a49aa2101e754ac818201243ab6cf95"><td class="memItemLeft" align="right" valign="top"><a id="a8a49aa2101e754ac818201243ab6cf95" name="a8a49aa2101e754ac818201243ab6cf95"></a> |
| std::optional< <a class="el" href="structiceberg_1_1CounterResult.html">CounterResult</a> > </td><td class="memItemRight" valign="bottom"><b>positional_delete_files</b></td></tr> |
| <tr class="memdesc:a8a49aa2101e754ac818201243ab6cf95"><td class="mdescLeft"> </td><td class="mdescRight">Number of positional delete files in the result. <br /></td></tr> |
| <tr class="separator:a8a49aa2101e754ac818201243ab6cf95"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aab9175ea4cc292e811498e351d4eff50" id="r_aab9175ea4cc292e811498e351d4eff50"><td class="memItemLeft" align="right" valign="top"><a id="aab9175ea4cc292e811498e351d4eff50" name="aab9175ea4cc292e811498e351d4eff50"></a> |
| std::optional< <a class="el" href="structiceberg_1_1CounterResult.html">CounterResult</a> > </td><td class="memItemRight" valign="bottom"><b>dvs</b></td></tr> |
| <tr class="memdesc:aab9175ea4cc292e811498e351d4eff50"><td class="mdescLeft"> </td><td class="mdescRight">Number of deletion vectors in the result. <br /></td></tr> |
| <tr class="separator:aab9175ea4cc292e811498e351d4eff50"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Immutable snapshot of scan metrics for use in <a class="el" href="structiceberg_1_1ScanReport.html" title="Report generated after a table scan operation.">ScanReport</a>. </p> |
| <p>Populated by <a class="el" href="classiceberg_1_1ScanMetrics.html#aceaf909e93eb63ad83fa613ac4daa588" title="Snapshot current counter/timer values into a ScanMetricsResult.">ScanMetrics::ToResult()</a> after a scan completes. </p> |
| </div><hr/>The documentation for this struct was generated from the following file:<ul> |
| <li>iceberg/metrics/<a class="el" href="scan__report_8h_source.html">scan_report.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> |
