You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by GitBox <gi...@apache.org> on 2022/06/17 00:45:08 UTC
[GitHub] [spark] gengliangwang opened a new pull request, #36896: [SPARK-39497][SQL] Improve the analysis exception of missing map key column
gengliangwang opened a new pull request, #36896:
URL: https://github.com/apache/spark/pull/36896
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a faster review.
7. If you want to add a new configuration, please read the guideline first for naming configurations in
'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
8. If you want to add or modify an error type or message, please read the guideline first in
'core/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
Sometimes users forgot to add single quotes on the map key string literal, for example `map_col[a]`. In such a case, the Analyzer will throw an exception:
```
[MISSING_COLUMN] Column 'struct.a' does not exist. Did you mean one of the following? ...
```
We can improve this message by saying that the user should append single quotes if the map key is a string literal.
```
[UNRESOLVED_MAP_KEY] Cannot resolve column 'a' as a map key. If the key is a string literal, please add single quotes around it. Otherwise, did you mean one of the following column(s)? ...
```
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
Error message improvement
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as the documentation fix.
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
Yes but trivial, an improvement on the error message of unresolved map key column
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why it was difficult to add.
If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
-->
New UT
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] gengliangwang closed pull request #36896: [SPARK-39497][SQL] Improve the analysis exception of missing map key column
Posted by GitBox <gi...@apache.org>.
gengliangwang closed pull request #36896: [SPARK-39497][SQL] Improve the analysis exception of missing map key column
URL: https://github.com/apache/spark/pull/36896
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] gengliangwang commented on a diff in pull request #36896: [SPARK-39497][SQL] Improve the analysis exception of missing map key column
Posted by GitBox <gi...@apache.org>.
gengliangwang commented on code in PR #36896:
URL: https://github.com/apache/spark/pull/36896#discussion_r899667100
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/analysis/CheckAnalysis.scala:
##########
@@ -160,28 +181,28 @@ trait CheckAnalysis extends PredicateHelper with LookupCatalog {
throw QueryCompilationErrors.commandUnsupportedInV2TableError("SHOW TABLE EXTENDED")
case operator: LogicalPlan =>
- // Check argument data types of higher-order functions downwards first.
- // If the arguments of the higher-order functions are resolved but the type check fails,
- // the argument functions will not get resolved, but we should report the argument type
- // check failure instead of claiming the argument functions are unresolved.
operator transformExpressionsDown {
+ // Check argument data types of higher-order functions downwards first.
+ // If the arguments of the higher-order functions are resolved but the type check fails,
+ // the argument functions will not get resolved, but we should report the argument type
+ // check failure instead of claiming the argument functions are unresolved.
case hof: HigherOrderFunction
if hof.argumentsResolved && hof.checkArgumentDataTypes().isFailure =>
hof.checkArgumentDataTypes() match {
case TypeCheckResult.TypeCheckFailure(message) =>
hof.failAnalysis(
s"cannot resolve '${hof.sql}' due to argument data type mismatch: $message")
}
+
+ // If an attribute can't be resolved as a map key of string type, either the key should be
+ // surrounded with single quotes, or there is a typo in the attribute name.
Review Comment:
I tried to match `element_at` and `try_element_at` here. But before the functions are not resolved yet in the rule `ResolveFunctions`, the error `MISSING_COLUMN` is thrown.
Checking the unresolved function name and arguments can work but is quite ugly. I decided to handle the `[]` operator first.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] gengliangwang commented on pull request #36896: [SPARK-39497][SQL] Improve the analysis exception of missing map key column
Posted by GitBox <gi...@apache.org>.
gengliangwang commented on PR #36896:
URL: https://github.com/apache/spark/pull/36896#issuecomment-1160696817
Merging to master
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on a diff in pull request #36896: [SPARK-39497][SQL] Improve the analysis exception of missing map key column
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on code in PR #36896:
URL: https://github.com/apache/spark/pull/36896#discussion_r899711639
##########
sql/core/src/test/scala/org/apache/spark/sql/errors/QueryCompilationErrorsSuite.scala:
##########
@@ -401,6 +401,24 @@ class QueryCompilationErrorsSuite
)
}
+ test("UNRESOLVED_MAP_KEY: string type literal should be quoted") {
+ checkAnswer(sql("select m['a'] from (select map('a', 'b') as m, 'aa' as aa)"), Row("b"))
+ checkErrorClass(
+ exception = intercept[AnalysisException] {
+ sql("select m[a] from (select map('a', 'b') as m, 'aa' as aa)")
Review Comment:
In `CheckAnalysis`, how can we distinguish `m.a` and `m[a]`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] gengliangwang commented on a diff in pull request #36896: [SPARK-39497][SQL] Improve the analysis exception of missing map key column
Posted by GitBox <gi...@apache.org>.
gengliangwang commented on code in PR #36896:
URL: https://github.com/apache/spark/pull/36896#discussion_r900509293
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/analysis/CheckAnalysis.scala:
##########
@@ -91,6 +91,27 @@ trait CheckAnalysis extends PredicateHelper with LookupCatalog {
}
}
+ private def isMapWithStringKey(e: Expression): Boolean = if (e.resolved) {
+ e.dataType match {
+ case m: MapType => m.keyType.isInstanceOf[StringType]
+ case _ => false
+ }
+ } else {
+ false
+ }
+
+ private def failUnresolvedAttribute(
+ operator: LogicalPlan,
+ a: Attribute,
+ errorClass: String): Nothing = {
+ val unresolvedAttribute = a.sql
+ val candidates = operator.inputSet.toSeq.map(_.qualifiedName)
+ val orderedCandidates = StringUtils.orderStringsBySimilarity(unresolvedAttribute, candidates)
+ a.failAnalysis(
+ errorClass = errorClass,
+ messageParameters = Array(unresolvedAttribute, orderedCandidates.mkString(", ")))
Review Comment:
I see. I will update this one after https://github.com/apache/spark/pull/36891 is merged.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] gengliangwang commented on pull request #36896: [SPARK-39497][SQL] Improve the analysis exception of missing map key column
Posted by GitBox <gi...@apache.org>.
gengliangwang commented on PR #36896:
URL: https://github.com/apache/spark/pull/36896#issuecomment-1158348777
cc @srielau as well
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] srielau commented on a diff in pull request #36896: [SPARK-39497][SQL] Improve the analysis exception of missing map key column
Posted by GitBox <gi...@apache.org>.
srielau commented on code in PR #36896:
URL: https://github.com/apache/spark/pull/36896#discussion_r900499746
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/analysis/CheckAnalysis.scala:
##########
@@ -91,6 +91,27 @@ trait CheckAnalysis extends PredicateHelper with LookupCatalog {
}
}
+ private def isMapWithStringKey(e: Expression): Boolean = if (e.resolved) {
+ e.dataType match {
+ case m: MapType => m.keyType.isInstanceOf[StringType]
+ case _ => false
+ }
+ } else {
+ false
+ }
+
+ private def failUnresolvedAttribute(
+ operator: LogicalPlan,
+ a: Attribute,
+ errorClass: String): Nothing = {
+ val unresolvedAttribute = a.sql
+ val candidates = operator.inputSet.toSeq.map(_.qualifiedName)
+ val orderedCandidates = StringUtils.orderStringsBySimilarity(unresolvedAttribute, candidates)
+ a.failAnalysis(
+ errorClass = errorClass,
+ messageParameters = Array(unresolvedAttribute, orderedCandidates.mkString(", ")))
Review Comment:
Both candidates and unresolvedAttribute should be wrapped with toSQLId
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] gengliangwang commented on a diff in pull request #36896: [SPARK-39497][SQL] Improve the analysis exception of missing map key column
Posted by GitBox <gi...@apache.org>.
gengliangwang commented on code in PR #36896:
URL: https://github.com/apache/spark/pull/36896#discussion_r899747324
##########
sql/core/src/test/scala/org/apache/spark/sql/errors/QueryCompilationErrorsSuite.scala:
##########
@@ -401,6 +401,24 @@ class QueryCompilationErrorsSuite
)
}
+ test("UNRESOLVED_MAP_KEY: string type literal should be quoted") {
+ checkAnswer(sql("select m['a'] from (select map('a', 'b') as m, 'aa' as aa)"), Row("b"))
+ checkErrorClass(
+ exception = intercept[AnalysisException] {
+ sql("select m[a] from (select map('a', 'b') as m, 'aa' as aa)")
Review Comment:
m.a is equivalent to m['a'] so it won't fail analysis
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org