pub struct SQLiteIVFIndex { /* private fields */ }Implementations§
Source§impl SQLiteIVFIndex
impl SQLiteIVFIndex
pub fn new( conn: ManagedConnection, table: impl Into<String>, field: impl Into<String>, dimensions: u32, ) -> Self
pub fn with_params( conn: ManagedConnection, table: impl Into<String>, field: impl Into<String>, dimensions: u32, nlist: usize, nprobe: usize, train_threshold: usize, ) -> Self
pub fn open_existing( conn: ManagedConnection, table: impl Into<String>, field: impl Into<String>, dimensions: u32, nlist: usize, nprobe: usize, train_threshold: usize, ) -> Self
pub fn drop_metadata( conn: &ManagedConnection, table: &str, field: &str, ) -> SQLiteResult<()>
Trait Implementations§
Source§impl Clone for SQLiteIVFIndex
impl Clone for SQLiteIVFIndex
Source§impl VectorIndex for SQLiteIVFIndex
impl VectorIndex for SQLiteIVFIndex
Source§fn contains_document(&self, doc_id: DocId) -> StorageBackendResult<bool>
fn contains_document(&self, doc_id: DocId) -> StorageBackendResult<bool>
Test canonical membership at this handle’s visibility boundary without searching or materializing the corpus. Empty tensor replacements have no membership. This is a maintenance probe, not a logical query observation.
fn dimensions(&self) -> u32
fn index_kind(&self) -> &'static str
fn add(&mut self, doc_id: DocId, vector: Vec<f32>) -> StorageBackendResult<()>
fn add_many( &mut self, doc_id: DocId, vectors: Vec<Vec<f32>>, ) -> StorageBackendResult<()>
fn delete(&mut self, doc_id: DocId) -> StorageBackendResult<()>
fn clear(&mut self) -> StorageBackendResult<()>
fn search_knn( &self, query: &[f32], k: usize, ) -> StorageBackendResult<PostingList>
fn search_threshold( &self, query: &[f32], threshold: f32, ) -> StorageBackendResult<PostingList>
fn count(&self) -> StorageBackendResult<usize>
Source§fn initialize(&mut self) -> StorageBackendResult<()>
fn initialize(&mut self) -> StorageBackendResult<()>
Build any auxiliary physical metadata required by this index from its
current vector contents. Brute-force indexes need no extra work;
persistent IVF and HNSW implementations use this during explicit
index creation, while restore paths deliberately skip it.
Source§fn snapshot(&self) -> StorageBackendResult<Arc<dyn VectorIndex>>
fn snapshot(&self) -> StorageBackendResult<Arc<dyn VectorIndex>>
Read-only handle suitable for an
ExecutionContext.Source§fn vector_read_snapshot(
&self,
control: &StorageReadControl,
) -> StorageBackendResult<Option<VectorReadSnapshot>>
fn vector_read_snapshot( &self, control: &StorageReadControl, ) -> StorageBackendResult<Option<VectorReadSnapshot>>
Retain the actual canonical values independently of physical mutation provenance. Capturing this source is metadata access, not a logical vector query.
Source§fn diskann_query_metadata(
&self,
control: &StorageReadControl,
) -> Result<Option<DiskANNQueryMetadata>, StorageBackendError>
fn diskann_query_metadata( &self, control: &StorageReadControl, ) -> Result<Option<DiskANNQueryMetadata>, StorageBackendError>
Metadata from the actual selected physical/canonical view, without executing a logical vector query. Unsupported methods return None.
Source§fn search_knn_with_control(
&self,
query: &[f32],
k: usize,
control: &StorageReadControl,
) -> Result<PostingList, StorageBackendError>
fn search_knn_with_control( &self, query: &[f32], k: usize, control: &StorageReadControl, ) -> Result<PostingList, StorageBackendError>
Request a controlled search. The default checks cancellation and delegates to the provider’s existing read boundary; in-memory physical algorithms override it to charge query workspace to the supplied allowance.
Source§fn search_threshold_with_control(
&self,
query: &[f32],
threshold: f32,
control: &StorageReadControl,
) -> Result<PostingList, StorageBackendError>
fn search_threshold_with_control( &self, query: &[f32], threshold: f32, control: &StorageReadControl, ) -> Result<PostingList, StorageBackendError>
Controlled threshold search keeps the same result and caller-owned posting boundary as ordinary search.
Source§fn search_knn_with_statistics(
&self,
query: &[f32],
k: usize,
control: Option<&StorageReadControl>,
) -> Result<VectorQueryResult, StorageBackendError>
fn search_knn_with_statistics( &self, query: &[f32], k: usize, control: Option<&StorageReadControl>, ) -> Result<VectorQueryResult, StorageBackendError>
Run one KNN invocation and retain its measured work when supported. An optional invoking control preserves the existing controlled-search boundary; absence preserves ordinary provider dispatch. Unsupported providers execute once and return no report.
Source§fn search_threshold_with_statistics(
&self,
query: &[f32],
threshold: f32,
control: Option<&StorageReadControl>,
) -> Result<VectorQueryResult, StorageBackendError>
fn search_threshold_with_statistics( &self, query: &[f32], threshold: f32, control: Option<&StorageReadControl>, ) -> Result<VectorQueryResult, StorageBackendError>
Return exact threshold results and optional work from their one invocation. Report support must not introduce an additional scan or weaken the original provider’s controls.
Source§fn snapshot_with_control(
&self,
control: &StorageReadControl,
) -> Result<Arc<dyn VectorIndex>, StorageBackendError>
fn snapshot_with_control( &self, control: &StorageReadControl, ) -> Result<Arc<dyn VectorIndex>, StorageBackendError>
Capture using the caller’s retention allowance and cancellation. Owners that copy index data override this method to reserve construction before allocation. The default preserves the provider’s existing snapshot and its independently retained control.
Source§fn diskann_read_snapshot(
&self,
control: &StorageReadControl,
) -> Result<Option<DiskANNReadSnapshot>, StorageBackendError>
fn diskann_read_snapshot( &self, control: &StorageReadControl, ) -> Result<Option<DiskANNReadSnapshot>, StorageBackendError>
Borrow an opaque retained
DiskANN canonical source for evaluated document replacements. Capturing metadata does not execute or observe a vector query; other physical methods leave this capability absent.Source§fn matches_document_vectors(
&self,
document: u64,
vectors: &[Vec<f32>],
control: &StorageReadControl,
) -> Result<bool, StorageBackendError>
fn matches_document_vectors( &self, document: u64, vectors: &[Vec<f32>], control: &StorageReadControl, ) -> Result<bool, StorageBackendError>
Check whether a SQL replacement can retain this document’s canonical vectors. Unsupported providers return false and keep the normal replacement path. Live memory indexes override this to borrow their canonical data without cloning the entire index.
Source§fn snapshot_with_vector_read(
&self,
_source: Arc<dyn VectorRead>,
control: &StorageReadControl,
) -> Result<Option<Arc<dyn VectorIndex>>, StorageBackendError>
fn snapshot_with_vector_read( &self, _source: Arc<dyn VectorRead>, control: &StorageReadControl, ) -> Result<Option<Arc<dyn VectorIndex>>, StorageBackendError>
Keep this selected physical
DiskANN generation while reading a different fixed canonical field view. The query owner verifies raw coverage without inventing mutation origins.Source§fn snapshot_with_diskann_changes(
&self,
_changes: &DiskANNReadChanges,
control: &StorageReadControl,
) -> Result<Option<Arc<dyn VectorIndex>>, StorageBackendError>
fn snapshot_with_diskann_changes( &self, _changes: &DiskANNReadChanges, control: &StorageReadControl, ) -> Result<Option<Arc<dyn VectorIndex>>, StorageBackendError>
Retain this physical
DiskANN generation with the selected actual canonical replacements. Wrappers preserve their original read observation and retention boundary on the returned index. Unsupported methods return None without changing physical selection.Source§fn writable_snapshot(&self) -> Result<Box<dyn VectorIndex>, StorageBackendError>
fn writable_snapshot(&self) -> Result<Box<dyn VectorIndex>, StorageBackendError>
Independent writable copy used by in-memory engine rollback. The
default keeps third-party and persistent implementations source
compatible; only indexes hosted by a memory engine need to support it.
Auto Trait Implementations§
impl !RefUnwindSafe for SQLiteIVFIndex
impl !UnwindSafe for SQLiteIVFIndex
impl Freeze for SQLiteIVFIndex
impl Send for SQLiteIVFIndex
impl Sync for SQLiteIVFIndex
impl Unpin for SQLiteIVFIndex
impl UnsafeUnpin for SQLiteIVFIndex
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more