Snowflake Extension for Visual Studio Code¶

Ouverture ou création de fichiers SQL¶

1. Dans Code VS, sélectionnez File > Open, recherchez l’emplacement d’un fichier SQL, puis ouvrez-le.

   Pour créer un nouveau fichier SQL, sélectionnez File > New File et créez un fichier de type Snowflake SQL File.

2. Ajoutez une ou plusieurs instructions SQL Snowflake au fichier.

3. En option. Sélectionnez Snowflake: Execute All Statements () pour exécuter une commande.

Exécution de commandes ou de requêtes¶

Dans VS Code, sélectionnez l’une des options suivantes :

• Pour exécuter toutes les instructions SQL d’un fichier, sélectionnez Snowflake: Execute All Statements ().

• Pour exécuter une commande spécifique, placez votre curseur sur l’instruction que vous souhaitez exécuter, puis sélectionnez Execute.

• Pour exécuter plusieurs commandes, sélectionnez les instructions que vous souhaitez exécuter, puis sélectionnez Execute. Les commandes s’exécutent dans l’ordre, de haut en bas.

Pour utiliser des raccourcis clavier pour exécuter des instructions, sélectionnez les instructions SQL que vous voulez exécuter, appuyez sur + [entrée] sur un clavier Mac ou + [entrée] sur un clavier Windows.

Les résultats de l’instruction SQL exécutée s’affichent dans le volet SNOWFLAKE.

Pour annuler des requêtes en cours, sélectionnez une requête dans la liste QUERY HISTORY et sélectionnez Cancel query ().

Afficher l’historique des requêtes¶

1. Dans VS Code, développez Query History.

2. Sélectionnez une instruction.

3. Examinez les résultats dans le volet SNOWFLAKE.

4. En option. Sélectionnez l’un des éléments suivants :

   • Sélectionnez Snowflake: Copy to Clipboard () pour copier le texte de la requête dans le presse-papiers.

   • Sélectionnez Snowflake: Remove Query () pour 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.

1. Dans QUERY HISTORY, sélectionnez une requête.

2. Dans le volet SNOWFLAKE, choisissez une colonne.

3. Sélectionnez la flèche d’extension (↓) puis l’un des éléments suivants : Sort Ascending, Sort Descending, Hide column « column name » ou Freeze columns up to « column name ».

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

4. En option. Sélectionnez l’un des éléments suivants :

   • Sélectionnez Cloud () pour enregistrer les résultats sous forme de fichier gzip compressé.

   • Sélectionnez Save () pour enregistrer les résultats dans un fichier à valeurs séparées par des virgules (CSV).

Débogage des fonctions Python Snowpark¶

1. Écrivez une procédure stockée Snowflake dans une fonction Python dans laquelle le premier paramètre est un objet Session Snowpark.

2. Une option Snowflake: Debug en ligne apparaît 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.

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 l’image suivante.

Indication manuelle des instructions SQL¶

1. En option. Désactivez le paramètre d’extension Auto Detect Sql in Python.

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

   L’image suivante montre comment les marqueurs --begin-sql et --end-sql indiquent manuellement une instruction SQL.

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

1. Dans un fichier Python, créez une chaîne Python alors que vous êtes connecté(e) à une session Snowflake active avec l’extension VS Code.

2. Écrivez une instruction SQL. Les suggestions par saisie semi-automatique 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 l’image suivante.

Coloration syntaxique des modèles Jinja¶

Par défaut, l’extension VS Code 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 l’image suivante.

Voir la palette de commandes Snowflake Native App de l’extension VS Code¶

La palette de commandes Snowflake Native App de l’extension VS Code donne accès aux commandes Snowflake Native App suivantes :

• Créer une Native App

• Déployer une Native App

• Se centrer sur une vue Native App

• Ouvrir une Native App

• Exécuter (déployer et réinstaller) une Native App

• Démonter une Native App

Pour accéder à ces commandes, tapez >Snowflake Native dans le champ de recherche situé en haut de la fenêtre de VS Code.

Créer une Snowflake Native App¶

1. Dans VS Code, ouvrez l’extension VS Code de Snowflake et connectez-vous à Snowflake.

