State store component specs on Dapr Docs

Aerospike

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Aerospike state store create a component of type state.Aerospike. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.Aerospike
 version: v1
 metadata:
 - name: hosts
 value: <REPLACE-WITH-HOSTS> # Required. A comma delimited string of hosts. Example: "aerospike:3000,aerospike2:3000"
 - name: namespace
 value: <REPLACE-WITH-NAMESPACE> # Required. The aerospike namespace.
 - name: set
 value: <REPLACE-WITH-SET> # Optional

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
hosts	Y	Host name/port of database server	`"localhost:3000"`, `"aerospike:3000,aerospike2:3000"`
namespace	Y	The Aerospike namespace	`"namespace"`
set	N	The setName in the database	`"myset"`

Setup Aerospike

You can run Aerospike locally using Docker:

Alibaba Cloud TableStore

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To set up an Alibaba Cloud TableStore state store, create a component of type state.alicloud.tablestore. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.alicloud.tablestore
 version: v1
 metadata:
 - name: endpoint
 value: <REPLACE-WITH-ENDPOINT>
 - name: instanceName
 value: <REPLACE-WITH-INSTANCE-NAME>
 - name: tableName
 value: <REPLACE-WITH-TABLE-NAME>
 - name: accessKeyID
 value: <REPLACE-WITH-ACCESS-KEY-ID>
 - name: accessKey
 value: <REPLACE-WITH-ACCESS-KEY>

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
`endpoint`	Y	The endpoint of the Alibaba Cloud TableStore instance	`"https://tablestore.aliyuncs.com"`
`instanceName`	Y	The name of the Alibaba Cloud TableStore instance	`"my_instance"`
`tableName`	Y	The name of the table to use for Dapr state. Will be created if it does not exist	`"my_table"`
`accessKeyID`	Y	The access key ID for authentication	`"my_access_key_id"`
`accessKey`	Y	The access key for authentication	`"my_access_key"`

Authentication

Alibaba Cloud TableStore supports authentication using an Access Key and Access Key ID.

AWS DynamoDB

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup a DynamoDB state store create a component of type state.aws.dynamodb. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.aws.dynamodb
 version: v1
 metadata:
 - name: table
 value: "Contracts"
 - name: accessKey
 value: "AKIAIOSFODNN7EXAMPLE" # Optional
 - name: secretKey
 value: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" # Optional
 - name: endpoint
 value: "http://localhost:8080" # Optional
 - name: region
 value: "eu-west-1" # Optional
 - name: sessionToken
 value: "myTOKEN" # Optional
 - name: ttlAttributeName
 value: "expiresAt" # Optional
 - name: ttlInSeconds
 value: <int> # Optional
 - name: partitionKey
 value: "ContractID" # Optional
 # Uncomment this if you wish to use AWS DynamoDB as a state store for actors (optional)
 #- name: actorStateStore
 # value: "true"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Primary Key

In order to use DynamoDB as a Dapr state store, the table must have a primary key named key. See the section Partition Keys for an option to change this behavior.

Azure Blob Storage

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup the Azure Blob Storage state store create a component of type state.azure.blobstorage. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.azure.blobstorage
 # Supports v1 and v2. Users should always use v2 by default. There is no
 # migration path from v1 to v2, see `versioning` below.
 version: v2
 metadata:
 - name: accountName
 value: "[your_account_name]"
 - name: accountKey
 value: "[your_account_key]"
 - name: containerName
 value: "[your_container_name]"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Versioning

Dapr has 2 versions of the Azure Blob Storage state store component: v1 and v2. It is recommended to use v2 for all new applications. v1 is considered legacy and is preserved for compatibility with existing applications only.

Azure Cosmos DB (SQL API)

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Azure Cosmos DB state store create a component of type state.azure.cosmosdb. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.azure.cosmosdb
 version: v1
 metadata:
 - name: url
 value: <REPLACE-WITH-URL>
 - name: masterKey
 value: <REPLACE-WITH-MASTER-KEY>
 - name: database
 value: <REPLACE-WITH-DATABASE>
 - name: collection
 value: <REPLACE-WITH-COLLECTION>
 # Uncomment this if you wish to use Azure Cosmos DB as a state store for actors (optional)
 #- name: actorStateStore
 # value: "true"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

If you wish to use Cosmos DB as an actor store, append the following to the yaml.

Azure Table Storage

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Azure Tablestorage state store create a component of type state.azure.tablestorage. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.azure.tablestorage
 version: v1
 metadata:
 - name: accountName
 value: <REPLACE-WITH-ACCOUNT-NAME>
 - name: accountKey
 value: <REPLACE-WITH-ACCOUNT-KEY>
 - name: tableName
 value: <REPLACE-WITH-TABLE-NAME>
