docs: update composite chunker README to reflect KeyAboveHighWatermark implementation#699
Merged
morgo merged 3 commits intoblock:mainfrom Apr 27, 2026
Merged
Conversation
aparajon
approved these changes
Apr 23, 2026
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
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.
A Pull Request should be associated with an Issue.
Related: issue #479
Summary
The
pkg/table/README.mdstated that the composite chunker "always returnsFALSEfor theKeyAboveHighWatermarkoptimization" and that it might be implemented in the future. This is no longer accurate — issue #479 has been implemented and the composite chunker now performs real key comparisons usingDatumtypes.Updated the README to accurately describe the current behavior:
KeyAboveHighWatermarkworks correctly for numeric, binary, and temporal primary key typesVARCHAR/TEXTcolumns with collations, Go's byte-order comparison may differ from MySQL's collation orderAlso verified
pkg/migration/README.md— its reference to issue #479 is in a different context (deadlock reduction) and remains accurate, so no changes were needed there.Also removes
paths-ignorefrom CI checks. This works well with optional checks, but since our checks are required, it leaves the PR in an un-mergeable state.