State management with the Dapr JavaScript SDK on Dapr Docs

How to: Manage state with the Dapr JavaScript SDK

Mon, 01 Jan 0001 00:00:00 +0000

Use DaprClient.state to manage key/value application state without depending on a particular database client. This guide uses Redis and covers basic operations, optimistic concurrency, bulk operations, TTL, and transactions.

Prerequisites

Dapr CLI
An initialized Dapr environment
Node.js 18 or later
The @dapr/dapr package, version 3.19.0 or later
A Redis instance, such as the local Redis container created by dapr init

In your application directory, initialize an npm project if needed and install the SDK:

State client usage

Mon, 01 Jan 0001 00:00:00 +0000

State management is available through DaprClient.state. This page describes the implementation in 3.19.0 and the behavior to account for when using that package or a later compatible release.

Client lifetime and configuration

Reuse a long-lived DaprClient instead of constructing one per operation. Await outstanding requests before calling await client.stop() during shutdown.

HTTP is the default protocol. To use gRPC:

import { CommunicationProtocolEnum, DaprClient } from "@dapr/dapr";

const client = new DaprClient({
 daprHost: "127.0.0.1",
 daprPort: "50001",
 communicationProtocol: CommunicationProtocolEnum.GRPC,
 daprApiToken: process.env.DAPR_API_TOKEN,
});

For HTTP, use CommunicationProtocolEnum.HTTP and the sidecar’s HTTP port, normally "3500". Port options are strings.

How to: Query state with the Dapr JavaScript SDK

Mon, 01 Jan 0001 00:00:00 +0000

Use client.state.query to query JSON documents in a state store that supports the state query API. Both HTTP and gRPC are implemented in 3.19.0. This is the alpha state query API, not a general-purpose SQL or native database query interface.

Prerequisites

Follow the state management how-to to install the SDK and run an application with a sidecar. For this guide, configure a query-capable component named state-mongodb, following the MongoDB state store reference. The basic Redis component in the how-to does not by itself configure query support.