apidoc/xml/structpaimon_1_1_realtime_write_batch.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="structpaimon_1_1_realtime_write_batch" kind="struct" language="C++" prot="public">
    <compoundname>paimon::RealtimeWriteBatch</compoundname>
    <includes refid="mem__indexer_8h" local="no">/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/realtime/mem_indexer.h</includes>
    <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="structpaimon_1_1_realtime_write_batch_1ad1b74828b9da38a852f12e2cc7d45733" prot="public" static="no" mutable="no">
        <type>std::unique_ptr&lt; <ref refid="classpaimon_1_1_record_batch" kindref="compound">RecordBatch</ref> &gt;</type>
        <definition>std::unique_ptr&lt;RecordBatch&gt; paimon::RealtimeWriteBatch::batch</definition>
        <argsstring></argsstring>
        <name>batch</name>
        <qualifiedname>paimon::RealtimeWriteBatch::batch</qualifiedname>
        <briefdescription>
<para>Input batch whose ownership is transferred to <computeroutput><ref refid="classpaimon_1_1_mem_indexer_1ae423410972a3640613aab2a0d3429115" kindref="member">MemIndexer::Write</ref></computeroutput>. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/realtime/mem_indexer.h" line="48" column="21" bodyfile="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/realtime/mem_indexer.h" bodystart="48" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structpaimon_1_1_realtime_write_batch_1a0c57503c49a2d200d0442050d845ffa5" prot="public" static="no" mutable="no">
        <type><ref refid="structpaimon_1_1_range" kindref="compound">Range</ref></type>
        <definition>Range paimon::RealtimeWriteBatch::offset_range</definition>
        <argsstring></argsstring>
        <name>offset_range</name>
        <qualifiedname>paimon::RealtimeWriteBatch::offset_range</qualifiedname>
        <briefdescription>
<para>Inclusive <computeroutput>[from, to]</computeroutput> offset range covered by <computeroutput>batch</computeroutput>. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/realtime/mem_indexer.h" line="50" column="11" bodyfile="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/realtime/mem_indexer.h" bodystart="50" bodyend="-1"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
<para>A table record batch and its framework-assigned contiguous offset range. </para>
    </briefdescription>
    <detaileddescription>
<para>The batch contains only table write fields. Row <computeroutput>i</computeroutput> is associated with <computeroutput>offset_range.from + i</computeroutput>; the offset is progress metadata and is not a table field. </para>
    </detaileddescription>
    <collaborationgraph>
      <node id="2">
        <label>paimon::Range</label>
        <link refid="structpaimon_1_1_range"/>
      </node>
      <node id="1">
        <label>paimon::RealtimeWriteBatch</label>
        <link refid="structpaimon_1_1_realtime_write_batch"/>
        <childnode refid="2" relation="usage">
          <edgelabel>offset_range</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/realtime/mem_indexer.h" line="46" column="1" bodyfile="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/realtime/mem_indexer.h" bodystart="46" bodyend="51"/>
    <listofallmembers>
      <member refid="structpaimon_1_1_realtime_write_batch_1ad1b74828b9da38a852f12e2cc7d45733" prot="public" virt="non-virtual"><scope>paimon::RealtimeWriteBatch</scope><name>batch</name></member>
      <member refid="structpaimon_1_1_realtime_write_batch_1a0c57503c49a2d200d0442050d845ffa5" prot="public" virt="non-virtual"><scope>paimon::RealtimeWriteBatch</scope><name>offset_range</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>