-
Notifications
You must be signed in to change notification settings - Fork 12
Expand file tree
/
Copy pathvector_index_test.go
More file actions
774 lines (703 loc) · 25.1 KB
/
Copy pathvector_index_test.go
File metadata and controls
774 lines (703 loc) · 25.1 KB
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
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
package anystore
import (
"cmp"
"fmt"
"math"
"math/rand"
"path/filepath"
"slices"
"strings"
"testing"
"github.com/anyproto/any-store/v2/anyenc"
"github.com/anyproto/any-store/v2/internal/btree"
"github.com/anyproto/any-store/v2/query"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func vrand(n, dim int, seed int64) [][]float32 {
rng := rand.New(rand.NewSource(seed))
v := make([][]float32, n)
for i := range v {
x := make([]float32, dim)
for d := range x {
x[d] = rng.Float32()*2 - 1
}
v[i] = x
}
return v
}
func vecDocJSON(id int, vec []float32) string {
parts := make([]string, len(vec))
for i, f := range vec {
parts[i] = fmt.Sprintf("%g", f)
}
return fmt.Sprintf(`{"id":%d,"v":[%s]}`, id, strings.Join(parts, ","))
}
// idBytesOf returns the stored document-id bytes for an integer id.
func idBytesOf(id int) []byte {
idVal := anyenc.MustParseJson(fmt.Sprintf(`{"id":%d}`, id)).Get("id")
if idVal == nil {
panic("idBytesOf: document without id")
}
return idVal.MarshalTo(nil)
}
// vhit mirrors the old VectorHit result for tests.
type vhit struct {
DocId []byte
Distance float32
}
// vsearch runs a k-NN search through the public Find() pipeline via the $knn
// operator and returns docId+distance pairs, closest-first. ef<=0 uses the
// index default. k must be > 0: $k is mandatory in the clause.
func vsearch(coll Collection, field string, q []float32, k, ef int) ([]vhit, error) {
if k <= 0 {
panic("vsearch: $knn requires k > 0")
}
fq := coll.Find(fmt.Sprintf(`{%q:%s}`, field, vknnJSON(q, k, ef)))
iter, err := fq.Iter(ctx)
if err != nil {
return nil, err
}
defer iter.Close()
var out []vhit
for iter.Next() {
d, derr := iter.Doc()
if derr != nil {
return nil, derr
}
out = append(out, vhit{DocId: d.Value().Get("id").MarshalTo(nil), Distance: iter.Distance()})
}
return out, iter.Err()
}
func vl2(a, b []float32) float32 {
var s float32
for i := range a {
d := a[i] - b[i]
s += d * d
}
return float32(math.Sqrt(float64(s)))
}
func bruteIDs(vecs [][]float32, q []float32, k int) map[string]bool {
type p struct {
i int
d float32
}
all := make([]p, len(vecs))
for i := range vecs {
all[i] = p{i, vl2(q, vecs[i])}
}
slices.SortFunc(all, func(a, b p) int { return cmp.Compare(a.d, b.d) })
out := map[string]bool{}
for i := 0; i < k && i < len(all); i++ {
out[string(idBytesOf(all[i].i))] = true
}
return out
}
func TestVectorIndex_EndToEnd(t *testing.T) {
const (
n = 1000
dim = 16
k = 10
)
fx := newFixture(t)
coll, err := fx.CreateCollection(ctx, "docs")
require.NoError(t, err)
require.NoError(t, coll.CreateIndex(ctx, IndexInfo{
Name: "emb",
Kind: IndexKindVector,
Vector: &VectorParams{Field: "v", Dim: dim, Metric: VectorL2, EfSearch: 64},
}))
vecs := vrand(n, dim, 7)
for i, vc := range vecs {
require.NoError(t, coll.Insert(ctx, anyenc.MustParseJson(vecDocJSON(i, vc))))
}
// self-query returns the same doc
hits, err := vsearch(coll, "v", vecs[42], 1, 64)
require.NoError(t, err)
require.Len(t, hits, 1)
assert.Equal(t, idBytesOf(42), hits[0].DocId)
assert.InDelta(t, 0, hits[0].Distance, 1e-3)
// recall vs brute
queries := vrand(50, dim, 99)
var recall float64
for _, q := range queries {
truth := bruteIDs(vecs, q, k)
hh, err := vsearch(coll, "v", q, k, 64)
require.NoError(t, err)
hit := 0
for _, h := range hh {
if truth[string(h.DocId)] {
hit++
}
}
recall += float64(hit) / float64(k)
}
recall /= float64(len(queries))
t.Logf("integrated vector index recall@%d = %.3f", k, recall)
assert.Greater(t, recall, 0.85)
}
func TestVectorIndex_DeleteUpdate(t *testing.T) {
const dim = 16
fx := newFixture(t)
coll, err := fx.CreateCollection(ctx, "docs")
require.NoError(t, err)
require.NoError(t, coll.CreateIndex(ctx, IndexInfo{
Name: "emb", Kind: IndexKindVector,
Vector: &VectorParams{Field: "v", Dim: dim, Metric: VectorL2},
}))
vecs := vrand(500, dim, 3)
for i, vc := range vecs {
require.NoError(t, coll.Insert(ctx, anyenc.MustParseJson(vecDocJSON(i, vc))))
}
// delete doc 50 → must vanish from results
require.NoError(t, coll.DeleteId(ctx, 50))
hits, err := vsearch(coll, "v", vecs[50], 10, 64)
require.NoError(t, err)
for _, h := range hits {
assert.NotEqual(t, idBytesOf(50), h.DocId, "deleted doc leaked")
}
// update doc 10's vector onto doc 400's location → found near 400
require.NoError(t, coll.UpsertOne(ctx, anyenc.MustParseJson(vecDocJSON(10, vecs[400]))))
hits, err = vsearch(coll, "v", vecs[400], 5, 64)
require.NoError(t, err)
var found bool
for _, h := range hits {
if string(h.DocId) == string(idBytesOf(10)) {
found = true
}
}
assert.True(t, found, "updated doc not found at new location")
}
func TestVectorIndex_BuildOnExisting(t *testing.T) {
const (
n = 800
dim = 16
k = 10
)
fx := newFixture(t)
coll, err := fx.CreateCollection(ctx, "docs")
require.NoError(t, err)
vecs := vrand(n, dim, 5)
for i, vc := range vecs {
require.NoError(t, coll.Insert(ctx, anyenc.MustParseJson(vecDocJSON(i, vc))))
}
// create the index AFTER the docs exist → must build from them
require.NoError(t, coll.CreateIndex(ctx, IndexInfo{
Name: "emb", Kind: IndexKindVector,
Vector: &VectorParams{Field: "v", Dim: dim, Metric: VectorL2, EfSearch: 64},
}))
hits, err := vsearch(coll, "v", vecs[123], 1, 64)
require.NoError(t, err)
require.Len(t, hits, 1)
assert.Equal(t, idBytesOf(123), hits[0].DocId)
}
func TestVectorIndex_Stats(t *testing.T) {
const (
n = 500
dim = 32
)
fx := newFixture(t)
coll, err := fx.CreateCollection(ctx, "docs")
require.NoError(t, err)
require.NoError(t, coll.CreateIndex(ctx, IndexInfo{
Name: "emb", Kind: IndexKindVector,
Vector: &VectorParams{Field: "v", Dim: dim, Metric: VectorCosine, EfSearch: 64},
}))
vecs := vrand(n, dim, 9)
for i, vc := range vecs {
require.NoError(t, coll.Insert(ctx, anyenc.MustParseJson(vecDocJSON(i, vc))))
}
st, err := coll.Stats(ctx)
require.NoError(t, err)
require.Len(t, st.VectorIndexes, 1, "vector index must appear in stats")
vs := st.VectorIndexes[0]
assert.Equal(t, "emb", vs.Name)
assert.Equal(t, "v", vs.Field)
assert.Equal(t, dim, vs.Dim)
assert.Equal(t, "cosine", vs.Metric)
assert.Equal(t, n, vs.NodeCount)
assert.Equal(t, n, vs.LiveCount)
assert.Equal(t, 0, vs.DeletedCount)
assert.Greater(t, vs.VectorBytes, 0, "vec namespace should have size")
assert.Greater(t, vs.GraphBytes, 0, "adj namespace should have size")
assert.Greater(t, vs.SizeBytes, vs.VectorBytes, "total > just vectors")
assert.Greater(t, st.VectorIndexesSizeBytes, 0)
assert.GreaterOrEqual(t, st.TotalSizeBytes, st.VectorIndexesSizeBytes)
// delete some docs → DeletedCount/LiveCount reflect the tombstones
for i := 0; i < 100; i++ {
require.NoError(t, coll.DeleteId(ctx, i))
}
st2, err := coll.Stats(ctx)
require.NoError(t, err)
vs2 := st2.VectorIndexes[0]
assert.Equal(t, n, vs2.NodeCount, "physical node count unchanged by tombstones")
assert.Equal(t, n-100, vs2.LiveCount)
assert.Equal(t, 100, vs2.DeletedCount)
t.Logf("vector index stats: nodes=%d live=%d deleted=%d vec=%dB graph=%dB total=%dB",
vs2.NodeCount, vs2.LiveCount, vs2.DeletedCount, vs2.VectorBytes, vs2.GraphBytes, vs2.SizeBytes)
}
func TestVectorIndex_Int8Quantization(t *testing.T) {
const (
dim = 32
n = 800
)
fx := newFixture(t)
coll, err := fx.CreateCollection(ctx, "docs")
require.NoError(t, err)
require.NoError(t, coll.CreateIndex(ctx, IndexInfo{
Name: "emb", Kind: IndexKindVector,
Vector: &VectorParams{Field: "v", Dim: dim, Metric: VectorL2, EfSearch: 64, Quantization: VectorQuantInt8},
}))
vecs := vrand(n, dim, 4)
for i, vc := range vecs {
require.NoError(t, coll.Insert(ctx, anyenc.MustParseJson(vecDocJSON(i, vc))))
}
// self-query still returns the doc with int8 storage
hits, err := vsearch(coll, "v", vecs[42], 1, 128)
require.NoError(t, err)
require.Len(t, hits, 1)
assert.Equal(t, idBytesOf(42), hits[0].DocId)
st, err := coll.Stats(ctx)
require.NoError(t, err)
require.Len(t, st.VectorIndexes, 1)
assert.Equal(t, "int8", st.VectorIndexes[0].Quantization)
t.Logf("int8 vector index: nodes=%d vec=%dB graph=%dB", st.VectorIndexes[0].NodeCount,
st.VectorIndexes[0].VectorBytes, st.VectorIndexes[0].GraphBytes)
// reopen-from-disk preserves int8 + results (covered for in-memory here via a
// fresh Find through the pipeline)
iter, err := coll.Find(fmt.Sprintf(`{"v":{"$knn":{"$query":[%s],"$k":1}}}`, joinFloats(vecs[7]))).Iter(ctx)
require.NoError(t, err)
require.True(t, iter.Next())
d, _ := iter.Doc()
assert.Equal(t, idBytesOf(7), d.Value().Get("id").MarshalTo(nil))
require.NoError(t, iter.Close())
}
func joinFloats(vec []float32) string {
parts := make([]string, len(vec))
for i, f := range vec {
parts[i] = fmt.Sprintf("%g", f)
}
return strings.Join(parts, ",")
}
func TestVectorIndex_UpdateSkipsUnchangedVector(t *testing.T) {
const dim = 16
fx := newFixture(t)
coll, err := fx.CreateCollection(ctx, "docs")
require.NoError(t, err)
require.NoError(t, coll.CreateIndex(ctx, IndexInfo{
Name: "emb", Kind: IndexKindVector,
Vector: &VectorParams{Field: "v", Dim: dim, Metric: VectorL2},
}))
vecs := vrand(200, dim, 9)
for i, vc := range vecs {
require.NoError(t, coll.Insert(ctx, anyenc.MustParseJson(vecDocJSON(i, vc))))
}
vecJSON := func(vec []float32) string {
parts := make([]string, len(vec))
for i, f := range vec {
parts[i] = fmt.Sprintf("%g", f)
}
return "[" + strings.Join(parts, ",") + "]"
}
nodesAndTombs := func() (int, int) {
st, serr := coll.Stats(ctx)
require.NoError(t, serr)
require.Len(t, st.VectorIndexes, 1)
return st.VectorIndexes[0].NodeCount, st.VectorIndexes[0].DeletedCount
}
n0, d0 := nodesAndTombs()
// update a NON-vector field, keeping the same vector → index must NOT change
require.NoError(t, coll.UpsertOne(ctx, anyenc.MustParseJson(
fmt.Sprintf(`{"id":5,"v":%s,"label":"changed"}`, vecJSON(vecs[5])))))
n1, d1 := nodesAndTombs()
assert.Equal(t, n0, n1, "vector index reindexed despite unchanged vector")
assert.Equal(t, d0, d1, "vector index tombstoned despite unchanged vector")
// now change the vector → index MUST reindex (old tombstoned, new node added)
require.NoError(t, coll.UpsertOne(ctx, anyenc.MustParseJson(
fmt.Sprintf(`{"id":5,"v":%s}`, vecJSON(vecs[100])))))
n2, d2 := nodesAndTombs()
assert.Equal(t, n1+1, n2, "changed vector should add a node")
assert.Equal(t, d1+1, d2, "changed vector should tombstone the old node")
}
func TestVectorIndex_Drop(t *testing.T) {
const dim = 16
fx := newFixture(t)
coll, err := fx.CreateCollection(ctx, "docs")
require.NoError(t, err)
require.NoError(t, coll.CreateIndex(ctx, IndexInfo{
Name: "emb", Kind: IndexKindVector,
Vector: &VectorParams{Field: "v", Dim: dim, Metric: VectorL2},
}))
vecs := vrand(200, dim, 9)
for i, vc := range vecs {
require.NoError(t, coll.Insert(ctx, anyenc.MustParseJson(vecDocJSON(i, vc))))
}
// works before drop
hits, err := vsearch(coll, "v", vecs[0], 1, 64)
require.NoError(t, err)
require.Len(t, hits, 1)
require.NoError(t, coll.DropIndex(ctx, "emb"))
// the index is gone: dropping it again reports not-found
require.ErrorIs(t, coll.DropIndex(ctx, "emb"), ErrIndexNotFound)
// and "v" is now an ordinary field — a {"v":[..]} query is no longer an ANN
// search (no vector index), so it runs as a plain filter without error.
iter, ferr := coll.Find(fmt.Sprintf(`{"v":%s}`, vqJSON(vecs[0]))).Iter(ctx)
require.NoError(t, ferr)
require.NoError(t, iter.Close())
// inserts after drop must not fail (index gone)
require.NoError(t, coll.Insert(ctx, anyenc.MustParseJson(vecDocJSON(999, vecs[1]))))
}
func TestVectorIndex_Reopen(t *testing.T) {
const (
n = 600
dim = 16
)
dir := t.TempDir()
path := filepath.Join(dir, "v.db")
vecs := vrand(n, dim, 11)
queries := vrand(20, dim, 22)
db, err := Open(ctx, path, nil)
require.NoError(t, err)
coll, err := db.CreateCollection(ctx, "docs")
require.NoError(t, err)
require.NoError(t, coll.CreateIndex(ctx, IndexInfo{
Name: "emb", Kind: IndexKindVector,
Vector: &VectorParams{Field: "v", Dim: dim, Metric: VectorL2, EfSearch: 64},
}))
for i, vc := range vecs {
require.NoError(t, coll.Insert(ctx, anyenc.MustParseJson(vecDocJSON(i, vc))))
}
pre := make([][]vhit, len(queries))
for i, q := range queries {
pre[i], err = vsearch(coll, "v", q, 10, 64)
require.NoError(t, err)
}
require.NoError(t, db.Close())
// reopen — index loads from disk, no rebuild
db2, err := Open(ctx, path, nil)
require.NoError(t, err)
defer db2.Close()
coll2, err := db2.OpenCollection(ctx, "docs")
require.NoError(t, err)
for i, q := range queries {
post, err := vsearch(coll2, "v", q, 10, 64)
require.NoError(t, err)
require.Equal(t, len(pre[i]), len(post))
for j := range post {
assert.Equal(t, pre[i][j].DocId, post[j].DocId, "result drift after reopen q%d", i)
}
}
}
// ---- $knn driver/probe plan duality ---------------------------------------
// knnPlanHints force each $knn plan form: the vector index name forces the ANN
// driver, the pk field the pk probe, a secondary index name its probe.
var knnPlanHints = []struct {
name string
hint []IndexHint
}{
{"cbo", nil},
{"driver", []IndexHint{{IndexName: "emb", Boost: 1 << 30}}},
{"probe-ids", []IndexHint{{IndexName: "id", Boost: 1 << 30}}},
{"probe-a", []IndexHint{{IndexName: "a", Boost: 1 << 30}}},
}
// knnProbeColl builds a brute-or-ANN collection with a secondary index on "a".
func knnProbeColl(t *testing.T, mode VectorMode, n, dim int) (Collection, [][]float32) {
fx := newFixture(t)
t.Cleanup(fx.finish)
coll, err := fx.CreateCollection(ctx, "knnprobe")
require.NoError(t, err)
makeVectorIndex(t, coll, mode, dim)
require.NoError(t, coll.EnsureIndex(ctx, IndexInfo{Name: "a", Fields: []string{"a"}}))
vecs := vrand(n, dim, 7)
for i, vc := range vecs {
doc := anyenc.MustParseJson(vecDocJSON(i, vc))
doc.Set("a", anyenc.MustParseJson(fmt.Sprintf("%d", i%10)))
require.NoError(t, coll.Insert(ctx, doc))
}
return coll, vecs
}
func collectKnn(t *testing.T, q Query) (ids []int, dists []float32) {
t.Helper()
iter, err := q.Iter(ctx)
require.NoError(t, err)
defer iter.Close()
for iter.Next() {
doc, derr := iter.Doc()
require.NoError(t, derr)
ids = append(ids, doc.Value().GetInt("id"))
dists = append(dists, iter.Distance())
}
require.NoError(t, iter.Err())
return ids, dists
}
// knnCond builds $knn + restriction conditions programmatically (the
// production construction path).
func knnCond(qv []float32, k int, extra query.Filter) query.Filter {
knn := vectorKnnFilter(qv, k)
if extra == nil {
return knn
}
return query.And{knn, extra}
}
func idInFilter(ids ...int) query.Filter {
vals := make([]*anyenc.Value, len(ids))
for i, id := range ids {
vals[i] = anyenc.MustParseJson(fmt.Sprintf("%d", id))
}
return query.Key{Path: []string{"id"}, Filter: query.NewInValue(vals...)}
}
// On the brute-force backend the driver is exact too, so every plan must
// produce identical rows, order, and distances.
func TestKnnProbe_BruteDifferential(t *testing.T) {
const dim, n, k = 12, 300, 8
coll, vecs := knnProbeColl(t, VectorModeBruteForce, n, dim)
conds := []query.Filter{
knnCond(vecs[5], k, idInFilter(3, 15, 27, 42, 55, 63, 78, 81, 99, 120, 150, 999)),
knnCond(vecs[5], k, query.MustParseCondition(`{"a":3}`)),
knnCond(vecs[9], k, nil),
}
for ci, cond := range conds {
var baseIds []int
var baseDists []float32
for _, p := range knnPlanHints {
q := coll.Find(cond)
if len(p.hint) > 0 {
q = q.IndexHint(p.hint...)
}
ids, dists := collectKnn(t, q)
if p.name == "cbo" {
baseIds, baseDists = ids, dists
continue
}
require.Equal(t, baseIds, ids, "cond %d plan %s: rows diverged", ci, p.name)
require.Equal(t, baseDists, dists, "cond %d plan %s: distances diverged", ci, p.name)
}
}
}
// Under a selective filter the exact probe must return the TRUE k nearest
// filter survivors — computed here by a brute oracle — and the CBO must route
// the restricted shapes to it. The ANN driver (post-filter) has no such
// guarantee; this is the recall fix, not just the perf fix.
func TestKnnProbe_ExactUnderFilter(t *testing.T) {
const dim, n, k = 12, 400, 10
coll, vecs := knnProbeColl(t, VectorModeBTree, n, dim)
// Oracle: true k nearest among docs with a == 3 (L2).
q := vecs[123]
type oc struct {
id int
d float64
}
var all []oc
for i, vc := range vecs {
if i%10 != 3 {
continue
}
var sum float64
for d := 0; d < dim; d++ {
diff := float64(vc[d]) - float64(q[d])
sum += diff * diff
}
all = append(all, oc{i, sum})
}
slices.SortFunc(all, func(x, y oc) int {
if x.d != y.d {
return cmp.Compare(x.d, y.d)
}
return cmp.Compare(x.id, y.id)
})
want := make([]int, k)
for i := range want {
want[i] = all[i].id
}
cond := knnCond(q, k, query.MustParseCondition(`{"a":3}`))
ids, _ := collectKnn(t, coll.Find(cond).IndexHint(IndexHint{IndexName: "a", Boost: 1 << 30}))
assert.Equal(t, want, ids, "probe plan must return the exact filtered k-nearest")
assert.Len(t, ids, k, "probe plan must fill k when enough docs pass the filter")
ex, err := coll.Find(cond).Explain(ctx)
require.NoError(t, err)
assert.Contains(t, ex.Plan+ex.Sql, "KnnProbe", "selective filter must route to the probe plan")
broad, err := coll.Find(knnCond(q, k, nil)).Explain(ctx)
require.NoError(t, err)
assert.Contains(t, broad.Plan+broad.Sql, "KnnSearch", "unrestricted $knn must keep the ANN driver")
}
// A probe plan must honor _distance residual predicates and _distance sorts
// exactly like the driver (brute backend: bit-exact).
func TestKnnProbe_DistanceResidualAndSort(t *testing.T) {
const dim, n, k = 12, 200, 12
coll, vecs := knnProbeColl(t, VectorModeBruteForce, n, dim)
restriction := idInFilter(1, 5, 9, 13, 17, 21, 25, 29, 33, 37, 41, 45, 49, 53)
base := knnCond(vecs[13], k, restriction)
var driverIds, probeIds []int
for _, p := range []string{"emb", "id"} {
q := coll.Find(base).IndexHint(IndexHint{IndexName: p, Boost: 1 << 30}).Sort("-_distance")
ids, dists := collectKnn(t, q)
for i := 1; i < len(dists); i++ {
assert.GreaterOrEqual(t, dists[i-1], dists[i], "descending distance order")
}
if p == "emb" {
driverIds = ids
} else {
probeIds = ids
}
}
assert.Equal(t, driverIds, probeIds, "sorted-by-distance rows must match across plans")
}
// Bounded writes select the same rows under either plan form.
func TestKnnProbe_DeleteMatchesIterSelection(t *testing.T) {
const dim, n, k = 12, 200, 5
coll, vecs := knnProbeColl(t, VectorModeBruteForce, n, dim)
restriction := idInFilter(0, 10, 20, 30, 40, 50, 60, 70, 80, 90)
cond := knnCond(vecs[30], k, restriction)
expect, _ := collectKnn(t, coll.Find(cond))
require.Len(t, expect, k)
res, err := coll.Find(cond).IndexHint(IndexHint{IndexName: "id", Boost: 1 << 30}).Delete(ctx)
require.NoError(t, err)
assert.Equal(t, k, res.Modified)
for _, id := range expect {
_, gerr := coll.FindId(ctx, id)
assert.ErrorIs(t, gerr, ErrDocNotFound, "doc %d must be deleted", id)
}
}
// A REVERSE-declared unique index chosen as the $knn probe driver goes
// through CoverIter, which must receive un-finalized bounds — the
// reverse-tail pad would double-pad its seek and silently select nothing.
func TestKnnProbe_ReverseUniqueCoverDriver(t *testing.T) {
const dim = 8
fx := newFixture(t)
t.Cleanup(fx.finish)
coll, err := fx.CreateCollection(ctx, "knnrev")
require.NoError(t, err)
makeVectorIndex(t, coll, VectorModeBruteForce, dim)
require.NoError(t, coll.EnsureIndex(ctx, IndexInfo{Name: "u", Fields: []string{"-u"}, Unique: true}))
vecs := vrand(60, dim, 21)
for i, vc := range vecs {
doc := anyenc.MustParseJson(vecDocJSON(i, vc))
doc.Set("u", anyenc.MustParseJson(fmt.Sprintf("%d", i)))
require.NoError(t, coll.Insert(ctx, doc))
}
for _, extra := range []query.Filter{
query.MustParseCondition(`{"u":9}`),
query.MustParseCondition(`{"u":{"$in":[3,17,42,99]}}`),
} {
cond := knnCond(vecs[9], 3, extra)
driverIds, driverDists := collectKnn(t, coll.Find(cond).IndexHint(IndexHint{IndexName: "emb", Boost: 1 << 30}))
probeIds, probeDists := collectKnn(t, coll.Find(cond).IndexHint(IndexHint{IndexName: "u", Boost: 1 << 30}))
require.NotEmpty(t, driverIds)
assert.Equal(t, driverIds, probeIds, "reverse-unique cover probe lost rows")
assert.Equal(t, driverDists, probeDists)
}
}
// TestVectorIndex_CompactMovesRootAndDetects checks the cross-process plumbing:
// compaction must move the index's namespace root pages, and the pre-compaction
// vectorIndex object must detect that (rootUnchanged == false) so a peer's
// reconcile reopens it with fresh handles instead of reading freed pages.
func TestVectorIndex_CompactMovesRootAndDetects(t *testing.T) {
const dim = 16
fx := newFixture(t)
coll, err := fx.CreateCollection(ctx, "docs")
require.NoError(t, err)
require.NoError(t, coll.CreateIndex(ctx, IndexInfo{
Name: "emb", Kind: IndexKindVector,
Vector: &VectorParams{Field: "v", Dim: dim, Metric: VectorL2, EfSearch: 64},
}))
vecs := vrand(300, dim, 7)
for i, vc := range vecs {
require.NoError(t, coll.Insert(ctx, anyenc.MustParseJson(vecDocJSON(i, vc))))
}
for i := 0; i < 100; i++ { // create tombstones so compaction isn't a no-op
require.NoError(t, coll.DeleteId(ctx, i))
}
c := coll.(*collection)
oldVI := c.loadVectorIndexes()[0]
oldRoot := oldVI.ix.MetaRoot()
require.NoError(t, coll.CompactVectorIndex(ctx, "emb"))
newVI := c.loadVectorIndexes()[0]
require.NotEqual(t, oldRoot, newVI.ix.MetaRoot(), "compaction must move the meta root page")
require.NoError(t, c.db.doReadTx(ctx, func(tx *btree.ReadTx) error {
assert.False(t, oldVI.rootUnchanged(tx, c.name), "stale object must detect the moved root")
assert.True(t, newVI.rootUnchanged(tx, c.name), "fresh object must be current")
return nil
}))
}
// TestKnnResidual_NoKnnSurvives is the hard post-condition behind the
// fail-closed design: for every legal placement, the residual handed to the
// FilterIter contains no Knn (a leaked Knn rejects every candidate — 0 rows,
// no-op Delete, err == nil — silently, on all verbs).
func TestKnnResidual_NoKnnSurvives(t *testing.T) {
for _, cond := range []string{
fmt.Sprintf(`{"v":%s}`, kd),
fmt.Sprintf(`{"v":%s,"a":1}`, kd),
fmt.Sprintf(`{"$and":[{"v":%s}]}`, kd),
fmt.Sprintf(`{"$and":[{"v":%s},{"a":1}]}`, kd),
fmt.Sprintf(`{"$and":[{"$and":[{"v":%s},{"a":1}]},{"b":2}]}`, kd),
fmt.Sprintf(`{"$and":[{"$and":[{"v":%s}]},{"$and":[{"a":1},{"b":2}]}]}`, kd),
} {
f := query.MustParseCondition(cond)
require.True(t, query.ContainsKnn(f), cond)
residual := knnResidualFilter(f)
assert.False(t, residual != nil && query.ContainsKnn(residual),
"the Knn must be stripped from the residual: %s -> %v", cond, residual)
}
// Empty residual collapses to nil, NOT All{}: ef sizing and the
// brute-force topK both key off "no residual" — All{} would flip every
// bare $knn onto the ×10 over-fetch / full-ranking path invisibly.
assert.Nil(t, knnResidualFilter(query.MustParseCondition(fmt.Sprintf(`{"v":%s}`, kd))))
assert.Nil(t, knnResidualFilter(query.MustParseCondition(fmt.Sprintf(`{"$and":[{"v":%s}]}`, kd))))
}
// CompactRatio (and the IVF tuning params) must survive a DB reopen: they used
// to be dropped by registerIndex/getIndexInfos, permanently disabling
// auto-compaction after any restart.
func TestVectorParams_PersistAcrossReopen(t *testing.T) {
const dim = 8
tmpDir := t.TempDir()
fx := newFixturePath(t, tmpDir)
coll, err := fx.CreateCollection(ctx, "docs")
require.NoError(t, err)
want := &VectorParams{
Field: "v", Dim: dim, Metric: VectorL2, EfSearch: 64,
CompactRatio: 0.5, NProbe: 8,
}
require.NoError(t, coll.CreateIndex(ctx, IndexInfo{Name: "emb", Kind: IndexKindVector, Vector: want}))
require.NoError(t, fx.Close())
db2, err := Open(ctx, filepath.Join(tmpDir, "any-store-test.db"), nil)
require.NoError(t, err)
defer db2.Close()
coll, err = db2.OpenCollection(ctx, "docs")
require.NoError(t, err)
vidxs := coll.(*collection).loadVectorIndexes()
require.Len(t, vidxs, 1)
require.NotNil(t, vidxs[0].info.Vector)
assert.Equal(t, *want, *vidxs[0].info.Vector)
assert.Equal(t, want.CompactRatio, vidxs[0].compactRatio)
}
// makeVectorIndex creates a vector index of the given mode on field "v".
func makeVectorIndex(t *testing.T, coll Collection, mode VectorMode, dim int) {
t.Helper()
require.NoError(t, coll.CreateIndex(ctx, IndexInfo{
Name: "emb",
Kind: IndexKindVector,
Vector: &VectorParams{Field: "v", Dim: dim, Metric: VectorL2, EfSearch: 64, Mode: mode},
}))
}
// vectorKnnFilter builds the programmatic $knn filter (query.NewKnn) used to
// issue a vector query through the normal Find pipeline — the same construction
// the downstream indexer uses (no JSON involved).
func vectorKnnFilter(qv []float32, k int) query.Filter {
return query.Key{Path: []string{"v"}, Filter: query.NewKnn(qv, k)}
}
func vqJSON(vec []float32) string {
parts := make([]string, len(vec))
for i, f := range vec {
parts[i] = fmt.Sprintf("%g", f)
}
return "[" + strings.Join(parts, ",") + "]"
}
// vknnJSON renders the $knn clause value: {"$knn":{"$query":[...],"$k":k}}.
// ef<=0 omits $ef (the index default applies).
func vknnJSON(vec []float32, k, ef int) string {
if ef > 0 {
return fmt.Sprintf(`{"$knn":{"$query":%s,"$k":%d,"$ef":%d}}`, vqJSON(vec), k, ef)
}
return fmt.Sprintf(`{"$knn":{"$query":%s,"$k":%d}}`, vqJSON(vec), k)
}
const kd = `{"$knn":{"$query":[3,1,2],"$k":4}}`