[SPARK-56868][SQL][FOLLOW-UP] Clarify scaladoc for V2 runtime filter helpers#55958
Closed
szehon-ho wants to merge 3 commits into
Closed
[SPARK-56868][SQL][FOLLOW-UP] Clarify scaladoc for V2 runtime filter helpers#55958szehon-ho wants to merge 3 commits into
szehon-ho wants to merge 3 commits into
Conversation
…helpers Move the mutating-scan note to pushRuntimeFilters and consolidate replanWithRuntimeFilters preconditions into a Notes list.
…ithRuntimeFilters Document that both original and re-planned splits must implement HasPartitionKey on the KeyedPartitioning path.
Member
Author
|
@vitaliili-db @gengliangwang @cloud-fan does it make sense? |
Contributor
|
cc @peter-toth |
peter-toth
approved these changes
May 20, 2026
Contributor
|
thanks, merging to master/4.x! |
cloud-fan
pushed a commit
that referenced
this pull request
May 21, 2026
…helpers ### What changes were proposed in this pull request? Clarify scaladoc for `PushDownUtils.pushRuntimeFilters` and `PushDownUtils.replanWithRuntimeFilters` introduced in [SPARK-56868](https://issues.apache.org/jira/browse/SPARK-56868) ([#55887](#55887)): - Document the mutating-scan constraint on `pushRuntimeFilters`, where `SupportsRuntimeV2Filtering.filter` is invoked. - Replace the mixed Note/Precondition text on `replanWithRuntimeFilters` with a concise Notes bullet list. ### Why are the changes needed? The original helper scaladoc mixed concerns (execute-time requirements, caller caching, and preconditions) and referenced `pushRuntimeFilters` from the wrong method. This follow-up makes the documentation easier to read without changing behavior. ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? Documentation-only change; existing tests cover runtime filter behavior. ### Was this patch authored or co-authored using generative AI tooling? No. Closes #55958 from szehon-ho/spark-56868-cleanup. Authored-by: Szehon Ho <szehon.apache@gmail.com> Signed-off-by: Wenchen Fan <wenchen@databricks.com> (cherry picked from commit 992290b) Signed-off-by: Wenchen Fan <wenchen@databricks.com>
Member
Author
|
thanks! |
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.
What changes were proposed in this pull request?
Clarify scaladoc for
PushDownUtils.pushRuntimeFiltersandPushDownUtils.replanWithRuntimeFiltersintroduced in SPARK-56868 (#55887):pushRuntimeFilters, whereSupportsRuntimeV2Filtering.filteris invoked.replanWithRuntimeFilterswith a concise Notes bullet list.Why are the changes needed?
The original helper scaladoc mixed concerns (execute-time requirements, caller caching, and preconditions) and referenced
pushRuntimeFiltersfrom the wrong method. This follow-up makes the documentation easier to read without changing behavior.Does this PR introduce any user-facing change?
No.
How was this patch tested?
Documentation-only change; existing tests cover runtime filter behavior.
Was this patch authored or co-authored using generative AI tooling?
No.