2. Développez le volet NATIVE APP et sélectionnez Create new from template.

3. Sélectionnez l’un des éléments suivants :

   • Saisissez le nom du dossier dans lequel vous souhaitez créer l”Snowflake Native App, puis appuyez sur Enter.

   • Appuyez sur Enter pour accepter le répertoire par défaut comme emplacement de l”Snowflake Native App.

4. Sélectionnez l’un des éléments suivants :

   • Saisissez l’URL du dépôt GitHub où sont stockés vos modèles Snowflake Native App, puis sélectionnez Enter.

   • Saisissez le chemin d’accès à un dossier local de modèles.

   • Pour accepter le dépôt de modèles par défaut GitHub Snowflake Native App URL, sélectionnez Enter.

5. Sélectionnez l’un des modèles suivants :

   • Sélectionnez basic pour créer une Snowflake Native App avec un minimum d’exemples de code et de conseils.

   • Sélectionnez streamlit-python pour créer une Snowflake Native App avec du code d’extension Python et des exemples de code Streamlit.

   • Sélectionnez streamlit-java pour créer une Snowflake Native App avec du code d’extension Java et des exemples de code Streamlit.

   • Sélectionnez spcs-basic pour créer une Snowflake Native App avec un code d’extension SPCS et des exemples de code Streamlit.

Déploiement et ouverture d’une Snowflake Native App¶

Lorsque vous utilisez les options Run (deploy and re-install) ou Deploy, l’application sélectionnée dans le volet NATIVE APP est utilisée. Lorsque plusieurs applications Snowflake Native App sont disponibles, un prompt apparaît et vous pouvez sélectionner le fichier snowflake.yml à utiliser pour le déploiement.

Après avoir déployé votre Snowflake Native App, vous pouvez l’ouvrir dans Snowflake pour gérer l’accès, afficher, ajouter et valider les paquets d’applications, afficher les journaux et les événements et modifier les privilèges.

1. Sélectionnez l’un des éléments suivants :

   • Dans le volet NATIVE APP de l’extension VS Code, sélectionnez Run (deploy and re-install). Cette option est recommandée si vous avez apporté des modifications importantes et qu’un objet d’application est requis.

   • Dans le volet NATIVE APP de l’extension VS Code, sélectionnez Deploy. Cette option est recommandée si vous déployez des paquets d’application et des fichiers en zone de préparation et qu’un objet d’application n’est pas requis.

2. En option. Sélectionnez l’onglet OUTPUT dans le volet des résultats de la requête pour voir la progression du déploiement.

3. Dans le volet NATIVE APP, sélectionnez Open.

Affichage du statut de l’objet d’application Snowflake Native App¶

• Dans le volet NATIVE APP de l’extension VS Code, développez votre application.

  Une police et un cercle bleus indiquent que l’objet de l’application n’a pas été installé ou déployé.

Voir le gestionnaire de variables d’environnement de Snowflake¶

Utilisez le gestionnaire de variables d’environnement de Snowflake pour créer et gérer des variables d’environnement dans des profils de variables d’environnement. Vous pouvez utiliser un profil de variable d’environnement pour personnaliser le comportement des objets dans les fichiers de définition de projet Snowflake Native App. Par exemple, vous pouvez créer des profils de variables d’environnement qui modifient le comportement des objets dans les environnements de développement, de zone de préparation et de production. Pour plus d’informations sur les variables d’environnement et les connexions Snowflake, voir Fichiers de définition de projet.

Utilisez l’une des méthodes suivantes pour voir le gestionnaire des variables d’environnement de Snowflake :

• Dans le volet NATIVE APP de l’extension VS Code, sélectionnez Environment Variables.

• Dans la palette de commandes, sélectionnez Open Environment Variables Manager.

Ajouter une variable d’environnement à un profil de variable d’environnement¶

Un profil de variable d’environnement stocke des variables d’environnement.

1. Dans le volet NATIVE APP de l’extension VS Code, sélectionnez Environment Variables.

2. Dans la liste Selected Profile, sélectionnez un profil.

3. Dans la colonne Environment Variable, entrez une variable d’environnement.

4. Dans la colonne Value, entrez une valeur pour la variable d’environnement.