# - name: cosmosDbMode
# value: false

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
`accountName`	Y	The storage account name	`"mystorageaccount"`.
`accountKey`	Y	Primary or secondary storage key	`"key"`
`tableName`	Y	The name of the table to be used for Dapr state. The table will be created for you if it doesn’t exist	`"table"`
`cosmosDbMode`	N	If enabled, connects to Cosmos DB Table API instead of Azure Tables (Storage Accounts). Defaults to `false`.	`"false"`
`serviceURL`	N	The full storage service endpoint URL. Useful for Azure environments other than public cloud.	`"https://mystorageaccount.table.core.windows.net/"`
`skipCreateTable`	N	Skips the check for and, if necessary, creation of the specified storage table. This is useful when using active directory authentication with minimal privileges. Defaults to `false`.	`"true"`

Microsoft Entra ID authentication

The Azure Cosmos DB state store component supports authentication using all Microsoft Entra ID mechanisms. For further information and the relevant component metadata fields to provide depending on the choice of Microsoft Entra ID authentication mechanism, see the docs for authenticating to Azure.

Cassandra

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Cassandra state store create a component of type state.cassandra. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.cassandra
 version: v1
 metadata:
 - name: hosts
 value: <REPLACE-WITH-COMMA-DELIMITED-HOSTS> # Required. Example: cassandra.cassandra.svc.cluster.local
 - name: username
 value: <REPLACE-WITH-PASSWORD> # Optional. default: ""
 - name: password
 value: <REPLACE-WITH-PASSWORD> # Optional. default: ""
 - name: consistency
 value: <REPLACE-WITH-CONSISTENCY> # Optional. default: "All"
 - name: table
 value: <REPLACE-WITH-TABLE> # Optional. default: "items"
 - name: keyspace
 value: <REPLACE-WITH-KEYSPACE> # Optional. default: "dapr"
 - name: protoVersion
 value: <REPLACE-WITH-PROTO-VERSION> # Optional. default: "4"
 - name: replicationFactor
 value: <REPLACE-WITH-REPLICATION-FACTOR> # Optional. default: "1"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
hosts	Y	Comma separated value of the hosts	`"cassandra.cassandra.svc.cluster.local"`.
port	N	Port for communication. Default `"9042"`	`"9042"`
username	Y	The username of database user. No default	`"user"`
password	Y	The password for the user	`"password"`
consistency	N	The consistency values	`"All"`, `"Quorum"`
table	N	Table name. Defaults to `"items"`	`"items"`, `"tab"`
keyspace	N	The cassandra keyspace to use. Defaults to `"dapr"`	`"dapr"`
protoVersion	N	The proto version for the client. Defaults to `"4"`	`"3"`, `"4"`
replicationFactor	N	The replication factor for the calls. Defaults to `"1"`	`"3"`

Setup Cassandra

You can run Cassandra locally with the Datastax Docker image:

Cloudflare Workers KV

Mon, 01 Jan 0001 00:00:00 +0000

Create a Dapr component

To setup a Cloudflare Workers KV state store, create a component of type state.cloudflare.workerskv. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.cloudflare.workerskv
 version: v1
 # Increase the initTimeout if Dapr is managing the Worker for you
 initTimeout: "120s"
 metadata:
 # ID of the Workers KV namespace (required)
 - name: kvNamespaceID
 value: ""
 # Name of the Worker (required)
 - name: workerName
 value: ""
 # PEM-encoded private Ed25519 key (required)
 - name: key
 value: |
 -----BEGIN PRIVATE KEY-----
 MC4CAQ...
 -----END PRIVATE KEY-----
 # Cloudflare account ID (required to have Dapr manage the Worker)
 - name: cfAccountID
 value: ""
 # API token for Cloudflare (required to have Dapr manage the Worker)
 - name: cfAPIToken
 value: ""
 # URL of the Worker (required if the Worker has been pre-created outside of Dapr)
 - name: workerUrl
 value: ""

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
`kvNamespaceID`	Y	ID of the pre-created Workers KV namespace	`"123456789abcdef8b5588f3d134f74ac"`
`workerName`	Y	Name of the Worker to connect to	`"mydaprkv"`
`key`	Y	Ed25519 private key, PEM-encoded	See example above
`cfAccountID`	Y/N	Cloudflare account ID. Required to have Dapr manage the worker.	`"456789abcdef8b5588f3d134f74ac"def`
`cfAPIToken`	Y/N	API token for Cloudflare. Required to have Dapr manage the Worker.	`"secret-key"`
`workerUrl`	Y/N	URL of the Worker. Required if the Worker has been pre-provisioned outside of Dapr.	`"https://mydaprkv.mydomain.workers.dev"`

When you configure Dapr to create your Worker for you, you may need to set a longer value for the initTimeout property of the component, to allow enough time for the Worker script to be deployed. For example: initTimeout: "120s"

CockroachDB

Mon, 01 Jan 0001 00:00:00 +0000

Create a Dapr component

