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

Esta página descreve as alterações nas APIs de Consultas, Alertas, Permissões, Fontes de Dados e Visualizações incluídas na versão mais recente da API do Databricks SQL. A API herdada foi preterida e o suporte terminará 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 amigável com nomes mais descritivos, respostas paginadas e respostas de lista classificadas automaticamente pelo tempo 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 herdado de /api/2.0/preview/sql/queries.
• Inclui uma nova definição de consulta com tipos e nomes de campo mais descritivos.
• O endpoint de atualização agora dá suporte a atualizações parciais usando PATCH em vez de POST.
• Agora, o ponto de extremidade de atualização dá suporte à transferência da propriedade de consultas. Anteriormente, isso só era permitido usando a API transferir propriedade de objeto.
• Agora, as respostas do ponto de extremidade da lista são paginadas usando a paginação baseada em token.
• O endpoint de lista não suporta mais 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 a hora de criação.
• Não há mais suporte para o ponto de extremidade de restauração. As consultas descartadas podem continuar a ser restauradas pela 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, com nomes e tipos de campo mais descritivos, suporte para atualizações parciais e respostas paginadas para endpoints de listas. A lista a seguir descreve as alterações na 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 uma nova definição de alerta com tipos e nomes de campo mais descritivos usados.
• O endpoint de atualização agora dá suporte a atualizações parciais usando PATCH em vez de POST.
• Agora, o ponto de extremidade de atualização dá suporte à transferência da propriedade de consultas. Anteriormente, isso só era permitido usando a API transferir propriedade de objeto.
• Agora, as respostas do ponto de extremidade da lista são paginadas usando a paginação baseada em token.
• Agora, o ponto de extremidade de exclusão 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 dentro de 30 dias da exclusão por meio da interface do usuário 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 agora está marcada como preterida. Use a API do Workspace para gerenciar permissões de objeto. Use as APIs de atualização de consultas e alertas para transferir a propriedade do objeto.

API de Fontes de Dados descontinuada

A API de Fontes de Dados agora está marcada como preterida. Atualmente, sua funcionalidade está limitada a obter uma lista de sql warehouses. Como a nova API de Consultas dá suporte à passagem e ao retorno de IDs do SQL Warehouse em vez de IDs de fonte de dados, uma chamada à API separada para converter entre fontes de dados e SQL warehouses não é mais necessária.

Atualizando versões do SDK

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

Migrando comandos da CLI

Se você estiver acessando a API herdada do Databricks SQL por meio da CLI do Databricks, faça a migração a partir destes grupos de comandos obsoletos:

Migrando recursos do Terraform

Se você usar o Terraform para gerenciar seus recursos sql do Databricks, migre para as novas definições de recurso:

Para databricks_sql_endpoint e databricks_sql_warehouse:

Atualize para o provedor Terraform do Databricks versão v1.105.0 ou superior. O data_source_id campo foi preterido. Atualize para evitar erros quando a API de fontes de dados preteridas estiver desativada.