Partager via

Pilote Databricks pour SQLTools pour Visual Studio Code

  • Article

Important

Cette fonctionnalité est disponible en préversion publique.

Le pilote Databricks pour SQLTools vous permet d’utiliser l’extension SQLTools pour Visual Studio Code afin de parcourir des objets SQL et d’exécuter des requêtes SQL dans des espaces de travail Azure Databricks distants.

Avant de commencer

Avant de pouvoir utiliser le pilote Databricks pour SQLTools, votre espace de travail Azure Databricks et votre ordinateur de développement local doivent répondre aux exigences suivantes.

Conditions requises pour l’espace de travail

Vous devez disposer d’au moins un espace de travail Azure Databricks et l’espace de travail doit répondre aux exigences suivantes :

Configuration requise pour l’ordinateur de développement local

Vous devez disposer des éléments suivants sur votre ordinateur de développement local :

  • Visual Studio Code version 1.70 ou ultérieure. Pour afficher votre version installée, cliquez sur Code > à propos de Visual Studio Code dans le menu principal sur Linux ou macOS et sur Aide > À propos sur Windows. Pour télécharger, installer et configurer Visual Studio Code, consultez Configuration de Visual Studio Code.
  • Extension SQLTools pour Visual Studio Code.
  • Extension Pilote Databricks pour SQLTools pour Visual Studio Code.

Pour installer l’extension SQLTools, accédez à SQLTools , puis cliquez sur Installer, ou :

  1. Dans Visual Studio Code, cliquez sur Afficher > Extensions dans le menu principal.

  2. Dans la zone Rechercher des extensions dans Marketplace, entrez SQLTools.

  3. Cliquez sur l’entrée SQLTools de Matheus Teixeira.

    Notes

    Plusieurs entrées SQLTools peuvent être répertoriées. Veillez à cliquer sur l’entrée de Matheus Teixeira.

  4. Cliquez sur Installer.

Pour installer l’extension Databricks Driver for SQLTools, accédez à Pilote Databricks pour SQLTools, puis cliquez sur Installer, ou :

  1. Dans Visual Studio Code, cliquez sur Afficher > Extensions dans le menu principal.
  2. Dans la zone Rechercher des extensions dans Marketplace, entrez Databricks Driver for SQLTools.
  3. Cliquez sur l’entrée Pilote Databricks pour SQLTools .
  4. Cliquez sur Installer.

Authentification

Vous devez configurer l’authentification pour Pilote Databricks pour SQLTools comme suit.

Pilote Databricks pour SQLTools prend en charge les types d’authentification Azure Databricks suivants :

Remarque

Pilote Databricks pour SQLTools ne prend pas en charge les jetons Microsoft Entra ID.

Authentification à l’aide d’un jeton d’accès personnel Azure Databricks

Pour utiliser Pilote Databricks pour SQLTools avec l’authentification par jeton d’accès personnel Azure Databricks, vous devez disposer d’un jeton d’accès personnel Azure Databricks. Pour créer un jeton d’accès personnel, effectuez les actions suivantes :

  1. Dans votre espace de travail Azure Databricks, cliquez sur votre nom d’utilisateur Azure Databricks dans la barre supérieure, puis sélectionnez Paramètres dans la liste déroulante.
  2. Cliquez sur Développeur.
  3. À côté de Jetons d’accès, cliquez sur Gérer.
  4. Cliquez sur Générer un nouveau jeton.
  5. (Facultatif) Entrez un commentaire qui vous aide à identifier ce jeton à l’avenir et modifiez sa durée de vie par défaut (90 jours). Pour créer un jeton sans durée de vie (non recommandé), laissez vide la zone Durée de vie (en jours).
  6. Cliquez sur Générer.
  7. Copiez le jeton affiché dans un emplacement sécurisé, puis cliquez sur Terminé.

Remarque

Veillez à enregistrer le jeton copié dans un emplacement sécurisé. Ne partagez pas votre jeton copié avec d'autres. Si vous le perdez, vous ne pouvez pas régénérer exactement le même. Vous devez donc répéter cette procédure pour créer un jeton. Si vous perdez le jeton copié ou si vous pensez que le jeton a été compromis, Databricks vous recommande vivement de supprimer immédiatement ce jeton de votre espace de travail en cliquant sur l’icône de la corbeille (Révoquer) à côté du jeton de la page Jetons d’accès.

