Struct PgVectorStoreBuilder 

pub struct PgVectorStoreBuilder { /* private fields */ }

Builder for PgVectorStore.

Implementations

impl PgVectorStoreBuilder

pub fn with_table(self, table: impl Into<String>) -> Self

Override the table name. Defaults to entelix_vectors. Must satisfy SQL-identifier rules ([a-zA-Z_][a-zA-Z0-9_]{0,62}).

pub const fn with_distance(self, distance: DistanceMetric) -> Self

Override the distance metric. Defaults to DistanceMetric::Cosine.

pub const fn with_index_kind(self, kind: IndexKind) -> Self

Override the ANN index kind. Defaults to IndexKind::Hnsw.

pub const fn with_auto_migrate(self, auto: bool) -> Self

Disable the automatic schema bootstrap.

Pass false when the table + extension + indexes are provisioned externally (DBA-managed, IaC, migration pipeline) and the store should consume an existing schema. Defaults to true.

pub fn with_connection_string(self, url: impl Into<String>) -> Self

Connect with a libpq-style connection string. Mutually exclusive with Self::with_pool.

pub fn with_pool(self, pool: PgPool) -> Self

Reuse an existing PgPool. Mutually exclusive with Self::with_connection_string.

pub const fn with_max_connections(self, max: u32) -> Self

Override the pool’s max_connections (when the builder constructs the pool). Ignored when Self::with_pool supplies a pre-built pool.

pub async fn build(self) -> PgVectorStoreResult<PgVectorStore>

Finalize the builder. Connects (or adopts the supplied pool) and runs the schema bootstrap when auto_migrate=true.