Skip to content

[SPARK-56868][SQL][FOLLOW-UP] Clarify scaladoc for V2 runtime filter helpers#55958

Open
szehon-ho wants to merge 3 commits into
apache:masterfrom
szehon-ho:spark-56868-cleanup
Open

[SPARK-56868][SQL][FOLLOW-UP] Clarify scaladoc for V2 runtime filter helpers#55958
szehon-ho wants to merge 3 commits into
apache:masterfrom
szehon-ho:spark-56868-cleanup

Conversation

@szehon-ho
Copy link
Copy Markdown
Member

What changes were proposed in this pull request?

Clarify scaladoc for PushDownUtils.pushRuntimeFilters and PushDownUtils.replanWithRuntimeFilters introduced in SPARK-56868 (#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.

…helpers

Move the mutating-scan note to pushRuntimeFilters and consolidate
replanWithRuntimeFilters preconditions into a Notes list.
szehon-ho added 2 commits May 18, 2026 14:27
…ithRuntimeFilters

Document that both original and re-planned splits must implement HasPartitionKey
on the KeyedPartitioning path.
@szehon-ho
Copy link
Copy Markdown
Member Author

@vitaliili-db @gengliangwang @cloud-fan does it make sense?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant