hudi-core 0.5.0

The native Rust implementation for Apache Hudi
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

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

use crate::Result;
use crate::config::table::HudiTableConfig::{TimelineHistoryPath, TimelinePath};
use crate::error::CoreError;
use crate::metadata::HUDI_METADATA_DIR;
use crate::storage::Storage;
use serde::{Deserialize, Serialize};
use std::sync::Arc;

#[cfg(not(tarpaulin_include))]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TimelineManifest {
    pub version: i64,
    pub entries: Vec<ManifestEntry>,
}

/// Entry in an LSM timeline manifest.
/// Each entry describes a compacted timeline file covering a time range
/// in the LSM history directory.
/// - `file_name`: relative path of the compacted timeline file under history
/// - `min_instant`/`max_instant`: smallest/largest instant timestamps covered
/// - `level`: LSM level where this file resides
/// - `file_size`: size in bytes of the file
#[cfg(not(tarpaulin_include))]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ManifestEntry {
    pub file_name: String,
    pub min_instant: String,
    pub max_instant: String,
    pub level: i32,
    pub file_size: i64,
}

/// LSM tree for v8+ timeline history management.
/// The paths are resolved from configs on-the-fly via `hoodie.timeline.path` and `hoodie.timeline.history.path`.
#[cfg(not(tarpaulin_include))]
pub struct LSMTree {
    storage: Arc<Storage>,
}

#[cfg(not(tarpaulin_include))]
impl LSMTree {
    pub fn new(storage: Arc<Storage>) -> Self {
        Self { storage }
    }

    /// Returns the timeline directory path, resolved from configs.
    pub fn timeline_dir(&self) -> String {
        let timeline_path: String = self
            .storage
            .hudi_configs
            .get_or_default(TimelinePath)
            .into();
        format!("{HUDI_METADATA_DIR}/{timeline_path}")
    }

    /// Returns the history directory path, resolved from configs.
    pub fn history_dir(&self) -> String {
        let timeline_path: String = self
            .storage
            .hudi_configs
            .get_or_default(TimelinePath)
            .into();
        let history_path: String = self
            .storage
            .hudi_configs
            .get_or_default(TimelineHistoryPath)
            .into();
        format!("{HUDI_METADATA_DIR}/{timeline_path}/{history_path}")
    }

    pub async fn read_manifest(&self) -> Result<Option<TimelineManifest>> {
        let history_dir = self.history_dir();
        let version_path = format!("{history_dir}/_version_");
        if let Ok(data) = self.storage.get_file_data(&version_path).await {
            let version_str =
                String::from_utf8(data.to_vec()).map_err(|e| CoreError::Timeline(e.to_string()))?;
            let version = version_str
                .trim()
                .parse::<i64>()
                .map_err(|e| CoreError::Timeline(e.to_string()))?;
            let manifest_path = format!("{history_dir}/manifest_{version}");
            let data = self.storage.get_file_data(&manifest_path).await?;
            let manifest: TimelineManifest =
                serde_json::from_slice(&data).map_err(|e| CoreError::Timeline(e.to_string()))?;
            Ok(Some(manifest))
        } else {
            Ok(None)
        }
    }
}