sqlitegraph 3.9.0

Embedded graph database with explicit SQLite, native-v3, and combined backend modes; HNSW vector search; and graph algorithms
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
103
104
105

//! Main configuration for graph construction.

use super::{
    combined::CombinedConfig, kinds::BackendKind, native::NativeConfig, sqlite::SqliteConfig,
};

/// Complete configuration for graph construction.
///
/// This structure combines backend selection with backend-specific
/// configuration options.
#[derive(Clone, Debug)]
pub struct GraphConfig {
    /// Which backend to use for graph storage
    pub backend: BackendKind,
    /// SQLite-specific configuration options
    pub sqlite: SqliteConfig,
    /// Native-specific configuration options
    pub native: NativeConfig,
    /// Combined-mode configuration options
    pub combined: CombinedConfig,
}

impl GraphConfig {
    /// Create a new configuration with the specified backend.
    pub fn new(backend: BackendKind) -> Self {
        let sqlite_config = match backend {
            BackendKind::SQLite | BackendKind::Combined => SqliteConfig::default(),
            BackendKind::Native => SqliteConfig {
                without_migrations: true,
                ..Default::default()
            },
        };

        Self {
            backend,
            sqlite: sqlite_config,
            native: NativeConfig::default(),
            combined: CombinedConfig::default(),
        }
    }

    /// Create a configuration for SQLite backend.
    pub fn sqlite() -> Self {
        Self::new(BackendKind::SQLite)
    }

    /// Create a configuration for Native backend.
    pub fn native() -> Self {
        Self::new(BackendKind::Native)
    }

    /// Create a configuration for Combined backend mode.
    ///
    /// Combined mode is SQLite-authoritative. In the current Phase 1 contract,
    /// it opens through the SQLite path while reserving a distinct backend mode
    /// for future native graph materialization work.
    pub fn combined() -> Self {
        Self::new(BackendKind::Combined)
    }

    /// Set the CPU profile for the Native backend (builder pattern)
    pub fn with_cpu_profile(mut self, profile: crate::backend::native::CpuProfile) -> Self {
        self.native.cpu_profile = Some(profile);
        self
    }

    /// Set the maximum parallel WAL recovery transactions (builder pattern)
    pub fn with_parallel_recovery(mut self, degree: usize) -> Self {
        self.native.max_parallel_transactions = degree;
        self
    }

    /// Configure SQLite backend with custom settings (builder pattern)
    pub fn with_sqlite_config<F>(mut self, config_fn: F) -> Self
    where
        F: FnOnce(SqliteConfig) -> SqliteConfig,
    {
        self.sqlite = config_fn(self.sqlite);
        self
    }

    /// Configure Native backend with custom settings (builder pattern)
    pub fn with_native_config<F>(mut self, config_fn: F) -> Self
    where
        F: FnOnce(NativeConfig) -> NativeConfig,
    {
        self.native = config_fn(self.native);
        self
    }

    /// Configure Combined backend settings (builder pattern)
    pub fn with_combined_config<F>(mut self, config_fn: F) -> Self
    where
        F: FnOnce(CombinedConfig) -> CombinedConfig,
    {
        self.combined = config_fn(self.combined);
        self
    }
}

impl Default for GraphConfig {
    fn default() -> Self {
        Self::new(BackendKind::SQLite)
    }
}