Atualize para a versão mais recente da API SQL do Databricks

Esta página descreve alterações às APIs de Consultas, Alertas, Permissões, Fontes de Dados e Visualizações incluídas na versão mais recente da API SQL do Databricks. A API legada está obsoleta e o suporte terminará em breve. Use esta página para migrar as suas aplicações e integrações para a nova versão da API.

Alterações na API de consultas

A nova API Queries inclui uma experiência mais amigável para o utilizador, com nomes mais descritivos, respostas paginadas e respostas de lista ordenadas automaticamente por tempo de criação. A lista seguinte descreve as alterações à API Queries:

• 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.
• O endpoint de atualização agora suporta atualizações parciais usando PATCH em vez de POST.
• O endpoint de atualização agora suporta a transferência da propriedade das consultas. Anteriormente, isso só era permitido usando a API de propriedade do objeto de transferência.
• As respostas dos endpoints da lista são agora paginadas usando um sistema de paginação baseado em tokens.
• O endpoint da lista já não suporta filtragem por nome ou ordenação personalizada. Em vez disso, todas as consultas acessíveis são retornadas e classificadas em ordem crescente por seu tempo de criação.
• O endpoint de restauro já não é suportado. As consultas perdidas podem continuar a ser restauradas por meio da interface do usuário do Azure Databricks.

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

Alterações na API de Alertas

A nova API de Alertas inclui uma experiência mais amigável para o utilizador, com nomes e tipos de campos mais descritivos, respostas paginadas aos endpoints das listas e suporte para atualizações parciais. A lista seguinte descreve as alterações à API de Alertas:

• O caminho da API é agora api/2.0/sql/alerts, substituindo o caminho herdado de /api/2.0/preview/sql/alerts.
• Inclui-se uma nova definição de alerta, em que se usam nomes e tipos de campo mais descritivos.
• O endpoint de atualização agora suporta atualizações parciais usando PATCH em vez de POST.
• O endpoint de atualização agora suporta a transferência da propriedade das consultas. Anteriormente, isso só era permitido usando a API de propriedade do objeto de transferência.
• As respostas dos endpoints da lista são agora paginadas usando um sistema de paginação baseado em tokens.
• O endpoint de exclusão agora move o alerta para a lixeira em vez de excluí-lo permanentemente. Os alertas eliminados serão automaticamente limpos após 30 dias. Os alertas eliminados podem ser restaurados dentro de 30 dias após a eliminação por meio da interface do utilizador do Azure Databricks.

Para obter a documentação completa sobre a API de alertas atualizada, consulte Alertas.

API de permissões obsoleta

A API de Permissões está agora marcada como obsoleta. Use a API do Workspace para gerir permissões de objetos. Use as APIs de atualização de consultas e alertas para transferir a propriedade dos objetos.

API de Fontes de Dados descontinuada

A API de Fontes de Dados está agora marcada como obsoleta. Atualmente, a sua funcionalidade limita-se a obter uma lista de armazéns SQL. Como a nova API de Consultas oferece suporte à passagem e ao retorno de IDs do SQL warehouse em vez de IDs de fonte de dados, uma chamada de API separada para converter entre fontes de dados e SQL warehouses não é mais necessária.

Atualização das versões do SDK

Se estiveres a aceder à antiga API SQL do Databricks através dos SDKs Databricks, atualiza para a versão mais recente do SDK e migra para as novas APIs. Consulte a documentação dos SDKs Databricks.

Migração de comandos CLI

Se estiver a aceder à API SQL legada do Databricks através da CLI do Databricks, migre a partir destes grupos de comandos obsoletos:

Deprecated	Use em vez disso
consultas-antigas	queries
alertas-legacy	alerts
fontes de dados	Sem substituição

Migração dos recursos Terraform

Se usar o Terraform para gerir os seus recursos SQL do Databricks, migre para as novas definições de recursos:

Recurso Descontinuado	Use em vez disso	Guia de migração
databricks_sql_query	databricks_query	Guia de migração
databricks_sql_alert	databricks_alert	Guia de migração
databricks_sql_visualization	databricks_dashboard	Sem guia de migração

Para databricks_sql_endpoint e databricks_sql_warehouse:

Atualize para o fornecedor Databricks Terraform v1.105.0 ou posterior. O data_source_id campo está obsoleto. Atualize para evitar erros quando a API de fontes de dados obsoleta estiver desligada.