Skip to main content

PgvectorAdapter

Struct PgvectorAdapter 

Source
pub struct PgvectorAdapter { /* private fields */ }
Expand description

A search backend that stores and queries vectors via pgvector.

Compile-time availability of the postgres connection depends on the live-db feature flag. Without it, all methods return BackendError::Adapter("live-db feature required").

Implementations§

Source§

impl PgvectorAdapter

Source

pub fn new(table: impl Into<String>) -> Result<Self, BackendError>

Create a new adapter for the given table (stub without live-db).

Only validates the table name; all operational methods will return an error until the live-db feature is enabled.

§Errors

Returns Err if table fails the allowlist regex validation.

Source

pub fn ensure_schema(&mut self, dim: usize) -> Result<(), BackendError>

Create the vector extension and the vectors table if they do not exist.

§Errors

Returns Err when the live-db feature is disabled, or on any postgres::Error.

Source

pub fn ensure_index(&self, lists: u32) -> Result<(), BackendError>

Create an approximate nearest-neighbour index on the embedding column.

lists controls the number of IVFFlat lists. If 0, defaults to 100.

§Errors

Returns Err when the live-db feature is disabled, or on any postgres::Error.

Source

pub fn table(&self) -> &str

The table name used by this adapter.

Trait Implementations§

Source§

impl SearchBackend for PgvectorAdapter

Source§

fn ingest( &mut self, vectors: &[(VectorId, Vec<f32>)], ) -> Result<(), BackendError>

Store the supplied (VectorId, Vec<f32>) pairs. Read more
Source§

fn search( &self, query: &[f32], top_k: usize, ) -> Result<Vec<SearchResult>, BackendError>

Return the top_k nearest vectors to query by cosine similarity, sorted descending. Read more
Source§

fn remove(&mut self, vector_ids: &[VectorId]) -> Result<(), BackendError>

Remove vectors by id. Read more
Source§

fn len(&self) -> usize

Number of vectors currently stored.
Source§

fn dim(&self) -> Option<usize>

The locked dimension, or None if no vectors have been ingested yet.
Source§

fn is_empty(&self) -> bool

Returns true if no vectors are stored.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V