5. Facultatif : Pour ajouter d’autres variables d’environnement au profil de variables d’environnement, répétez les étapes 3 et 4.

6. Facultatif : Pour ajouter des lignes supplémentaires au profil de la variable d’environnement, sélectionnez + (Add Row).

Ajouter un profil de variable d’environnement¶

Un profil de variable d’environnement stocke des variables d’environnement. Pour personnaliser le comportement des objets dans les fichiers de définition du projet Snowflake Native App, créez un nouveau profil.

1. Dans le volet NATIVE APP de l’extension VS Code, sélectionnez Environment Variables.

2. Sélectionnez Add Profile.

3. Saisissez un nom pour le profil, puis appuyez sur Enter.

Ajouter une ligne à un profil de variable d’environnement¶

Pour ajouter une variable d’environnement, ajoutez une ligne au profil de la variable d’environnement.

1. Dans le volet NATIVE APP de l’extension VS Code, sélectionnez Environment Variables.

2. Sélectionnez un profil dans la liste Selected Profile.

3. Sélectionnez + (Add Row).

Renommer un profil de variable d’environnement¶

1. Dans le volet NATIVE APP de l’extension VS Code, sélectionnez Environment Variables.

2. Sélectionnez un profil dans la liste Selected Profile.

3. Sélectionnez Rename Profile.

4. Saisissez un nom pour le profil, puis appuyez sur Enter.

Supprimer un profil de variable d’environnement¶

1. Dans le volet NATIVE APP de l’extension VS Code, sélectionnez Environment Variables.

2. Sélectionnez un profil dans la liste Selected Profile.

3. Sélectionnez Delete Profile.

Activer le mode débogage Snowflake Native App¶

Utilisez le mode débogage pour voir les objets de l’application qui ne sont pas visibles par les consommateurs, tels que les objets de contenu partagé ou les objets non accordés à un rôle de base de données spécifique. Pour plus d’informations sur le mode débogage et son activation par programmation, voir Activer le mode débogage.

• Dans le volet NATIVE APP de l’extension VS Code, sélectionnez App Debug Mode: OFF.

Suppression d’objets d’application et de paquets Snowflake Native App¶

Utilisez l’option Teardown pour supprimer l’objet d’application et le paquet définis dans la définition du projet résolu.

• Dans le volet NATIVE APP de l’extension VS Code, sélectionnez Teardown. Un message de confirmation apparaît lorsque le démontage est terminé.

Référencement de tous les fichiers d’une zone de préparation¶

1. Dans l”OBJECT EXPLORER de VS Code, accédez à une zone de préparation.

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

Chargement de fichiers du système de fichiers local vers une zone de préparation¶

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

1. Dans VS Code OBJECT EXPLORER, naviguez jusqu’à une zone de préparation et sélectionnez Upload ().

2. Saisissez les paramètres facultatifs pour l’opération de chargement. Voir PUT pour obtenir la liste des paramètres optionnels.

3. Accédez au dossier contenant les fichiers à charger, puis sélectionnez et chargez un ou plusieurs fichiers.

Chargement de fichiers d’une zone de préparation vers un système de fichiers local¶

1. Dans l”OBJECT EXPLORER de VS Code, accédez à une zone de préparation.

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

3. Sélectionnez et téléchargez un fichier.

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

Suppression des fichiers d’une zone de préparation¶

Voir aussi REMOVE.

1. Dans l”OBJECT EXPLORER de VS Code, accédez à une zone de préparation.

2. Sélectionnez un fichier.

3. Sélectionnez Remove ().

Paramètres de prévisualisation de l’extension VS Code¶

Le tableau suivant répertorie les paramètres de prévisualisation de l’extension VS Code.

Modification des paramètres de l’extension VS Code¶

1. Sélectionnez l’un des éléments suivants :

   • Sous Windows/Linux, sélectionnez File > Preferences > Settings.

   • Sur macOS, sélectionnez Code > Settings > Settings.

2. Dans le champ Search settings, saisissez Snowflake.

3. Sélectionnez les onglets User ou Workspace pour afficher ou modifier les paramètres spécifiques à l’utilisateur ou à l’espace de travail.

4. Fermez l’onglet Settings.