uqa-storage 0.4.0

Document store, inverted index, IVF/HNSW vectors, B-tree, R*Tree, catalog
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

//
// Unified Query Algebra
//
// Copyright (c) 2023-2026 Cognica, Inc.
//

//! Physical caches retain their original allowance through replacement, failure, and nested readers.

use super::*;
use crate::key_value::index_view::read_view;
use crate::read_control::StorageReadControl;

fn specs() -> [VectorIndexSpec; 2] {
    [
        VectorIndexSpec::HNSW(HNSWIndexParams::default()),
        VectorIndexSpec::IVF(IVFIndexParams {
            nlist: 2,
            nprobe: 2,
            train_threshold: 2,
        }),
    ]
}

#[test]
fn physical_cache_replacement_keeps_prior_snapshots_charged_until_the_last_reader() {
    for spec in specs() {
        let store = store();
        let control = read_view(&*store, |read| Ok(read.control().clone())).unwrap();
        let backend = super::super::KeyValueStorageBackend::new(store.clone());
        let mut index = backend
            .vector_index("docs", "embedding", 2, spec, VectorIndexOpenMode::Create)
            .unwrap();
        index
            .add_many(1, vec![vec![1.0, 0.0], vec![0.0, 1.0]])
            .unwrap();
        index.initialize().unwrap();
        let old = index.snapshot().unwrap();
        let old_used = control.memory().used();
        assert!(old_used > 0);
        let nested = old
            .snapshot_with_control(&StorageReadControl::with_limit(0))
            .unwrap();
        assert_eq!(control.memory().used(), old_used);
        index.add(2, vec![-1.0, 0.0]).unwrap();
        let current = index.snapshot().unwrap();
        assert_eq!(current.count().unwrap(), 3);
        assert_eq!(old.count().unwrap(), 2);
        assert_eq!(old.index_kind(), spec.access_method());
        drop((index, backend, store));
        assert!(control.memory().used() > old_used);
        drop(current);
        assert_eq!(control.memory().used(), old_used);
        drop(old);
        assert_eq!(control.memory().used(), old_used);
        assert_eq!(
            nested
                .search_knn(&[1.0, 0.0], 1)
                .unwrap()
                .doc_ids()
                .collect::<Vec<_>>(),
            vec![1]
        );
        drop(nested);
        assert_eq!(control.memory().used(), 0);
    }
}

#[test]
fn physical_restore_and_rebuild_fail_without_replacing_retained_readers_or_records() {
    for spec in specs() {
        let store = store();
        let control = read_view(&*store, |read| Ok(read.control().clone())).unwrap();
        let backend = super::super::KeyValueStorageBackend::new(store.clone());
        let mut index = backend
            .vector_index("docs", "embedding", 2, spec, VectorIndexOpenMode::Create)
            .unwrap();
        index
            .add_many(1, vec![vec![1.0, 0.0], vec![0.0, 1.0]])
            .unwrap();
        index.initialize().unwrap();
        let old = index.snapshot().unwrap();
        let used = control.memory().used();
        let before = store.scan_prefix(&[]).unwrap();
        let full = control
            .memory()
            .reserve(control.memory().limit() - used)
            .unwrap();
        assert!(matches!(
            backend.vector_index("docs", "embedding", 2, spec, VectorIndexOpenMode::Restore),
            Err(StorageBackendError::Memory(_))
        ));
        assert!(matches!(
            index.initialize(),
            Err(StorageBackendError::Memory(_))
        ));
        assert_eq!(old.count().unwrap(), 2);
        assert_eq!(control.memory().used(), control.memory().limit());
        drop(full);
        assert_eq!(control.memory().used(), used);
        assert_eq!(store.scan_prefix(&[]).unwrap(), before);
        index.initialize().unwrap();
        assert_eq!(index.count().unwrap(), 2);
        control.cancellation().cancel();
        assert!(matches!(
            index.snapshot(),
            Err(StorageBackendError::Cancelled(_))
        ));
        drop((index, old, backend, store));
        assert_eq!(control.memory().used(), 0);
    }
}

#[test]
fn occurrence_snapshots_keep_field_metadata_and_reject_capture_at_the_original_limit() {
    let store = store();
    let control = read_view(&*store, |read| Ok(read.control().clone())).unwrap();
    let mut index =
        KeyValueInvertedIndex::new(store.clone(), "docs", uqa_analysis::whitespace_analyzer());
    let field = "bound_".repeat(8192);
    let revision = uqa_analysis::keyword_analyzer().compile().unwrap();
    index
        .set_field_analyzer_revision(
            &field,
            Arc::clone(&revision),
            crate::inverted_index::AnalyzerPhase::Both,
        )
        .unwrap();
    let snapshot = index.snapshot().unwrap();
    let bytes = control.memory().used();
    assert!(bytes > field.len());
    let full = control
        .memory()
        .reserve(control.memory().limit() - bytes)
        .unwrap();
    assert!(matches!(
        index.snapshot(),
        Err(StorageBackendError::Memory(_))
    ));
    assert_eq!(control.memory().used(), control.memory().limit());
    drop(full);
    let nested = snapshot
        .snapshot_with_control(&StorageReadControl::with_limit(0))
        .unwrap();
    assert_eq!(control.memory().used(), bytes);
    index.remove_field_analyzers(&field).unwrap();
    drop((snapshot, index, store));
    assert!(Arc::ptr_eq(
        &nested.index_analyzer_revision(&field).unwrap(),
        &revision
    ));
    assert_eq!(control.memory().used(), bytes);
    drop(nested);
    assert_eq!(control.memory().used(), 0);
}