Skip to content
1 min read · 294 words

Interface: MongoDBVectorStoreOptions

Defined in: src/batteries/vector/mongodb/index.ts:42

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

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
connection{ collectionPrefix?: string; database?: string; url: string; }Connection and authentication parameters for the backend.-src/batteries/vector/mongodb/index.ts:44
connection.collectionPrefix?stringWhen set, the physical MongoDB 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 Atlas vectorSearch index builds asynchronously, so a fresh collection per use avoids drop+rebuild churn.-src/batteries/vector/mongodb/index.ts:53
connection.database?string--src/batteries/vector/mongodb/index.ts:46
connection.urlstring--src/batteries/vector/mongodb/index.ts:45
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