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

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

use linkrs_transaction::wal::SyncPolicy;

use crate::engine::config::PropertyGraphConfig;

#[derive(Debug, Clone)]
pub struct PersistenceConfig {
    pub data_dir: PathBuf,
    pub wal_dir: PathBuf,
    pub checkpoint_dir: PathBuf,
    pub snapshot_dir: PathBuf,
    pub auto_flush_interval: Duration,
    pub auto_checkpoint_interval: Duration,
    pub checkpoint_threshold: u64,
    pub max_wal_size: u64,
    pub enable_snapshots: bool,
    pub snapshot_interval: Duration,
    /// Should WAL be enabled
    pub enable_wal: bool,
    /// Synchronization policy for WAL write-ahead logging
    pub sync_policy: Option<SyncPolicy>,
    /// Property graph resource and maintenance configuration.
    pub property_graph_config: PropertyGraphConfig,
    /// Whether async background checkpoint scheduling is enabled.
    pub async_checkpoint_enabled: bool,
    /// Interval for background checkpoint polling.
    pub async_checkpoint_poll_interval: Duration,
    /// Per-thread WAL buffer size for async flush (default 256KB).
    pub wal_buffer_size: usize,
    /// Background WAL flush interval in milliseconds (default 10ms).
    pub wal_flush_interval_ms: u64,
    /// Enable background async WAL flush; false preserves sync behavior.
    pub wal_enable_async_flush: bool,
}

impl Default for PersistenceConfig {
    fn default() -> Self {
        Self {
            data_dir: PathBuf::from("data"),
            wal_dir: PathBuf::from("wal"),
            checkpoint_dir: PathBuf::from("checkpoint"),
            snapshot_dir: PathBuf::from("snapshots"),
            auto_flush_interval: Duration::from_secs(60),
            auto_checkpoint_interval: Duration::from_secs(300),
            checkpoint_threshold: 10000,
            max_wal_size: 100 * 1024 * 1024,
            enable_snapshots: true,
            snapshot_interval: Duration::from_secs(3600),
            enable_wal: true,
            sync_policy: Some(SyncPolicy::EveryWrite),
            property_graph_config: PropertyGraphConfig::default(),
            async_checkpoint_enabled: true,
            async_checkpoint_poll_interval: Duration::from_secs(1),
            wal_buffer_size: 256 * 1024,
            wal_flush_interval_ms: 10,
            wal_enable_async_flush: true,
        }
    }
}

impl PersistenceConfig {
    pub fn for_work_dir(path: impl AsRef<Path>) -> Self {
        let path = path.as_ref();
        Self {
            data_dir: path.join("data"),
            wal_dir: path.join("wal"),
            checkpoint_dir: path.join("checkpoint"),
            snapshot_dir: path.join("snapshots"),
            enable_wal: true,
            sync_policy: Some(SyncPolicy::EveryWrite),
            property_graph_config: PropertyGraphConfig::default(),
            ..Default::default()
        }
    }

    pub fn with_property_graph_config(mut self, config: PropertyGraphConfig) -> Self {
        self.property_graph_config = config;
        self
    }
}