Skip to content

[docs] Add missing executeFilter() call in Java API read examples #6892

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.

Sign up for GitHub

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

Merged
JingsongLi merged 2 commits into from
Dec 25, 2025
Merged

[docs] Add missing executeFilter() call in Java API read examples #6892

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9740402
[docs] Add executeFilter() call to Java API read examples
userzhy Dec 25, 2025
96c8d73
[docs] Add comments to explain executeFilter() behavior
userzhy Dec 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/content/program-api/java-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,9 @@ public class ReadTable {
// 3. Distribute these splits to different tasks

// 4. Read a split in task
TableRead read = readBuilder.newRead();
// You can use executeFilter to do filter per record.
// By default, only capable of performing coarse-grained filtering.
TableRead read = readBuilder.newRead().executeFilter();
Copy link
Contributor

@JingsongLi JingsongLi Dec 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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();

Copy link
Contributor Author

@userzhy userzhy Dec 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed, thanks!

RecordReader<InternalRow> reader = read.createReader(splits);
reader.forEachRemaining(System.out::println);
}
Expand Down Expand Up @@ -304,7 +306,9 @@ public class StreamReadTable {
// can be restored in scan.restore(state) after fail over

// 3. Read a split in task
TableRead read = readBuilder.newRead();
// You can use executeFilter to do filter per record.
// By default, only capable of performing coarse-grained filtering.
TableRead read = readBuilder.newRead().executeFilter();
RecordReader<InternalRow> reader = read.createReader(splits);
reader.forEachRemaining(System.out::println);

Expand Down