blob: e715981880ed9c780b414213b8f9a76422170293 [file] [log] [blame]
<?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="file__format_8h" kind="file" language="C++">
<compoundname>file_format.h</compoundname>
<includes local="no">string_view</includes>
<includes local="no">utility</includes>
<includes refid="iceberg__export_8h" local="yes">iceberg/iceberg_export.h</includes>
<includes refid="result_8h" local="yes">iceberg/result.h</includes>
<includes refid="string__util_8h" local="yes">iceberg/util/string_util.h</includes>
<includedby refid="data__writer_8h" local="yes">iceberg/data/data_writer.h</includedby>
<includedby refid="equality__delete__writer_8h" local="yes">iceberg/data/equality_delete_writer.h</includedby>
<includedby refid="position__delete__writer_8h" local="yes">iceberg/data/position_delete_writer.h</includedby>
<includedby refid="file__reader_8h" local="yes">iceberg/file_reader.h</includedby>
<includedby refid="file__writer_8h" local="yes">iceberg/file_writer.h</includedby>
<includedby refid="manifest__entry_8h" local="yes">iceberg/manifest/manifest_entry.h</includedby>
<includedby refid="manifest__reader_8cc" local="yes">iceberg/manifest/manifest_reader.cc</includedby>
<includedby refid="data__file__set__test_8cc" local="yes">iceberg/test/data_file_set_test.cc</includedby>
<includedby refid="data__writer__test_8cc" local="yes">iceberg/test/data_writer_test.cc</includedby>
<includedby refid="file__scan__task__test_8cc" local="yes">iceberg/test/file_scan_task_test.cc</includedby>
<includedby refid="manifest__writer__versions__test_8cc" local="yes">iceberg/test/manifest_writer_versions_test.cc</includedby>
<includedby refid="rolling__manifest__writer__test_8cc" local="yes">iceberg/test/rolling_manifest_writer_test.cc</includedby>
<includedby refid="content__file__util_8cc" local="yes">iceberg/util/content_file_util.cc</includedby>
<incdepgraph>
<node id="1">
<label>iceberg/file_format.h</label>
<link refid="file__format_8h"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
</node>
<node id="4">
<label>iceberg/iceberg_export.h</label>
<link refid="iceberg__export_8h_source"/>
</node>
<node id="5">
<label>iceberg/result.h</label>
<link refid="result_8h_source"/>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
</node>
<node id="9">
<label>iceberg/util/string_util.h</label>
<link refid="string__util_8h_source"/>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="11" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="13" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="14" relation="include">
</childnode>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="10">
<label>algorithm</label>
</node>
<node id="11">
<label>cerrno</label>
</node>
<node id="12">
<label>charconv</label>
</node>
<node id="6">
<label>expected</label>
</node>
<node id="7">
<label>format</label>
</node>
<node id="13">
<label>ranges</label>
</node>
<node id="8">
<label>string</label>
</node>
<node id="2">
<label>string_view</label>
</node>
<node id="14">
<label>type_traits</label>
</node>
<node id="15">
<label>typeinfo</label>
</node>
<node id="3">
<label>utility</label>
</node>
</incdepgraph>
<invincdepgraph>
<node id="6">
<label>iceberg/avro/avro_reader.h</label>
<link refid="avro__reader_8h_source"/>
</node>
<node id="10">
<label>iceberg/avro/avro_writer.h</label>
<link refid="avro__writer_8h_source"/>
</node>
<node id="2">
<label>iceberg/data/data_writer.h</label>
<link refid="data__writer_8h"/>
</node>
<node id="3">
<label>iceberg/data/equality_delete_writer.h</label>
<link refid="equality__delete__writer_8h"/>
</node>
<node id="4">
<label>iceberg/data/position_delete_writer.h</label>
<link refid="position__delete__writer_8h"/>
</node>
<node id="15">
<label>iceberg/delete_file_index.h</label>
<link refid="delete__file__index_8h"/>
<childnode refid="16" relation="include">
</childnode>
</node>
<node id="1">
<label>iceberg/file_format.h</label>
<link refid="file__format_8h"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
<childnode refid="14" relation="include">
</childnode>
</node>
<node id="5">
<label>iceberg/file_reader.h</label>
<link refid="file__reader_8h"/>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
</node>
<node id="9">
<label>iceberg/file_writer.h</label>
<link refid="file__writer_8h"/>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="11" relation="include">
</childnode>
<childnode refid="13" relation="include">
</childnode>
</node>
<node id="14">
<label>iceberg/manifest/manifest_entry.h</label>
<link refid="manifest__entry_8h"/>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="16" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="17" relation="include">
</childnode>
<childnode refid="18" relation="include">
</childnode>
</node>
<node id="16">
<label>iceberg/manifest/manifest_group.h</label>
<link refid="manifest__group_8h"/>
</node>
<node id="7">
<label>iceberg/manifest/manifest_reader_internal.h</label>
<link refid="manifest__reader__internal_8h"/>
</node>
<node id="11">
<label>iceberg/manifest/manifest_writer.h</label>
<link refid="manifest__writer_8h"/>
<childnode refid="12" relation="include">
</childnode>
</node>
<node id="12">
<label>iceberg/manifest/rolling_manifest_writer.h</label>
<link refid="rolling__manifest__writer_8h"/>
</node>
<node id="8">
<label>iceberg/parquet/parquet_reader.h</label>
<link refid="parquet__reader_8h_source"/>
</node>
<node id="13">
<label>iceberg/parquet/parquet_writer.h</label>
<link refid="parquet__writer_8h_source"/>
</node>
<node id="19">
<label>iceberg/update/fast_append.h</label>
<link refid="fast__append_8h"/>
</node>
<node id="17">
<label>iceberg/util/content_file_util.h</label>
<link refid="content__file__util_8h"/>
</node>
<node id="18">
<label>iceberg/util/data_file_set.h</label>
<link refid="data__file__set_8h"/>
<childnode refid="19" relation="include">
</childnode>
</node>
</invincdepgraph>
<innernamespace refid="namespaceiceberg">iceberg</innernamespace>
<sectiondef kind="var">
<memberdef kind="variable" id="file__format_8h_1a894c229e52ede0f8a5654e019e650315" prot="public" static="no" mutable="no">
<type></type>
<definition>kParquet</definition>
<argsstring></argsstring>
<name>kParquet</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="iceberg/file_format.h" line="36" column="3" bodyfile="iceberg/file_format.h" bodystart="36" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="file__format_8h_1ac21a87df05694a8fe34837fe217d74e2" prot="public" static="no" mutable="no">
<type></type>
<definition>kAvro</definition>
<argsstring></argsstring>
<name>kAvro</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="iceberg/file_format.h" line="37" column="3" bodyfile="iceberg/file_format.h" bodystart="37" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="file__format_8h_1ae2aa1de7654c215f7581b228e51df311" prot="public" static="no" mutable="no">
<type></type>
<definition>kOrc</definition>
<argsstring></argsstring>
<name>kOrc</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="iceberg/file_format.h" line="38" column="3" bodyfile="iceberg/file_format.h" bodystart="38" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="file__format_8h_1adcb48f2f8c7abd8d5d5322c328ad396e" prot="public" static="no" mutable="no">
<type></type>
<definition>kPuffin</definition>
<argsstring></argsstring>
<name>kPuffin</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="iceberg/file_format.h" line="39" column="3" bodyfile="iceberg/file_format.h" bodystart="39" bodyend="-1"/>
</memberdef>
</sectiondef>
<briefdescription>
</briefdescription>
<detaileddescription>
<para>File format used by Iceberg. </para>
</detaileddescription>
<programlisting>
<codeline lineno="1"><highlight class="comment">/*</highlight></codeline>
<codeline lineno="2"><highlight class="comment"><sp/>*<sp/>Licensed<sp/>to<sp/>the<sp/>Apache<sp/>Software<sp/>Foundation<sp/>(ASF)<sp/>under<sp/>one</highlight></codeline>
<codeline lineno="3"><highlight class="comment"><sp/>*<sp/>or<sp/>more<sp/>contributor<sp/>license<sp/>agreements.<sp/><sp/>See<sp/>the<sp/>NOTICE<sp/>file</highlight></codeline>
<codeline lineno="4"><highlight class="comment"><sp/>*<sp/>distributed<sp/>with<sp/>this<sp/>work<sp/>for<sp/>additional<sp/>information</highlight></codeline>
<codeline lineno="5"><highlight class="comment"><sp/>*<sp/>regarding<sp/>copyright<sp/>ownership.<sp/><sp/>The<sp/>ASF<sp/>licenses<sp/>this<sp/>file</highlight></codeline>
<codeline lineno="6"><highlight class="comment"><sp/>*<sp/>to<sp/>you<sp/>under<sp/>the<sp/>Apache<sp/>License,<sp/>Version<sp/>2.0<sp/>(the</highlight></codeline>
<codeline lineno="7"><highlight class="comment"><sp/>*<sp/>&quot;License&quot;);<sp/>you<sp/>may<sp/>not<sp/>use<sp/>this<sp/>file<sp/>except<sp/>in<sp/>compliance</highlight></codeline>
<codeline lineno="8"><highlight class="comment"><sp/>*<sp/>with<sp/>the<sp/>License.<sp/><sp/>You<sp/>may<sp/>obtain<sp/>a<sp/>copy<sp/>of<sp/>the<sp/>License<sp/>at</highlight></codeline>
<codeline lineno="9"><highlight class="comment"><sp/>*</highlight></codeline>
<codeline lineno="10"><highlight class="comment"><sp/>*<sp/><sp/><sp/>http://www.apache.org/licenses/LICENSE-2.0</highlight></codeline>
<codeline lineno="11"><highlight class="comment"><sp/>*</highlight></codeline>
<codeline lineno="12"><highlight class="comment"><sp/>*<sp/>Unless<sp/>required<sp/>by<sp/>applicable<sp/>law<sp/>or<sp/>agreed<sp/>to<sp/>in<sp/>writing,</highlight></codeline>
<codeline lineno="13"><highlight class="comment"><sp/>*<sp/>software<sp/>distributed<sp/>under<sp/>the<sp/>License<sp/>is<sp/>distributed<sp/>on<sp/>an</highlight></codeline>
<codeline lineno="14"><highlight class="comment"><sp/>*<sp/>&quot;AS<sp/>IS&quot;<sp/>BASIS,<sp/>WITHOUT<sp/>WARRANTIES<sp/>OR<sp/>CONDITIONS<sp/>OF<sp/>ANY</highlight></codeline>
<codeline lineno="15"><highlight class="comment"><sp/>*<sp/>KIND,<sp/>either<sp/>express<sp/>or<sp/>implied.<sp/><sp/>See<sp/>the<sp/>License<sp/>for<sp/>the</highlight></codeline>
<codeline lineno="16"><highlight class="comment"><sp/>*<sp/>specific<sp/>language<sp/>governing<sp/>permissions<sp/>and<sp/>limitations</highlight></codeline>
<codeline lineno="17"><highlight class="comment"><sp/>*<sp/>under<sp/>the<sp/>License.</highlight></codeline>
<codeline lineno="18"><highlight class="comment"><sp/>*/</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="19"><highlight class="normal"></highlight></codeline>
<codeline lineno="20"><highlight class="normal"></highlight><highlight class="preprocessor">#pragma<sp/>once</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="21"><highlight class="normal"></highlight></codeline>
<codeline lineno="24"><highlight class="normal"></highlight></codeline>
<codeline lineno="25"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;string_view&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="26"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;utility&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="27"><highlight class="normal"></highlight></codeline>
<codeline lineno="28"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;iceberg/iceberg_export.h&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="29"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;iceberg/result.h&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="30"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;iceberg/util/string_util.h&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="31"><highlight class="normal"></highlight></codeline>
<codeline lineno="32"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal">iceberg<sp/>{</highlight></codeline>
<codeline lineno="33"><highlight class="normal"></highlight></codeline>
<codeline lineno="35"><highlight class="keyword">enum<sp/>class</highlight><highlight class="normal"><sp/>ICEBERG_EXPORT<sp/>FileFormatType<sp/>{</highlight></codeline>
<codeline lineno="36"><highlight class="normal"><sp/><sp/>kParquet,</highlight></codeline>
<codeline lineno="37"><highlight class="normal"><sp/><sp/>kAvro,</highlight></codeline>
<codeline lineno="38"><highlight class="normal"><sp/><sp/>kOrc,</highlight></codeline>
<codeline lineno="39"><highlight class="normal"><sp/><sp/>kPuffin,</highlight></codeline>
<codeline lineno="40"><highlight class="normal">};</highlight></codeline>
<codeline lineno="41"><highlight class="normal"></highlight></codeline>
<codeline lineno="43" refid="file__format_8h_1a6c6a9823b4f3275c85997c3ab98211fd" refkind="member"><highlight class="normal">ICEBERG_EXPORT<sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/>std::string_view<sp/>ToString(FileFormatType<sp/>format_type)<sp/>{</highlight></codeline>
<codeline lineno="44"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">switch</highlight><highlight class="normal"><sp/>(format_type)<sp/>{</highlight></codeline>
<codeline lineno="45"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">case</highlight><highlight class="normal"><sp/>FileFormatType::kParquet:</highlight></codeline>
<codeline lineno="46"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/></highlight><highlight class="stringliteral">&quot;parquet&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="47"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">case</highlight><highlight class="normal"><sp/>FileFormatType::kAvro:</highlight></codeline>
<codeline lineno="48"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/></highlight><highlight class="stringliteral">&quot;avro&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="49"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">case</highlight><highlight class="normal"><sp/>FileFormatType::kOrc:</highlight></codeline>
<codeline lineno="50"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/></highlight><highlight class="stringliteral">&quot;orc&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="51"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">case</highlight><highlight class="normal"><sp/>FileFormatType::kPuffin:</highlight></codeline>
<codeline lineno="52"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/></highlight><highlight class="stringliteral">&quot;puffin&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="53"><highlight class="normal"><sp/><sp/>}</highlight></codeline>
<codeline lineno="54"><highlight class="normal"><sp/><sp/>std::unreachable();</highlight></codeline>
<codeline lineno="55"><highlight class="normal">}</highlight></codeline>
<codeline lineno="56"><highlight class="normal"></highlight></codeline>
<codeline lineno="58" refid="file__format_8h_1ac636c6e570a5e0902e16087c7322c6a7" refkind="member"><highlight class="normal">ICEBERG_EXPORT<sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/>Result&lt;FileFormatType&gt;<sp/><ref refid="file__format_8h_1ac636c6e570a5e0902e16087c7322c6a7" kindref="member">FileFormatTypeFromString</ref>(</highlight></codeline>
<codeline lineno="59"><highlight class="normal"><sp/><sp/><sp/><sp/>std::string_view<sp/>str)<sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"><sp/>{</highlight></codeline>
<codeline lineno="60"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal"><sp/>lower<sp/>=<sp/>StringUtils::ToLower(str);</highlight></codeline>
<codeline lineno="61"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(lower<sp/>==<sp/></highlight><highlight class="stringliteral">&quot;parquet&quot;</highlight><highlight class="normal">)<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>FileFormatType::kParquet;</highlight></codeline>
<codeline lineno="62"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(lower<sp/>==<sp/></highlight><highlight class="stringliteral">&quot;avro&quot;</highlight><highlight class="normal">)<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>FileFormatType::kAvro;</highlight></codeline>
<codeline lineno="63"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(lower<sp/>==<sp/></highlight><highlight class="stringliteral">&quot;orc&quot;</highlight><highlight class="normal">)<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>FileFormatType::kOrc;</highlight></codeline>
<codeline lineno="64"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(lower<sp/>==<sp/></highlight><highlight class="stringliteral">&quot;puffin&quot;</highlight><highlight class="normal">)<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>FileFormatType::kPuffin;</highlight></codeline>
<codeline lineno="65"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>InvalidArgument(</highlight><highlight class="stringliteral">&quot;Invalid<sp/>file<sp/>format<sp/>type:<sp/>{}&quot;</highlight><highlight class="normal">,<sp/>str);</highlight></codeline>
<codeline lineno="66"><highlight class="normal">}</highlight></codeline>
<codeline lineno="67"><highlight class="normal"></highlight></codeline>
<codeline lineno="68"><highlight class="normal">}<sp/><sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>iceberg</highlight><highlight class="normal"></highlight></codeline>
</programlisting>
<location file="iceberg/file_format.h"/>
</compounddef>
</doxygen>