Struct iceberg_rust::spec::table_metadata::TableMetadata

pub struct TableMetadata {

    pub format_version: FormatVersion,
    pub table_uuid: Uuid,
    pub location: String,
    pub last_sequence_number: i64,
    pub last_updated_ms: i64,
    pub last_column_id: i32,
    pub schemas: HashMap<i32, Schema>,
    pub current_schema_id: i32,
    pub partition_specs: HashMap<i32, PartitionSpec>,
    pub default_spec_id: i32,
    pub last_partition_id: i32,
    pub properties: HashMap<String, String>,
    pub current_snapshot_id: Option<i64>,
    pub snapshots: HashMap<i64, Snapshot>,
    pub snapshot_log: Vec<SnapshotLog>,
    pub metadata_log: Vec<MetadataLog>,
    pub sort_orders: HashMap<i32, SortOrder>,
    pub default_sort_order_id: i32,
    pub refs: HashMap<String, SnapshotReference>,
}

Fields for the version 2 of the table metadata.

Fields

format_version: FormatVersion

Integer Version for the format.

table_uuid: Uuid

A UUID that identifies the table

location: String

Location tables base location

last_sequence_number: i64

The tables highest sequence number

last_updated_ms: i64

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

last_column_id: i32

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

schemas: HashMap<i32, Schema>

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

current_schema_id: i32

ID of the table’s current schema.

partition_specs: HashMap<i32, PartitionSpec>

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

default_spec_id: i32

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

last_partition_id: i32

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

properties: HashMap<String, String>

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.

current_snapshot_id: Option<i64>

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

snapshots: HashMap<i64, Snapshot>

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.

snapshot_log: Vec<SnapshotLog>

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.

metadata_log: Vec<MetadataLog>

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.

sort_orders: HashMap<i32, SortOrder>

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

default_sort_order_id: i32

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.

refs: HashMap<String, SnapshotReference>

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.

Implementations

impl TableMetadata

pub fn current_schema(&self, branch: Option<&str>) -> Result<&Schema, Error>

Get current schema

pub fn schema(&self, snapshot_id: i64) -> Result<&Schema, Error>

Get schema for snapshot

pub fn default_partition_spec(&self) -> Result<&PartitionSpec, Error>

Get default partition spec

pub fn current_snapshot( &self, snapshot_ref: Option<&str> ) -> Result<Option<&Snapshot>, Error>

Get current snapshot

pub fn current_snapshot_mut( &mut self, snapshot_ref: Option<String> ) -> Result<Option<&mut Snapshot>, Error>

Get current snapshot

Trait Implementations

impl Clone for TableMetadata

fn clone(&self) -> TableMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TableMetadata

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

Formats the value using the given formatter.

impl Default for TableMetadata

fn default() -> TableMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TableMetadata

fn deserialize<__D>( __deserializer: __D ) -> Result<TableMetadata, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a TableMetadata> for TabularMetadataRef<'a>

fn from(value: &'a TableMetadata) -> TabularMetadataRef<'a>

Converts to this type from the input type.

impl From<TableMetadata> for TabularMetadata

fn from(value: TableMetadata) -> TabularMetadata

Converts to this type from the input type.

impl PartialEq for TableMetadata

fn eq(&self, other: &TableMetadata) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TableMetadata

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<TableMetadataEnum> for TableMetadata

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: TableMetadataEnum) -> Result<TableMetadata, Error>

Performs the conversion.

impl TryFrom<TableMetadataV1> for TableMetadata

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: TableMetadataV1) -> Result<TableMetadata, Error>

Performs the conversion.

impl TryFrom<TableMetadataV2> for TableMetadata

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: TableMetadataV2) -> Result<TableMetadata, Error>

Performs the conversion.

impl Eq for TableMetadata

impl StructuralPartialEq for TableMetadata