Tratamento de erros no Azure Databricks

Aplica-se a: Databricks SQL Databricks Runtime 12.2 e superior

Componentes de erro

Quando o Azure Databricks gera um erro, ele inclui os seguintes componentes:

• Classe de erro

  Uma cadeia de caracteres descritiva, legível por humanos, exclusiva para a condição de erro.

  Algumas classes de erro incluem sublasses.

  Por exemplo: TABLE_OR_VIEW_NOT_FOUND e INCOMPLETE_TYPE_DEFINITION. MATRIZ.

  Para obter uma lista de todas as classes de erro, consulte Classes de erro.

• SQLSTATE

  Uma cadeia de caracteres de cinco caracteres, agrupando classes de erro em um formato padrão suportado por muitos produtos e APIs.

  Por exemplo: '42P01'

  Para obter uma lista completa de todos os SQLSTATEs usados pelo Azure Databricks, consulte SQLSTATEs.

• Mensagem parametrizada

  A mensagem de erro com espaços reservados para os parâmetros.

  Por exemplo: TABLE_OR_VIEW_NOT_FOUND inclui a seguinte mensagem:

  The table or view <relationName> cannot be found.
  

  Você pode usar a mensagem parametrizada para renderizar uma mensagem de erro mapeando valores de parâmetro de mensagem para as tags <parameter>de parâmetro .

• Parâmetros de mensagem

  Um mapa de parâmetros e valores que fornecem informações adicionais sobre o erro. Por exemplo: 'relationName' -> 'main.default.tab1'.

• Mensagem

  A mensagem de erro completamente renderizada, incluindo a classe de erro e o SQLSTATE, com os parâmetros preenchidos. Por exemplo:

  [TABLE_OR_VIEW_NOT_FOUND] The table or view `does_not_exist` cannot be found. Verify the spelling and correctness of the schema and catalog.
  If you did not qualify the name with a schema, verify the current_schema() output, or qualify the name with the correct schema and catalog.
  To tolerate the error on drop use DROP VIEW IF EXISTS or DROP TABLE IF EXISTS. SQLSTATE: 42P01; line 1 pos 14;
  'Project [*]
  +- 'UnresolvedRelation [does_not_exist], [], false
  

Tratamento de condições de erro

Aplica-se a: Databricks SQL Databricks Runtime 14.2 e superior

O Azure Databricks fornece APIs específicas do idioma para lidar com condições de erro.

Python

Para Python use pySparkException

• PySparkException.getErrorClass(): Retorna a classe de erro da exceção como uma cadeia de caracteres.
• PySparkException.getMessageParameters(): Retorna os parâmetros de mensagem da exceção como um dicionário.
• PySparkException.getSqlState(): Devolve o SQLSTATE da expressão como uma cadeia de caracteres.

Scala

Para Scala use SparkThrowable

• getErrorClass(): Retorna uma classe de erro como uma cadeia de caracteres.
• getMessageParameters(): Retorna parâmetros de uma mensagem como um mapa.
• getSqlState(): Retorna um SQLSTATE como uma cadeia de caracteres.

Exemplos

• Detete qualquer exceção e exiba a classe de erro, os parâmetros da mensagem e SQLSTATEo . Exibir também a mensagem de erro padrão

  Scala

  import org.apache.spark.SparkThrowable
  
  try {
    spark.sql("SELECT * FROM does_not_exist").show()
  }
  catch {
    case ex: SparkThrowable =>
      println("Error Class       : " + ex.getErrorClass)
      println("Message parameters: " + ex.getMessageParameters())
      println("SQLSTATE          : " + ex.getSqlState)
      println(ex)
  }
  

  Python

  from pyspark.errors import PySparkException
  
  try:
    spark.sql("SELECT * FROM does_not_exist").show()
  except PySparkException as ex:
    print("Error Class       : " + ex.getErrorClass())
    print("Message parameters: " + str(ex.getMessageParameters()))
    print("SQLSTATE          : " + ex.getSqlState())
    print(ex)
  

  Result

    Error Class       : TABLE_OR_VIEW_NOT_FOUND
    Message parameters: {'relationName': '`does_not_exist`'}
    SQLSTATE          : 42P01
    [TABLE_OR_VIEW_NOT_FOUND] The table or view `does_not_exist` cannot be found. Verify the spelling and correctness of the schema and catalog.
    If you did not qualify the name with a schema, verify the current_schema() output, or qualify the name with the correct schema and catalog.
    To tolerate the error on drop use DROP VIEW IF EXISTS or DROP TABLE IF EXISTS. SQLSTATE: 42P01; line 1 pos 14;
    'Project [*]
    +- 'UnresolvedRelation [does_not_exist], [], false
  

• Capture somente o SQLSTATE 42P01 e exiba uma mensagem personalizada:

  Scala

  import org.apache.spark.SparkThrowable
  
  try {
    spark.sql("SELECT * FROM does_not_exist").show()
  }
  catch {
    case ex: SparkThrowable if (ex.getSqlState == "42P01") =>
      println("I'm so sorry, but I cannot find: " + ex.getMessageParameters().get("relationName"))
  }
  

  Python

  from pyspark.errors import PySparkException
  
  try:
    spark.sql("SELECT * FROM does_not_exist").show()
  except PySparkException as ex:
    if (ex.getSqlState() == "42P01"):
      print("I'm so sorry, but I cannot find: " + ex.getMessageParameters()['relationName'])
    else:
      raise
  

  Result

  I'm so sorry, but I cannot find: `does_not_exist`
  

• Capture apenas a classe TABLE_OR_VIEW_NOT_FOUND de erro e exiba uma mensagem personalizada:

  Scala

  import org.apache.spark.SparkThrowable
  
  try {
    spark.sql("SELECT * FROM does_not_exist").show()
  }
  catch {
    case ex: SparkThrowable if (ex.getErrorClass == "TABLE_OR_VIEW_NOT_FOUND") =>
      println("I'm so sorry, but I cannot find: " + ex.getMessageParameters().get("relationName"))
  }
  

  Python

  from pyspark.errors import PySparkException
  
  try:
    spark.sql("SELECT * FROM does_not_exist").show()
  except PySparkException as ex:
    if (ex.getErrorClass() == "TABLE_OR_VIEW_NOT_FOUND"):
      print("I'm so sorry, but I cannot find: " + ex.getMessageParameters()['relationName'])
    else:
      raise
  

  Result

  I'm so sorry, but I cannot find: `does_not_exist`
  

Exceções levantadas pelo usuário

O Azure Databricks fornece as seguintes funções para gerar erros definidos pelo usuário:

• raise_error

  Gera uma exceção com uma mensagem de erro personalizada.

• assert_true

  Gera um erro com uma mensagem de erro opcional, se uma condição não for atendida.

Ambas as funções retornam a classe de erro 'USER_RAISED_EXCEPTION' e a mensagem definida pelo SQLSTATE 'P0001' usuário.

Exemplos

> SELECT raise_error('This is a custom error message');
 [USER_RAISED_EXCEPTION] This is a custom error message. SQLSTATE: P0001

> SELECT assert_true(1 = 2, 'One is not two!');
 [USER_RAISED_EXCEPTION] One is not two! SQLSTATE: P0001

> SELECT assert_true(1 = 2);
 [USER_RAISED_EXCEPTION] '(1 = 2)' is not true! SQLSTATE: P0001

Relacionada

• assert_true função
• raise_error função