pub struct PgVectorAdapter { /* private fields */ }Expand description
Vector database backed by PostgreSQL + pgvector extension.
Requires a PostgreSQL instance with the vector extension installed (the
adapter will attempt CREATE EXTENSION IF NOT EXISTS vector on startup).
Implementations§
Source§impl PgVectorAdapter
impl PgVectorAdapter
Sourcepub async fn new(
database_url: &str,
dimension: usize,
) -> Result<PgVectorAdapter, VectorDBError>
pub async fn new( database_url: &str, dimension: usize, ) -> Result<PgVectorAdapter, VectorDBError>
Connect to an existing PostgreSQL database and run pgvector migrations.
The database must already exist. Use Self::from_connection to share
a connection that was established elsewhere (e.g. by the database crate).
§Arguments
database_url— Postgres connection string, e.g.postgres://user:pass@localhost:5432/mydbdimension— default vector dimension (e.g. 384 for BGE-Small)
Sourcepub async fn from_connection(
db: DatabaseConnection,
dimension: usize,
) -> Result<PgVectorAdapter, VectorDBError>
pub async fn from_connection( db: DatabaseConnection, dimension: usize, ) -> Result<PgVectorAdapter, VectorDBError>
Wrap an existing SeaORM DatabaseConnection (must be Postgres).
The caller is responsible for ensuring the database already exists (the connection proves it does). Only the pgvector extension and bookkeeping table are created if missing.
Trait Implementations§
Source§impl VectorDB for PgVectorAdapter
impl VectorDB for PgVectorAdapter
Source§fn create_collection<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
data_type: &'life1 str,
field_name: &'life2 str,
dimension: usize,
) -> Pin<Box<dyn Future<Output = Result<(), VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
PgVectorAdapter: 'async_trait,
fn create_collection<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
data_type: &'life1 str,
field_name: &'life2 str,
dimension: usize,
) -> Pin<Box<dyn Future<Output = Result<(), VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
PgVectorAdapter: 'async_trait,
Create a collection for (data_type, field_name) pair Read more
Source§fn has_collection<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
data_type: &'life1 str,
field_name: &'life2 str,
) -> Pin<Box<dyn Future<Output = Result<bool, VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
PgVectorAdapter: 'async_trait,
fn has_collection<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
data_type: &'life1 str,
field_name: &'life2 str,
) -> Pin<Box<dyn Future<Output = Result<bool, VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
PgVectorAdapter: 'async_trait,
Check if collection exists Read more
Source§fn index_points<'life0, 'life1, 'life2, 'life3, 'async_trait>(
&'life0 self,
data_type: &'life1 str,
field_name: &'life2 str,
points: &'life3 [VectorPoint],
) -> Pin<Box<dyn Future<Output = Result<(), VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
PgVectorAdapter: 'async_trait,
fn index_points<'life0, 'life1, 'life2, 'life3, 'async_trait>(
&'life0 self,
data_type: &'life1 str,
field_name: &'life2 str,
points: &'life3 [VectorPoint],
) -> Pin<Box<dyn Future<Output = Result<(), VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
PgVectorAdapter: 'async_trait,
Index data points (batch upsert with embeddings already generated) Read more
Source§fn search_similar<'life0, 'life1, 'life2, 'life3, 'async_trait>(
&'life0 self,
data_type: &'life1 str,
field_name: &'life2 str,
query_vector: &'life3 [f32],
top_k: usize,
) -> Pin<Box<dyn Future<Output = Result<Vec<SearchResult>, VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
PgVectorAdapter: 'async_trait,
fn search_similar<'life0, 'life1, 'life2, 'life3, 'async_trait>(
&'life0 self,
data_type: &'life1 str,
field_name: &'life2 str,
query_vector: &'life3 [f32],
top_k: usize,
) -> Pin<Box<dyn Future<Output = Result<Vec<SearchResult>, VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
PgVectorAdapter: 'async_trait,
Search for similar vectors Read more
Source§fn delete_collection<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
data_type: &'life1 str,
field_name: &'life2 str,
) -> Pin<Box<dyn Future<Output = Result<(), VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
PgVectorAdapter: 'async_trait,
fn delete_collection<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
data_type: &'life1 str,
field_name: &'life2 str,
) -> Pin<Box<dyn Future<Output = Result<(), VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
PgVectorAdapter: 'async_trait,
Delete collection
Source§fn delete_points<'life0, 'life1, 'life2, 'life3, 'async_trait>(
&'life0 self,
data_type: &'life1 str,
field_name: &'life2 str,
point_ids: &'life3 [Uuid],
) -> Pin<Box<dyn Future<Output = Result<(), VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
PgVectorAdapter: 'async_trait,
fn delete_points<'life0, 'life1, 'life2, 'life3, 'async_trait>(
&'life0 self,
data_type: &'life1 str,
field_name: &'life2 str,
point_ids: &'life3 [Uuid],
) -> Pin<Box<dyn Future<Output = Result<(), VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
PgVectorAdapter: 'async_trait,
Delete points by IDs from an existing collection.
Source§fn collection_size<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
data_type: &'life1 str,
field_name: &'life2 str,
) -> Pin<Box<dyn Future<Output = Result<usize, VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
PgVectorAdapter: 'async_trait,
fn collection_size<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
data_type: &'life1 str,
field_name: &'life2 str,
) -> Pin<Box<dyn Future<Output = Result<usize, VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
PgVectorAdapter: 'async_trait,
Get collection statistics
Source§fn list_collections<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<Vec<(String, String)>, VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
PgVectorAdapter: 'async_trait,
fn list_collections<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<Vec<(String, String)>, VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
PgVectorAdapter: 'async_trait,
List all existing vector collections as
(data_type, field_name) pairs. Read moreSource§fn prune<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<(), VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
Self: 'async_trait,
fn prune<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<(), VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
Self: 'async_trait,
Remove all vector collections. Read more
Source§fn batch_search_similar<'life0, 'life1, 'life2, 'life3, 'async_trait>(
&'life0 self,
data_type: &'life1 str,
field_name: &'life2 str,
query_vectors: &'life3 [Vec<f32>],
top_k: usize,
) -> Pin<Box<dyn Future<Output = Result<Vec<Vec<SearchResult>>, VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
Self: 'async_trait,
fn batch_search_similar<'life0, 'life1, 'life2, 'life3, 'async_trait>(
&'life0 self,
data_type: &'life1 str,
field_name: &'life2 str,
query_vectors: &'life3 [Vec<f32>],
top_k: usize,
) -> Pin<Box<dyn Future<Output = Result<Vec<Vec<SearchResult>>, VectorDBError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
Self: 'async_trait,
Perform multiple vector similarity searches in sequence. Read more
Auto Trait Implementations§
impl !RefUnwindSafe for PgVectorAdapter
impl !UnwindSafe for PgVectorAdapter
impl Freeze for PgVectorAdapter
impl Send for PgVectorAdapter
impl Sync for PgVectorAdapter
impl Unpin for PgVectorAdapter
impl UnsafeUnpin for PgVectorAdapter
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> FutureExt for T
impl<T> FutureExt for T
Source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
Source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::RequestSource§impl<T, U, C> IntoWithContext<U, C> for Twhere
U: FromWithContext<T, C>,
impl<T, U, C> IntoWithContext<U, C> for Twhere
U: FromWithContext<T, C>,
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref() only in debug builds, and is erased in release
builds.