Documentation: Clarify revisions vs. versions in data model doc #9487
Conversation
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
hexfusion
reviewed
Mar 24, 2018
Documentation/learning/data_model.md
Outdated
|
|
||
| A key’s lifetime spans a generation, denoted by its version. Each key may have one or multiple generations. Creating a key increments the version of that key, starting at 1 if the key never existed. Deleting a key generates a key tombstone, concluding the key’s current generation by resetting its version. Each modification of a key increments its version. Once a compaction happens, any version ended before the given revision will be removed and values set before the compaction revision except the latest one will be removed. | ||
| A key's lifetime spans a generation, from creation to deletion. Each key may have one or multiple generations. Creating a key increments the **version** of that key, starting at 1 if the key does not exist at the current revision. Deleting a key generates a key tombstone, concluding the key’s current generation by resetting its version to 0. Each modification of a key increments its version; so, versions are monotonically increasing within a key's generation. Once a compaction happens, any generation ended before the compaction revision will be removed, and values set before the compaction revision except the latest one will be removed. |
There was a problem hiding this comment.
A key's lifetime spans a generation, from creation to deletion.
s/lifetime/life?
There was a problem hiding this comment.
Sure; done.
("lifetime" was the original; I don't have an opinion one way or another.)
This confused me just looking at the protos; reading up on #6518 helped clarify things. I highlighted the terms that show up as fields in protos and tried to clean up some of the language.
cceckman
changed the title
|
Done (I think- may need to poke Travis after retitling the issue, if I'm reading it right.) |
|
lgtm |
|
@cceckman Travis retests after new push, all set. |
hexfusion
approved these changes
Mar 24, 2018
gyuho
approved these changes
Mar 26, 2018
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.
This confused me just looking at the protos; reading up on #6518 helped clarify things. I highlighted the terms that show up as fields in protos and tried to clean up some of the language.