Atualize para a versão mais recente Databricks SQL API

Esta página descreve as alterações nas APIs Consultas, Alertas, Permissões, Fonte de Dados e Visualizações incluídas na versão mais recente da API Databricks SQL . A API legada está obsoleta e o suporte será encerrado em breve. Use esta página para migrar seus aplicativos e integrações para a nova versão da API.

Alterações na API de consultas

A nova API de consultas inclui uma experiência mais fácil de usar, com nomes mais descritivos, respostas paginadas e listas de respostas classificadas automaticamente por hora de criação. A lista a seguir descreve as alterações na API de consultas:

• O caminho da API agora é api/2.0/sql/queries, substituindo o caminho legado de /api/2.0/preview/sql/queries.
• Inclui uma nova definição de consulta com nomes e tipos de campo mais descritivos.
• A atualização endpoint agora é compatível com atualizações parciais, usando PATCH em vez de POST.
• A atualização endpoint agora suporta a transferência de propriedade de consultas. Anteriormente, isso só era permitido usando a API de propriedade de objeto de transferência.
• As respostas da lista endpoint agora são paginadas usando a paginação baseada em tokens.
• A lista endpoint não suporta mais a filtragem por nome ou ordenação personalizada. Em vez disso, todas as consultas acessíveis são retornadas e classificadas em ordem crescente de acordo com o horário de criação.
• A restauração endpoint não é mais suportada. As consultas descartadas podem continuar a ser restauradas por meio da interface do usuário do Databricks.

Para obter a documentação completa sobre a API de consultas atualizada, consulte Consultas.

Alterações no alerta API

O novo alerta API inclui uma experiência mais amigável com nomes e tipos de campos mais descritivos, respostas paginadas para o endpoint da lista e suporte para atualizações parciais. A lista a seguir descreve as alterações no alerta API:

• O caminho da API agora é api/2.0/sql/alerts, substituindo o caminho legado de /api/2.0/preview/sql/alerts.
• Inclui uma nova definição de alerta com nomes e tipos de campos mais descritivos.
• A atualização endpoint agora é compatível com atualizações parciais, usando PATCH em vez de POST.
• A atualização endpoint agora suporta a transferência de propriedade de consultas. Anteriormente, isso só era permitido usando a API de propriedade de objeto de transferência.
• As respostas da lista endpoint agora são paginadas usando a paginação baseada em tokens.
• A exclusão endpoint agora move o alerta para a lixeira em vez de excluí-lo permanentemente. Os alertas descartados serão limpos automaticamente após 30 dias. Os alertas descartados podem ser restaurados em até 30 dias após a exclusão por meio da UI Databricks.

Para obter a documentação completa sobre o alerta atualizado API, consulte alerta.

API de permissões descontinuada

A API de Permissões agora está marcada como obsoleta. Utilize a APIdo espaço de trabalho para gerenciar permissões de objetos. Utilize as APIs de consultas e atualização de alertas para transferir a propriedade do objeto.

API de fonte de dados obsoleta

A API fonte de dados agora está marcada como obsoleta. Atualmente, sua funcionalidade se limita a obter uma lista de repositórios SQL . Como a nova API de Consultas permite o envio e o retorno de IDs SQL warehouse em vez de IDs de fonte de dados, não é mais necessário fazer uma chamada API separada para converter entre fonte de dados e SQL Warehouse.

Atualizando versões do SDK

Se você estiver acessando a API Databricks SQL por meio dos SDKs Databricks , atualize para a versão mais recente SDK e migre para as novas APIs. Databricks Consulte a SDK documentação dos .

Migrando comando CLI

Se você estiver acessando a API Databricks SQL por meio da CLIDatabricks, migre destes grupos de comandos obsoletos:

Descontinuado	Use em vez de
consultas-legado	consultas
alerta-legado	alertas
fonte de dados	Sem substituto

Migrando recurso Terraform

Se você usa Terraform para gerenciar seus recursos Databricks SQL , migre para as novas definições de recursos:

Recurso obsoleto	Use em vez de	Guia de migração
consulta_sql_databricks	consulta_databricks	Guia de migração
alerta_sql_databricks	alerta_databricks	Guia de migração
visualização_sql_databricks	painel de controle do databricks	Sem guia de migração

Para databricks_sql_endpoint e databricks_sql_warehouse:

Atualize para o provedor Terraform do Databricks versão 1.105.0 ou posterior. O campo data_source_id está obsoleto. Atualize para evitar erros quando a API obsoleta de fonte de dados for desativada.