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

[Persistence] Document how different data structures and engines are used #873

Open
6 tasks
Olshansk opened this issue Jul 4, 2023 · 0 comments
Open
6 tasks
Assignees
Labels
documentation Improvements or additions to documentation persistence Persistence specific changes

Comments

@Olshansk
Copy link
Member

Olshansk commented Jul 4, 2023

Objective

Make it clear and accessible to newcomers to the database how (and why) data is store in a certain way.

Origin Document

#847 (comment)

Screenshot 2023-07-03 at 5 36 13 PM

Starting Point

This table can be used as a starting point

Tree Type Storage Type Responsibility
IBC Tree KV Store State Commitment
IBC Tree KV Store State Storage
IBC Tree KV Store Data Integrity
IBC Tree KV Store & Block Store Data Availability
Other Trees KV Store State Commitment
Other Trees Postgres State Storage
Other Trees KV Store Data Integrity
Other Trees KV Store & Postgres & Block Store Data Availability

Goals

  • Document how data is stored across different data structures and database engines
  • Make it clear why data is stored in a certain way

Deliverable

Non-goals / Non-deliverables

  • Changes to the architecture or implementation

General issue deliverables

  • Update the appropriate CHANGELOG(s)
  • Update any relevant local/global README(s)
  • Update relevant source code tree explanations
  • Add or update any relevant or supporting mermaid diagrams

Creator: @Olshansk
Co-Owners: @dylanlott @h5law

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation persistence Persistence specific changes
Projects
Status: No status
Development

No branches or pull requests

2 participants