viirya commented on a change in pull request #32850:
URL: https://github.com/apache/spark/pull/32850#discussion_r650282569
##########
File path: core/src/main/resources/error/README.md
##########
@@ -0,0 +1,79 @@
+# Guidelines
+
+To throw a standardized exception, developers should use an error class and
message parameters
+rather than an arbitrary error message.
+
+## Usage
+
+To throw an exception, do the following.
+
+1. Check if an appropriate error class already exists in `error-class.json`.
+ If true, skip to step 3. Otherwise, continue to step 2.
+2. Add a new class to `error-class.json`; keep in mind the invariants below.
+3. Check if the exception type already extends `SparkError`.
+ If true, skip to step 5. Otherwise, continue to step 4.
+4. Mix `SparkError` into the exception.
+5. Throw the exception with the error class and message parameters.
+
+### Before
+
+Throw exception:
+
+ throw new TestException("Problem A because B")
+
+
+### After
+
+`error-class.json`
+
+ "PROBLEM_BECAUSE": {
+ "sqlState": "XXXXX",
+ "messageFormatLines": ["Problem %s because %s"]
+ }
+
+`SparkException.scala`
+
+ class SparkTestException(
+ val errorClass: String,
+ val messageParameters: Seq[String])
+ extends TestException(SparkError.getMessage(errorClass,
messageParameters))
+ with SparkError
+
+Throw exception:
+
+ throw new SparkTestException("PROBLEM_BECAUSE", Seq("A", "B"))
+
+## Access fields
+
+To access error fields, catch exceptions that extend
`org.apache.spark.SparkError` and access
+ - Error class with `errorClass`
+ - SQLSTATE with `sqlState`
+
+
+ try {
+ ...
+ } catch {
+ case e: SparkError if e.sqlState.forall(_.startsWith("42")) =>
+ warn("Syntax error")
+ }
+
+## Fields
+
+All fields, excluding error messages, should be consistent across releases.
Review comment:
This sounds a pretty strict requirement.
##########
File path: core/src/main/resources/error/README.md
##########
@@ -0,0 +1,79 @@
+# Guidelines
+
+To throw a standardized exception, developers should use an error class and
message parameters
+rather than an arbitrary error message.
+
+## Usage
+
+To throw an exception, do the following.
+
+1. Check if an appropriate error class already exists in `error-class.json`.
Review comment:
I have a concern that this will be another burden. E.g. naming a error
class, finding error class.
I also worry that the number of error classes will grow quickly and hard to
maintain.
##########
File path: core/src/main/scala/org/apache/spark/SparkError.scala
##########
@@ -0,0 +1,86 @@
+/*
+ * 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.
+ */
+
+package org.apache.spark
+
+import java.net.URL
+
+import scala.collection.immutable.SortedMap
+
+import com.fasterxml.jackson.annotation.JsonIgnore
+import com.fasterxml.jackson.core.`type`.TypeReference
+import com.fasterxml.jackson.databind.SerializationFeature
+import com.fasterxml.jackson.databind.json.JsonMapper
+import com.fasterxml.jackson.module.scala.DefaultScalaModule
+
+import org.apache.spark.util.Utils
+
+/**
+ * Information associated with an error class.
+ *
+ * @param sqlState SQLSTATE associated with this class.
+ * @param messageFormatLines C-style message format compatible with printf.
+ * The error message is constructed by concatenating
the lines with
+ * linebreaks.
+ */
+case class ErrorInfo(sqlState: Option[String], messageFormatLines:
Seq[String]) {
Review comment:
This is defined in core. But sql state is a SQL concept?
--
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.
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
