Snowflake Extension for Visual Studio Code¶
Die Snowflake-Erweiterung für Visual Studio Code (VS Code) ermöglicht es Ihnen, Snowflake SQL-Anweisungen direkt in VS-Code zu schreiben und auszuführen. Die Erweiterung ist auch in Snowpark Python integriert, um Debugging-, Syntaxhervorhebungs- und Autovervollständigungsfunktionen für SQL in Python-Code zu bieten.
Sie können die VS-Code-Erweiterung über Visual Studio Marketplace installieren, oder Sie können die Datei .vsix
herunterladen und installieren.
Unter diesem Thema:
Installieren Sie die VS-Code-Erweiterung vom Visual Studio Marketplace¶
Wählen Sie unter VS-Code Code » Settings » Extensions aus.
Geben Sie in das Feld Search Extensions in Marketplace Snowflake ein, und wählen Sie dann die Erweiterung Snowflake aus.
Um zu bestätigen, dass Sie die richtige Erweiterung ausgewählt haben, suchen Sie nach dem Snowflake-Abzeichen, wie in der folgenden Abbildung dargestellt:
Klicken Sie auf Install.
Installieren Sie die VS-Code-Erweiterung aus einer .vsix Datei¶
Laden Sie die Erweiterung herunter:
Rufen Sie https://marketplace.visualstudio.com/items?itemName=snowflake.snowflake-vsc auf.
Klicken Sie auf die Registerkarte Version History.
Klicken Sie auf Download für die VS-Code-Version, die Sie installieren möchten. Achten Sie darauf, in welches Verzeichnis die Datei heruntergeladen wird.
Wählen Sie unter VS-Code Code » Settings » Extensions aus.
Klicken Sie auf More (…) » Install from VSIX.
Suchen Sie den Speicherort der Datei
snowflake-x.y.z.vsix
auf Ihrem Computer, markieren Sie die Datei und wählen Sie dann Install aus.Nach erfolgreicher Installation wird die Snowflake-Erweiterung für Visual Studio Code im Abschnitt INSTALLED des Menüs Extensions in VS Code angezeigt.
Melden Sie sich bei Snowflake mit der VS-Code-Erweiterung an¶
Bevor Sie SQL-Anweisungen ausführen oder Snowpark Python Features nutzen können, müssen Sie sich bei einem Snowflake-Konto anmelden.
Um sich bei Snowflake mit der VS-Code-Erweiterung anzumelden, können Sie:
Verwenden Sie Ihren Snowflake-Kontobezeichner, Ihren Benutzernamen und Ihr Kennwort.
Verwenden Sie eine Verbundauthentifizierung wie Security Assertion Markup Language (SAML) oder Single Sign-On (SSO).
Verwenden der Schlüsselpaar-Authentifizierung.
Wenn Sie sich zum ersten Mal über die VS-Code-Erweiterung bei Snowflake anmelden, müssen Sie den Kontobezeichner für Ihr Snowflake-Konto oder die URL eingeben, die Sie für die Verbindung zu Snowflake verwenden. Um Ihren Kontobezeichner zu bestimmen, siehe Kontobezeichner.
Klicken Sie auf das Snowflake-Symbol in der VS-Code-Aktivitätsleiste.
Geben Sie in das Feld Account Identifier/URL den Kontobezeichner für Ihr Snowflake-Konto oder die URL ein, die Sie für die Verbindung mit Snowflake verwenden, und klicken Sie dann auf Continue.
Das Feld Account Identifier/URL ist nicht verfügbar, wenn Sie zuvor Ihre Anmeldeinformationen für das Snowflake-Konto angegeben haben.
Wählen Sie eine der folgenden Optionen in der Liste Auth Method:
Wählen Sie Single sign-on, um Ihre SSO-Anmeldeinformationen zu verwenden, um sich bei Snowflake anzumelden.
Wählen Sie Username/password, um sich mit Ihrem Snowflake-Benutzernamen und -Kennwort bei Snowflake anzumelden.
Wählen Sie Key Pair, um sich mit Ihrem Snowflake-Benutzernamen und -Kennwort bei Snowflake anzumelden. Mehr über die Authentifizierung mit Schlüsselpaaren erfahren Sie unter Schlüsselpaar-Authentifizierung und Schlüsselpaar-Rotation.
Geben Sie Ihre Anmeldeinformationen ein und klicken Sie dann auf Sign in.
Wenn Sie SSO auswählen, öffnet sich eine separate Seite zur Authentifizierung, nachdem Sie Ihren Benutzernamen eingegeben und Sign in with single sign-on ausgewählt haben. Geben Sie Ihre SSO-Anmeldeinformationen ein und kehren Sie dann zu VS-Code zurück, um die Anmeldung bei Snowflake abzuschließen.
Nachdem Sie sich erfolgreich angemeldet haben, zeigt die Seitenleiste Ihre Kontoinformationen, Ihre Standardrolle, die OBJECT EXPLORER mit einer Liste von Datenbanken und Ihre QUERY HISTORY an.
Bearbeiten Sie die Snowflake-Datei connections.toml
¶
Sie können in der Konfigurationsdatei von Snowflake connections.toml
Definitionen für Verbindungen hinzufügen und ändern. Eine Verbindungsdefinition ist eine Sammlung von verbindungsbezogenen Parametern. Weitere Informationen zur Verbindung mit Snowflake über eine TOML-Datei finden Sie unter Verbinden mit der Datei connections.toml.
Die VS Code Erweiterung Weboberfläche¶

