Azure Databricks でのエラー処理

[アーティクル]
10/25/2024

適用対象: Databricks SQL Databricks Runtime 12.2 以上

エラーコンポーネント

Azure Databricks でエラーが発生する場合は、次のコンポーネントが含まれています。

エラークラス

わかりやすく、人間が判読でき、エラー条件に一意の文字列。

エラークラスの中には、サブクラスを含むものもあります。

例: TABLE_OR_VIEW_NOT_FOUND、 INCOMPLETE_TYPE_DEFINITION。ARRAY。

すべてのエラークラスの一覧については、「エラークラス」を参照してください。
SQLSTATE

5 文字の長さの文字列で、多くの製品や API でサポートされている標準形式にエラークラスをグループ化します。

例: '42P01'

Azure Databricks で使用されるすべての SQLSTATE の完全なリストについては、SQLSTATE を参照してください。
パラメーター化されたメッセージ

パラメーターのプレースホルダーを含んだエラーメッセージです。

例: TABLE_OR_VIEW_NOT_FOUND には、次のメッセージが含まれます。
```
The table or view <relationName> cannot be found.
```
パラメーター化されたメッセージを使用して、メッセージパラメーター値をパラメータータグ <parameter> にマッピングすることにより、エラーメッセージを表示できます。
メッセージのパラメーター

エラーに関する追加情報を提供するパラメーターと値のマップ。 (例: 'relationName' -> 'main.default.tab1')。

メッセージ

エラークラスと SQLSTATE を含む、パラメーターが入力され完全にレンダリングされたエラーメッセージ。次に例を示します。

[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

警告

メッセージとパラメーター化されたメッセージはリリース間で安定していません。メッセージテキストは予告なく変更またはローカライズされる場合があります。プログラムでエラー状態を処理するには、代わりにエラークラス、SQLSTATE、メッセージパラメーターを使用します。

エラー条件の処理

適用対象: check marked yes Databricks SQL 「はい」のチェックマーク Databricks Runtime 14.2 以上

重要

この機能はパブリックプレビュー段階にあります。

Azure Databricks では、エラー条件を処理するための言語固有の API が提供されます。

Python

Python では、pySparkException を使用します

PySparkException.getErrorClass(): 例外のエラークラスを文字列として返します。
PySparkException.getMessageParameters(): 例外のメッセージパラメーターを辞書として返します。
PySparkException.getSqlState(): 式の SQLSTATE を文字列として返します。

Scala

Scala では SparkThrowable を使用します。

getErrorClass(): エラークラスを文字列として返します。
getMessageParameters(): メッセージパラメーターをマップとして返します。
getSqlState(): SQLSTATE を文字列として返します。

例

例外をキャッチし、エラークラス、メッセージパラメーター、SQLSTATE を表示します。既定のエラーメッセージも表示する

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)

結果

  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

SQLSTATE 42P01 のみをキャッチし、次のカスタムメッセージを表示します。

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

結果

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

エラークラス TABLE_OR_VIEW_NOT_FOUND のみをキャッチし、次のカスタムメッセージを表示します。

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

結果

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

ユーザーが発生させた例外

Azure Databricks には、ユーザー定義のエラーを発生させるための次の関数が用意されています。

raise_error

独自のエラーメッセージを含む例外を発生させます。
assert_true

条件が満たされない場合、オプションのエラーメッセージとともにエラーを発生させます。

いずれの関数もエラークラス ‘USER_RAISED_EXCEPTION’ と SQLSTATE 'P0001' をユーザ定義のメッセージと共に返します。

例

> 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

次の方法で共有

Azure Databricks でのエラー処理

エラーコンポーネント

エラー条件の処理

Python

Scala

例

Scala

Python

Scala

Python

Scala

Python

ユーザーが発生させた例外

例

フィードバック

その他のリソース

次の方法で共有

Azure Databricks でのエラー処理

エラー コンポーネント

エラー条件の処理

Python

Scala

例

Scala

Python

Scala

Python

Scala

Python

ユーザーが発生させた例外

例

関連項目

フィードバック

その他のリソース

エラーコンポーネント