Snowflake Extension for Visual Studio Code¶

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

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.

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.

Ö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 () 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 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 + Eingabetaste auf einer Mac-Tastatur bzw. + Eingabetaste auf einer Windows-Tastatur.

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

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.

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.

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

Debuggen von Snowpark Python-Funktionen¶

So Debuggen Sie einer Snowpark Python-Funktion:

1. Schreiben Sie eine gespeicherte Snowflake-Prozedur in einer Python-Funktion, deren erster Parameter ein Snowpark-Session-Objekt ist.

2. Über dem Funktionsnamen sollte die Inline-Option Snowflake: Debug angezeigt werden. 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.

Syntaxhervorhebung und Autovervollständigung für SQL in Python¶

Sie können die Syntaxhervorhebung von SQL in Python-Code hinzufügen, indem Sie die automatische Erkennung aktivieren, oder indem Sie Kommentare verwenden, um SQL-Zeichenfolgen manuell zu kennzeichnen.

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¶

Um eine SQL-Anweisung in einem Python-String manuell zu kennzeichnen:

1. (Optional) Deaktivieren Sie die Erweiterungseinstellung Auto Detect Sql in Python.

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

Der folgende Screenshot zeigt beispielsweise Code, der --begin-sql und --end-sql verwendet, um eine SQL-Anweisung manuell zu kennzeichnen.

SQL-Autovervollständigung in Python-Zeichenfolgen verwenden¶

So verwenden Sie die Autovervollständigung für SQL-Anweisungen in Python-Zeichenfolgen:

1. Erstellen Sie in einer Python-Datei eine Python-Zeichenfolge, während Sie über die Erweiterung mit einer aktiven Snowflake-Sitzung verbunden sind.

2. Beginnen Sie mit dem Schreiben einer SQL-Anweisung, und sehen Sie sich die angezeigten Vorschläge für die Autovervollständigung an.

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

Syntaxhervorhebung in Jinja-Vorlagen¶

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

Verwenden von Stagingbereichen¶

Die Snowflake-Erweiterung für Visual Studio Code unterstützt das Verwalten von Inhalten des Stagingbereichs direkt im Datenbank-Explorer. Sie können Folgendes tun:

• Alle Dateien eines Stagingbereichs auflisten:

  1. Navigieren Sie zu einem bestimmten Stagingbereich.

  2. Erweitern Sie den Stagingbereich, um alle Stagingdateien zu sehen.

• Laden Sie Dateien vom lokalen Dateisystem in einen Stagingbereich, ähnlich wie bei Verwendung von PUT.

  1. Navigieren Sie zum Stagingbereich, und wählen Sie Hochladen () aus.

  2. Geben Sie alle optionalen Parameter für die Upload-Operation ein. Eine Liste der optionalen Parameter finden Sie unter PUT.

  3. Navigieren Sie zu dem Ordner, der die hochzuladenden Dateien enthält, wählen Sie eine oder mehrere Dateien aus, und laden Sie diese hoch.

• Herunterladen von Dateien eines Stagingbereichs in ein lokales Dateisystem, ähnlich wie GET:

  1. Navigieren Sie zu dem Stagingbereich.

  2. Wählen Sie im Stagingbereich die Download-Option () aus, um alle Dateien herunterzuladen, oder erweitern Sie den Stagingbereich.

  3. Wählen Sie eine Datei aus, und laden Sie diese Datei herunter.

  4. Wählen Sie ein Verzeichnis aus, um den Download abzuschließen.

• Entfernen Sie Dateien aus einem Stagingbereich, ähnlich wie unter REMOVE:

  1. Wählen Sie eine Datei aus.

  2. Wählen Sie die zugehörige Schaltfläche zum Entfernen () aus.

Änderungsprotokoll anzeigen¶

Um das Änderungsprotokoll für die Erweiterung anzuzeigen, können Sie auch den Befehl Show Change Log verwenden:

1. Öffnen Sie die Command Palette durch Drücken von CMD+Umschalttaste+P auf einer Mac-Tastatur, oder Strg+Umschalttaste+P auf einer Windows-Tastatur.

2. Geben Sie den folgenden Befehl ein:

   Show Change Log
   

   Copy

Erweiterungseinstellungen in der Vorschau¶

Die folgenden Erweiterungseinstellungen sind derzeit als Vorschau verfügbar:

Erweiterungseinstellungen ändern¶

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.