mkdocs/docs/api/xml/classiceberg_1_1Writer.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="classiceberg_1_1Writer" kind="class" language="C++" prot="public" abstract="yes">
    <compoundname>iceberg::Writer</compoundname>
    <derivedcompoundref refid="classiceberg_1_1avro_1_1AvroWriter" prot="public" virt="non-virtual">iceberg::avro::AvroWriter</derivedcompoundref>
    <derivedcompoundref refid="classiceberg_1_1parquet_1_1ParquetWriter" prot="public" virt="non-virtual">iceberg::parquet::ParquetWriter</derivedcompoundref>
    <includes refid="file__writer_8h" local="no">file_writer.h</includes>
    <sectiondef kind="public-func">
      <memberdef kind="function" id="classiceberg_1_1Writer_1a3316c3e547ae9ce5333f27f5c0aa269b" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type></type>
        <definition>virtual iceberg::Writer::~Writer</definition>
        <argsstring>()=default</argsstring>
        <name>~Writer</name>
        <qualifiedname>iceberg::Writer::~Writer</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_writer.h" line="89" column="11"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1Writer_1a46dfddc942469f2081cbab385d72ea6b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>iceberg::Writer::Writer</definition>
        <argsstring>()=default</argsstring>
        <name>Writer</name>
        <qualifiedname>iceberg::Writer::Writer</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_writer.h" line="90" column="3"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1Writer_1a949903764bf9e3d38f00edb297a7103e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>iceberg::Writer::Writer</definition>
        <argsstring>(const Writer &amp;)=delete</argsstring>
        <name>Writer</name>
        <qualifiedname>iceberg::Writer::Writer</qualifiedname>
        <param>
          <type>const <ref refid="classiceberg_1_1Writer" kindref="compound">Writer</ref> &amp;</type>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_writer.h" line="91" column="3"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1Writer_1ab4749448ef3a9f01d946294d44f23578" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classiceberg_1_1Writer" kindref="compound">Writer</ref> &amp;</type>
        <definition>Writer &amp; iceberg::Writer::operator=</definition>
        <argsstring>(const Writer &amp;)=delete</argsstring>
        <name>operator=</name>
        <qualifiedname>iceberg::Writer::operator=</qualifiedname>
        <param>
          <type>const <ref refid="classiceberg_1_1Writer" kindref="compound">Writer</ref> &amp;</type>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_writer.h" line="92" column="10"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1Writer_1a3088b433357b7589be2aa294fa311346" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>Status</type>
        <definition>virtual Status iceberg::Writer::Open</definition>
        <argsstring>(const WriterOptions &amp;options)=0</argsstring>
        <name>Open</name>
        <qualifiedname>iceberg::Writer::Open</qualifiedname>
        <reimplementedby refid="classiceberg_1_1avro_1_1AvroWriter_1a6f1f8a09bac758ba7602e13f572f3d62">Open</reimplementedby>
        <reimplementedby refid="classiceberg_1_1parquet_1_1ParquetWriter_1a144493d7ba4e63daae1b5c9b0d510dbd">Open</reimplementedby>
        <param>
          <type>const <ref refid="structiceberg_1_1WriterOptions" kindref="compound">WriterOptions</ref> &amp;</type>
          <declname>options</declname>
        </param>
        <briefdescription>
<para>Open the writer. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_writer.h" line="95" column="18"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1Writer_1ad919074c1cb99c517b3e7e09214cd43c" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>Status</type>
        <definition>virtual Status iceberg::Writer::Close</definition>
        <argsstring>()=0</argsstring>
        <name>Close</name>
        <qualifiedname>iceberg::Writer::Close</qualifiedname>
        <reimplementedby refid="classiceberg_1_1avro_1_1AvroWriter_1a2dd42fd539830a897aae840cf0e2a8b5">Close</reimplementedby>
        <reimplementedby refid="classiceberg_1_1parquet_1_1ParquetWriter_1a31b035bae2b384bc66fd58f4eb972f77">Close</reimplementedby>
        <briefdescription>
<para>Close the writer. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_writer.h" line="98" column="18"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1Writer_1ab9fd192deac4e2a73bbd5c8e8ee71529" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>Status</type>
        <definition>virtual Status iceberg::Writer::Write</definition>
        <argsstring>(ArrowArray *data)=0</argsstring>
        <name>Write</name>
        <qualifiedname>iceberg::Writer::Write</qualifiedname>
        <reimplementedby refid="classiceberg_1_1parquet_1_1ParquetWriter_1acead2c7a8837b9977bcf68664c13345b">Write</reimplementedby>
        <reimplementedby refid="classiceberg_1_1avro_1_1AvroWriter_1a60e9eb49bcb01e2e7823f529c7f42025">Write</reimplementedby>
        <param>
          <type><ref refid="structArrowArray" kindref="compound">ArrowArray</ref> *</type>
          <declname>data</declname>
        </param>
        <briefdescription>
<para>Write arrow data to the file. </para>
        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>Status of write results. </para>
