Aller au contenu principal
Dernière mise à jour le

Driver Databricks pour SQLTools pour Visual Studio Code

info

Aperçu

Cette fonctionnalité est en aperçu public.

Le Databricks Driver pour SQLTools vous permet d'utiliser l'extension SQLTools pour Visual Studio Code afin de parcourir les objets SQL et d'exécuter des requêtes SQL dans des workspaces Databricks distants.

Avant de commencer​

Avant de pouvoir utiliser le Databricks Driver pour SQLTools, votre Databricks Workspace et votre machine de développement locale doivent remplir les conditions suivantes.

Exigences du workspace​

Vous devez avoir au moins un workspace Databricks disponible, et le workspace doit satisfaire aux exigences suivantes :

  • Le Workspace doit contenir au moins un Databricks SQL Warehouse.
remarque

Les clusters Databricks ne sont pas pris en charge par le Driver Databricks pour SQLTools.

Exigences de la machine de développement local​

Vous devez avoir les éléments suivants sur votre machine de développement locale :

  • 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 sous Linux ou macOS et sur **Aide > À propos** sous Windows. Pour download, installer et configurer Visual Studio Code, consultez Configuration de Visual Studio Code.
  • L'extension SQLTools pour Visual Studio Code.
  • L'extension Databricks Driver for SQLTools pour Visual Studio Code.

Pour installer l’extension SQLTools, rendez-vous sur 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 la marketplace,SQLTools saisissez.

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

remarque

Il peut y avoir plusieurs entrées **SQLTools** répertoriées. Assurez-vous de cliquer sur l'entrée de Matheus Teixeira .

  1. Cliquez sur Installer .

Pour installer le Databricks Driver pour l'extension SQLTools, rendez-vous sur Databricks Driver 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 la marketplace,Databricks Driver for SQLTools saisissez.
  3. Cliquez sur l'entrée Databricks Driver pour SQLTools .
  4. Cliquez sur Installer .

Authentification​

Vous devez configurer l'authentification pour le Driver Databricks pour SQLTools comme suit.

Le Driver Databricks pour SQLTools prend en charge les types d'authentification Databricks suivants :

Authentification par jeton d'accès personnel Databricks​

Pour utiliser le Driver Databricks pour SQLTools avec l'authentification par jeton d'accès personnel Databricks, vous devez disposer d'un jeton d'accès personnel Databricks. Pour créer un jeton d'accès personnel, suivez les étapes de Créer des jetons d'accès personnels pour les utilisateurs de Workspace.

Authentification Databricks OAuth machine à machine (M2M)​

Vous pouvez utiliser l'authentification OAuth machine-to-machine (M2M) Databricks pour vous authentifier auprès du Driver Databricks pour SQLTools, comme suit :

remarque

L'authentification Databricks OAuth M2M est disponible dans le Databricks Driver pour SQLTools versions 0.4.2 et supérieures.

  1. Terminez les étapes de configuration pour l'authentification OAuth M2M. Consultez l'authentification OAuth machine-to-machine (M2M).
  2. Créez un profil de configuration Databricks avec vos paramètres de configuration d'authentification OAuth M2M. Consultez la section « Config » de l'authentification OAuth machine-to-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 **Configurer** dans le volet **Configuration**. Si le bouton **Configurer** n'est pas affiché, cliquez plutôt sur l'icône d'engrenage (**Configurer le Workspace**).
  5. Dans la **palette de commandes**, pour **Databricks Host**, entrez votre Databricks URL de l'instance de workspace, par https://dbc-a1b2345c-d6e7.cloud.databricks.com exemple, puis appuyez sur **Entrée**.
  6. Sélectionnez l'entrée de profil de configuration qui correspond à celle que vous avez créée à l'étape 2.
  7. Complétez les instructions à l'écran dans votre navigateur web pour terminer l'authentification avec votre compte Databricks.

Authentification utilisateur-à-machine (U2M) Databricks OAuth​

Vous pouvez utiliser l'authentification Databricks OAuth user-to-machine (U2M) pour vous authentifier auprès du Driver Databricks pour SQLTools, comme suit :

remarque

