All Implemented Interfaces:
Serializable, SparkThrowable, org.apache.spark.sql.catalyst.trees.WithOrigin

Thrown when a query fails to analyze, usually because the query itself is invalid.

Since:
1.3.0
See Also:

  • Constructor Details

    • AnalysisException

      public AnalysisException(String message, scala.Option<Object> line, scala.Option<Object> startPosition, scala.Option<Throwable> cause, scala.Option<String> errorClass, scala.collection.immutable.Map<String,String> messageParameters, QueryContext[] context)

    • AnalysisException

      public AnalysisException(String errorClass, scala.collection.immutable.Map<String,String> messageParameters, scala.Option<Throwable> cause)

    • AnalysisException

      public AnalysisException(String errorClass, scala.collection.immutable.Map<String,String> messageParameters, QueryContext[] context, scala.Option<Throwable> cause)

    • AnalysisException

      public AnalysisException(String errorClass, String sqlState, String messageTemplate, scala.collection.immutable.Map<String,String> messageParameters, scala.Option<Throwable> cause, scala.Option<String> message)

      External constructor for callers that want to supply error fields directly, without requiring a local JSON definition for the error class.

      If message is provided (Some), it is used verbatim. Otherwise, the message is rendered from (errorClass, sqlState, messageTemplate, messageParameters).

      messageTemplate is always persisted into the exception so clients can read it via SparkThrowable.getDefaultMessageTemplate().

      Parameters:
      errorClass - (undocumented)
      sqlState - (undocumented)
      messageTemplate - (undocumented)
      messageParameters - (undocumented)
      cause - (undocumented)
      message - (undocumented)

    • AnalysisException

      public AnalysisException(String errorClass, scala.collection.immutable.Map<String,String> messageParameters, QueryContext[] context, String summary)

    • AnalysisException

      public AnalysisException(String errorClass, scala.collection.immutable.Map<String,String> messageParameters)

    • AnalysisException

      public AnalysisException(String errorClass, scala.collection.immutable.Map<String,String> messageParameters, org.apache.spark.sql.catalyst.trees.Origin origin)

    • AnalysisException

      public AnalysisException(String errorClass, scala.collection.immutable.Map<String,String> messageParameters, org.apache.spark.sql.catalyst.trees.Origin origin, scala.Option<Throwable> cause)

  • Method Details

    • message

    • line

      public scala.Option<Object> line()

    • startPosition

      public scala.Option<Object> startPosition()

    • cause

      public scala.Option<Throwable> cause()

    • errorClass

      public scala.Option<String> errorClass()

    • messageParameters

      public scala.collection.immutable.Map<String,String> messageParameters()

    • context

    • sqlState

      public scala.Option<String> sqlState()

    • messageTemplate

      public scala.Option<String> messageTemplate()

    • copy

    • copy

    • withPosition

      public AnalysisException withPosition(org.apache.spark.sql.catalyst.trees.Origin origin)

    • getDefaultMessageTemplate

      public String getDefaultMessageTemplate()

      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.

      Specified by:
      getDefaultMessageTemplate in interface SparkThrowable
      Returns:
      the default message template for this error, or null if unavailable

    • getSqlState

      public String getSqlState()

      ================================================ Server side exceptions should override this method and use a provided SQL state property instead. ================================================

      Specified by:
      getSqlState in interface SparkThrowable

    • getMessage

      public String getMessage()

      Overrides:
      getMessage in class Throwable

    • getSimpleMessage

      public String getSimpleMessage()

    • getMessageParameters

      Specified by:
      getMessageParameters in interface SparkThrowable

    • getCondition

      public String getCondition()

      Succinct, human-readable, unique, and consistent representation of the error condition. If null, error condition is not set.

      Specified by:
      getCondition in interface SparkThrowable

    • getQueryContext

      Specified by:
      getQueryContext in interface SparkThrowable

    • origin

      public org.apache.spark.sql.catalyst.trees.Origin origin()

      Specified by:
      origin in interface org.apache.spark.sql.catalyst.trees.WithOrigin