iceberg::UpdateProperties Class Reference

Updates table properties. More...

#include <update_properties.h>

Inheritance diagram for iceberg::UpdateProperties:

Classes
struct	ApplyResult

Public Member Functions
UpdateProperties &	Set (const std::string &key, const std::string &value)
	Sets a property key to a specified value.
UpdateProperties &	Remove (const std::string &key)
	Marks a property for removal.
Kind	kind () const final
	Return the kind of this pending update.
bool	IsRetryable () const override
	Whether this update can be retried after a commit conflict.
Result< ApplyResult >	Apply ()
	Apply the pending changes and return the updates and removals.
Public Member Functions inherited from iceberg::PendingUpdate
virtual Status	Commit ()
	Apply the pending changes and commit.
virtual Status	Finalize (Result< const TableMetadata * > commit_result)
	Finalize the pending update.
	PendingUpdate (const PendingUpdate &)=delete
PendingUpdate &	operator= (const PendingUpdate &)=delete
	PendingUpdate (PendingUpdate &&) noexcept=default
PendingUpdate &	operator= (PendingUpdate &&) noexcept=default
Public Member Functions inherited from iceberg::ErrorCollector
	ErrorCollector (ErrorCollector &&)=default
ErrorCollector &	operator= (ErrorCollector &&)=default
	ErrorCollector (const ErrorCollector &)=default
ErrorCollector &	operator= (const ErrorCollector &)=default
template<typename... Args>
auto &	AddError (this auto &self, ErrorKind kind, const std::format_string< Args... > fmt, Args &&... args)
	Add a specific error and return reference to derived class.
auto &	AddError (this auto &self, Error err)
	Add an existing error object and return reference to derived class.
auto &	AddError (this auto &self, std::unexpected< Error > err)
	Add an unexpected result's error and return reference to derived class.
bool	has_errors () const
	Check if any errors have been collected.
size_t	error_count () const
	Get the number of errors collected.
Status	CheckErrors () const
	Check for accumulated errors and return them if any exist.
void	ClearErrors ()
	Clear all accumulated errors.
const std::vector< Error > &	errors () const
	Get read-only access to all collected errors.

Static Public Member Functions
static Result< std::shared_ptr< UpdateProperties > >	Make (std::shared_ptr< TransactionContext > ctx)

Additional Inherited Members
Public Types inherited from iceberg::PendingUpdate
enum class	Kind : uint8_t {   kExpireSnapshots , kSetSnapshot , kUpdateLocation , kUpdatePartitionSpec ,   kUpdatePartitionStatistics , kUpdateProperties , kUpdateSchema , kUpdateSnapshot ,   kUpdateSnapshotReference , kUpdateSortOrder , kUpdateStatistics }
Protected Member Functions inherited from iceberg::PendingUpdate
	PendingUpdate (std::shared_ptr< TransactionContext > ctx)
const TableMetadata &	base () const
Protected Attributes inherited from iceberg::PendingUpdate
std::shared_ptr< TransactionContext >	ctx_
Protected Attributes inherited from iceberg::ErrorCollector
std::vector< Error >	errors_

Detailed Description

Updates table properties.

Member Function Documentation

IsRetryable()

bool iceberg::UpdateProperties::IsRetryable ( ) const

inlineoverridevirtual

Whether this update can be retried after a commit conflict.

Implements iceberg::PendingUpdate.

kind()

Kind iceberg::UpdateProperties::kind ( ) const

inlinefinalvirtual

Return the kind of this pending update.

Implements iceberg::PendingUpdate.

Remove()

UpdateProperties & iceberg::UpdateProperties::Remove

(

const std::string &

key

)

Marks a property for removal.

Parameters

key	The property key to remove

Returns

Reference to this UpdateProperties for chaining

Set()

UpdateProperties & iceberg::UpdateProperties::Set	(	const std::string &	key,
		const std::string &	value
	)

Sets a property key to a specified value.

The key must not have been previously marked for removal and reserved property keys will be ignored.

Parameters

key	The property key to set
value	The property value to set

Returns

Reference to this UpdateProperties for chaining

---

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

• iceberg/update/update_properties.h
• iceberg/update/update_properties.cc