Create a file called cockroachdb.yaml, paste the following and replace the <CONNECTION STRING> value with your connection string. The connection string for CockroachDB follow the same standard for PostgreSQL connection string. For example, "host=localhost user=root port=26257 connect_timeout=10 database=dapr_test". See the CockroachDB documentation on database connections for information on how to define a connection string.

If you want to also configure CockroachDB to store actors, add the actorStateStore option as in the example below.

Coherence

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Coherence state store, create a component of type state.coherence. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.coherence
 version: v1
 metadata:
 - name: serverAddress
 value: <REPLACE-WITH-GRPC-PROXY-HOST-AND-PORT> # Required. Example: "my-cluster-grpc:1408"
 - name: tlsEnabled
 value: <REPLACE-WITH-BOOLEAN> # Optional
 - name: tlsClientCertPath
 value: <REPLACE-WITH-PATH> # Optional
 - name: tlsClientKey
 value: <REPLACE-WITH-PATH> # Optional
 - name: tlsCertsPath
 value: <REPLACE-WITH-PATH> # Optional
 - name: ignoreInvalidCerts
 value: <REPLACE-WITH-BOOLEAN> # Optional
 - name: scopeName
 value: <REPLACE-WITH-SCOPE> # Optional
 - name: requestTimeout
 value: <REPLACE-WITH-REQUEST-TIMEOUT> # Optional
 - name: nearCacheTTL
 value: <REPLACE-WITH-NEAR-CACHE-TTL> # Optional
 - name: nearCacheUnits
 value: <REPLACE-WITH-NEAR-CACHE-UNITS> # Optional
 - name: nearCacheMemory
 value: <REPLACE-WITH-NEAR-CACHE-MEMORY> # Optional

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
serverAddress	Y	Comma delimited endpoints	`"my-cluster-grpc:1408"`
tlsEnabled	N	Indicates if TLS should be enabled. Defaults to false	`"true"`
tlsClientCertPath	N	Client certificate path for Coherence. Defaults to “”. Can be `secretKeyRef` to use a secret reference.	`"-----BEGIN CERTIFICATE-----\nMIIC9TCCA..."`
tlsClientKey	N	Client key for Coherence. Defaults to “”. Can be `secretKeyRef` to use a secret reference.	`"-----BEGIN CERTIFICATE-----\nMIIC9TCCA..."`
tlsCertsPath	N	Additional certificates for Coherence. Defaults to “”. Can be `secretKeyRef` to use a secret reference.	`"-----BEGIN CERTIFICATE-----\nMIIC9TCCA..."`
ignoreInvalidCerts	N	Indicates if to ignore self-signed certificates for testing only, not to be used in production. Defaults to false	`"false"`
scopeName	N	A scope name to use for the internal cache. Defaults to ""	`"my-scope"`
requestTimeout	N	ATimeout for calls to the cluster Defaults to “30s”	`"15s"`
nearCacheTTL	N	If non-zero a near cache is used and the TTL of the near cache is this value. Defaults to 0s	`"60s"`
nearCacheUnits	N	If non-zero a near cache is used and the maximum size of the near cache is this value in units. Defaults to 0	`"1000"`
nearCacheMemory	N	If non-zero a near cache is used and the maximum size of the near cache is this value in bytes. Defaults to 0	`"4096"`

About Using Near Cache TTL

The Coherence state store allows you to specify a near cache to cache frequently accessed data when using the DAPR client. When you access data using Get(ctx context.Context, req *GetRequest), returned entries are stored in the near cache and subsequent data access for keys in the near cache is almost instant, where without a near cache each Get() operation results in a network call.

Couchbase

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Couchbase state store create a component of type state.couchbase. See this guide 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.

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

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

You can run Couchbase locally using Docker:

Etcd

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup an Etcd state store create a component of type state.etcd. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.etcd
 # Supports v1 and v2. Users should always use v2 by default. There is no
 # migration path from v1 to v2, see `versioning` below.
 version: v2
 metadata:
 - name: endpoints
 value: <CONNECTION STRING> # Required. Example: 192.168.0.1:2379,192.168.0.2:2379,192.168.0.3:2379
 - name: keyPrefixPath
 value: <KEY PREFIX STRING> # Optional. default: "". Example: "dapr"
 - name: tlsEnable
 value: <ENABLE TLS> # Optional. Example: "false"
 - name: ca
 value: <CA> # Optional. Required if tlsEnable is `true`.
 - name: cert
 value: <CERT> # Optional. Required if tlsEnable is `true`.
 - name: key
 value: <KEY> # Optional. Required if tlsEnable is `true`.
 # Uncomment this if you wish to use Etcd as a state store for actors (optional)
 #- name: actorStateStore
 # value: "true"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Versioning

Dapr has 2 versions of the Etcd state store component: v1 and v2. It is recommended to use v2, as v1 is deprecated.

