iqdb 0.3.0

Embedded vector database for Rust. Lock-free, allocation-free hot path; cross-platform similarity search.
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236

//! Integration tests for the v0.3.0 search surface.
//!
//! Exercises the four public entry points — `Iqdb::search`,
//! `search_with`, `search_batch`, `search_batch_with` — through the
//! public re-exports. Living outside the unit tests guarantees the
//! external API actually compiles and behaves as documented.

use iqdb::{DistanceMetric, Error, Iqdb, Payload, PayloadValue, Record, RecordId, Vector};

fn record(id: u64, components: Vec<f32>, topic: Option<&str>) -> Record {
    let v = Vector::new(components).expect("finite components");
    match topic {
        None => Record::new(RecordId::new(id), v),
        Some(label) => {
            let mut payload = Payload::new();
            let _ = payload.insert("topic", label);
            Record::with_payload(RecordId::new(id), v, payload)
        }
    }
}

fn seed(db: &Iqdb) {
    db.upsert(record(1, vec![1.0, 0.0, 0.0], Some("rust")))
        .unwrap();
    db.upsert(record(2, vec![0.99, 0.10, 0.0], Some("rust")))
        .unwrap();
    db.upsert(record(3, vec![0.0, 1.0, 0.0], Some("python")))
        .unwrap();
    db.upsert(record(4, vec![0.71, 0.71, 0.0], Some("go")))
        .unwrap();
    db.upsert(record(5, vec![-1.0, 0.0, 0.0], Some("rust")))
        .unwrap();
}

#[test]
fn search_returns_top_k_sorted_ascending() {
    let db = Iqdb::open_in_memory();
    seed(&db);
    let probe = Vector::new(vec![1.0, 0.0, 0.0]).unwrap();
    let hits = db.search(&probe, 3, DistanceMetric::Cosine).unwrap();
    assert_eq!(hits.len(), 3);
    for pair in hits.windows(2) {
        assert!(pair[0].score <= pair[1].score, "results must be ascending");
    }
}

#[test]
fn search_caps_at_k_when_store_exceeds_k() {
    let db = Iqdb::open_in_memory();
    seed(&db);
    let probe = Vector::new(vec![1.0, 0.0, 0.0]).unwrap();
    let hits = db.search(&probe, 2, DistanceMetric::L2).unwrap();
    assert_eq!(hits.len(), 2);
}

#[test]
fn search_returns_all_when_k_exceeds_store() {
    let db = Iqdb::open_in_memory();
    seed(&db);
    let probe = Vector::new(vec![1.0, 0.0, 0.0]).unwrap();
    let hits = db.search(&probe, 100, DistanceMetric::L2).unwrap();
    assert_eq!(hits.len(), 5);
}

#[test]
fn search_returns_empty_when_k_is_zero() {
    let db = Iqdb::open_in_memory();
    seed(&db);
    let probe = Vector::new(vec![1.0, 0.0, 0.0]).unwrap();
    let hits = db.search(&probe, 0, DistanceMetric::Cosine).unwrap();
    assert!(hits.is_empty());
}

#[test]
fn search_returns_empty_on_empty_store() {
    let db = Iqdb::open_in_memory();
    let probe = Vector::new(vec![1.0, 0.0, 0.0]).unwrap();
    let hits = db.search(&probe, 5, DistanceMetric::Cosine).unwrap();
    assert!(hits.is_empty());
}

#[test]
fn search_with_filter_excludes_records_before_admission() {
    let db = Iqdb::open_in_memory();
    seed(&db);
    let probe = Vector::new(vec![1.0, 0.0, 0.0]).unwrap();
    let only_rust = db
        .search_with(&probe, 5, DistanceMetric::Cosine, |rec| {
            rec.payload()
                .and_then(|p| p.get("topic"))
                .and_then(PayloadValue::as_text)
                == Some("rust")
        })
        .unwrap();
    // Three rust records exist; all should make it through.
    assert_eq!(only_rust.len(), 3);
    for hit in &only_rust {
        let topic = hit
            .payload
            .as_ref()
            .and_then(|p| p.get("topic"))
            .and_then(PayloadValue::as_text);
        assert_eq!(topic, Some("rust"));
    }
}

#[test]
fn search_with_filter_returning_false_yields_empty() {
    let db = Iqdb::open_in_memory();
    seed(&db);
    let probe = Vector::new(vec![1.0, 0.0, 0.0]).unwrap();
    let none = db
        .search_with(&probe, 5, DistanceMetric::Cosine, |_| false)
        .unwrap();
    assert!(none.is_empty());
}

