Snowflake Extension for Visual Studio Code

Snowflake fournit une extension pour Visual Studio Code (VS Code) afin de permettre aux utilisateurs de Snowflake d’écrire et d’exécuter des instructions SQL Snowflake directement dans VS Code. Les extensions sont des fonctionnalités pré-empaquetées, souvent fournies par des tiers, qui ajoutent de nouvelles caractéristiques et fonctionnalités à VS Code.

Dans ce chapitre :

Installation de l”Snowflake Extension for Visual Studio Code

Les utilisateurs de Snowflake peuvent installer l’extension VS Code directement à partir de la marketplace Visual Studio ou télécharger l’extension, empaquetée en tant que fichier .xsix, puis l’installer.

Installation à partir de la marketplace Visual Studio

Pour effectuer une installation directement à partir de la marketplace Visual Studio, procédez comme suit :

  1. Ouvrez Code Visual Studio.

  2. Sélectionnez Code » Preferences » Extensions.

    Vous pouvez également sélectionner View » Extensions ou cliquer sur le bouton des extensions vsc-extensions-button dans la barre d’activité VS Code.

  3. Dans la zone de texte Search Extensions entrez le texte Snowflake pour rechercher l’extension Visual Studio Snowflake.

  4. Dans l’ensemble des extensions, sélectionnez l’extension créée par Snowflake et cliquez sur Install.

Installation à partir d’un fichier .vsix

Pour un téléchargement et une installation à partir d’un fichier .vsix, procédez comme suit :

  1. Téléchargez l’extension.

    1. Ouvrez la page Extension Snowflake Visual Studio Code.

    2. Sélectionnez l’onglet Version History.

    3. Sélectionnez une version à télécharger et cliquez sur Download. Notez l’emplacement de téléchargement du fichier.

  2. Ouvrez Code Visual Studio.

  3. Sélectionnez Code » Preferences » Extensions.

    Vous pouvez également sélectionner View » Extensions ou cliquer sur le bouton des extensions vsc-extensions-button dans la barre d’activité.

  4. Sélectionnez Install from VSIX dans le menu plus(…).

    In the Extensions page, select more and then Install from VSIX file.
  5. Localisez le fichier snowflake-x.y.z.vsix sur votre ordinateur, sélectionnez le fichier, puis sélectionnez Install.

Une fois l’installation terminée, l”Snowflake Extension for Visual Studio Code apparaît dans la section INSTALLED du menu Extensions dans VS Code.

The Snowflake SQL extension, after being installed in Visual Studio Code.

Connexion

Avant de pouvoir exécuter des instructions SQL, vous devez vous connecter à un compte Snowflake.

Vous pouvez vous connecter à Snowflake en utilisant votre identificateur de compte Snowflake, votre nom d’utilisateur et votre mot de passe, ou en utilisant l’authentification fédérée à Snowflake avec SSO SAML.

La première fois que vous vous connectez à Snowflake à partir de l’extension VS Code, vous devez ajouter votre compte en saisissant l’identificateur de votre compte Snowflake ou l’URL que vous utilisez pour vous connecter à Snowflake.

Voir Identificateurs de compte pour plus de détails sur la façon de déterminer votre identificateur de compte.

Pour se connecter à Snowflake à partir de l’extension VS Code, procédez comme suit :

  1. Dans la Activity Bar, cliquez sur l’icône Snowflake.

    Le panneau de la barre latérale passe à la navigation Snowflake et affiche les boîtes de dialogue Add Account ou Sign in.

  2. Sous Add Account, entrez l’identificateur du compte et sélectionnez Continue.

    Add Account n’est affiché que si aucun compte n’a été spécifié auparavant.

    The Snowflake select account dialog.
  3. Entrez un nom d’utilisateur et un mot de passe pour le compte sélectionné et sélectionnez Sign in.

Une fois la connexion réussie, la barre latérale change pour afficher le contexte de la session (ACCOUNT), DATABASE EXPLORER pour l’utilisateur dans son rôle par défaut, et QUERY HISTORY.

Utilisation des fichiers SQL

Vous pouvez utiliser l”Snowflake Extension for Visual Studio Code pour créer et charger des fichiers SQL. Les fichiers SQL sont de simples fichiers texte qui contiennent une ou plusieurs instructions SQL.

Ouverture de fichiers SQL