In der folgenden Tabelle finden Sie Beschreibungen der Funktionen der Weboberfläche der VS-Code-Erweiterung.
Element |
Beschreibung |
---|---|
1 |
Seitenleisten-Panel. Enthält die Bereiche Konto, Objekt-Explorer und Abfrageverlauf. In diesem Bereich können Sie Kontodetails angeben, Datenbankobjekte untersuchen und Abfrageergebnisse prüfen. |
2 |
Snowflake-SQL-Panel. Zeigt Snowflake-SQL-Dateien an. |
3 |
Abfrageverlaufs-Panel. Zeigt die letzten Abfragen an. |
4 |
Abfrageergebnisse-Panel. Zeigt die Abfrageergebnisse an. Wählen Sie eine Abfrage aus, um das Ergebnis ihrer Ausführung anzuzeigen. |
5 |
Aktuelle Sitzung. Zeigt Informationen zur aktuellen Sitzung, einschließlich der aktuellen Rolle, der Datenbank, des Schemas und des aktiven Warehouse. |
Die VS-Code-Erweiterung mit den SnowSQL-Konfigurationsdateien verwenden¶
Die Snowflake-Erweiterung für Visual Studio Code kann SnowSQL-Konfigurationsdateien zum Laden von Verbindungskonfigurationen verwenden.
Bemerkung
Es werden nur die Werte der Verbindungskonfiguration verwendet. Andere SnowSQL-Konfigurationswerte werden ignoriert.
Geben Sie in das VS-Code Suchfeld
>user settings
ein und wählen Sie dann Preferences: Open User Settings.Erweitern Sie auf der Registerkarte User Extensions.
Scrollen Sie nach unten und wählen Sie Snowflake aus.
Scrollen Sie im rechten Fensterbereich nach unten zu Snowsql Config Path.
Geben Sie einen Pfad zu einer gültigen SnowSQL-Konfigurationsdatei ein.
Alle in der Konfiguration definierten Verbindungen werden im Panel Konto angezeigt.
Mit SQL-Dateien arbeiten¶
Sie können die Snowflake-Erweiterung für Visual Studio Code verwenden, um SQL-Dateien zu laden. SQL-Dateien sind Textdateien, die eine oder mehrere SQL-Anweisungen enthalten.
SQL-Dateien öffnen oder erstellen¶
Wählen Sie in VS-Code File » Open, suchen Sie den Speicherort einer SQL-Datei und öffnen Sie diese.
Um eine neue SQL-Datei zu erstellen, wählen Sie File » New File aus und erstellen Sie eine Datei vom Typ Snowflake SQL File.
Geben Sie eine oder mehrere Snowflake SQL-Anweisungen in die Datei ein.
(Optional) Klicken Sie auf Snowflake: Execute All Statements (
), um einen Befehl auszuführen.
Befehle oder Abfragen ausführen¶
Wichtig
Um Snowflake-Abfrageergebnisse anzuzeigen, führt die VS-Code-Erweiterung nach jeder Abfrage automatisch DESC RESULT '<query_id>'
im Hintergrund aus. Dieser Prozess macht LAST_QUERY_ID()
ungenau. Weitere Informationen über den Befehl DESCRIBE RESULT und seine Parameter finden Sie unter DESCRIBE RESULT.
Wählen Sie unter VS Code eine der folgenden Optionen aus:
Um alle SQL-Anweisungen in einer Datei auszuführen, klicken Sie auf Snowflake: Execute All Statements (
).
Um einen bestimmten Befehl auszuführen, setzen Sie den Cursor auf die gewünschte Anweisung und klicken dann auf Execute.
Um mehrere Befehle auszuführen, markieren Sie die Anweisungen, die Sie ausführen möchten, und klicken Sie dann auf Execute. Die Ausführung der Befehle erfolgt in der Reihenfolge von oben nach unten.
Um Tastaturkürzel zur Ausführung von Anweisungen zu verwenden, markieren Sie die SQL-Anweisungen, die Sie ausführen möchten, und drücken Sie + Eingabetaste auf einer Mac-Tastatur oder
+ Eingabetaste auf einer Windows-Tastatur.
Die Ergebnisse der ausgeführten SQL-Anweisung werden im Panel SNOWFLAKE angezeigt.
Um laufende Abfragen abzubrechen, wählen Sie eine Abfrage in der Liste QUERY HISTORY aus und klicken Sie auf Cancel query ().
Abfrageverlauf anzeigen¶
Erweitern Sie unter VS-Code Query History.
Wählen Sie eine Anweisung aus.
Überprüfen Sie die Ergebnisse im Bereich SNOWFLAKE.
(Optional) Wählen Sie eine der folgenden Optionen aus:
Mit Abfrageergebnissen arbeiten¶
Sie können Abfrageergebnisse sortieren, neu anordnen, ausblenden, einfrieren oder auf der Festplatte speichern.
Wählen Sie in QUERY HISTORY eine Abfrage aus.
Wählen Sie im Bereich SNOWFLAKE eine Spalte aus.
Wählen Sie den Erweiterungspfeil (↓) und dann eine der folgenden Optionen aus: Sort Ascending, Sort Descending, Hide column „column name“ oder Freeze columns up to „column name“.
Wenn eine Spalte zuvor ausgeblendet war, wählen Sie eine beliebige andere Spalte und markieren Sie Unhide N columns (N Spalten einblenden).
(Optional) Wählen Sie eine der folgenden Optionen aus:
Mit Snowpark Python-Code arbeiten¶
Sie können die Snowflake Extension for Visual Studio Code zum Schreiben und Debuggen von Snowflake SQL-Anweisungen in Snowpark Python-Code verwenden.
Snowpark Python-Funktionen debuggen¶
Schreiben Sie eine gespeicherte Snowflake-Prozedur in einer Python-Funktion, deren erster Parameter ein Snowpark-
Session
-Objekt ist.Eine Inline-Option Snowflake: Debug wird über dem Namen der Funktion angezeigt. Wählen Sie diese Option, um die gespeicherte Prozedur in der Funktion auszuführen, wobei Ihre aktuelle aktive Sitzung über die Erweiterung verwendet wird. Sie können auch Debug-Haltepunkte setzen.
SQL-Anweisungen automatische erkennen¶
Um die automatische SQL-Syntaxhervorhebung einzurichten, aktivieren Sie die Erweiterungseinstellung Auto Detect Sql in Python. Die Erweiterung erkennt automatisch SQL-Anweisungen, indem sie nach einem SQL-Schlüsselwort in Großbuchstaben als erstes Wort in einer Python-Zeichenfolge sucht, wie im folgenden Screenshot gezeigt.

