Skip to content

Commit 24add04

Browse files
Docs review
1 parent bba4512 commit 24add04

File tree

1 file changed

+7
-7
lines changed
  • samples/sql-persistence/transitioning-correlation-ids

1 file changed

+7
-7
lines changed

samples/sql-persistence/transitioning-correlation-ids/sample.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Transitioning Saga Correlation IDs
33
summary: An approach for transitioning between different correlation IDs with no downtime
4-
reviewed: 2024-02-05
4+
reviewed: 2025-11-26
55
component: SqlPersistence
66
related:
77
- nservicebus/sagas
88
---
99

10-
This sample illustrates an approach for transitioning between different [correlation IDs](/persistence/sql/saga.md#correlation-ids) in a way that requires no endpoint downtime or migration of saga data stored in sql.
10+
This sample illustrates an approach for transitioning between different [correlation IDs](/persistence/sql/saga.md#correlation-ids) in a way that requires no endpoint downtime or migration of saga data stored in SQL.
1111

1212
> [!NOTE]
1313
> The sample uses three "Phase" endpoint projects to illustrate the iterations of a single endpoint in one solution.
@@ -16,9 +16,9 @@ include: sqlpersistence-prereqs
1616

1717
## Scenario
1818

19-
The sample uses a hypothetical "Order" scenario where the requirement is to transition from an an integer correlation ID `OrderNumber` to a GUID correlation ID `OrderId`.
19+
The sample uses a hypothetical "Order" scenario where the requirement is to transition from an integer correlation ID `OrderNumber` to a GUID correlation ID `OrderId`.
2020

21-
To move between phases, after running each phase adjust the startup project list in solution properties. E.g. after phase 1, disable endpoints that contain "Phase1" in the name, and enable endpoints that contain "Phase2".
21+
To move between phases, after running each phase, adjust the startup project list in the solution properties. E.g., after phase 1, disable endpoints that contain "Phase1" in the name, and enable endpoints that contain "Phase2".
2222

2323
## Phases
2424

@@ -40,7 +40,7 @@ snippet: sagadataPhase1
4040

4141
### Phase 2
4242

43-
In the second phase a GUID `OrderId` is added. The saga still maps `StartOrder.OrderNumber` to `OrderSagaData.OrderNumber` in the `ConfigureHowToFindSaga` method. However it also introduces a correlation to `OrderSagaData.OrderId` via a `transitionalCorrelationProperty` in the `[SqlSaga]` attribute.
43+
In the second phase, a GUID `OrderId` is added. The saga still maps `StartOrder.OrderNumber` to `OrderSagaData.OrderNumber` in the `ConfigureHowToFindSaga` method. However, it also introduces a correlation to `OrderSagaData.OrderId` via a `transitionalCorrelationProperty` in the `[SqlSaga]` attribute.
4444

4545
#### Message
4646

@@ -55,11 +55,11 @@ snippet: sagaPhase2
5555
snippet: sagadataPhase2
5656

5757
> [!WARNING]
58-
> Prior to moving to Phase 3 it is necessary to verify that all existing sagas have the `Correlation_OrderId` column populated. This can either be inferred by the business knowledge (i.e. certain saga may have a known and constrained lifetime) or by querying the database.
58+
> Prior to moving to Phase 3, it is necessary to verify that all existing sagas have the `Correlation_OrderId` column populated. This can either be inferred by the business knowledge (i.e., certain saga may have a known and constrained lifetime) or by querying the database.
5959
6060
### Phase 3
6161

62-
In the third phase, the integer `OrderNumber` is removed leaving only the `OrderId`. The saga now maps `StartOrder.OrderId` to `OrderSagaData.OrderId` in the `ConfigureHowToFindSaga` method.
62+
In the third phase, the integer `OrderNumber` is removed, leaving only the `OrderId`. The saga now maps `StartOrder.OrderId` to `OrderSagaData.OrderId` in the `ConfigureHowToFindSaga` method.
6363

6464
#### Message
6565

0 commit comments

Comments
 (0)