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

Document how to design state queries (and writes) #7833

Closed
Tracked by #7738
teor2345 opened this issue Oct 25, 2023 · 2 comments · Fixed by #8149
Closed
Tracked by #7738

Document how to design state queries (and writes) #7833

teor2345 opened this issue Oct 25, 2023 · 2 comments · Fixed by #8149
Labels
A-docs Area: Documentation A-rpc Area: Remote Procedure Call interfaces A-state Area: State / database changes

Comments

@teor2345
Copy link
Contributor

teor2345 commented Oct 25, 2023

This needs to be done before #7738, but it's not a ticket template.

Everything that goes in the docs doesn't need to go in the ticket template, I can just link to the docs from the template.

This should document the typed column families from PR #8112.

@teor2345 teor2345 self-assigned this Oct 25, 2023
@mpguerra mpguerra added this to Zebra Oct 25, 2023
@github-project-automation github-project-automation bot moved this to 🆕 New in Zebra Oct 25, 2023
@teor2345 teor2345 changed the title Doc about how to design the RPC and state queries Document how to design RPCs and state queries Oct 25, 2023
@teor2345 teor2345 added A-docs Area: Documentation A-rpc Area: Remote Procedure Call interfaces A-state Area: State / database changes P-Medium ⚡ labels Oct 25, 2023
@teor2345
Copy link
Contributor Author

From PR #7972:

Document how to avoid this happening again in the state upgrade docs.

In particular, don't concurrently read and write the same keys in the same column family:

  • in an upgrade, and
  • in the sync.

If we need to do that, we should make the upgrade happen before syncing. (That is, block on the upgrade when the state is opened.)

And make sure the read and write methods have compatible conditions.

@teor2345
Copy link
Contributor Author

The typed column families from PR #8112 might also help with some common database bugs.

@teor2345 teor2345 changed the title Document how to design RPCs and state queries Document how to design state queries (and writes) Jan 11, 2024
@mergify mergify bot closed this as completed in #8149 Jan 12, 2024
@github-project-automation github-project-automation bot moved this from 🆕 New to ✅ Done in Zebra Jan 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation A-rpc Area: Remote Procedure Call interfaces A-state Area: State / database changes
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant