Skip to main content

Crate uqa_storage

Crate uqa_storage 

Source
Expand description

Persistent and in-memory backing stores for UQA: documents, inverted index, vector indexes (IVF), B-tree, in-memory spatial scan, block-max, and the provider-neutral catalog and transaction contracts.

Re-exports§

pub use analyzer_binding::AnalyzerBindingOwner;
pub use analyzer_binding::BoundAnalyzerRevision;
pub use analyzer_binding::FieldAnalyzerBinding;
pub use encryption_key::StorageEncryptionKey;
pub use backend::PersistentStorageBackend;
pub use backend::PersistentStorageIdentity;
pub use backend::PersistentStorageProvider;
pub use backend::PersistentStorageSession;
pub use backend::StorageBackendError;
pub use backend::StorageBackendResult;
pub use backend::StorageSavepointId;
pub use backend::StorageSessionAffinity;
pub use backend::StorageSessionMismatch;
pub use backend::StorageTransactionModel;
pub use block_max_index::BlockMaxIndex;
pub use block_max_index::BlockMaxScorer;
pub use block_max_index::DEFAULT_BLOCK_SIZE;
pub use btree_index::BTreeIndex;
pub use catalog::sequence_value_allocation;
pub use catalog::sequence_value_reservation;
pub use catalog::CatalogCacheRevisions;
pub use catalog::CatalogFacade;
pub use catalog::ColumnStatsInput;
pub use catalog::ColumnStatsRow;
pub use catalog::EdgeRow;
pub use catalog::ForeignTableRow;
pub use catalog::GraphEntityFilter;
pub use catalog::GraphEntityKind;
pub use catalog::GraphSnapshot;
pub use catalog::GraphVertexRow;
pub use catalog::RelationKind;
pub use catalog::RelationSecurityRow;
pub use catalog::SchemaRow;
pub use catalog::SequenceLogResult;
pub use catalog::SequenceOptions;
pub use catalog::SequenceReservationResult;
pub use catalog::SequenceRow;
pub use catalog::SequenceSecurityRow;
pub use catalog::SequenceSetValueResult;
pub use catalog::SequenceValueAllocation;
pub use catalog::SequenceValuePosition;
pub use catalog::SequenceValueReservation;
pub use catalog::TableSchema;
pub use catalog::VectorFieldSchema;
pub use catalog::ViewRow;
pub use catalog::MAX_GRAPH_ID_PAGE;
pub use clustered_postings::MaterializedPostingCursor;
pub use clustered_postings::PostingCursor;
pub use clustered_postings::PostingScore;
pub use clustered_postings::POSTING_CLUSTER_DOCS;
pub use document_store::DocumentMetadata;
pub use document_store::DocumentStore;
pub use document_store::MemoryDocumentStore;
pub use document_store::RetainedDocumentFields;
pub use document_store::RetainedDocumentPage;
pub use document_store::RetainedDocumentStore;
pub use document_store::RetainedDocumentStoreBuilder;
pub use document_store::RetainedStoredDocument;
pub use document_store::SharedDocumentRow;
pub use document_store::StoredDocument;
pub use hnsw_index::HNSWIndex;
pub use index_abc::Index;
pub use index_manager::BTreeIndexHandle;
pub use index_manager::IndexManager;
pub use index_types::IndexDef;
pub use index_types::IndexType;
pub use inverted_index::AnalyzerPhase;
pub use inverted_index::InvertedIndex;
pub use inverted_index::MemoryInvertedIndex;
pub use ivf_index::IVFIndex;
pub use ivf_index::IVFState;
pub use key_value::KeyValueBatch;
pub use key_value::KeyValueCatalog;
pub use key_value::KeyValueDocumentStore;
pub use key_value::KeyValueInvertedIndex;
pub use key_value::KeyValueStorageBackend;
pub use key_value::KeyValueStore;
pub use key_value::KeyValueVectorIndex;
pub use key_value::MemoryKeyValueStore;
pub use spatial_index::haversine_distance;
pub use spatial_index::MemorySpatialIndex;
pub use spatial_index::SpatialIndex;
pub use term_key::TokenTermKey;
pub use transaction::InMemoryTransaction;
pub use transaction::Snapshotable;
pub use transaction::TransactionError;
pub use transaction::TxResult;
pub use vector_index::cosine_similarity;
pub use vector_index::HNSWIndexParams;
pub use vector_index::IVFIndexParams;
pub use vector_index::MemoryVectorIndex;
pub use vector_index::VectorIndex;
pub use vector_index::VectorIndexOpenMode;
pub use vector_index::VectorIndexSpec;

