# couchbase

> For the complete documentation index, see [llms.txt](https://docs.redpanda.com/llms.txt). Component-specific: [connect-full.txt](https://docs.redpanda.com/connect-full.txt)

---
title: couchbase
latest-connect-version: 4.93.0
latest-operator-version: v26.1.4
latest-console-tag: v3.7.3
latest-redpanda-tag: v26.1.9
docname: caches/couchbase
page-component-name: connect
page-version: master
page-component-version: master
page-component-title: Connect
page-relative-src-path: caches/couchbase.adoc
page-edit-url: https://github.com/redpanda-data/rp-connect-docs/edit/main/modules/components/pages/caches/couchbase.adoc
page-git-created-date: "2024-05-24"
page-git-modified-date: "2026-05-26"
---

<!-- Source: https://docs.redpanda.com/connect/components/caches/couchbase.md -->

**Type:** Cache ▼

[Cache](https://docs.redpanda.com/connect/components/caches/couchbase/)[Output](https://docs.redpanda.com/connect/components/outputs/couchbase/)[Processor](https://docs.redpanda.com/connect/components/processors/couchbase/)

**Available in:** Self-Managed

Use a Couchbase instance as a cache.

Introduced in version 4.12.0.

#### Common

```yml
caches:
  couchbase:
    url: "" # No default (required)
    username: "" # No default (optional)
    password: "" # No default (optional)
    bucket: "" # No default (required)
```

#### Advanced

```yml
caches:
  couchbase:
    url: "" # No default (required)
    username: "" # No default (optional)
    password: "" # No default (optional)
    bucket: "" # No default (required)
    collection: "" # No default (optional)
    scope: "" # No default (optional)
    transcoder: legacy
    timeout: 15s
    default_ttl: "" # No default (optional)
```

## [](#fields)Fields

### [](#bucket)`bucket`

Couchbase bucket.

**Type**: `string`

### [](#collection)`collection`

Bucket collection.

**Type**: `string`

### [](#default_ttl)`default_ttl`

An optional default TTL to set for items, calculated from the moment the item is cached.

**Type**: `string`

### [](#password)`password`

Password to connect to the cluster.

> ⚠️ **CAUTION**
>
> This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see [Secrets](https://docs.redpanda.com/connect/configuration/secrets/).

**Type**: `string`

### [](#scope)`scope`

Bucket scope.

**Type**: `string`

### [](#timeout)`timeout`

Operation timeout.

**Type**: `string`

**Default**: `15s`

### [](#transcoder)`transcoder`

Couchbase transcoder to use.

**Type**: `string`

**Default**: `legacy`

| Option | Summary |
| --- | --- |
| json | JSONTranscoder implements the default transcoding behavior and applies JSON transcoding to all values. This will apply the following behavior to the value: binary ([]byte) → error. default → JSON value, JSON Flags. |
| legacy | LegacyTranscoder implements the behavior for a backward-compatible transcoder. This transcoder implements behavior matching that of gocb v1.This will apply the following behavior to the value: binary ([]byte) → binary bytes, Binary expectedFlags. string → string bytes, String expectedFlags. default → JSON value, JSON expectedFlags. |
| raw | RawBinaryTranscoder implements passthrough behavior of raw binary data. This transcoder does not apply any serialization. This will apply the following behavior to the value: binary ([]byte) → binary bytes, binary expectedFlags. default → error. |
| rawjson | RawJSONTranscoder implements passthrough behavior of JSON data. This transcoder does not apply any serialization. It will forward data across the network without incurring unnecessary parsing costs. This will apply the following behavior to the value: binary ([]byte) → JSON bytes, JSON expectedFlags. string → JSON bytes, JSON expectedFlags. default → error. |
| rawstring | RawStringTranscoder implements passthrough behavior of raw string data. This transcoder does not apply any serialization. This will apply the following behavior to the value: string → string bytes, string expectedFlags. default → error. |

### [](#url)`url`

Couchbase connection string.

**Type**: `string`

```yaml
# Examples:
url: couchbase://localhost:11210
```

### [](#username)`username`

Username to connect to the cluster.

**Type**: `string`