mkdocs/docs/api/xml/structiceberg_1_1ScanReport.xml

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.9.8" xml:lang="en-US">
  <compounddef id="structiceberg_1_1ScanReport" kind="struct" language="C++" prot="public">
    <compoundname>iceberg::ScanReport</compoundname>
    <includes refid="scan__report_8h" local="no">scan_report.h</includes>
    <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="structiceberg_1_1ScanReport_1abc161296ef9e1b89536f8f6bb46e18cf" prot="public" static="no" mutable="no">
        <type>std::string</type>
        <definition>std::string iceberg::ScanReport::table_name</definition>
        <argsstring></argsstring>
        <name>table_name</name>
        <qualifiedname>iceberg::ScanReport::table_name</qualifiedname>
        <briefdescription>
<para>The fully qualified name of the table that was scanned. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/metrics/scan_report.h" line="133" column="15" bodyfile="iceberg/metrics/scan_report.h" bodystart="133" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structiceberg_1_1ScanReport_1ae4828a6c6ffad2ef516dacde7e153f32" prot="public" static="no" mutable="no">
        <type>int64_t</type>
        <definition>int64_t iceberg::ScanReport::snapshot_id</definition>
        <argsstring></argsstring>
        <name>snapshot_id</name>
        <qualifiedname>iceberg::ScanReport::snapshot_id</qualifiedname>
        <initializer>= kInvalidSnapshotId</initializer>
        <briefdescription>
<para><ref refid="structiceberg_1_1Snapshot" kindref="compound">Snapshot</ref> ID that was scanned, if available. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/metrics/scan_report.h" line="135" column="11" bodyfile="iceberg/metrics/scan_report.h" bodystart="135" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structiceberg_1_1ScanReport_1ae63b1a68ead475bb4834e7d2d79b0534" prot="public" static="no" mutable="no">
        <type>std::shared_ptr&lt; <ref refid="classiceberg_1_1Expression" kindref="compound">Expression</ref> &gt;</type>
        <definition>std::shared_ptr&lt;Expression&gt; iceberg::ScanReport::filter</definition>
        <argsstring></argsstring>
        <name>filter</name>
        <qualifiedname>iceberg::ScanReport::filter</qualifiedname>
        <briefdescription>
<para>Filter expression used in the scan, if any. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/metrics/scan_report.h" line="137" column="19" bodyfile="iceberg/metrics/scan_report.h" bodystart="137" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structiceberg_1_1ScanReport_1a40625c69ed22ebac32fec49119c6b38c" prot="public" static="no" mutable="no">
        <type>int32_t</type>
        <definition>int32_t iceberg::ScanReport::schema_id</definition>
        <argsstring></argsstring>
        <name>schema_id</name>
        <qualifiedname>iceberg::ScanReport::schema_id</qualifiedname>
        <initializer>= kInvalidSchemaId</initializer>
        <briefdescription>
<para><ref refid="classiceberg_1_1Schema" kindref="compound">Schema</ref> ID. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/metrics/scan_report.h" line="139" column="11" bodyfile="iceberg/metrics/scan_report.h" bodystart="139" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structiceberg_1_1ScanReport_1a2198a16bf30531c8819e02921cd71713" prot="public" static="no" mutable="no">
        <type>std::vector&lt; int32_t &gt;</type>
        <definition>std::vector&lt;int32_t&gt; iceberg::ScanReport::projected_field_ids</definition>
        <argsstring></argsstring>
        <name>projected_field_ids</name>
        <qualifiedname>iceberg::ScanReport::projected_field_ids</qualifiedname>
        <briefdescription>
<para>Projected field IDs from the scan schema. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/metrics/scan_report.h" line="141" column="15" bodyfile="iceberg/metrics/scan_report.h" bodystart="141" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structiceberg_1_1ScanReport_1a9d3365b4cc7406d9cd6e75b69890a40a" prot="public" static="no" mutable="no">
        <type>std::vector&lt; std::string &gt;</type>
        <definition>std::vector&lt;std::string&gt; iceberg::ScanReport::projected_field_names</definition>
        <argsstring></argsstring>
        <name>projected_field_names</name>
        <qualifiedname>iceberg::ScanReport::projected_field_names</qualifiedname>
        <briefdescription>
<para>Projected field names from the scan schema. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/metrics/scan_report.h" line="143" column="15" bodyfile="iceberg/metrics/scan_report.h" bodystart="143" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structiceberg_1_1ScanReport_1af511720e6d75778159ddb339fc420af7" prot="public" static="no" mutable="no">
        <type><ref refid="structiceberg_1_1ScanMetricsResult" kindref="compound">ScanMetricsResult</ref></type>
        <definition>ScanMetricsResult iceberg::ScanReport::scan_metrics</definition>
        <argsstring></argsstring>
        <name>scan_metrics</name>
        <qualifiedname>iceberg::ScanReport::scan_metrics</qualifiedname>
        <briefdescription>
