Quickstart: State Management

This quickstart showcases how to enable stateful data persistence using the State API.

1

Prerequisites

Before you proceed, ensure you have the following prereqs installed.

Python

• Diagrid CLI
• Git
• Python 3.11+

.NET

• Diagrid CLI
• Git
• .NET 8.0+

JavaScript

• Diagrid CLI
• Git
• Node.JS LTS

Java

• Diagrid CLI
• Git
• Java 11.0+: OracleJDK or OpenJDK
• Apache Maven 3.9.5+

2

Log in to Catalyst

Authenticate to Diagrid Catalyst using the following command:

diagrid login

Confirm your organization and user details are correct:

diagrid whoami

3

Clone Quickstart Code

Clone the quickstart code from the Diagrid Labs GitHub repository and navigate to the appropriate directory:

Python

diagrid dev quickstart --type state --language python

.NET

diagrid dev quickstart --type state --language csharp

JavaScript

diagrid dev quickstart --type state --language javascript

Java

diagrid dev quickstart --type state --language java

After the command executes successfully, the CLI will output the contents of your newly created project including an App ID called order-app and a Diagrid KV Store called kvstore.

4

Install Dependencies and Run

The diagrid dev run command creates your Catalyst project (if needed), provisions resources (App IDs, Components, Diagrid KV Store service), configures environment variables, and launches your application using the dapr multi-app run file.

Python

Create and activate a Python virtual environment:

python -m venv venv
source venv/bin/activate  # MacOS/Linux
# Or: venv\Scripts\activate  # Windows

note

Windows users: Use venv\Scripts\Activate.ps1 (PowerShell) or venv\Scripts\activate.bat (Command Prompt). Use conda, pipenv, or your preferred tool if desired.

Install dependencies:

pip install -r requirements.txt

.NET

Install .NET dependencies:

dotnet restore

JavaScript

Install Node dependencies:

npm install

Java

Install Maven dependencies:

mvn clean install

Run the application:

Python

diagrid dev run -f dev-python-state.yaml --project dev-python-state

.NET

diagrid dev run -f dev-csharp-state.yaml --project dev-csharp-state

JavaScript

diagrid dev run -f dev-js-state.yaml --project dev-js-state

Java

diagrid dev run -f dev-java-state.yaml --project dev-java-state

5

Call the State API

With the quickstart running, test the State API using curl or the REST Client extension with the test.rest file.

Store state

Open a new terminal and execute the following curl command to save a state item to the Diagrid KV store:

curl -i -X POST http://localhost:5001/order -H "Content-Type: application/json" -d '{"orderId":1}'

Retrieve state

Confirm the state item was saved successfully by retrieving the state:

curl -i -X GET http://localhost:5001/order/1

You can also view the stored item using the Diagrid KV Store data explorer:

Delete state

Delete the state item using the below command:

curl -i -X DELETE http://localhost:5001/order/1

After running the above commands, the local app logs should indicate an order was saved, retrieved and deleted.

To stop the application:

diagrid dev stop

6

Clean Up ResourcesOptional

If you are not going to continue to use this application, delete the app ID:

diagrid appid delete order-app

To delete the entire Catalyst project, including the managed infrastructure resources:

diagrid project delete dev-python-state  # or dev-csharp-state, dev-js-state, dev-java-state