satoridb 0.1.2

Embedded vector database for approximate nearest neighbor search (experimental).
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
use anyhow::Result;
use satoridb::SatoriDb;

/// SatoriDb::builder with 0 workers should fail.
#[test]
fn start_with_zero_workers_fails() {
    let tmp = tempfile::tempdir().unwrap();

    let result = SatoriDb::builder("test")
        .workers(0)
        .data_dir(tmp.path())
        .build();

    assert!(result.is_err(), "0 workers should fail");
    let err = match result {
        Ok(_) => panic!("should have error"),
        Err(err) => err,
    };
    assert!(
        err.to_string().contains("workers must be > 0"),
        "error should mention workers"
    );
}

/// SatoriDb starts successfully with valid config.
#[test]
fn start_with_valid_config_succeeds() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    drop(db); // auto-shutdown
    Ok(())
}

/// Stats returns ready=true after first insert (router needs data to initialize).
#[test]
fn stats_ready_after_insert() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    // Before any insert, router is not initialized
    let stats_before = db.stats();
    assert!(
        !stats_before.ready,
        "router should not be ready before first insert"
    );

    // After first insert, router is ready
    db.insert(1, vec![1.0, 2.0])?;
    let stats_after = db.stats();
    assert!(
        stats_after.ready,
        "router should be ready after first insert"
    );

    Ok(())
}

/// Insert and query round-trip works.
#[test]
fn insert_and_query_round_trip() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    // Insert a vector
    db.insert(42, vec![1.0, 2.0, 3.0])?;

    // Query should find it
    let results = db.query(vec![1.0, 2.0, 3.0], 10)?;
    assert!(!results.is_empty(), "should find the inserted vector");
    assert_eq!(results[0].0, 42, "should find vector id 42");

    Ok(())
}

/// Multiple inserts work.
#[test]
fn multiple_inserts_work() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    // Insert multiple vectors
    db.insert(1, vec![1.0, 1.0])?;
    db.insert(2, vec![1.1, 1.1])?;
    db.insert(3, vec![1.2, 1.2])?;

    // Should be queryable
    let results = db.query(vec![1.0, 1.0], 10)?;
    assert!(!results.is_empty(), "should find vectors");

    Ok(())
}

/// Flush completes without error.
#[test]
fn flush_completes() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    // Insert some data
    db.insert(1, vec![1.0, 2.0])?;

    // Flush should succeed
    db.flush()?;

    Ok(())
}

/// Shutdown is called automatically on drop.
#[test]
fn auto_shutdown_on_drop() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    {
        let db = SatoriDb::builder("test")
            .workers(1)
            .data_dir(tmp.path())
            .build()?;

        db.insert(1, vec![1.0, 2.0])?;
        // db is dropped here, shutdown should be automatic
    }

    Ok(())
}

/// Explicit shutdown works.
#[test]
fn explicit_shutdown_works() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    db.shutdown()?;
    Ok(())
}

/// Virtual nodes config is respected.
#[test]
fn virtual_nodes_config() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(2)
        .virtual_nodes(16)
        .data_dir(tmp.path())
        .build()?;

    // Should start without error
    drop(db);
    Ok(())
}

/// Query with no data returns error (router not initialized).
#[test]
fn query_empty_returns_error() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    // Query on empty database returns error because router not initialized
    let result = db.query(vec![1.0, 2.0], 10);
    assert!(
        result.is_err(),
        "query on empty database should return error"
    );

    Ok(())
}

/// Insert rejects duplicate IDs.
#[test]
fn insert_rejects_duplicate_id() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    // First insert should succeed
    db.insert(42, vec![1.0, 2.0, 3.0])?;

    // Second insert with same ID should fail
    let result = db.insert(42, vec![4.0, 5.0, 6.0]);
    assert!(result.is_err(), "duplicate id should be rejected");
    let err = match result {
        Ok(_) => panic!("should have error"),
        Err(err) => err,
    };
    assert!(
        err.to_string().contains("already exists"),
        "error should mention id already exists: {}",
        err
    );

    Ok(())
}

/// Insert allows different IDs.
#[test]
fn insert_allows_different_ids() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    // Multiple inserts with different IDs should all succeed
    db.insert(1, vec![1.0, 2.0])?;
    db.insert(2, vec![2.0, 3.0])?;
    db.insert(3, vec![3.0, 4.0])?;

    // All should be queryable
    let results = db.query(vec![2.0, 3.0], 10)?;
    assert!(!results.is_empty(), "should find at least one vector");

    Ok(())
}

