Struct Snapshot

pub struct Snapshot { /* private fields */ }

A snapshot represents the state of a table at some time and is used to access the complete set of data files in the table.

Implementations

impl Snapshot

pub fn builder() -> SnapshotBuilder<((), (), (), (), (), (), (), (), ())>

Create a builder for building Snapshot. On the builder, call .snapshot_id(...), .parent_snapshot_id(...)(optional), .sequence_number(...), .timestamp_ms(...), .manifest_list(...), .summary(...), .schema_id(...)(optional), .encryption_key_id(...)(optional), .row_range(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Snapshot.

impl Snapshot

pub fn snapshot_id(&self) -> i64

Get the id of the snapshot

pub fn parent_snapshot_id(&self) -> Option<i64>

Get parent snapshot id.

pub fn sequence_number(&self) -> i64

Get sequence_number of the snapshot. Is 0 for Iceberg V1 tables.

pub fn manifest_list(&self) -> &str

Get location of manifest_list file

pub fn summary(&self) -> &Summary

Get summary of the snapshot

pub fn timestamp(&self) -> Result<DateTime<Utc>>

Get the timestamp of when the snapshot was created

pub fn timestamp_ms(&self) -> i64

Get the timestamp of when the snapshot was created in milliseconds

pub fn schema_id(&self) -> Option<SchemaId>

Get the schema id of this snapshot.

pub fn schema(&self, table_metadata: &TableMetadata) -> Result<SchemaRef>

Get the schema of this snapshot.

pub async fn load_manifest_list( &self, file_io: &FileIO, table_metadata: &TableMetadata, ) -> Result<ManifestList>

Load manifest list.

pub fn first_row_id(&self) -> Option<u64>

The row-id of the first newly added row in this snapshot. All rows added in this snapshot will have a row-id assigned to them greater than this value. All rows with a row-id less than this value were created in a snapshot that was added to the table (but not necessarily committed to this branch) in the past.

This field is optional but is required when the table version supports row lineage.

pub fn added_rows_count(&self) -> Option<u64>

The total number of newly added rows in this snapshot. It should be the summation of {@link ManifestFile#ADDED_ROWS_COUNT} for every manifest added in this snapshot.

This field is optional but is required when the table version supports row lineage.

pub fn row_range(&self) -> Option<(u64, u64)>

Returns the row range of this snapshot, if available. This is a tuple containing (first_row_id, added_rows_count).

pub fn encryption_key_id(&self) -> Option<&str>

Get encryption key id, if available.

Trait Implementations

impl Clone for Snapshot

fn clone(&self) -> Snapshot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Snapshot

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

Formats the value using the given formatter.

impl PartialEq for Snapshot

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Snapshot

impl StructuralPartialEq for Snapshot