mkdocs/docs/api/xml/classiceberg_1_1DataWriter.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_1DataWriter" kind="class" language="C++" prot="public">
    <compoundname>iceberg::DataWriter</compoundname>
    <basecompoundref refid="classiceberg_1_1FileWriter" prot="public" virt="non-virtual">iceberg::FileWriter</basecompoundref>
    <includes refid="data__writer_8h" local="no">data_writer.h</includes>
    <innerclass refid="classiceberg_1_1DataWriter_1_1Impl" prot="public">iceberg::DataWriter::Impl</innerclass>
    <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classiceberg_1_1DataWriter_1ae52a9c5f64cc631cfbe55bfb844d52f1" prot="private" static="no" mutable="no">
        <type>std::unique_ptr&lt; <ref refid="classiceberg_1_1DataWriter_1_1Impl" kindref="compound">Impl</ref> &gt;</type>
        <definition>std::unique_ptr&lt;Impl&gt; iceberg::DataWriter::impl_</definition>
        <argsstring></argsstring>
        <name>impl_</name>
        <qualifiedname>iceberg::DataWriter::impl_</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/data/data_writer.h" line="68" column="19" bodyfile="iceberg/data/data_writer.h" bodystart="68" bodyend="-1"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="public-func">
      <memberdef kind="function" id="classiceberg_1_1DataWriter_1a6b926388d840540e961a5b6b582c27ac" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>iceberg::DataWriter::~DataWriter</definition>
        <argsstring>() override</argsstring>
        <name>~DataWriter</name>
        <qualifiedname>iceberg::DataWriter::~DataWriter</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/data/data_writer.h" line="56" column="3"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1DataWriter_1a6a72a9a4f9193b389e0465fe4120656d" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>Status</type>
        <definition>Status iceberg::DataWriter::Write</definition>
        <argsstring>(ArrowArray *data) override</argsstring>
        <name>Write</name>
        <qualifiedname>iceberg::DataWriter::Write</qualifiedname>
        <reimplements refid="classiceberg_1_1FileWriter_1ad27902863767dbda5a2d7fcf88eb0e28">Write</reimplements>
        <param>
          <type><ref refid="structArrowArray" kindref="compound">ArrowArray</ref> *</type>
          <declname>data</declname>
        </param>
        <briefdescription>
<para>Write a batch of records. </para>
        </briefdescription>
        <detaileddescription>
<para><simplesect kind="note"><para>The ownership of the <ref refid="structArrowArray" kindref="compound">ArrowArray</ref> will be transferred to the writer. </para>
</simplesect>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/data/data_writer.h" line="61" column="10" bodyfile="iceberg/data/data_writer.cc" bodystart="128" bodyend="128"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1DataWriter_1a33f636f51003a122b97a5eb836846c3c" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
        <type>Result&lt; int64_t &gt;</type>
        <definition>Result&lt; int64_t &gt; iceberg::DataWriter::Length</definition>
        <argsstring>() const override</argsstring>
        <name>Length</name>
        <qualifiedname>iceberg::DataWriter::Length</qualifiedname>
        <reimplements refid="classiceberg_1_1FileWriter_1ad32f2d3323e2fea39baa59a96eb50197">Length</reimplements>
        <briefdescription>
<para>Get the current number of bytes written. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/data/data_writer.h" line="62" column="10" bodyfile="iceberg/data/data_writer.cc" bodystart="130" bodyend="130"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1DataWriter_1acfb7b11e0ddbc46bd984dd5d6f47cb54" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>Status</type>
        <definition>Status iceberg::DataWriter::Close</definition>
        <argsstring>() override</argsstring>
        <name>Close</name>
        <qualifiedname>iceberg::DataWriter::Close</qualifiedname>
        <reimplements refid="classiceberg_1_1FileWriter_1a6d7f69f445e791c2c864913fc1188370">Close</reimplements>
        <briefdescription>
<para>Close the writer and finalize the file. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/data/data_writer.h" line="63" column="10" bodyfile="iceberg/data/data_writer.cc" bodystart="132" bodyend="132"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1DataWriter_1a981674a97afb37f20d6c8d38417d57b8" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>Result&lt; <ref refid="structiceberg_1_1FileWriter_1_1WriteResult" kindref="compound">WriteResult</ref> &gt;</type>
        <definition>Result&lt; FileWriter::WriteResult &gt; iceberg::DataWriter::Metadata</definition>
        <argsstring>() override</argsstring>
        <name>Metadata</name>
        <qualifiedname>iceberg::DataWriter::Metadata</qualifiedname>
        <reimplements refid="classiceberg_1_1FileWriter_1a7206abe67a08dc3362379f810cf11b96">Metadata</reimplements>
        <briefdescription>
<para>Get file metadata for all files produced by this writer. </para>
        </briefdescription>
        <detaileddescription>
