[SPARK-41131][SQL] Improve error message for UNRESOLVED_MAP_KEY.WITHOUT_SUGGESTION
#38646
Conversation
This file contains 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
MaxGekk
requested changes
Nov 14, 2022
| @@ -1044,7 +1044,7 @@ | |||
| }, | |||
| "UNRESOLVED_MAP_KEY" : { | |||
| "message" : [ | |||
| "Cannot resolve column <objectName> as a map key. If the key is a string literal, please add single quotes around it." | |||
| "Cannot resolve column <objectName> as a map key. If the key is a string literal, add single quotes around it: '<object_name>'." | |||
There was a problem hiding this comment.
- I don't see that we pass
object_name. Maybe,objectName? - We quite
objectNameby back ticks, and how it will looks like'`a`'?
There was a problem hiding this comment.
Oh... I see.
Just updated the PR description.
Maybe we can just remove the example in the error message since the printing message like '`a`' could confuse ??
There was a problem hiding this comment.
Maybe we can just remove the example in the error message
ok. Let's remove the example. You can show which quotes to add:
"Cannot resolve column <objectName> as a map key. If the key is a string literal, add the single quotes '' around it."
There was a problem hiding this comment.
Sounds good. Just updated!
MaxGekk
approved these changes
Nov 23, 2022
|
+1, LGTM. Merging to master. |
beliefer
pushed a commit
to beliefer/spark
that referenced
this pull request
Dec 15, 2022
…OUT_SUGGESTION` ### What changes were proposed in this pull request? This PR proposes to improve error message for `UNRESOLVED_MAP_KEY.WITHOUT_SUGGESTION`. ### Why are the changes needed? Printing the single quotes in error message as an example would more helpful for users, and we don't need 'please' in the error message. See https://spark.apache.org/error-message-guidelines.html more detail. ### Does this PR introduce _any_ user-facing change? Minor error message improvement. From ``` Cannot resolve column `col1` as a map key. If the key is a string literal, please add single quotes around it. ``` To ``` Cannot resolve column `col1` as a map key. If the key is a string literal, add single quotes '' around it. ``` ### How was this patch tested? The existing CI should pass. Closes apache#38646 from itholic/SPARK-41131. Authored-by: itholic <haejoon.lee@databricks.com> Signed-off-by: Max Gekk <max.gekk@gmail.com>
beliefer
pushed a commit
to beliefer/spark
that referenced
this pull request
Dec 18, 2022
…OUT_SUGGESTION` ### What changes were proposed in this pull request? This PR proposes to improve error message for `UNRESOLVED_MAP_KEY.WITHOUT_SUGGESTION`. ### Why are the changes needed? Printing the single quotes in error message as an example would more helpful for users, and we don't need 'please' in the error message. See https://spark.apache.org/error-message-guidelines.html more detail. ### Does this PR introduce _any_ user-facing change? Minor error message improvement. From ``` Cannot resolve column `col1` as a map key. If the key is a string literal, please add single quotes around it. ``` To ``` Cannot resolve column `col1` as a map key. If the key is a string literal, add single quotes '' around it. ``` ### How was this patch tested? The existing CI should pass. Closes apache#38646 from itholic/SPARK-41131. Authored-by: itholic <haejoon.lee@databricks.com> Signed-off-by: Max Gekk <max.gekk@gmail.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 proposes to improve error message for
UNRESOLVED_MAP_KEY.WITHOUT_SUGGESTION.Why are the changes needed?
Printing the single quotes in error message as an example would more helpful for users, and we don't need 'please' in the error message. See https://spark.apache.org/error-message-guidelines.html more detail.
Does this PR introduce any user-facing change?
Minor error message improvement.
From
To
How was this patch tested?
The existing CI should pass.