api/xml/classiceberg_1_1table_1_1UpgradeFormatVersion.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_1table_1_1UpgradeFormatVersion" kind="class" language="C++" prot="public">
    <compoundname>iceberg::table::UpgradeFormatVersion</compoundname>
    <basecompoundref refid="classiceberg_1_1TableUpdate" prot="public" virt="non-virtual">iceberg::TableUpdate</basecompoundref>
    <includes refid="table__update_8h" local="no">table_update.h</includes>
    <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classiceberg_1_1table_1_1UpgradeFormatVersion_1a8309b4a903769d9c1d5ca401d4afe8b6" prot="private" static="no" mutable="no">
        <type>int8_t</type>
        <definition>int8_t iceberg::table::UpgradeFormatVersion::format_version_</definition>
        <argsstring></argsstring>
        <name>format_version_</name>
        <qualifiedname>iceberg::table::UpgradeFormatVersion::format_version_</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/table_update.h" line="150" column="10" bodyfile="iceberg/table_update.h" bodystart="150" bodyend="-1"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="public-func">
      <memberdef kind="function" id="classiceberg_1_1table_1_1UpgradeFormatVersion_1a516fe0c7356afade204ce291c4573960" prot="public" static="no" const="no" explicit="yes" inline="yes" virt="non-virtual">
        <type></type>
        <definition>iceberg::table::UpgradeFormatVersion::UpgradeFormatVersion</definition>
        <argsstring>(int8_t format_version)</argsstring>
        <name>UpgradeFormatVersion</name>
        <qualifiedname>iceberg::table::UpgradeFormatVersion::UpgradeFormatVersion</qualifiedname>
        <param>
          <type>int8_t</type>
          <declname>format_version</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/table_update.h" line="134" column="12" bodyfile="iceberg/table_update.h" bodystart="134" bodyend="135"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1table_1_1UpgradeFormatVersion_1af95382ae105c425960e1600d3cf711e1" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>int8_t</type>
        <definition>int8_t iceberg::table::UpgradeFormatVersion::format_version</definition>
        <argsstring>() const</argsstring>
        <name>format_version</name>
        <qualifiedname>iceberg::table::UpgradeFormatVersion::format_version</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/table_update.h" line="137" column="10" bodyfile="iceberg/table_update.h" bodystart="137" bodyend="137"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1table_1_1UpgradeFormatVersion_1a4d2cdf7ea6d5a8ce8f70ea52e6ea0514" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>void iceberg::table::UpgradeFormatVersion::ApplyTo</definition>
        <argsstring>(TableMetadataBuilder &amp;builder) const override</argsstring>
        <name>ApplyTo</name>
        <qualifiedname>iceberg::table::UpgradeFormatVersion::ApplyTo</qualifiedname>
        <reimplements refid="classiceberg_1_1TableUpdate_1af07326d407ad45eb6072b586ee6c9485">ApplyTo</reimplements>
        <param>
          <type><ref refid="classiceberg_1_1TableMetadataBuilder" kindref="compound">TableMetadataBuilder</ref> &amp;</type>
          <declname>builder</declname>
        </param>
        <briefdescription>
<para>Apply this update to a <ref refid="classiceberg_1_1TableMetadataBuilder" kindref="compound">TableMetadataBuilder</ref>. </para>
        </briefdescription>
        <detaileddescription>
<para>This method modifies the builder by applying the update operation it represents. Each subclass implements this to apply its specific type of update.</para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>builder</parametername>
</parameternamelist>
<parameterdescription>
<para>The builder to apply this update to </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/table_update.h" line="139" column="8" bodyfile="iceberg/table_update.cc" bodystart="61" bodyend="63"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1table_1_1UpgradeFormatVersion_1a2a78db6ae8580316f30911982ecfcfd6" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>void iceberg::table::UpgradeFormatVersion::GenerateRequirements</definition>
        <argsstring>(TableUpdateContext &amp;context) const override</argsstring>
        <name>GenerateRequirements</name>
        <qualifiedname>iceberg::table::UpgradeFormatVersion::GenerateRequirements</qualifiedname>
        <reimplements refid="classiceberg_1_1TableUpdate_1adddc714f83cea93141bc5b771e326e05">GenerateRequirements</reimplements>
        <param>
          <type><ref refid="classiceberg_1_1TableUpdateContext" kindref="compound">TableUpdateContext</ref> &amp;</type>
          <declname>context</declname>
        </param>
        <briefdescription>
<para>Generate update requirements for this metadata update. </para>
        </briefdescription>
        <detaileddescription>
<para>This method generates the appropriate UpdateRequirement instances that must be validated before this update can be applied. The context provides information about the base metadata and operation mode.</para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>context</parametername>
</parameternamelist>
<parameterdescription>
<para>The context containing base metadata and operation state </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/table_update.h" line="141" column="8" bodyfile="iceberg/table_update.cc" bodystart="65" bodyend="67"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1table_1_1UpgradeFormatVersion_1a3fd1492ca5fa6376ecef5ed32c845591" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
        <type>Kind</type>
        <definition>Kind iceberg::table::UpgradeFormatVersion::kind</definition>
        <argsstring>() const override</argsstring>
        <name>kind</name>
        <qualifiedname>iceberg::table::UpgradeFormatVersion::kind</qualifiedname>
        <reimplements refid="classiceberg_1_1TableUpdate_1acf1e83fa9835010cda68a6a3387a08a5">kind</reimplements>
        <briefdescription>
