Skip to content

[SPARK-39243][SQL][DOCS] Rules of quoting elements in error messages #36621

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

Closed
wants to merge 2 commits into from
Closed

[SPARK-39243][SQL][DOCS] Rules of quoting elements in error messages #36621

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79870db
Describe rules of quoting elements in error messages
MaxGekk May 20, 2022
e51c596
Add one more rule
MaxGekk May 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions sql/catalyst/src/main/scala/org/apache/spark/sql/errors/QueryErrorsBase.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,23 @@ import org.apache.spark.sql.catalyst.expressions.Literal
import org.apache.spark.sql.catalyst.util.quoteIdentifier
import org.apache.spark.sql.types.{DataType, DoubleType, FloatType}

/**
* The trait exposes util methods for preparing error messages such as quoting of error elements.
* All classes that extent `QueryErrorsBase` shall follow the rules:
* 1. Any values shall be outputted in the SQL standard style by using `toSQLValue()`.
* For example: 'a string value', 1, NULL.
* 2. SQL types shall be double quoted and outputted in the upper case using `toSQLType()`.
* For example: "INT", "DECIMAL(10,0)".
* 3. Elements of identifiers shall be wrapped by backticks by using `toSQLId()`.
* For example: `namespaceA`.`funcB`, `tableC`.
* 4. SQL statements shall be in the upper case prepared by using `toSQLStmt`.
* For example: DESC PARTITION, DROP TEMPORARY FUNCTION.
* 5. SQL configs and datasource options shall be wrapped by double quotes by using
* `toSQLConf()`/`toDSOption()`.
* For example: "spark.sql.ansi.enabled".
* 6. Any values of datasource options or SQL configs shall be double quoted.
* For example: "true", "CORRECTED".
*/
trait QueryErrorsBase {
// Converts an error class parameter to its SQL representation
def toSQLValue(v: Any, t: DataType): String = Literal.create(v, t) match {
Expand Down