Skip to content

Commit

Permalink
Clarify sessions and transactions
Browse files Browse the repository at this point in the history
  • Loading branch information
boblangley authored Oct 10, 2019
1 parent 00f9196 commit 77e6d30
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
## MongoDB Sessions
## MongoDB Transactions

The Saga and Outbox implementations support MongoDB transactions, which also requires support for MongoDB sessions. This limits the use of this package to MongoDB server 3.6 or greater.
By default the Saga and Outbox implementations utilize [MongoDB transactions](https://docs.mongodb.com/manual/core/transactions/), which is only supported in MongoDB server version 4.0 or greater and cannot be used in all configurations of MongoDB server. MongoDB transactions rely on the MongoDB server sessions feature.

## MongoDB Server Sessions

The Saga and Outbox implementations are built around [MongoDB server sessions](https://docs.mongodb.com/manual/reference/server-sessions/). MongoDB sessions were introduced in MongoDB server version 3.6, however version 3.6 can only be used by this package when the user configures the package to disable use of transactions.

## Initialization

Expand Down

0 comments on commit 77e6d30

Please sign in to comment.