</simplesect>
<simplesect kind="note"><para>Ownership of the data is transferred to the writer. </para>
</simplesect>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_writer.h" line="104" column="18"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1Writer_1a36090c8c8e11cd6d5746b3c57e90983d" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>Result&lt; <ref refid="structiceberg_1_1Metrics" kindref="compound">Metrics</ref> &gt;</type>
        <definition>virtual Result&lt; Metrics &gt; iceberg::Writer::metrics</definition>
        <argsstring>()=0</argsstring>
        <name>metrics</name>
        <qualifiedname>iceberg::Writer::metrics</qualifiedname>
        <reimplementedby refid="classiceberg_1_1avro_1_1AvroWriter_1af3713ff59007cca54e37800f89eefa9f">metrics</reimplementedby>
        <reimplementedby refid="classiceberg_1_1parquet_1_1ParquetWriter_1ac702c6ecb018e6f7b1e5c1e71a20e320">metrics</reimplementedby>
        <briefdescription>
<para>Get the file statistics. Only valid after the file is closed. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_writer.h" line="108" column="18"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1Writer_1a5de3531e7c60570692a4a2b0d8449a81" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>Result&lt; int64_t &gt;</type>
        <definition>virtual Result&lt; int64_t &gt; iceberg::Writer::length</definition>
        <argsstring>()=0</argsstring>
        <name>length</name>
        <qualifiedname>iceberg::Writer::length</qualifiedname>
        <reimplementedby refid="classiceberg_1_1avro_1_1AvroWriter_1ac05ec6d94cbc4f51f8032a5ccae8ec8b">length</reimplementedby>
        <reimplementedby refid="classiceberg_1_1parquet_1_1ParquetWriter_1a4bfca96b64d6fdfa3cbcd8268c63a297">length</reimplementedby>
        <briefdescription>
<para>Get the file length. This can be called while the writer is still open or after the file is closed. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_writer.h" line="112" column="18"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1Writer_1a9630828a5052ec475c653ed492f70124" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>std::vector&lt; int64_t &gt;</type>
        <definition>virtual std::vector&lt; int64_t &gt; iceberg::Writer::split_offsets</definition>
        <argsstring>()=0</argsstring>
        <name>split_offsets</name>
        <qualifiedname>iceberg::Writer::split_offsets</qualifiedname>
        <reimplementedby refid="classiceberg_1_1avro_1_1AvroWriter_1a6cea029f237cc8d1f8dd9361e3546042">split_offsets</reimplementedby>
        <reimplementedby refid="classiceberg_1_1parquet_1_1ParquetWriter_1a332fd55ebd1e841cb301fa06edd3ef22">split_offsets</reimplementedby>
        <briefdescription>
<para>Returns a list of recommended split locations, if applicable, empty otherwise. When available, this information is used for planning scan tasks whose boundaries are determined by these offsets. The returned list must be sorted in ascending order. Only valid after the file is closed. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/file_writer.h" line="118" column="23"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
<para>Base writer class to write data from different file formats. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="1">
        <label>iceberg::Writer</label>
        <link refid="classiceberg_1_1Writer"/>
      </node>
      <node id="2">
        <label>iceberg::avro::AvroWriter</label>
        <link refid="classiceberg_1_1avro_1_1AvroWriter"/>
        <childnode refid="1" relation="public-inheritance">
        </childnode>
      </node>
      <node id="3">
        <label>iceberg::parquet::ParquetWriter</label>
        <link refid="classiceberg_1_1parquet_1_1ParquetWriter"/>
        <childnode refid="1" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <location file="iceberg/file_writer.h" line="87" column="1" bodyfile="iceberg/file_writer.h" bodystart="87" bodyend="119"/>
    <listofallmembers>
      <member refid="classiceberg_1_1Writer_1ad919074c1cb99c517b3e7e09214cd43c" prot="public" virt="pure-virtual"><scope>iceberg::Writer</scope><name>Close</name></member>
      <member refid="classiceberg_1_1Writer_1a5de3531e7c60570692a4a2b0d8449a81" prot="public" virt="pure-virtual"><scope>iceberg::Writer</scope><name>length</name></member>
      <member refid="classiceberg_1_1Writer_1a36090c8c8e11cd6d5746b3c57e90983d" prot="public" virt="pure-virtual"><scope>iceberg::Writer</scope><name>metrics</name></member>
      <member refid="classiceberg_1_1Writer_1a3088b433357b7589be2aa294fa311346" prot="public" virt="pure-virtual"><scope>iceberg::Writer</scope><name>Open</name></member>
      <member refid="classiceberg_1_1Writer_1ab4749448ef3a9f01d946294d44f23578" prot="public" virt="non-virtual"><scope>iceberg::Writer</scope><name>operator=</name></member>
      <member refid="classiceberg_1_1Writer_1a9630828a5052ec475c653ed492f70124" prot="public" virt="pure-virtual"><scope>iceberg::Writer</scope><name>split_offsets</name></member>
      <member refid="classiceberg_1_1Writer_1ab9fd192deac4e2a73bbd5c8e8ee71529" prot="public" virt="pure-virtual"><scope>iceberg::Writer</scope><name>Write</name></member>
      <member refid="classiceberg_1_1Writer_1a46dfddc942469f2081cbab385d72ea6b" prot="public" virt="non-virtual"><scope>iceberg::Writer</scope><name>Writer</name></member>
      <member refid="classiceberg_1_1Writer_1a949903764bf9e3d38f00edb297a7103e" prot="public" virt="non-virtual"><scope>iceberg::Writer</scope><name>Writer</name></member>
      <member refid="classiceberg_1_1Writer_1a3316c3e547ae9ce5333f27f5c0aa269b" prot="public" virt="virtual"><scope>iceberg::Writer</scope><name>~Writer</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>