Skip to content
1 min read · 225 words

Interface: DuckDBVectorStoreOptions

Defined in: src/batteries/vector/duckdb/index.ts:36

Shared base options every adapter extends with its own connection block.

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
connection?{ path?: string; }Connection and authentication parameters for the backend.-src/batteries/vector/duckdb/index.ts:38
connection.path?string--src/batteries/vector/duckdb/index.ts:38
consistency?VectorConsistencyStore-wide read-after-write guarantee for writes. Overrides the adapter's declared VectorStoreCapabilities.consistency default; a per-operation .consistency() on the builder overrides this in turn (precedence: per-op > store option > adapter default). Ignored by strongly-consistent adapters. See VectorConsistency.BaseVectorStoreOptions.consistencysrc/batteries/vector/types.ts:129
defaultCollection?stringCollection name used when a call omits an explicit one.BaseVectorStoreOptions.defaultCollectionsrc/batteries/vector/types.ts:122
dimensions?numberEmbedding dimensionality. Required by backends that must declare it at collection-creation time.BaseVectorStoreOptions.dimensionssrc/batteries/vector/types.ts:120
encoder?VectorEncoderFnFunction that turns text into vectors. Required unless the backend has built-in encoding.BaseVectorStoreOptions.encodersrc/batteries/vector/types.ts:118
metric?DistanceMetricDistance metric used for similarity (e.g. cosine, euclidean, dot). Defaults to the adapter's preferred metric.BaseVectorStoreOptions.metricsrc/batteries/vector/types.ts:116