class AnalysisException extends Exception with SparkThrowable with Serializable with WithOrigin
Thrown when a query fails to analyze, usually because the query itself is invalid.
- Annotations
- @Stable()
- Source
- AnalysisException.scala
- Since
1.3.0
Linear Supertypes
Known Subclasses
Ordering
- Alphabetic
- By Inheritance
Inherited
- AnalysisException
- WithOrigin
- SparkThrowable
- Exception
- Throwable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new AnalysisException(errorClass: String, messageParameters: Map[String, String], origin: Origin, cause: Option[Throwable])
- new AnalysisException(errorClass: String, messageParameters: Map[String, String], origin: Origin)
- new AnalysisException(errorClass: String, messageParameters: Map[String, String])
- new AnalysisException(errorClass: String, messageParameters: Map[String, String], context: Array[QueryContext], summary: String)
- new AnalysisException(errorClass: String, sqlState: String, messageTemplate: String, messageParameters: Map[String, String], cause: Option[Throwable], message: Option[String])
External constructor for callers that want to supply error fields directly, without requiring a local JSON definition for the error class.
External constructor for callers that want to supply error fields directly, without requiring a local JSON definition for the error class.
If
messageis provided (Some), it is used verbatim. Otherwise, the message is rendered from (errorClass, sqlState, messageTemplate, messageParameters).messageTemplateis always persisted into the exception so clients can read it via SparkThrowable.getDefaultMessageTemplate(). - new AnalysisException(errorClass: String, messageParameters: Map[String, String], context: Array[QueryContext], cause: Option[Throwable])
- new AnalysisException(errorClass: String, messageParameters: Map[String, String], cause: Option[Throwable])
- new AnalysisException(message: String, line: Option[Int], startPosition: Option[Int], cause: Option[Throwable], errorClass: Option[String], messageParameters: Map[String, String], context: Array[QueryContext])
- new AnalysisException(message: String, line: Option[Int] = None, startPosition: Option[Int] = None, cause: Option[Throwable] = None, errorClass: Option[String] = None, messageParameters: Map[String, String] = Map.empty, context: Array[QueryContext] = Array.empty, sqlState: Option[String] = None, messageTemplate: Option[String] = None)
- Attributes
- protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def addSuppressed(arg0: Throwable): Unit
- Definition Classes
- Throwable
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val cause: Option[Throwable]
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- val context: Array[QueryContext]
- def copy(message: String = this.message, line: Option[Int] = this.line, startPosition: Option[Int] = this.startPosition, cause: Option[Throwable] = this.cause, errorClass: Option[String] = this.errorClass, messageParameters: Map[String, String] = this.messageParameters, context: Array[QueryContext] = this.context, sqlState: Option[String] = this.sqlState, messageTemplate: Option[String] = this.messageTemplate): AnalysisException
- def copy(message: String, line: Option[Int], startPosition: Option[Int], cause: Option[Throwable], errorClass: Option[String], messageParameters: Map[String, String], context: Array[QueryContext]): AnalysisException
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- val errorClass: Option[String]
- def fillInStackTrace(): Throwable
- Definition Classes
- Throwable
- def getBreakingChangeInfo(): BreakingChangeInfo
- Definition Classes
- SparkThrowable
- def getCause(): Throwable
- Definition Classes
- Throwable
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def getCondition(): String
Succinct, human-readable, unique, and consistent representation of the error condition.
Succinct, human-readable, unique, and consistent representation of the error condition. If null, error condition is not set.
- Definition Classes
- AnalysisException → SparkThrowable
- def getDefaultMessageTemplate(): String
Returns the default message template for this error.
Returns the default message template for this error.
The template is a machine-readable string with placeholders to be filled by
getMessageParameters().This is the default template known to Spark, but clients are free to generate their own messages (e.g., translations, alternate formats) using the provided error metadata.
- returns
the default message template for this error, or null if unavailable
- Definition Classes
- AnalysisException → SparkThrowable
- def getLocalizedMessage(): String
- Definition Classes
- Throwable
- def getMessage(): String
- Definition Classes
- AnalysisException → Throwable
- def getMessageParameters(): Map[String, String]
- Definition Classes
- AnalysisException → SparkThrowable
- def getQueryContext(): Array[QueryContext]
- Definition Classes
- AnalysisException → SparkThrowable
- def getSimpleMessage: String
- def getSqlState(): String
- Definition Classes
- AnalysisException → SparkThrowable
- def getStackTrace(): Array[StackTraceElement]
- Definition Classes
- Throwable
- final def getSuppressed(): Array[Throwable]
- Definition Classes
- Throwable
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def initCause(arg0: Throwable): Throwable
- Definition Classes
- Throwable
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isInternalError(): Boolean
- Definition Classes
- SparkThrowable
- val line: Option[Int]
- val message: String
- val messageParameters: Map[String, String]
- val messageTemplate: Option[String]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- lazy val origin: Origin
- Definition Classes
- AnalysisException → WithOrigin
- def printStackTrace(arg0: PrintWriter): Unit
- Definition Classes
- Throwable
- def printStackTrace(arg0: PrintStream): Unit
- Definition Classes
- Throwable
- def printStackTrace(): Unit
- Definition Classes
- Throwable
- def setStackTrace(arg0: Array[StackTraceElement]): Unit
- Definition Classes
- Throwable
- val sqlState: Option[String]
- val startPosition: Option[Int]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- Throwable → AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withPosition(origin: Origin): AnalysisException
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def getErrorClass(): String
Succinct, human-readable, unique, and consistent representation of the error category.
Succinct, human-readable, unique, and consistent representation of the error category. If null, error class is not set.
- Definition Classes
- SparkThrowable
- Annotations
- @Deprecated
- Deprecated