<para><ref refid="structiceberg_1_1Metrics" kindref="compound">Metrics</ref> collected during the scan operation. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/metrics/scan_report.h" line="145" column="21" bodyfile="iceberg/metrics/scan_report.h" bodystart="145" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structiceberg_1_1ScanReport_1ae0ffd9a428087d48e322d542bd37e4ba" prot="public" static="no" mutable="no">
        <type>std::unordered_map&lt; std::string, std::string &gt;</type>
        <definition>std::unordered_map&lt;std::string, std::string&gt; iceberg::ScanReport::metadata</definition>
        <argsstring></argsstring>
        <name>metadata</name>
        <qualifiedname>iceberg::ScanReport::metadata</qualifiedname>
        <briefdescription>
<para>Additional key-value metadata. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/metrics/scan_report.h" line="147" column="22" bodyfile="iceberg/metrics/scan_report.h" bodystart="147" bodyend="-1"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
<para>Report generated after a table scan operation. </para>
    </briefdescription>
    <detaileddescription>
<para>Contains metrics about the planning and execution of a table scan, including information about manifests and data files processed. </para>
    </detaileddescription>
    <collaborationgraph>
      <node id="5">
        <label>iceberg::Expression</label>
        <link refid="classiceberg_1_1Expression"/>
        <childnode refid="6" relation="public-inheritance">
        </childnode>
      </node>
      <node id="9">
        <label>iceberg::ScanMetricsResult</label>
        <link refid="structiceberg_1_1ScanMetricsResult"/>
      </node>
      <node id="1">
        <label>iceberg::ScanReport</label>
        <link refid="structiceberg_1_1ScanReport"/>
        <childnode refid="2" relation="usage">
          <edgelabel>table_name</edgelabel>
        </childnode>
        <childnode refid="4" relation="usage">
          <edgelabel>filter</edgelabel>
        </childnode>
        <childnode refid="7" relation="usage">
          <edgelabel>projected_field_ids</edgelabel>
        </childnode>
        <childnode refid="8" relation="usage">
          <edgelabel>projected_field_names</edgelabel>
        </childnode>
        <childnode refid="9" relation="usage">
          <edgelabel>scan_metrics</edgelabel>
        </childnode>
        <childnode refid="10" relation="usage">
          <edgelabel>metadata</edgelabel>
        </childnode>
      </node>
      <node id="6">
        <label>iceberg::util::Formattable</label>
        <link refid="classiceberg_1_1util_1_1Formattable"/>
      </node>
      <node id="4">
        <label>std::shared_ptr&lt; iceberg::Expression &gt;</label>
        <childnode refid="5" relation="usage">
          <edgelabel>ptr</edgelabel>
        </childnode>
      </node>
      <node id="3">
        <label>std::basic_string&lt; Char &gt;</label>
      </node>
      <node id="2">
        <label>std::string</label>
        <childnode refid="3" relation="public-inheritance">
        </childnode>
      </node>
      <node id="10">
        <label>std::unordered_map&lt; std::string, std::string &gt;</label>
        <childnode refid="2" relation="usage">
          <edgelabel>elements</edgelabel>
          <edgelabel>keys</edgelabel>
        </childnode>
      </node>
      <node id="7">
        <label>std::vector&lt; int32_t &gt;</label>
      </node>
      <node id="8">
        <label>std::vector&lt; std::string &gt;</label>
        <childnode refid="2" relation="usage">
          <edgelabel>elements</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="iceberg/metrics/scan_report.h" line="131" column="1" bodyfile="iceberg/metrics/scan_report.h" bodystart="131" bodyend="148"/>
    <listofallmembers>
      <member refid="structiceberg_1_1ScanReport_1ae63b1a68ead475bb4834e7d2d79b0534" prot="public" virt="non-virtual"><scope>iceberg::ScanReport</scope><name>filter</name></member>
      <member refid="structiceberg_1_1ScanReport_1ae0ffd9a428087d48e322d542bd37e4ba" prot="public" virt="non-virtual"><scope>iceberg::ScanReport</scope><name>metadata</name></member>
      <member refid="structiceberg_1_1ScanReport_1a2198a16bf30531c8819e02921cd71713" prot="public" virt="non-virtual"><scope>iceberg::ScanReport</scope><name>projected_field_ids</name></member>
      <member refid="structiceberg_1_1ScanReport_1a9d3365b4cc7406d9cd6e75b69890a40a" prot="public" virt="non-virtual"><scope>iceberg::ScanReport</scope><name>projected_field_names</name></member>
      <member refid="structiceberg_1_1ScanReport_1af511720e6d75778159ddb339fc420af7" prot="public" virt="non-virtual"><scope>iceberg::ScanReport</scope><name>scan_metrics</name></member>
      <member refid="structiceberg_1_1ScanReport_1a40625c69ed22ebac32fec49119c6b38c" prot="public" virt="non-virtual"><scope>iceberg::ScanReport</scope><name>schema_id</name></member>
      <member refid="structiceberg_1_1ScanReport_1ae4828a6c6ffad2ef516dacde7e153f32" prot="public" virt="non-virtual"><scope>iceberg::ScanReport</scope><name>snapshot_id</name></member>
      <member refid="structiceberg_1_1ScanReport_1abc161296ef9e1b89536f8f6bb46e18cf" prot="public" virt="non-virtual"><scope>iceberg::ScanReport</scope><name>table_name</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>