api/xml/structiceberg_1_1ReaderOptions.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_1ReaderOptions" kind="struct" language="C++" prot="public">
    <compoundname>iceberg::ReaderOptions</compoundname>
    <includes refid="file__reader_8h" local="no">file_reader.h</includes>
    <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="structiceberg_1_1ReaderOptions_1a959dc0c774f0a3d55991f1eb73753b2c" prot="public" static="no" mutable="no">
        <type>std::string</type>
        <definition>std::string iceberg::ReaderOptions::path</definition>
        <argsstring></argsstring>
        <name>path</name>
        <qualifiedname>iceberg::ReaderOptions::path</qualifiedname>
        <briefdescription>
<para>The path to the file to read. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_reader.h" line="93" column="15" bodyfile="iceberg/file_reader.h" bodystart="93" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structiceberg_1_1ReaderOptions_1a774ae321e3063b7ae0bbb92c9d552a74" prot="public" static="no" mutable="no">
        <type>std::optional&lt; size_t &gt;</type>
        <definition>std::optional&lt;size_t&gt; iceberg::ReaderOptions::length</definition>
        <argsstring></argsstring>
        <name>length</name>
        <qualifiedname>iceberg::ReaderOptions::length</qualifiedname>
        <briefdescription>
<para>The total length of the file. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_reader.h" line="95" column="17" bodyfile="iceberg/file_reader.h" bodystart="95" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structiceberg_1_1ReaderOptions_1ad23066ad0bd76b9bddf201e5b9bbeb0e" prot="public" static="no" mutable="no">
        <type>std::optional&lt; <ref refid="structiceberg_1_1Split" kindref="compound">Split</ref> &gt;</type>
        <definition>std::optional&lt;Split&gt; iceberg::ReaderOptions::split</definition>
        <argsstring></argsstring>
        <name>split</name>
        <qualifiedname>iceberg::ReaderOptions::split</qualifiedname>
        <briefdescription>
<para>The split to read. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_reader.h" line="97" column="17" bodyfile="iceberg/file_reader.h" bodystart="97" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structiceberg_1_1ReaderOptions_1a49992ba965f62ff27631e8131ed657ea" prot="public" static="no" mutable="no">
        <type>std::shared_ptr&lt; class <ref refid="classiceberg_1_1FileIO" kindref="compound">FileIO</ref> &gt;</type>
        <definition>std::shared_ptr&lt;class FileIO&gt; iceberg::ReaderOptions::io</definition>
        <argsstring></argsstring>
        <name>io</name>
        <qualifiedname>iceberg::ReaderOptions::io</qualifiedname>
        <briefdescription>
<para><ref refid="classiceberg_1_1FileIO" kindref="compound">FileIO</ref> instance to open the file. <ref refid="classiceberg_1_1Reader" kindref="compound">Reader</ref> implementations should down cast it to the specific <ref refid="classiceberg_1_1FileIO" kindref="compound">FileIO</ref> implementation. By default, the <computeroutput>iceberg-bundle</computeroutput> library uses <computeroutput>ArrowFileSystemFileIO</computeroutput> as the default implementation. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_reader.h" line="101" column="19" bodyfile="iceberg/file_reader.h" bodystart="101" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structiceberg_1_1ReaderOptions_1a418c6556965b0db7f12131e4f0070304" prot="public" static="no" mutable="no">
        <type>std::shared_ptr&lt; class <ref refid="classiceberg_1_1Schema" kindref="compound">Schema</ref> &gt;</type>
        <definition>std::shared_ptr&lt;class Schema&gt; iceberg::ReaderOptions::projection</definition>
        <argsstring></argsstring>
        <name>projection</name>
        <qualifiedname>iceberg::ReaderOptions::projection</qualifiedname>
        <briefdescription>
<para>The projection schema to read from the file. This field is required. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_reader.h" line="103" column="19" bodyfile="iceberg/file_reader.h" bodystart="103" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structiceberg_1_1ReaderOptions_1af6504634d4bf0a406fb091d9e10dc8fc" prot="public" static="no" mutable="no">
        <type>std::shared_ptr&lt; class <ref refid="classiceberg_1_1Expression" kindref="compound">Expression</ref> &gt;</type>
        <definition>std::shared_ptr&lt;class Expression&gt; iceberg::ReaderOptions::filter</definition>
        <argsstring></argsstring>
        <name>filter</name>
        <qualifiedname>iceberg::ReaderOptions::filter</qualifiedname>
        <briefdescription>