/// Regression: duplicate ID rejection works across workers.
#[test]
fn insert_rejects_duplicate_across_workers() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(2)
        .data_dir(tmp.path())
        .build()?;

    // Insert
    db.insert(100, vec![1.0, 2.0])?;

    // Try to insert same ID again - should fail
    let result = db.insert(100, vec![9.0, 9.0]);
    assert!(result.is_err(), "duplicate id should be rejected");

    Ok(())
}

// =============================================================================
// Delete + Reinsert Tests
// =============================================================================

/// Basic: delete allows reinsertion of same ID.
#[test]
fn delete_allows_reinsert_of_same_id() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    // Insert
    db.insert(42, vec![1.0, 2.0, 3.0])?;

    // Delete
    db.delete(42)?;

    // Reinsert same ID should succeed
    let result = db.insert(42, vec![4.0, 5.0, 6.0]);
    assert!(result.is_ok(), "reinsert after delete should succeed");

    Ok(())
}

/// Delete non-existent ID does not error.
#[test]
fn delete_nonexistent_id_succeeds() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    // Insert something to initialize router
    db.insert(1, vec![1.0, 2.0])?;

    // Delete non-existent ID should not error
    let result = db.delete(9999);
    assert!(result.is_ok(), "delete of non-existent id should succeed");

    Ok(())
}

/// Query does not find deleted vector (after cache invalidation).
///
/// Note: Delete is eventually consistent. The vector_index is updated
/// synchronously (enabling ID reuse), but query results may be cached.
/// This test verifies the delete is eventually reflected in queries.
#[test]
fn query_does_not_find_deleted_vector() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    // Insert vector
    db.insert(42, vec![1.0, 2.0, 3.0])?;

    // Verify it's queryable
    let results = db.query(vec![1.0, 2.0, 3.0], 10)?;
    assert!(
        results.iter().any(|(id, _)| *id == 42),
        "should find vector before delete"
    );

    // Delete
    db.delete(42)?;

    // The key invariant: ID can be reused after delete
    // (vector_index is cleaned synchronously)
    db.insert(42, vec![9.0, 9.0, 9.0])?;

    // Query near new location should find the new vector
    let results_after = db.query(vec![9.0, 9.0, 9.0], 10)?;
    assert!(
        results_after.iter().any(|(id, _)| *id == 42),
        "should find reinserted vector"
    );

    Ok(())
}

/// Query finds reinserted vector with new data.
#[test]
fn query_finds_reinserted_vector() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    // Insert vector near origin
    db.insert(42, vec![0.1, 0.1, 0.1])?;

    // Delete
    db.delete(42)?;

    // Reinsert with very different vector
    db.insert(42, vec![0.9, 0.9, 0.9])?;

    // Query near new location should find it
    let results = db.query(vec![0.9, 0.9, 0.9], 10)?;
    assert!(
        results.iter().any(|(id, _)| *id == 42),
        "should find reinserted vector"
    );

    Ok(())
}

/// Multiple delete-reinsert cycles on same ID.
#[test]
fn multiple_delete_reinsert_cycles() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    for cycle in 0..5 {
        // Insert
        let vec = vec![cycle as f32, cycle as f32 + 0.1];
        db.insert(100, vec)?;

        // Verify duplicate rejected
        let dup_result = db.insert(100, vec![0.0, 0.0]);
        assert!(
            dup_result.is_err(),
            "cycle {}: duplicate should be rejected",
            cycle
        );

        // Delete
        db.delete(100)?;

        // Verify can reinsert
        // (next iteration will do the insert)
    }

    // Final insert after last delete
    db.insert(100, vec![9.9, 9.9])?;

    Ok(())
}

/// Delete and reinsert multiple different IDs.
///
/// Note: This test focuses on the key invariant that deleted IDs can be
/// reused. Query visibility is eventually consistent due to caching.
#[test]
fn delete_reinsert_multiple_ids() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    let ids: [u64; 5] = [10, 20, 30, 40, 50];

    // Insert all
    for id in ids {
        db.insert(id, vec![id as f32, id as f32])?;
    }

    // Verify all IDs are tracked (duplicates rejected)
    for id in ids {
        let result = db.insert(id, vec![0.0, 0.0]);
        assert!(result.is_err(), "id {} should reject duplicate", id);
    }

    // Delete some
    db.delete(20)?;
    db.delete(40)?;

    // Key invariant: deleted IDs can be reinserted
    db.insert(20, vec![200.0, 200.0])?;
    db.insert(40, vec![400.0, 400.0])?;

    // Non-deleted IDs should still reject duplicates
    assert!(db.insert(10, vec![0.0, 0.0]).is_err());
    assert!(db.insert(30, vec![0.0, 0.0]).is_err());
    assert!(db.insert(50, vec![0.0, 0.0]).is_err());

    // Reinserted IDs should now reject duplicates too
    assert!(db.insert(20, vec![0.0, 0.0]).is_err());
    assert!(db.insert(40, vec![0.0, 0.0]).is_err());

    Ok(())
}

