[docs] Add missing executeFilter() call in Java API read examples #6892
Conversation
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
This fixes the documentation where the filter conditions would not take effect because executeFilter() was not being called after newRead(). Without calling executeFilter(), the filters specified through withFilter() are not applied when reading data. Closes apache#2932
JingsongLi
reviewed
Dec 25, 2025
|
|
||
| // 4. Read a split in task | ||
| TableRead read = readBuilder.newRead(); | ||
| TableRead read = readBuilder.newRead().executeFilter(); |
Contributor
There was a problem hiding this comment.
Maybe you can explain this.
// You can use executeFilter to do filter per record
// By default, only capable of performing coarse-grained filtering
read.executeFilter();
Add explanatory comments for executeFilter() call based on review feedback: - You can use executeFilter to do filter per record - By default, only capable of performing coarse-grained filtering
Contributor
|
+1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Purpose
Linked issue: close #2932
The current Java API documentation examples for Batch Read and Stream Read are missing the
executeFilter()call afternewRead(). Without callingexecuteFilter(), the filter conditions specified throughwithFilter()will not take effect when reading data.This PR adds the missing
executeFilter()call to both examples:Tests
This is a documentation-only change. No code tests are needed.
API and Format
This change does not affect API or storage format. It only fixes the documentation examples.
Documentation
This change fixes existing documentation. No new feature is introduced.