1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
/*!
* Snapshots
*/
use std::{collections::HashMap, io::Cursor, sync::Arc};
use object_store::ObjectStore;
use serde::{Deserialize, Serialize};
use crate::{error::Error, util};
use super::{
manifest_list::{ManifestListEntry, ManifestListReader},
table_metadata::TableMetadata,
};
#[derive(Debug, PartialEq, Eq, Clone)]
/// 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.
pub struct Snapshot {
/// A unique long ID
pub snapshot_id: i64,
/// The snapshot ID of the snapshot’s parent.
/// Omitted for any snapshot with no parent
pub parent_snapshot_id: Option<i64>,
/// A monotonically increasing long that tracks the order of
/// changes to a table.
pub sequence_number: i64,
/// A timestamp when the snapshot was created, used for garbage
/// collection and table inspection
pub timestamp_ms: i64,
/// The location of a manifest list for this snapshot that
/// tracks manifest files with additional metadata.
pub manifest_list: String,
/// A string map that summarizes the snapshot changes, including operation.
pub summary: Summary,
/// ID of the table’s current schema when the snapshot was created.
pub schema_id: Option<i32>,
}
impl Snapshot {
// Return all manifest files associated to the latest table snapshot. Reads the related manifest_list file and returns its entries.
// If the manifest list file is empty returns an empty vector.
pub async fn manifests<'metadata>(
&self,
table_metadata: &'metadata TableMetadata,
object_store: Arc<dyn ObjectStore>,
) -> Result<impl Iterator<Item = Result<ManifestListEntry, Error>> + 'metadata, Error> {
let bytes: Cursor<Vec<u8>> = Cursor::new(
object_store
.get(&util::strip_prefix(&self.manifest_list).into())
.await?
.bytes()
.await?
.into(),
);
ManifestListReader::new(bytes, table_metadata).map_err(Into::into)
}
}
pub(crate) mod _serde {
use std::collections::HashMap;
use serde::{Deserialize, Serialize};
use super::{Operation, Snapshot, Summary};
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
#[serde(rename_all = "kebab-case")]
/// 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.
pub(crate) struct SnapshotV2 {
/// A unique long ID
pub snapshot_id: i64,
/// The snapshot ID of the snapshot’s parent.
/// Omitted for any snapshot with no parent
#[serde(skip_serializing_if = "Option::is_none")]
pub parent_snapshot_id: Option<i64>,
/// A monotonically increasing long that tracks the order of
/// changes to a table.
pub sequence_number: i64,
/// A timestamp when the snapshot was created, used for garbage
/// collection and table inspection
pub timestamp_ms: i64,
/// The location of a manifest list for this snapshot that
/// tracks manifest files with additional metadata.
pub manifest_list: String,
/// A string map that summarizes the snapshot changes, including operation.
pub summary: Summary,
/// ID of the table’s current schema when the snapshot was created.
#[serde(skip_serializing_if = "Option::is_none")]
pub schema_id: Option<i32>,
}
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
#[serde(rename_all = "kebab-case")]
/// 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.
pub(crate) struct SnapshotV1 {
/// A unique long ID
pub snapshot_id: i64,
/// The snapshot ID of the snapshot’s parent.
/// Omitted for any snapshot with no parent
#[serde(skip_serializing_if = "Option::is_none")]
pub parent_snapshot_id: Option<i64>,
/// A timestamp when the snapshot was created, used for garbage
/// collection and table inspection
pub timestamp_ms: i64,
/// The location of a manifest list for this snapshot that
/// tracks manifest files with additional metadata.
#[serde(skip_serializing_if = "Option::is_none")]
pub manifest_list: Option<String>,
/// A list of manifest file locations. Must be omitted if manifest-list is present
#[serde(skip_serializing_if = "Option::is_none")]
pub manifests: Option<Vec<String>>,
/// A string map that summarizes the snapshot changes, including operation.
#[serde(skip_serializing_if = "Option::is_none")]
pub summary: Option<Summary>,
/// ID of the table’s current schema when the snapshot was created.
#[serde(skip_serializing_if = "Option::is_none")]
pub schema_id: Option<i32>,
}
impl From<SnapshotV1> for Snapshot {
fn from(v1: SnapshotV1) -> Self {
Snapshot {
snapshot_id: v1.snapshot_id,
parent_snapshot_id: v1.parent_snapshot_id,
sequence_number: 0,
timestamp_ms: v1.timestamp_ms,
manifest_list: v1.manifest_list.unwrap_or_default(),
summary: v1.summary.unwrap_or(Summary {
operation: Operation::default(),
other: HashMap::new(),
}),
schema_id: v1.schema_id,
}
}
}
impl From<Snapshot> for SnapshotV1 {
fn from(v1: Snapshot) -> Self {
SnapshotV1 {
snapshot_id: v1.snapshot_id,
parent_snapshot_id: v1.parent_snapshot_id,
timestamp_ms: v1.timestamp_ms,
manifest_list: Some(v1.manifest_list),
summary: Some(v1.summary),
schema_id: v1.schema_id,
manifests: None,
}
}
}
impl From<SnapshotV2> for Snapshot {
fn from(value: SnapshotV2) -> Self {
Snapshot {
snapshot_id: value.snapshot_id,
parent_snapshot_id: value.parent_snapshot_id,
sequence_number: 0,
timestamp_ms: value.timestamp_ms,
manifest_list: value.manifest_list,
summary: value.summary,
schema_id: value.schema_id,
}
}
}
impl From<Snapshot> for SnapshotV2 {
fn from(value: Snapshot) -> Self {
SnapshotV2 {
snapshot_id: value.snapshot_id,
parent_snapshot_id: value.parent_snapshot_id,
sequence_number: 0,
timestamp_ms: value.timestamp_ms,
manifest_list: value.manifest_list,
summary: value.summary,
schema_id: value.schema_id,
}
}
}
}
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
#[serde(rename_all = "lowercase")]
/// The operation field is used by some operations, like snapshot expiration, to skip processing certain snapshots.
pub enum Operation {
/// Only data files were added and no files were removed.
Append,
/// Data and delete files were added and removed without changing table data;
/// i.e., compaction, changing the data file format, or relocating data files.
Replace,
/// Data and delete files were added and removed in a logical overwrite operation.
Overwrite,
/// Data files were removed and their contents logically deleted and/or delete files were added to delete rows.
Delete,
}
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
/// Summarises the changes in the snapshot.
pub struct Summary {
/// The type of operation in the snapshot
pub operation: Operation,
/// Other summary data.
#[serde(flatten)]
pub other: HashMap<String, String>,
}
impl Default for Operation {
fn default() -> Operation {
Self::Append
}
}
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
#[serde(rename_all = "kebab-case")]
/// Iceberg tables keep track of branches and tags using snapshot references.
pub struct Reference {
/// A reference’s snapshot ID. The tagged snapshot or latest snapshot of a branch.
pub snapshot_id: i64,
#[serde(flatten)]
/// Snapshot retention policy
pub retention: Retention,
}
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
#[serde(rename_all = "lowercase", tag = "type")]
/// The snapshot expiration procedure removes snapshots from table metadata and applies the table’s retention policy.
pub enum Retention {
#[serde(rename_all = "kebab-case")]
/// 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.
Branch {
/// 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.
#[serde(skip_serializing_if = "Option::is_none")]
min_snapshots_to_keep: Option<i32>,
/// 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.
#[serde(skip_serializing_if = "Option::is_none")]
max_snapshot_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.
#[serde(skip_serializing_if = "Option::is_none")]
max_ref_age_ms: Option<i64>,
},
#[serde(rename_all = "kebab-case")]
/// Tags are labels for individual snapshots.
Tag {
/// 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.
max_ref_age_ms: i64,
},
}
impl Default for Retention {
fn default() -> Self {
Retention::Branch {
max_ref_age_ms: None,
max_snapshot_age_ms: None,
min_snapshots_to_keep: None,
}
}
}