entelix-memory-pgvector 0.5.5

entelix concrete VectorStore — sqlx + pgvector extension backend
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

//! # entelix-memory-pgvector
//!
//! Concrete [`entelix_memory::VectorStore`] implementation backed by
//! Postgres + the pgvector extension.
//!
//! Companion to the trait-only [`entelix_memory`] crate:
//! sqlx + pgvector specifics live here so users who plug their own
//! `VectorStore` pay nothing in compile time.
//!
//! ## One-call setup
//!
//! ```ignore
//! use entelix_memory_pgvector::{DistanceMetric, IndexKind, PgVectorStore};
//!
//! let store = PgVectorStore::builder(1536)
//!     .with_connection_string("postgres://localhost/entelix")
//!     .with_distance(DistanceMetric::Cosine)
//!     .with_index_kind(IndexKind::Hnsw)
//!     .build()
//!     .await?;
//! ```
//!
//! ## Multi-tenancy
//!
//! Single-table design with a composite `(namespace_key, doc_id)`
//! primary key. Every read / write / count / list rides a
//! `WHERE namespace_key = $1` anchor — invariant 11 / F2 demand
//! structural tenant isolation, and the composite PK doubles as
//! the B-tree index that anchor relies on.
//!
//! ## Schema-as-code escape hatch
//!
//! Operators that own the schema externally (DBA-managed, IaC,
//! migration pipeline) call [`PgVectorStoreBuilder::with_auto_migrate`]
//! with `false` — the builder
//! skips extension creation, table creation, and index
//! provisioning, trusting the operator to have stamped them.

#![cfg_attr(docsrs, feature(doc_cfg))]
#![doc(html_root_url = "https://docs.rs/entelix-memory-pgvector/0.5.3")]
#![deny(missing_docs)]
// `Postgres`, `pgvector` ride through doc strings as vendor names.
// `pub(crate)` items inside private modules are the canonical
// crate-internal helper pattern.
#![allow(
    clippy::doc_markdown,
    clippy::redundant_pub_crate,
    clippy::cast_precision_loss,
    clippy::cast_possible_truncation,
    clippy::cast_possible_wrap,
    clippy::cast_sign_loss,
    clippy::redundant_closure_for_method_calls,
    clippy::missing_const_for_fn,
    clippy::expect_used
)]

mod error;
mod filter;
mod migration;
mod store;
mod tenant;

pub use error::{PgVectorStoreError, PgVectorStoreResult};
pub use store::{DistanceMetric, IndexKind, PgVectorStore, PgVectorStoreBuilder};