Improve batch docs #126
Merged
Improve batch docs #126
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
LuKks
commented
Jun 29, 2023
README.md
Outdated
| @@ -168,6 +168,14 @@ Make a new atomic batch that is either fully processed or not processed at all. | |||
|
|
|||
| If you have several inserts and deletions then a batch can be much faster. | |||
|
|
|||
| Batch is snapshotted at creation. Outside writes are not taken into account when reading. | |||
There was a problem hiding this comment.
Not highly true:
const batch = await db.batch()
t.is(batch.version, 1)
await db.put('/a')
t.is(batch.version, 2)
console.log(await batch.get('/a')) // => { seq, key, value }So state is not snapshotted?
There was a problem hiding this comment.
A put (obvs) updates the snap.
There was a problem hiding this comment.
It's a db.put external write outside of batch, is that intended to update the snap of the batch?
There was a problem hiding this comment.
Ah db my bad. I'd prefer to leave this be for now. Its due to update being called. This needs some (breaking) refactor to remove all update calls
mafintosh
reviewed
Jun 29, 2023
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.
Thanks @HDegroote the initial explanation: 08a3fca
I didn't even know that we had a lock method lol