次の方法で共有

最新の Databricks SQL API バージョンへの更新

  • [アーティクル]

この記事では、最新バージョンの Databricks SQL API に含まれるクエリ、アラート、アクセス許可、データ ソース API の変更について説明します。 この記事は、アプリケーションと統合を新しい API バージョンに移行する際に役立ちます。

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

クエリ API の変更

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

  • API パスが api/2.0/sql/queries になり、レガシ パス /api/2.0/preview/sql/queries から変更されました。
  • よりわかりやすいフィールド名と型を含む新しいクエリ定義が含まれています。
  • 更新エンドポイントでは、POST ではなく PATCH を使用して部分的な更新がサポートされるようになりました。
  • 更新エンドポイントで、クエリの所有権の譲渡がサポートされるようになりました。 以前は、[オブジェクト所有権の譲渡 API](/API/workspace/dbsqlpermissions/transfer ownership) を使用する場合にのみ許可されていました。
  • リスト エンドポイントの応答は、トークン ベースの改ページ位置の自動修正を使用してページ分割されるようになりました。
  • リスト エンドポイントでは、名前またはカスタム順序によるフィルター処理がサポートされなくなりました。 代わりに、すべてのアクセス可能なクエリが返され、作成日時に昇順で並べ替えられます。
  • 復元エンドポイントはサポートされなくなりました。 ごみ箱に入れられたクエリは、Azure Databricks UI を使って引き続き復元できます。

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

アラート API の変更

新しいアラート API には、よりわかりやすいフィールド名と型、リスト エンドポイントに対するページ分割された応答、部分的な更新のサポートを備えた、よりユーザー フレンドリなエクスペリエンスが含まれています。 次の一覧では、アラート API の変更について説明します。

  • API パスが api/2.0/sql/alerts になり、レガシ パス /api/2.0/preview/sql/alerts から変更されました。
  • よりわかりやすいフィールド名と型が使用される新しいアラート定義が含まれています。
  • 更新エンドポイントでは、POST ではなく PATCH を使用して部分的な更新がサポートされるようになりました。
  • 更新エンドポイントで、クエリの所有権の譲渡がサポートされるようになりました。 これまで、これは Transfer Object Ownership API を使うことによってのみ実行できました。
  • リスト エンドポイントの応答は、トークン ベースの改ページ位置の自動修正を使用してページ分割されるようになりました。
  • 削除エンドポイントは、アラートを完全に削除するのではなく、アラートをごみ箱に移動するようになりました。 ごみ箱に入れられたアラートは、30 日経つと自動的にクリーンアップされます。 削除から 30 日以内であれば、Azure Databricks UI を使ってごみ箱のアラートを復元できます。

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

Permissions API の変更

Permissions API では、Get オブジェクト ACL および Set オブジェクト ACLがサポートされなくなりました。 これらのアクションのアクセス許可を管理するには、Workspace API を使用します。

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

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