[SPARK-46410][SQL] Assign error classes/subclasses to JdbcUtils.classifyException

common/utils/src/main/resources/error/error-classes.json

@@ -1096,6 +1096,79 @@
     ],
     "sqlState" : "38000"
   },
+  "FAILED_JDBC" : {
+    "message" : [
+      "Failed the JDBC operation:"
+    ],
+    "subClass" : {
+      "ALTER_TABLE" : {
+        "message" : [
+          "Alter the table <tableName>."
+        ]
+      },
+      "CREATE_INDEX" : {
+        "message" : [
+          "Create the index <indexName> in the <tableName> table."
+        ]
+      },
+      "CREATE_NAMESPACE" : {
+        "message" : [
+          "Create the namespace <namespace>."
+        ]
+      },
+      "CREATE_NAMESPACE_COMMENT" : {
+        "message" : [
+          "Create a comment on the namespace: <namespace>."
+        ]
+      },
+      "CREATE_TABLE" : {
+        "message" : [
+          "Create the table <tableName>."
+        ]
+      },
+      "DROP_INDEX" : {
+        "message" : [
+          "Drop the index <indexName> in the <tableName> table."
+        ]
+      },
+      "DROP_NAMESPACE" : {
+        "message" : [
+          "Drop the namespace <namespace>."
+        ]
+      },
+      "GET_TABLES" : {
+        "message" : [
+          "Get tables from the namespace: <namespace>."
+        ]
+      },
+      "LIST_NAMESPACES" : {
+        "message" : [
+          "List namespaces."
+        ]
+      },
+      "NAMESPACE_EXISTS" : {
+        "message" : [
+          "Check that the namespace <namespace> exists."
+        ]
+      },
+      "REMOVE_NAMESPACE_COMMENT" : {
+        "message" : [
+          "Remove a comment on the namespace: <namespace>."
+        ]
+      },
+      "RENAME_TABLE" : {
+        "message" : [
+          "Rename the table <oldName> to <newName>."
+        ]
+      },
+      "TABLE_EXISTS" : {
+        "message" : [
+          "Check that the table <tableName> exists."
+        ]
+      }
+    },
+    "sqlState" : "40000"
+  },
   "FAILED_PARSE_STRUCT_TYPE" : {
     "message" : [
       "Failed parsing struct: <raw>."
@@ -6778,11 +6851,6 @@
       "pivot is not supported on a streaming DataFrames/Datasets"
     ]
   },
-  "_LEGACY_ERROR_TEMP_3064" : {
-    "message" : [
-      "<msg>"
-    ]
-  },
   "_LEGACY_ERROR_TEMP_3065" : {
     "message" : [
       "<clazz>: <msg>"

connector/docker-integration-tests/src/test/scala/org/apache/spark/sql/jdbc/v2/V2JDBCTest.scala

@@ -221,10 +221,10 @@ private[v2] trait V2JDBCTest extends SharedSparkSession with DockerIntegrationFu
 
   test("CREATE TABLE with table property") {
     withTable(s"$catalogName.new_table") {
-      val m = intercept[AnalysisException] {
+      val e = intercept[AnalysisException] {
         sql(s"CREATE TABLE $catalogName.new_table (i INT) TBLPROPERTIES('a'='1')")
-      }.message
-      assert(m.contains("Failed table creation"))
+      }
+      assert(e.getErrorClass == "FAILED_JDBC.CREATE_TABLE")
       testCreateTableWithProperty(s"$catalogName.new_table")
     }
   }
@@ -279,7 +279,7 @@ private[v2] trait V2JDBCTest extends SharedSparkSession with DockerIntegrationFu
             sql(s"CREATE index i1 ON $catalogName.new_table (col1)")
           },
           errorClass = "INDEX_ALREADY_EXISTS",
-          parameters = Map("indexName" -> "i1", "tableName" -> "new_table")
+          parameters = Map("indexName" -> "`i1`", "tableName" -> "`new_table`")
         )
 
         sql(s"DROP index i1 ON $catalogName.new_table")
