armour 0.30.27

DDL and serialization for key-value storage
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

use std::{collections::BTreeMap, path::Path};

use derive_more::{Debug, Deref};
use fjall::{Database, DatabaseBuilder, Keyspace, KeyspaceCreateOptions, PersistMode};

use crate::{
    migration,
    snapshot::Snapshot,
    utils::{DbInfo, Persist},
};

#[derive(Debug, Clone, Deref)]
pub struct Db {
    #[debug(skip)]
    #[deref]
    pub db: Database,
    pub db_info: Persist<DbInfo>,
    pub path: String,
    #[debug(skip)]
    pub(crate) seq_tree: Keyspace,
}

impl Db {
    pub fn new<P>(path: P) -> Self
    where
        P: AsRef<Path>,
    {
        let builder = Self::builder(path.as_ref());
        Self::with_builder(path, builder)
    }

    pub fn builder<P: AsRef<Path>>(path: P) -> DatabaseBuilder<Database> {
        let db_path = path.as_ref().join("db");
        Database::builder(&db_path)
    }

    pub fn with_builder<P: AsRef<Path>>(path: P, config: DatabaseBuilder<Database>) -> Self {
        let db = config.open().expect("Failed to open keyspace");
        let meta_path = path.as_ref().join("db.info");
        let db_info = Persist::<DbInfo>::open(meta_path);

        let seq_tree = db
            .keyspace("__seq_tree", KeyspaceCreateOptions::default)
            .expect("Failed to open __seq_tree tree");

        Self {
            db,
            db_info,
            path: path.as_ref().to_string_lossy().into_owned(),
            seq_tree,
        }
    }

    pub fn open_tree(&self, name: &str, options: Option<KeyspaceCreateOptions>) -> Keyspace {
        self.db
            .keyspace(name, || options.unwrap_or_default())
            .expect("Failed to open tree")
    }

    pub fn get_keyspace(&self, name: &str) -> Option<Keyspace> {
        if !self.db.keyspace_exists(name) {
            return None;
        }
        self.db
            .keyspace(name, KeyspaceCreateOptions::default)
            .inspect_err(|err| {
                error!("{err}");
            })
            .ok()
    }

    pub fn get_all_keyspaces(&self) -> BTreeMap<String, Keyspace> {
        self.db_info
            .cloned()
            .collections
            .into_iter()
            .filter_map(|(name, info)| {
                let versioned = migration::collection_name(&name, info.version);
                self.get_keyspace(&versioned).map(|ks| (name, ks))
            })
            .collect()
    }

    pub fn snapshot(&self) -> Snapshot {
        let inner = self.db.snapshot();
        Snapshot { inner }
    }

    #[instrument(skip(self), name = "Database::close", fields(path = self.path))]
    pub fn close(&self) {
        self.db_info.save();
        self.db
            .persist(PersistMode::SyncAll)
            .expect("Failed to persist");
    }
}