Skip to content

[WIP] Added docs for RavenDB as State Store #4600

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: v1.15
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
type: docs
title: "RavenDB"
linkTitle: "RavenDB"
description: Detailed information on the RavenDB state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-ravendb/"
---

## Component format

To setup RavenDB state store create a component of type `state.ravendb`. 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.


```yaml
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: "server.example.com"
- 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"
```

{{% 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 |
|--------------------|:--------:|---------|---------|
| databaseName | N | The name of the database to use. Defaults to `"daprStore"` | `"daprStore"`
| serverURL | Y | Url to RavenDB instance | `"http://localhost:8080"`
| certPath | N<sup>1</sup> | Path to certificate file | `"/path/to/client.certificate.crt"`
| keyPath | N<sup>1</sup> | Path to key file | `"/path/to/certificate.key"`
| EnableTTL | N | Boolean value to enable TTL capability. Defaults to `"true"` | `"true"`
| TTLFrequency | N | Additional parameters to use | `"5s"`

> <sup>[1]</sup> The `certPath` and `keyPath` fields are not mandatory if server url is http, however if server url is https and no certPath and keyPath is present dapr returns an error.
Copy link
Member

@msfussell msfussell Apr 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> <sup>[1]</sup> The `certPath` and `keyPath` fields are not mandatory if server url is http, however if server url is https and no certPath and keyPath is present dapr returns an error.
> <sup>[1]</sup> 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 is present, then Dapr returns an error.


### TTLs and cleanups

This state store supports [Time-To-Live (TTL)]({{< ref state-store-ttl.md >}}) for records stored with Dapr. When storing data using Dapr, you can set the `ttlInSeconds` metadata property to indicate when the data should be considered "expired".

## 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 >}})
11 changes: 11 additions & 0 deletions daprdocs/data/components/state_stores/generic.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -207,3 +207,14 @@
etag: true
ttl: false
query: false
- component: RavenDB
link: setup-ravendb
state: Stable
version: v1
since: "1.0"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
since: "1.0"
since: "1.16"

features:
crud: true
transactions: true
etag: true
ttl: true
query: false
Loading