Verwenden von SnowSQL¶

Definieren von Variablen¶

Sie können Variablen für SnowSQL auf verschiedene Weise definieren:

• Definieren von Variablen vor dem Verbinden (Konfigurationsdatei)

• Definieren von Variablen beim Verbinden (Befehlszeilenflag -D oder --variable)

• Definieren von Variablen innerhalb einer Sitzung (Befehl !define)

Aktivieren der Variablensubstitution¶

Damit SnowSQL-Werte für die Variablen ersetzen kann, müssen Sie die Konfigurationsoption variable_substitution auf eine der folgenden Arten auf true setzen:

• Um diese Option vor dem Start von SnowSQL einzustellen, öffnen Sie die SnowSQL-Konfigurationsdatei in einem Texteditor und stellen diese Option im Abschnitt [options] ein:

  [options]
  variable_substitution = True
  

  Copy

• Um diese Option beim Start von SnowSQL festzulegen, geben Sie das Befehlszeilenflag -o an:

  $ snowsql ... -o variable_substitution=true
  

  Copy

• Um diese Option in einer SnowSQL-Sitzung zu aktivieren, führen Sie den Befehl !set in der Sitzung aus:

  user#> !set variable_substitution=true
  

  Copy

  Bemerkung

  Es gibt derzeit keine Option wie unset, mit der ein Optionswert wie variable_substitution rückgängig gemacht werden kann. Wenn Sie die Variablensubstitution deaktivieren müssen, führen Sie den Befehl !set variable_substitution=false aus.

Ersetzen von Variablen in einer Sitzung¶

Nachdem Sie die Variablensubstitution aktiviert haben, können Sie Variablen in SQL-Anweisungen verwenden.

Um eine Variable in einer Anweisung zu verwenden, verwenden Sie die Syntax &variable_name. Beachten Sie, dass bei Variablennamen die Groß- und Kleinschreibung nicht beachtet wird. Beispiel:

user#> !define snowshell=bash

user#> !set variable_substitution=true

user#> select '&snowshell';

+--------+
| 'BASH' |
|--------|
| bash   |
+--------+

Copy

Wenn die Option variable_substitution nicht aktiviert ist, erfolgt keine Variablenersetzung. Beispiel:

user#> !define snowshell=bash

user#> !set variable_substitution=false

user#> select '&snowshell';

+--------------+
| '&SNOWSHELL' |
|--------------|
| &snowshell   |
+--------------+

Copy

Wenn Sie auf eine Variable verweisen, die nicht definiert wurde, zeigt SnowSQL einen Fehler an. Beispiel:

select '&z';

Variable z is not defined

Copy

Um eine Variable mit Text zu kombinieren, schließen Sie die Variablenreferenz in geschweifte Klammern ein. Beispiel:

user#> !define snowshell=bash

user#> !set variable_substitution=true

select '&{snowshell}_shell';

+--------------+
| 'BASH_SHELL' |
|--------------|
| bash_shell   |
+--------------+

Copy

Um ein kaufmännisches Und-Zeichen ohne Ersetzung zu verwenden, schließen Sie das kaufmännische Und-Zeichen mit einem zweiten kaufmännischen Und-Zeichen als Escapezeichen ein:

&&variable

Beispiel:

user#> !set variable_substitution=true

user#> select '&notsubstitution';

Variable notsubstitution is not defined

user#> select '&&notsubstitution';

+--------------------+
| '&NOTSUBSTITUTION' |
|--------------------|
| &notsubstitution   |
+--------------------+

Copy

Auflisten von Variablen¶

Um Variablen aufzulisten, führen Sie den Befehl !variables oder !vars in der Sitzung aus:

user#> !variables

+-----------+-------+
| Name      | Value |
|-----------+-------|
| snowshell | bash  |
+-----------+-------+

Copy

Verwenden von integrierten Variablen¶

SnowSQL enthält einen Satz integrierter Variablen, die Metadaten über Anweisungen zurückgeben, die in der aktuellen Benutzersitzung ausgeführt wurden.

Jeder dieser Variablennamen beginnt mit zwei Unterstrichzeichen („__“).

__rowcount

Gibt die Anzahl der Zeilen zurück, die von der zuletzt vom Benutzer ausgeführten DML-Anweisung betroffen sind.

user#> insert into a values(1),(2),(3);

+-------------------------+
| number of rows inserted |
|-------------------------|
|                       3 |
+-------------------------+
3 Row(s) produced. Time Elapsed: 0.950s

user#> !set variable_substitution=true

user#> select &__rowcount;

+---+
| 3 |
|---|
| 3 |
+---+

Copy

__sfqid

Gibt die Abfrage-ID für die zuletzt vom Benutzer ausgeführte Abfrage zurück.

