[SPARK-42746][SQL][FOLLOWUP] Correct the comments for SupportsOrderingWithinGroup and Mode #49907
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
There was a problem hiding this comment.
cc @mikhailnik-db , @cloud-fan because this is a follow-up of
cloud-fan
reviewed
Feb 13, 2025
...atalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/aggregate/percentiles.scala
Show resolved
Hide resolved
Comment on lines
28
to
44
| /** Indicator that ordering was set. */ | ||
| def orderingFilled: Boolean | ||
| def orderingFilled: Boolean = false | ||
|
|
||
| /** | ||
| * Tells Analyzer that WITHIN GROUP (ORDER BY ...) is mandatory for function. | ||
| * | ||
| * @see [[QueryCompilationErrors.functionMissingWithinGroupError]] | ||
| */ | ||
| def isOrderingMandatory: Boolean | ||
| def isOrderingMandatory: Boolean = true | ||
|
|
||
| /** | ||
| * Tells Analyzer that DISTINCT is supported. | ||
| * The DISTINCT can conflict with order so some functions can ban it. | ||
| * | ||
| * @see [[QueryCompilationErrors.functionMissingWithinGroupError]] | ||
| * @see [[QueryCompilationErrors.distinctWithOrderingFunctionUnsupportedError]] | ||
| */ | ||
| def isDistinctSupported: Boolean | ||
| def isDistinctSupported: Boolean = false |
There was a problem hiding this comment.
I don't like the idea of default flags in this trait. I think every developer should make a deliberate decision about what behavior he wants for a new function. With default values, it's easy to forget some corner cases.
Personally, as a new contributor, I saw abstract/non-implemented methods and flags as hints, which is not to forget. But about default values, you can get to know them only by reading all the code or during testing.
@cloud-fan, what do you think?
beliefer
force-pushed
the
SPARK-42746_followup2
branch
from
b9a6e08 to
0b630cc
Compare
beliefer
changed the title
cloud-fan
reviewed
Feb 16, 2025
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/aggregate/Mode.scala
Outdated
Show resolved
Hide resolved
cloud-fan
reviewed
Feb 16, 2025
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/aggregate/Mode.scala
Outdated
Show resolved
Hide resolved
beliefer
force-pushed
the
SPARK-42746_followup2
branch
from
a94f00e to
4fc2419
Compare
cloud-fan
approved these changes
Feb 17, 2025
beliefer
added a commit
that referenced
this pull request
Feb 17, 2025
…gWithinGroup and Mode ### What changes were proposed in this pull request? This PR propose to correct the comments for `SupportsOrderingWithinGroup` and `Mode`. ### Why are the changes needed? First, some comments added with incorrect style. Second, replace `QueryCompilationErrors.functionMissingWithinGroupError` with the correct `QueryCompilationErrors.distinctWithOrderingFunctionUnsupportedError`. ### Does this PR introduce _any_ user-facing change? 'No'. New feature. ### How was this patch tested? GA. ### Was this patch authored or co-authored using generative AI tooling? 'No'. Closes #49907 from beliefer/SPARK-42746_followup2. Lead-authored-by: beliefer <beliefer@163.com> Co-authored-by: Jiaan Geng <beliefer@163.com> Signed-off-by: beliefer <beliefer@163.com> (cherry picked from commit 0002cdd) Signed-off-by: beliefer <beliefer@163.com>
|
Merged into branch-4.0/master |
Pajaraja
pushed a commit
to Pajaraja/spark
that referenced
this pull request
Mar 6, 2025
…gWithinGroup and Mode ### What changes were proposed in this pull request? This PR propose to correct the comments for `SupportsOrderingWithinGroup` and `Mode`. ### Why are the changes needed? First, some comments added with incorrect style. Second, replace `QueryCompilationErrors.functionMissingWithinGroupError` with the correct `QueryCompilationErrors.distinctWithOrderingFunctionUnsupportedError`. ### Does this PR introduce _any_ user-facing change? 'No'. New feature. ### How was this patch tested? GA. ### Was this patch authored or co-authored using generative AI tooling? 'No'. Closes apache#49907 from beliefer/SPARK-42746_followup2. Lead-authored-by: beliefer <beliefer@163.com> Co-authored-by: Jiaan Geng <beliefer@163.com> Signed-off-by: beliefer <beliefer@163.com>
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.
What changes were proposed in this pull request?
This PR propose to correct the comments for
SupportsOrderingWithinGroupandMode.Why are the changes needed?
First, some comments added with incorrect style.
Second, replace
QueryCompilationErrors.functionMissingWithinGroupErrorwith the correctQueryCompilationErrors.distinctWithOrderingFunctionUnsupportedError.Does this PR introduce any user-facing change?
'No'.
New feature.
How was this patch tested?
GA.
Was this patch authored or co-authored using generative AI tooling?
'No'.