Databricks SQL API の最新バージョンに更新する

このページではDatabricks SQL APIの最新バージョンに含まれるクエリ、アラート、権限、データソース、および視覚化APIsへの変更について説明します。レガシー API は非推奨となっており、サポートはまもなく終了します。このページを使用して、アプリケーションと統合を新しい API バージョンに移行します。

クエリ API の変更

新しいクエリ API には、よりわかりやすい名前、ページ分割された応答、作成時間で自動的に並べ替えられたリスト応答など、よりユーザーフレンドリーなエクスペリエンスが含まれています。次の一覧では、クエリ API の変更点について説明します。

API パスが api/2.0/sql/queriesになり、 /api/2.0/preview/sql/queriesのレガシーパスが置き換えられました。
よりわかりやすいフィールド名とタイプを持つ新しいクエリ定義が含まれています。
更新エンドポイントで、POSTではなく PATCH を使用した部分的な更新がサポートされるようになりました。
更新エンドポイントで、クエリの所有権の転送がサポートされるようになりました。以前は、これはオブジェクト所有権の転送 API を使用してのみ許可されていました。
リストエンドポイントの応答は、トークンベースのページ分割を使用してページ分割されるようになりました。
リストエンドポイントでは、名前によるフィルタリングやカスタム順序付けはサポートされなくなりました。代わりに、アクセス可能なすべてのクエリが返され、作成時刻の昇順で並べ替えられます。
復元エンドポイントはサポートされなくなりました。ごみ箱入りのクエリは、Databricks UI を使用して引き続き復元できます。

更新されたクエリ API の詳細なドキュメントについては、クエリを参照してください。

アラート API の変更

新しいアラート API には、よりわかりやすいフィールド名とタイプ、リストエンドポイントへのページ分割された応答、部分的な更新のサポートなど、より使いやすいエクスペリエンスが含まれています。次の一覧では、アラート API の変更点について説明します。

API パスが api/2.0/sql/alertsになり、 /api/2.0/preview/sql/alertsのレガシーパスが置き換えられました。
新しいアラート定義が含まれており、フィールド名とタイプがより説明的に使用されます。
更新エンドポイントで、POSTではなく PATCH を使用した部分的な更新がサポートされるようになりました。
更新エンドポイントで、クエリの所有権の転送がサポートされるようになりました。以前は、これはオブジェクト所有権の転送 API を使用してのみ許可されていました。
リストエンドポイントの応答は、トークンベースのページ分割を使用してページ分割されるようになりました。
削除エンドポイントは、アラートを完全に削除するのではなく、アラートをゴミ箱に移動するようになりました。ごみ箱にごみ箱にされたアラートは、30日後に自動的にクリーンアップされます。ごみ箱入りのアラートは、削除から 30 日以内であれば Databricks UI を使用して復元できます。

更新されたアラート API の詳細なドキュメントについては、「アラート」を参照してください。

権限APIは非推奨になりました

Permissions API は非推奨としてマークされました。ワークスペースAPIを使用してオブジェクトの権限を管理します。クエリとアラート更新APIsを使用して、オブジェクトの所有権を譲渡します。

データソース API は非推奨になりました

データソースAPIは非推奨としてマークされています。現在、その機能はSQLウェアハウスのリストの取得に限定されています。新しいクエリAPIデータソース ID の代わりにSQLウェアハウス ID の受け渡しと返しをサポートしているため、データソースとSQLウェアハウスの間で変換するための別のAPI呼び出しは必要なくなりました。

SDKバージョンのアップグレード

Databricks SDK を介して従来のDatabricks SQL APIにアクセスしている場合は、最新のSDKバージョンにアップグレードし、新しいAPIsに移行します。 SDK ドキュメントについては、 Databricks SDK を参照してください。

CLIコマンドの移行

Databricks CLIを介して従来の Databricks SQL API にアクセスしている場合は、次の非推奨のコマンドグループから移行します。

非推奨	代わりに使用
queries-legacy	queries
alerts-legacy	アラート
data-sources	代替品なし

Terraform リソースの移行

Terraformを使用してDatabricks SQLリソースを管理する場合は、新しいリソース定義に移行します。

非推奨のリソース	代わりに使用	移行ガイド
データブリックスSQLクエリ	データブリックスクエリ	移行ガイド
データブリックスSQLアラート	データブリックスアラート	移行ガイド
データブリックスSQL視覚化	データブリックスダッシュボード	移行ガイドなし

非推奨のリソース	代わりに使用	移行ガイド
データブリックスSQLクエリ	データブリックスクエリ	移行ガイド
データブリックスSQLアラート	データブリックスアラート	移行ガイド
データブリックスSQL視覚化	データブリックスダッシュボード	移行ガイドなし

databricks_sql_endpointおよびdatabricks_sql_warehouseの場合:

Databricks Terraform プロバイダー v1.105.0 以降にアップグレードします。data_source_idフィールドは非推奨です。非推奨のデータソースAPIオフになっている場合のエラーを防ぐためにアップグレードします。

クエリ API の変更​

アラート API の変更​

権限APIは非推奨になりました​

データソース API は非推奨になりました​

SDKバージョンのアップグレード​

CLIコマンドの移行​

Terraform リソースの移行​