このページでは、最新バージョンの Databricks SQL API に含まれるクエリ、アラート、アクセス許可、データ ソース、視覚化 API の変更について説明します。 レガシ API は非推奨となり、サポートは間もなく終了します。 このページを使用して、アプリケーションと統合を新しい API バージョンに移行します。
クエリ API の変更
新しい Queries API には、わかりやすい名前、ページ分割された応答、および作成時刻で自動的に並べ替えられた応答の一覧を含む、よりわかりやすいエクスペリエンスが含まれています。 次の一覧では、Queries API の変更について説明します。
- API パスが
api/2.0/sql/queriesになり、レガシ パス/api/2.0/preview/sql/queriesから変更されました。 - よりわかりやすいフィールド名と型を含む新しいクエリ定義が含まれています。
- 更新エンドポイントでは、
PATCHではなくPOSTを使用して部分的な更新がサポートされるようになりました。 - 更新エンドポイントで、クエリの所有権の譲渡がサポートされるようになりました。 これまで、これは Transfer Object Ownership API を使うことによってのみ実行できました。
- リストエンドポイントの応答は、トークンベースのページネーションを使用してページングされるようになりました。
- リスト エンドポイントでは、名前またはカスタム順序によるフィルター処理がサポートされなくなりました。 代わりに、すべてのアクセス可能なクエリが返され、作成日時に昇順で並べ替えられます。
- 復元エンドポイントはサポートされなくなりました。 ごみ箱に入れられたクエリは、Azure Databricks UI を使って引き続き復元できます。
更新されたクエリ API の完全なドキュメントについては、「クエリ」を参照してください。
アラート API の変更
新しい Alerts API には、よりわかりやすいフィールド名と型、リスト エンドポイントに対するページ分割された応答、部分的な更新のサポートを備えた、よりわかりやすいエクスペリエンスが含まれています。 次の一覧では、Alerts API の変更について説明します。
- API パスが
api/2.0/sql/alertsになり、レガシ パス/api/2.0/preview/sql/alertsから変更されました。 - よりわかりやすいフィールド名と型が使用される新しいアラート定義が含まれています。
- 更新エンドポイントでは、
PATCHではなくPOSTを使用して部分的な更新がサポートされるようになりました。 - 更新エンドポイントで、クエリの所有権の譲渡がサポートされるようになりました。 これまで、これは Transfer Object Ownership API を使うことによってのみ実行できました。
- リストエンドポイントの応答は、トークンベースのページネーションを使用してページングされるようになりました。
- 削除エンドポイントは、アラートを完全に削除するのではなく、アラートをごみ箱に移動するようになりました。 ごみ箱に入れられたアラートは、30 日経つと自動的にクリーンアップされます。 削除から 30 日以内であれば、Azure Databricks UI を使ってごみ箱のアラートを復元できます。
更新されたアラート API の完全なドキュメントについては、「アラート」を参照してください。
Permissions API の非推奨
Permissions API は非推奨としてマークされるようになりました。 Workspace API を使用してオブジェクトのアクセス許可を管理します。 クエリとアラートの更新 API を使用して、オブジェクトの所有権を転送します。
データ ソース API の非推奨
データ ソース API は非推奨としてマークされるようになりました。 現時点では、その機能は SQL ウェアハウスの一覧を取得することに限定されています。 新しいクエリ API では、データ ソース ID ではなく SQL ウェアハウス ID の受け渡しと返しがサポートされているため、データ ソースと SQL ウェアハウス間で変換する別の API 呼び出しは不要になりました。
SDK バージョンのアップグレード
Databricks SDK を使用してレガシ Databricks SQL API にアクセスする場合は、最新の SDK バージョンにアップグレードし、新しい API に移行します。 Databricks SDKのSDKドキュメントを参照してください。
CLI コマンドの移行
Databricks CLI を使用してレガシ Databricks SQL API にアクセスする場合は、次の非推奨のコマンド グループから移行します。
| Deprecated | 代わりに使用する |
|---|---|
| queries-legacy | queries |
| alerts-legacy | alerts |
| データソース | 置き換えなし |
Terraform リソースの移行
Terraform を使用して Databricks SQL リソースを管理する場合は、新しいリソース定義に移行します。
| 非推奨のリソース | 代わりに使用する | 移行ガイド |
|---|---|---|
| databricks_sql_query | databricks_query | 移行ガイド |
| databricks_sql_alert | databricks_alert | 移行ガイド |
| databricks_sql_visualization | databricks_dashboard | 移行ガイドなし |
databricks_sql_endpointとdatabricks_sql_warehouseの場合:
Databricks Terraform プロバイダー v1.105.0 以降にアップグレードします。
data_source_id フィールドは非推奨です。 非推奨のデータ ソース API がオフになっている場合にエラーが発生しないようにアップグレードします。