Skip to main content

uqa_storage/
lib.rs

1//
2// Unified Query Algebra
3//
4// Copyright (c) 2023-2026 Cognica, Inc.
5//
6
7//! Persistent and in-memory backing stores for UQA: documents, inverted
8//! index, vector indexes (IVF), B-tree, in-memory spatial scan, block-max, and the
9//! `SQLite` catalog.
10
11pub mod backend;
12pub mod block_max_index;
13pub mod btree_index;
14mod catalog_index_keys;
15mod value_index_key;
16pub use value_index_key::ValueIndexKey;
17pub mod catalog;
18pub mod clustered_postings;
19pub mod document_store;
20pub mod hnsw_index;
21pub mod index_abc;
22pub mod index_manager;
23pub mod index_types;
24pub mod inverted_index;
25pub mod ivf_index;
26pub mod key_value;
27pub mod spatial_index;
28pub mod sqlite;
29pub mod transaction;
30pub mod vector_index;
31
32pub use backend::{
33    PersistentStorageBackend, PersistentStorageIdentity, PersistentStorageProvider,
34    PersistentStorageSession, SQLiteStorageBackend, SQLiteStorageProvider, StorageBackendError,
35    StorageBackendResult, StorageSavepointId,
36};
37pub use block_max_index::{BlockMaxIndex, BlockMaxScorer, DEFAULT_BLOCK_SIZE};
38pub use btree_index::BTreeIndex;
39pub use catalog::{
40    sequence_value_reservation, CatalogFacade, CatalogIndexRow, ColumnStatsInput, ColumnStatsRow,
41    EdgeRow, ForeignTableRow, GraphSnapshot, GraphVertexRow, RelationIdentity, RelationKind,
42    SchemaAclEntry, SchemaPrivileges, SchemaRow, SequenceAclEntry, SequenceOptions, SequenceOwner,
43    SequenceOwnerDependency, SequencePrivileges, SequenceReservationResult, SequenceRow,
44    SequenceValuePosition, SequenceValueReservation, TableAclEntry, TablePrivileges, TableSchema,
45    VectorFieldSchema, ViewRow,
46};
47pub use clustered_postings::{
48    MaterializedPostingCursor, PostingCursor, PostingScore, POSTING_CLUSTER_DOCS,
49};
50pub use document_store::{
51    DocumentMetadata, DocumentStore, MemoryDocumentStore, SharedDocumentRow, StoredDocument,
52};
53pub use hnsw_index::HNSWIndex;
54pub use index_abc::Index;
55pub use index_manager::{BTreeIndexHandle, IndexManager};
56pub use index_types::{IndexDef, IndexType};
57pub use inverted_index::{AnalyzerPhase, InvertedIndex, MemoryInvertedIndex};
58pub use ivf_index::{IVFIndex, IVFState};
59pub use key_value::{
60    KeyValueBatch, KeyValueCatalog, KeyValueDocumentStore, KeyValueInvertedIndex,
61    KeyValueStorageBackend, KeyValueStore, KeyValueVectorIndex, MemoryKeyValueStore,
62};
63pub use spatial_index::{haversine_distance, MemorySpatialIndex, SpatialIndex};
64pub use sqlite::{
65    detect_database_file_format, read_authenticated_anchor, Catalog, DatabaseFileFormat,
66    ManagedConnection, SQLiteBTreeIndexStore, SQLiteCompressedContainerAnchor,
67    SQLiteCompressionCodec, SQLiteCompressionOptions, SQLiteDocumentStore, SQLiteError,
68    SQLiteHNSWIndex, SQLiteIVFIndex, SQLiteInvertedIndex, SQLiteVectorIndex,
69};
70pub use transaction::{
71    InMemoryTransaction, SQLiteTransaction, Snapshotable, TransactionError, TxResult,
72};
73pub use vector_index::{
74    cosine_similarity, HNSWIndexParams, IVFIndexParams, MemoryVectorIndex, VectorIndex,
75    VectorIndexOpenMode, VectorIndexSpec,
76};