<para>The filter to apply to the data. <ref refid="classiceberg_1_1Reader" kindref="compound">Reader</ref> implementations may ignore this if the file format does not support filtering. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_reader.h" line="106" column="19" bodyfile="iceberg/file_reader.h" bodystart="106" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structiceberg_1_1ReaderOptions_1ab2824fcc77efcfdd2810ff3945f2a519" prot="public" static="no" mutable="no">
        <type>std::shared_ptr&lt; class <ref refid="classiceberg_1_1NameMapping" kindref="compound">NameMapping</ref> &gt;</type>
        <definition>std::shared_ptr&lt;class NameMapping&gt; iceberg::ReaderOptions::name_mapping</definition>
        <argsstring></argsstring>
        <name>name_mapping</name>
        <qualifiedname>iceberg::ReaderOptions::name_mapping</qualifiedname>
        <briefdescription>
<para>Name mapping for schema evolution compatibility. Used when reading files that may have different field names than the current schema. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_reader.h" line="109" column="19" bodyfile="iceberg/file_reader.h" bodystart="109" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structiceberg_1_1ReaderOptions_1abfe412d377c1207df04c3a2c4fe23d55" prot="public" static="no" mutable="no">
        <type><ref refid="classiceberg_1_1ReaderProperties" kindref="compound">ReaderProperties</ref></type>
        <definition>ReaderProperties iceberg::ReaderOptions::properties</definition>
        <argsstring></argsstring>
        <name>properties</name>
        <qualifiedname>iceberg::ReaderOptions::properties</qualifiedname>
        <briefdescription>
