Snowflake Extension for Visual Studio Code

Snowflake bietet eine Erweiterung für Visual Studio Code (VS Code), mit der Snowflake-Benutzer Snowflake SQL-Anweisungen direkt in VS Code schreiben und ausführen können. Erweiterungen sind vorgefertigte Funktionen, die meist von Drittanbietern bereitgestellt werden und neue Features und Funktionen zu VS Code hinzufügen.

Unter diesem Thema:

Installieren der Snowflake-Erweiterung für Visual Studio Code

Snowflake-Benutzer können die VS Code-Erweiterung direkt über Visual Studio Marketplace installieren oder die Erweiterung als .xsix-Datei herunterladen und dann installieren.

Installieren über Visual Studio Marketplace

Um die Installation direkt über Visual Studio Marketplace vorzunehmen, gehen Sie wie folgt vor:

  1. Öffnen Sie Visual Studio Code.

  2. Wählen Sie Code » Preferences » Extensions aus.

    Sie können auch View » Extensions auswählen oder in der VS Code-Aktivitätsleiste auf die Erweiterungsschaltfläche vsc-extensions-button klicken.

  3. Geben Sie im Textfeld Search Extensions den Text „Snowflake“ ein, um nach der Snowflake Visual Studio-Erweiterung zu suchen.

  4. Wählen Sie in der Liste der Erweiterungen die von Snowflake bereitgestellte Erweiterung aus, und klicken Sie auf Install.

Installieren über eine VSIX-Datei

Um eine VSIX-Datei herunterzuladen und zu installieren, gehen Sie wie folgt vor:

  1. Laden Sie die Erweiterung herunter.

    1. Öffnen Sie die Seite Snowflake Visual Studio Code-Erweiterung.

    2. Wählen Sie die Registerkarte Version History aus.

    3. Wählen Sie die herunterzuladende Version aus, und klicken Sie auf Download. Achten Sie darauf, in welches Verzeichnis die Datei heruntergeladen wird.

  2. Öffnen Sie Visual Studio Code.

  3. Wählen Sie Code » Preferences » Extensions aus.

    Sie können auch View » Extensions auswählen oder in der Aktivitätsleiste auf die Erweiterungsschaltfläche vsc-extensions-button klicken.

  4. Wählen Sie im Menü „Mehr“ (…) die Option Install from VSIX aus.

  1. Suchen Sie die Datei snowflake-x.y.z.vsix auf Ihrem Computer, wählen Sie die Datei aus, 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.

Anmelden

Bevor Sie SQL-Anweisungen ausführen können, müssen Sie sich bei einem Snowflake-Konto anmelden.

Sie können sich bei Snowflake mit Ihrem Snowflake-Kontobezeichner, Ihrem Benutzernamen und Ihrem Kennwort anmelden oder eine Verbundauthentifizierung bei Snowflake mit SAML SSO verwenden.

Wenn Sie sich das erste Mal über die VS Code-Erweiterung bei Snowflake anmelden, müssen Sie Ihr Konto hinzufügen, indem Sie entweder den Kontobezeichner für Ihr Snowflake-Konto oder die URL eingeben, die Sie für die Verbindung zu Snowflake verwenden.

Weitere Informationen zum Ermitteln des Kontobezeichners finden Sie unter Kontobezeichner.

Um sich bei Snowflake über die VS Code-Erweiterung anzumelden, gehen Sie wie folgt vor:

  1. Klicken Sie in der Activity Bar auf das Snowflake-Symbol.

    Der Seitenleistenbereich wechselt zur Snowflake-Navigation und zeigt das Dialogfeld Add Account oder Sign in an.

  2. Geben Sie unter Add Account den Kontobezeichner ein, und wählen Sie Continue aus.

    Add Account wird nur angezeigt, wenn zuvor kein Konto angegeben wurde.

  1. Geben Sie einen Benutzernamen und ein Kennwort für das ausgewählte Konto ein, und wählen Sie Sign in aus.

Nach erfolgreicher Anmeldung werden in der Seitenleiste der Sitzungskontext (ACCOUNT), DATABASE EXPLORER für den Benutzer in seiner Standardrolle und QUERY HISTORY (Abfrageverlauf) angezeigt.

