Mettre à jour vers la dernière version de l'API Databricks SQL

Cette page décrit les modifications apportées aux APIs Queries, alertes, autorisations, sources de données et Visualisations incluses dans la dernière version de l'API Databricks SQL. L'API héritée est obsolète et son support prendra fin prochainement. Utilisez cette page pour migrer vos applications et intégrations vers la nouvelle version de l'API.

Modifications de l'API de query

La nouvelle API des requêtes offre une expérience plus conviviale avec des noms plus descriptifs, des réponses paginées et des réponses de liste triées automatiquement par date de création. La liste suivante décrit les modifications apportées à l'API des requêtes :

• Le chemin d'API est maintenant api/2.0/sql/queries, remplaçant le chemin hérité de /api/2.0/preview/sql/queries.
• Comprend une nouvelle définition de query avec des noms et des types de champs plus descriptifs.
• Le endpoint de mise à jour prend désormais en charge les mises à jour partielles en utilisant PATCH au lieu de POST.
• L'Endpoint de mise à jour prend désormais en charge le transfert de la propriété des queries. Auparavant, cela n'était autorisé qu'en utilisant l'API de transfert de propriété d'objet.
• Les réponses de l'endpoint de liste sont désormais paginées à l'aide d'une pagination basée sur des jetons.
• L'Endpoint de liste ne prend plus en charge le filtrage par nom ou le tri personnalisé. Au lieu de cela, toutes les requêtes accessibles sont renvoyées et triées par ordre croissant en fonction de leur heure de création.
• L'endpoint de restauration n'est plus pris en charge. Les requêtes mises à la corbeille peuvent continuer à être restaurées via l'interface utilisateur de Databricks.

Pour la documentation complète sur l'API des Requêtes mise à jour, consultez Requêtes.

Modifications apportées à l'API des alertes

La nouvelle API d'Alertes offre une expérience plus conviviale avec des noms et types de champs plus descriptifs, des réponses paginées aux endpoints de liste et la prise en charge des mises à jour partielles. La liste suivante décrit les modifications apportées à l'API d'alertes :

• Le chemin d'API est maintenant api/2.0/sql/alerts, remplaçant le chemin hérité de /api/2.0/preview/sql/alerts.
• Inclut une nouvelle définition d’alerte avec des noms et des types de champs plus descriptifs.
• Le endpoint de mise à jour prend désormais en charge les mises à jour partielles en utilisant PATCH au lieu de POST.
• L'Endpoint de mise à jour prend désormais en charge le transfert de la propriété des queries. Auparavant, cela n'était autorisé qu'en utilisant l'API de transfert de propriété d'objet.
• Les réponses de l'endpoint de liste sont désormais paginées à l'aide d'une pagination basée sur des jetons.
• L'endpoint de suppression déplace désormais l'alerte vers la corbeille au lieu de supprimer l'alerte définitivement. Les alertes présentes dans la corbeille sont automatiquement supprimées définitivement au bout de 30 jours. Les alertes mises à la corbeille peuvent être restaurées dans les 30 jours suivant la suppression via l'interface utilisateur de Databricks.

Pour une documentation complète sur l’API d’alertes mise à jour, consultez Alertes.

API Permissions obsolète

L'API Permissions est désormais considérée comme obsolète. Utilisez l'Workspace API pour gérer les autorisations d'objets. Utilisez les API de mise à jour des queries et des alertes pour transférer la propriété des objets.

API de sources de données obsolète

L'API de sources de données est maintenant marquée comme obsolète. Actuellement, ses fonctionnalités se limitent à l'obtention d'une liste de SQL Warehouse. Étant donné que la nouvelle API Queries prend en charge le passage et le retour d'ID de SQL warehouse au lieu d'ID de source de données, un appel d'API distinct pour convertir entre les sources de données et les SQL warehouses n'est plus nécessaire.

Mise à niveau des versions du SDK

Si vous accédez à l'ancienne API Databricks SQL via des SDK Databricks, mettez à niveau vers la dernière version du SDK et migrez vers les nouvelles APIs. Consultez les SDK Databricks pour la documentation du SDK.

Migration des commandes CLI

Si vous accédez à l'API Databricks SQL héritée via la CLI Databricks, migrez à partir de ces groupes de commandes obsolètes :

Obsolète	Utiliser à la place
queries-héritées	requêtes
alerts-legacy	alertes
source de données, origine de données	Aucun remplacement

Obsolète	Utiliser à la place
queries-héritées	requêtes
alerts-legacy	alertes
source de données, origine de données	Aucun remplacement

Migration des ressources Terraform

Si vous utilisez Terraform pour gérer vos ressources Databricks SQL, migrez vers les nouvelles définitions de ressources :

Ressource obsolète	Utiliser à la place	Guide de migration
databricks_SQL_query	databricks_query	Guide de migration
databricks_sql_alert	databricks_alert	Guide de migration
databricks_sql_visualization	databricks_dashboard	Pas de guide de migration

Ressource obsolète	Utiliser à la place	Guide de migration
databricks_SQL_query	databricks_query	Guide de migration
databricks_sql_alert	databricks_alert	Guide de migration
databricks_sql_visualization	databricks_dashboard	Pas de guide de migration

Pour databricks_sql_endpoint et databricks_sql_warehouse:

Passez à la version 1.105.0 ou ultérieure du fournisseur Databricks Terraform. Le champ data_source_id est obsolète. Mettez à niveau pour éviter les erreurs lorsque l'API des sources de données obsolètes est désactivée.