user#> !set variable_substitution=true

user#> select * from a;

user#> select '&__sfqid';

+----------------------------------------+
| 'A5F35B56-49A2-4437-BA0E-998496CE793E' |
|----------------------------------------|
| a5f35b56-49a2-4437-ba0e-998496ce793e   |
+----------------------------------------+

Copy

Verlaufsdatei¶

Die interaktive Befehlszeilenprotokolldatei hat den Namen history und befindet sich in ~/.snowsql/history.

Ausführen beim Verbinden (Verbindungsparameter -f)¶

Um ein SQL-Skript während des Verbindens mit Snowflake auszuführen, verwenden Sie den Verbindungsparameter -f <Eingabedateiname>.

Eine Ausgabedatei für das Skript kann mit -o output_file=<Ausgabedateiname> angegeben werden. Darüber hinaus können Sie mit -o quiet=true die Standardausgabe und mit -o friendly=false die Start- und Endemeldungen deaktivieren.

Beispiel:

snowsql -a myorganization-myaccount -u jsmith -f /tmp/input_script.sql -o output_file=/tmp/output.csv -o quiet=true -o friendly=false -o header=false -o output_format=csv

Copy

Weitere Informationen zu allen Verbindungsparametern finden Sie unter Übersicht der Verbindungsparameter.

Ausführen in einer Sitzung (Befehl !source oder !load)¶

Um ein SQL-Skript nach dem Verbinden mit Snowflake auszuführen, führen Sie den Befehl !source (oder !load) in der Sitzung aus.

Beispiel:

user#> !source example.sql

Copy

Unterstützte Token¶

SnowSQL unterstützt die folgenden Objekttypen als Token:

• user

• account

• role

• database

• schema

• warehouse

Standardeingabeaufforderung¶

Die Standardeingabeaufforderung von SnowSQL verwendet die folgenden Token und Strukturen:

[user]#[warehouse]@[database].[schema]>

Copy

Beispiel:

jdoe#DATALOAD@BOOKS_DB.PUBLIC>

Copy

Beispiel für Eingabeaufforderung¶

In Fortsetzung des obigen Beispiels fügt der folgende !set-Befehl, der in der Befehlszeile ausgeführt wird, das Rollentoken hinzu und ändert die Tokenreihenfolge in user und role, database und schema, dann warehouse. Er ändert auch das Trennzeichen für jedes Token in einen Punkt (.) und setzt die Token so, dass sie verschiedene Farben verwenden:

jdoe#DATALOAD@BOOKS_DB.PUBLIC> !set prompt_format=[#FF0000][user].[role].[#00FF00][database].[schema].[#0000FF][warehouse]>

Copy

Dieses Beispiel führt zu der folgenden Eingabeaufforderung für die Sitzung:

Exitcodes¶

Es gibt mehrere mögliche Exitcodes, die zurückgegeben werden, wenn SnowSQL beendet wird:

0

Alles lief reibungslos.

1

Es gab ein Problem mit dem Client.

2

Es gab ein Problem mit den Befehlszeilenargumenten.

3

SnowSQL konnte den Server nicht kontaktieren.

4

SnowSQL konnte nicht ordnungsgemäß mit dem Server kommunizieren.

5

Die Konfigurationsoption exit_on_error wurde gesetzt und SnowSQL wegen eines Fehlers beendet.

!abort¶

Bricht eine Abfrage (spezifiziert durch die Abfrage-ID) ab. Die Abfrage-ID kann von der Seite History der Weboberfläche abgerufen werden.

Beispiel:

user#> !abort 77589bd1-bcbf-4ec8-9ebc-6c949b00614d;

Copy

!connect¶

SnowSQL unterstützt mehrere Sitzungen (d. h. Verbindungen) mit !connect <Verbindungsname>:

• Die mit connection_name im Zusammenhang stehenden Verbindungsparameter und Optionen werden in der SnowSQL-Konfigurationsdatei im zugehörigen Abschnitt [connections.<Verbindungsname>] gespeichert.

• Wenn im Abschnitt [connections.<Verbindungsname>] weder Parameter noch Option angegeben sind, werden für die nicht spezifizierten Parameter standardmäßig die unter [connections] angegebenen Parameterwerte verwendet.

Beim Verbinden wird die Verbindung zu Ihrem Verbindungsstack hinzugefügt, und beim Beenden kehren Sie zu Ihrer vorherigen Verbindung zurück. Beim Verlassen werden alle Ihre Verbindungen geschlossen, egal wie viele Verbindungen Sie haben.

Beispiel:

Konfigurationsdatei:

[connections.my_example_connection]
...

Copy

Befehlszeile:

user#> !connect my_example_connection

Copy