Modules§

analyzer_binding
Durable, independently resolved analyzer sides and their field owner.
backend
Persistent storage backend factory.
block_max_index
Per-block maximum score index for Block-Max WAND optimisation.
btree_index
In-memory B-tree index for predicate scans.
catalog
Backend-neutral persistent catalog facade.
catalog_index_keys
Storage preserves opaque SQL expressions; the engine owns their dependencies and rewrites.
clustered_postings
Backend-neutral clustered posting codec and lazy score cursor.
diskann_index
DiskANN numerical and physical primitives. Navigation values are not public retrieval scores.
document_store
Document storage abstraction.
encryption_key
Explicit, non-serializable key propagation between persistent storage owners.
hnsw_index
Hierarchical Navigable Small World vector index.
index_abc
Common contract every index implementation honours.
index_manager
Index manager: registry that creates / drops / looks up indexes.
index_types
Index type definitions for the storage layer.
inverted_index
Inverted index abstraction and an in-memory implementation.
ivf_index
In-memory inverted-file vector index.
key_value
Backend-neutral Key/Value storage.
mvcc
Committed record histories and snapshot retention shared by storage providers.
native_file
Native byte locks and positioned I/O shared by physical coordination adapters. On POSIX, each adapter must keep one process-wide descriptor per coordination file: closing any other descriptor would release that process’s record locks. Callers own local arbitration, lock ordering and cancellation.
notifications
Notification payloads and bounded queue page accounting.
read_control
Query-owned provider reads share allocation limits and cancellation with their consumers.
spatial_index
In-memory spatial index over geographic points.
statistics_maintenance
Durable statistics-maintenance state and evaluated concurrent counter changes.
temporary_file
Ephemeral authenticated byte files with independent reader positions and bounded workspace.
term_key
Canonical binary posting keys for scalar strings and unpaired UTF-16 terms.
transaction
In-memory transaction snapshots and shared transaction errors.
vector_index
Vector index abstraction and an in-memory brute-force fallback.

Structs§

CatalogIndexRow
One row from the secondary-index registry.
FtsIndexStat
ReadOnlySnapshot
Adapt an already captured snapshot to an owned read-only handle without copying its contents. The caller must supply the snapshot selected for its visibility boundary; this adapter does not capture or advance that boundary.
RelationIdentity
Durable identity of a SQL relation.
SchemaAclEntry
One explicit schema ACL path. None on SchemaRow::acl retains the owner-only default privileges of an ordinary newly created schema.
SchemaPrivileges
Grantable privileges carried by one schema ACL path.
SequenceAclEntry
One explicit sequence ACL path. None on SequenceRow::acl retains PostgreSQL’s default owner-only privileges.
SequenceOwner
Stable owner identity for a sequence dependency. Names are deliberately excluded so table and column renames do not require dependency rewrites.
SequencePrivileges
Grantable privileges carried by one sequence ACL path.
TableAclEntry
One explicit table-shaped relation ACL path. Legacy entries without an explicit grantor originate from the relation owner.
TablePrivileges
Grantable privileges carried by one table-shaped relation ACL path.

Enums§

SequenceOwnerDependency
Dependency strength of a sequence owner. Ordinary OWNED BY and SERIAL use an automatic dependency, while an identity column owns its sequence through an internal dependency that cannot be reassigned or dropped directly.
ValueIndexEntry
A stored evaluated key distinguishes an unbuilt index, an absent row and a present SQL NULL. Consumers must not recompute an old expression against a newer routine definition.
ValueIndexKey