blob: f3a62b4cc6a25ba632371cb92076552eda2549a1 [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/metrics/scan_report.h Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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="dir_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_5dc26e7e5886cb79baf1860f841364b7.html">metrics</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">scan_report.h</div></div>
</div><!--header-->
<div class="contents">
<a href="scan__report_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include &lt;optional&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &lt;unordered_map&gt;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include &quot;<a class="code" href="constants_8h.html">iceberg/constants.h</a>&quot;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include &quot;<a class="code" href="expression_8h.html">iceberg/expression/expression.h</a>&quot;</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include &quot;<a class="code" href="iceberg__export_8h.html">iceberg/iceberg_export.h</a>&quot;</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#include &quot;<a class="code" href="metrics__context_8h.html">iceberg/metrics/metrics_context.h</a>&quot;</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#include &quot;<a class="code" href="metrics__types_8h.html">iceberg/metrics/metrics_types.h</a>&quot;</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#include &quot;<a class="code" href="timer_8h.html">iceberg/metrics/timer.h</a>&quot;</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg.html">iceberg</a> {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment">// Forward declaration: ScanMetrics is defined later in this header.</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keyword">class </span>ScanMetrics;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="foldopen" id="foldopen00046" data-start="{" data-end="};">
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html"> 46</a></span><span class="keyword">struct </span>ICEBERG_EXPORT <a class="code hl_struct" href="structiceberg_1_1ScanMetricsResult.html">ScanMetricsResult</a> {</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#a0bad97252ada931792f094064dfe31f4"> 48</a></span> std::optional&lt;TimerResult&gt; <a class="code hl_variable" href="structiceberg_1_1ScanMetricsResult.html#a0bad97252ada931792f094064dfe31f4">total_planning_duration</a>;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#aa0d265681bf064b1e1f9d16ceb8984b3"> 50</a></span> std::optional&lt;CounterResult&gt; <a class="code hl_variable" href="structiceberg_1_1ScanMetricsResult.html#aa0d265681bf064b1e1f9d16ceb8984b3">result_data_files</a>;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#abae2ba65e6efdc9b3da9ef23a835bd41"> 52</a></span> std::optional&lt;CounterResult&gt; <a class="code hl_variable" href="structiceberg_1_1ScanMetricsResult.html#abae2ba65e6efdc9b3da9ef23a835bd41">result_delete_files</a>;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#aaab4912dac12d249db8d7a7adda35e26"> 54</a></span> std::optional&lt;CounterResult&gt; <a class="code hl_variable" href="structiceberg_1_1ScanMetricsResult.html#aaab4912dac12d249db8d7a7adda35e26">scanned_data_manifests</a>;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#afa0f6d6a3069cb549e2463555d2c1950"> 56</a></span> std::optional&lt;CounterResult&gt; <a class="code hl_variable" href="structiceberg_1_1ScanMetricsResult.html#afa0f6d6a3069cb549e2463555d2c1950">scanned_delete_manifests</a>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#a1534e3b0d1cf4994bc9e441d41b178af"> 58</a></span> std::optional&lt;CounterResult&gt; <a class="code hl_variable" href="structiceberg_1_1ScanMetricsResult.html#a1534e3b0d1cf4994bc9e441d41b178af">total_data_manifests</a>;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#a8db5a4c57d115d451dc63565e1adcbfa"> 60</a></span> std::optional&lt;CounterResult&gt; <a class="code hl_variable" href="structiceberg_1_1ScanMetricsResult.html#a8db5a4c57d115d451dc63565e1adcbfa">total_delete_manifests</a>;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#a28cb5434595150a60cdefbb9306384ea"> 62</a></span> std::optional&lt;CounterResult&gt; <a class="code hl_variable" href="structiceberg_1_1ScanMetricsResult.html#a28cb5434595150a60cdefbb9306384ea">total_file_size_in_bytes</a>;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#a95650e9b7986fa718d65904084175277"> 64</a></span> std::optional&lt;CounterResult&gt; <a class="code hl_variable" href="structiceberg_1_1ScanMetricsResult.html#a95650e9b7986fa718d65904084175277">total_delete_file_size_in_bytes</a>;</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#abee069249143ffccc4a46749ef545f6c"> 66</a></span> std::optional&lt;CounterResult&gt; <a class="code hl_variable" href="structiceberg_1_1ScanMetricsResult.html#abee069249143ffccc4a46749ef545f6c">skipped_data_manifests</a>;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#a966945cd62d095f1e4d26e406de17e26"> 68</a></span> std::optional&lt;CounterResult&gt; <a class="code hl_variable" href="structiceberg_1_1ScanMetricsResult.html#a966945cd62d095f1e4d26e406de17e26">skipped_delete_manifests</a>;</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#a0c8c733275745e2690e7759802473f01"> 70</a></span> std::optional&lt;CounterResult&gt; <a class="code hl_variable" href="structiceberg_1_1ScanMetricsResult.html#a0c8c733275745e2690e7759802473f01">skipped_data_files</a>;</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#a1db5aabe44923227008407ef8ef5f55c"> 72</a></span> std::optional&lt;CounterResult&gt; <a class="code hl_variable" href="structiceberg_1_1ScanMetricsResult.html#a1db5aabe44923227008407ef8ef5f55c">skipped_delete_files</a>;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#ad3f82c94d0869704045774493f1830c7"> 74</a></span> std::optional&lt;CounterResult&gt; <a class="code hl_variable" href="structiceberg_1_1ScanMetricsResult.html#ad3f82c94d0869704045774493f1830c7">indexed_delete_files</a>;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#a9859494079158f00988e9dd2c6424190"> 76</a></span> std::optional&lt;CounterResult&gt; <a class="code hl_variable" href="structiceberg_1_1ScanMetricsResult.html#a9859494079158f00988e9dd2c6424190">equality_delete_files</a>;</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#a8a49aa2101e754ac818201243ab6cf95"> 78</a></span> std::optional&lt;CounterResult&gt; <a class="code hl_variable" href="structiceberg_1_1ScanMetricsResult.html#a8a49aa2101e754ac818201243ab6cf95">positional_delete_files</a>;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#aab9175ea4cc292e811498e351d4eff50"> 80</a></span> std::optional&lt;CounterResult&gt; <a class="code hl_variable" href="structiceberg_1_1ScanMetricsResult.html#aab9175ea4cc292e811498e351d4eff50">dvs</a>;</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1ScanMetricsResult.html">ScanMetricsResult</a>&amp;) <span class="keyword">const</span> = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanMetricsResult.html#a155ef530d0bcb6fd1aeaf3c566222cdc"> 85</a></span> <span class="keyword">static</span> <a class="code hl_struct" href="structiceberg_1_1ScanMetricsResult.html">ScanMetricsResult</a> <a class="code hl_function" href="structiceberg_1_1ScanMetricsResult.html#a155ef530d0bcb6fd1aeaf3c566222cdc">From</a>(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1ScanMetrics.html">ScanMetrics</a>&amp; scan_metrics);</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span>};</div>
</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="foldopen" id="foldopen00094" data-start="{" data-end="};">
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="classiceberg_1_1ScanMetrics.html"> 94</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1ScanMetrics.html">ScanMetrics</a> {</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="classiceberg_1_1ScanMetrics.html#af019ee08f851f148bc5ed91db9a31b66"> 97</a></span> <span class="keyword">static</span> std::unique_ptr&lt;ScanMetrics&gt; <a class="code hl_function" href="classiceberg_1_1ScanMetrics.html#af019ee08f851f148bc5ed91db9a31b66">Make</a>(<a class="code hl_class" href="classiceberg_1_1MetricsContext.html">MetricsContext</a>&amp; context);</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"><a class="line" href="classiceberg_1_1ScanMetrics.html#a7d06baa3ce0e3ca52aff17570dcf510e"> 100</a></span> <span class="keyword">static</span> std::unique_ptr&lt;ScanMetrics&gt; <a class="code hl_function" href="classiceberg_1_1ScanMetrics.html#a7d06baa3ce0e3ca52aff17570dcf510e">Noop</a>();</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="classiceberg_1_1ScanMetrics.html#aceaf909e93eb63ad83fa613ac4daa588"> 103</a></span> <a class="code hl_struct" href="structiceberg_1_1ScanMetricsResult.html">ScanMetricsResult</a> <a class="code hl_function" href="classiceberg_1_1ScanMetrics.html#aceaf909e93eb63ad83fa613ac4daa588">ToResult</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> std::shared_ptr&lt;Timer&gt; total_planning_duration;</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> std::shared_ptr&lt;Counter&gt; result_data_files;</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> std::shared_ptr&lt;Counter&gt; result_delete_files;</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> std::shared_ptr&lt;Counter&gt; scanned_data_manifests;</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> std::shared_ptr&lt;Counter&gt; scanned_delete_manifests;</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> std::shared_ptr&lt;Counter&gt; total_data_manifests;</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> std::shared_ptr&lt;Counter&gt; total_delete_manifests;</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> std::shared_ptr&lt;Counter&gt; total_file_size_in_bytes;</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> std::shared_ptr&lt;Counter&gt; total_delete_file_size_in_bytes;</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> std::shared_ptr&lt;Counter&gt; skipped_data_manifests;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> std::shared_ptr&lt;Counter&gt; skipped_delete_manifests;</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> std::shared_ptr&lt;Counter&gt; skipped_data_files;</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> std::shared_ptr&lt;Counter&gt; skipped_delete_files;</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> std::shared_ptr&lt;Counter&gt; indexed_delete_files;</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> std::shared_ptr&lt;Counter&gt; equality_delete_files;</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> std::shared_ptr&lt;Counter&gt; positional_delete_files;</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> std::shared_ptr&lt;Counter&gt; dvs;</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> <a class="code hl_class" href="classiceberg_1_1ScanMetrics.html">ScanMetrics</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span>};</div>
</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div>
<div class="foldopen" id="foldopen00131" data-start="{" data-end="};">
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanReport.html"> 131</a></span><span class="keyword">struct </span>ICEBERG_EXPORT <a class="code hl_struct" href="structiceberg_1_1ScanReport.html">ScanReport</a> {</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanReport.html#abc161296ef9e1b89536f8f6bb46e18cf"> 133</a></span> std::string <a class="code hl_variable" href="structiceberg_1_1ScanReport.html#abc161296ef9e1b89536f8f6bb46e18cf">table_name</a>;</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanReport.html#ae4828a6c6ffad2ef516dacde7e153f32"> 135</a></span> int64_t snapshot_id = kInvalidSnapshotId;</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanReport.html#ae63b1a68ead475bb4834e7d2d79b0534"> 137</a></span> std::shared_ptr&lt;Expression&gt; <a class="code hl_variable" href="structiceberg_1_1ScanReport.html#ae63b1a68ead475bb4834e7d2d79b0534">filter</a>;</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanReport.html#a40625c69ed22ebac32fec49119c6b38c"> 139</a></span> int32_t schema_id = kInvalidSchemaId;</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanReport.html#a2198a16bf30531c8819e02921cd71713"> 141</a></span> std::vector&lt;int32_t&gt; <a class="code hl_variable" href="structiceberg_1_1ScanReport.html#a2198a16bf30531c8819e02921cd71713">projected_field_ids</a>;</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanReport.html#a9d3365b4cc7406d9cd6e75b69890a40a"> 143</a></span> std::vector&lt;std::string&gt; <a class="code hl_variable" href="structiceberg_1_1ScanReport.html#a9d3365b4cc7406d9cd6e75b69890a40a">projected_field_names</a>;</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanReport.html#af511720e6d75778159ddb339fc420af7"> 145</a></span> <a class="code hl_struct" href="structiceberg_1_1ScanMetricsResult.html">ScanMetricsResult</a> <a class="code hl_variable" href="structiceberg_1_1ScanReport.html#af511720e6d75778159ddb339fc420af7">scan_metrics</a>;</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"><a class="line" href="structiceberg_1_1ScanReport.html#ae0ffd9a428087d48e322d542bd37e4ba"> 147</a></span> std::unordered_map&lt;std::string, std::string&gt; <a class="code hl_variable" href="structiceberg_1_1ScanReport.html#ae0ffd9a428087d48e322d542bd37e4ba">metadata</a>;</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span>};</div>
</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> </div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span>} <span class="comment">// namespace iceberg</span></div>
<div class="ttc" id="aclassiceberg_1_1MetricsContext_html"><div class="ttname"><a href="classiceberg_1_1MetricsContext.html">iceberg::MetricsContext</a></div><div class="ttdoc">Factory for creating named Counter and Timer instances.</div><div class="ttdef"><b>Definition</b> metrics_context.h:35</div></div>
<div class="ttc" id="aclassiceberg_1_1ScanMetrics_html"><div class="ttname"><a href="classiceberg_1_1ScanMetrics.html">iceberg::ScanMetrics</a></div><div class="ttdoc">Live scan metrics collected during a table scan operation.</div><div class="ttdef"><b>Definition</b> scan_report.h:94</div></div>
<div class="ttc" id="aclassiceberg_1_1ScanMetrics_html_a7d06baa3ce0e3ca52aff17570dcf510e"><div class="ttname"><a href="classiceberg_1_1ScanMetrics.html#a7d06baa3ce0e3ca52aff17570dcf510e">iceberg::ScanMetrics::Noop</a></div><div class="ttdeci">static std::unique_ptr&lt; ScanMetrics &gt; Noop()</div><div class="ttdoc">Create a ScanMetrics instance with all-noop counters and timer.</div></div>
<div class="ttc" id="aclassiceberg_1_1ScanMetrics_html_aceaf909e93eb63ad83fa613ac4daa588"><div class="ttname"><a href="classiceberg_1_1ScanMetrics.html#aceaf909e93eb63ad83fa613ac4daa588">iceberg::ScanMetrics::ToResult</a></div><div class="ttdeci">ScanMetricsResult ToResult() const</div><div class="ttdoc">Snapshot current counter/timer values into a ScanMetricsResult.</div></div>
<div class="ttc" id="aclassiceberg_1_1ScanMetrics_html_af019ee08f851f148bc5ed91db9a31b66"><div class="ttname"><a href="classiceberg_1_1ScanMetrics.html#af019ee08f851f148bc5ed91db9a31b66">iceberg::ScanMetrics::Make</a></div><div class="ttdeci">static std::unique_ptr&lt; ScanMetrics &gt; Make(MetricsContext &amp;context)</div><div class="ttdoc">Create a ScanMetrics instance backed by the given MetricsContext.</div></div>
<div class="ttc" id="aconstants_8h_html"><div class="ttname"><a href="constants_8h.html">constants.h</a></div></div>
<div class="ttc" id="aexpression_8h_html"><div class="ttname"><a href="expression_8h.html">expression.h</a></div></div>
<div class="ttc" id="aiceberg__export_8h_html"><div class="ttname"><a href="iceberg__export_8h.html">iceberg_export.h</a></div><div class="ttdoc">Define symbol visibility macros for core Iceberg APIs.</div></div>
<div class="ttc" id="ametrics__context_8h_html"><div class="ttname"><a href="metrics__context_8h.html">metrics_context.h</a></div><div class="ttdoc">Factory interface for creating named Counter and Timer instances.</div></div>
<div class="ttc" id="ametrics__types_8h_html"><div class="ttname"><a href="metrics__types_8h.html">metrics_types.h</a></div><div class="ttdoc">Serialisable snapshot types shared across scan and commit metrics.</div></div>
<div class="ttc" id="anamespaceiceberg_html"><div class="ttname"><a href="namespaceiceberg.html">iceberg</a></div><div class="ttdoc">Core Apache Iceberg C++ APIs.</div><div class="ttdef"><b>Definition</b> arrow_io_util.h:33</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html">iceberg::ScanMetricsResult</a></div><div class="ttdoc">Immutable snapshot of scan metrics for use in ScanReport.</div><div class="ttdef"><b>Definition</b> scan_report.h:46</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_a0bad97252ada931792f094064dfe31f4"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#a0bad97252ada931792f094064dfe31f4">iceberg::ScanMetricsResult::total_planning_duration</a></div><div class="ttdeci">std::optional&lt; TimerResult &gt; total_planning_duration</div><div class="ttdoc">Total planning duration (count of recordings + accumulated nanoseconds).</div><div class="ttdef"><b>Definition</b> scan_report.h:48</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_a0c8c733275745e2690e7759802473f01"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#a0c8c733275745e2690e7759802473f01">iceberg::ScanMetricsResult::skipped_data_files</a></div><div class="ttdeci">std::optional&lt; CounterResult &gt; skipped_data_files</div><div class="ttdoc">Number of individual data files skipped by stats pruning.</div><div class="ttdef"><b>Definition</b> scan_report.h:70</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_a1534e3b0d1cf4994bc9e441d41b178af"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#a1534e3b0d1cf4994bc9e441d41b178af">iceberg::ScanMetricsResult::total_data_manifests</a></div><div class="ttdeci">std::optional&lt; CounterResult &gt; total_data_manifests</div><div class="ttdoc">Total number of data manifests in the snapshot.</div><div class="ttdef"><b>Definition</b> scan_report.h:58</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_a155ef530d0bcb6fd1aeaf3c566222cdc"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#a155ef530d0bcb6fd1aeaf3c566222cdc">iceberg::ScanMetricsResult::From</a></div><div class="ttdeci">static ScanMetricsResult From(const ScanMetrics &amp;scan_metrics)</div><div class="ttdoc">Build a ScanMetricsResult from live scan metrics.</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_a1db5aabe44923227008407ef8ef5f55c"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#a1db5aabe44923227008407ef8ef5f55c">iceberg::ScanMetricsResult::skipped_delete_files</a></div><div class="ttdeci">std::optional&lt; CounterResult &gt; skipped_delete_files</div><div class="ttdoc">Number of individual delete files skipped by stats pruning.</div><div class="ttdef"><b>Definition</b> scan_report.h:72</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_a28cb5434595150a60cdefbb9306384ea"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#a28cb5434595150a60cdefbb9306384ea">iceberg::ScanMetricsResult::total_file_size_in_bytes</a></div><div class="ttdeci">std::optional&lt; CounterResult &gt; total_file_size_in_bytes</div><div class="ttdoc">Total byte size of all result data files.</div><div class="ttdef"><b>Definition</b> scan_report.h:62</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_a8a49aa2101e754ac818201243ab6cf95"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#a8a49aa2101e754ac818201243ab6cf95">iceberg::ScanMetricsResult::positional_delete_files</a></div><div class="ttdeci">std::optional&lt; CounterResult &gt; positional_delete_files</div><div class="ttdoc">Number of positional delete files in the result.</div><div class="ttdef"><b>Definition</b> scan_report.h:78</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_a8db5a4c57d115d451dc63565e1adcbfa"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#a8db5a4c57d115d451dc63565e1adcbfa">iceberg::ScanMetricsResult::total_delete_manifests</a></div><div class="ttdeci">std::optional&lt; CounterResult &gt; total_delete_manifests</div><div class="ttdoc">Total number of delete manifests in the snapshot.</div><div class="ttdef"><b>Definition</b> scan_report.h:60</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_a95650e9b7986fa718d65904084175277"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#a95650e9b7986fa718d65904084175277">iceberg::ScanMetricsResult::total_delete_file_size_in_bytes</a></div><div class="ttdeci">std::optional&lt; CounterResult &gt; total_delete_file_size_in_bytes</div><div class="ttdoc">Total byte size of all result delete files.</div><div class="ttdef"><b>Definition</b> scan_report.h:64</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_a966945cd62d095f1e4d26e406de17e26"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#a966945cd62d095f1e4d26e406de17e26">iceberg::ScanMetricsResult::skipped_delete_manifests</a></div><div class="ttdeci">std::optional&lt; CounterResult &gt; skipped_delete_manifests</div><div class="ttdoc">Number of delete manifests skipped by partition/stats pruning.</div><div class="ttdef"><b>Definition</b> scan_report.h:68</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_a9859494079158f00988e9dd2c6424190"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#a9859494079158f00988e9dd2c6424190">iceberg::ScanMetricsResult::equality_delete_files</a></div><div class="ttdeci">std::optional&lt; CounterResult &gt; equality_delete_files</div><div class="ttdoc">Number of equality delete files in the result.</div><div class="ttdef"><b>Definition</b> scan_report.h:76</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_aa0d265681bf064b1e1f9d16ceb8984b3"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#aa0d265681bf064b1e1f9d16ceb8984b3">iceberg::ScanMetricsResult::result_data_files</a></div><div class="ttdeci">std::optional&lt; CounterResult &gt; result_data_files</div><div class="ttdoc">Number of data files included in the scan result.</div><div class="ttdef"><b>Definition</b> scan_report.h:50</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_aaab4912dac12d249db8d7a7adda35e26"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#aaab4912dac12d249db8d7a7adda35e26">iceberg::ScanMetricsResult::scanned_data_manifests</a></div><div class="ttdeci">std::optional&lt; CounterResult &gt; scanned_data_manifests</div><div class="ttdoc">Number of data manifests whose files were read (not skipped).</div><div class="ttdef"><b>Definition</b> scan_report.h:54</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_aab9175ea4cc292e811498e351d4eff50"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#aab9175ea4cc292e811498e351d4eff50">iceberg::ScanMetricsResult::dvs</a></div><div class="ttdeci">std::optional&lt; CounterResult &gt; dvs</div><div class="ttdoc">Number of deletion vectors in the result.</div><div class="ttdef"><b>Definition</b> scan_report.h:80</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_abae2ba65e6efdc9b3da9ef23a835bd41"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#abae2ba65e6efdc9b3da9ef23a835bd41">iceberg::ScanMetricsResult::result_delete_files</a></div><div class="ttdeci">std::optional&lt; CounterResult &gt; result_delete_files</div><div class="ttdoc">Number of delete files included in the scan result.</div><div class="ttdef"><b>Definition</b> scan_report.h:52</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_abee069249143ffccc4a46749ef545f6c"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#abee069249143ffccc4a46749ef545f6c">iceberg::ScanMetricsResult::skipped_data_manifests</a></div><div class="ttdeci">std::optional&lt; CounterResult &gt; skipped_data_manifests</div><div class="ttdoc">Number of data manifests skipped by partition/stats pruning.</div><div class="ttdef"><b>Definition</b> scan_report.h:66</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_ad3f82c94d0869704045774493f1830c7"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#ad3f82c94d0869704045774493f1830c7">iceberg::ScanMetricsResult::indexed_delete_files</a></div><div class="ttdeci">std::optional&lt; CounterResult &gt; indexed_delete_files</div><div class="ttdoc">Number of indexed delete files (positional or DV) in the result.</div><div class="ttdef"><b>Definition</b> scan_report.h:74</div></div>
<div class="ttc" id="astructiceberg_1_1ScanMetricsResult_html_afa0f6d6a3069cb549e2463555d2c1950"><div class="ttname"><a href="structiceberg_1_1ScanMetricsResult.html#afa0f6d6a3069cb549e2463555d2c1950">iceberg::ScanMetricsResult::scanned_delete_manifests</a></div><div class="ttdeci">std::optional&lt; CounterResult &gt; scanned_delete_manifests</div><div class="ttdoc">Number of delete manifests whose files were read (not skipped).</div><div class="ttdef"><b>Definition</b> scan_report.h:56</div></div>
<div class="ttc" id="astructiceberg_1_1ScanReport_html"><div class="ttname"><a href="structiceberg_1_1ScanReport.html">iceberg::ScanReport</a></div><div class="ttdoc">Report generated after a table scan operation.</div><div class="ttdef"><b>Definition</b> scan_report.h:131</div></div>
<div class="ttc" id="astructiceberg_1_1ScanReport_html_a2198a16bf30531c8819e02921cd71713"><div class="ttname"><a href="structiceberg_1_1ScanReport.html#a2198a16bf30531c8819e02921cd71713">iceberg::ScanReport::projected_field_ids</a></div><div class="ttdeci">std::vector&lt; int32_t &gt; projected_field_ids</div><div class="ttdoc">Projected field IDs from the scan schema.</div><div class="ttdef"><b>Definition</b> scan_report.h:141</div></div>
<div class="ttc" id="astructiceberg_1_1ScanReport_html_a9d3365b4cc7406d9cd6e75b69890a40a"><div class="ttname"><a href="structiceberg_1_1ScanReport.html#a9d3365b4cc7406d9cd6e75b69890a40a">iceberg::ScanReport::projected_field_names</a></div><div class="ttdeci">std::vector&lt; std::string &gt; projected_field_names</div><div class="ttdoc">Projected field names from the scan schema.</div><div class="ttdef"><b>Definition</b> scan_report.h:143</div></div>
<div class="ttc" id="astructiceberg_1_1ScanReport_html_abc161296ef9e1b89536f8f6bb46e18cf"><div class="ttname"><a href="structiceberg_1_1ScanReport.html#abc161296ef9e1b89536f8f6bb46e18cf">iceberg::ScanReport::table_name</a></div><div class="ttdeci">std::string table_name</div><div class="ttdoc">The fully qualified name of the table that was scanned.</div><div class="ttdef"><b>Definition</b> scan_report.h:133</div></div>
<div class="ttc" id="astructiceberg_1_1ScanReport_html_ae0ffd9a428087d48e322d542bd37e4ba"><div class="ttname"><a href="structiceberg_1_1ScanReport.html#ae0ffd9a428087d48e322d542bd37e4ba">iceberg::ScanReport::metadata</a></div><div class="ttdeci">std::unordered_map&lt; std::string, std::string &gt; metadata</div><div class="ttdoc">Additional key-value metadata.</div><div class="ttdef"><b>Definition</b> scan_report.h:147</div></div>
<div class="ttc" id="astructiceberg_1_1ScanReport_html_ae63b1a68ead475bb4834e7d2d79b0534"><div class="ttname"><a href="structiceberg_1_1ScanReport.html#ae63b1a68ead475bb4834e7d2d79b0534">iceberg::ScanReport::filter</a></div><div class="ttdeci">std::shared_ptr&lt; Expression &gt; filter</div><div class="ttdoc">Filter expression used in the scan, if any.</div><div class="ttdef"><b>Definition</b> scan_report.h:137</div></div>
<div class="ttc" id="astructiceberg_1_1ScanReport_html_af511720e6d75778159ddb339fc420af7"><div class="ttname"><a href="structiceberg_1_1ScanReport.html#af511720e6d75778159ddb339fc420af7">iceberg::ScanReport::scan_metrics</a></div><div class="ttdeci">ScanMetricsResult scan_metrics</div><div class="ttdoc">Metrics collected during the scan operation.</div><div class="ttdef"><b>Definition</b> scan_report.h:145</div></div>
<div class="ttc" id="atimer_8h_html"><div class="ttname"><a href="timer_8h.html">timer.h</a></div><div class="ttdoc">Define metrics timers.</div></div>
</div><!-- fragment --></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>