Package org.apache.spark

Interface SparkThrowable

All Known Implementing Classes:
AnalysisException, CatalogNotFoundException, CircularDependencyException, LoadTableException, SparkException, SqlGraphElementRegistrationException, StreamingQueryException, UnrecognizedBlockId, UnresolvedDatasetException, UnresolvedPipelineException
@Evolving public interface SparkThrowable
Interface mixed into Throwables thrown from Spark. - For backwards compatibility, existing Throwable types can be thrown with an arbitrary error message with a null error class. See [[SparkException]]. - To promote standardization, Throwables should be thrown with an error class and message parameters to construct an error message with SparkThrowableHelper.getMessage(). New Throwable types should not accept arbitrary error messages. See [[SparkArithmeticException]].
Since:
3.2.0

  • Method Details

    • getCondition

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

    • getErrorClass

      @Deprecated default String getErrorClass()
      Deprecated.
      Use getCondition() instead.
      Succinct, human-readable, unique, and consistent representation of the error category. If null, error class is not set.

    • getSqlState

      default String getSqlState()

    • isInternalError

      default boolean isInternalError()

    • getBreakingChangeInfo

      default BreakingChangeInfo getBreakingChangeInfo()

    • getMessageParameters

      default Map<String,String> getMessageParameters()

    • getDefaultMessageTemplate

      default 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.
      Returns:
      the default message template for this error, or null if unavailable

    • getQueryContext

      default QueryContext[] getQueryContext()