GCP Firestore (Datastore mode)

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup GCP Firestore state store create a component of type state.gcp.firestore. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.gcp.firestore
 version: v1
 metadata:
 - name: project_id
 value: <REPLACE-WITH-PROJECT-ID> # Required.
 - name: type 
 value: <REPLACE-WITH-CREDENTIALS-TYPE> # Required.
 - name: endpoint # Optional. 
 value: "http://localhost:8432"
 - name: private_key_id
 value: <REPLACE-WITH-PRIVATE-KEY-ID> # Optional.
 - name: private_key
 value: <REPLACE-WITH-PRIVATE-KEY> # Optional, but Required if `private_key_id` is specified.
 - name: client_email
 value: <REPLACE-WITH-CLIENT-EMAIL> # Optional, but Required if `private_key_id` is specified.
 - name: client_id
 value: <REPLACE-WITH-CLIENT-ID> # Optional, but Required if `private_key_id` is specified.
 - name: auth_uri
 value: <REPLACE-WITH-AUTH-URI> # Optional.
 - name: token_uri
 value: <REPLACE-WITH-TOKEN-URI> # Optional.
 - name: auth_provider_x509_cert_url
 value: <REPLACE-WITH-AUTH-X509-CERT-URL> # Optional.
 - name: client_x509_cert_url
 value: <REPLACE-WITH-CLIENT-x509-CERT-URL> # Optional.
 - name: entity_kind
 value: <REPLACE-WITH-ENTITY-KIND> # Optional. default: "DaprState"
 - name: noindex
 value: <REPLACE-WITH-BOOLEAN> # Optional. default: "false"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
project_id	Y	The ID of the GCP project to use	`"project-id"`
type	Y	The credentials type	`"service_account"`
endpoint	N	GCP endpoint for the component to use. Only used for local development with (for example) GCP Datastore Emulator. The `endpoint` is unnecessary when running against the GCP production API.	`"localhost:8432"`
private_key_id	N	The ID of the prvate key to use	`"private-key-id"`
privateKey	N	If using explicit credentials, this field should contain the `private_key` field from the service account json	`-----BEGIN PRIVATE KEY-----MIIBVgIBADANBgkqhkiG9w0B`
client_email	N	The email address for the client	`"eample@example.com"`
client_id	N	The client id value to use for authentication	`"client-id"`
auth_uri	N	The authentication URI to use	`"https://accounts.google.com/o/oauth2/auth"`
token_uri	N	The token URI to query for Auth token	`"https://oauth2.googleapis.com/token"`
auth_provider_x509_cert_url	N	The auth provider certificate URL	`"https://www.googleapis.com/oauth2/v1/certs"`
client_x509_cert_url	N	The client certificate URL	`"https://www.googleapis.com/robot/v1/metadata/x509/x"`
entity_kind	N	The entity name in Filestore. Defaults to `"DaprState"`	`"DaprState"`
noindex	N	Whether to disable indexing of state entities. Use this setting if you encounter Firestore index size limitations. Defaults to `"false"`	`"true"`

GCP Credentials

Since the GCP Firestore component uses the GCP Go Client Libraries, by default it authenticates using Application Default Credentials. This is explained in the Authenticate to GCP Cloud services using client libraries guide.

HashiCorp Consul

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Hashicorp Consul state store create a component of type state.consul. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.consul
 version: v1
 metadata:
 - name: datacenter
 value: <REPLACE-WITH-DATA-CENTER> # Required. Example: dc1
 - name: httpAddr
 value: <REPLACE-WITH-CONSUL-HTTP-ADDRESS> # Required. Example: "consul.default.svc.cluster.local:8500"
 - name: aclToken
 value: <REPLACE-WITH-ACL-TOKEN> # Optional. default: ""
 - name: scheme
 value: <REPLACE-WITH-SCHEME> # Optional. default: "http"
 - name: keyPrefixPath
 value: <REPLACE-WITH-TABLE> # Optional. default: ""

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
datacenter	Y	Datacenter to use	`"dc1"`
httpAddr	Y	Address of the Consul server	`"consul.default.svc.cluster.local:8500"`
aclToken	N	Per Request ACL Token. Default is `""`	`"token"`
scheme	N	Scheme is the URI scheme for the Consul server. Default is `"http"`	`"http"`
keyPrefixPath	N	Key prefix path in Consul. Default is `""`	`"dapr"`

Setup HashiCorp Consul

You can run Consul locally using Docker:

Hazelcast

Mon, 01 Jan 0001 00:00:00 +0000

Create a Dapr component

To setup Hazelcast state store create a component of type state.hazelcast. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.hazelcast
 version: v1
 metadata:
 - name: hazelcastServers
 value: <REPLACE-WITH-HOSTS> # Required. A comma delimited string of servers. Example: "hazelcast:3000,hazelcast2:3000"
 - name: hazelcastMap
 value: <REPLACE-WITH-MAP> # Required. Hazelcast map configuration.

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
hazelcastServers	Y	A comma delimited string of servers	`"hazelcast:3000,hazelcast2:3000"`
hazelcastMap	Y	Hazelcast Map configuration	`"foo-map"`