Si vous n'êtes pas en mesure de créer ou d'utiliser des jetons dans votre espace de travail, cela peut être dû au fait que votre administrateur d'espace de travail a désactivé les jetons ou ne vous a pas donné l'autorisation de créer ou d'utiliser des jetons. Consultez votre administrateur d'espace de travail ou les rubriques suivantes :

Authentification Azure Databricks OAuth de machine à machine (M2M)

Vous pouvez utiliser l’authentification Azure Databricks OAuth de machine à machine (M2M) pour vous authentifier auprès du pilote Databricks pour SQLTools, comme suit :

Remarque

L’authentification Azure Databricks OAuth M2M est disponible dans le pilote Databricks pour SQLTools versions 0.4.2 et ultérieures.

  1. Effectuez les étapes de configuration pour l’authentification OAuth M2M. Consultez Authentification OAuth M2M (machine à machine).
  2. Créez un profil de configuration Azure Databricks avec vos paramètres de configuration d’authentification OAuth M2M. Consultez la section « Configuration » de l’authentification OAuth de machine à machine (M2M).
  3. Installez et ouvrez l’extension Databricks pour Visual Studio Code sur votre machine de développement locale.
  4. Dans l’extension Databricks pour Visual Studio Code, cliquez sur le bouton Configure (Configurer) dans le volet Configuration. Si le bouton Configure (Configurer) n’est pas affiché, cliquez sur l’icône d’engrenage (Configurer l’espace de travail).
  5. Dans la Palette de commandes, pour Hôte Databricks, entrez votre URL par espace de travail Azure Databricks, par exemple https://adb-1234567890123456.7.azuredatabricks.net, puis tapez sur la touche Entrée.
  6. Sélectionnez l’entrée de profil de configuration qui correspond à celle que vous avez créée à l’étape 2.
  7. Suivez les instructions à l’écran dans votre navigateur web pour terminer l’authentification avec votre compte Azure Databricks.

Authentification Azure Databricks OAuth d’utilisateur à machine (U2M)

Vous pouvez utiliser l’authentification Azure Databricks OAuth d’utilisateur à machine (U2M) pour vous authentifier auprès du pilote Databricks pour SQLTools, comme suit :

Remarque

L’authentification Azure Databricks OAuth U2M est disponible dans le pilote Databricks pour SQLTools versions 0.4.2 et ultérieures.

  1. Installez et ouvrez l’extension Databricks pour Visual Studio Code sur votre machine de développement locale.
  2. Dans l’extension Databricks pour Visual Studio Code, cliquez sur le bouton Configure (Configurer) dans le volet Configuration. Si le bouton Configure (Configurer) n’est pas affiché, cliquez sur l’icône d’engrenage (Configurer l’espace de travail).
  3. Dans la palette de commandes, pour Databricks Host (Hôte Databricks), entrez votre URL par espace de travail Azure Databricks, par exemple https://adb-1234567890123456.7.azuredatabricks.net. Appuyez sur Entrée.
  4. Sélectionnez OAuth (utilisateur à machine).
  5. Suivez les instructions à l’écran dans votre navigateur web pour terminer l’authentification avec votre compte Azure Databricks. Si vous y êtes invité, autorisez l’accès all-apis.

Authentification Azure CLI

Vous pouvez utiliser Azure CLI pour vous authentifier auprès de Pilote Databricks pour SQLTools, comme suit :

Remarque

L’authentification avec Azure CLI est une fonctionnalité à l’état Expérimental. Cette fonctionnalité est disponible dans Pilote Databricks pour SQLTools versions 0.4.2 et ultérieures.

  1. Installez Azure CLI sur votre machine de développement locale, si vous ne l’avez pas déjà fait.
  2. Installez et ouvrez l’extension Databricks pour Visual Studio Code sur votre machine de développement locale.
  3. Dans l’extension Databricks pour Visual Studio Code, cliquez sur le bouton Configure (Configurer) dans le volet Configuration. Si le bouton Configure (Configurer) n’est pas affiché, cliquez sur l’icône d’engrenage (Configurer l’espace de travail).
  4. Dans la palette de commandes, pour Databricks Host (Hôte Databricks), entrez votre URL par espace de travail Azure Databricks, par exemple https://adb-1234567890123456.7.azuredatabricks.net. Appuyez sur Entrée.
  5. Sélectionnez Azure CLI.
  6. Suivez les invites à l’écran pour terminer l’authentification à l’aide d’Azure CLI.