!define¶

Setzt eine Variable auf einen bestimmten Wert, wobei das folgende Format verwendet wird:

!define <Variablenname>=<Variablenwert>

Name und Wert müssen durch ein einzelnes = ohne Leerzeichen getrennt werden. Gültige Zeichen, die in der Variable verwendet werden können, sind:

0-9a-zA-Z\_

Weitere Informationen zum Definieren und Verwenden von Variablen finden Sie unter Verwenden von Variablen.

!edit¶

Öffnet den Editor, der mit dem Verbindungsparameter editor eingestellt wurde (wenn kein Editor eingestellt wurde, ist die Voreinstellung vim). Der Befehl akzeptiert eine Abfrage als Argument. Wenn kein Argument übergeben wird, wird die zuletzt ausgeführte Abfrage geöffnet.

!exit, !disconnect¶

Löscht die aktuelle Verbindung. Wenn es sich um die letzte Verbindung handelte, wird auch SnowSQL beendet.

!help, !helps, !h¶

Zeigt die Hilfe zu SnowSQL-Befehlen an.

!options, !opts¶

Gibt eine Liste aller Konfigurationsoptionen von SnowSQL mit deren aktuellen Werten zurück. Diese Optionen können mit dem Befehl !set in der aktuellen SnowSQL-Sitzung eingestellt werden.

!pause¶

Hält aktive Abfragen an. Drücken Sie die Eingabetaste, um fortzufahren.

!print¶

Gibt den angegebenen Text auf dem Bildschirm und in alle Dateien aus, auf die Sie gerade zugreifen.

Beispiel:

user#> !print Include This Text

Copy

!queries¶

Listet alle Abfragen auf, die den angegebenen Filtern entsprechen. Die Standardfilter sind session und amount=25, die die letzten 25 Abfragen der aktuellen Sitzung zurückgeben.

Beispiel:

• Liefert die letzten 25 Abfragen, die in der aktuellen Sitzung ausgeführt wurden:

  !queries session
  

  Copy

• Liefert die letzten 20 Abfragen, die im Kontos ausgeführt wurden:

  !queries amount=20
  

  Copy

• Liefert die letzten 20 Abfragen, die im Konto ausgeführt wurden und länger als 200 Millisekunden gedauert haben:

  !queries amount=20 duration=200
  

  Copy

• Liefert die letzten 25 Abfragen, die im angegebenen Warehouse ausgeführt wurden:

  !queries warehouse=mywh
  

  Copy

Dieser Befehl erstellt eine Variable für jede zurückgegebene Abfrage ID. Beachten Sie, dass die Variablenersetzung aktiviert sein muss, damit Sie diese Variablen verwenden können. Beispiel:

user#> !queries session

+-----+--------------------------------------+----------+-----------+----------+
| VAR | QUERY ID                             | SQL TEXT | STATUS    | DURATION |
|-----+--------------------------------------+----------+-----------+----------|
| &0  | acbd6778-c68c-4e79-a977-510b2d8c08f1 | select 1 | SUCCEEDED |       19 |
+-----+--------------------------------------+----------+-----------+----------+

user#> !result &0

+---+
| 1 |
|---|
| 1 |
+---+

user#> !result acbd6778-c68c-4e79-a977-510b2d8c08f1

+---+
| 1 |
|---|
| 1 |
+---+

Copy

!quit, !q (auch CTRL + d)¶

Löscht alle Verbindungen und beendet SnowSQL.

!rehash¶

Synchronisiert die Auto-Vervollständigungs-Token neu.

Für den normalen Gebrauch ist keine Neusynchronisierung der Auto-Vervollständigungs-Token erforderlich. Das Erzwingen einer Aktualisierung der serverseitigen Token kann jedoch in bestimmten Szenarien sinnvoll sein (z. B. wenn in einer anderen Sitzung eine neue benutzerdefinierte Funktion erstellt wird).

!result¶

Gibt das Ergebnis einer abgeschlossenen Abfrage zurück (spezifiziert durch die Abfrage-ID). Abfrage-IDs können von der Seite History der Weboberfläche oder mit dem Befehl !queries abgerufen werden.

Wenn die Abfrage noch ausgeführt wird, wartet der Befehl, bis die Abfrage abgeschlossen ist.

Beispiel:

user#> !result 77589bd1-bcbf-4ec8-9ebc-6c949b00614d;

Copy

!set¶

Setzt die angegebene Konfigurationsoption von SnowSQL auf einen bestimmten Wert unter Verwendung der Form <Option>=<Wert>.

Beachten Sie, dass es derzeit keine Option wie unset gibt, mit der ein Optionswert rückgängig gemacht werden kann. Um den Wert einer Option zu ändern, führen Sie den Befehl !set erneut mit dem gewünschten Wert aus.

