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. L’extension s’intègre également à Python Snowpark pour fournir des fonctions de débogage, de coloration syntaxique et de saisie semi-automatique pour SQL dans le code Python.

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 :

Ouvrez Code Visual Studio.
Sélectionnez Code » Preferences » Extensions.

Vous pouvez également sélectionner View » Extensions ou cliquer sur le bouton des extensions dans la barre d’activité VS Code.
Dans la zone de texte Search Extensions entrez le texte Snowflake pour rechercher l’extension Visual Studio Snowflake.
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 :

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.
Ouvrez Code Visual Studio.
Sélectionnez Code » Preferences » Extensions.

Vous pouvez également sélectionner View » Extensions ou cliquer sur le bouton des extensions dans la barre d’activité.
Sélectionnez Install from VSIX dans le menu plus(…).

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.

Connexion¶

Avant de pouvoir exécuter des instructions SQL ou utiliser les fonctions Python Snowpark, 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 :

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.
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.

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 de Snowflake Extension for Visual Studio Code avec des fichiers de configuration SnowSQL¶

Le Snowflake Extension for Visual Studio Code peut utiliser les fichiers de configuration Snow SQL pour charger les configurations de connexion.

Note

Seules les valeurs de configuration de la connexion sont utilisées. Les autres valeurs de configuration SnowSQL sont ignorées.

Pour configurer Snowflake Extension for Visual Studio Code afin qu’il utilise un fichier de configuration Snow SQL, procédez comme suit :

Dans Activity Bar, sélectionnez 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.
Sélectionnez la liste déroulante Username, puis sélectionnez Sign in to another account.
Sélectionnez Use SnowSQL Config. La page de configuration du code Visual Studio pour Snowflake Extension for Visual Studio Code s’ouvre avec le SnowSQL Config Path sélectionné.
Saisissez le chemin d’accès à un fichier de configuration SnowSQL valide.

La liste déroulante des comptes est mise à jour pour inclure toutes les connexions définies dans le fichier de configuration spécifié.

Accès à l’interface Snowflake Extension for Visual Studio Code¶

L”Snowflake Extension for Visual Studio Code comporte les sections principales suivantes :

Panneau latéral (1) : le panneau le plus à gauche est le panneau du compte, de l’exploration de la base de données et de l’historique des requêtes.

Utilisez ce panneau pour spécifier les détails du compte, examiner les objets de la base de données et les résultats des requêtes.
Le panneau SQL Snowflake (2) : le panneau SQL Snowflake affiche les fichiers SQL Snowflake.
Panneau des résultats des requêtes (3) : le panneau des résultats des requêtes affiche les résultats des requêtes.

Sélectionnez une requête dans Side Bar » Query History pour afficher le résultat de son exécution (panneau 4).
Section Historique des requêtes de Side Bar (4) : l’historique des requêtes affiche les requêtes récentes.
Session actuelle (5) : informations sur la session actuelle, y compris le rôle actuel, la base de données, le schéma et l’entrepôt actif.
Icône Snowflake (non numérotée) - Sélectionnez l’icône Snowflake pour afficher ou masquer le panneau Side Bar.

Extension SQL Snowflake en cours d'utilisation montrant ses principales sections : le panneau de barre latérale, le panneau SQL et le panneau de résultats de la requête.

Utilisation de 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 :

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. Vous pouvez également cliquer sur le bouton () dans le panneau de l’explorateur de base de données pour créer un nouveau fichier SQL.
Ajoutez une ou plusieurs instructions SQL Snowflake au fichier.
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 :