<para><simplesect kind="note"><para>This method should be called after <ref refid="classiceberg_1_1DataWriter_1acfb7b11e0ddbc46bd984dd5d6f47cb54" kindref="member">Close()</ref>. </para>
</simplesect>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/data/data_writer.h" line="64" column="10" bodyfile="iceberg/data/data_writer.cc" bodystart="134" bodyend="134"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="public-static-func">
      <memberdef kind="function" id="classiceberg_1_1DataWriter_1a75a3d11a5978812e66da37875f54fb98" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>Result&lt; std::unique_ptr&lt; <ref refid="classiceberg_1_1DataWriter" kindref="compound">DataWriter</ref> &gt; &gt;</type>
        <definition>Result&lt; std::unique_ptr&lt; DataWriter &gt; &gt; iceberg::DataWriter::Make</definition>
        <argsstring>(const DataWriterOptions &amp;options)</argsstring>
        <name>Make</name>
        <qualifiedname>iceberg::DataWriter::Make</qualifiedname>
        <param>
          <type>const <ref refid="structiceberg_1_1DataWriterOptions" kindref="compound">DataWriterOptions</ref> &amp;</type>
          <declname>options</declname>
        </param>
        <briefdescription>
<para>Create a new <ref refid="classiceberg_1_1DataWriter" kindref="compound">DataWriter</ref> instance. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/data/data_writer.h" line="59" column="17" bodyfile="iceberg/data/data_writer.cc" bodystart="123" bodyend="126"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="private-func">
      <memberdef kind="function" id="classiceberg_1_1DataWriter_1af2c7f67dc8aaec9f2521338635aa775c" prot="private" static="no" const="no" explicit="yes" inline="no" virt="non-virtual">
        <type></type>
        <definition>iceberg::DataWriter::DataWriter</definition>
        <argsstring>(std::unique_ptr&lt; Impl &gt; impl)</argsstring>
        <name>DataWriter</name>
        <qualifiedname>iceberg::DataWriter::DataWriter</qualifiedname>
        <param>
          <type>std::unique_ptr&lt; <ref refid="classiceberg_1_1DataWriter_1_1Impl" kindref="compound">Impl</ref> &gt;</type>
          <declname>impl</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/data/data_writer.h" line="70" column="12" bodyfile="iceberg/data/data_writer.cc" bodystart="119" bodyend="119"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
<para><ref refid="classiceberg_1_1Writer" kindref="compound">Writer</ref> for Iceberg data files. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="1">
        <label>iceberg::DataWriter</label>
        <link refid="classiceberg_1_1DataWriter"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
      <node id="2">
        <label>iceberg::FileWriter</label>
        <link refid="classiceberg_1_1FileWriter"/>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="1">
        <label>iceberg::DataWriter</label>
        <link refid="classiceberg_1_1DataWriter"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
      <node id="2">
        <label>iceberg::FileWriter</label>
        <link refid="classiceberg_1_1FileWriter"/>
      </node>
    </collaborationgraph>
    <location file="iceberg/data/data_writer.h" line="54" column="1" bodyfile="iceberg/data/data_writer.h" bodystart="54" bodyend="71"/>
    <listofallmembers>
      <member refid="classiceberg_1_1DataWriter_1acfb7b11e0ddbc46bd984dd5d6f47cb54" prot="public" virt="virtual"><scope>iceberg::DataWriter</scope><name>Close</name></member>
      <member refid="classiceberg_1_1DataWriter_1af2c7f67dc8aaec9f2521338635aa775c" prot="private" virt="non-virtual"><scope>iceberg::DataWriter</scope><name>DataWriter</name></member>
      <member refid="classiceberg_1_1DataWriter_1ae52a9c5f64cc631cfbe55bfb844d52f1" prot="private" virt="non-virtual"><scope>iceberg::DataWriter</scope><name>impl_</name></member>
      <member refid="classiceberg_1_1DataWriter_1a33f636f51003a122b97a5eb836846c3c" prot="public" virt="virtual"><scope>iceberg::DataWriter</scope><name>Length</name></member>
      <member refid="classiceberg_1_1DataWriter_1a75a3d11a5978812e66da37875f54fb98" prot="public" virt="non-virtual"><scope>iceberg::DataWriter</scope><name>Make</name></member>
      <member refid="classiceberg_1_1DataWriter_1a981674a97afb37f20d6c8d38417d57b8" prot="public" virt="virtual"><scope>iceberg::DataWriter</scope><name>Metadata</name></member>
      <member refid="classiceberg_1_1DataWriter_1a6a72a9a4f9193b389e0465fe4120656d" prot="public" virt="virtual"><scope>iceberg::DataWriter</scope><name>Write</name></member>
      <member refid="classiceberg_1_1DataWriter_1a6b926388d840540e961a5b6b582c27ac" prot="public" virt="non-virtual"><scope>iceberg::DataWriter</scope><name>~DataWriter</name></member>
      <member refid="classiceberg_1_1FileWriter_1ac1131a6e8ec6e4541f49528ff7677bc5" prot="public" virt="virtual"><scope>iceberg::DataWriter</scope><name>~FileWriter</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>