Skip to content
1 min read · 225 words

Interface: SurrealDBVectorStoreOptions

Defined in: batteries/vector/surrealdb/index.ts:34

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

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
connection{ database?: string; namespace?: string; password?: string; url: string; username?: string; }--batteries/vector/surrealdb/index.ts:35
connection.database?string--batteries/vector/surrealdb/index.ts:40
connection.namespace?string--batteries/vector/surrealdb/index.ts:39
connection.password?string--batteries/vector/surrealdb/index.ts:38
connection.urlstring--batteries/vector/surrealdb/index.ts:36
connection.username?string--batteries/vector/surrealdb/index.ts:37
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