-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
chore: added wal/snapshot doc #25856
base: main
Are you sure you want to change the base?
Conversation
8cc5d20
to
b5f00f1
Compare
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.
Looking good I just had a couple comments.
│ ┌────────────┐ | ||
└───────────────►│clear buffer│ (whatever snapshotted is removed) | ||
└────────────┘ | ||
``` |
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.
A useful addition to this diagram would be to show the entry point for writes from user, i.e., where do writes go from the user (wal buffer
?), via an arrow. Otherwise, it is not clear on the order of operations. If you could connect the numbers from the steps described below to locations / arrows on the diagram, that would be helpful.
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.
Good point - I'll try to link the steps to the diagram and add the incoming writes as well.
If going ahead with force snapshotting, pick all the wal periods in the tracker and find the max time from most recent wal period. This will be | ||
used as the `end_time_marker` to evict data from query buffer. Because forcing a snapshot can be triggered when wal buffer is empty (even though | ||
queryable buffer is full), we need to add `Noop` (a no-op WalOp) to the wal file to hold the snapshot details in wal file. | ||
|
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.
Add a header on this diagram, e.g.,
##### Forced snapshot
Moving some of my work notes into a doc (might be handy to understand the wal/snapshotting process)