--- url: >- https://adk.nht.io/api/batteries/vector/surrealdb/interfaces/SurrealDBVectorStoreOptions.md description: Shared base options every adapter extends with its own connection block. --- # Interface: SurrealDBVectorStoreOptions Defined in: [batteries/vector/surrealdb/index.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/surrealdb/index.ts#L34) Shared base options every adapter extends with its own connection block. ## Extends * [`BaseVectorStoreOptions`](../../../../@nhtio/adk/batteries/vector/types/interfaces/BaseVectorStoreOptions.md) ## Properties | Property | Type | Description | Inherited from | Defined in | | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | `connection` | { `database?`: `string`; `namespace?`: `string`; `password?`: `string`; `url`: `string`; `username?`: `string`; } | - | - | [batteries/vector/surrealdb/index.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/surrealdb/index.ts#L35) | | `connection.database?` | `string` | - | - | [batteries/vector/surrealdb/index.ts:40](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/surrealdb/index.ts#L40) | | `connection.namespace?` | `string` | - | - | [batteries/vector/surrealdb/index.ts:39](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/surrealdb/index.ts#L39) | | `connection.password?` | `string` | - | - | [batteries/vector/surrealdb/index.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/surrealdb/index.ts#L38) | | `connection.url` | `string` | - | - | [batteries/vector/surrealdb/index.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/surrealdb/index.ts#L36) | | `connection.username?` | `string` | - | - | [batteries/vector/surrealdb/index.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/surrealdb/index.ts#L37) | | `consistency?` | [`VectorConsistency`](../../../../@nhtio/adk/batteries/vector/types/type-aliases/VectorConsistency.md) | Store-wide read-after-write guarantee for writes. Overrides the adapter's declared [VectorStoreCapabilities.consistency](../../../../@nhtio/adk/batteries/vector/types/interfaces/VectorStoreCapabilities.md#property-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](../../../../@nhtio/adk/batteries/vector/types/type-aliases/VectorConsistency.md). | [`BaseVectorStoreOptions`](../../../../@nhtio/adk/batteries/vector/types/interfaces/BaseVectorStoreOptions.md).[`consistency`](../../../../@nhtio/adk/batteries/vector/types/interfaces/BaseVectorStoreOptions.md#property-consistency) | [batteries/vector/types.ts:106](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/types.ts#L106) | | `defaultCollection?` | `string` | - | [`BaseVectorStoreOptions`](../../../../@nhtio/adk/batteries/vector/types/interfaces/BaseVectorStoreOptions.md).[`defaultCollection`](../../../../@nhtio/adk/batteries/vector/types/interfaces/BaseVectorStoreOptions.md#property-defaultcollection) | [batteries/vector/types.ts:99](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/types.ts#L99) | | `dimensions?` | `number` | - | [`BaseVectorStoreOptions`](../../../../@nhtio/adk/batteries/vector/types/interfaces/BaseVectorStoreOptions.md).[`dimensions`](../../../../@nhtio/adk/batteries/vector/types/interfaces/BaseVectorStoreOptions.md#property-dimensions) | [batteries/vector/types.ts:98](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/types.ts#L98) | | `encoder?` | [`VectorEncoderFn`](../../../../@nhtio/adk/batteries/vector/types/type-aliases/VectorEncoderFn.md) | - | [`BaseVectorStoreOptions`](../../../../@nhtio/adk/batteries/vector/types/interfaces/BaseVectorStoreOptions.md).[`encoder`](../../../../@nhtio/adk/batteries/vector/types/interfaces/BaseVectorStoreOptions.md#property-encoder) | [batteries/vector/types.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/types.ts#L97) | | `metric?` | [`DistanceMetric`](../../../../@nhtio/adk/batteries/vector/types/type-aliases/DistanceMetric.md) | - | [`BaseVectorStoreOptions`](../../../../@nhtio/adk/batteries/vector/types/interfaces/BaseVectorStoreOptions.md).[`metric`](../../../../@nhtio/adk/batteries/vector/types/interfaces/BaseVectorStoreOptions.md#property-metric) | [batteries/vector/types.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/types.ts#L96) |