本页介绍 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 现在标记为已弃用。 使用 工作区 API 管理对象权限。 使用查询和警报更新 API 来转移对象所有权。
数据源 API 已弃用
数据源 API 现在标记为已弃用。 目前，其功能仅限于获取 SQL 仓库的列表。 由于新的查询 API 支持传入和返回 SQL 仓库 ID 而不是数据源 ID，因此不再需要在数据源和 SQL 仓库之间转换单独的 API 调用。
升级 SDK 版本
如果要通过 Databricks SDK 访问旧 Databricks SQL API，请升级到最新的 SDK 版本并迁移到新的 API。 请参阅 Databricks SDK 文档。
迁移 CLI 命令
如果要通过 Databricks CLI 访问旧 Databricks SQL API，请从这些已弃用的命令组进行迁移：
| 已弃用 | 请改用 |
|---|---|
| queries-legacy | queries |
| alerts-legacy | 警报 |
| 数据源 | 无替换 |
迁移 Terraform 资源
如果使用 Terraform 管理 Databricks SQL 资源，请迁移到新的资源定义：
| 已弃用的资源 | 请改用 | 迁移指南 |
|---|---|---|
| databricks_sql_query | databricks_query | 迁移指南 |
| databricks_sql_alert | databricks_alert | 迁移指南 |
| Databricks SQL 可视化 | databricks_dashboard | 无迁移指南 |
对于 databricks_sql_endpoint 和 databricks_sql_warehouse：
升级到 Databricks Terraform 提供程序 v1.105.0 或更高版本。 字段 data_source_id 已弃用。 升级以防止在关闭弃用的数据源 API 时出错。