SQL-Anweisungen manuell kennzeichnen¶
(Optional) Deaktivieren Sie die Erweiterungseinstellung Auto Detect Sql in Python.
Verwenden Sie Kommentare, um Anfang und Ende einer SQL-Anweisung zu kennzeichnen. Sie können eine beliebige Kombination der folgenden Markierungen verwenden:
Startmarkierungen:
-–startsql
,-–beginsql
,-–start-sql
,-–begin-sql
Endmarkierungen:
–-endsql
,–-end-sql
Die folgende Abbildung zeigt, wie die Markierungen
--begin-sql
und--end-sql
eine SQL-Anweisung manuell kennzeichnen.

SQL-Autovervollständigung in Python-Zeichenfolgen verwenden¶
Erstellen Sie in einer Python-Datei eine Python-Zeichenfolge , während Sie mit einer aktiven Snowflake-Sitzung mit der VS-Code-Erweiterung verbunden sind.
Schreiben Sie eine SQL-Anweisung. Die Vorschläge zur automatischen Vervollständigung werden angezeigt.
Wenn Sie zum Beispiel eine Anweisung wie
SELECT * FROM db1.public
schreiben, schlägt die Erweiterung automatisch Tabellennamen vor.Ähnlich verhält es sich, wenn Sie innerhalb einer SELECT-Anweisung, die auf eine Tabelle verweist, mit dem Ausfüllen von Spalten beginnen: Die Erweiterung schlägt automatisch Spaltennamen vor, wie im folgenden Bild gezeigt.

