[SPARK-39419][SQL] Fix ArraySort to throw an exception when the comparator returns null #36812
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
HyukjinKwon
reviewed
Jun 9, 2022
sql/catalyst/src/main/scala/org/apache/spark/sql/internal/SQLConf.scala
Outdated
Show resolved
Hide resolved
HyukjinKwon
reviewed
Jun 9, 2022
sql/catalyst/src/main/scala/org/apache/spark/sql/errors/QueryExecutionErrors.scala
Outdated
Show resolved
Hide resolved
HyukjinKwon
approved these changes
Jun 9, 2022
Member
HyukjinKwon
left a comment
HyukjinKwon
left a comment
There was a problem hiding this comment.
LGTM otherwise. two questions
| argument: Expression, | ||
| function: Expression) | ||
| function: Expression, | ||
| handleComparisonResultNullAsZero: Boolean) |
Member
There was a problem hiding this comment.
How about failOnNullComparisonResult?
gengliangwang
approved these changes
Jun 9, 2022
| .createWithDefault(false) | ||
|
|
||
| val LEGACY_ARRAY_SORT_FAILS_ON_NULL_COMPARISON_RESULT = | ||
| buildConf("spark.sql.legacy.arraySortFailsOnNullComparisonResult") |
Member
There was a problem hiding this comment.
I feel the "fail" behavior is the legacy one from the new conf name. The previous name was good. Or we can follow the other conf style spark.sql.legacy.allowNullComparisonResultInArraySort.
Sorry about the previous trivial comment: #36812 (comment)
Member
Author
There was a problem hiding this comment.
No worries, thanks for the suggestions!
spark.sql.legacy.allowNullComparisonResultInArraySort sounds better to me.
cloud-fan
reviewed
Jun 9, 2022
| }, | ||
| "NULL_COMPARISON_RESULT" : { | ||
| "message" : [ | ||
| "The comparison result is null. If you want to handle null as 0 (equal), you can set \"<config>\" to \"<value>\"." |
Contributor
There was a problem hiding this comment.
actually, why not hardcode the config name and value here?
Member
Author
There was a problem hiding this comment.
I just thought it could be reusable. Let me just change to hardcode it for now.
gengliangwang
approved these changes
Jun 9, 2022
cloud-fan
approved these changes
Jun 10, 2022
Contributor
|
@ueshin please fix the conflicts, thanks! |
| .doc("When set to false, `array_sort` function throws an error " + | ||
| "if the comparator function returns null. " + | ||
| "If set to true, it restores the legacy behavior that handles null as zero (equal).") | ||
| .version("3.2.2") |
Contributor
There was a problem hiding this comment.
This is not a 3.3 regression so technically not a release blocker.
Contributor
|
thanks, merging to master! @ueshin can you open backport PRs for 3.2 and 3.3? |
dongjoon-hyun
pushed a commit
that referenced
this pull request
Jun 10, 2022
…comparator returns null ### What changes were proposed in this pull request? Backport of #36812. Fixes `ArraySort` to throw an exception when the comparator returns `null`. Also updates the doc to follow the corrected behavior. ### Why are the changes needed? When the comparator of `ArraySort` returns `null`, currently it handles it as `0` (equal). According to the doc, ``` It returns -1, 0, or 1 as the first element is less than, equal to, or greater than the second element. If the comparator function returns other values (including null), the function will fail and raise an error. ``` It's fine to return non -1, 0, 1 integers to follow the Java convention (still need to update the doc, though), but it should throw an exception for `null` result. ### Does this PR introduce _any_ user-facing change? Yes, if a user uses a comparator that returns `null`, it will throw an error after this PR. The legacy flag `spark.sql.legacy.allowNullComparisonResultInArraySort` can be used to restore the legacy behavior that handles `null` as `0` (equal). ### How was this patch tested? Added some tests. Closes #36834 from ueshin/issues/SPARK-39419/3.3/array_sort. Authored-by: Takuya UESHIN <[email protected]> Signed-off-by: Dongjoon Hyun <[email protected]>
dongjoon-hyun
pushed a commit
that referenced
this pull request
Jun 10, 2022
…comparator returns null ### What changes were proposed in this pull request? Backport of #36812. Fixes `ArraySort` to throw an exception when the comparator returns `null`. Also updates the doc to follow the corrected behavior. ### Why are the changes needed? When the comparator of `ArraySort` returns `null`, currently it handles it as `0` (equal). According to the doc, ``` It returns -1, 0, or 1 as the first element is less than, equal to, or greater than the second element. If the comparator function returns other values (including null), the function will fail and raise an error. ``` It's fine to return non -1, 0, 1 integers to follow the Java convention (still need to update the doc, though), but it should throw an exception for `null` result. ### Does this PR introduce _any_ user-facing change? Yes, if a user uses a comparator that returns `null`, it will throw an error after this PR. The legacy flag `spark.sql.legacy.allowNullComparisonResultInArraySort` can be used to restore the legacy behavior that handles `null` as `0` (equal). ### How was this patch tested? Added some tests. Closes #36835 from ueshin/issues/SPARK-39419/3.2/array_sort. Authored-by: Takuya UESHIN <[email protected]> Signed-off-by: Dongjoon Hyun <[email protected]>
sunchao
pushed a commit
to sunchao/spark
that referenced
this pull request
Jun 2, 2023
…comparator returns null Backport of apache#36812. Fixes `ArraySort` to throw an exception when the comparator returns `null`. Also updates the doc to follow the corrected behavior. When the comparator of `ArraySort` returns `null`, currently it handles it as `0` (equal). According to the doc, ``` It returns -1, 0, or 1 as the first element is less than, equal to, or greater than the second element. If the comparator function returns other values (including null), the function will fail and raise an error. ``` It's fine to return non -1, 0, 1 integers to follow the Java convention (still need to update the doc, though), but it should throw an exception for `null` result. Yes, if a user uses a comparator that returns `null`, it will throw an error after this PR. The legacy flag `spark.sql.legacy.allowNullComparisonResultInArraySort` can be used to restore the legacy behavior that handles `null` as `0` (equal). Added some tests. Closes apache#36835 from ueshin/issues/SPARK-39419/3.2/array_sort. Authored-by: Takuya UESHIN <[email protected]> Signed-off-by: Dongjoon Hyun <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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?
Fixes
ArraySortto throw an exception when the comparator returnsnull.Also updates the doc to follow the corrected behavior.
Why are the changes needed?
When the comparator of
ArraySortreturnsnull, currently it handles it as0(equal).According to the doc,
It's fine to return non -1, 0, 1 integers to follow the Java convention (still need to update the doc, though), but it should throw an exception for
nullresult.Does this PR introduce any user-facing change?
Yes, if a user uses a comparator that returns
null, it will throw an error after this PR.The legacy flag
spark.sql.legacy.allowNullComparisonResultInArraySortcan be used to restore the legacy behavior that handlesnullas0(equal).How was this patch tested?
Added some tests.