Snowflake Extension for Visual Studio Code¶

SQL-Dateien öffnen oder erstellen¶

1. 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, und erstellen Sie eine Datei vom Typ Snowflake SQL File.

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

3. Optional. Wählen Sie Snowflake: Execute All Statements (), um einen Befehl auszuführen.

Befehle oder Abfragen ausführen¶

Wählen Sie unter VS Code eine der folgenden Optionen aus:

• Um alle SQL-Anweisungen in einer Datei auszuführen, wählen Sie Snowflake: Execute All Statements ().

• Um einen bestimmten Befehl auszuführen, setzen Sie den Cursor auf die Anweisung, die Sie ausführen möchten, und wählen dann Execute.

• Um mehrere Befehle auszuführen, markieren Sie die Anweisungen, die Sie ausführen möchten, und wählen Sie dann 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 Bereich SNOWFLAKE angezeigt.

Um laufende Abfragen abzubrechen, markieren Sie eine Abfrage in der Liste QUERY HISTORY, und wählen Sie Cancel query ().

Abfrageverlauf anzeigen¶

1. Erweitern Sie unter VS-Code Query History.

2. Wählen Sie eine Anweisung aus.

3. Überprüfen Sie die Ergebnisse im Bereich SNOWFLAKE.

4. Optional. Wählen Sie eine der folgenden Optionen aus:

   • Wählen Sie Snowflake: Copy to Clipboard (), um den Abfragetext in die Zwischenablage zu kopieren.

   • Wählen Sie Snowflake: Remove Query (), um eine Abfrage zu löschen.

Mit Abfrageergebnissen arbeiten¶

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

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

2. Wählen Sie im Bereich SNOWFLAKE eine Spalte aus.

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

4. Optional. Wählen Sie eine der folgenden Optionen aus:

   • Wählen Sie Cloud (), um die Ergebnisse als komprimierte gzip-Datei zu speichern.

   • Wählen Sie Save (), um die Ergebnisse als kommagetrennte (CSV)-Datei zu speichern.

Snowpark Python-Funktionen debuggen¶

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

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

1. Optional. Deaktivieren Sie die Erweiterungseinstellungen 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

   Die folgende Abbildung zeigt, wie die Markierungen --begin-sql und --end-sql eine SQL-Anweisung manuell kennzeichnen.

SQL-Autovervollständigung in Python-Zeichenfolgen verwenden¶

1. Erstellen Sie in einer Python-Datei eine Python-Zeichenfolge , während Sie mit einer aktiven Snowflake-Sitzung mit der VS-Code-Erweiterung verbunden sind.

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

Betrachten Sie die VS-Code-Erweiterung der Snowflake Native App-Befehlspalette¶

Die VS-Code-Erweiterung der Snowflake Native App-Befehlspalette bietet Zugriff auf die folgenden Snowflake Native App-Befehle:

• Native App erstellen

• Bereitstellen einer Native App

• Fokus auf die Ansicht einer Native App

• Öffnen einer Native App

• Ausführen (Bereitstellen und Neuinstallieren) einer Native App

• Löschen einer Native App

Um auf diese Befehle zuzugreifen, geben Sie >Snowflake Native in das Suchfeld am oberen Rand des VS-Code-Fensters ein.

Erstellen Sie eine Snowflake Native App, wenn:¶

1. Öffnen Sie unter VS-Code Snowflake-Erweiterung für VS-Code und melden Sie sich bei Snowflake an.

2. Erweitern Sie den Bereich NATIVE APP, und wählen Sie dann Create new from template.

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

4. 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 wählen Sie dann Enter.

   • Geben Sie den Pfad zu einem lokalen Vorlagenordner ein.

   • Um die Standardvorlage GitHub Snowflake Native App URL zu übernehmen, wählen Sie Enter.

5. 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 im Fensterbereich der NATIVE APP ausgewählte Anwendung verwendet. Wenn mehrere Snowflake Native App-Anwendungen verfügbar sind, erscheint eine Eingabeaufforderung und Sie können auswählen, welche snowflake.yml Datei für die Bereitstellung verwendet werden soll.

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.

1. Wählen Sie eine der folgenden Optionen aus:

   • Wählen Sie im Bereich VS-Code-Erweiterung NATIVE APP die Option Run (deploy and re-install). Dies ist die empfohlene Option, wenn Sie erhebliche Änderungen vorgenommen haben und ein Anwendungsobjekt erforderlich ist.

   • Wählen Sie im Bereich VS-Code-Erweiterung NATIVE APP die Option Deploy. Dies ist die empfohlene Option, wenn Sie Anwendungspakete und Stagingbereiche bereitstellen und ein Anwendungsobjekt nicht erforderlich ist.

2. Optional. Wählen Sie die Registerkarte OUTPUT im Bereich der Abfrageergebnisse, um den Fortschritt der Bereitstellung anzuzeigen.

3. Wählen Sie im Bereich NATIVE APP die Option Open.

Status der Anwendungsobjekte der Snowflake Native App anzeigen¶

• Erweitern Sie im Bereich VS-Code-Erweiterung NATIVE APP Ihre Anwendung.

  Eine blaue Schrift und ein blauer Kreis zeigen an, dass das Anwendungsobjekt nicht installiert oder bereitgestellt wurde.

Ansicht des Snowflake Environment Variables Manager¶