Setup Hazelcast

You can run Hazelcast locally using Docker:

In-memory

Mon, 01 Jan 0001 00:00:00 +0000

The in-memory state store component maintains state in the Dapr sidecar’s memory. This is primarily meant for development purposes. State is not replicated across multiple sidecars and is lost when the Dapr sidecar is restarted.

Component format

To setup in-memory state store, create a component of type state.in-memory. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.in-memory
 version: v1
 metadata: 
 # Uncomment this if you wish to use In-memory as a state store for actors (optional)
 #- name: actorStateStore
 # value: "true"

Note: While in-memory does not require any specific metadata for the component to work, spec.metadata is a required field.

JetStream KV

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup a JetStream KV state store create a component of type state.jetstream. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.jetstream
 version: v1
 metadata:
 - name: natsURL
 value: "nats://localhost:4222"
 - name: jwt
 value: "eyJhbGciOiJ...6yJV_adQssw5c" # Optional. Used for decentralized JWT authentication
 - name: seedKey
 value: "SUACS34K232O...5Z3POU7BNIL4Y" # Optional. Used for decentralized JWT authentication
 - name: bucket
 value: "<bucketName>"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadatafield

Field	Required	Details	Example
natsURL	Y	NATS server address URL	“`nats://localhost:4222`”
jwt	N	NATS decentralized authentication JWT	“`eyJhbGciOiJ...6yJV_adQssw5c`”
seedKey	N	NATS decentralized authentication seed key	“`SUACS34K232O...5Z3POU7BNIL4Y`”
bucket	Y	JetStream KV bucket name	`"<bucketName>"`

Create a NATS server

You can run a NATS Server with JetStream enabled locally using Docker:

Memcached

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Memcached state store create a component of type state.memcached. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.memcached
 version: v1
 metadata:
 - name: hosts
 value: <REPLACE-WITH-COMMA-DELIMITED-ENDPOINTS> # Required. Example: "memcached.default.svc.cluster.local:11211"
 - name: maxIdleConnections
 value: <REPLACE-WITH-MAX-IDLE-CONNECTIONS> # Optional. default: "2"
 - name: timeout
 value: <REPLACE-WITH-TIMEOUT> # Optional. default: "1000"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
hosts	Y	Comma delimited endpoints	`"memcached.default.svc.cluster.local:11211"`
maxIdleConnections	N	The max number of idle connections. Defaults to `"2"`	`"3"`
timeout	N	The timeout for the calls in milliseconds. Defaults to `"1000"`	`"1000"`

Setup Memcached

You can run Memcached locally using Docker:

Microsoft SQL Server & Azure SQL

Mon, 01 Jan 0001 00:00:00 +0000

Note

This is the v2 of the Sql Server state store component, which supports Dapr workflows. New applications are encouraged to use v2.

The Sql Server v2 state store component is not compatible with the v1 component, and data cannot be migrated between the two components.

There are no plans to deprecate the v1 component.

Component format

This state store component can be used with both Microsoft SQL Server and Azure SQL.

Microsoft SQL Server & Azure SQL

Mon, 01 Jan 0001 00:00:00 +0000

Component format

This state store component can be used with both Microsoft SQL Server and Azure SQL.

To set up this state store, create a component of type state.sqlserver. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.sqlserver
 version: v1
 metadata:
 # Authenticate using SQL Server credentials
 - name: connectionString
 value: |
 Server=myServerName\myInstanceName;Database=myDataBase;User Id=myUsername;Password=myPassword;

 # Authenticate with Microsoft Entra ID (Azure SQL only)
 # "useAzureAD" be set to "true"
 - name: useAzureAD
 value: true
 # Connection string or URL of the Azure SQL database, optionally containing the database
 - name: connectionString
 value: |
 sqlserver://myServerName.database.windows.net:1433?database=myDataBase

 # Other optional fields (listing default values)
 - name: tableName
 value: "state"
 - name: metadataTableName
 value: "dapr_metadata"
 - name: schema
 value: "dbo"
 - name: keyType
 value: "string"
 - name: keyLength
 value: "200"
 - name: indexedProperties
 value: ""
 - name: cleanupIntervalInSeconds
 value: "3600"
 # Uncomment this if you wish to use Microsoft SQL Server as a state store for actors (optional)
 #- name: actorStateStore
 # value: "true"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

If you wish to use SQL server as an actor state store, append the following to the metadata:

