Struct iceberg::spec::TableMetadataBuilder

pub struct TableMetadataBuilder { /* private fields */ }

Manipulating table metadata.

For this builder the order of called functions matters. Functions are applied in-order. All operations applied to the TableMetadata are tracked in changes as a chronologically ordered vec of TableUpdate. If an operation does not lead to a change of the TableMetadata, the corresponding update is omitted from changes.

Unlike a typical builder pattern, the order of function calls matters. Some basic rules:

• add_schema must be called before set_current_schema.
• If a new partition spec and schema are added, the schema should be added first.

Implementations

impl TableMetadataBuilder

pub const LAST_ADDED: i32 = -1i32

Proxy id for “last added” items, including schema, partition spec, sort order.

pub fn new( schema: Schema, spec: impl Into<UnboundPartitionSpec>, sort_order: SortOrder, location: String, format_version: FormatVersion, properties: HashMap<String, String>, ) -> Result<Self>

Create a TableMetadata object from scratch.

This method re-assign ids of fields in the schema, schema.id, sort_order.id and spec.id. It should only be used to create new table metadata from scratch.

pub fn new_from_metadata( previous: TableMetadata, previous_file_location: Option<String>, ) -> Self

Creates a new table metadata builder from the given metadata to modify it. current_file_location is the location where the current version of the metadata file is stored. This is used to update the metadata log. If current_file_location is None, the metadata log will not be updated. This should only be used to stage-create tables.

pub fn from_table_creation(table_creation: TableCreation) -> Result<Self>

Creates a new table metadata builder from the given table creation.

pub fn assign_uuid(self, uuid: Uuid) -> Self

Changes uuid of table metadata.

pub fn upgrade_format_version( self, format_version: FormatVersion, ) -> Result<Self>

Upgrade FormatVersion. Downgrades are not allowed.

Errors

• Cannot downgrade to older format versions.

pub fn set_properties(self, properties: HashMap<String, String>) -> Result<Self>

Set properties. If a property already exists, it will be overwritten.

If a reserved property is set, the corresponding action is performed and the property is not persisted. Currently the following reserved properties are supported:

• format-version: Set the format version of the table.

Errors

• If properties contains a reserved property

pub fn remove_properties(self, properties: &[String]) -> Result<Self>

Remove properties from the table metadata. Does nothing if the key is not present.

Errors

• If properties to remove contains a reserved property

pub fn set_location(self, location: String) -> Self

Set the location of the table metadata, stripping any trailing slashes.

pub fn add_snapshot(self, snapshot: Snapshot) -> Result<Self>

Add a snapshot to the table metadata.

Errors

• Snapshot id already exists.
• For format version > 1: the sequence number of the snapshot is lower than the highest sequence number specified so far.

pub fn set_branch_snapshot( self, snapshot: Snapshot, branch: &str, ) -> Result<Self>

Append a snapshot to the specified branch. Retention settings from the branch are re-used.

Errors

• Any of the preconditions of self.add_snapshot are not met.

pub fn remove_snapshots(self, snapshot_ids: &[i64]) -> Self

Remove snapshots by its ids from the table metadata. Does nothing if a snapshot id is not present. Keeps as changes only the snapshots that were actually removed.

pub fn set_ref( self, ref_name: &str, reference: SnapshotReference, ) -> Result<Self>

Set a reference to a snapshot.

Errors

• The snapshot id is unknown.

pub fn remove_ref(self, ref_name: &str) -> Self

Remove a reference

If ref_name='main' the current snapshot id is set to -1.

pub fn add_schema(self, schema: Schema) -> Self

Add a schema to the table metadata.

The provided schema.schema_id may not be used.

Important: Use this method with caution. The builder does not check if the added schema is compatible with the current schema.

pub fn set_current_schema(self, schema_id: i32) -> Result<Self>

Set the current schema id.

If schema_id is -1, the last added schema is set as the current schema.

Errors:

• provided schema_id is -1 but no schema has been added via add_schema.
• No schema with the provided schema_id exists.

pub fn add_current_schema(self, schema: Schema) -> Result<Self>

Add a schema and set it as the current schema.

pub fn add_partition_spec( self, unbound_spec: UnboundPartitionSpec, ) -> Result<Self>

Add a partition spec to the table metadata.

The spec is bound eagerly to the current schema. If a schema is added in the same set of changes, the schema should be added first.

Even if unbound_spec.spec_id is provided as Some, it may not be used.

Errors

• The partition spec cannot be bound to the current schema.
• The partition spec has non-sequential field ids and the table format version is 1.

pub fn set_default_partition_spec(self, spec_id: i32) -> Result<Self>

Set the default partition spec.

Errors

• spec_id is -1 but no spec has been added via add_partition_spec.
• No partition spec with the provided spec_id exists.

pub fn add_default_partition_spec( self, unbound_spec: UnboundPartitionSpec, ) -> Result<Self>

Add a partition spec and set it as the default

pub fn add_sort_order(self, sort_order: SortOrder) -> Result<Self>

Add a sort order to the table metadata.

The spec is bound eagerly to the current schema and must be valid for it. If a schema is added in the same set of changes, the schema should be added first.

Even if sort_order.order_id is provided, it may not be used.

Errors

• Sort order id to add already exists.
• Sort order is incompatible with the current schema.

pub fn set_default_sort_order(self, sort_order_id: i64) -> Result<Self>

Set the default sort order. If sort_order_id is -1, the last added sort order is set as default.

Errors

• sort_order_id is -1 but no sort order has been added via add_sort_order.
• No sort order with the provided sort_order_id exists.

pub fn build(self) -> Result<TableMetadataBuildResult>

Build the table metadata.

Trait Implementations

impl Clone for TableMetadataBuilder

fn clone(&self) -> TableMetadataBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TableMetadataBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.