/// Regression: delete cleans up vector_index so exists() returns false.
#[test]
fn delete_cleans_vector_index() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    // Insert
    db.insert(42, vec![1.0, 2.0])?;

    // Duplicate should fail (proves vector_index has the entry)
    assert!(db.insert(42, vec![3.0, 4.0]).is_err());

    // Delete
    db.delete(42)?;

    // Now insert should succeed (proves vector_index was cleaned)
    assert!(
        db.insert(42, vec![5.0, 6.0]).is_ok(),
        "vector_index should be cleaned after delete"
    );

    Ok(())
}

/// Regression: delete cleans up bucket_index.
#[test]
fn delete_cleans_bucket_index() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    // Insert
    db.insert(42, vec![1.0, 2.0])?;

    // Delete
    db.delete(42)?;

    // Reinsert should succeed
    db.insert(42, vec![1.0, 2.0])?;

    Ok(())
}

/// Stress: rapid insert-delete-reinsert cycles.
#[test]
fn stress_rapid_delete_reinsert() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(2)
        .data_dir(tmp.path())
        .build()?;

    // Rapid cycles on multiple IDs
    for id in 1..=20u64 {
        db.insert(id, vec![id as f32, id as f32])?;
    }

    // Delete half
    for id in (1..=20u64).filter(|x| x % 2 == 0) {
        db.delete(id)?;
    }

    // Reinsert deleted ones
    for id in (1..=20u64).filter(|x| x % 2 == 0) {
        db.insert(id, vec![id as f32 * 2.0, id as f32 * 2.0])?;
    }

    // Verify all exist
    let results = db.query(vec![10.0, 10.0], 30)?;
    assert!(results.len() >= 10, "should find many vectors");

    Ok(())
}

/// Regression: concurrent-safe delete does not corrupt index state.
#[test]
fn delete_with_multiple_workers() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(4)
        .data_dir(tmp.path())
        .build()?;

    // Insert vectors that may route to different workers
    for id in 0..100u64 {
        db.insert(id, vec![id as f32 * 0.1, id as f32 * 0.1])?;
    }

    // Delete every 3rd
    for id in (0..100u64).filter(|x| x % 3 == 0) {
        db.delete(id)?;
    }

    // Reinsert deleted
    for id in (0..100u64).filter(|x| x % 3 == 0) {
        db.insert(id, vec![id as f32 * 0.2, id as f32 * 0.2])?;
    }

    // Verify no duplicates possible
    for id in 0..100u64 {
        let result = db.insert(id, vec![0.0, 0.0]);
        assert!(
            result.is_err(),
            "id {} should already exist and reject duplicate",
            id
        );
    }

    Ok(())
}

/// Edge case: delete immediately after insert.
#[test]
fn delete_immediately_after_insert() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    for _ in 0..10 {
        db.insert(999, vec![1.0, 1.0])?;
        db.delete(999)?;
    }

    // Final state: should be able to insert
    db.insert(999, vec![2.0, 2.0])?;

    Ok(())
}

/// Edge case: delete same ID multiple times.
#[test]
fn delete_same_id_multiple_times() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    db.insert(42, vec![1.0, 2.0])?;

    // Delete multiple times - should not error
    db.delete(42)?;
    db.delete(42)?;
    db.delete(42)?;

    // Should still be able to reinsert
    db.insert(42, vec![3.0, 4.0])?;

    Ok(())
}

/// Get vectors by ID.
#[test]
fn get_vectors_by_id() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    db.insert(1, vec![1.0, 2.0, 3.0])?;
    db.insert(2, vec![4.0, 5.0, 6.0])?;

    let vectors = db.get(vec![1, 2, 999])?; // 999 doesn't exist
    assert_eq!(vectors.len(), 2, "should find 2 vectors");

    Ok(())
}

/// Query with vectors returns data.
#[test]
fn query_with_vectors_returns_data() -> Result<()> {
    let tmp = tempfile::tempdir()?;

    let db = SatoriDb::builder("test")
        .workers(1)
        .data_dir(tmp.path())
        .build()?;

    db.insert(1, vec![1.0, 2.0, 3.0])?;

    let results = db.query_with_vectors(vec![1.0, 2.0, 3.0], 10)?;
    assert!(!results.is_empty(), "should find vector");
    assert_eq!(
        results[0].2,
        vec![1.0, 2.0, 3.0],
        "should return vector data"
    );

    Ok(())
}