Skip to content

Review sample text for CosmosDB - Simple #7843

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 27, 2025
Merged

Review sample text for CosmosDB - Simple #7843

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions samples/cosmosdb/simple/sample.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Simple Cosmos DB Persistence Usage
summary: Using Cosmos DB Persistence to store sagas
reviewed: 2023-12-05
reviewed: 2025-09-26
component: CosmosDB
related:
- nservicebus/sagas
Expand All @@ -15,7 +15,9 @@ This sample shows a client/server scenario using non-transactional saga persiste

Ensure that an instance of the latest [Azure Cosmos DB Emulator](https://docs.microsoft.com/en-us/azure/cosmos-db/local-emulator) is running.

## Projects
## Sample structure

This sample contains three projects, `SharedMessages`, `Client` and `Server`.

### SharedMessages

Expand All @@ -26,24 +28,30 @@ The shared message contracts used by all endpoints.
* Sends the `StartOrder` message to `Server`.
* Receives and handles the `OrderCompleted` event.

### Server projects
### Server

* Receive the `StartOrder` message and initiate an `OrderSaga`.
* `OrderSaga` requests a timeout with an instance of `CompleteOrder` with the saga data.
* `OrderSaga` publishes an `OrderCompleted` event when the `CompleteOrder` timeout fires.

## Implementation highlights

### Persistence config

Configure the endpoint to use Cosmos DB Persistence.
In Program.cs of the Server project, the endpoint is configured to use Cosmos DB Persistence:

snippet: CosmosDBConfig

In the non-transactional mode, the saga id is used as a partition key, and thus, the container needs to use `/id` as the partition key path.

## Order saga data

The data stored on the saga is defined on the `OrderSagaData.cs` file inside the `Server` project:

snippet: sagadata

## Order saga

The handler for this data is on the `OrderSaga.cs` file on the `Server` project:

snippet: thesaga
Loading