docs/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-couchbase.md

type	title	linkTitle	description	aliases
docs	Couchbase	Couchbase	Detailed information on the Couchbase state store component	/operations/components/setup-state-store/supported-state-stores/setup-couchbase/

Component format

To setup Couchbase state store create a component of type state.couchbase. See [this guide]({{% ref "howto-get-save-state.md#step-1-setup-a-state-store" %}}) on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: <NAME>
spec:
  type: state.couchbase
  version: v1
  metadata:
  - name: couchbaseURL
    value: <REPLACE-WITH-URL> # Required. Example: "http://localhost:8091"
  - name: username
    value: <REPLACE-WITH-USERNAME> # Required.
  - name: password
    value: <REPLACE-WITH-PASSWORD> # Required.
  - name: bucketName
    value: <REPLACE-WITH-BUCKET> # Required.

{{% alert title="Warning" color="warning" %}} The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described [here]({{% ref component-secrets.md %}}). {{% /alert %}}

Spec metadata fields

Field	Required	Details	Example
couchbaseURL	Y	The URL of the Couchbase server	"http://localhost:8091"
username	Y	The username for the database	"user"
password	Y	The password for access	"password"
bucketName	Y	The bucket name to write to	"bucket"

Setup Couchbase

{{< tabpane text=true >}}

{{% tab "Self-Hosted" %}} You can run Couchbase locally using Docker:

docker run -d --name db -p 8091-8094:8091-8094 -p 11210:11210 couchbase

You can then interact with the server using localhost:8091 and start the server setup. {{% /tab %}}

{{% tab "Kubernetes" %}} The easiest way to install Couchbase on Kubernetes is by using the Helm chart:

helm repo add couchbase https://couchbase-partners.github.io/helm-charts/
helm install couchbase/couchbase-operator
helm install couchbase/couchbase-cluster

{{% /tab %}}

{{< /tabpane >}}

Related links

• [Basic schema for a Dapr component]({{% ref component-schema %}})
• Read [this guide]({{% ref "howto-get-save-state.md#step-2-save-and-retrieve-a-single-state" %}}) for instructions on configuring state store components
• [State management building block]({{% ref state-management %}})