linkrs-storage 0.1.0

Storage engine with CSR and memory-mapped containers
Documentation 
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

use std::path::{Path, PathBuf};

#[cfg(test)]
use linkrs_core::types::LabelId;

/// Standard storage layout rooted at a database work directory.
#[derive(Debug, Clone)]
pub struct StoragePaths {
    root: PathBuf,
}

impl StoragePaths {
    pub fn new(root: impl Into<PathBuf>) -> Self {
        Self { root: root.into() }
    }

    pub fn root(&self) -> &Path {
        &self.root
    }

    pub fn data_dir(&self) -> PathBuf {
        self.root.join("data")
    }

    pub fn wal_dir(&self) -> PathBuf {
        self.root.join("wal")
    }

    pub fn schema_dir(&self) -> PathBuf {
        self.root.join("schema")
    }

    pub fn schema_file(&self) -> PathBuf {
        self.schema_dir().join("schema.json")
    }

    pub fn index_meta_dir(&self) -> PathBuf {
        self.root.join("index_meta")
    }

    pub fn index_meta_file(&self) -> PathBuf {
        self.index_meta_dir().join("index_meta.json")
    }

    pub fn indexes_dir(&self) -> PathBuf {
        self.root.join("indexes")
    }

    pub fn migration_history_file(&self) -> PathBuf {
        self.root.join("migration_history.json")
    }

    pub fn vertices_dir(&self) -> PathBuf {
        self.data_dir().join("vertices")
    }

    #[cfg(test)]
    pub fn vertex_dir(&self, label_id: LabelId) -> PathBuf {
        self.vertices_dir().join(format!("label_{}", label_id))
    }

    pub fn edges_dir(&self) -> PathBuf {
        self.data_dir().join("edges")
    }

    #[cfg(test)]
    pub fn edge_dir(&self, src_label: LabelId, dst_label: LabelId, edge_label: LabelId) -> PathBuf {
        self.edges_dir()
            .join(format!("{}_{}_{}", src_label, dst_label, edge_label))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_storage_paths_layout() {
        let paths = StoragePaths::new("/tmp/linkrs");

        assert_eq!(paths.root(), Path::new("/tmp/linkrs"));
        assert_eq!(paths.data_dir(), PathBuf::from("/tmp/linkrs/data"));
        assert_eq!(paths.wal_dir(), PathBuf::from("/tmp/linkrs/wal"));
        assert_eq!(
            paths.schema_file(),
            PathBuf::from("/tmp/linkrs/schema/schema.json")
        );
        assert_eq!(
            paths.index_meta_file(),
            PathBuf::from("/tmp/linkrs/index_meta/index_meta.json")
        );
        assert_eq!(paths.indexes_dir(), PathBuf::from("/tmp/linkrs/indexes"));
        assert_eq!(
            paths.vertex_dir(7),
            PathBuf::from("/tmp/linkrs/data/vertices/label_7")
        );
        assert_eq!(
            paths.edge_dir(1, 2, 3),
            PathBuf::from("/tmp/linkrs/data/edges/1_2_3")
        );
    }
}