Skip to content
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.

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

Adding write performance optimization section to Cosmos DB state stor… #3934

Merged
merged 7 commits into from
Jan 9, 2024

Conversation

KrylixZA
Copy link
Contributor

@KrylixZA KrylixZA commented Jan 3, 2024

Thank you for helping make the Dapr documentation better!

Please follow this checklist before submitting:

  • Commits are signed with Developer Certificate of Origin (DCO - learn more)
  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within codetabs
  • New file and folder names are globally unique
  • Page references use shortcodes instead of markdown or URL links
  • Images use HTML style and have alternative text
  • Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand this pull request:

Description

This pull request documents configuration changes which can be made to Azure Cosmos DB SQL containers to optimise for write operations. These optimisations target specific uses cases where developers only ever interact with Cosmos DB via the Dapr API/Client or via Dapr Actors. It forces Cosmos DB not to index the entire document as this slows down write operations. Obviously this comes with a performance hit when querying the state store, so I have added a note to the documentation for developers to read and acknowledge the risks of using this optimisation.

Issue reference

Closes #3698

@KrylixZA KrylixZA marked this pull request as ready for review January 3, 2024 09:49
@KrylixZA KrylixZA requested review from a team as code owners January 3, 2024 09:49
Copy link
Member

@msfussell msfussell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this contribution.

Copy link
Member

@msfussell msfussell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the updates. Approved. Appreciate the great contribution to the docs

@msfussell msfussell merged commit 5c132e6 into dapr:v1.12 Jan 9, 2024
7 checks passed
@KrylixZA KrylixZA deleted the cosmosdb-performance-docs branch May 18, 2024 05:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cosmos DB State Store documentation should include a performance optimisation section
2 participants