L'authentification Databricks OAuth U2M est disponible dans Databricks Driver pour SQLTools versions 0.4.2 et supé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 **Configurer** dans le volet **Configuration**. Si le bouton **Configurer** n'est pas affiché, cliquez plutôt sur l'icône d'engrenage (**Configurer le Workspace**).
  3. Dans la **palette de commandes**, pour l'**hôte Databricks**, entrez l'URL de votre instance de workspace Databricks, par https://dbc-a1b2345c-d6e7.cloud.databricks.com exemple. Ensuite, 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 Databricks. Si vous y êtes invité, autorisez l'accès à all-apis.

Se connecter à un schéma​

  1. Dans Visual Studio Code, dans la barre latérale, cliquez sur l'icône SQLTools .

  2. Dans la vue SQLTools , si c'est la première fois que vous utilisez l'extension SQLTools, cliquez sur Ajouter une nouvelle connexion dans le volet Connexions . Sinon, cliquez sur l'icône **Ajouter une nouvelle connexion** dans la barre de titre du volet.

  3. Dans la **SQLTools Settings** tab, pour l'étape **Sélectionner un Driver de base de données**, cliquez sur l'icône **Databricks**.

  4. Pour l'étape Paramètres de connexion , saisissez les informations suivantes concernant votre warehouse, votre catalogue et votre schéma :

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

    2. (Facultatif) Pour Groupe de connexion , saisissez le nom d'un groupe de connexions existant afin d'ajouter la nouvelle connexion à ce groupe. Ou, saisissez un nom unique pour créer un nouveau groupe de connexions avec la nouvelle connexion. Les groupes de connexions facilitent la recherche de connexions dans l'extension.

    3. Pour **Se connecter à l’aide de**, sélectionnez l’une des options suivantes :

      • Pour utiliser un jeton d'accès personnel Databricks pour l'authentification, sélectionnez Hostname et Jeton .
      • Pour Databricks Driver pour SQLTools versions 0.4.2 et ultérieures, afin d'utiliser l'authentification OAuth U2M ou M2M, sélectionnez l' extension VS Code (bêta) .

    4. Si vous avez sélectionné Hostname et Jeton pour Connexion via , alors pour Hôte , saisissez le paramètre Server Hostname du warehouse. Pour obtenir le paramètre Hostname du serveur d'un warehouse, consultez Obtenir les détails de connexion pour une ressource de compute Databricks.

    5. Pour **Chemin**, saisissez le paramètre **Chemin HTTP** du warehouse ou du cluster. Pour obtenir le paramètre HTTP path d'un warehouse, consultez Obtenir les détails de connexion pour une ressource de compute Databricks.

    6. Si vous avez sélectionné Hostname and Token pour Connect using , saisissez la valeur de votre jeton d'accès personnel Databricks dans Token .

    7. Pour le **Catalogue**, saisissez le nom de votre catalogue.

remarque

Pour les Workspaces qui ne sont pas activés pour Unity Catalog, vous pouvez laisser **Catalogue** vide pour utiliser la valeur par default hive_metastore de.

  1. Pour Schema , saisissez le nom de votre schéma.

  2. (Facultatif) Pour **Afficher la limite par default des enregistrements**, laissez la valeur par default de 50 pour afficher uniquement les 50 premières lignes pour chaque query, ou saisissez une limite différente.

  3. Cliquez sur Test de la connexion .

  4. Si le test de connexion réussit, cliquez sur Enregistrer la connexion .

Modifier les paramètres d'une connexion​

Cette procédure suppose que vous vous êtes connecté avec succès à au moins un warehouse.

  1. Si la vue SQLTools n'est pas visible, alors dans Visual Studio Code, sur la barre latérale, cliquez sur l'icône SQLTools .
  2. Dans le volet **Connexions**, développez le groupe de connexions, s'il en existe un pour votre connexion cible.
  3. Faites un clic droit sur la connexion, puis cliquez sur Modifier la connexion .
  4. Modifiez les paramètres de la cible.
  5. Cliquez sur Test de la connexion .
  6. Si le test de connexion réussit, cliquez sur Enregistrer la connexion .

