メインコンテンツまでスキップ

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 の詳細なドキュメントについては、「 アラート」を参照してください。

Permissions API の変更​

Permissions API は 、オブジェクト ACL の取得 と オブジェクト ACL の設定 をサポートしなくなりました。ワークスペース APIを使用して、これらのアクションのアクセス許可を管理します。

データソース API レガシとしてマークされています​

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

に最終更新