Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[SPARK-43485][SQL] Fix the error message for the unit argument of the datetime add/diff functions #41143

Closed
wants to merge 3 commits into from
Closed

[SPARK-43485][SQL] Fix the error message for the unit argument of the datetime add/diff functions #41143

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6d6b666
Improve the error message for the DATEADD/DIFF functions
MaxGekk May 11, 2023
166758c
Trigger build
MaxGekk May 12, 2023
a07cbd3
Merge remote-tracking branch 'origin/master' into dateadd-unit-error
MaxGekk May 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions core/src/main/resources/error/error-classes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1051,6 +1051,11 @@
"expects a binary value with 16, 24 or 32 bytes, but got <actualLength> bytes."
]
},
"DATETIME_UNIT" : {
"message" : [
"expects one of the units without quotes YEAR, QUARTER, MONTH, WEEK, DAY, DAYOFYEAR, HOUR, MINUTE, SECOND, MILLISECOND, MICROSECOND, but got the string literal <invalidValue>."
]
},
"PATTERN" : {
"message" : [
"<value>."
Expand Down
4 changes: 2 additions & 2 deletions sql/catalyst/src/main/antlr4/org/apache/spark/sql/catalyst/parser/SqlBaseParser.g4
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -892,8 +892,8 @@ datetimeUnit

primaryExpression
: name=(CURRENT_DATE | CURRENT_TIMESTAMP | CURRENT_USER | USER) #currentLike
| name=(TIMESTAMPADD | DATEADD) LEFT_PAREN unit=datetimeUnit COMMA unitsAmount=valueExpression COMMA timestamp=valueExpression RIGHT_PAREN #timestampadd
| name=(TIMESTAMPDIFF | DATEDIFF) LEFT_PAREN unit=datetimeUnit COMMA startTimestamp=valueExpression COMMA endTimestamp=valueExpression RIGHT_PAREN #timestampdiff
| name=(TIMESTAMPADD | DATEADD) LEFT_PAREN (unit=datetimeUnit | invalidUnit=stringLit) COMMA unitsAmount=valueExpression COMMA timestamp=valueExpression RIGHT_PAREN #timestampadd
| name=(TIMESTAMPDIFF | DATEDIFF) LEFT_PAREN (unit=datetimeUnit | invalidUnit=stringLit) COMMA startTimestamp=valueExpression COMMA endTimestamp=valueExpression RIGHT_PAREN #timestampdiff
| CASE whenClause+ (ELSE elseExpression=expression)? END #searchedCase
| CASE value=expression whenClause+ (ELSE elseExpression=expression)? END #simpleCase
| name=(CAST | TRY_CAST) LEFT_PAREN expression AS dataType RIGHT_PAREN #cast
Expand Down
18 changes: 16 additions & 2 deletions sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/parser/AstBuilder.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4943,14 +4943,28 @@ class AstBuilder extends SqlBaseParserBaseVisitor[AnyRef] with SQLConfHelper wit
* Create a TimestampAdd expression.
*/
override def visitTimestampadd(ctx: TimestampaddContext): Expression = withOrigin(ctx) {
TimestampAdd(ctx.unit.getText, expression(ctx.unitsAmount), expression(ctx.timestamp))
if (ctx.invalidUnit != null) {
throw QueryParsingErrors.invalidDatetimeUnitError(
ctx,
ctx.name.getText,
ctx.invalidUnit.getText)
} else {
TimestampAdd(ctx.unit.getText, expression(ctx.unitsAmount), expression(ctx.timestamp))
}
}

/**
* Create a TimestampDiff expression.
*/
override def visitTimestampdiff(ctx: TimestampdiffContext): Expression = withOrigin(ctx) {
TimestampDiff(ctx.unit.getText, expression(ctx.startTimestamp), expression(ctx.endTimestamp))
if (ctx.invalidUnit != null) {
throw QueryParsingErrors.invalidDatetimeUnitError(
ctx,
ctx.name.getText,
ctx.invalidUnit.getText)
} else {
TimestampDiff(ctx.unit.getText, expression(ctx.startTimestamp), expression(ctx.endTimestamp))
}
}

/**
Expand Down
14 changes: 14 additions & 0 deletions sql/catalyst/src/main/scala/org/apache/spark/sql/errors/QueryParsingErrors.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -669,4 +669,18 @@ private[sql] object QueryParsingErrors extends QueryErrorsBase {
ctx
)
}

def invalidDatetimeUnitError(
ctx: ParserRuleContext,
functionName: String,
invalidValue: String): Throwable = {
new ParseException(
errorClass = "INVALID_PARAMETER_VALUE.DATETIME_UNIT",
messageParameters = Map(
"functionName" -> toSQLId(functionName),
"parameter" -> toSQLId("unit"),
"invalidValue" -> invalidValue),
ctx
)
}
}
88 changes: 88 additions & 0 deletions sql/core/src/test/resources/sql-tests/analyzer-results/ansi/date.sql.out
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -807,6 +807,50 @@ select dateadd(YEAR, 1, date'2022-02-25')
[Analyzer test output redacted due to nondeterminism]


-- !query
select dateadd('MICROSECOND', 1001, timestamp'2022-02-25 01:02:03.123')
-- !query analysis
org.apache.spark.sql.catalyst.parser.ParseException
{
"errorClass" : "INVALID_PARAMETER_VALUE.DATETIME_UNIT",
"sqlState" : "22023",
"messageParameters" : {
"functionName" : "`dateadd`",
"invalidValue" : "'MICROSECOND'",
"parameter" : "`unit`"
},
"queryContext" : [ {
"objectType" : "",
"objectName" : "",
"startIndex" : 8,
"stopIndex" : 71,
"fragment" : "dateadd('MICROSECOND', 1001, timestamp'2022-02-25 01:02:03.123')"
} ]
}


-- !query
select dateadd('QUARTER', 5, date'2022-02-25')
-- !query analysis
org.apache.spark.sql.catalyst.parser.ParseException
{
"errorClass" : "INVALID_PARAMETER_VALUE.DATETIME_UNIT",
"sqlState" : "22023",
"messageParameters" : {
"functionName" : "`dateadd`",
"invalidValue" : "'QUARTER'",
"parameter" : "`unit`"
},
"queryContext" : [ {
"objectType" : "",
"objectName" : "",
"startIndex" : 8,
"stopIndex" : 46,
"fragment" : "dateadd('QUARTER', 5, date'2022-02-25')"
} ]
}


-- !query
select datediff(MICROSECOND, timestamp'2022-02-25 01:02:03.123', timestamp'2022-02-25 01:02:03.124001')
-- !query analysis
Expand Down Expand Up @@ -865,3 +909,47 @@ select datediff(QUARTER, date'2022-02-25', date'2023-05-25')
select datediff(YEAR, date'2022-02-25', date'2023-02-25')
-- !query analysis
[Analyzer test output redacted due to nondeterminism]


-- !query
select datediff('MILLISECOND', timestamp'2022-02-25 01:02:03.456', timestamp'2022-02-25 01:02:03.455')
-- !query analysis
org.apache.spark.sql.catalyst.parser.ParseException
{
"errorClass" : "INVALID_PARAMETER_VALUE.DATETIME_UNIT",
"sqlState" : "22023",
"messageParameters" : {
"functionName" : "`datediff`",
"invalidValue" : "'MILLISECOND'",
"parameter" : "`unit`"
},
"queryContext" : [ {
"objectType" : "",
"objectName" : "",
"startIndex" : 8,
"stopIndex" : 102,
"fragment" : "datediff('MILLISECOND', timestamp'2022-02-25 01:02:03.456', timestamp'2022-02-25 01:02:03.455')"
} ]
}


-- !query
select datediff('YEAR', date'2022-02-25', date'2023-02-25')
-- !query analysis
org.apache.spark.sql.catalyst.parser.ParseException
{
"errorClass" : "INVALID_PARAMETER_VALUE.DATETIME_UNIT",
"sqlState" : "22023",
"messageParameters" : {
"functionName" : "`datediff`",
"invalidValue" : "'YEAR'",
"parameter" : "`unit`"
},
"queryContext" : [ {
"objectType" : "",
"objectName" : "",
"startIndex" : 8,
"stopIndex" : 59,
"fragment" : "datediff('YEAR', date'2022-02-25', date'2023-02-25')"
} ]
}
88 changes: 88 additions & 0 deletions sql/core/src/test/resources/sql-tests/analyzer-results/ansi/timestamp.sql.out
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -765,6 +765,50 @@ select timestampadd(SECOND, -1, date'2022-02-15')
[Analyzer test output redacted due to nondeterminism]


-- !query
select timestampadd('MONTH', -1, timestamp'2022-02-14 01:02:03')
-- !query analysis
org.apache.spark.sql.catalyst.parser.ParseException
{
"errorClass" : "INVALID_PARAMETER_VALUE.DATETIME_UNIT",
"sqlState" : "22023",
"messageParameters" : {
"functionName" : "`timestampadd`",
"invalidValue" : "'MONTH'",
"parameter" : "`unit`"
},
"queryContext" : [ {
"objectType" : "",
"objectName" : "",
"startIndex" : 8,
"stopIndex" : 64,
"fragment" : "timestampadd('MONTH', -1, timestamp'2022-02-14 01:02:03')"
} ]
}


-- !query
select timestampadd('SECOND', -1, date'2022-02-15')
-- !query analysis
org.apache.spark.sql.catalyst.parser.ParseException
{
"errorClass" : "INVALID_PARAMETER_VALUE.DATETIME_UNIT",
"sqlState" : "22023",
"messageParameters" : {
"functionName" : "`timestampadd`",
"invalidValue" : "'SECOND'",
"parameter" : "`unit`"
},
"queryContext" : [ {
"objectType" : "",
"objectName" : "",
"startIndex" : 8,
"stopIndex" : 51,
"fragment" : "timestampadd('SECOND', -1, date'2022-02-15')"
} ]
}


-- !query
select timestampdiff(MONTH, timestamp'2022-02-14 01:02:03', timestamp'2022-01-14 01:02:03')
-- !query analysis
Expand All @@ -787,3 +831,47 @@ select timestampdiff(YEAR, date'2022-02-15', date'2023-02-15')
select timestampdiff(SECOND, date'2022-02-15', timestamp'2022-02-14 23:59:59')
-- !query analysis
[Analyzer test output redacted due to nondeterminism]


-- !query
select timestampdiff('MINUTE', timestamp'2022-02-14 01:02:03', timestamp'2022-02-14 02:00:03')
-- !query analysis
org.apache.spark.sql.catalyst.parser.ParseException
{
"errorClass" : "INVALID_PARAMETER_VALUE.DATETIME_UNIT",
"sqlState" : "22023",
"messageParameters" : {
"functionName" : "`timestampdiff`",
"invalidValue" : "'MINUTE'",
"parameter" : "`unit`"
},
"queryContext" : [ {
"objectType" : "",
"objectName" : "",
"startIndex" : 8,
"stopIndex" : 94,
"fragment" : "timestampdiff('MINUTE', timestamp'2022-02-14 01:02:03', timestamp'2022-02-14 02:00:03')"
} ]
}


-- !query
select timestampdiff('YEAR', date'2022-02-15', date'2023-02-15')
-- !query analysis
org.apache.spark.sql.catalyst.parser.ParseException
{
"errorClass" : "INVALID_PARAMETER_VALUE.DATETIME_UNIT",
"sqlState" : "22023",
"messageParameters" : {
"functionName" : "`timestampdiff`",
"invalidValue" : "'YEAR'",
"parameter" : "`unit`"
},
"queryContext" : [ {
"objectType" : "",
"objectName" : "",
"startIndex" : 8,
"stopIndex" : 64,
"fragment" : "timestampdiff('YEAR', date'2022-02-15', date'2023-02-15')"
} ]
}
88 changes: 88 additions & 0 deletions sql/core/src/test/resources/sql-tests/analyzer-results/date.sql.out
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -882,6 +882,50 @@ select dateadd(YEAR, 1, date'2022-02-25')
[Analyzer test output redacted due to nondeterminism]


-- !query
select dateadd('MICROSECOND', 1001, timestamp'2022-02-25 01:02:03.123')
-- !query analysis
org.apache.spark.sql.catalyst.parser.ParseException
{
"errorClass" : "INVALID_PARAMETER_VALUE.DATETIME_UNIT",
"sqlState" : "22023",
"messageParameters" : {
"functionName" : "`dateadd`",
"invalidValue" : "'MICROSECOND'",
"parameter" : "`unit`"
},
"queryContext" : [ {
"objectType" : "",
"objectName" : "",
"startIndex" : 8,
"stopIndex" : 71,
"fragment" : "dateadd('MICROSECOND', 1001, timestamp'2022-02-25 01:02:03.123')"
} ]
}


-- !query
select dateadd('QUARTER', 5, date'2022-02-25')
-- !query analysis
org.apache.spark.sql.catalyst.parser.ParseException
{
"errorClass" : "INVALID_PARAMETER_VALUE.DATETIME_UNIT",
"sqlState" : "22023",
"messageParameters" : {
"functionName" : "`dateadd`",
"invalidValue" : "'QUARTER'",
"parameter" : "`unit`"
},
"queryContext" : [ {
"objectType" : "",
"objectName" : "",
"startIndex" : 8,
"stopIndex" : 46,
"fragment" : "dateadd('QUARTER', 5, date'2022-02-25')"
} ]
}


-- !query
select datediff(MICROSECOND, timestamp'2022-02-25 01:02:03.123', timestamp'2022-02-25 01:02:03.124001')
-- !query analysis
Expand Down Expand Up @@ -940,3 +984,47 @@ select datediff(QUARTER, date'2022-02-25', date'2023-05-25')
select datediff(YEAR, date'2022-02-25', date'2023-02-25')
-- !query analysis
[Analyzer test output redacted due to nondeterminism]


-- !query
select datediff('MILLISECOND', timestamp'2022-02-25 01:02:03.456', timestamp'2022-02-25 01:02:03.455')
-- !query analysis
org.apache.spark.sql.catalyst.parser.ParseException
{
"errorClass" : "INVALID_PARAMETER_VALUE.DATETIME_UNIT",
"sqlState" : "22023",
"messageParameters" : {
"functionName" : "`datediff`",
"invalidValue" : "'MILLISECOND'",
"parameter" : "`unit`"
},
"queryContext" : [ {
"objectType" : "",
"objectName" : "",
"startIndex" : 8,
"stopIndex" : 102,
"fragment" : "datediff('MILLISECOND', timestamp'2022-02-25 01:02:03.456', timestamp'2022-02-25 01:02:03.455')"
} ]
}


-- !query
select datediff('YEAR', date'2022-02-25', date'2023-02-25')
-- !query analysis
org.apache.spark.sql.catalyst.parser.ParseException
{
"errorClass" : "INVALID_PARAMETER_VALUE.DATETIME_UNIT",
"sqlState" : "22023",
"messageParameters" : {
"functionName" : "`datediff`",
"invalidValue" : "'YEAR'",
"parameter" : "`unit`"
},
"queryContext" : [ {
"objectType" : "",
"objectName" : "",
"startIndex" : 8,
"stopIndex" : 59,
"fragment" : "datediff('YEAR', date'2022-02-25', date'2023-02-25')"
} ]
}