nidus 0.3.1

A small, pure-Rust embeddable vector store: brute-force cosine search over a single append-only file. No FFI, no C, no SQL; anyhow its only dependency.
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
106
107
108
109
110
111
112
113

//! End-to-end smoke test of the public API — the quickest way to see nidus work.
//!
//! Run it:
//!     cargo run --example demo        (or: just demo)
//!
//! It opens a file-backed store in a temp dir, indexes a handful of toy 4-dim
//! vectors across two collections, then demonstrates: single-collection search,
//! whole-store (`Scope::All`) search, a metadata filter + `min_score`, and
//! durability by reopening the store from disk.

use std::collections::BTreeMap;

use nidus::{Config, Nidus, Predicate, Record, Scope, SearchOpts, Value};

/// Tiny helper to build a record with a couple of string attrs.
fn rec(id: &str, vector: Vec<f32>, path: &str, kind: &str) -> Record {
    let mut attrs = BTreeMap::new();
    attrs.insert("path".to_string(), Value::Str(path.to_string()));
    attrs.insert("kind".to_string(), Value::Str(kind.to_string()));
    Record {
        id: id.to_string(),
        vector,
        attrs,
    }
}

fn print_hits(label: &str, hits: &[nidus::Hit]) {
    println!("\n{label}");
    for h in hits {
        let path = match h.attrs.get("path") {
            Some(Value::Str(s)) => s.as_str(),
            _ => "?",
        };
        println!(
            "  {:>6.3}  [{}] {}  ({})",
            h.score, h.collection, h.id, path
        );
    }
}

fn main() -> anyhow::Result<()> {
    let dir = std::env::temp_dir().join("nidus-demo");
    let _ = std::fs::remove_dir_all(&dir); // start clean

    // ── Open a file-backed store (dimension 4) ───────────────────────────
    let mut db = Nidus::open(Config::new(&dir, 4))?;
    println!("opened store at {} (dim {})", dir.display(), db.dimension());

    db.create_collection("code")?;
    db.create_collection("docs")?;

    // ── Index some toy vectors ───────────────────────────────────────────
    db.upsert(
        "code",
        &[
            rec("a", vec![1.0, 0.0, 0.0, 0.0], "src/auth/login.rs", "file"),
            rec("b", vec![0.9, 0.1, 0.0, 0.0], "src/auth/token.rs", "file"),
            rec("c", vec![0.0, 1.0, 0.0, 0.0], "src/render/mod.rs", "file"),
        ],
    )?;
    db.upsert(
        "docs",
        &[
            rec("d", vec![0.8, 0.2, 0.0, 0.0], "docs/auth.md", "section"),
            rec("e", vec![0.0, 0.0, 1.0, 0.0], "docs/render.md", "section"),
        ],
    )?;
    println!(
        "indexed {} code + {} docs records",
        db.get_all("code").len(),
        db.get_all("docs").len()
    );

    let query = [1.0, 0.0, 0.0, 0.0]; // "something about auth"
    let opts = SearchOpts {
        top_k: 5,
        ..Default::default()
    };

    // ── 1. Search one collection ─────────────────────────────────────────
    print_hits(
        "search(\"code\", auth-ish):",
        &db.search("code", &query, &opts)?,
    );

    // ── 2. Search the whole store (one merged ranking) ───────────────────
    print_hits(
        "search(Scope::All, auth-ish):",
        &db.search(Scope::All, &query, &opts)?,
    );

    // ── 3. Filter (path glob) + min_score ────────────────────────────────
    let filtered = SearchOpts {
        top_k: 5,
        filter: nidus::Filter(vec![Predicate::Glob("path".into(), "src/auth/*".into())]),
        min_score: Some(0.5),
    };
    print_hits(
        "search(Scope::All) WHERE path GLOB 'src/auth/*' AND score>=0.5:",
        &db.search(Scope::All, &query, &filtered)?,
    );

    // ── 4. Durability: drop, reopen from disk, search again ──────────────
    drop(db);
    let db2 = Nidus::open(Config::new(&dir, 4))?;
    let reopened = db2.search("code", &query, &opts)?;
    print_hits("after reopen — search(\"code\"):", &reopened);
    assert_eq!(reopened.first().map(|h| h.id.as_str()), Some("a"));

    println!("\nOK — durability + ranking verified. Cleaning up.");
    let _ = std::fs::remove_dir_all(&dir);
    Ok(())
}