| <!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::ScanReport 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_1ScanReport.html">ScanReport</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="structiceberg_1_1ScanReport-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::ScanReport Struct Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Report generated after a table scan operation. |
| <a href="structiceberg_1_1ScanReport.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-attribs" name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:abc161296ef9e1b89536f8f6bb46e18cf" id="r_abc161296ef9e1b89536f8f6bb46e18cf"><td class="memItemLeft" align="right" valign="top"><a id="abc161296ef9e1b89536f8f6bb46e18cf" name="abc161296ef9e1b89536f8f6bb46e18cf"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><b>table_name</b></td></tr> |
| <tr class="memdesc:abc161296ef9e1b89536f8f6bb46e18cf"><td class="mdescLeft"> </td><td class="mdescRight">The fully qualified name of the table that was scanned. <br /></td></tr> |
| <tr class="separator:abc161296ef9e1b89536f8f6bb46e18cf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae4828a6c6ffad2ef516dacde7e153f32" id="r_ae4828a6c6ffad2ef516dacde7e153f32"><td class="memItemLeft" align="right" valign="top"><a id="ae4828a6c6ffad2ef516dacde7e153f32" name="ae4828a6c6ffad2ef516dacde7e153f32"></a> |
| int64_t </td><td class="memItemRight" valign="bottom"><b>snapshot_id</b> = kInvalidSnapshotId</td></tr> |
| <tr class="memdesc:ae4828a6c6ffad2ef516dacde7e153f32"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structiceberg_1_1Snapshot.html" title="A snapshot of the data in a table at a point in time.">Snapshot</a> ID that was scanned, if available. <br /></td></tr> |
| <tr class="separator:ae4828a6c6ffad2ef516dacde7e153f32"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae63b1a68ead475bb4834e7d2d79b0534" id="r_ae63b1a68ead475bb4834e7d2d79b0534"><td class="memItemLeft" align="right" valign="top"><a id="ae63b1a68ead475bb4834e7d2d79b0534" name="ae63b1a68ead475bb4834e7d2d79b0534"></a> |
| std::shared_ptr< <a class="el" href="classiceberg_1_1Expression.html">Expression</a> > </td><td class="memItemRight" valign="bottom"><b>filter</b></td></tr> |
| <tr class="memdesc:ae63b1a68ead475bb4834e7d2d79b0534"><td class="mdescLeft"> </td><td class="mdescRight">Filter expression used in the scan, if any. <br /></td></tr> |
| <tr class="separator:ae63b1a68ead475bb4834e7d2d79b0534"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a40625c69ed22ebac32fec49119c6b38c" id="r_a40625c69ed22ebac32fec49119c6b38c"><td class="memItemLeft" align="right" valign="top"><a id="a40625c69ed22ebac32fec49119c6b38c" name="a40625c69ed22ebac32fec49119c6b38c"></a> |
| int32_t </td><td class="memItemRight" valign="bottom"><b>schema_id</b> = kInvalidSchemaId</td></tr> |
| <tr class="memdesc:a40625c69ed22ebac32fec49119c6b38c"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classiceberg_1_1Schema.html" title="A schema for a Table.">Schema</a> ID. <br /></td></tr> |
| <tr class="separator:a40625c69ed22ebac32fec49119c6b38c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2198a16bf30531c8819e02921cd71713" id="r_a2198a16bf30531c8819e02921cd71713"><td class="memItemLeft" align="right" valign="top"><a id="a2198a16bf30531c8819e02921cd71713" name="a2198a16bf30531c8819e02921cd71713"></a> |
| std::vector< int32_t > </td><td class="memItemRight" valign="bottom"><b>projected_field_ids</b></td></tr> |
| <tr class="memdesc:a2198a16bf30531c8819e02921cd71713"><td class="mdescLeft"> </td><td class="mdescRight">Projected field IDs from the scan schema. <br /></td></tr> |
| <tr class="separator:a2198a16bf30531c8819e02921cd71713"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9d3365b4cc7406d9cd6e75b69890a40a" id="r_a9d3365b4cc7406d9cd6e75b69890a40a"><td class="memItemLeft" align="right" valign="top"><a id="a9d3365b4cc7406d9cd6e75b69890a40a" name="a9d3365b4cc7406d9cd6e75b69890a40a"></a> |
| std::vector< std::string > </td><td class="memItemRight" valign="bottom"><b>projected_field_names</b></td></tr> |
| <tr class="memdesc:a9d3365b4cc7406d9cd6e75b69890a40a"><td class="mdescLeft"> </td><td class="mdescRight">Projected field names from the scan schema. <br /></td></tr> |
| <tr class="separator:a9d3365b4cc7406d9cd6e75b69890a40a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af511720e6d75778159ddb339fc420af7" id="r_af511720e6d75778159ddb339fc420af7"><td class="memItemLeft" align="right" valign="top"><a id="af511720e6d75778159ddb339fc420af7" name="af511720e6d75778159ddb339fc420af7"></a> |
| <a class="el" href="structiceberg_1_1ScanMetricsResult.html">ScanMetricsResult</a> </td><td class="memItemRight" valign="bottom"><b>scan_metrics</b></td></tr> |
| <tr class="memdesc:af511720e6d75778159ddb339fc420af7"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structiceberg_1_1Metrics.html" title="Iceberg file format metrics.">Metrics</a> collected during the scan operation. <br /></td></tr> |
| <tr class="separator:af511720e6d75778159ddb339fc420af7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae0ffd9a428087d48e322d542bd37e4ba" id="r_ae0ffd9a428087d48e322d542bd37e4ba"><td class="memItemLeft" align="right" valign="top"><a id="ae0ffd9a428087d48e322d542bd37e4ba" name="ae0ffd9a428087d48e322d542bd37e4ba"></a> |
| std::unordered_map< std::string, std::string > </td><td class="memItemRight" valign="bottom"><b>metadata</b></td></tr> |
| <tr class="memdesc:ae0ffd9a428087d48e322d542bd37e4ba"><td class="mdescLeft"> </td><td class="mdescRight">Additional key-value metadata. <br /></td></tr> |
| <tr class="separator:ae0ffd9a428087d48e322d542bd37e4ba"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Report generated after a table scan operation. </p> |
| <p>Contains metrics about the planning and execution of a table scan, including information about manifests and data files processed. </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> |
