RethinkDB
Detailed information on the RethinkDB state store component
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.
Spec metadata fields
Field | Required | Details | Example |
---|---|---|---|
address | Y | The address for RethinkDB server | "127.0.0.1:28015" , "rethinkdb.default.svc.cluster.local:28015" |
database | Y | The database to use. Alpha-numerics only | "dapr" |
table | N | The table name to use | "table" |
username | N | The username to connect with | "user" |
password | N | The password to connect with | "password" |
archive | N | Whether or not to archive the table | "true" , "false" |
Setup RethinkDB
You can run RethinkDB locally using Docker:
docker run --name rethinkdb -v "$PWD:/rethinkdb-data" -d rethinkdb:latest
To connect to the admin UI:
open "http://$(docker inspect --format '{{ .NetworkSettings.IPAddress }}' rethinkdb):8080"
Related links
- Basic schema for a Dapr component
- Read the how-to guide for instructions on configuring state store components.
- State management building block.
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.
Last modified October 11, 2024: Fixed typo (#4389) (fe17926)