Pour créer ou ouvrir des fichiers SQL Snowflake, procédez comme suit :

  1. Sélectionnez File » Open, naviguez vers un fichier texte contenant du SQL et ouvrez-le.

    Si vous n’avez pas de fichier SQL existant, vous pouvez en créer un nouveau. Sélectionnez File » New File et créez un fichier de type Snowflake SQL File.

    Alternatively, click the (vsc-new-sql-file-button) button in the Database explorer panel to create a new SQL file.

    The Snowflake SQL extension database explorer panel with new SQL file button highlighted.
  2. Ajoutez une ou plusieurs instructions SQL Snowflake au fichier.

  3. Sélectionnez une ligne et appuyez sur [Exécuter], au-dessus de la ligne, pour exécuter la commande.

Exécution de commandes ou de requêtes

Pour exécuter une ou plusieurs commandes ou requêtes, procédez comme suit :

  1. Sélectionnez le vsc-execute-all-button du fichier SQL sélectionné pour exécuter toutes les instructions de ce fichier.

  2. Sélectionnez une ligne à exécuter en plaçant votre curseur sur l’instruction à exécuter.

    Sélectionnez deux ou plusieurs commandes - Toutes les commandes sélectionnées seront exécutées.

  3. Appuyez sur le bouton [Exécuter] au-dessus de la première commande sélectionnée.

Si vous sélectionnez plusieurs commandes, les commandes s’exécutent dans l’ordre, de haut en bas.

Vous pouvez également exécuter des instructions en utilisant des raccourcis clavier. Après avoir sélectionné les instructions SQL que vous voulez exécuter, appuyez sur Apple OSX Command key. + [entrée] sur un clavier Mac ou Generic control key. + [entrée] sur un clavier Windows.

Vous pouvez voir les résultats de l’instruction SQL dans le tableau SNOWFLAKE:QUERY RESULTS de la section Output.

Astuce

Les requêtes en cours peuvent être annulées. Pour annuler une requête en cours, recherchez la requête dans QUERY HISTORY et appuyez sur la requête d’annulation (vsc-cancel-query-button).

Utilisation de l’historique des requêtes

Un suivi des résultats des requêtes est disponible dans QUERY HISTORY.

Pour afficher les résultats de la requête, procédez comme suit :

  1. Développez Query History.

  2. Sélectionnez une instruction.

  3. Examinez le résultat dans l’onglet SNOWFLAKE:QUERY RESULTS du panneau Output.

Example of executing a statement with result highlighted.

Astuce

Vous pouvez utiliser l”Query History pour réexécuter une requête (vsc-query-rerun-button), copier le texte d’une requête dans le presse-papiers (vsc-query-copy-button) ou supprimer une requête (vsc-query-delete-button).

Modification du contexte de la session

Vous pouvez utiliser la section Account du panneau Side Bar pour sélectionner des rôles, des bases de données, des schémas et des entrepôts. Utilisez la liste déroulante associée pour sélectionner chacun d’entre eux comme il convient.

The Snowflake sign in dialog.

Astuce

Utilisez la liste déroulante des comptes pour vous connecter à un compte ou passer d’un compte à l’autre.

Sign in to, or switch between accounts.

Voir les détails de l’extension

Vous pouvez consulter les informations sur l’extension Snowflake SQL Visual Studio Code à tout moment.

Vous pouvez voir les détails suivants sur l’extension, notamment :

  • Informations sur la version : quelle version de l’extension est actuellement installée.

  • Journal des modifications : informations par version sur les fonctionnalités ajoutées, modifiées ou mises à jour.

  • Visite guidée des fonctionnalités.

En outre, vous pouvez désactiver ou activer l’extension à l’aide de la liste déroulante d’activation/de désactivation.

Pour afficher les informations sur les extensions, procédez comme suit :

  1. Sélectionnez Code » Preferences » Extensions.

  2. Sélectionnez l’extension SQL Snowflake VS Code.

    Vous pouvez également sélectionner View » Extensions ou cliquer sur le bouton des extensions vsc-extensions-button dans la barre Activities.

Désinstallation de l’extension

Pour désactiver ou désinstaller l’extension, procédez comme suit :

  1. Sélectionnez Code » Preferences » Extensions

  2. Sélectionnez l’extension.

  3. Faites un clic droit et choisissez Disable ou Uninstall.