---
url: >-
  https://adk.nht.io/api/batteries/vector/couchbase/interfaces/CouchbaseVectorStoreOptions.md
description: Shared base options every adapter extends with its own connection block.
---

# Interface: CouchbaseVectorStoreOptions

Defined in: [batteries/vector/couchbase/index.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/couchbase/index.ts#L100)

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`                | { `bucket`: `string`; `collectionPrefix?`: `string`; `password`: `string`; `scope?`: `string`; `url`: `string`; `username`: `string`; } | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | -                                                                                                                                                                                                                                                   | [batteries/vector/couchbase/index.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/couchbase/index.ts#L101) |
| `connection.bucket`                                          | `string`                                                                                                                                  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | -                                                                                                                                                                                                                                                   | [batteries/vector/couchbase/index.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/couchbase/index.ts#L105) |
| `connection.collectionPrefix?`                               | `string`                                                                                                                                  | When 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](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/couchbase/index.ts#L113) |
| `connection.password`                                        | `string`                                                                                                                                  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | -                                                                                                                                                                                                                                                   | [batteries/vector/couchbase/index.ts:104](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/couchbase/index.ts#L104) |
| `connection.scope?`                                          | `string`                                                                                                                                  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | -                                                                                                                                                                                                                                                   | [batteries/vector/couchbase/index.ts:106](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/couchbase/index.ts#L106) |
| `connection.url`                                             | `string`                                                                                                                                  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | -                                                                                                                                                                                                                                                   | [batteries/vector/couchbase/index.ts:102](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/couchbase/index.ts#L102) |
| `connection.username`                                        | `string`                                                                                                                                  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | -                                                                                                                                                                                                                                                   | [batteries/vector/couchbase/index.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/couchbase/index.ts#L103) |
|  `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)                       |