#[test]
fn search_propagates_dimension_mismatch() {
    let db = Iqdb::open_in_memory();
    seed(&db); // stored vectors are dim 3
    let probe = Vector::new(vec![1.0, 0.0]).unwrap(); // dim 2
    let err = db.search(&probe, 5, DistanceMetric::L2).unwrap_err();
    assert!(matches!(err, Error::DimensionMismatch { .. }));
}

#[test]
fn search_attaches_payload_when_present() {
    let db = Iqdb::open_in_memory();
    seed(&db);
    let probe = Vector::new(vec![1.0, 0.0, 0.0]).unwrap();
    let hits = db.search(&probe, 1, DistanceMetric::Cosine).unwrap();
    assert_eq!(hits.len(), 1);
    let payload = hits[0].payload.as_ref().expect("payload preserved");
    assert!(payload.contains_key("topic"));
}

#[test]
fn search_omits_payload_for_records_without_one() {
    let db = Iqdb::open_in_memory();
    db.upsert(record(99, vec![1.0, 0.0, 0.0], None)).unwrap();
    let probe = Vector::new(vec![1.0, 0.0, 0.0]).unwrap();
    let hits = db.search(&probe, 1, DistanceMetric::L2).unwrap();
    assert_eq!(hits.len(), 1);
    assert!(hits[0].payload.is_none());
}

#[test]
fn search_batch_preserves_input_order() {
    let db = Iqdb::open_in_memory();
    seed(&db);
    let probes = vec![
        Vector::new(vec![1.0, 0.0, 0.0]).unwrap(),
        Vector::new(vec![0.0, 1.0, 0.0]).unwrap(),
        Vector::new(vec![-1.0, 0.0, 0.0]).unwrap(),
    ];
    let batches = db.search_batch(&probes, 1, DistanceMetric::Cosine).unwrap();
    assert_eq!(batches.len(), 3);
    // Nearest to (1,0,0) is id 1 ("rust" perfect match).
    assert_eq!(batches[0][0].id, RecordId::new(1));
    // Nearest to (0,1,0) is id 3 ("python").
    assert_eq!(batches[1][0].id, RecordId::new(3));
    // Nearest to (-1,0,0) is id 5 ("rust" opposite direction).
    assert_eq!(batches[2][0].id, RecordId::new(5));
}

#[test]
fn search_batch_returns_empty_per_query_on_empty_store() {
    let db = Iqdb::open_in_memory();
    let probes = vec![
        Vector::new(vec![1.0, 0.0]).unwrap(),
        Vector::new(vec![0.0, 1.0]).unwrap(),
    ];
    let batches = db.search_batch(&probes, 3, DistanceMetric::L2).unwrap();
    assert_eq!(batches.len(), 2);
    assert!(batches.iter().all(Vec::is_empty));
}

#[test]
fn search_batch_with_shared_filter_applies_to_every_query() {
    let db = Iqdb::open_in_memory();
    seed(&db);
    let probes = vec![
        Vector::new(vec![1.0, 0.0, 0.0]).unwrap(),
        Vector::new(vec![0.0, 1.0, 0.0]).unwrap(),
    ];
    let batches = db
        .search_batch_with(&probes, 5, DistanceMetric::Cosine, |rec| {
            rec.payload()
                .and_then(|p| p.get("topic"))
                .and_then(PayloadValue::as_text)
                == Some("rust")
        })
        .unwrap();
    // Even the python-favouring probe is filtered down to rust records.
    for batch in &batches {
        for hit in batch {
            let topic = hit
                .payload
                .as_ref()
                .and_then(|p| p.get("topic"))
                .and_then(PayloadValue::as_text);
            assert_eq!(topic, Some("rust"));
        }
    }
}

#[test]
fn search_supports_concurrent_readers_through_arc() {
    use std::sync::Arc;
    use std::thread;

    let db = Arc::new(Iqdb::open_in_memory());
    for id in 0..16_u64 {
        db.upsert(Record::new(
            RecordId::new(id),
            Vector::new(vec![id as f32, 0.0]).unwrap(),
        ))
        .unwrap();
    }

    let mut handles = Vec::new();
    for _ in 0..8 {
        let db = Arc::clone(&db);
        handles.push(thread::spawn(move || {
            let probe = Vector::new(vec![5.0, 0.0]).unwrap();
            let hits = db.search(&probe, 3, DistanceMetric::L2).expect("ok");
            assert_eq!(hits.len(), 3);
            // id 5 is the perfect match; should always be first.
            assert_eq!(hits[0].id, RecordId::new(5));
        }));
    }
    for h in handles {
        h.join().expect("worker panicked");
    }
}