docs: in memory state store component (#2534)

* in mem state

Signed-off-by: seeflood <zhou.qunli@foxmail.com>

* resolve issues

Signed-off-by: seeflood <zhou.qunli@foxmail.com>

* Developer-only

Signed-off-by: seeflood <zhou.qunli@foxmail.com>

* Update daprdocs/content/en/reference/components-reference/supported-state-stores/setup-inmemory.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

Signed-off-by: seeflood <zhou.qunli@foxmail.com>

* Update daprdocs/content/en/reference/components-reference/supported-state-stores/setup-inmemory.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

Signed-off-by: seeflood <zhou.qunli@foxmail.com>

* Update daprdocs/content/en/reference/components-reference/supported-state-stores/setup-inmemory.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

Signed-off-by: seeflood <zhou.qunli@foxmail.com>

* Update daprdocs/content/en/reference/components-reference/supported-state-stores/setup-inmemory.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

Signed-off-by: seeflood <zhou.qunli@foxmail.com>

* Update daprdocs/content/en/reference/components-reference/supported-state-stores/setup-inmemory.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

Signed-off-by: seeflood <zhou.qunli@foxmail.com>

* add in memory comp

Signed-off-by: seeflood <zhou.qunli@foxmail.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>
This commit is contained in:
seeflood 2022-06-24 08:42:50 +08:00 committed by GitHub
parent 9f13407124
commit d522e47b86
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 48 additions and 0 deletions

View File

@ -0,0 +1,37 @@
---
type: docs
title: "In Memory"
linkTitle: "In Memory"
description: "Detailed documentation on the In Memory state component"
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-inmemory/"
---
The In Memory state store component is useful for development purposes and works inside of a single machine boundary.
{{% alert title="Warning" color="warning" %}}
This component **shouldn't be used for production**. It is developer only and will never be stable. If you come across a scenario and want to use it in production, you can submit an issue and discuss it with the community.
{{% /alert %}}
## Component format
To setup in-memory state store, create a component of type `state.in-memory`. 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>
namespace: <NAMESPACE>
spec:
type: state.in-memory
version: v1
metadata: []
```
> Note: While in-memory does not require any specific metadata for the component to work, `spec.metadata` is a required field.
## Related links
- [Basic schema for a Dapr component]({{< ref component-schema >}})
- Learn [how to create and configure state store components]({{< ref howto-get-save-state.md >}})
- Read more about the [state management building block]({{< ref state-management >}})

View File

@ -64,6 +64,17 @@
etag: false etag: false
ttl: false ttl: false
query: false query: false
- component: In Memory
link: setup-inmemory
state: Developer-only
version: v1
since: "1.8"
features:
crud: true
transactions: true
etag: true
ttl: true
query: false
- component: JetStream KV - component: JetStream KV
link: setup-jetstream-kv link: setup-jetstream-kv
state: Alpha state: Alpha