sqlitegraph-cli 3.0.2

Command-line interface for SQLiteGraph — embedded graph and vector runtime with Cypher-inspired queries
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

use sqlitegraph::backend::GraphBackend;
use sqlitegraph::backend::SqliteGraphBackend;

/// CLI backend client supporting SQLite and V3 backends
///
/// Both variants box their payload so the enum stays pointer-sized
/// (8 bytes) instead of being bloated to ~1.2 KB by the V3 variant,
/// avoiding `clippy::large_enum_variant`. The CLI only ever holds
/// one `CliClient` at a time, so the extra heap indirection has no
/// measurable cost vs. paying for the largest variant on every value.
pub enum CliClient {
    Sqlite(Box<SqliteGraphBackend>),
    #[cfg(feature = "native-v3")]
    V3(Box<sqlitegraph::backend::native::v3::V3Backend>),
}

impl CliClient {
    /// Open database with specified backend
    pub fn open(backend: super::cli::BackendType, path: &std::path::Path) -> anyhow::Result<Self> {
        match backend {
            super::cli::BackendType::Sqlite => {
                let graph = sqlitegraph::SqliteGraph::open(path)?;
                Ok(Self::Sqlite(Box::new(SqliteGraphBackend::from_graph(
                    graph,
                ))))
            }
            #[cfg(feature = "native-v3")]
            super::cli::BackendType::V3 => {
                use sqlitegraph::backend::native::v3::V3Backend;
                let backend = if path.exists() {
                    V3Backend::open(path)?
                } else {
                    V3Backend::create(path)?
                };
                Ok(Self::V3(Box::new(backend)))
            }
        }
    }

    /// Open in-memory database
    pub fn open_in_memory(backend: super::cli::BackendType) -> anyhow::Result<Self> {
        match backend {
            super::cli::BackendType::Sqlite => {
                let graph = sqlitegraph::SqliteGraph::open_in_memory()?;
                Ok(Self::Sqlite(Box::new(SqliteGraphBackend::from_graph(
                    graph,
                ))))
            }
            #[cfg(feature = "native-v3")]
            super::cli::BackendType::V3 => {
                anyhow::bail!("V3 backend does not support in-memory mode")
            }
        }
    }

    /// Get backend trait object
    pub fn backend(&self) -> &dyn GraphBackend {
        match self {
            Self::Sqlite(b) => b.as_ref(),
            #[cfg(feature = "native-v3")]
            Self::V3(b) => b.as_ref(),
        }
    }

    /// Get SQLite graph reference (if SQLite backend)
    pub fn sqlite_graph(&self) -> Option<&sqlitegraph::SqliteGraph> {
        match self {
            Self::Sqlite(b) => Some(b.graph()),
            #[cfg(feature = "native-v3")]
            Self::V3(_) => None,
        }
    }

    /// Get SQLite backend reference (for Cypher queries)
    pub fn sqlite_backend(&self) -> Option<&SqliteGraphBackend> {
        match self {
            Self::Sqlite(b) => Some(b.as_ref()),
            #[cfg(feature = "native-v3")]
            Self::V3(_) => None,
        }
    }

    /// Get backend name
    pub fn backend_name(&self) -> &'static str {
        match self {
            Self::Sqlite(_) => "sqlite",
            #[cfg(feature = "native-v3")]
            Self::V3(_) => "v3",
        }
    }

    /// Get node count
    pub fn node_count(&self) -> anyhow::Result<usize> {
        let ids = self.backend().entity_ids()?;
        Ok(ids.len())
    }
}