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

change(doc): Document how to add a column family #8149

Merged
merged 3 commits into from Jan 12, 2024
Merged

change(doc): Document how to add a column family #8149

merged 3 commits into from Jan 12, 2024

Conversation

teor2345
Copy link
Contributor

Motivation

This PR documents how to add a new column family. (Or convert old column families to be type-safe.)

Close #7833

PR Author Checklist

Check before marking the PR as ready for review:

  • Will the PR name make sense to users?
  • Does the PR have a priority label?
  • Have you added or updated tests?
  • Is the documentation up to date?

If a checkbox isn't relevant to the PR, mark it as done.

Solution

  • Document how to add a new column family
  • Document how to read from a column family
  • Document how to write batches to a column family and write a batch to the database
  • Link to code examples

Review

This is a routine documentation update.

Reviewer Checklist

Check before approving the PR:

  • Does the PR scope match the ticket?
  • Are there enough tests to make sure it works? Do the tests cover the PR motivation?
  • Are all the PR blockers dealt with?
    PR blockers can be dealt with in new tickets or PRs.

And check the PR Author checklist is complete.

@teor2345 teor2345 added A-docs Area: Documentation C-enhancement Category: This is an improvement P-Medium ⚡ I-panic Zebra panics with an internal error message A-state Area: State / database changes C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG A-blockchain-scanner Area: Blockchain scanner of shielded transactions labels Jan 11, 2024
@teor2345 teor2345 self-assigned this Jan 11, 2024
@teor2345 teor2345 requested a review from a team as a code owner January 11, 2024 22:54
@teor2345 teor2345 requested review from arya2 and removed request for a team January 11, 2024 22:54
Copy link
Contributor

@arya2 arya2 left a comment

Choose a reason for hiding this comment

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

Looks good!

mergify bot added a commit that referenced this pull request Jan 12, 2024
@mergify mergify bot merged commit b2e71f4 into main Jan 12, 2024
91 checks passed
@mergify mergify bot deleted the state-docs branch January 12, 2024 02:11
@oxarbitrage oxarbitrage mentioned this pull request Jan 17, 2024
41 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-blockchain-scanner Area: Blockchain scanner of shielded transactions A-docs Area: Documentation A-state Area: State / database changes C-enhancement Category: This is an improvement C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG I-panic Zebra panics with an internal error message
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how to design state queries (and writes)
2 participants