Skip to content

Add Clickhouse state store docs v1.16 #4697

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

Jump to bottom
Open
wants to merge 3 commits into
base: v1.16
Choose a base branch
from
Open

Add Clickhouse state store docs v1.16 #4697

wants to merge 3 commits into from
+204 −0

Conversation

middt
Copy link

@middt middt commented Jun 27, 2025 •
edited by msfussell
Loading

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

Issue reference

https://github.com/dapr/components-contrib/pull/3675

@middt middt requested review from a team as code owners June 27, 2025 11:52
msfussell
msfussell reviewed Jun 30, 2025
View reviewed changes
@middt middt force-pushed the add-clickhouse-state-store-docs-v1.16 branch from e084f7a to 2da4c1d Compare July 1, 2025 06:22
@middt
Copy link
Author

middt commented Jul 1, 2025

@msfussell I've removed the unnecessary files—only the required ones remain. Thanks again for the feedback!

@middt middt mentioned this pull request Jul 2, 2025
Open
3 tasks
@msfussell msfussell added the waiting-on-code-pr The code PR needs to be merged before the docs are updated label Jul 2, 2025
@msfussell msfussell added this to the 1.16 milestone Jul 2, 2025
msfussell
msfussell reviewed Jul 2, 2025
View reviewed changes
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.

@middt - Great docs. A few suggested edits. Appreciate the contribution

@middt middt force-pushed the add-clickhouse-state-store-docs-v1.16 branch from 87e7232 to e6635ca Compare July 3, 2025 11:51
@middt
Copy link
Author

middt commented Jul 3, 2025

@msfussell Thank you for the great feedback! 🙏
I've addressed all your suggestions:
✅ Fixed version: Changed since: "1.15" to since: "1.16" in generic.yaml
✅ Removed actor references: Removed all actor-related comments and sections since ClickHouse is not a transactional state store

Thanks for the thorough review and for helping make this contribution better!

@middt middt requested a review from msfussell July 3, 2025 11:56
@msfussell msfussell changed the title Add clickhouse state store docs v1.16 Add Clickhouse state store docs v1.16 Jul 9, 2025
msfussell
msfussell approved these changes Jul 9, 2025
View reviewed changes
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.

@middt - Appreciate this amazing contribution to Dapr! Would love to get this to be a stable component in due course.

@middt
Copy link
Author

middt commented Jul 9, 2025

@middt - Appreciate this amazing contribution to Dapr! Would love to get this to be a stable component in due course.

@msfussell – Thank you so much for the approval and kind words! 🙌

@msfussell
Copy link
Member

@middt - can you remove the sdkdoc/python file from the PR. This should not be here, otherwise cannot merge

@middt
Add ClickHouse state store documentation
6a4c1bf 
- Add comprehensive documentation for ClickHouse state store component
- Include setup instructions for self-hosted, Kubernetes, and cloud deployments
- Document supported features: CRUD, ETag, and TTL support
- Add advanced configuration options and performance considerations
- Update component registry with ClickHouse entry in generic.yaml
- Set correct version as 1.16 (first release)
- Remove actor-related content as ClickHouse is not transactional

Signed-off-by: Mehmet TOSUN <[email protected]>
@middt middt force-pushed the add-clickhouse-state-store-docs-v1.16 branch from bfa6dd7 to 6a4c1bf Compare August 31, 2025 03:42
@middt
Copy link
Author

middt commented Aug 31, 2025

msfussell

@msfussell ✅ Done! Removed sdkdocs/python and all other unnecessary files. The PR now contains only the 2 ClickHouse files. Thanks for catching that!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@msfussell msfussell msfussell approved these changes

Assignees
No one assigned
Labels
waiting-on-code-pr The code PR needs to be merged before the docs are updated
Projects
None yet
Milestone
1.16
Development

Successfully merging this pull request may close these issues.
2 participants
@middt @msfussell