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

この記事では、の最新バージョンに含まれるクエリ、アラート、権限、およびデータソースへの変更について説明します。APIsDatabricks SQLAPIこの記事を参考にして、アプリケーションと統合を新しい API バージョンに移行してください。

レガシー API は引き続き 6 か月間サポートされます。この移行期間により、古いバージョンが段階的に廃止される前に移行する時間を確保できます。

クエリ 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 は、Get object ACLおよびSet object ACL をサポートしなくなりました。これらのアクションの権限を管理するには、ワークスペースAPIを使用します。

データソース API がレガシーとしてマークされました

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