In this post, you will learn
- What is TransactionBatch?
- Sample scenario and demo
- TransactionalBatch or Stored procedure?
With the release of .NET SQL SDK version 3.4, The Cosmos DB team has released support for TransactionalBatch, With TransactionalBatch, it is now possible to save multiple documents in a single batch operation.
What is TransactionBatch?
Documents in the batch will either all succeed atomically, or all be rolled back together.
Sample scenario and demo
Banks use Event sourcing to store events (bank transactions). These events are immutable and banks maintain a complete log of changes (transactions) as Events in an Event store. Some possible events in a banking scenario could be AccountCreated, DepositPerformed, and WithdrawPerformed, etc.
When you visit a bank for opening a new bank account, you might have a requirement to deposit a minimum amount in order to activate your account. Think of it as two Events, one for creating an account and the second one is performing a sufficient deposit. If you save two documents via separate calls to the Cosmos DB one for the account creation and second for a deposit, you risk the second call to fail and you end up in a situation where you have an invalid account. You want to make sure both Events either saved successfully or none of them gets saved. In such situations, you might want to use TransactionBatch support to create a batch with both AccountCreated and DepositPerformed events and then commit the transaction. See the following code sample
TransactionBatch or Stored procedure?
You might ask what’s wrong with writing a server-side stored procedure. Nothing wrong as such, but there are many reasons to prefer TransactionalBatch over authoring stored procedures
Since it is just like any other code you write, you can use your favorite mocking framework or other familiar techniques for testing it.
The preferred choice of language
At the time of writing, this feature is available only in .NET SDK but Cosmos DB product team is planning to release this support for many other languages like Node, Python, and Java
Easier version control
With Server-Side stored procedures, you always had to update your stored procedure before deploying your new code, and imagine if things don’t work out as you expected, how painful a rollback could be, Similarly In the world where CI/CD it is crucial to have everything as Code.
According to Microsoft, a 30% reduction in latency has been experienced when compared to Stored procedures for equal operations. Other than comparing it with Stored procedures, Saving documents as a batch reduces the number of round trips as well.
Content serialization flexibility
With TransactionBatch support directly in your code, you have complete control of the way you want to serialize your object.
- Maximum payload size is 2MB
- Maximum number of operations are 100 per TransactionalBatch
If there is anything difficult in a distributed database, that is support for the transaction. Cosmos DB product team has done a tremendous job by providing this feature directly in the SDK. Transactions are a very useful feature when you need an all or nothing behavior. Please let me know in the comments what situations you think this feature would be useful.