| <?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_1UpdateSnapshotReference" kind="class" language="C++" prot="public"> |
| <compoundname>iceberg::UpdateSnapshotReference</compoundname> |
| <basecompoundref refid="classiceberg_1_1PendingUpdate" prot="public" virt="non-virtual">iceberg::PendingUpdate</basecompoundref> |
| <includes refid="update__snapshot__reference_8h" local="no">update_snapshot_reference.h</includes> |
| <innerclass refid="structiceberg_1_1UpdateSnapshotReference_1_1ApplyResult" prot="public">iceberg::UpdateSnapshotReference::ApplyResult</innerclass> |
| <sectiondef kind="private-attrib"> |
| <memberdef kind="variable" id="classiceberg_1_1UpdateSnapshotReference_1a58609d3844dcbe27cf2c4e3124d4f89b" prot="private" static="no" mutable="no"> |
| <type>std::unordered_map< std::string, std::shared_ptr< <ref refid="structiceberg_1_1SnapshotRef" kindref="compound">SnapshotRef</ref> > ></type> |
| <definition>std::unordered_map<std::string, std::shared_ptr<SnapshotRef> > iceberg::UpdateSnapshotReference::updated_refs_</definition> |
| <argsstring></argsstring> |
| <name>updated_refs_</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::updated_refs_</qualifiedname> |
| <briefdescription> |
| </briefdescription> |
| <detaileddescription> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="154" column="22" bodyfile="iceberg/update/update_snapshot_reference.h" bodystart="154" bodyend="-1"/> |
| </memberdef> |
| </sectiondef> |
| <sectiondef kind="public-static-func"> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1aa3ca681f9bfc66614b2b463201a5854e" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type>Result< std::shared_ptr< <ref refid="classiceberg_1_1UpdateSnapshotReference" kindref="compound">UpdateSnapshotReference</ref> > ></type> |
| <definition>Result< std::shared_ptr< UpdateSnapshotReference > > iceberg::UpdateSnapshotReference::Make</definition> |
| <argsstring>(std::shared_ptr< Transaction > transaction)</argsstring> |
| <name>Make</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::Make</qualifiedname> |
| <param> |
| <type>std::shared_ptr< <ref refid="classiceberg_1_1Transaction" kindref="compound">Transaction</ref> ></type> |
| <declname>transaction</declname> |
| </param> |
| <briefdescription> |
| </briefdescription> |
| <detaileddescription> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="41" column="17" bodyfile="iceberg/update/update_snapshot_reference.cc" bodystart="35" bodyend="41"/> |
| </memberdef> |
| </sectiondef> |
| <sectiondef kind="public-func"> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1a3ec7f822936304a17232e616fb4d41c4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type></type> |
| <definition>iceberg::UpdateSnapshotReference::~UpdateSnapshotReference</definition> |
| <argsstring>() override</argsstring> |
| <name>~UpdateSnapshotReference</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::~UpdateSnapshotReference</qualifiedname> |
| <briefdescription> |
| </briefdescription> |
| <detaileddescription> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="44" column="3"/> |
| </memberdef> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1aa2b206e480c3975eed0ec681055fb421" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classiceberg_1_1UpdateSnapshotReference" kindref="compound">UpdateSnapshotReference</ref> &</type> |
| <definition>UpdateSnapshotReference & iceberg::UpdateSnapshotReference::CreateBranch</definition> |
| <argsstring>(const std::string &name, int64_t snapshot_id)</argsstring> |
| <name>CreateBranch</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::CreateBranch</qualifiedname> |
| <param> |
| <type>const std::string &</type> |
| <declname>name</declname> |
| </param> |
| <param> |
| <type>int64_t</type> |
| <declname>snapshot_id</declname> |
| </param> |
| <briefdescription> |
| <para>Create a branch reference. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>name</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The branch name </para> |
| </parameterdescription> |
| </parameteritem> |
| <parameteritem> |
| <parameternamelist> |
| <parametername>snapshot_id</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The snapshot ID for the branch </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para><ref refid="classiceberg_1_1Reference" kindref="compound">Reference</ref> to this for method chaining </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="51" column="27" bodyfile="iceberg/update/update_snapshot_reference.cc" bodystart="48" bodyend="55"/> |
| </memberdef> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1afeb72977cdad95e81a9a39e371bc3fed" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classiceberg_1_1UpdateSnapshotReference" kindref="compound">UpdateSnapshotReference</ref> &</type> |
| <definition>UpdateSnapshotReference & iceberg::UpdateSnapshotReference::CreateTag</definition> |
| <argsstring>(const std::string &name, int64_t snapshot_id)</argsstring> |
| <name>CreateTag</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::CreateTag</qualifiedname> |
| <param> |
| <type>const std::string &</type> |
| <declname>name</declname> |
| </param> |
| <param> |
| <type>int64_t</type> |
| <declname>snapshot_id</declname> |
| </param> |
| <briefdescription> |
| <para>Create a tag reference. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>name</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The tag name </para> |
| </parameterdescription> |
| </parameteritem> |
| <parameteritem> |
| <parameternamelist> |
| <parametername>snapshot_id</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The snapshot ID for the tag </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para><ref refid="classiceberg_1_1Reference" kindref="compound">Reference</ref> to this for method chaining </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="58" column="27" bodyfile="iceberg/update/update_snapshot_reference.cc" bodystart="57" bodyend="64"/> |
| </memberdef> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1ad4cba4f1a05a47a103c2bab28e6c0d0b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classiceberg_1_1UpdateSnapshotReference" kindref="compound">UpdateSnapshotReference</ref> &</type> |
| <definition>UpdateSnapshotReference & iceberg::UpdateSnapshotReference::RemoveBranch</definition> |
| <argsstring>(const std::string &name)</argsstring> |
| <name>RemoveBranch</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::RemoveBranch</qualifiedname> |
| <param> |
| <type>const std::string &</type> |
| <declname>name</declname> |
| </param> |
| <briefdescription> |
| <para>Remove a branch reference. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>name</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The branch name to remove </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para><ref refid="classiceberg_1_1Reference" kindref="compound">Reference</ref> to this for method chaining </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="64" column="27" bodyfile="iceberg/update/update_snapshot_reference.cc" bodystart="66" bodyend="75"/> |
| </memberdef> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1a9f035c9b6c1a8144f69b6a0834772669" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classiceberg_1_1UpdateSnapshotReference" kindref="compound">UpdateSnapshotReference</ref> &</type> |
| <definition>UpdateSnapshotReference & iceberg::UpdateSnapshotReference::RemoveTag</definition> |
| <argsstring>(const std::string &name)</argsstring> |
| <name>RemoveTag</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::RemoveTag</qualifiedname> |
| <param> |
| <type>const std::string &</type> |
| <declname>name</declname> |
| </param> |
| <briefdescription> |
| <para>Remove a tag reference. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>name</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The tag name to remove </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para><ref refid="classiceberg_1_1Reference" kindref="compound">Reference</ref> to this for method chaining </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="70" column="27" bodyfile="iceberg/update/update_snapshot_reference.cc" bodystart="77" bodyend="85"/> |
| </memberdef> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1addd69d3ac34ed0591b09276a7030009b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classiceberg_1_1UpdateSnapshotReference" kindref="compound">UpdateSnapshotReference</ref> &</type> |
| <definition>UpdateSnapshotReference & iceberg::UpdateSnapshotReference::RenameBranch</definition> |
| <argsstring>(const std::string &name, const std::string &new_name)</argsstring> |
| <name>RenameBranch</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::RenameBranch</qualifiedname> |
| <param> |
| <type>const std::string &</type> |
| <declname>name</declname> |
| </param> |
| <param> |
| <type>const std::string &</type> |
| <declname>new_name</declname> |
| </param> |
| <briefdescription> |
| <para>Rename a branch reference. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>name</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The current branch name </para> |
| </parameterdescription> |
| </parameteritem> |
| <parameteritem> |
| <parameternamelist> |
| <parametername>new_name</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The new branch name </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para><ref refid="classiceberg_1_1Reference" kindref="compound">Reference</ref> to this for method chaining </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="77" column="27" bodyfile="iceberg/update/update_snapshot_reference.cc" bodystart="87" bodyend="100"/> |
| </memberdef> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1a839c4712058906a871996decdcdb8108" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classiceberg_1_1UpdateSnapshotReference" kindref="compound">UpdateSnapshotReference</ref> &</type> |
| <definition>UpdateSnapshotReference & iceberg::UpdateSnapshotReference::ReplaceBranch</definition> |
| <argsstring>(const std::string &name, int64_t snapshot_id)</argsstring> |
| <name>ReplaceBranch</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::ReplaceBranch</qualifiedname> |
| <param> |
| <type>const std::string &</type> |
| <declname>name</declname> |
| </param> |
| <param> |
| <type>int64_t</type> |
| <declname>snapshot_id</declname> |
| </param> |
| <briefdescription> |
| <para>Replace a branch reference with a new snapshot ID. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>name</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The branch name </para> |
| </parameterdescription> |
| </parameteritem> |
| <parameteritem> |
| <parameternamelist> |
| <parametername>snapshot_id</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The new snapshot ID </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para><ref refid="classiceberg_1_1Reference" kindref="compound">Reference</ref> to this for method chaining </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="85" column="27" bodyfile="iceberg/update/update_snapshot_reference.cc" bodystart="102" bodyend="111"/> |
| </memberdef> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1ad931e8aa29e96c7818120b8c31817eed" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classiceberg_1_1UpdateSnapshotReference" kindref="compound">UpdateSnapshotReference</ref> &</type> |
| <definition>UpdateSnapshotReference & iceberg::UpdateSnapshotReference::ReplaceBranch</definition> |
| <argsstring>(const std::string &from, const std::string &to)</argsstring> |
| <name>ReplaceBranch</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::ReplaceBranch</qualifiedname> |
| <param> |
| <type>const std::string &</type> |
| <declname>from</declname> |
| </param> |
| <param> |
| <type>const std::string &</type> |
| <declname>to</declname> |
| </param> |
| <briefdescription> |
| <para>Replace a branch reference with another reference's snapshot ID. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>from</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The branch name to update </para> |
| </parameterdescription> |
| </parameteritem> |
| <parameteritem> |
| <parameternamelist> |
| <parametername>to</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The reference name to copy the snapshot ID from </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para><ref refid="classiceberg_1_1Reference" kindref="compound">Reference</ref> to this for method chaining </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="92" column="27" bodyfile="iceberg/update/update_snapshot_reference.cc" bodystart="113" bodyend="116"/> |
| </memberdef> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1a7c274cfeb145f645421c495580447add" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classiceberg_1_1UpdateSnapshotReference" kindref="compound">UpdateSnapshotReference</ref> &</type> |
| <definition>UpdateSnapshotReference & iceberg::UpdateSnapshotReference::FastForward</definition> |
| <argsstring>(const std::string &from, const std::string &to)</argsstring> |
| <name>FastForward</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::FastForward</qualifiedname> |
| <param> |
| <type>const std::string &</type> |
| <declname>from</declname> |
| </param> |
| <param> |
| <type>const std::string &</type> |
| <declname>to</declname> |
| </param> |
| <briefdescription> |
| <para>Fast-forward a branch to another reference's snapshot ID. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para>This is similar to ReplaceBranch but validates that the target snapshot is an ancestor of the current branch snapshot.</para> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>from</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The branch name to update </para> |
| </parameterdescription> |
| </parameteritem> |
| <parameteritem> |
| <parameternamelist> |
| <parametername>to</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The reference name to copy the snapshot ID from </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para><ref refid="classiceberg_1_1Reference" kindref="compound">Reference</ref> to this for method chaining </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="102" column="27" bodyfile="iceberg/update/update_snapshot_reference.cc" bodystart="118" bodyend="121"/> |
| </memberdef> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1adc9d7f88938a20e1f113464dfc00fcf9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classiceberg_1_1UpdateSnapshotReference" kindref="compound">UpdateSnapshotReference</ref> &</type> |
| <definition>UpdateSnapshotReference & iceberg::UpdateSnapshotReference::ReplaceTag</definition> |
| <argsstring>(const std::string &name, int64_t snapshot_id)</argsstring> |
| <name>ReplaceTag</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::ReplaceTag</qualifiedname> |
| <param> |
| <type>const std::string &</type> |
| <declname>name</declname> |
| </param> |
| <param> |
| <type>int64_t</type> |
| <declname>snapshot_id</declname> |
| </param> |
| <briefdescription> |
| <para>Replace a tag reference with a new snapshot ID. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>name</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The tag name </para> |
| </parameterdescription> |
| </parameteritem> |
| <parameteritem> |
| <parameternamelist> |
| <parametername>snapshot_id</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The new snapshot ID </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para><ref refid="classiceberg_1_1Reference" kindref="compound">Reference</ref> to this for method chaining </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="109" column="27" bodyfile="iceberg/update/update_snapshot_reference.cc" bodystart="161" bodyend="170"/> |
| </memberdef> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1af17c0f80038ab35945d1f869656fe5ab" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classiceberg_1_1UpdateSnapshotReference" kindref="compound">UpdateSnapshotReference</ref> &</type> |
| <definition>UpdateSnapshotReference & iceberg::UpdateSnapshotReference::SetMinSnapshotsToKeep</definition> |
| <argsstring>(const std::string &name, int32_t min_snapshots_to_keep)</argsstring> |
| <name>SetMinSnapshotsToKeep</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::SetMinSnapshotsToKeep</qualifiedname> |
| <param> |
| <type>const std::string &</type> |
| <declname>name</declname> |
| </param> |
| <param> |
| <type>int32_t</type> |
| <declname>min_snapshots_to_keep</declname> |
| </param> |
| <briefdescription> |
| <para>Set the minimum number of snapshots to keep for a branch. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>name</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The branch name </para> |
| </parameterdescription> |
| </parameteritem> |
| <parameteritem> |
| <parameternamelist> |
| <parametername>min_snapshots_to_keep</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The minimum number of snapshots to keep </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para><ref refid="classiceberg_1_1Reference" kindref="compound">Reference</ref> to this for method chaining </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="116" column="27" bodyfile="iceberg/update/update_snapshot_reference.cc" bodystart="172" bodyend="186"/> |
| </memberdef> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1a920b8e4e58e2e0766ddb0187170bf0b8" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classiceberg_1_1UpdateSnapshotReference" kindref="compound">UpdateSnapshotReference</ref> &</type> |
| <definition>UpdateSnapshotReference & iceberg::UpdateSnapshotReference::SetMaxSnapshotAgeMs</definition> |
| <argsstring>(const std::string &name, int64_t max_snapshot_age_ms)</argsstring> |
| <name>SetMaxSnapshotAgeMs</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::SetMaxSnapshotAgeMs</qualifiedname> |
| <param> |
| <type>const std::string &</type> |
| <declname>name</declname> |
| </param> |
| <param> |
| <type>int64_t</type> |
| <declname>max_snapshot_age_ms</declname> |
| </param> |
| <briefdescription> |
| <para>Set the maximum snapshot age in milliseconds for a branch. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>name</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The branch name </para> |
| </parameterdescription> |
| </parameteritem> |
| <parameteritem> |
| <parameternamelist> |
| <parametername>max_snapshot_age_ms</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The maximum snapshot age in milliseconds </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para><ref refid="classiceberg_1_1Reference" kindref="compound">Reference</ref> to this for method chaining </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="124" column="27" bodyfile="iceberg/update/update_snapshot_reference.cc" bodystart="188" bodyend="202"/> |
| </memberdef> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1a6106a27e7accb8b9019b2667c546db80" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classiceberg_1_1UpdateSnapshotReference" kindref="compound">UpdateSnapshotReference</ref> &</type> |
| <definition>UpdateSnapshotReference & iceberg::UpdateSnapshotReference::SetMaxRefAgeMs</definition> |
| <argsstring>(const std::string &name, int64_t max_ref_age_ms)</argsstring> |
| <name>SetMaxRefAgeMs</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::SetMaxRefAgeMs</qualifiedname> |
| <param> |
| <type>const std::string &</type> |
| <declname>name</declname> |
| </param> |
| <param> |
| <type>int64_t</type> |
| <declname>max_ref_age_ms</declname> |
| </param> |
| <briefdescription> |
| <para>Set the maximum reference age in milliseconds. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>name</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The reference name </para> |
| </parameterdescription> |
| </parameteritem> |
| <parameteritem> |
| <parameternamelist> |
| <parametername>max_ref_age_ms</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The maximum reference age in milliseconds </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para><ref refid="classiceberg_1_1Reference" kindref="compound">Reference</ref> to this for method chaining </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="132" column="27" bodyfile="iceberg/update/update_snapshot_reference.cc" bodystart="204" bodyend="218"/> |
| </memberdef> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1a607504fa70250fcbacd8abf5c009dec6" prot="public" static="no" const="yes" explicit="no" inline="yes" final="yes" virt="virtual"> |
| <type>Kind</type> |
| <definition>Kind iceberg::UpdateSnapshotReference::kind</definition> |
| <argsstring>() const final</argsstring> |
| <name>kind</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::kind</qualifiedname> |
| <reimplements refid="classiceberg_1_1PendingUpdate_1a33fba65ffa4a85fd7c5b9984cb892812">kind</reimplements> |
| <briefdescription> |
| <para>Return the kind of this pending update. </para> |
| </briefdescription> |
| <detaileddescription> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="135" column="8" bodyfile="iceberg/update/update_snapshot_reference.h" bodystart="135" bodyend="135"/> |
| </memberdef> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1a904a1455bf90448127826c03ca817dbe" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type>Result< <ref refid="structiceberg_1_1UpdateSnapshotReference_1_1ApplyResult" kindref="compound">ApplyResult</ref> ></type> |
| <definition>Result< UpdateSnapshotReference::ApplyResult > iceberg::UpdateSnapshotReference::Apply</definition> |
| <argsstring>()</argsstring> |
| <name>Apply</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::Apply</qualifiedname> |
| <briefdescription> |
| <para>Apply the pending changes and return the updated and removed references. </para> |
| </briefdescription> |
| <detaileddescription> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="145" column="10" bodyfile="iceberg/update/update_snapshot_reference.cc" bodystart="220" bodyend="242"/> |
| </memberdef> |
| </sectiondef> |
| <sectiondef kind="private-func"> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1a325cee99c4b3a7d0bffcb44320e29cd3" prot="private" static="no" const="no" explicit="yes" inline="no" virt="non-virtual"> |
| <type></type> |
| <definition>iceberg::UpdateSnapshotReference::UpdateSnapshotReference</definition> |
| <argsstring>(std::shared_ptr< Transaction > transaction)</argsstring> |
| <name>UpdateSnapshotReference</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::UpdateSnapshotReference</qualifiedname> |
| <param> |
| <type>std::shared_ptr< <ref refid="classiceberg_1_1Transaction" kindref="compound">Transaction</ref> ></type> |
| <declname>transaction</declname> |
| </param> |
| <briefdescription> |
| </briefdescription> |
| <detaileddescription> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="148" column="12" bodyfile="iceberg/update/update_snapshot_reference.cc" bodystart="43" bodyend="44"/> |
| </memberdef> |
| <memberdef kind="function" id="classiceberg_1_1UpdateSnapshotReference_1a00f20f2142866450cc6e0acd51ac096a" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classiceberg_1_1UpdateSnapshotReference" kindref="compound">UpdateSnapshotReference</ref> &</type> |
| <definition>UpdateSnapshotReference & iceberg::UpdateSnapshotReference::ReplaceBranchInternal</definition> |
| <argsstring>(const std::string &from, const std::string &to, bool fast_forward)</argsstring> |
| <name>ReplaceBranchInternal</name> |
| <qualifiedname>iceberg::UpdateSnapshotReference::ReplaceBranchInternal</qualifiedname> |
| <param> |
| <type>const std::string &</type> |
| <declname>from</declname> |
| </param> |
| <param> |
| <type>const std::string &</type> |
| <declname>to</declname> |
| </param> |
| <param> |
| <type>bool</type> |
| <declname>fast_forward</declname> |
| </param> |
| <briefdescription> |
| </briefdescription> |
| <detaileddescription> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="iceberg/update/update_snapshot_reference.h" line="150" column="27" bodyfile="iceberg/update/update_snapshot_reference.cc" bodystart="123" bodyend="159"/> |
| </memberdef> |
| </sectiondef> |
| <briefdescription> |
| <para>Updates snapshot references. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para>TODO(xxx): Add <ref refid="classiceberg_1_1SetSnapshot" kindref="compound">SetSnapshot</ref> operations such as SetCurrentSnapshot, RollBackTime, RollbackTo to this class so that we can support those operations for refs. </para> |
| </detaileddescription> |
| <inheritancegraph> |
| <node id="3"> |
| <label>iceberg::ErrorCollector</label> |
| <link refid="classiceberg_1_1ErrorCollector"/> |
| </node> |
| <node id="2"> |
| <label>iceberg::PendingUpdate</label> |
| <link refid="classiceberg_1_1PendingUpdate"/> |
| <childnode refid="3" relation="public-inheritance"> |
| </childnode> |
| </node> |
| <node id="1"> |
| <label>iceberg::UpdateSnapshotReference</label> |
| <link refid="classiceberg_1_1UpdateSnapshotReference"/> |
| <childnode refid="2" relation="public-inheritance"> |
| </childnode> |
| </node> |
| </inheritancegraph> |
| <collaborationgraph> |
| <node id="5"> |
| <label>iceberg::Error</label> |
| <link refid="structiceberg_1_1Error"/> |
| <childnode refid="6" relation="usage"> |
| <edgelabel>message</edgelabel> |
| </childnode> |
| </node> |
| <node id="3"> |
| <label>iceberg::ErrorCollector</label> |
| <link refid="classiceberg_1_1ErrorCollector"/> |
| <childnode refid="4" relation="usage"> |
| <edgelabel>errors_</edgelabel> |
| </childnode> |
| </node> |
| <node id="2"> |
| <label>iceberg::PendingUpdate</label> |
| <link refid="classiceberg_1_1PendingUpdate"/> |
| <childnode refid="3" relation="public-inheritance"> |
| </childnode> |
| <childnode refid="8" relation="usage"> |
| <edgelabel>transaction_</edgelabel> |
| </childnode> |
| </node> |
| <node id="9"> |
| <label>iceberg::Transaction</label> |
| <link refid="classiceberg_1_1Transaction"/> |
| <childnode refid="10" relation="public-inheritance"> |
| </childnode> |
| </node> |
| <node id="1"> |
| <label>iceberg::UpdateSnapshotReference</label> |
| <link refid="classiceberg_1_1UpdateSnapshotReference"/> |
| <childnode refid="2" relation="public-inheritance"> |
| </childnode> |
| </node> |
| <node id="8"> |
| <label>std::shared_ptr< iceberg::Transaction ></label> |
| <childnode refid="9" relation="usage"> |
| <edgelabel>ptr</edgelabel> |
| </childnode> |
| </node> |
| <node id="7"> |
| <label>std::basic_string< Char ></label> |
| </node> |
| <node id="10"> |
| <label>std::enable_shared_from_this< Transaction ></label> |
| </node> |
| <node id="6"> |
| <label>std::string</label> |
| <childnode refid="7" relation="public-inheritance"> |
| </childnode> |
| </node> |
| <node id="4"> |
| <label>std::vector< iceberg::Error ></label> |
| <childnode refid="5" relation="usage"> |
| <edgelabel>elements</edgelabel> |
| </childnode> |
| </node> |
| </collaborationgraph> |
| <location file="iceberg/update/update_snapshot_reference.h" line="39" column="1" bodyfile="iceberg/update/update_snapshot_reference.h" bodystart="39" bodyend="155"/> |
| <listofallmembers> |
| <member refid="classiceberg_1_1ErrorCollector_1a3a20345150b136c918ffe8947a7d75e1" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>AddError</name></member> |
| <member refid="classiceberg_1_1ErrorCollector_1a5e555954de121d0908dcf4648da446e3" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>AddError</name></member> |
| <member refid="classiceberg_1_1ErrorCollector_1a5749264a2234092a5246056a1c72ee51" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>AddError</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1a904a1455bf90448127826c03ca817dbe" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>Apply</name></member> |
| <member refid="classiceberg_1_1PendingUpdate_1a93721051561748b1a29e75b7d4cbbd86" prot="protected" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>base</name></member> |
| <member refid="classiceberg_1_1ErrorCollector_1a16cbe7b6d423a372c9e68d970ff2c3ea" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>CheckErrors</name></member> |
| <member refid="classiceberg_1_1ErrorCollector_1a274df2b90b0c22156a4c339aa30a4401" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>ClearErrors</name></member> |
| <member refid="classiceberg_1_1PendingUpdate_1a4a5df6d83b7a4a3c4dac19a77945be71" prot="public" virt="virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>Commit</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1aa2b206e480c3975eed0ec681055fb421" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>CreateBranch</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1afeb72977cdad95e81a9a39e371bc3fed" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>CreateTag</name></member> |
| <member refid="classiceberg_1_1ErrorCollector_1afae10739a78bbffc2609a63e52821195" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>error_count</name></member> |
| <member refid="classiceberg_1_1ErrorCollector_1a690c840a35a03af0f94eea092ca65aaa" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>ErrorCollector</name></member> |
| <member refid="classiceberg_1_1ErrorCollector_1a827c296a8527f87f76d7f9321e7ee68f" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>ErrorCollector</name></member> |
| <member refid="classiceberg_1_1ErrorCollector_1ab3fa546cd2748fe418db9c0933542755" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>ErrorCollector</name></member> |
| <member refid="classiceberg_1_1ErrorCollector_1a101fb70f2ad50a6023de932dc2eca96c" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>errors</name></member> |
| <member refid="classiceberg_1_1ErrorCollector_1a354d1e7287bb45926a4b563f80d0c623" prot="protected" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>errors_</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1a7c274cfeb145f645421c495580447add" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>FastForward</name></member> |
| <member refid="classiceberg_1_1PendingUpdate_1a22441dbf2867204cb175300075e50db9" prot="public" virt="virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>Finalize</name></member> |
| <member refid="classiceberg_1_1ErrorCollector_1a8813b3fe2a3cc112e6db19c87b8422ae" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>has_errors</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1a607504fa70250fcbacd8abf5c009dec6" prot="public" virt="virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>kind</name></member> |
| <member refid="classiceberg_1_1PendingUpdate_1a5bac3f32c6a0790ba222399fed5c1944" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>Kind</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1aa3ca681f9bfc66614b2b463201a5854e" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>Make</name></member> |
| <member refid="classiceberg_1_1PendingUpdate_1a3314053bba6a86931feb39c1487e2c8b" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>operator=</name></member> |
| <member refid="classiceberg_1_1PendingUpdate_1a9e71d56c145591059c7e2f6ee0305295" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>operator=</name></member> |
| <member refid="classiceberg_1_1ErrorCollector_1a22311658715152d8e6e27834240ce446" prot="public" virt="non-virtual" ambiguityscope="iceberg::ErrorCollector::"><scope>iceberg::UpdateSnapshotReference</scope><name>operator=</name></member> |
| <member refid="classiceberg_1_1ErrorCollector_1aaba366560be481bfa9538735f3a38e3e" prot="public" virt="non-virtual" ambiguityscope="iceberg::ErrorCollector::"><scope>iceberg::UpdateSnapshotReference</scope><name>operator=</name></member> |
| <member refid="classiceberg_1_1PendingUpdate_1ac5c3549e22869ad7f6abd417ffcabbe2" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>PendingUpdate</name></member> |
| <member refid="classiceberg_1_1PendingUpdate_1a18521611dee09ce7f85477f38d85e75d" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>PendingUpdate</name></member> |
| <member refid="classiceberg_1_1PendingUpdate_1ab758ff7780442894f3fb0a80d0db064f" prot="protected" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>PendingUpdate</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1ad4cba4f1a05a47a103c2bab28e6c0d0b" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>RemoveBranch</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1a9f035c9b6c1a8144f69b6a0834772669" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>RemoveTag</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1addd69d3ac34ed0591b09276a7030009b" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>RenameBranch</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1a839c4712058906a871996decdcdb8108" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>ReplaceBranch</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1ad931e8aa29e96c7818120b8c31817eed" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>ReplaceBranch</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1a00f20f2142866450cc6e0acd51ac096a" prot="private" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>ReplaceBranchInternal</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1adc9d7f88938a20e1f113464dfc00fcf9" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>ReplaceTag</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1a6106a27e7accb8b9019b2667c546db80" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>SetMaxRefAgeMs</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1a920b8e4e58e2e0766ddb0187170bf0b8" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>SetMaxSnapshotAgeMs</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1af17c0f80038ab35945d1f869656fe5ab" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>SetMinSnapshotsToKeep</name></member> |
| <member refid="classiceberg_1_1PendingUpdate_1ac57921ff326abc60b8d9558aa7046d10" prot="protected" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>transaction_</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1a58609d3844dcbe27cf2c4e3124d4f89b" prot="private" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>updated_refs_</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1a325cee99c4b3a7d0bffcb44320e29cd3" prot="private" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>UpdateSnapshotReference</name></member> |
| <member refid="classiceberg_1_1ErrorCollector_1ae84ca7242062cb3e3b86ce4cb81b368d" prot="public" virt="virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>~ErrorCollector</name></member> |
| <member refid="classiceberg_1_1PendingUpdate_1ace0dfef0058a64109f51e2638429a9f2" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>~PendingUpdate</name></member> |
| <member refid="classiceberg_1_1UpdateSnapshotReference_1a3ec7f822936304a17232e616fb4d41c4" prot="public" virt="non-virtual"><scope>iceberg::UpdateSnapshotReference</scope><name>~UpdateSnapshotReference</name></member> |
| </listofallmembers> |
| </compounddef> |
| </doxygen> |