Syntaxhervorhebung in Jinja-Vorlagen¶
Standardmäßig fügt die VS-Codeerweiterung grundlegende Syntaxhervorhebung und automatische Klammervervollständigung für das Schreiben von Jinja-Vorlagen in Snowflake SQL hinzu, wie im folgenden Screenshot gezeigt.

Arbeiten Sie mit Snowflake Native App Framework¶
Sie können die VS-Code-Erweiterung verwenden, um eine Snowflake Native App zu erstellen und zu verwalten. Weitere Informationen über Snowflake Native App Framework finden Sie unter Allgemeine Informationen zum Snowflake Native App Framework.
Erstellen Sie eine Snowflake Native App, wenn:¶
Öffnen Sie unter VS-Code Snowflake-Erweiterung für VS-Code und melden Sie sich bei Snowflake an.
Erweitern Sie den Bereich NATIVE APP und klicken Sie dann auf Create new from template.
Wählen Sie eine der folgenden Optionen aus:
Geben Sie den Namen des Ordners ein, in dem Sie die Snowflake Native App erstellen möchten, und drücken Sie dann Enter.
Drücken Sie Enter, um das Standardverzeichnis als Speicherort für Snowflake Native App zu akzeptieren.
Wählen Sie eine der folgenden Optionen aus:
Geben Sie die URL für das GitHub-Repository ein, in dem Ihre Snowflake Native App-Vorlagen gespeichert sind, und drücken Sie dann Enter.
Drücken Sie Enter, um die Standard-URL des GitHub Snowflake Native App-Vorlagen-Repositorys zu akzeptieren.
Wählen Sie eine der folgenden Vorlagen aus:
Wählen Sie basic aus, um eine Snowflake Native App mit minimalen Codebeispielen und Anleitungen zu erstellen.
Wählen Sie streamlit-python aus, um eine Snowflake Native App mit Python-Erweiterungscode und Streamlit-Codebeispielen zu erstellen.
Wählen Sie streamlit-java, um eine Snowflake Native App mit Java-Erweiterungscode und Streamlit-Codebeispielen zu erstellen.
Wählen Sie spcs-basic, um eine Snowflake Native App mit SPCS-Erweiterungscode und Streamlit-Codebeispielen zu erstellen.
Eine Snowflake Native App bereitstellen und öffnen¶
Wenn Sie die Optionen Run (deploy and re-install) oder Deploy verwenden, wird die erste snowflake.yml
-Datei verwendet, die im Bereich NATIVE APP aufgeführt ist. Wenn mehrere snowflake.yml
-Dateien verfügbar sind, erscheint eine Aufforderung und Sie können die snowflake.yml
-Datei auswählen, die Sie für die Bereitstellung verwenden möchten.
Nachdem Sie Ihr Snowflake Native App bereitgestellt haben, können Sie es in Snowflake öffnen, um den Zugriff zu verwalten, Anwendungspakete anzuzeigen, hinzuzufügen und zu validieren, Protokolle und Ereignisse anzuzeigen und Berechtigungen zu ändern.
Wählen Sie eine der folgenden Optionen aus:
Klicken Sie im Bereich VS-Code-Erweiterung der NATIVE APP auf Run (deploy and re-install). Dies ist die empfohlene Option, wenn Sie erhebliche Änderungen vorgenommen haben und ein Anwendungsobjekt erforderlich ist.
Klicken Sie im Bereich VS-Code-Erweiterung der NATIVE APP auf Deploy. Dies ist die empfohlene Option, wenn Sie Anwendungspakete und Stagingbereiche bereitstellen und ein Anwendungsobjekt nicht erforderlich ist.
(Optional) Klicken Sie auf die Registerkarte OUTPUT im Panel Abfrageergebnisse, um den Fortschritt der Bereitstellung zu sehen.
Klicken Sie im Fensterbereich NATIVE APP auf Open.
Status der Anwendungsobjekte der Snowflake Native App anzeigen¶
Erweitern Sie im Bereich VS-Code-Erweiterung NATIVE APP Ihre Anwendung.
Nicht installierte Anwendungsobjekte sind blau.
Debug-Modus aktivieren¶
Verwenden Sie den Debug-Modus, um Anwendungsobjekte anzuzeigen, die für Verbraucher nicht sichtbar sind. Zum Beispiel freigegebene Inhaltsobjekte oder Objekte, die keiner bestimmten Datenbankrolle zugewiesen sind. Weitere Informationen über den Debug-Modus und dessen programmgesteuerte Aktivierung finden Sie unter Debug-Modus aktivieren.
Klicken Sie im Bereich VS-Code-Erweiterung der NATIVE APP auf Debug Mode.
Klicken Sie auf Enable Debug Mode.
Wählen Sie Enable debug mode for all Native Apps operations aus.
Snowflake Native App-Pakete und Anwendungsobjekte löschen¶
Verwenden Sie die Option Teardown, um das Anwendungsobjekt das in der aufgelösten Projektdefinition definierte Anwendungspaket zu löschen.
Klicken Sie im Bereich VS-Code-Erweiterung der NATIVE APP auf Teardown. Wenn die Löschung abgeschlossen ist, wird eine Bestätigungsmeldung.
Sitzungskontext ändern¶
Im Abschnitt Account des Side Bar-Bereichs können Sie Rollen, Datenbanken, Schemas und Warehouses auswählen. Verwenden Sie das jeweilige Dropdown-Menü, um die gewünschte Option auszuwählen.
Verwenden Sie das Dropdown-Menü für Konten, um sich anzumelden oder zwischen verschiedenen Konten zu wechseln.
Inhalte des Stagingbereichs verwalten¶
Die Snowflake Extension for Visual Studio Code unterstützt das Verwalten von Stagingbereichen direkt im Object Explorer.
Alle Dateien eines Stagingbereichs auflisten¶
Navigieren Sie im VS-Code OBJECT EXPLORER zu einem Stagingbereich.
Erweitern Sie den Stagingbereich, um alle Stagingdateien zu sehen.
Dateien vom lokalen System in einen Stagingbereich hochladen¶
Die Snowflake Extension for Visual Studio Code unterstützt nur Uploads für interne Stagingbereiche, während alle anderen Operationen sowohl für interne als auch für externe Stagingbereiche funktionieren.
Navigieren Sie im VS-Code OBJECT EXPLORER Sie zu einem Stagingbereich und klicken auf Upload (
).
Geben Sie optionale Parameter für die Upload-Operation ein. Eine Liste der optionalen Parameter finden Sie unter PUT.
Navigieren Sie zu dem Ordner, der die hochzuladenden Dateien enthält, und wählen Sie dann eine oder mehrere Dateien aus und laden Sie sie hoch.
Dateien aus einem Stagingbereich in ein lokales Dateisystem herunterladen¶
Dateien aus einem Stagingbereich entfernen¶
Siehe auch REMOVE.
Einstellungen für die VS-Code-Erweiterung¶
In der folgenden Tabelle sind die Einstellungen von Snowflake Extension for Visual Studio Code aufgeführt.
Einstellung |
Beschreibung |
Standard |
---|---|---|
Export CSV » Delimiter |
Gibt Trennzeichen für Spalten an |
Komma |
Export CSV » Header |
Aktiviert Einfügen von Kopfzeile in exportierter CSV-Datei |
Aktiviert |
Export CSV » Include Empty Rows |
Aktiviert Einfügen von leeren Zeilen in exportierter CSV-Datei |
Ausschließen |
Export CSV » Quotes |
Aktiviert doppelte Anführungszeichen um alle Werte in exportierter CSV-Datei |
Aktiviert |
Highlight Query |
Aktiviert Hintergrundhervorhebung der aktuellen SQL-Anweisung |
Aktiviert |
Show Execute Above Statement |
Aktiviert anklickbare Ausführungsaktion über jeder Anweisung |
Aktiviert |
Snowsql Config Path |
Wenn festgelegt, wird Verbindungskonfiguration aus dieser Datei geladen |
Nicht festgelegt |
Autocomplete Object Details |
Zeigt Details eines Snowflake-Objekts an, nachdem dessen Autovervollständigungseintrag ausgewählt wurde |
Deaktiviert |
Set Client Session Keep Alive |
Gibt an, ob die Sitzung auf unbestimmte Zeit aktiv bleiben soll, solange die Verbindung aktiv ist, unabhängig von der Aktivität. Wenn nicht aktiviert, ist nach vier Stunden Inaktivität eine erneute Anmeldung erforderlich. |
Aktiviert |
Autovervollständigung von Variant-Schlüsseln |
Vorschläge für die Autovervollständigung von OBJECT/VARIANT-Schlüsseln anzeigen |
Deaktiviert |
Object Explorer: Search |
Aktiviert die Suche im Objekt-Explorer |
Aktiviert |
Query History: Item Limit |
Gibt die maximale Anzahl der im Verlauf angezeigten Abfragen an. Die Anzeige von mehr Abfragen kann die Leistung beeinträchtigen. |
1000 |
Einstellungen für die Vorschau der VS-Code-Erweiterung¶
In der folgenden Tabelle finden Sie eine Auflistung der Einstellungen für die Vorschau der VS-Code-Erweiterung.
Einstellung |
Beschreibung |
Standard |
---|---|---|
Syntax Highlighting: Auto Detect Sql in Python |
Aktiviert automatische Syntaxhervorhebung von SQL-Anweisungen in Python-Zeichenfolgen |
Aktiviert |
Enable Public Preview Features |
Aktiviert das öffentlichen Vorschau-Feature für die Erweiterung |
Deaktiviert |
Einstellungen der VS-Code-Erweiterung ändern¶
Wählen Sie eine der folgenden Optionen aus:
Wählen Sie unter Windows/Linux File » Preferences » Settings aus.
Wählen Sie unter macOS Code » Settings » Settings aus.
Geben Sie in das Feld Search settings Snowflake ein.
Wählen Sie die Registerkarte User oder Workspace aus, um benutzerspezifische oder arbeitsbereichsspezifische Einstellungen anzuzeigen oder zu ändern.
Schließen Sie die Registerkarte Settings.
Das Änderungsprotokoll der VS-Code-Erweiterung anzeigen¶
Drücken Sie CMD+Umschalt+P (Mac), oder CTRL+Umschalt+P (Windows).
Geben Sie den folgenden Befehl ein:
Show Change Log
VS-Code-Erweiterung¶
Wählen Sie Code » Settings » Extensions aus.
Wählen Sie die Erweiterung aus.
Klicken Sie mit der rechten Maustaste, und wählen Sie Disable oder Uninstall aus.