MongoDB

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup MongoDB state store create a component of type state.mongodb. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.mongodb
 version: v1
 metadata:
 - name: server
 value: <REPLACE-WITH-SERVER> # Required unless "host" field is set . Example: "server.example.com"
 - name: host
 value: <REPLACE-WITH-HOST> # Required unless "server" field is set . Example: "mongo-mongodb.default.svc.cluster.local:27017"
 - name: username
 value: <REPLACE-WITH-USERNAME> # Optional. Example: "admin"
 - name: password
 value: <REPLACE-WITH-PASSWORD> # Optional.
 - name: databaseName
 value: <REPLACE-WITH-DATABASE-NAME> # Optional. default: "daprStore"
 - name: collectionName
 value: <REPLACE-WITH-COLLECTION-NAME> # Optional. default: "daprCollection"
 - name: writeConcern
 value: <REPLACE-WITH-WRITE-CONCERN> # Optional.
 - name: readConcern
 value: <REPLACE-WITH-READ-CONCERN> # Optional.
 - name: operationTimeout
 value: <REPLACE-WITH-OPERATION-TIMEOUT> # Optional. default: "5s"
 - name: params
 value: <REPLACE-WITH-ADDITIONAL-PARAMETERS> # Optional. Example: "?authSource=daprStore&ssl=true"
 # Uncomment this if you wish to use MongoDB as a state store for actors (optional)
 #- name: actorStateStore
 # value: "true"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Actor state store and transactions support

When using as an actor state store or to leverage transactions, MongoDB must be running in a Replica Set.

MySQL & MariaDB

Mon, 01 Jan 0001 00:00:00 +0000

Component format

The MySQL state store components allows connecting to both MySQL and MariaDB databases. In this document, we refer to “MySQL” to indicate both databases.

To setup MySQL state store create a component of type state.mysql. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.mysql
 version: v1
 metadata:
 - name: connectionString
 value: "<CONNECTION STRING>"
 - name: schemaName
 value: "<SCHEMA NAME>"
 - name: tableName
 value: "<TABLE NAME>"
 - name: timeoutInSeconds
 value: "30"
 - name: pemPath # Required if pemContents not provided. Path to pem file.
 value: "<PEM PATH>"
 - name: pemContents # Required if pemPath not provided. Pem value.
 value: "<PEM CONTENTS>" 
# Uncomment this if you wish to use MySQL & MariaDB as a state store for actors (optional)
 #- name: actorStateStore
 # value: "true"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

If you wish to use MySQL as an actor store, append the following to the yaml.

OCI Object Storage

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup OCI Object Storage state store create a component of type state.oci.objectstorage. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.oci.objectstorage
 version: v1
 metadata:
 - name: instancePrincipalAuthentication
 value: <"true" or "false">  # Optional. default: "false" 
 - name: configFileAuthentication
 value: <"true" or "false">  # Optional. default: "false" . Not used when instancePrincipalAuthentication == "true" 
 - name: configFilePath
 value: <REPLACE-WITH-FULL-QUALIFIED-PATH-OF-CONFIG-FILE>  # Optional. No default. Only used when configFileAuthentication == "true" 
 - name: configFileProfile
 value: <REPLACE-WITH-NAME-OF-PROFILE-IN-CONFIG-FILE> # Optional. default: "DEFAULT" . Only used when configFileAuthentication == "true" 
 - name: tenancyOCID
 value: <REPLACE-WITH-TENANCY-OCID>  # Not used when configFileAuthentication == "true" or instancePrincipalAuthentication == "true" 
 - name: userOCID
 value: <REPLACE-WITH-USER-OCID>  # Not used when configFileAuthentication == "true" or instancePrincipalAuthentication == "true" 
 - name: fingerPrint
 value: <REPLACE-WITH-FINGERPRINT>  # Not used when configFileAuthentication == "true" or instancePrincipalAuthentication == "true" 
 - name: privateKey  # Not used when configFileAuthentication == "true" or instancePrincipalAuthentication == "true" 
 value: |
 -----BEGIN RSA PRIVATE KEY-----
 REPLACE-WITH-PRIVATE-KEY-AS-IN-PEM-FILE
 -----END RSA PRIVATE KEY----- 
 - name: region
 value: <REPLACE-WITH-OCI-REGION>  # Not used when configFileAuthentication == "true" or instancePrincipalAuthentication == "true" 
 - name: bucketName
	 value: <REPLACE-WITH-BUCKET-NAME>
 - name: compartmentOCID
 value: <REPLACE-WITH-COMPARTMENT-OCID>

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
instancePrincipalAuthentication	N	Boolean to indicate whether instance principal based authentication is used. Default: `"false"`	`"true"` or `"false"` .
configFileAuthentication	N	Boolean to indicate whether identity credential details are provided through a configuration file. Default: `"false"` Not required nor used when instancePrincipalAuthentication is true.	`"true"` or `"false"` .
configFilePath	N	Full path name to the OCI configuration file. No default value exists. Not used when instancePrincipalAuthentication is true. Note: the ~/ prefix is not supported.	`"/home/apps/configuration-files/myOCIConfig.txt"`.
configFileProfile	N	Name of profile in configuration file to use. Default: `"DEFAULT"` Not used when instancePrincipalAuthentication is true.	`"DEFAULT"` or `"PRODUCTION"` .
tenancyOCID	Y	The OCI tenancy identifier. Not required nor used when instancePrincipalAuthentication is true.	`"ocid1.tenancy.oc1..aaaaaaaag7c7sljhsdjhsdyuwe723"`.
userOCID	Y	The OCID for an OCI account (this account requires permissions to access OCI Object Storage). Not required nor used when instancePrincipalAuthentication is true.	`"ocid1.user.oc1..aaaaaaaaby4oyyyuqwy7623yuwe76"`
fingerPrint	Y	Fingerprint of the public key. Not required nor used when instancePrincipalAuthentication is true.	`"02:91:6c:49:e2:94:21:15:a7:6b:0e:a7:34:e1:3d:1b"`
privateKey	Y	Private key of the RSA key pair. Not required nor used when instancePrincipalAuthentication is true.	`"MIIEoyuweHAFGFG2727as+7BTwQRAIW4V"`
region	Y	OCI Region. Not required nor used when instancePrincipalAuthentication is true.	`"us-ashburn-1"`
bucketName	Y	Name of the bucket written to and read from (and if necessary created)	`"application-state-store-bucket"`
compartmentOCID	Y	The OCID for the compartment that contains the bucket	`"ocid1.compartment.oc1..aaaaaaaacsssekayyuq7asjh78"`