Verwenden Snowflake-Erweiterung für Visual Studio Code mit SnowSQL-Konfigurationsdateien

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.

Um die Snowflake-Erweiterung für Visual Studio Code so zu konfigurieren, dass eine SnowSQL-Konfigurationsdatei verwendet wird, gehen Sie wie folgt vor:

  1. Wählen Sie in der Aktivitätsleiste Activity Bar das Snowflake-Symbol aus.

    Der Seitenleistenbereich wechselt zur Snowflake-Navigation und zeigt das Dialogfeld Add Account oder Sign in an.

  2. Wählen Sie im Dropdown-Menü Username die Option Sign in to another account aus.

  3. Wählen Sie Use SnowSQL Config aus. Die Visual Studio-Codeeinstellungsseite für die Snowflake-Erweiterung für Visual Studio Code wird mit der Auswahl von SnowSQL Config Path geöffnet.

  4. Geben Sie einen Pfad zu einer gültigen SnowSQL-Konfigurationsdatei ein.

Die Dropdown-Liste der Konten wird aktualisiert und enthält nun alle Verbindungen, die in der angegebenen Konfigurationsdatei definiert sind.

Verwenden von SQL-Dateien

Sie können die Snowflake-Erweiterung für Visual Studio Code verwenden, um SQL-Dateien zu laden. SQL-Dateien sind einfache Textdateien, die eine oder mehrere SQL-Anweisungen enthalten.

Öffnen von SQL-Dateien

Um Snowflake SQL-Dateien zu erstellen oder zu öffnen, gehen Sie wie folgt vor:

  1. Wählen Sie File » Open aus, navigieren Sie zu einer Textdatei, die SQL enthält, und öffnen Sie diese.

    Wenn Sie keine vorhandene SQL-Datei haben, können Sie eine neue erstellen. Wählen Sie File » New File aus, und erstellen Sie eine Datei des Typs Snowflake SQL File. Klicken Sie alternativ auf die Schaltfläche (vsc-new-sql-file-button) im Datenbank-Explorer-Bereich, um eine neue SQL-Datei zu erstellen.

  2. Geben Sie eine oder mehrere Snowflake SQL-Anweisungen in die Datei ein.

  3. Wählen Sie eine Zeile aus, und drücken Sie über der Zeile auf die Schaltfläche „Enter“, um den Befehl auszuführen.

Ausführen von Befehlen oder Abfragen

Um einen oder mehrere Befehle oder Abfragen auszuführen, gehen Sie wie folgt vor:

  1. Wählen Sie vsc-execute-all-button für die ausgewählte SQL-Datei aus, um alle Anweisungen in dieser Datei auszuführen.

  2. Wählen Sie die auszuführende Zeile aus, indem Sie den Cursor auf die auszuführende Anweisung setzen.

    Wenn Sie zwei oder mehr Befehle auswählen, werden alle ausgewählten Befehle ausgeführt.

  3. Drücken Sie über dem ersten ausgewählten Befehl auf die Schaltfläche „Enter“.

Wenn Sie mehrere Befehle auswählen, werden die Befehle in der Reihenfolge von oben nach unten ausgeführt.

Sie können Anweisungen auch über Tastenkombinationen ausführen. Nach Auswahl der SQL-Anweisungen, die Sie ausführen möchten, drücken Sie Apple OSX Command key. + Eingabetaste auf einer Mac-Tastatur bzw. Generic control key. + Eingabetaste auf einer Windows-Tastatur.

Die Ergebnisse der SQL-Anweisung werden in der Tabelle SNOWFLAKE:QUERY RESULTS des Output-Bereichs angezeigt.

Tipp

Laufende Abfragen können abgebrochen werden. Um eine laufende Abfrage abzubrechen, suchen Sie die Abfrage in QUERY HISTORY, und wählen Sie dann die Schaltfläche zum Abbrechen der Abfrage (vsc-cancel-query-button).

Abfrageverlauf verwenden

Die Abfrageergebnisse werden in QUERY HISTORY verfolgt.

