Skip to main content

uqa_storage_sqlite/vector_index/diskann/retained/
selection.rs

1//
2// Unified Query Algebra
3//
4// Copyright (c) 2023-2026 Cognica, Inc.
5//
6
7use super::{invalid, RetainedSQLiteDiskANNCanonical};
8use std::sync::Arc;
9use uqa_storage::diskann_index::{
10    format::{DiskANNCanonicalOrigin, DiskANNChangeIdentity},
11    pages::DiskANNReadLimits,
12    DiskANNQuery, DiskANNQueryRead, RetainedDiskANNIndex,
13};
14use uqa_storage::{
15    diskann_index::catalog::DiskANNIndexResolver, key_value::KeyValueDiskANNSource,
16    read_control::StorageReadControl, StorageBackendResult,
17};
18
19impl RetainedSQLiteDiskANNCanonical {
20    /// Consume the retained native view into the common read-only `VectorIndex` owner without copying canonical vectors or reconstructing the graph.
21    pub fn into_vector_index(
22        self,
23        resolver: &dyn DiskANNIndexResolver,
24        limits: DiskANNReadLimits,
25        control: &StorageReadControl,
26    ) -> StorageBackendResult<Option<RetainedDiskANNIndex<Self>>> {
27        self.selected_source(resolver, control)?
28            .map(|source| {
29                let parameters = self
30                    .index_parameters()
31                    .ok_or_else(|| invalid("missing index parameters"))?;
32                RetainedDiskANNIndex::open(self, source, parameters, limits, control)
33            })
34            .transpose()
35    }
36
37    /// Prepare the common Storage document search on this native canonical/catalog view and its selected physical source.
38    pub fn query(
39        &self,
40        resolver: &dyn DiskANNIndexResolver,
41        limits: DiskANNReadLimits,
42        control: &StorageReadControl,
43    ) -> StorageBackendResult<Option<DiskANNQuery<'_>>> {
44        self.selected_source(resolver, control)?
45            .map(|source| {
46                DiskANNQuery::open(
47                    self,
48                    source,
49                    self.index_parameters()
50                        .ok_or_else(|| invalid("missing index parameters"))?,
51                    limits,
52                    control,
53                )
54            })
55            .transpose()
56    }
57
58    /// Select physical graph data on this native canonical/catalog view, retaining private publication resources without advancing the SQL snapshot or loading page/PQ bodies.
59    pub fn selected_source(
60        &self,
61        resolver: &dyn DiskANNIndexResolver,
62        control: &StorageReadControl,
63    ) -> StorageBackendResult<Option<Arc<KeyValueDiskANNSource>>> {
64        self.check(control)?;
65        let scope = self.index_scope(resolver, control)?;
66        let parameters = self
67            .index_parameters()
68            .ok_or_else(|| invalid("missing index parameters"))?;
69        let records = self.snapshot.record_read();
70        let physical = crate::diskann::map_read(&records, self.snapshot.database)?;
71        let source = KeyValueDiskANNSource::select(
72            &scope,
73            self.dimensions,
74            parameters,
75            &physical,
76            &self.control,
77            control,
78        )?;
79        self.check(control)?;
80        Ok(source)
81    }
82}
83
84impl DiskANNQueryRead for RetainedSQLiteDiskANNCanonical {
85    fn document_origin(
86        &self,
87        document: uqa_core::DocId,
88        control: &StorageReadControl,
89    ) -> StorageBackendResult<Option<DiskANNCanonicalOrigin>> {
90        self.record(document, control)
91    }
92
93    fn next_change_after(
94        &self,
95        after: Option<uqa_core::DocId>,
96        control: &StorageReadControl,
97    ) -> StorageBackendResult<Option<DiskANNChangeIdentity>> {
98        self.next_change_after(after, control)
99    }
100}