Skip to content
1 min read · 282 words

Interface: CouchbaseVectorStoreOptions

Defined in: batteries/vector/couchbase/index.ts:100

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

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
connection{ bucket: string; collectionPrefix?: string; password: string; scope?: string; url: string; username: string; }--batteries/vector/couchbase/index.ts:101
connection.bucketstring--batteries/vector/couchbase/index.ts:105
connection.collectionPrefix?stringWhen set, the physical Couchbase collection becomes ${collectionPrefix}${collection}. The logical collection the builder/base see is unchanged. Lets callers (and the test suite) isolate otherwise identically-named collections — useful because the scoped FTS vector index builds asynchronously, so a fresh collection per use avoids drop+rebuild-index churn.-batteries/vector/couchbase/index.ts:113
connection.passwordstring--batteries/vector/couchbase/index.ts:104
connection.scope?string--batteries/vector/couchbase/index.ts:106
connection.urlstring--batteries/vector/couchbase/index.ts:102
connection.usernamestring--batteries/vector/couchbase/index.ts:103
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.consistencybatteries/vector/types.ts:106
defaultCollection?string-BaseVectorStoreOptions.defaultCollectionbatteries/vector/types.ts:99
dimensions?number-BaseVectorStoreOptions.dimensionsbatteries/vector/types.ts:98
encoder?VectorEncoderFn-BaseVectorStoreOptions.encoderbatteries/vector/types.ts:97
metric?DistanceMetric-BaseVectorStoreOptions.metricbatteries/vector/types.ts:96