@@ -304,7 +304,7 @@ private[v2] trait V2JDBCTest extends SharedSparkSession with DockerIntegrationFu
             sql(s"DROP index i1 ON $catalogName.new_table")
           },
           errorClass = "INDEX_NOT_FOUND",
-          parameters = Map("indexName" -> "i1", "tableName" -> "new_table")
+          parameters = Map("indexName" -> "`i1`", "tableName" -> "`new_table`")
         )
       }
     }

docs/sql-error-conditions-failed-jdbc-error-class.md

@@ -0,0 +1,80 @@
+---
+layout: global
+title: FAILED_JDBC error class
+displayTitle: FAILED_JDBC error class
+license: |
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+---
+
+SQLSTATE: 40000
+
+Failed the JDBC operation:
+
+This error class has the following derived error classes:
+
+## ALTER_TABLE
+
+Alter the table `<tableName>`.
+
+## CREATE_INDEX
+
+Create the index `<indexName>` in the `<tableName>` table.
+
+## CREATE_NAMESPACE
+
+Create the namespace `<namespace>`.
+
+## CREATE_NAMESPACE_COMMENT
+
+Create a comment on the namespace: `<namespace>`.
+
+## CREATE_TABLE
+
+Create the table `<tableName>`.
+
+## DROP_INDEX
+
+Drop the index `<indexName>` in the `<tableName>` table.
+
+## DROP_NAMESPACE
+
+Drop the namespace `<namespace>`.
+
+## GET_TABLES
+
+Get tables from the namespace: `<namespace>`.
+
+## LIST_NAMESPACES
+
+List namespaces.
+
+## NAMESPACE_EXISTS
+
+Check that the namespace `<namespace>` exists.
+
+## REMOVE_NAMESPACE_COMMENT
+
+Remove a comment on the namespace: `<namespace>`.
+
+## RENAME_TABLE
+
+Rename the table `<oldName>` to `<newName>`.
+
+## TABLE_EXISTS
+
+Check that the table `<tableName>` exists.
+
+

docs/sql-error-conditions.md

@@ -665,6 +665,14 @@ User defined function (`<functionName>`: (`<signature>`) => `<result>`) failed d
 
 Failed preparing of the function `<funcName>` for call. Please, double check function's arguments.
 