Gehen Sie wie folgt vor, um zuvor ausgeführte Abfrageergebnisse zu prüfen:

  1. Erweitern Sie Query History.

  2. Wählen Sie eine Anweisung aus.

  3. Untersuchen Sie das Ergebnis auf der Registerkarte SNOWFLAKE:QUERY RESULTS des Bereichs Output.

Tipp

Über Query History können Sie eine Abfrage erneut ausführen (vsc-query-rerun-button), den Abfragetext in die Zwischenablage kopieren (vsc-query-copy-button) oder eine Abfrage löschen (vsc-query-delete-button).

Verwenden von Abfrageergebnissen

Sie können Abfrageergebnisse sortieren, neu anordnen, ausblenden, einfrieren oder auf der Festplatte speichern.

Um die Anzeige einer bestimmten Abfrage zu ändern, gehen Sie wie folgt vor:

  1. Wählen Sie in QUERY HISTORY eine Abfrage aus.

  2. Wählen Sie in QUERY RESULTS eine Spalte aus.

  3. Wählen Sie den Abwärtspfeil (↓) und dann eine der folgenden Optionen aus: SORT A-Z (absteigend), Sort Z-A (aufsteigend), Hide column „column name“ (Spalte „Spaltenname“ ausblenden) oder Freeze columns up to „column name“ (Spalten bis „Spaltenname“ einfrieren).

Die Anzeige des Inhalts wird entsprechend geändert.

Tipp

Wenn eine Spalte zuvor ausgeblendet war, wählen Sie eine beliebige andere Spalte und markieren Sie Unhide N columns (N Spalten einblenden).

Um die Ergebnisse einer Abfrage auf der Festplatte zu speichern, wählen Sie entweder Festplatte (vsc-view-download-button) oder Download (vsc-view-save-button) für die Abfrage aus. Der Inhalt wird in einer Datei gespeichert, entweder als komprimierte gzip-Datei oder als kommagetrennte Datei.

Ändern des Sitzungskontexts

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.

Tipp

Verwenden Sie das Dropdown-Menü für Konten, um sich anzumelden oder zwischen verschiedenen Konten zu wechseln.

Sign in to, or switch between accounts.

Details zur Erweiterung anzeigen

Sie können jederzeit Informationen zur Snowflake SQL-Erweiterung für Visual Studio Code anzeigen.

Folgende Informationen zu der Erweiterung werden angezeigt:

  • Versionsinformationen: Die derzeit installierte Version der Erweiterung.

  • Änderungsprotokoll (Changelog): Informationen zu den hinzugefügten, geänderten oder aktualisierten Features je nach Version.

  • Erläuterungen zu den Features.

Darüber hinaus können Sie die Erweiterung über das Dropdown-Menü aktivieren/deaktivieren.

Gehen Sie wie folgt vor, um Informationen zur Erweiterung anzuzeigen:

  1. Wählen Sie Code » Preferences » Extensions aus.

  2. Wählen Sie die Snowflake SQL-Erweiterung für VS Code aus.

    Sie können auch View » Extensions auswählen oder auf der Activities-Leiste auf die Erweiterungsschaltfläche vsc-extensions-button klicken.

Einstellungen für die Erweiterung

Die Snowflake-Erweiterung für Visual Studio Code unterstützt die folgenden Einstellungen:

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

So ändern Sie die Erweiterungseinstellungen:

  1. Wählen Sie unter Windows/Linux File » Preferences » Settings aus. . Wählen Sie unter macOS Code » Preferences » Settings aus.

  2. Geben Sie in das Textfeld Search settings Snowflake ein.

  3. Wählen Sie die Registerkarte User oder Workspace aus, um benutzerspezifische oder arbeitsbereichsspezifische Einstellungen anzuzeigen oder zu ändern.

  4. Schließen Sie die Registerkarte Settings.

Deinstallieren der Erweiterung

Um die Erweiterung zu deaktivieren oder zu deinstallieren, gehen Sie wie folgt vor:

  1. Wählen Sie Code » Preferences » Extensions aus.

  2. Wählen Sie die Erweiterung aus.

  3. Klicken Sie mit der rechten Maustaste, und wählen Sie Disable oder Uninstall auf.