chore: fix some documentation #1662
Merged
Conversation
This file contains hidden or 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
Signed-off-by: Xiangyu (Samuel) Hu <[email protected]> fix
hzxa21
approved these changes
Apr 7, 2022
skyzh
reviewed
Apr 7, 2022
| in the project root. | ||
|
|
||
| For developers, we always recommend using risedev to start the full cluster, instead of using these docker images. | ||
| For RisingWave kernel hackers, we always recommend using [risedev](../src/risedevtool/README.md) to start the full cluster, instead of using docker images. |
Contributor
There was a problem hiding this comment.
Why using such fancy word to describe "developers"?
Contributor
Author
There was a problem hiding this comment.
Developers include kernel devs and full stack devs. Dockers are firstly niticed and tried by the latter.
docs/state-store-overview.md
Outdated
| ### Read Path | ||
|
|
||
| To read from Hummock, we will first need a ***version*** (a consistent state of list of SSTs we can read). To avoid contacting Hummock manager in every user read, the Hummock client will cache a most recent ***version*** locally. Local version will be updated when 1) client initiates a write batch and 2) background refresher triggers. | ||
| To read from Hummock, we need a ***version*** (a consistent state of list of SSTs we can read) and and ***epoch*** to generate a consistent read snapshot. To avoid RPC with Hummock manager in every user read, the Hummock client will cache a most recent ***version*** locally. Local version will be updated when 1) client initiates a write batch and 2) background refresher triggers. |
docs/state-store-overview.md
Outdated
| As mentioned in [Read Path](#read-path), reads are performed on a ***version*** based on a given ***epoch***. During the whole read process, data from the specified read epoch cannot be removed by compaction, which is guaranteed by ***pinning an snapshot***; SSTs within a ***version*** cannot be vacuumed by compaction, which is guaranteed by ***pinning a version***. | ||
|
|
||
| The SQL frontend will get the latest epoch from meta service. Then, it will embed the epoch number into SQL plans, so that all compute nodes will read from that epoch. In theory, both SQL frontend and compute nodes will ***pin the snapshot***, to handle the case that frontend goes down and the compute nodes are still reading from Hummock (#622). However, to simplify the process, currently we *only pin on the frontend side**.* | ||
| The SQL frontend will get the latest epoch from meta service. Then, it will embed the epoch number into SQL plans, so that all compute nodes will read from that epoch (***Snapshot Isolation***). In theory, both SQL frontend and compute nodes will ***pin the snapshot***, to handle the case that frontend goes down and the compute nodes are still reading from Hummock (#622). However, to simplify the process, currently we *only pin on the frontend side**.* |
Contributor
There was a problem hiding this comment.
Don't think it's a good idea to mention Snapshot Isolation here. The consistence level we provide is somehow a little bit different.
Codecov Report
@@ Coverage Diff @@
## main #1662 +/- ##
============================================
+ Coverage 69.79% 69.90% +0.10%
Complexity 2766 2766
============================================
Files 1050 1052 +2
Lines 92481 92473 -8
Branches 1790 1790
============================================
+ Hits 64549 64642 +93
+ Misses 27041 26940 -101
Partials 891 891
Flags with carried forward coverage won't be shown. Click here to find out more.
📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
cloudcarver
approved these changes
Apr 7, 2022
skyzh
approved these changes
Apr 7, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Signed-off-by: Xiangyu (Samuel) Hu [email protected]
Checklist
Refer to a related PR or issue link (optional)