Sélectionnez le du fichier SQL sélectionné pour exécuter toutes les instructions de ce fichier.
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.
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 + [entrée] sur un clavier Mac ou + [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 sélectionnez le bouton d’annulation de la requête ().

Utilisation de l’historique des requêtes¶

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

Pour examiner les résultats d’une requête précédemment exécutée, procédez comme suit :

Développez Query History.
Sélectionnez une instruction.
Examinez le résultat dans l’onglet SNOWFLAKE:QUERY RESULTS du panneau Output.

Astuce

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

Utilisation des résultats d’une requête¶

Vous pouvez trier, réorganiser, masquer, geler ou enregistrer les résultats de la requête sur le disque.

Pour modifier l’affichage d’une requête donnée, procédez comme suit :

Dans QUERY HISTORY, sélectionnez une requête.
Dans QUERY RESULTS, choisissez une colonne.
Sélectionnez la flèche vers le bas (↓), puis l’une des options suivantes : SORT A-Z (descendant), Sort Z-A (ascendant), Hide column « column name » ou Freeze columns up to « column name ».

L’affichage du contenu sera modifié en conséquence.

Astuce

Si une colonne était précédemment masquée, choisissez n’importe quelle autre colonne et sélectionnez Unhide N columns.

Pour enregistrer les résultats d’une requête sur le disque, sélectionnez le disque () ou le téléchargement () associé à la requête. Le contenu sera enregistré dans un fichier, soit sous forme de fichier compressé gzip, soit sous forme de fichier séparé par des virgules.

Utilisation du code Python Snowpark¶

Vous pouvez utiliser Snowflake Extension for Visual Studio Code pour écrire et déboguer des instructions SQL Snowflake dans le code Python Snowpark.

Débogage des fonctions Python Snowpark¶

Pour déboguer une fonction Python Snowpark :

Écrivez une procédure stockée Snowflake dans une fonction Python dans laquelle le premier paramètre est un objet Session Snowpark.
Vous devriez voir apparaître une option Snowflake: Debug en ligne au-dessus du nom de la fonction. Sélectionnez cette option pour exécuter la procédure stockée dans la fonction, en utilisant votre session active en cours via l’extension. Vous pouvez également définir des points d’arrêt de débogage.

Coloration syntaxique et saisie semi-automatique pour SQL en Python¶

Vous pouvez ajouter la coloration syntaxique de SQL dans le code Python en activant la détection automatique ou en utilisant des commentaires pour indiquer manuellement les chaînes SQL.

Détection automatique des instructions SQL¶

Pour configurer la coloration syntaxique SQL automatique, activez le paramètre d’extension Auto Detect Sql in Python. L’extension détecte automatiquement les instructions SQL en recherchant un mot-clé SQL tout en majuscules comme premier mot d’une chaîne Python, comme le montre la capture d’écran suivante.

Extrait de code d'une instruction SQL Snowflake dans une chaîne Python montrant la coloration syntaxique SQL automatique.

Indication manuelle des instructions SQL¶

Pour indiquer manuellement une instruction SQL dans une chaîne Python :

(Facultatif) Désactivez le paramètre d’extension Auto Detect Sql in Python.
Utilisez des commentaires pour indiquer le début et la fin d’une instruction SQL. Vous pouvez utiliser n’importe quelle combinaison des marqueurs suivants :
- Marqueurs de début : -–startsql, -–beginsql, -–start-sql, -–begin-sql
- Marqueurs de fin : –-endsql, –-end-sql

Par exemple, la capture d’écran suivante montre un code qui utilise --begin-sql et --end-sql pour indiquer manuellement une instruction SQL.

Extrait de code d'une instruction SQL Snowflake dans une chaîne Python utilisant des commentaires pour activer manuellement la coloration syntaxique SQL.

Utilisation de la saisie semi-automatique SQL dans des chaînes Python¶

Pour utiliser la saisie semi-automatique des instructions SQL dans des chaînes Python :

Dans un fichier Python, créez une chaîne Python alors que vous êtes connecté(e) à une session Snowflake active via l’extension.
Commencez à saisir une instruction SQL et voyez les suggestions de saisie semi-automatique qui apparaissent.

Par exemple, lorsque vous commencez à saisir une instruction telle que SELECT * FROM db1.public, l’extension suggère automatiquement des noms de table.

De même, lorsque vous commencez à remplir des colonnes à l’intérieur d’une instruction SELECT qui fait référence à une table, l’extension suggère automatiquement des noms de colonne, comme le montre la capture d’écran suivante.

Extrait de code d'une instruction SQL Snowflake dans une chaîne Python montrant des suggestions de saisie semi-automatique pour des noms de colonne.

Coloration syntaxique des modèles Jinja¶

Par défaut, l’extension ajoute une coloration syntaxique de base et une saisie semi-automatique entre parenthèses pour l’écriture des modèles Jinja dans SQL Snowflake, comme le montre la capture d’écran suivante.

Extrait de code d'une instruction SQL Snowflake avec un modèle Jinja montrant la coloration syntaxique et la saisie semi-automatique entre parenthèses.

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.

Astuce

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

Connectez-vous à un compte ou passer d'un compte à un autre.

Navigation avec l’explorateur de bases de données¶

Utilisez la section DATABASE EXPLORER du panneau Side Bar pour examiner et afficher les caractéristiques des objets de la base de données.

Pour examiner un objet de base de données, procédez comme suit :

Connectez-vous à un compte.
Développez la section DATABASE EXPLORER du panneau Sidebar.
Sélectionnez une base de données et développez-la.
Sélectionnez un schéma et développez-le.
Naviguez vers un composant enfant.
Sélectionnez un élément pour voir ses caractéristiques dans l’onglet SNOWFLAKE:OBJECT DETAILS du panneau Output.

Astuce

Utilisez le bouton de visualisation des détails de l’objet () pour afficher les détails de l’objet associé. . Utilisez le bouton de visualisation de l’objet DML () pour afficher le DML utilisé pour créer l’objet.

Lors de l’examen des détails associés à une table, une vue, une vue matérialisée ou un objet similaire, sélectionnez l’aperçu () pour afficher un aperçu d’un maximum de 100 lignes de contenu.

Utilisation des zones de préparation¶

Le Snowflake Extension for Visual Studio Code permet de gérer le contenu de la zone de préparation directement dans l’explorateur de base de données. Vous pouvez :

Listez tous les fichiers d’une zone de préparation :

Naviguez vers une zone de préparation spécifique.

Développez la zone de préparation pour voir tous les fichiers en zone de préparation.

Téléchargement de fichiers du système de fichiers local vers une zone de préparation, similaire à PUT :

Naviguez jusqu’à la zone de préparation et sélectionnez Charger ().

Saisissez tout paramètre facultatif pour l’opération de chargement. Référez-vous à PUT pour obtenir la liste des paramètres optionnels.

Naviguez jusqu’au dossier contenant les fichiers à charger, sélectionnez un ou plusieurs fichiers et chargez-les.

Téléchargez des fichiers d’une zone de préparation vers un système de fichiers local, comme GET :

Accédez à la zone de préparation.

Sélectionnez Télécharger () sur la zone de préparation pour télécharger tous les fichiers, ou développez la zone de préparation.

Sélectionnez un fichier et téléchargez-le.

Sélectionnez un répertoire pour terminer le téléchargement.

Supprimez les fichiers d’une zone de préparation, comme REMOVE :

Sélectionnez un fichier.

Sélectionnez le bouton de suppression associé ().

Note

Le Snowflake Extension for Visual Studio Code ne prend en charge que le téléchargement pour les zones de préparation internes, toutes les autres opérations fonctionnent pour les zones de préparation internes et externes.

Affichage des 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 :

Sélectionnez Code » Preferences » Extensions.
Sélectionnez l’extension SQL Snowflake VS Code.

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

Affichage du journal des modifications¶

Pour afficher le journal des modifications de l’extension, vous pouvez également utiliser la commande Show Change Log :

Ouvrez Command Palette en appuyant sur CMD+Maj+P sur un clavier Mac, ou sur CTRL+Maj+P sur un clavier Windows.
Saisissez la commande suivante :
```
Show Change Log
```
Copy

Paramètres de l’extension¶

Le Snowflake Extension for Visual Studio Code prend en charge les paramètres suivants :

Réglage	Description	Par défaut
Exporter CSV » Délimiteur	Spécifie le délimiteur pour les colonnes	Virgule
Exporter CSV » En-tête	Permettre l’inclusion de la ligne d’en-tête dans le fichier CSV exporté	Activé
Exporter CSV » Inclure les lignes vides	Permettre l’inclusion des lignes vides dans le fichier CSV exporté	Exclure
Exporter CSV » Guillemets	Activer les guillemets doubles autour de toutes les valeurs dans le fichier exporté CSV	Activé
Mettre en évidence la requête	Activer la mise en évidence de l’arrière-plan de l’instruction SQL active	Activé
Afficher Exécuter au-dessus de l’instruction	Activer une action d’exécution cliquable au-dessus de chaque instruction	Activé
Chemin de configuration de Snowsql	Si cette option est activée, la configuration de la connexion sera chargée à partir de ce fichier.	Non défini
Saisie semi-automatique des détails de l’objet	Affichage des détails d’un objet Snowflake après que vous avez sélectionné son entrée par saisie semi-automatique	Désactivé
Activation du maintien en ligne de la session du client	Indique si la session doit rester active indéfiniment tant que la connexion est active, quelle que soit l’activité. Si cette option n’est pas activée, vous devez vous reconnecter au bout de quatre heures d’inactivité.	Activé
Saisie semi-automatique des clés de variante	Affichage des suggestions par saisie semi-automatique des clés OBJECT/VARIANT.	Désactivé
Explorateur d’objets : Recherche	Activation de la recherche dans l’explorateur d’objets	Activé
Historique des requêtes : Limite du nombre d’éléments	Spécifie le nombre maximal de requêtes affichées dans l’historique. L’affichage d’un plus grand nombre de requêtes peut affecter les performances.	1000

Paramètres d’extension en avant-première¶

Les paramètres d’extension suivants sont actuellement disponibles en avant-première :

Réglage	Description	Par défaut
Coloration syntaxique : Détection automatique du SQL dans Python	Activation de la coloration syntaxique automatique des instructions SQL dans des chaînes Python	Activé
Activation des fonctions en avant-première publique	Activation des fonctions en avant-première publique pour l’extension	Désactivé

Modification des paramètres d’extension¶

Pour modifier les paramètres de l’extension :

Sous Windows/Linux, sélectionnez File » Preferences » Settings. . Sur macOS, sélectionnez Code » Preferences » Settings.
Dans la zone de texte Search settings, entrez Snowflake.
Sélectionnez les onglets User ou Workspace pour afficher ou modifier les paramètres spécifiques à l’utilisateur ou à l’espace de travail.
Fermez l’onglet Settings.

Désinstallation de l’extension¶

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

Sélectionnez Code » Preferences » Extensions
Sélectionnez l’extension.
Faites un clic droit et choisissez Disable ou Uninstall.