Reworded the documentation for lastByKeyColumns. #1935
Closed
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
rcaudy
requested changes
Feb 8, 2022
| * aggregated. | ||
| * is {@code IGNORE}. If {@code lastByKeyColumns == true}, it is expected that {@code table} is an add-only | ||
| * stream, or the result of an aggregation; a general refreshing table where rows can change position in | ||
| * arbitrary ways (eg, the result of {@code sort}) is not allowed. In DH engine technical terms, when |
| * is {@code IGNORE}. If {@code keySpec != null && !lastByKeyColumns}, it is expected that {@code table} will | ||
| * not produce any row shifts; that is, the publisher expects keyed tables to be streams, add-only, or | ||
| * aggregated. | ||
| * is {@code IGNORE}. If {@code lastByKeyColumns == true}, it is expected that {@code table} is an add-only |
There was a problem hiding this comment.
This is backwards. If {@code lastByKeyColumns == true} we will apply the aggregation ourselves, and so none of this wording applies.
| * is {@code IGNORE}. If {@code lastByKeyColumns == true}, it is expected that {@code table} is an add-only | ||
| * stream, or the result of an aggregation; a general refreshing table where rows can change position in | ||
| * arbitrary ways (eg, the result of {@code sort}) is not allowed. In DH engine technical terms, when | ||
| * {@code lastByKeyColumns == true} the updates to {@code table} should not produce any row shifts. A table |
There was a problem hiding this comment.
There is a debate to be had about whether we actually want to restrict shifts for keyed tables. I remain convinced that the answer is yes. @cpwright should weigh in as well.
|
I don't think I am adding any value here; this change is so small that is easily replicated as a new PR, and Charles and/or Ryan are in a much better position to decide what this javadoc should say, I add not value being in the middle of it. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Original discussion here:
#1825 (comment)