Setup OCI Object Storage

The OCI Object Storage state store needs to interact with Oracle Cloud Infrastructure. The state store supports two different approaches to authentication. One is based on an identity (a user or service account) and the other is instance principal authentication leveraging the permissions granted to the compute instance running the application workload. Note: Resource Principal Authentication - used for resources that are not instances such as serverless functions - is not currently supported.

Oracle Database

Mon, 01 Jan 0001 00:00:00 +0000

Component format

Create a component properties yaml file, for example called oracle.yaml (but it could be named anything ), paste the following and replace the <CONNECTION STRING> value with your connection string. The connection string is a standard Oracle Database connection string, composed as: "oracle://user/password@host:port/servicename" for example "oracle://demo:demo@localhost:1521/xe".

In case you connect to the database using an Oracle Wallet, you should specify a value for the oracleWalletLocation property, for example: "/home/app/state/Wallet_daprDB/"; this should refer to the local file system directory that contains the file cwallet.sso that is extracted from the Oracle Wallet archive file.

PostgreSQL

Mon, 01 Jan 0001 00:00:00 +0000

Note

This is the v2 of the PostgreSQL state store component, which contains some improvements to performance and reliability. New applications are encouraged to use v2.

The PostgreSQL v2 state store component is not compatible with the v1 component, and data cannot be migrated between the two components. The v2 component does not offer support for state store query APIs.

There are no plans to deprecate the v1 component.

This component allows using PostgreSQL (Postgres) as state store for Dapr, using the “v2” component. See this guide on how to create and apply a state store configuration.

PostgreSQL v1

Mon, 01 Jan 0001 00:00:00 +0000

Note

Starting with Dapr 1.13, you can leverage the PostgreSQL v2 state store component, which contains some improvements to performance and reliability.
The v2 component is not compatible with v1, and data cannot be migrated between the two components. The v2 component does not offer support for state store query APIs.

There are no plans to deprecate the v1 component.

This component allows using PostgreSQL (Postgres) as state store for Dapr, using the “v1” component. See this guide on how to create and apply a state store configuration.

RavenDB

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup RavenDB state store create a component of type state.ravendb. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.ravendb
 version: v1
 metadata:
 - name: serverURL
 value: <REPLACE-WITH-SERVER-URL> # Required. Example: "http://localhost:8080"
 - name: databaseName
 value: <REPLACE-WITH-DATABASE-NAME> # Optional. default: "daprStore"
 - name: certPath
 value: <REPLACE-WITH-CERT-PATH> # Required unless server is insecure.
 - name: keyPath
 value: <REPLACE-WITH-KEY-PATH> # Required unless server is insecure.
 - name: EnableTTL
 value: <REPLACE-WITH-ENABLE-TTL> # Optional. default: "true"
 - name: TTLFrequency
 value: <REPLACE-WITH-TTL-FREQUENCY> # Optional. Example: "15". Default: "60"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
serverURL	Y	URL to RavenDB instance	`"http://localhost:8080"`
databaseName	N	The name of the database to use. Defaults to `"daprStore"`	`"daprStore"`
certPath	N¹	Path to certificate file	`"/path/to/client.certificate.crt"`
keyPath	N¹	Path to key file	`"/path/to/certificate.key"`
EnableTTL	N	Boolean value to enable TTL capability. Defaults to `"true"`	`"true"`
TTLFrequency	N	Frequency in seconds for TTL cleanup. Defaults to `"60"`	`"60"`

