-
Notifications
You must be signed in to change notification settings - Fork 29.3k
[SPARK-30703][SQL][DOCS] Add a document for the ANSI mode #27489
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.
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
Changes from 3 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| --- | ||
| layout: global | ||
| title: Spark SQL Keywords | ||
| displayTitle: Spark SQL Keywords | ||
| title: ANSI Compliance | ||
| displayTitle: ANSI Compliance | ||
| license: | | ||
| Licensed to the Apache Software Foundation (ASF) under one or more | ||
| contributor license agreements. See the NOTICE file distributed with | ||
|
|
@@ -19,6 +19,87 @@ license: | | |
| limitations under the License. | ||
| --- | ||
|
|
||
| Spark SQL has two options to comply with the SQL standard: `spark.sql.ansi.enabled` and `spark.sql.storeAssignmentPolicy`. | ||
| When `spark.sql.ansi.enabled` is set to `true` (`false` by default), Spark SQL follows the standard in basic behaviours (e.g., arithmetic operations, type conversion, and SQL parsing). | ||
| Moreover, Spark SQL has an independent option to control implicit casting behaviours when inserting rows in a table. | ||
| The casting behaviours are defined as store assignment rules in the standard. | ||
| When `spark.sql.storeAssignmentPolicy` is set to `ANSI`, Spark SQL complies with the ANSI store assignment rules and this setting is a default value. | ||
|
|
||
| The following subsections present behaviour changes in arithmetic operations, type conversions, and SQL parsing when the ANSI mode enabled. | ||
|
|
||
| ### Arithmetic Operations | ||
|
|
||
| In Spark SQL, arithmetic operations performed on numeric types (with the exception of decimal) are not checked for overflows by default. | ||
| This means that in case an operation causes overflows, the result is the same that the same operation returns in a Java/Scala program (e.g., if the sum of 2 integers is higher than the maximum value representable, the result is a negative number). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ah, yes. I'll fix later. (If other developers plan to open a PR for typo fixes, it would be helpful to include this fix as well.)
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| On the other hand, Spark SQL returns null for decimal overflows. | ||
| When `spark.sql.ansi.enabled` is set to `true` and an overflow occurs in numeric and interval arithmetic operations, it throws an arithmetic exception at runtime. | ||
|
|
||
| {% highlight sql %} | ||
| -- `spark.sql.ansi.enabled=true` | ||
| SELECT 2147483647 + 1; | ||
|
|
||
| java.lang.ArithmeticException: integer overflow | ||
|
|
||
| -- `spark.sql.ansi.enabled=false` | ||
| SELECT 2147483647 + 1; | ||
|
|
||
| +----------------+ | ||
| |(2147483647 + 1)| | ||
| +----------------+ | ||
| | -2147483648| | ||
| +----------------+ | ||
|
|
||
| {% endhighlight %} | ||
|
|
||
| ### Type Conversion | ||
|
|
||
| Spark SQL has three kinds of type conversions: explicit casting, type coercion, and store assignment casting. | ||
| When `spark.sql.ansi.enabled` is set to `true`, explicit casting by `CAST` syntax throws a number-format exception at runtime for illegal cast patterns defined in the standard, e.g. casts from a string to an integer. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. number-format exception is not the only runtime exception for ANSI mode
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oh, right. I'll update.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. updated. |
||
| On the other hand, `INSERT INTO` syntax throws an analysis exception when the ANSI mode enabled via `spark.sql.storeAssignmentPolicy=ANSI`. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just a question, shall we mention
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ah, good suggestion! I totally missed that syntax. I'll check.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've checked CTAS (CTAS cannot exist with schema definition); Any other concern? |
||
|
|
||
| Currently, the ANSI mode affects explicit casting and assignment casting only. | ||
| In future releases, the behaviour of type coercion might change along with the other two type conversion rules. | ||
|
|
||
| {% highlight sql %} | ||
| -- Examples of explicit casting | ||
|
|
||
| -- `spark.sql.ansi.enabled=true` | ||
| SELECT CAST('a' AS INT); | ||
|
|
||
| java.lang.NumberFormatException: invalid input syntax for type numeric: a | ||
|
|
||
| -- `spark.sql.ansi.enabled=false` (This is a default behaviour) | ||
| SELECT CAST('a' AS INT); | ||
|
|
||
| +--------------+ | ||
| |CAST(a AS INT)| | ||
| +--------------+ | ||
| | null| | ||
| +--------------+ | ||
|
|
||
| -- Examples of store assignment rules | ||
| CREATE TABLE t (v INT); | ||
|
|
||
| -- `spark.sql.storeAssignmentPolicy=ANSI` | ||
| INSERT INTO t VALUES ('1'); | ||
|
|
||
| org.apache.spark.sql.AnalysisException: Cannot write incompatible data to table '`default`.`t`': | ||
| - Cannot safely cast 'v': StringType to IntegerType; | ||
|
|
||
| -- `spark.sql.storeAssignmentPolicy=LEGACY` (This is a legacy behaviour until Spark 2.x) | ||
| INSERT INTO t VALUES ('1'); | ||
| SELECT * FROM t; | ||
|
|
||
| +---+ | ||
| | v| | ||
| +---+ | ||
| | 1| | ||
| +---+ | ||
|
|
||
| {% endhighlight %} | ||
|
|
||
| ### SQL Keywords | ||
|
|
||
| When `spark.sql.ansi.enabled` is true, Spark SQL will use the ANSI mode parser. | ||
| In this mode, Spark SQL has two kinds of keywords: | ||
| * Reserved keywords: Keywords that are reserved and can't be used as identifiers for table, view, column, function, alias, etc. | ||
|
|
||
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shall we summarize as a table like https://spark.apache.org/docs/3.0.0-preview2/configuration.html#application-properties ? That will be more easier to explain and to understand and to maintain(add new conf later or change the default value).
For example, the default value of
spark.sql.storeAssignmentPolicyis not mentioned in this paragraph.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, I see. But, when I was writing this doc, I assumed the basic info about
spark.sql.storeAssignmentPolicywould appear in the SQL Conf doc: #27459Better to describe the two options in a tabular format here, too?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am +1 with showing a table here, which can be more clear.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok