共用方式為


更新為最新的 Databricks SQL API 版本

本頁說明最新版本 Databricks SQL API 中查詢、警示、權限、資料來源及視覺化 API 的變更。 舊有 API 已被棄用,支援也將很快結束。 使用此頁面將您的應用程式與整合遷移至新的 API 版本。

查詢 API 的變更

新的查詢 API 包含更方便使用的體驗,其中包含更具描述性的名稱、編頁回應,以及依建立時間自動排序的清單回應。 下列清單描述查詢 API 的變更:

  • API 路徑現在是 api/2.0/sql/queries,取代的 /api/2.0/preview/sql/queries舊版路徑。
  • 包含具有更具描述性的欄位名稱和類型的新查詢定義。
  • 更新端點現在支援部分更新,方法是使用 PATCH 而非 POST
  • 更新端點現在支援傳輸查詢的擁有權。 先前,這隻允許使用 傳輸對象擁有權 API
  • 清單端點回應現在會使用令牌為基礎的分頁。
  • 清單端點不再支援依名稱或自定義排序進行篩選。 相反地,所有可存取的查詢都會依建立時間以遞增順序傳回和排序。
  • 不再支援還原端點。 已刪除的查詢仍然可以透過 Azure Databricks UI 進行還原。

如需更新查詢 API 的完整檔,請參閱 查詢

警示 API 的變更

新的警報 API 提供更佳的使用者體驗,其中包含更具描述性的欄位名稱和類型、支援列出端點的分頁回應,以及部分更新的支援。 下列清單描述警示 API 的變更:

  • API 路徑現在是 api/2.0/sql/alerts,取代的 /api/2.0/preview/sql/alerts舊版路徑。
  • 包含一個新建立的警示定義,具有更加具體的欄位名稱和類型。
  • 更新端點現在支援部分更新,方法是使用 PATCH 而非 POST
  • 更新端點現在支援傳輸查詢的擁有權。 先前,這隻允許使用 傳輸對象擁有權 API
  • 列表端點的回應現在會採用以令牌為基礎的分頁方式。
  • 刪除端點現在會將警示移至垃圾桶,而不是永久刪除警示。 已刪除的警報會在 30 天之後自動清除。 您可以透過 Azure Databricks UI 在刪除後的 30 天內還原垃圾警示。

如需更新警示 API 的完整檔,請參閱 警示

權限 API 已被棄用

權限 API 現在被標記為已棄用。 使用 Workspace API 來管理物件權限。 利用查詢和警示更新 API,轉移物件所有權。

Data Sources API 已棄用

資料來源 API 現已標記為棄用。 目前,其功能僅限於取得 SQL 倉儲清單。 由於新的查詢 API 支援傳入和傳回 SQL 倉儲標識碼,而不是數據源標識碼,因此不再需要在數據源與 SQL 倉儲之間轉換的個別 API 呼叫。

升級 SDK 版本

如果你是透過 Databricks SDK 存取舊版 Databricks SQL API,請升級到最新版本的 SDK 並遷移到新的 API。 有關 SDK 文件,請參見 Databricks 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_endpointdatabricks_sql_warehouse

升級到 Databricks Terraform 供應商 v1.105.0 或更新版本。 這個 data_source_id 欄位已經被棄用了。 升級以防止關閉棄用資料來源 API 時的錯誤。