Se connecter à un schéma

  1. Dans Visual Studio Code, dans la barre latérale, cliquez sur l’icône SQLTools.
  2. Dans l’affichage SQLTools, si c’est la première fois que vous utilisez l’extension SQLTools, cliquez sur Add New Connection (Ajouter une nouvelle connexion) dans le volet Connections (Connexions). Sinon, cliquez sur l’icône Ajouter une nouvelle connexion dans la barre de titre du volet.
  3. Sous l’onglet Paramètres SQLTools, pour l’étape Sélectionner un pilote de base de données, cliquez sur l’icône Databricks .
  4. Pour l’étape Paramètres de connexion, entrez les informations suivantes sur votre entrepôt, votre catalogue et votre schéma :

    1. Pour Nom de la connexion, entrez un nom unique pour cette connexion.

    2. (Facultatif) Pour Connection group (Groupe de connexions), entrez le nom d’un groupe de connexions existant pour ajouter la nouvelle connexion à ce groupe. Vous pouvez également entrer un nom unique pour créer un nouveau groupe de connexions avec la nouvelle connexion. Les groupes de connexions permettent de trouver plus facilement les connexions dans l’extension.

    3. Pour Se connecter avec, sélectionnez l’une des options suivantes :

      • Pour utiliser un jeton d’accès personnel Azure Databricks pour l’authentification, sélectionnez Hostname and Token (Nom d’hôte et jeton).
      • Pour le pilote Databricks pour SQLTools versions 0.4.2 et ultérieures, pour utiliser l’authentification OAuth U2M ou M2M ou Azure CLI, sélectionnez Extension VS Code (bêta).

    4. Si vous avez sélectionné Hostname and Token (Nom d’hôte et jeton) pour Connect using (Se connecter avec), pour Host (Hôte), définissez le paramètre Server hostname (Nom d’hôte du serveur) de l’entrepôt. Pour obtenir le paramètre de Nom d’hôte du serveur d’un entrepôt, consultez Obtenir des détails de connexion pour une ressource de calcul Azure Databricks.

    5. Pour Chemin d’accès, entrez le paramètre de chemin HTTP de l’entrepôt ou du cluster. Pour obtenir le paramètre de Chemin d’accès HTTP d’un entrepôt, consultez Obtenir des détails de connexion pour une ressource de calcul Azure Databricks.

    6. Si vous avez sélectionné Nom d’hôte et jeton pour Se connecter avec, entrez la valeur de votre jeton d’accès personnel Azure Databricks dans Jeton.

    7. Pour Catalogue, entrez le nom de votre catalogue.

      Notes

      Pour les espaces de travail qui ne sont pas activés pour Unity Catalog, vous pouvez laisser Catalogue vide pour utiliser la valeur par défaut de hive_metastore.

    8. Pour Schéma, entrez le nom de votre schéma.

    9. (Facultatif) Pour Afficher la limite par défaut des enregistrements, laissez la valeur par défaut de 50 pour afficher uniquement jusqu’aux 50 premières lignes pour chaque requête, ou entrez une limite différente.

  5. Cliquez sur Tester la connexion.
  6. Si fois la connexion est correctement établie, cliquez sur Enregistrer la connexion.

Modifier les paramètres d’une connexion

Cette procédure suppose que vous vous êtes connecté à au moins un entrepôt.

  1. Si la vue SQLTools n’est pas visible, dans Visual Studio Code, dans la barre latérale, cliquez sur l’icône SQLTools .
  2. Dans le volet Connexions , développez le groupe de connexions, le cas échéant pour votre connexion cible.
  3. Cliquez avec le bouton droit sur la connexion, puis cliquez sur Modifier la connexion.
  4. Modifiez les paramètres de la cible.
  5. Cliquez sur Tester la connexion.
  6. Si fois la connexion est correctement établie, cliquez sur Enregistrer la connexion.

Parcourir les objets d’un schéma

  1. Dans le volet Connexions , développez le groupe de connexions, le cas échéant pour votre connexion cible.
  2. Double-cliquez ou développez la connexion cible pour votre entrepôt.
  3. Développez la base de données cible (schéma), le cas échéant pour votre connexion.
  4. Développez Tables ou Vues, si une ou plusieurs tables ou vues existent pour votre base de données (schéma).
  5. Développez une table ou une vue cible pour afficher les colonnes de la table ou de la vue.

Afficher les lignes ou le schéma d’une table ou d’une vue

