Struct TableMetadataBuilder

pub struct TableMetadataBuilder { /* private fields */ }

Builder for TableMetadata.

Implementations

impl TableMetadataBuilder

pub fn format_version(&mut self, value: FormatVersion) -> &mut Self

Integer Version for the format.

pub fn table_uuid(&mut self, value: Uuid) -> &mut Self

A UUID that identifies the table

pub fn location<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Location tables base location

pub fn last_sequence_number(&mut self, value: i64) -> &mut Self

The tables highest sequence number

pub fn last_updated_ms(&mut self, value: i64) -> &mut Self

Timestamp in milliseconds from the unix epoch when the table was last updated.

pub fn last_column_id(&mut self, value: i32) -> &mut Self

An integer; the highest assigned column ID for the table.

pub fn schemas(&mut self, value: HashMap<i32, Schema>) -> &mut Self

A list of schemas, stored as objects with schema-id.

pub fn with_schema<VALUE>(&mut self, item: VALUE) -> &mut Self

where HashMap<i32, Schema>: Default + Extend<VALUE>,

A list of schemas, stored as objects with schema-id.

pub fn current_schema_id(&mut self, value: i32) -> &mut Self

ID of the table’s current schema.

pub fn partition_specs( &mut self, value: HashMap<i32, PartitionSpec>, ) -> &mut Self

A list of partition specs, stored as full partition spec objects.

pub fn with_partition_spec<VALUE>(&mut self, item: VALUE) -> &mut Self

where HashMap<i32, PartitionSpec>: Default + Extend<VALUE>,

A list of partition specs, stored as full partition spec objects.

pub fn default_spec_id(&mut self, value: i32) -> &mut Self

ID of the “current” spec that writers should use by default.

pub fn last_partition_id(&mut self, value: i32) -> &mut Self

An integer; the highest assigned partition field ID across all partition specs for the table.

pub fn properties(&mut self, value: HashMap<String, String>) -> &mut Self

A string to string map of table properties. This is used to control settings that affect reading and writing and is not intended to be used for arbitrary metadata. For example, commit.retry.num-retries is used to control the number of commit retries.

pub fn current_snapshot_id(&mut self, value: Option<i64>) -> &mut Self

long ID of the current table snapshot; must be the same as the current ID of the main branch in refs.

pub fn snapshots(&mut self, value: HashMap<i64, Snapshot>) -> &mut Self

A list of valid snapshots. Valid snapshots are snapshots for which all data files exist in the file system. A data file must not be deleted from the file system until the last snapshot in which it was listed is garbage collected.

pub fn snapshot_log(&mut self, value: Vec<SnapshotLog>) -> &mut Self

A list (optional) of timestamp and snapshot ID pairs that encodes changes to the current snapshot for the table. Each time the current-snapshot-id is changed, a new entry should be added with the last-updated-ms and the new current-snapshot-id. When snapshots are expired from the list of valid snapshots, all entries before a snapshot that has expired should be removed.

pub fn metadata_log(&mut self, value: Vec<MetadataLog>) -> &mut Self

A list (optional) of timestamp and metadata file location pairs that encodes changes to the previous metadata files for the table. Each time a new metadata file is created, a new entry of the previous metadata file location should be added to the list. Tables can be configured to remove oldest metadata log entries and keep a fixed-size log of the most recent entries after a commit.

pub fn sort_orders(&mut self, value: HashMap<i32, SortOrder>) -> &mut Self

A list of sort orders, stored as full sort order objects.

pub fn with_sort_order<VALUE>(&mut self, item: VALUE) -> &mut Self

where HashMap<i32, SortOrder>: Default + Extend<VALUE>,

A list of sort orders, stored as full sort order objects.

pub fn default_sort_order_id(&mut self, value: i32) -> &mut Self

Default sort order id of the table. Note that this could be used by writers, but is not used when reading because reads use the specs stored in manifest files.

pub fn refs(&mut self, value: HashMap<String, SnapshotReference>) -> &mut Self

A map of snapshot references. The map keys are the unique snapshot reference names in the table, and the map values are snapshot reference objects. There is always a main branch reference pointing to the current-snapshot-id even if the refs map is null.

pub fn build(&self) -> Result<TableMetadata, TableMetadataBuilderError>

Builds a new TableMetadata.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for TableMetadataBuilder

fn clone(&self) -> TableMetadataBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for TableMetadataBuilder

fn default() -> Self

Returns the “default value” for a type.