+### [FAILED_JDBC](sql-error-conditions-failed-jdbc-error-class.html)
+
+SQLSTATE: 40000
+
+Failed the JDBC operation:
+
+For more details see [FAILED_JDBC](sql-error-conditions-failed-jdbc-error-class.html)
+
 ### FAILED_PARSE_STRUCT_TYPE
 
 [SQLSTATE: 22018](sql-error-conditions-sqlstates.html#class-22-data-exception)

project/MimaExcludes.scala

@@ -100,6 +100,9 @@ object MimaExcludes {
     ProblemFilters.exclude[MissingTypesProblem]("org.apache.spark.storage.CacheId$"),
     ProblemFilters.exclude[DirectMissingMethodProblem]("org.apache.spark.storage.CacheId.apply"),
 
+    // SPARK-46410: Assign error classes/subclasses to JdbcUtils.classifyException
+    ProblemFilters.exclude[DirectMissingMethodProblem]("org.apache.spark.sql.jdbc.JdbcDialect.classifyException"),
+
     (problem: Problem) => problem match {
       case MissingClassProblem(cls) => !cls.fullName.startsWith("org.sparkproject.jpmml") &&
           !cls.fullName.startsWith("org.sparkproject.dmg.pmml")

sql/api/src/main/scala/org/apache/spark/sql/catalyst/analysis/NonEmptyException.scala

@@ -36,7 +36,4 @@ case class NonEmptyNamespaceException(
       "details" -> details)) {
 
   def this(namespace: Array[String]) = this(namespace, "", None)
-
-  def this(details: String, cause: Option[Throwable]) =
-    this(Array.empty, details, cause)
 }

sql/core/src/main/scala/org/apache/spark/sql/execution/datasources/jdbc/JdbcUtils.scala

@@ -1180,12 +1180,15 @@ object JdbcUtils extends Logging with SQLConfHelper {
     }
   }
 
-  def classifyException[T](message: String, dialect: JdbcDialect)(f: => T): T = {
+  def classifyException[T](
+      errorClass: String,
+      messageParameters: Map[String, String],
+      dialect: JdbcDialect)(f: => T): T = {
     try {
       f
     } catch {
       case e: SparkThrowable with Throwable => throw e
-      case e: Throwable => throw dialect.classifyException(message, e)
+      case e: Throwable => throw dialect.classifyException(e, errorClass, messageParameters)
     }
   }
 

sql/core/src/main/scala/org/apache/spark/sql/execution/datasources/v2/jdbc/JDBCTable.scala

@@ -26,13 +26,18 @@ import org.apache.spark.sql.connector.catalog.TableCapability._
 import org.apache.spark.sql.connector.catalog.index.{SupportsIndex, TableIndex}
 import org.apache.spark.sql.connector.expressions.NamedReference
 import org.apache.spark.sql.connector.write.{LogicalWriteInfo, WriteBuilder}
+import org.apache.spark.sql.errors.DataTypeErrorsBase
 import org.apache.spark.sql.execution.datasources.jdbc.{JDBCOptions, JdbcOptionsInWrite, JdbcUtils}
 import org.apache.spark.sql.jdbc.JdbcDialects
 import org.apache.spark.sql.types.StructType
 import org.apache.spark.sql.util.CaseInsensitiveStringMap
 
 case class JDBCTable(ident: Identifier, schema: StructType, jdbcOptions: JDBCOptions)
-  extends Table with SupportsRead with SupportsWrite with SupportsIndex {
+  extends Table
+  with SupportsRead
+  with SupportsWrite
+  with SupportsIndex
+  with DataTypeErrorsBase {
 
   override def name(): String = ident.toString
 
@@ -58,8 +63,12 @@ case class JDBCTable(ident: Identifier, schema: StructType, jdbcOptions: JDBCOpt
       columnsProperties: util.Map[NamedReference, util.Map[String, String]],
       properties: util.Map[String, String]): Unit = {
     JdbcUtils.withConnection(jdbcOptions) { conn =>
-      JdbcUtils.classifyException(s"Failed to create index $indexName in ${name()}",
-        JdbcDialects.get(jdbcOptions.url)) {
+      JdbcUtils.classifyException(
+        errorClass = "FAILED_JDBC.CREATE_INDEX",
+        messageParameters = Map(
+          "indexName" -> toSQLId(indexName),
+          "tableName" -> toSQLId(name)),
+        dialect = JdbcDialects.get(jdbcOptions.url)) {
         JdbcUtils.createIndex(
           conn, indexName, ident, columns, columnsProperties, properties, jdbcOptions)
       }
@@ -74,8 +83,12 @@ case class JDBCTable(ident: Identifier, schema: StructType, jdbcOptions: JDBCOpt
 
   override def dropIndex(indexName: String): Unit = {
     JdbcUtils.withConnection(jdbcOptions) { conn =>
-      JdbcUtils.classifyException(s"Failed to drop index $indexName in ${name()}",
-        JdbcDialects.get(jdbcOptions.url)) {
+      JdbcUtils.classifyException(
+        errorClass = "FAILED_JDBC.DROP_INDEX",
+        messageParameters = Map(
+          "indexName" -> toSQLId(indexName),
+          "tableName" -> toSQLId(name)),
+        dialect = JdbcDialects.get(jdbcOptions.url)) {
         JdbcUtils.dropIndex(conn, indexName, ident, jdbcOptions)
       }
     }