Avec tables ou vues développées dans le volet Connexions, effectuez l’une des opérations suivantes :

  • Pour afficher les lignes de la table ou de la vue, cliquez avec le bouton droit sur la table ou la vue, puis cliquez sur Afficher les enregistrements de table ou Afficher les enregistrements d’affichage.
  • Pour afficher le schéma de la table ou de la vue, cliquez avec le bouton droit sur la table ou la vue, puis cliquez sur Décrire la table ou décrire la vue.

Générer une requête d’insertion pour une table

  1. Placez votre curseur dans un éditeur existant à l’emplacement où vous souhaitez ajouter la requête d’insertion.
  2. Avec Tables développées dans le volet Connexions , cliquez avec le bouton droit sur la table, puis cliquez sur Générer une requête d’insertion. La définition de la requête d’insertion est ajoutée au point d’insertion du curseur.

Créer et exécuter une requête

Cette procédure suppose que vous vous êtes connecté à au moins un entrepôt.

  1. Dans le volet Connexions , développez le groupe de connexions, le cas échéant pour votre connexion cible.
  2. Double-cliquez ou développez la connexion cible pour votre entrepôt.
  3. Une fois la connexion sélectionnée, cliquez sur Nouveau fichier SQL dans la barre de titre du volet Connexions . Un nouvel onglet éditeur s’affiche.
  4. Entrez votre requête SQL dans le nouvel éditeur.
  5. Pour exécuter la requête SQL, cliquez sur Exécuter sur la connexion active dans l’éditeur. Les résultats de la requête s’affichent dans un nouvel onglet éditeur.

Exécuter une requête existante

Cette procédure suppose que vous vous êtes connecté à au moins un entrepôt.

  1. Dans le volet Connexions , développez le groupe de connexions, le cas échéant pour votre connexion cible.
  2. Double-cliquez ou développez la connexion cible pour votre entrepôt.
  3. Une fois la connexion sélectionnée, ouvrez n’importe quel fichier avec l’extension de fichier de .sql, ou sélectionnez n’importe quel groupe d’instructions SQL continues dans un éditeur qui a été ouvert précédemment.
  4. Pour exécuter la requête SQL à partir d’un fichier ouvert .sql , avec le contenu de votre .sql fichier affiché dans l’éditeur, cliquez sur Exécuter sur la connexion active dans l’éditeur. Les résultats de la requête s’affichent dans un nouvel onglet éditeur.
  5. Pour exécuter un groupe sélectionné d’instructions SQL continues dans un éditeur précédemment ouvert, cliquez avec le bouton droit sur votre sélection, puis cliquez sur Exécuter la requête sélectionnée. Les résultats de la requête s’affichent dans un nouvel onglet éditeur.

Envoyer des journaux d’utilisation à Databricks

Si vous rencontrez des problèmes pendant l’utilisation de Databricks Driver pour SQLTools, vous pouvez envoyer les journaux d’utilisation et les informations connexes au support Databricks en procédant comme suit :

  1. Installez l’extension Databricks pour Visual Studio Code sur votre machine de développement locale.
  2. Activez la journalisation en définissant le paramètre Journaux : Activés ou le paramètre databricks.logs.enabled sur true, comme décrit dans Paramètres de l’extension Databricks pour Visual Studio Code. Assurez-vous de redémarrer Visual Studio Code après l’activation de a journalisation.
  3. Essayez de reproduire votre problème.
  4. À partir de la palette de commandes (Afficher > Palette de commandes dans le menu principal), exécutez la commande Databricks : Open full logs (Ouvrir les journaux complets).
  5. Envoyez les fichiers Databricks Logs.log, databricks-cli-logs.json et sdk-and-extension-logs.json qui sont visibles par le support Databricks.
  6. Copiez également le contenu du terminal (Afficher > Terminal) dans le contexte du problème et envoyez ce contenu à l’équipe du support Databricks.

La vue Sortie (Afficher > Sortie, journaux Databricks) affiche des informations tronquées concernant ces journaux d’utilisation si l’option Journaux : Activé est cochée ou si databricks.logs.enabled a la valeur true. Pour afficher plus d’informations, modifiez les paramètres suivants, comme décrit dans Paramètres de l’extension Databricks pour Visual Studio Code :

  • Journaux : Longueur maximale du tableau ou databricks.logs.maxArrayLength
  • Journaux : Longueur maximale du champ ou databricks.logs.maxFieldLength
  • Journaux : Profondeur de troncation ou databricks.logs.truncationDepth

Ressources supplémentaires