Parcourir les objets d'un schéma​

  1. Dans le volet **Connexions**, développez le groupe de connexions, s'il en existe un pour votre connexion cible.
  2. Double-cliquez ou développez la connexion cible de votre warehouse.
  3. Développez la base de données cible (schéma), si elle existe 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 n'importe quelle table ou 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 les Tables ou les 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 la table ou Afficher les enregistrements de la vue .
  • 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érez une query d'insertion pour une table​

  1. Placez votre curseur dans un éditeur existant à l'emplacement où vous voulez que la query d'insertion soit ajoutée.
  2. Avec les **Tables** développées dans le volet **Connexions**, cliquez avec le bouton droit sur la table, puis cliquez sur **Générer une insert query**. La définition de la query d'insertion est ajoutée au point d'insertion du curseur.

Créer et exécuter une query​

Cette procédure suppose que vous vous êtes connecté avec succès à au moins un warehouse.

  1. Dans le volet **Connexions**, développez le groupe de connexions, s'il en existe un pour votre connexion cible.
  2. Double-cliquez ou développez la connexion cible de votre warehouse.
  3. Une fois la connexion sélectionnée, cliquez sur Nouveau fichier SQL dans la barre de titre du volet Connexions . Un nouvel onglet tab apparaît.
  4. Saisissez votre requête SQL dans le nouvel éditeur.
  5. Pour exécuter la query SQL, cliquez sur Exécuter sur la connexion active dans l'éditeur. Les résultats de la query s'affichent dans un nouveau tab d'éditeur.

Exécuter une query existante​

Cette procédure suppose que vous vous êtes connecté avec succès à au moins un warehouse.

  1. Dans le volet **Connexions**, développez le groupe de connexions, s'il en existe un pour votre connexion cible.
  2. Double-cliquez ou développez la connexion cible de votre warehouse.
  3. Une fois la connexion sélectionnée, ouvrez n'importe quel fichier avec l'extension de fichier .sql, ou sélectionnez n'importe quel groupe d'instructions SQL continues dans n'importe quel éditeur qui a été précédemment ouvert.
  4. Pour exécuter la query SQL à partir d'un .sql fichier ouvert, avec le .sql contenu de votre fichier affiché dans l'éditeur, cliquez sur **Exécuter sur la connexion active** dans l'éditeur. Les résultats de la query s'affichent dans un nouveau tab d'éditeur.
  5. Pour exécuter un groupe sélectionné d'instructions SQL continues dans un éditeur précédemment ouvert, faites un clic droit sur votre sélection, puis cliquez sur **Exécuter la query sélectionnée**. Les résultats de la query s'affichent dans un nouveau tab d'éditeur.

Envoyer les Logs d'utilisation à Databricks​

Si vous rencontrez des problèmes lors de l'utilisation du Driver Databricks pour SQLTools, vous pouvez envoyer les Logs d'utilisation et les information associées à l'assistance Databricks en procédant comme suit :

  1. Installez l'extension Databricks pour Visual Studio Code sur votre ordinateur de développement.
  2. Activez la journalisation en cochant le paramètre Logs : Activé , ou en définissant 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 avoir activé la journalisation.
  3. Tentez de reproduire votre problème.
  4. Depuis la **Palette de commandes** (**Afficher > Palette de commandes** depuis le menu principal), exécutez la commande **Databricks : Ouvrir les logs complets**.
  5. Envoyez les fichiers Databricks Logs.log, databricks-cli-logs.json et sdk-and-extension-logs.json qui apparaissent au support Databricks.
  6. Copiez également le contenu du Terminal ( Afficher > Terminal ) dans le contexte du problème, et envoyez ce contenu au support Databricks.

La vue Sortie ( Afficher > Sortie, Logs Databricks ) affiche des informations tronquées si Logs : Activé est coché ou si databricks.logs.enabled est défini sur 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:

  • **Logs : Longueur maximale de tableau** ou databricks.logs.maxArrayLength
  • **Logs : Longueur maximale du champ** ou databricks.logs.maxFieldLength
  • **Logs : profondeur de troncation** ou databricks.logs.truncationDepth

Ressources supplémentaires​

Sur cette page