uqa-storage 0.4.8

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
155
156
157
158
159
160

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

//! Evaluated document selections compose raw sources without transferring physical provenance.

use super::{VectorRead, VectorReadSnapshot};
use crate::{mvcc::VersionError, read_control::StorageReadControl, StorageBackendResult};
use uqa_core::{
    memory::{Budgeted, BudgetedVec},
    DocId,
};

pub struct SelectedVectorRead {
    base: Option<VectorReadSnapshot>,
    selected: BudgetedVec<(DocId, Option<VectorReadSnapshot>)>,
    dimensions: u32,
    control: StorageReadControl,
}

impl SelectedVectorRead {
    /// Retain already evaluated replacements/deletions in strictly increasing document order. None for the base means the supplied selection is the entire visible field. Capture inspects only controls and dimensions.
    pub fn capture(
        base: Option<VectorReadSnapshot>,
        dimensions: u32,
        selected: impl IntoIterator<Item = (DocId, Option<VectorReadSnapshot>)>,
        control: &StorageReadControl,
    ) -> StorageBackendResult<VectorReadSnapshot> {
        control.check()?;
        let check = |source: &VectorReadSnapshot| {
            source.check_control(control)?;
            if source.dimensions() != dimensions {
                return Err(
                    VersionError::InvalidEncoding("selected vector source width mismatch")
                        .into_storage_error(),
                );
            }
            Ok(())
        };
        if let Some(base) = &base {
            check(base)?;
        }
        let mut sources = BudgetedVec::new(control.memory());
        let mut after = None;
        for (document, source) in selected {
            control.check()?;
            if after.is_some_and(|after| document <= after) {
                return Err(VersionError::InvalidEncoding(
                    "selected vector documents are not strictly increasing",
                )
                .into_storage_error());
            }
            if let Some(source) = &source {
                check(source)?;
            }
            sources.push((document, source))?;
            after = Some(document);
        }
        let source = Self {
            base,
            selected: sources,
            dimensions,
            control: control.clone(),
        };
        Ok(Budgeted::new(source, control.memory().empty_reservation()).into_shared()?)
    }

    fn source(&self, document: DocId) -> Option<&VectorReadSnapshot> {
        match self
            .selected
            .binary_search_by_key(&document, |entry| entry.0)
        {
            Ok(position) => self.selected[position].1.as_ref(),
            Err(_) => self.base.as_ref(),
        }
    }
}

impl VectorRead for SelectedVectorRead {
    fn corpus_fingerprint(
        &self,
        control: &StorageReadControl,
    ) -> StorageBackendResult<Option<[u8; 32]>> {
        self.check_control(control)?;
        super::selected_fingerprint(
            self.dimensions,
            self.base.as_deref(),
            self.selected
                .iter()
                .map(|(document, source)| (*document, source.as_deref())),
            control,
        )
    }
    fn check_control(&self, control: &StorageReadControl) -> StorageBackendResult<()> {
        self.control.check()?;
        control.check()?;
        if let Some(base) = &self.base {
            base.check_control(control)?;
        }
        Ok(())
    }
    fn dimensions(&self) -> u32 {
        self.dimensions
    }
    fn next_document_after(
        &self,
        mut after: Option<DocId>,
        control: &StorageReadControl,
    ) -> StorageBackendResult<Option<DocId>> {
        loop {
            self.check_control(control)?;
            let base = self
                .base
                .as_ref()
                .map(|base| base.next_document_after(after, control))
                .transpose()?
                .flatten();
            let position = self
                .selected
                .partition_point(|entry| after.is_some_and(|after| entry.0 <= after));
            let selected = self.selected.get(position).map(|entry| entry.0);
            let Some(document) = base.into_iter().chain(selected).min() else {
                return Ok(None);
            };
            if after.is_some_and(|after| document <= after) {
                return Err(VersionError::InvalidEncoding(
                    "selected vector cursor did not advance",
                )
                .into_storage_error());
            }
            if self.document_vector_count(document, control)? != 0 {
                return Ok(Some(document));
            }
            after = Some(document);
        }
    }
    fn document_vector_count(
        &self,
        document: DocId,
        control: &StorageReadControl,
    ) -> StorageBackendResult<u64> {
        self.check_control(control)?;
        self.source(document).map_or(Ok(0), |source| {
            source.document_vector_count(document, control)
        })
    }
    fn read_vector(
        &self,
        document: DocId,
        ordinal: u32,
        control: &StorageReadControl,
    ) -> StorageBackendResult<Option<BudgetedVec<f32>>> {
        self.check_control(control)?;
        self.source(document).map_or(Ok(None), |source| {
            source.read_vector(document, ordinal, control)
        })
    }
}