iceberg-cpp
Loading...
Searching...
No Matches
Public Member Functions | List of all members
iceberg::table::AddSortOrder Class Reference

Represents adding a new sort order to the table. More...

#include <table_update.h>

Inheritance diagram for iceberg::table::AddSortOrder:
iceberg::TableUpdate

Public Member Functions

 AddSortOrder (std::shared_ptr< SortOrder > sort_order)
 
const std::shared_ptr< SortOrder > & sort_order () const
 
void ApplyTo (TableMetadataBuilder &builder) const override
 Apply this update to a TableMetadataBuilder.
 
void GenerateRequirements (TableUpdateContext &context) const override
 Generate update requirements for this metadata update.
 
Kind kind () const override
 Return the kind of this update.
 
bool Equals (const TableUpdate &other) const override
 Check equality with another TableUpdate.
 
std::unique_ptr< TableUpdateClone () const override
 Create a deep copy of this update.
 

Additional Inherited Members

- Public Types inherited from iceberg::TableUpdate
enum class  Kind : uint8_t {
  kAssignUUID , kUpgradeFormatVersion , kAddSchema , kSetCurrentSchema ,
  kAddPartitionSpec , kSetDefaultPartitionSpec , kRemovePartitionSpecs , kRemoveSchemas ,
  kAddSortOrder , kSetDefaultSortOrder , kAddSnapshot , kRemoveSnapshots ,
  kRemoveSnapshotRef , kSetSnapshotRef , kSetProperties , kRemoveProperties ,
  kSetLocation , kSetStatistics , kRemoveStatistics , kSetPartitionStatistics ,
  kRemovePartitionStatistics
}
 

Detailed Description

Represents adding a new sort order to the table.

Member Function Documentation

◆ ApplyTo()

void iceberg::table::AddSortOrder::ApplyTo ( TableMetadataBuilder builder) const
overridevirtual

Apply this update to a TableMetadataBuilder.

This method modifies the builder by applying the update operation it represents. Each subclass implements this to apply its specific type of update.

Parameters
builderThe builder to apply this update to

Implements iceberg::TableUpdate.

◆ Clone()

std::unique_ptr< TableUpdate > iceberg::table::AddSortOrder::Clone ( ) const
overridevirtual

Create a deep copy of this update.

Returns
A unique_ptr to a new TableUpdate that is a copy of this one

Implements iceberg::TableUpdate.

◆ Equals()

bool iceberg::table::AddSortOrder::Equals ( const TableUpdate other) const
overridevirtual

Check equality with another TableUpdate.

Parameters
otherThe update to compare with
Returns
true if the updates are equal, false otherwise

Implements iceberg::TableUpdate.

◆ GenerateRequirements()

void iceberg::table::AddSortOrder::GenerateRequirements ( TableUpdateContext context) const
overridevirtual

Generate update requirements for this metadata update.

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.

Parameters
contextThe context containing base metadata and operation state

Implements iceberg::TableUpdate.

◆ kind()

Kind iceberg::table::AddSortOrder::kind ( ) const
inlineoverridevirtual

Return the kind of this update.

Implements iceberg::TableUpdate.


The documentation for this class was generated from the following files: