chore(docs): add documents of db
#888
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # DB | ||
|
|
||
| The `db` package contains the key-value database interface and `memdb` implementation. The `memdb` is a simple in-memory key-value store that is used for testing and development purposes. | ||
|
|
||
| ## Context | ||
|
|
||
| The main purpose of the `db` package is to provide decoupling between `cosmos-db` and `iavl` packages. It provides a simple `wrapper` for the old users of `iavl` and `cosmos-db` to use the new `db` package without changing their code. For example: | ||
|
|
||
| ```go | ||
| package main | ||
|
|
||
| import ( | ||
| "cosmossdk.io/log" | ||
| dbm "github.com/cosmos/cosmos-db" | ||
|
|
||
| "github.com/cosmos/iavl" | ||
| idbm "github.com/cosmos/iavl/db" | ||
| ) | ||
|
|
||
| func main() { | ||
| levelDB, err := dbm.NewDB("application", dbm.GoLevelDBBackend, "test") | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| tree := iavl.NewMutableTree(idbm.NewWrapper(dbm.NewPrefixDB(levelDB, []byte("s/k:main/"))), 0, false, log.NewNopLogger()) | ||
| } | ||
| ``` | ||
|
Comment on lines
+1
to
+28
There was a problem hiding this comment. The README.md provides a clear overview of the
Overall, the documentation is a good starting point but could be enhanced to offer more guidance and information to users. |
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The improvements listed in the Unreleased section of the CHANGELOG.md accurately reflect the significant changes made to the project, including the decoupling from
cosmos-db, introduction of new APIs, and performance optimizations. However, it would be beneficial to include more context or details for each item to help users understand the impact of these changes better. For example:cosmos-db, briefly explain the benefits or reasons behind this move.SaveChangeSet,NewCompressExporter, andNewCompressImporter, a short description of their use cases or advantages would be helpful.Enhancing the descriptions in the CHANGELOG.md will provide users with a clearer understanding of the changes and how they can benefit from them.