Beispiel:

user#> !options

+-----------------------+-------------------+
| Name                  | Value             |
|-----------------------+-------------------|
 ...
| rowset_size           | 1000              |
 ...
+-----------------------+-------------------+

user#> !set rowset_size=500

user#> !options

+-----------------------+-------------------+
| Name                  | Value             |
|-----------------------+-------------------|
 ...
| rowset_size           | 500               |
 ...
+-----------------------+-------------------+

user#> !set rowset_size=1000

user#> !options

+-----------------------+-------------------+
| Name                  | Value             |
|-----------------------+-------------------|
 ...
| rowset_size           | 1000              |
 ...
+-----------------------+-------------------+

Copy

!source, !load¶

Führt SQL aus einer Datei aus. Sie können SQL aus lokalen Dateien oder über eine URL aufrufen.

Beispiel:

user#> !source example.sql

user#> !load /tmp/scripts/example.sql

user#> !load http://www.example.com/sql_text.sql

Copy

!spool¶

Dieser Befehl kann auf zwei Arten ausgeführt werden:

• Aktivieren Sie das Spooling, und schreiben Sie die Ergebnisse aller nachfolgenden Anweisungen/Abfragen in die angegebene Datei:

  !spool <Dateiname>

• Deaktivieren Sie das Spooling von Ergebnissen (wenn es aktiviert ist):

  !spool off

Beispiel:

user#> select 1 num;

+-----+
| NUM |
|-----|
|   1 |
+-----+

user#> !spool /tmp/spool_example

user#> select 2 num;

+---+
| 2 |
|---|
| 2 |
+---+

user#> !spool off

user#> select 3 num;

+---+
| 3 |
|---|
| 3 |
+---+

user#> !exit

Goodbye!

$ cat /tmp/spool_example

+---+
| 2 |
|---|
| 2 |
+---+

Copy

Sie können das Ausgabeformat ändern, indem Sie zuerst den Befehl !set output_format=<Format> ausführen. Die Option unterstützt die folgenden Werte:

• expanded

• fancy_grid

• grid

• html

• latex

• latex_booktabs

• mediawiki

• orgtbl

• pipe

• plain

• psql

• rst

• simple

• tsv

Empfohlener Wert: psql, fancy_grid oder grid

Beispiel für die Ausgabe im CSV-Format:

user#> !set output_format=csv

user#> !spool /tmp/spool_example

Copy

!system¶

Führt einen Shell-Befehl aus.

!system <Befehl>

Das folgende Beispiel führt den Befehl ls im Stammverzeichnis des Benutzers aus:

user#> !system ls ~

Copy

!variables, !vars¶

Listet alle aktuellen Variablen auf. Gibt jedes aktuell definierte <Variablenname>=<Variablenwert>-Paar zurück.

Sobald eine Variable zugewiesen wurde, kann sie nicht mehr gelöscht werden, aber ihr Wert kann durch Angabe des Variablennamens ohne Wert entfernt werden. Beispiel:

user#> !set variable_substitution=true

user#> !define SnowAlpha=_ALPHA_

user#> !variables

+------------------+---------+
| Name             | Value   |
|------------------+---------|
| snowalpha        | _ALPHA_ |
+------------------+---------+

user#> !define SnowAlpha

user#> !variables

+------------------+-------+
| Name             | Value |
|------------------+-------|
| snowalpha        |       |
+------------------+-------+

user#> !define snowalpha=456

user#> select &snowalpha;

+-----+
| 456 |
|-----|
| 456 |
+-----+

Copy

Weitere Informationen zum Festlegen von Variablen finden Sie unter Verwenden von Variablen (unter diesem Thema).

Fehlermeldung: Variable is not defined¶

Ursache

Wenn beim Ausführen von Befehle in SnowSQL diese Fehlermeldung angezeigt wird, könnte die Ursache ein kaufmännisches Und (&) innerhalb eines CREATE FUNCTION-Befehls sein. (Das kaufmännische Und ist das Variablen-Ersatzzeichen in SnowSQL). Die Ausführung des folgenden Befehls in SnowSQL führt beispielsweise zu diesem Fehler:

create function mask_bits(...)
    ...
    as
    $$
    var masked = (x & y);
    ...
    $$;

Copy

Der Fehler tritt auf, wenn die Funktion erstellt wird, nicht wenn sie aufgerufen wird.

Lösung

Wenn Sie die Variablenersetzung in SnowSQL nicht verwenden möchten, können Sie diese mit folgendem Befehl explizit deaktivieren:

!set variable_substitution=false;

Copy

Weitere Informationen zur Variablenersetzung finden Sie unter Verwenden von Variablen.