Skip to main content

deltalake_core/logstore/storage/
utils.rs

1//! Utility functions for working across Delta tables
2
3use crate::kernel::Version;
4use chrono::DateTime;
5use object_store::ObjectMeta;
6use object_store::path::Path;
7
8use crate::errors::{DeltaResult, DeltaTableError};
9use crate::kernel::Add;
10
11/// Return the uri of commit version.
12///
13/// ```rust
14/// # use deltalake_core::logstore::*;
15/// use object_store::path::Path;
16/// let uri = commit_uri_from_version(Some(1));
17/// assert_eq!(uri, Path::from("_delta_log/00000000000000000001.json"));
18/// ```
19pub fn commit_uri_from_version(version: Option<Version>) -> Path {
20    if let Some(version) = version {
21        let version = format!("{version:020}.json");
22        super::DELTA_LOG_PATH.clone().join(version.as_str())
23    } else {
24        /*
25         * Currently there are some situations where we're relying on negative versions for silly
26         * reasons like in load_with_datetime(). Handling the `None` case preserves this behavior
27         */
28        let version = -1;
29        let version = format!("{version:020}.json");
30        super::DELTA_LOG_PATH.clone().join(version.as_str())
31    }
32}
33
34impl TryFrom<Add> for ObjectMeta {
35    type Error = DeltaTableError;
36
37    fn try_from(value: Add) -> DeltaResult<Self> {
38        (&value).try_into()
39    }
40}
41
42impl TryFrom<&Add> for ObjectMeta {
43    type Error = DeltaTableError;
44
45    fn try_from(value: &Add) -> DeltaResult<Self> {
46        let last_modified = DateTime::from_timestamp_millis(value.modification_time).ok_or(
47            DeltaTableError::MetadataError(format!(
48                "invalid modification_time: {:?}",
49                value.modification_time
50            )),
51        )?;
52
53        Ok(Self {
54            // TODO this won't work for absolute paths, since Paths are always relative to store.
55            location: Path::parse(value.path.as_str())?,
56            last_modified,
57            size: value.size as u64,
58            e_tag: None,
59            version: None,
60        })
61    }
62}
63
64#[cfg(test)]
65mod tests {
66    use super::*;
67
68    #[test]
69    fn test_commit_uri_from_version() {
70        let version = commit_uri_from_version(Some(0));
71        assert_eq!(version, Path::from("_delta_log/00000000000000000000.json"));
72        let version = commit_uri_from_version(Some(123));
73        assert_eq!(version, Path::from("_delta_log/00000000000000000123.json"));
74        let version = commit_uri_from_version(None);
75        assert_eq!(version, Path::from("_delta_log/-0000000000000000001.json"));
76    }
77
78    #[test]
79    fn test_object_meta_from_add_action() {
80        let add = Add {
81            path: "x=A%252FA/part-00007-b350e235-2832-45df-9918-6cab4f7578f7.c000.snappy.parquet"
82                .to_string(),
83            size: 123,
84            modification_time: 123456789,
85            data_change: true,
86            stats: None,
87            partition_values: Default::default(),
88            tags: Default::default(),
89            base_row_id: None,
90            default_row_commit_version: None,
91            deletion_vector: None,
92            clustering_provider: None,
93        };
94
95        let meta: ObjectMeta = (&add).try_into().unwrap();
96        assert_eq!(
97            meta.location,
98            Path::parse(
99                "x=A%252FA/part-00007-b350e235-2832-45df-9918-6cab4f7578f7.c000.snappy.parquet"
100            )
101            .unwrap()
102        );
103        assert_eq!(meta.size, 123);
104        assert_eq!(meta.last_modified.timestamp_millis(), 123456789);
105    }
106}