Package org.apache.spark.sql

Class AnalysisException

Object

Throwable

Exception

org.apache.spark.sql.AnalysisException

All Implemented Interfaces:

Serializable, SparkThrowable, org.apache.spark.sql.catalyst.trees.WithOrigin

Direct Known Subclasses:

CircularDependencyException, SqlGraphElementRegistrationException, UnresolvedDatasetException, UnresolvedPipelineException

public class AnalysisException
extends Exception
implements SparkThrowable, Serializable, 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:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
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.
AnalysisException(String errorClass, scala.collection.immutable.Map<String,String> messageParameters)
AnalysisException(String errorClass, scala.collection.immutable.Map<String,String> messageParameters, QueryContext[] context, String summary)
AnalysisException(String errorClass, scala.collection.immutable.Map<String,String> messageParameters, QueryContext[] context, scala.Option<Throwable> cause)
AnalysisException(String errorClass, scala.collection.immutable.Map<String,String> messageParameters, org.apache.spark.sql.catalyst.trees.Origin origin)
AnalysisException(String errorClass, scala.collection.immutable.Map<String,String> messageParameters, org.apache.spark.sql.catalyst.trees.Origin origin, scala.Option<Throwable> cause)
AnalysisException(String errorClass, scala.collection.immutable.Map<String,String> messageParameters, scala.Option<Throwable> cause)
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)

Method Summary

Modifier and Type	Method	Description
scala.Option<Throwable>	cause()
QueryContext[]	context()
AnalysisException	copy(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	copy(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, scala.Option<String> sqlState, scala.Option<String> messageTemplate)
scala.Option<String>	errorClass()
String	getCondition()	Succinct, human-readable, unique, and consistent representation of the error condition.
String	getDefaultMessageTemplate()	Returns the default message template for this error.
String	getMessage()
Map<String,String>	getMessageParameters()
QueryContext[]	getQueryContext()
String	getSimpleMessage()
String	getSqlState()
scala.Option<Object>	line()
String	message()
scala.collection.immutable.Map<String,String>	messageParameters()
scala.Option<String>	messageTemplate()
org.apache.spark.sql.catalyst.trees.Origin	origin()
scala.Option<String>	sqlState()
scala.Option<Object>	startPosition()
AnalysisException	withPosition(org.apache.spark.sql.catalyst.trees.Origin origin)

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.spark.SparkThrowable

getBreakingChangeInfo, getErrorClass, isInternalError

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

public String 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

public QueryContext[] context()

sqlState

public scala.Option<String> sqlState()

messageTemplate

public scala.Option<String> messageTemplate()

copy

public AnalysisException copy(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)

copy

public AnalysisException copy(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,
 scala.Option<String> sqlState,
 scala.Option<String> messageTemplate)

withPosition

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

getDefaultMessageTemplate

public String getDefaultMessageTemplate()

Description copied from interface: SparkThrowable

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()

Specified by:

getSqlState in interface SparkThrowable

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getSimpleMessage

public String getSimpleMessage()

getMessageParameters

public Map<String,String> getMessageParameters()

Specified by:

getMessageParameters in interface SparkThrowable

getCondition

public String getCondition()

Description copied from interface: SparkThrowable

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

public QueryContext[] 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