-
Notifications
You must be signed in to change notification settings - Fork 755
[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
nmalocic
wants to merge
12
commits into
dapr:v1.15
Choose a base branch
from
nmalocic:3318-ravendb-docs
base: v1.15
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+74
−0
Open
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
4088858
Added docs for RavenDB as State Store
nmalocicvega ccef7f3
Merge branch 'v1.15' into 3318-ravendb-docs
mikeee 028e554
Fixes to the supported features and to Ravendb page
nmalocic 7f87f2b
Fixes to the supported features and to Ravendb page
nmalocic dcc6d70
Merge branch '3318-ravendb-docs' of github.com:nmalocic/dapr-docs int…
nmalocic 7b4962c
Fixed spelling mistake in secret-scope.md (#4593)
jamespegg bd33953
Added docs for RavenDB as State Store
nmalocicvega 44ce484
Update self-hosted-with-docker.md - make `scheduler` running (#4599)
mathieu-benoit a6c8cc4
Fixes to the supported features and to Ravendb page
nmalocic 46a8c73
Update actors-quickstart.md (#4601)
alicejgibbons 282c3b9
Merge branch '3318-ravendb-docs' of github.com:nmalocic/dapr-docs int…
nmalocic 08fe273
Merge branch 'v1.15' into 3318-ravendb-docs
mikeee File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
63 changes: 63 additions & 0 deletions
63
...ntent/en/reference/components-reference/supported-state-stores/setup-ravendb.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
### 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 >}}) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -207,3 +207,14 @@ | |||||
etag: true | ||||||
ttl: false | ||||||
query: false | ||||||
- component: RavenDB | ||||||
link: setup-ravendb | ||||||
state: Stable | ||||||
version: v1 | ||||||
since: "1.0" | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
features: | ||||||
crud: true | ||||||
transactions: true | ||||||
etag: true | ||||||
ttl: true | ||||||
query: false |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.