^[1] The certPath and keyPath fields are not mandatory if server URL is http. However, if the server URL is https and no certPath and keyPath are present, then Dapr returns an error.

Redis

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Redis state store create a component of type state.redis. See this guide on how to create and apply a state store configuration.

Limitations

Before using Redis and the Transactions API, make sure you’re familiar with Redis limitations regarding transactions.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.redis
 version: v1
 metadata:
 - name: redisHost
 value: <HOST>
 - name: redisPassword # Optional.
 value: <PASSWORD>
 - name: useEntraID
 value: <bool> # Optional. Allowed: true, false.
 - name: enableTLS
 value: <bool> # Optional. Allowed: true, false.
 - name: clientCert
 value: # Optional
 - name: clientKey
 value: # Optional 
 - name: maxRetries
 value: # Optional
 - name: maxRetryBackoff
 value: # Optional
 - name: failover
 value: <bool> # Optional. Allowed: true, false.
 - name: sentinelMasterName
 value: <string> # Optional
 - name: sentinelUsername
 value: # Optional
 - name: sentinelPassword
 value: # Optional
 - name: redeliverInterval
 value: # Optional
 - name: processingTimeout
 value: # Optional
 - name: redisType
 value: # Optional
 - name: redisDB
 value: # Optional
 - name: redisMaxRetries
 value: # Optional
 - name: redisMinRetryInterval
 value: # Optional
 - name: redisMaxRetryInterval
 value: # Optional
 - name: dialTimeout
 value: # Optional
 - name: readTimeout
 value: # Optional
 - name: writeTimeout
 value: # Optional
 - name: poolSize
 value: # Optional
 - name: poolTimeout
 value: # Optional
 - name: maxConnAge
 value: # Optional
 - name: minIdleConns
 value: # Optional
 - name: idleCheckFrequency
 value: # Optional
 - name: idleTimeout
 value: # Optional
 - name: ttlInSeconds
 value: <int> # Optional
 - name: queryIndexes
 value: <string> # Optional
 # Uncomment this if you wish to use Redis as a state store for actors (optional)
 #- name: actorStateStore
 # value: "true"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

If you wish to use Redis as an actor store, append the following to the yaml.

RethinkDB

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup RethinkDB state store, create a component of type state.rethinkdb. See the how-to guide to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.rethinkdb
 version: v1
 metadata:
 - name: address
 value: <REPLACE-RETHINKDB-ADDRESS> # Required, e.g. 127.0.0.1:28015 or rethinkdb.default.svc.cluster.local:28015).
 - name: database
 value: <REPLACE-RETHINKDB-DB-NAME> # Required, e.g. dapr (alpha-numerics only)
 - name: table
 value: # Optional
 - name: username
 value: <USERNAME> # Optional
 - name: password
 value: <PASSWORD> # Optional
 - name: archive
 value: bool # Optional (whether or not store should keep archive table of all the state changes)

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets, as described here.

If the optional archive metadata is set to true, on each state change, the RethinkDB state store will also log state changes with timestamp in the daprstate_archive table. This allows for time series analyses of the state managed by Dapr.

SQLite

Mon, 01 Jan 0001 00:00:00 +0000

This component allows using SQLite 3 as state store for Dapr.

The component is currently compiled with SQLite version 3.41.2.

Create a Dapr component

Create a file called sqlite.yaml, paste the following, and replace the <CONNECTION STRING> value with your connection string, which is the path to a file on disk.

If you want to also configure SQLite to store actors, add the actorStateStore option as in the example below.

Zookeeper

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Zookeeper state store create a component of type state.zookeeper. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: state.zookeeper
 version: v1
 metadata:
 - name: servers
 value: <REPLACE-WITH-COMMA-DELIMITED-SERVERS> # Required. Example: "zookeeper.default.svc.cluster.local:2181"
 - name: sessionTimeout
 value: <REPLACE-WITH-SESSION-TIMEOUT> # Required. Example: "5s"
 - name: maxBufferSize
 value: <REPLACE-WITH-MAX-BUFFER-SIZE> # Optional. default: "1048576"
 - name: maxConnBufferSize
 value: <REPLACE-WITH-MAX-CONN-BUFFER-SIZE> # Optional. default: "1048576"
 - name: keyPrefixPath
 value: <REPLACE-WITH-KEY-PREFIX-PATH> # Optional.

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
servers	Y	Comma delimited list of servers	`"zookeeper.default.svc.cluster.local:2181"`
sessionTimeout	Y	The session timeout value	`"5s"`
maxBufferSize	N	The maximum size of buffer. Defaults to `"1048576"`	`"1048576"`
maxConnBufferSize	N	The maximum size of connection buffer. Defaults to `"1048576`"	`"1048576"`
keyPrefixPath	N	The key prefix path in Zookeeper. No default	`"dapr"`

Setup Zookeeper

You can run Zookeeper locally using Docker: