Enum iceberg_rust::spec::snapshot::SnapshotRetention

pub enum SnapshotRetention {
    Branch {
        min_snapshots_to_keep: Option<i32>,
        max_snapshot_age_ms: Option<i64>,
        max_ref_age_ms: Option<i64>,
    },
    Tag {
        max_ref_age_ms: i64,
    },
}

The snapshot expiration procedure removes snapshots from table metadata and applies the table’s retention policy.

Variants

Branch

Fields

min_snapshots_to_keep: Option<i32>

A positive number for the minimum number of snapshots to keep in a branch while expiring snapshots. Defaults to table property history.expire.min-snapshots-to-keep.

max_snapshot_age_ms: Option<i64>

A positive number for the max age of snapshots to keep when expiring, including the latest snapshot. Defaults to table property history.expire.max-snapshot-age-ms.

max_ref_age_ms: Option<i64>

For snapshot references except the main branch, a positive number for the max age of the snapshot reference to keep while expiring snapshots. Defaults to table property history.expire.max-ref-age-ms. The main branch never expires.

Branches are mutable named references that can be updated by committing a new snapshot as the branch’s referenced snapshot using the Commit Conflict Resolution and Retry procedures.

Tag

Fields

max_ref_age_ms: i64

For snapshot references except the main branch, a positive number for the max age of the snapshot reference to keep while expiring snapshots. Defaults to table property history.expire.max-ref-age-ms. The main branch never expires.

Tags are labels for individual snapshots.

Trait Implementations

impl Clone for SnapshotRetention

fn clone(&self) -> SnapshotRetention

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SnapshotRetention

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

Formats the value using the given formatter.

impl Default for SnapshotRetention

fn default() -> SnapshotRetention

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SnapshotRetention

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SnapshotRetention

fn eq(&self, other: &SnapshotRetention) -> 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 SnapshotRetention

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 Eq for SnapshotRetention

impl StructuralPartialEq for SnapshotRetention