MINOR: Docs on state store instantiation - #5698
Merged
guozhangwang merged 4 commits intoOct 3, 2018
Merged
Conversation
mjsax
reviewed
Oct 1, 2018
| * The implementation of this function must register the root store in the context via the | ||
| * {@link ProcessorContext#register(StateStore, StateRestoreCallback)} function, where the | ||
| * first {@code StateStore} parameter should always be the passed-in {@code root} object, and the | ||
| * second {@code StateRestoreCallback} is what users need to instantiate. |
Member
There was a problem hiding this comment.
what users need to instantiate
Unclear what this means.
| * {@link ProcessorContext#register(StateStore, StateRestoreCallback)} function, where the | ||
| * first {@code StateStore} parameter should always be the passed-in {@code root} object, and the | ||
| * second {@code StateRestoreCallback} is what users need to instantiate. | ||
| * |
| * | ||
| * Note that if the state store implementation itself supports bulk writes, users can implement another | ||
| * interface {@link BatchingStateRestoreCallback} which extends {@link StateRestoreCallback} and could | ||
| * let users instantiate bulk-load restoration logic instead of restoring one record at a time. |
Member
There was a problem hiding this comment.
let users instantiate -- who is "users" ?
mjsax
approved these changes
Oct 3, 2018
mjsax
left a comment
mjsax
left a comment
Member
There was a problem hiding this comment.
LGTM.
One minor formatting nit. Feel free to merge.
| /** | ||
| * Initializes this state store | ||
| * Initializes this state store. | ||
| * |
Member
There was a problem hiding this comment.
If we want a new paragraph, we need to insert <p> here.
pengxiaolong
pushed a commit
to pengxiaolong/kafka
that referenced
this pull request
Jun 14, 2019
Reviewers: Bill Bejeck <bill@confluent.io>, Matthias J. Sax <matthias@confluent.io>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Committer Checklist (excluded from commit message)