iceberg::spec

Struct TableMetadataBuilder

Source
pub struct TableMetadataBuilder { /* private fields */ }
Expand description

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§

Source§

impl TableMetadataBuilder

Source

pub const LAST_ADDED: i32 = -1i32

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

Source

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.

Source

pub fn new_from_metadata( previous: TableMetadata, current_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.

Source

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

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

Source

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

Changes uuid of table metadata.

Source

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

Upgrade FormatVersion. Downgrades are not allowed.

§Errors
  • Cannot downgrade to older format versions.
Source

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
Source

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
Source

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

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

Source

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.
Source

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.
Source

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.

Source

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

Set a reference to a snapshot.

§Errors
  • The snapshot id is unknown.
Source

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

Remove a reference

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

Source

pub fn set_statistics(self, statistics: StatisticsFile) -> Self

Set statistics for a snapshot

Source

pub fn remove_statistics(self, snapshot_id: i64) -> Self

Remove statistics for a snapshot

Source

pub fn set_partition_statistics( self, partition_statistics_file: PartitionStatisticsFile, ) -> Self

Set partition statistics

Source

pub fn remove_partition_statistics(self, snapshot_id: i64) -> Self

Remove partition statistics

Source

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.

Source

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.
Source

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

Add a schema and set it as the current schema.

Source

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.
Source

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.
Source

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

Add a partition spec and set it as the default

Source

pub fn remove_partition_specs(self, spec_ids: &[i32]) -> Result<Self>

Remove partition specs by their ids from the table metadata. Does nothing if a spec id is not present. Active partition specs should not be removed.

§Errors
  • Cannot remove the default partition spec.
Source

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.
Source

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.
Source

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

Build the table metadata.

Source

pub fn remove_schemas(self, schema_id_to_remove: &[i32]) -> Result<Self>

Remove schemas by their ids from the table metadata. Does nothing if a schema id is not present. Active schemas should not be removed.

Trait Implementations§

Source§

impl Clone for TableMetadataBuilder

Source§

fn clone(&self) -> TableMetadataBuilder

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TableMetadataBuilder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSendSync for T