uqa-storage 0.5.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

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

use super::{Keys, Kind};
use crate::diskann_index::pages::DiskANNRecordKey;
use crate::key_value::conformance::{expect, expect_eq};
use crate::key_value::{
    DiskANNMaintenanceStatus, DiskANNMaintenanceStep, KeyValueDiskANNMaintenance,
    KeyValueDiskANNStage, KeyValueDiskANNStore,
};
use crate::read_control::StorageReadControl;
use crate::{KeyValueStore, StorageBackendResult};
use std::sync::Arc;

/// A finite discovery boundary excludes later builds, skips live owners and deletes bounded key pages without materializing large payloads. Use a fresh disposable provider.
pub fn verify_diskann_maintenance(store: &Arc<dyn KeyValueStore>) -> StorageBackendResult<()> {
    let control = StorageReadControl::with_limit(1 << 20);
    let repository = KeyValueDiskANNStore::connect(store, &control)?;
    repository.initialize(&control)?;
    let abandoned = stage(store, &repository, 100, 70, &control)?;
    let generation = abandoned.generation();
    drop(abandoned);
    let live = stage(store, &repository, 200, 1, &control)?;
    let tail = stage(store, &repository, 400, 1, &control)?.generation();
    let keys = Keys::new(generation);
    let payload_key = keys.key(Kind::Record(DiskANNRecordKey::Codes(0)));
    let held = store.open_retained_read_session(control.cancellation())?;
    let cleanup = StorageReadControl::with_limit(65_536);
    let mut pass = KeyValueDiskANNMaintenance::start(store, &cleanup)?;
    let earlier = stage(store, &repository, 50, 1, &control)?.generation();
    let later = stage(store, &repository, 500, 1, &control)?.generation();
    for status in [
        DiskANNMaintenanceStatus::MoreRecords,
        DiskANNMaintenanceStatus::Reclaimed,
    ] {
        expect_eq(
            &pass.step()?,
            &Some(DiskANNMaintenanceStep { generation, status }),
            "large abandoned generation uses two bounded batches",
        )?;
        if status == DiskANNMaintenanceStatus::MoreRecords {
            expect_eq(
                &store
                    .scan_prefix_keys_after(keys.prefix(), None, 100)?
                    .len(),
                &7,
                "first maintenance step deletes exactly 64 payload keys",
            )?;
        }
    }
    expect_eq(
        &pass.step()?,
        &Some(DiskANNMaintenanceStep {
            generation: live.generation(),
            status: DiskANNMaintenanceStatus::Retained,
        }),
        "live build is retained without blocking the discovery cursor",
    )?;
    expect_eq(
        &pass.step()?,
        &Some(DiskANNMaintenanceStep {
            generation: tail,
            status: DiskANNMaintenanceStatus::Reclaimed,
        }),
        "a retained generation does not starve a later abandoned build",
    )?;
    for _ in 0..2 {
        expect_eq(&pass.step()?, &None, "new builds cannot extend this pass")?;
    }
    for next in [earlier, later] {
        expect(
            repository.resume_stage(next, &control).is_ok(),
            "builds outside the discovery boundary survive its completion",
        )?;
    }
    drop(pass);
    expect_eq(
        &cleanup.memory().used(),
        &0,
        "closed pass releases its allowance",
    )?;
    store.reclaim_obsolete()?;
    for reclaimed in [generation, earlier, later] {
        expect(
            store
                .scan_prefix_keys_after(Keys::new(reclaimed).prefix(), None, 1)?
                .is_empty(),
            "the next vacuum pass collects earlier and later abandoned generations",
        )?;
    }
    expect_eq(
        &held.get(payload_key.as_ref())?,
        &Some(vec![23; 32_768]),
        "retained payload remains readable after automatic deletion and vacuum",
    )?;
    expect_eq(
        &live.status(&control)?,
        &Some(crate::key_value::DiskANNStageStatus::Writing),
        "vacuum preserves the live build",
    )?;
    let live_generation = live.generation();
    drop((live, held));
    store.vacuum()?;
    expect(
        store
            .scan_prefix_keys_after(Keys::new(live_generation).prefix(), None, 1)?
            .is_empty(),
        "a subsequent pass observes last-owner release",
    )?;
    super::mappings::verify(store, &control)?;
    store.reclaim_obsolete()?;
    Ok(())
}

fn stage(
    store: &Arc<dyn KeyValueStore>,
    repository: &KeyValueDiskANNStore,
    table: u64,
    records: u64,
    control: &StorageReadControl,
) -> StorageBackendResult<KeyValueDiskANNStage> {
    let mut stage = repository.allocate_stage(table, 2, control)?;
    stage.start(control)?;
    let keys = Keys::new(stage.generation());
    let payload = vec![23; 32_768];
    store.with_mutation(&mut |_, batch| {
        batch.require_unchanged(keys.key(Kind::State).as_ref())?;
        for position in 0..records {
            batch.put(
                keys.key(Kind::Record(DiskANNRecordKey::Codes(position)))
                    .as_ref(),
                &payload,
            )?;
        }
        Ok(())
    })?;
    Ok(stage)
}