<para>Return the kind of this update. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/table_update.h" line="143" column="8" bodyfile="iceberg/table_update.h" bodystart="143" bodyend="143"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1table_1_1UpgradeFormatVersion_1a352aaa5b079b3feb6dc91f6bae293e54" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
        <type>bool</type>
        <definition>bool iceberg::table::UpgradeFormatVersion::Equals</definition>
        <argsstring>(const TableUpdate &amp;other) const override</argsstring>
        <name>Equals</name>
        <qualifiedname>iceberg::table::UpgradeFormatVersion::Equals</qualifiedname>
        <reimplements refid="classiceberg_1_1TableUpdate_1afd0780e6106546f7462e8e66d62db1f2">Equals</reimplements>
        <param>
          <type>const <ref refid="classiceberg_1_1TableUpdate" kindref="compound">TableUpdate</ref> &amp;</type>
          <declname>other</declname>
        </param>
        <briefdescription>
<para>Check equality with another <ref refid="classiceberg_1_1TableUpdate" kindref="compound">TableUpdate</ref>. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>other</parametername>
</parameternamelist>
<parameterdescription>
<para>The update to compare with </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>true if the updates are equal, false otherwise </para>
</simplesect>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/table_update.h" line="145" column="8" bodyfile="iceberg/table_update.cc" bodystart="69" bodyend="75"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1table_1_1UpgradeFormatVersion_1a52d742bc01e2fd4588ac8e91eb3dd5a7" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
        <type>std::unique_ptr&lt; <ref refid="classiceberg_1_1TableUpdate" kindref="compound">TableUpdate</ref> &gt;</type>
        <definition>std::unique_ptr&lt; TableUpdate &gt; iceberg::table::UpgradeFormatVersion::Clone</definition>
        <argsstring>() const override</argsstring>
        <name>Clone</name>
        <qualifiedname>iceberg::table::UpgradeFormatVersion::Clone</qualifiedname>
        <reimplements refid="classiceberg_1_1TableUpdate_1affb4be490ac63849864bf8ed636363aa">Clone</reimplements>
        <briefdescription>
<para>Create a deep copy of this update. </para>
        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>A unique_ptr to a new <ref refid="classiceberg_1_1TableUpdate" kindref="compound">TableUpdate</ref> that is a copy of this one </para>
</simplesect>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/table_update.h" line="147" column="19" bodyfile="iceberg/table_update.cc" bodystart="77" bodyend="79"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
<para>Represents an upgrade of the table format version. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="2">
        <label>iceberg::TableUpdate</label>
        <link refid="classiceberg_1_1TableUpdate"/>
      </node>
      <node id="1">
        <label>iceberg::table::UpgradeFormatVersion</label>
        <link refid="classiceberg_1_1table_1_1UpgradeFormatVersion"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="2">
        <label>iceberg::TableUpdate</label>
        <link refid="classiceberg_1_1TableUpdate"/>
      </node>
      <node id="1">
        <label>iceberg::table::UpgradeFormatVersion</label>
        <link refid="classiceberg_1_1table_1_1UpgradeFormatVersion"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
    </collaborationgraph>
    <location file="iceberg/table_update.h" line="132" column="1" bodyfile="iceberg/table_update.h" bodystart="132" bodyend="151"/>
    <listofallmembers>
      <member refid="classiceberg_1_1table_1_1UpgradeFormatVersion_1a4d2cdf7ea6d5a8ce8f70ea52e6ea0514" prot="public" virt="virtual"><scope>iceberg::table::UpgradeFormatVersion</scope><name>ApplyTo</name></member>
      <member refid="classiceberg_1_1table_1_1UpgradeFormatVersion_1a52d742bc01e2fd4588ac8e91eb3dd5a7" prot="public" virt="virtual"><scope>iceberg::table::UpgradeFormatVersion</scope><name>Clone</name></member>
      <member refid="classiceberg_1_1table_1_1UpgradeFormatVersion_1a352aaa5b079b3feb6dc91f6bae293e54" prot="public" virt="virtual"><scope>iceberg::table::UpgradeFormatVersion</scope><name>Equals</name></member>
      <member refid="classiceberg_1_1table_1_1UpgradeFormatVersion_1af95382ae105c425960e1600d3cf711e1" prot="public" virt="non-virtual"><scope>iceberg::table::UpgradeFormatVersion</scope><name>format_version</name></member>
      <member refid="classiceberg_1_1table_1_1UpgradeFormatVersion_1a8309b4a903769d9c1d5ca401d4afe8b6" prot="private" virt="non-virtual"><scope>iceberg::table::UpgradeFormatVersion</scope><name>format_version_</name></member>
      <member refid="classiceberg_1_1table_1_1UpgradeFormatVersion_1a2a78db6ae8580316f30911982ecfcfd6" prot="public" virt="virtual"><scope>iceberg::table::UpgradeFormatVersion</scope><name>GenerateRequirements</name></member>
      <member refid="classiceberg_1_1table_1_1UpgradeFormatVersion_1a3fd1492ca5fa6376ecef5ed32c845591" prot="public" virt="virtual"><scope>iceberg::table::UpgradeFormatVersion</scope><name>kind</name></member>
      <member refid="classiceberg_1_1TableUpdate_1ad8c72b1755b111ad20acff6ae6d4974d" prot="public" virt="non-virtual"><scope>iceberg::table::UpgradeFormatVersion</scope><name>Kind</name></member>
      <member refid="classiceberg_1_1table_1_1UpgradeFormatVersion_1a516fe0c7356afade204ce291c4573960" prot="public" virt="non-virtual"><scope>iceberg::table::UpgradeFormatVersion</scope><name>UpgradeFormatVersion</name></member>
      <member refid="classiceberg_1_1TableUpdate_1a1a77bb6c54a6d728aa28b9847a039d85" prot="public" virt="virtual"><scope>iceberg::table::UpgradeFormatVersion</scope><name>~TableUpdate</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>