From d522e47b8639340919e0614943b69248f82bb276 Mon Sep 17 00:00:00 2001 From: seeflood Date: Fri, 24 Jun 2022 08:42:50 +0800 Subject: [PATCH] docs: in memory state store component (#2534) * in mem state Signed-off-by: seeflood * resolve issues Signed-off-by: seeflood * Developer-only Signed-off-by: seeflood * 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 * 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 * 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 * 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 * 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 * add in memory comp Signed-off-by: seeflood Co-authored-by: Mark Fussell --- .../supported-state-stores/setup-inmemory.md | 37 +++++++++++++++++++ .../data/components/state_stores/generic.yaml | 11 ++++++ 2 files changed, 48 insertions(+) create mode 100644 daprdocs/content/en/reference/components-reference/supported-state-stores/setup-inmemory.md diff --git a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-inmemory.md b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-inmemory.md new file mode 100644 index 000000000..86878608e --- /dev/null +++ b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-inmemory.md @@ -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: + 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 >}}) diff --git a/daprdocs/data/components/state_stores/generic.yaml b/daprdocs/data/components/state_stores/generic.yaml index e7fa3e210..6b524549a 100644 --- a/daprdocs/data/components/state_stores/generic.yaml +++ b/daprdocs/data/components/state_stores/generic.yaml @@ -64,6 +64,17 @@ etag: false ttl: 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 link: setup-jetstream-kv state: Alpha