Verwenden Sie den Snowflake Environment Variables Manager, um Umgebungsvariablen in Umgebungsvariablenprofilen zu erstellen und zu verwalten. Sie können ein Umgebungsvariablenprofil verwenden, um das Objektverhalten in Snowflake Native App Projektdefinitionsdateien anzupassen. Sie können zum Beispiel Profile für Umgebungsvariablen erstellen, die die Verhaltensweise von Objekten in Entwicklungs-, Stagingbereich- und Produktionsumgebungen ändern. Weitere Informationen über Umgebungsvariablen und Snowflake-Verbindungen finden Sie unter Projektdefinitionsdateien.

Verwenden Sie eine der folgenden Methoden, um den Snowflake Environment Variables Manager anzuzeigen:

• Wählen Sie im Bereich VS-Code-Erweiterung NATIVE APP die Option Environment Variables.

• Wählen Sie in der Befehlspalette Open Environment Variables Manager.

Eine Umgebungsvariable zu einem Umgebungsvariablenprofil hinzufügen¶

Ein Umgebungsvariablenprofil speichert Umgebungsvariablen.

1. Wählen Sie im Bereich VS-Code-Erweiterung NATIVE APP die Option Environment Variables.

2. Wählen Sie in der Liste Selected Profile ein Profil aus.

3. Geben Sie in der Spalte Environment Variable eine Umgebungsvariable ein.

4. Geben Sie in der Spalte Value einen Wert für die Umgebungsvariable ein.

5. Optional: Um weitere Umgebungsvariablen zum Umgebungsvariablenprofil hinzuzufügen, wiederholen Sie die Schritte 3 und 4.

6. Optional: Um dem Umgebungsvariablenprofil weitere Zeilen hinzuzufügen, wählen Sie + (Add Row).

Fügen Sie ein Umgebungsvariablenprofil hinzu¶

Ein Umgebungsvariablenprofil speichert Umgebungsvariablen. Um das Objektverhalten in Snowflake Native App-Projektdefinitionsdateien anzupassen, erstellen Sie ein neues Profil.

1. Wählen Sie im Bereich VS-Code-Erweiterung NATIVE APP die Option Environment Variables.

2. Wählen Sie Add Profile aus.

3. Geben Sie einen Namen für das Profil ein, und drücken Sie dann Enter.

Eine Zeile zu einem Umgebungsvariablenprofil hinzufügen¶

Um eine Umgebungsvariable hinzuzufügen, fügen Sie dem Umgebungsvariablenprofil eine Zeile hinzu.

1. Wählen Sie im Bereich VS-Code-Erweiterung NATIVE APP die Option Environment Variables.

2. Wählen Sie ein Profil aus der Liste Selected Profile.

3. Wählen Sie + (Add Row) aus.

Umbenennen eines Umgebungsvariablenprofils¶

1. Wählen Sie im Bereich VS-Code-Erweiterung NATIVE APP die Option Environment Variables.

2. Wählen Sie ein Profil aus der Liste Selected Profile.

3. Wählen Sie Rename Profile aus.

4. Geben Sie einen Namen für das Profil ein, und drücken Sie dann Enter.

Ein Umgebungsvariablenprofil löschen¶

1. Wählen Sie im Bereich VS-Code-Erweiterung NATIVE APP die Option Environment Variables.

2. Wählen Sie ein Profil aus der Liste Selected Profile.

3. Wählen Sie Delete Profile aus.

Snowflake Native App Debug-Modus aktivieren¶

Verwenden Sie den Debug-Modus, um Anwendungsobjekte anzuzeigen, die für Verbraucher nicht sichtbar sind, wie z. B. gemeinsam genutzte 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.

• Wählen Sie im Bereich VS-Code-Erweiterung NATIVE APP die Option App Debug Mode: OFF.

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.

• Wählen Sie im Bereich VS-Code-Erweiterung NATIVE APP die Option Teardown. Wenn die Löschung abgeschlossen ist, wird eine Bestätigungsmeldung.

Alle Dateien eines Stagingbereichs auflisten¶

1. Navigieren Sie im VS-Code OBJECT EXPLORER zu einem Stagingbereich.

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

1. Navigieren Sie im VS-Code OBJECT EXPLORER zu einem Stagingbereich, und wählen Sie Upload ().

2. Geben Sie optionale 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, und wählen Sie dann eine oder mehrere Dateien aus und laden Sie sie hoch.

Dateien aus einem Stagingbereich in ein lokales Dateisystem herunterladen¶

1. Navigieren Sie im VS-Code OBJECT EXPLORER zu einem Stagingbereich.

2. Wählen Sie Download (), um alle Dateien herunterzuladen, oder erweitern Sie den Stagingbereich.

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

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

Dateien aus einem Stagingbereich entfernen¶

Siehe auch REMOVE.

1. Navigieren Sie im VS-Code OBJECT EXPLORER zu einem Stagingbereich.

2. Wählen Sie eine Datei aus.

3. Wählen Sie Remove () aus.

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.

Einstellungen der VS-Code-Erweiterung ändern¶

1. Wählen Sie eine der folgenden Optionen aus:

   • Unter Windows/Linux wählen Sie File > Preferences > Settings.

   • Wählen Sie auf macOS Code > Settings > Settings.

2. Geben Sie in das Feld 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.