Interface: SurrealDBVectorStoreOptions

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

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

Extends

• BaseVectorStoreOptions

Properties

Property	Type	Description	Inherited from	Defined in
connection	{ database?: string; namespace?: string; password?: string; url: string; username?: string; }	Connection and authentication parameters for the backend.	-	src/batteries/vector/surrealdb/index.ts:36
connection.database?	string	-	-	src/batteries/vector/surrealdb/index.ts:41
connection.namespace?	string	-	-	src/batteries/vector/surrealdb/index.ts:40
connection.password?	string	-	-	src/batteries/vector/surrealdb/index.ts:39
connection.url	string	-	-	src/batteries/vector/surrealdb/index.ts:37
connection.username?	string	-	-	src/batteries/vector/surrealdb/index.ts:38
consistency?	VectorConsistency	Store-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.consistency	src/batteries/vector/types.ts:129
defaultCollection?	string	Collection name used when a call omits an explicit one.	BaseVectorStoreOptions.defaultCollection	src/batteries/vector/types.ts:122
dimensions?	number	Embedding dimensionality. Required by backends that must declare it at collection-creation time.	BaseVectorStoreOptions.dimensions	src/batteries/vector/types.ts:120
encoder?	VectorEncoderFn	Function that turns text into vectors. Required unless the backend has built-in encoding.	BaseVectorStoreOptions.encoder	src/batteries/vector/types.ts:118
metric?	DistanceMetric	Distance metric used for similarity (e.g. cosine, euclidean, dot). Defaults to the adapter's preferred metric.	BaseVectorStoreOptions.metric	src/batteries/vector/types.ts:116