LuciferYang opened a new pull request, #38737:
URL: https://github.com/apache/spark/pull/38737
<!--
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.
-->
### 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.
-->
### 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'.
-->
### 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.
-->
--
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
MaxGekk commented on PR #38737: URL: https://github.com/apache/spark/pull/38737#issuecomment-1325150795 +1, LGTM. Merging to master. Thank you, @LuciferYang and @srielau for review. -- 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
MaxGekk closed pull request #38737: [SPARK-41174][CORE][SQL] Propagate an error class to users for invalid `format` of `to_binary()` URL: https://github.com/apache/spark/pull/38737 -- 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
LuciferYang commented on code in PR #38737:
URL: https://github.com/apache/spark/pull/38737#discussion_r1030121284
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/stringExpressions.scala:
##########
@@ -2620,46 +2620,81 @@ case class ToBinary(
nullOnInvalidFormat: Boolean = false) extends RuntimeReplaceable
with ImplicitCastInputTypes {
- override lazy val replacement: Expression = format.map { f =>
- assert(f.foldable && (f.dataType == StringType || f.dataType == NullType))
+ @transient lazy val fmt: String = format.map { f =>
val value = f.eval()
if (value == null) {
- Literal(null, BinaryType)
+ null
} else {
- value.asInstanceOf[UTF8String].toString.toLowerCase(Locale.ROOT) match {
- case "hex" => Unhex(expr, failOnError = true)
- case "utf-8" | "utf8" => Encode(expr, Literal("UTF-8"))
- case "base64" => UnBase64(expr, failOnError = true)
- case _ if nullOnInvalidFormat => Literal(null, BinaryType)
- case other => throw QueryCompilationErrors.invalidStringLiteralParameter(
- "to_binary",
- "format",
- other,
- Some(
- "The value has to be a case-insensitive string literal of " +
- "'hex', 'utf-8', 'utf8', or 'base64'."))
- }
+ value.asInstanceOf[UTF8String].toString.toLowerCase(Locale.ROOT)
+ }
+ }.getOrElse("hex")
+
+ override lazy val replacement: Expression = if (fmt == null) {
+ Literal(null, BinaryType)
+ } else {
+ fmt match {
+ case "hex" => Unhex(expr, failOnError = true)
+ case "utf-8" | "utf8" => Encode(expr, Literal("UTF-8"))
+ case "base64" => UnBase64(expr, failOnError = true)
+ case _ => Literal(null, BinaryType)
}
- }.getOrElse(Unhex(expr, failOnError = true))
+ }
def this(expr: Expression) = this(expr, None, false)
def this(expr: Expression, format: Expression) =
- this(expr, Some({
- // We perform this check in the constructor to make it eager and not go through type coercion.
- if (format.foldable && (format.dataType == StringType || format.dataType == NullType)) {
- format
- } else {
- throw QueryCompilationErrors.requireLiteralParameter("to_binary", "format", "string")
- }
- }), false)
+ this(expr, Some(format), false)
override def prettyName: String = "to_binary"
override def children: Seq[Expression] = expr +: format.toSeq
override def inputTypes: Seq[AbstractDataType] = children.map(_ => StringType)
+ override def checkInputDataTypes(): TypeCheckResult = {
+ def isValidFormat: Boolean = {
+ fmt == null || Set("hex", "utf-8", "utf8", "base64").contains(fmt)
+ }
+ format match {
+ case Some(f) =>
+ if (f.foldable && (f.dataType == StringType || f.dataType == NullType)) {
+ if (isValidFormat || nullOnInvalidFormat) {
+ super.checkInputDataTypes()
+ } else {
+ DataTypeMismatch(
+ errorSubClass = "INVALID_ARG_VALUE",
+ messageParameters = Map(
+ "inputName" -> "fmt",
+ "requireType" -> s"case-insensitive ${toSQLType(StringType)}",
+ "validValues" -> "'hex', 'utf-8', 'utf8', or 'base64'",
+ "inputValue" -> toSQLValue(fmt, StringType)
+ )
+ )
+ }
+ } else if (!f.foldable) {
+ DataTypeMismatch(
+ errorSubClass = "NON_FOLDABLE_INPUT",
Review Comment:
[36e1bda](https://github.com/apache/spark/pull/38737/commits/36e1bda1427ae754e739c70d363e4733615bd7bd) add two new case
--
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
LuciferYang commented on code in PR #38737:
URL: https://github.com/apache/spark/pull/38737#discussion_r1030187172
##########
sql/catalyst/src/test/scala/org/apache/spark/sql/catalyst/expressions/StringExpressionsSuite.scala:
##########
@@ -432,6 +432,7 @@ class StringExpressionsSuite extends SparkFunSuite with ExpressionEvalHelper {
GenerateUnsafeProjection.generate(StringDecode(b, Literal("\"quote")) :: Nil)
}
+
Review Comment:
removed
--
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
MaxGekk commented on code in PR #38737:
URL: https://github.com/apache/spark/pull/38737#discussion_r1030077573
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/stringExpressions.scala:
##########
@@ -2620,46 +2620,81 @@ case class ToBinary(
nullOnInvalidFormat: Boolean = false) extends RuntimeReplaceable
with ImplicitCastInputTypes {
- override lazy val replacement: Expression = format.map { f =>
- assert(f.foldable && (f.dataType == StringType || f.dataType == NullType))
+ @transient lazy val fmt: String = format.map { f =>
val value = f.eval()
if (value == null) {
- Literal(null, BinaryType)
+ null
} else {
- value.asInstanceOf[UTF8String].toString.toLowerCase(Locale.ROOT) match {
- case "hex" => Unhex(expr, failOnError = true)
- case "utf-8" | "utf8" => Encode(expr, Literal("UTF-8"))
- case "base64" => UnBase64(expr, failOnError = true)
- case _ if nullOnInvalidFormat => Literal(null, BinaryType)
- case other => throw QueryCompilationErrors.invalidStringLiteralParameter(
- "to_binary",
- "format",
- other,
- Some(
- "The value has to be a case-insensitive string literal of " +
- "'hex', 'utf-8', 'utf8', or 'base64'."))
- }
+ value.asInstanceOf[UTF8String].toString.toLowerCase(Locale.ROOT)
+ }
+ }.getOrElse("hex")
+
+ override lazy val replacement: Expression = if (fmt == null) {
+ Literal(null, BinaryType)
+ } else {
+ fmt match {
+ case "hex" => Unhex(expr, failOnError = true)
+ case "utf-8" | "utf8" => Encode(expr, Literal("UTF-8"))
+ case "base64" => UnBase64(expr, failOnError = true)
+ case _ => Literal(null, BinaryType)
}
- }.getOrElse(Unhex(expr, failOnError = true))
+ }
def this(expr: Expression) = this(expr, None, false)
def this(expr: Expression, format: Expression) =
- this(expr, Some({
- // We perform this check in the constructor to make it eager and not go through type coercion.
- if (format.foldable && (format.dataType == StringType || format.dataType == NullType)) {
- format
- } else {
- throw QueryCompilationErrors.requireLiteralParameter("to_binary", "format", "string")
- }
- }), false)
+ this(expr, Some(format), false)
override def prettyName: String = "to_binary"
override def children: Seq[Expression] = expr +: format.toSeq
override def inputTypes: Seq[AbstractDataType] = children.map(_ => StringType)
+ override def checkInputDataTypes(): TypeCheckResult = {
+ def isValidFormat: Boolean = {
+ fmt == null || Set("hex", "utf-8", "utf8", "base64").contains(fmt)
+ }
+ format match {
+ case Some(f) =>
+ if (f.foldable && (f.dataType == StringType || f.dataType == NullType)) {
+ if (isValidFormat || nullOnInvalidFormat) {
+ super.checkInputDataTypes()
+ } else {
+ DataTypeMismatch(
+ errorSubClass = "INVALID_ARG_VALUE",
+ messageParameters = Map(
+ "inputName" -> "fmt",
+ "requireType" -> s"case-insensitive ${toSQLType(StringType)}",
+ "validValues" -> "'hex', 'utf-8', 'utf8', or 'base64'",
+ "inputValue" -> toSQLValue(fmt, StringType)
+ )
+ )
+ }
+ } else if (!f.foldable) {
+ DataTypeMismatch(
+ errorSubClass = "NON_FOLDABLE_INPUT",
Review Comment:
Could you write a test for the case, please. I just wonder how it could happen:
```scala
if (f.foldable && ...) {
...
} else if (!f.foldable) {
```
--
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
LuciferYang commented on PR #38737: URL: https://github.com/apache/spark/pull/38737#issuecomment-1323234015 @MaxGekk rebased -- 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
LuciferYang commented on PR #38737: URL: https://github.com/apache/spark/pull/38737#issuecomment-1321843391 cc @MaxGekk -- 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
MaxGekk commented on code in PR #38737:
URL: https://github.com/apache/spark/pull/38737#discussion_r1030164334
##########
sql/catalyst/src/test/scala/org/apache/spark/sql/catalyst/expressions/StringExpressionsSuite.scala:
##########
@@ -432,6 +432,7 @@ class StringExpressionsSuite extends SparkFunSuite with ExpressionEvalHelper {
GenerateUnsafeProjection.generate(StringDecode(b, Literal("\"quote")) :: Nil)
}
+
Review Comment:
it is not needed.
--
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
MaxGekk commented on code in PR #38737:
URL: https://github.com/apache/spark/pull/38737#discussion_r1030091988
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/stringExpressions.scala:
##########
@@ -2620,46 +2620,81 @@ case class ToBinary(
nullOnInvalidFormat: Boolean = false) extends RuntimeReplaceable
with ImplicitCastInputTypes {
- override lazy val replacement: Expression = format.map { f =>
- assert(f.foldable && (f.dataType == StringType || f.dataType == NullType))
+ @transient lazy val fmt: String = format.map { f =>
val value = f.eval()
if (value == null) {
- Literal(null, BinaryType)
+ null
} else {
- value.asInstanceOf[UTF8String].toString.toLowerCase(Locale.ROOT) match {
- case "hex" => Unhex(expr, failOnError = true)
- case "utf-8" | "utf8" => Encode(expr, Literal("UTF-8"))
- case "base64" => UnBase64(expr, failOnError = true)
- case _ if nullOnInvalidFormat => Literal(null, BinaryType)
- case other => throw QueryCompilationErrors.invalidStringLiteralParameter(
- "to_binary",
- "format",
- other,
- Some(
- "The value has to be a case-insensitive string literal of " +
- "'hex', 'utf-8', 'utf8', or 'base64'."))
- }
+ value.asInstanceOf[UTF8String].toString.toLowerCase(Locale.ROOT)
+ }
+ }.getOrElse("hex")
+
+ override lazy val replacement: Expression = if (fmt == null) {
+ Literal(null, BinaryType)
+ } else {
+ fmt match {
+ case "hex" => Unhex(expr, failOnError = true)
+ case "utf-8" | "utf8" => Encode(expr, Literal("UTF-8"))
+ case "base64" => UnBase64(expr, failOnError = true)
+ case _ => Literal(null, BinaryType)
}
- }.getOrElse(Unhex(expr, failOnError = true))
+ }
def this(expr: Expression) = this(expr, None, false)
def this(expr: Expression, format: Expression) =
- this(expr, Some({
- // We perform this check in the constructor to make it eager and not go through type coercion.
- if (format.foldable && (format.dataType == StringType || format.dataType == NullType)) {
- format
- } else {
- throw QueryCompilationErrors.requireLiteralParameter("to_binary", "format", "string")
- }
- }), false)
+ this(expr, Some(format), false)
override def prettyName: String = "to_binary"
override def children: Seq[Expression] = expr +: format.toSeq
override def inputTypes: Seq[AbstractDataType] = children.map(_ => StringType)
+ override def checkInputDataTypes(): TypeCheckResult = {
+ def isValidFormat: Boolean = {
+ fmt == null || Set("hex", "utf-8", "utf8", "base64").contains(fmt)
+ }
+ format match {
+ case Some(f) =>
+ if (f.foldable && (f.dataType == StringType || f.dataType == NullType)) {
+ if (isValidFormat || nullOnInvalidFormat) {
+ super.checkInputDataTypes()
+ } else {
+ DataTypeMismatch(
+ errorSubClass = "INVALID_ARG_VALUE",
+ messageParameters = Map(
+ "inputName" -> "fmt",
+ "requireType" -> s"case-insensitive ${toSQLType(StringType)}",
+ "validValues" -> "'hex', 'utf-8', 'utf8', or 'base64'",
+ "inputValue" -> toSQLValue(fmt, StringType)
+ )
+ )
+ }
+ } else if (!f.foldable) {
+ DataTypeMismatch(
+ errorSubClass = "NON_FOLDABLE_INPUT",
Review Comment:
Yep. Just to be sure we handle the non-foldable case correctly.
--
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
LuciferYang commented on code in PR #38737:
URL: https://github.com/apache/spark/pull/38737#discussion_r1030082083
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/stringExpressions.scala:
##########
@@ -2620,46 +2620,81 @@ case class ToBinary(
nullOnInvalidFormat: Boolean = false) extends RuntimeReplaceable
with ImplicitCastInputTypes {
- override lazy val replacement: Expression = format.map { f =>
- assert(f.foldable && (f.dataType == StringType || f.dataType == NullType))
+ @transient lazy val fmt: String = format.map { f =>
val value = f.eval()
if (value == null) {
- Literal(null, BinaryType)
+ null
} else {
- value.asInstanceOf[UTF8String].toString.toLowerCase(Locale.ROOT) match {
- case "hex" => Unhex(expr, failOnError = true)
- case "utf-8" | "utf8" => Encode(expr, Literal("UTF-8"))
- case "base64" => UnBase64(expr, failOnError = true)
- case _ if nullOnInvalidFormat => Literal(null, BinaryType)
- case other => throw QueryCompilationErrors.invalidStringLiteralParameter(
- "to_binary",
- "format",
- other,
- Some(
- "The value has to be a case-insensitive string literal of " +
- "'hex', 'utf-8', 'utf8', or 'base64'."))
- }
+ value.asInstanceOf[UTF8String].toString.toLowerCase(Locale.ROOT)
+ }
+ }.getOrElse("hex")
+
+ override lazy val replacement: Expression = if (fmt == null) {
+ Literal(null, BinaryType)
+ } else {
+ fmt match {
+ case "hex" => Unhex(expr, failOnError = true)
+ case "utf-8" | "utf8" => Encode(expr, Literal("UTF-8"))
+ case "base64" => UnBase64(expr, failOnError = true)
+ case _ => Literal(null, BinaryType)
}
- }.getOrElse(Unhex(expr, failOnError = true))
+ }
def this(expr: Expression) = this(expr, None, false)
def this(expr: Expression, format: Expression) =
- this(expr, Some({
- // We perform this check in the constructor to make it eager and not go through type coercion.
- if (format.foldable && (format.dataType == StringType || format.dataType == NullType)) {
- format
- } else {
- throw QueryCompilationErrors.requireLiteralParameter("to_binary", "format", "string")
- }
- }), false)
+ this(expr, Some(format), false)
override def prettyName: String = "to_binary"
override def children: Seq[Expression] = expr +: format.toSeq
override def inputTypes: Seq[AbstractDataType] = children.map(_ => StringType)
+ override def checkInputDataTypes(): TypeCheckResult = {
+ def isValidFormat: Boolean = {
+ fmt == null || Set("hex", "utf-8", "utf8", "base64").contains(fmt)
+ }
+ format match {
+ case Some(f) =>
+ if (f.foldable && (f.dataType == StringType || f.dataType == NullType)) {
+ if (isValidFormat || nullOnInvalidFormat) {
+ super.checkInputDataTypes()
+ } else {
+ DataTypeMismatch(
+ errorSubClass = "INVALID_ARG_VALUE",
+ messageParameters = Map(
+ "inputName" -> "fmt",
+ "requireType" -> s"case-insensitive ${toSQLType(StringType)}",
+ "validValues" -> "'hex', 'utf-8', 'utf8', or 'base64'",
+ "inputValue" -> toSQLValue(fmt, StringType)
+ )
+ )
+ }
+ } else if (!f.foldable) {
+ DataTypeMismatch(
+ errorSubClass = "NON_FOLDABLE_INPUT",
Review Comment:
For `!f.foldable` branch?
--
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