<para>Format-specific or implementation-specific properties. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_reader.h" line="111" column="20" bodyfile="iceberg/file_reader.h" bodystart="111" bodyend="-1"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
<para>Options for creating a reader. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <collaborationgraph>
      <node id="24">
        <label>iceberg::ConfigBase&lt; ReaderProperties &gt;</label>
        <link refid="classiceberg_1_1ConfigBase"/>
        <childnode refid="25" relation="usage">
          <edgelabel>configs_</edgelabel>
        </childnode>
      </node>
      <node id="14">
        <label>iceberg::Lazy&lt; InitFieldById &gt;</label>
        <link refid="classiceberg_1_1Lazy"/>
      </node>
      <node id="16">
        <label>iceberg::Lazy&lt; InitFieldByLowerCaseName &gt;</label>
        <link refid="classiceberg_1_1Lazy"/>
      </node>
      <node id="15">
        <label>iceberg::Lazy&lt; InitFieldByName &gt;</label>
        <link refid="classiceberg_1_1Lazy"/>
      </node>
      <node id="20">
        <label>iceberg::Expression</label>
        <link refid="classiceberg_1_1Expression"/>
        <childnode refid="11" relation="public-inheritance">
        </childnode>
      </node>
      <node id="5">
        <label>iceberg::FileIO</label>
        <link refid="classiceberg_1_1FileIO"/>
      </node>
      <node id="22">
        <label>iceberg::NameMapping</label>
        <link refid="classiceberg_1_1NameMapping"/>
      </node>
      <node id="9">
        <label>iceberg::NestedType</label>
        <link refid="classiceberg_1_1NestedType"/>
        <childnode refid="10" relation="public-inheritance">
        </childnode>
      </node>
      <node id="1">
        <label>iceberg::ReaderOptions</label>
        <link refid="structiceberg_1_1ReaderOptions"/>
        <childnode refid="2" relation="usage">
          <edgelabel>path</edgelabel>
        </childnode>
        <childnode refid="4" relation="usage">
          <edgelabel>io</edgelabel>
        </childnode>
        <childnode refid="6" relation="usage">
          <edgelabel>projection</edgelabel>
        </childnode>
        <childnode refid="19" relation="usage">
          <edgelabel>filter</edgelabel>
        </childnode>
        <childnode refid="21" relation="usage">
          <edgelabel>name_mapping</edgelabel>
        </childnode>
        <childnode refid="23" relation="usage">
          <edgelabel>properties</edgelabel>
        </childnode>
      </node>
      <node id="23">
        <label>iceberg::ReaderProperties</label>
        <link refid="classiceberg_1_1ReaderProperties"/>
        <childnode refid="24" relation="public-inheritance">
        </childnode>
      </node>
      <node id="7">
        <label>iceberg::Schema</label>
        <link refid="classiceberg_1_1Schema"/>
        <childnode refid="8" relation="public-inheritance">
        </childnode>
        <childnode refid="17" relation="usage">
          <edgelabel>kAllColumns</edgelabel>
        </childnode>
      </node>
      <node id="13">
        <label>iceberg::SchemaField</label>
        <link refid="classiceberg_1_1SchemaField"/>
        <childnode refid="11" relation="public-inheritance">
        </childnode>
      </node>
      <node id="8">
        <label>iceberg::StructType</label>
        <link refid="classiceberg_1_1StructType"/>
        <childnode refid="9" relation="public-inheritance">
        </childnode>
        <childnode refid="12" relation="usage">
          <edgelabel>fields_</edgelabel>
        </childnode>
        <childnode refid="14" relation="usage">
          <edgelabel>field_by_id_</edgelabel>
        </childnode>
        <childnode refid="15" relation="usage">
          <edgelabel>field_by_name_</edgelabel>
        </childnode>
        <childnode refid="16" relation="usage">
          <edgelabel>field_by_lowercase_name_</edgelabel>
        </childnode>
      </node>
      <node id="10">
        <label>iceberg::Type</label>
        <link refid="classiceberg_1_1Type"/>
        <childnode refid="11" relation="public-inheritance">
        </childnode>
      </node>
      <node id="11">
        <label>iceberg::util::Formattable</label>
        <link refid="classiceberg_1_1util_1_1Formattable"/>
      </node>
      <node id="19">
        <label>std::shared_ptr&lt; class iceberg::Expression &gt;</label>
        <childnode refid="20" relation="usage">
          <edgelabel>ptr</edgelabel>
        </childnode>
      </node>
      <node id="4">
        <label>std::shared_ptr&lt; class iceberg::FileIO &gt;</label>
        <childnode refid="5" relation="usage">
          <edgelabel>ptr</edgelabel>
        </childnode>
      </node>
      <node id="21">
        <label>std::shared_ptr&lt; class iceberg::NameMapping &gt;</label>
        <childnode refid="22" relation="usage">
          <edgelabel>ptr</edgelabel>
        </childnode>
      </node>
      <node id="6">
        <label>std::shared_ptr&lt; class iceberg::Schema &gt;</label>
        <childnode refid="7" relation="usage">
          <edgelabel>ptr</edgelabel>
        </childnode>
      </node>
      <node id="3">
        <label>std::basic_string&lt; Char &gt;</label>
      </node>
      <node id="18">
        <label>std::basic_string_view&lt; Char &gt;</label>
      </node>
      <node id="2">
        <label>std::string</label>
        <childnode refid="3" relation="public-inheritance">
        </childnode>
      </node>
      <node id="17">
        <label>std::string_view</label>
        <childnode refid="18" relation="public-inheritance">
        </childnode>
      </node>
      <node id="25">
        <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="12">
        <label>std::vector&lt; iceberg::SchemaField &gt;</label>
        <childnode refid="13" relation="usage">
          <edgelabel>elements</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="iceberg/file_reader.h" line="91" column="1" bodyfile="iceberg/file_reader.h" bodystart="91" bodyend="112"/>
    <listofallmembers>
      <member refid="structiceberg_1_1ReaderOptions_1af6504634d4bf0a406fb091d9e10dc8fc" prot="public" virt="non-virtual"><scope>iceberg::ReaderOptions</scope><name>filter</name></member>
      <member refid="structiceberg_1_1ReaderOptions_1a49992ba965f62ff27631e8131ed657ea" prot="public" virt="non-virtual"><scope>iceberg::ReaderOptions</scope><name>io</name></member>
      <member refid="structiceberg_1_1ReaderOptions_1a774ae321e3063b7ae0bbb92c9d552a74" prot="public" virt="non-virtual"><scope>iceberg::ReaderOptions</scope><name>length</name></member>
      <member refid="structiceberg_1_1ReaderOptions_1ab2824fcc77efcfdd2810ff3945f2a519" prot="public" virt="non-virtual"><scope>iceberg::ReaderOptions</scope><name>name_mapping</name></member>
      <member refid="structiceberg_1_1ReaderOptions_1a959dc0c774f0a3d55991f1eb73753b2c" prot="public" virt="non-virtual"><scope>iceberg::ReaderOptions</scope><name>path</name></member>
      <member refid="structiceberg_1_1ReaderOptions_1a418c6556965b0db7f12131e4f0070304" prot="public" virt="non-virtual"><scope>iceberg::ReaderOptions</scope><name>projection</name></member>
      <member refid="structiceberg_1_1ReaderOptions_1abfe412d377c1207df04c3a2c4fe23d55" prot="public" virt="non-virtual"><scope>iceberg::ReaderOptions</scope><name>properties</name></member>
      <member refid="structiceberg_1_1ReaderOptions_1ad23066ad0bd76b9bddf201e5b9bbeb0e" prot="public" virt="non-virtual"><scope>iceberg::ReaderOptions</scope><name>split</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>