DESCRIBE PIPE

Beschreibt die für eine Pipe angegebenen Eigenschaften sowie die Standardwerte der Eigenschaften.

DESCRIBE kann mit DESC abgekürzt werden.

Siehe auch:

DROP PIPE, ALTER PIPE, CREATE PIPE, SHOW PIPES

Syntax

DESC[RIBE] PIPE <name>
Copy

Parameter

name

Gibt den Bezeichner für die zu beschreibende Pipe an. Wenn der Bezeichner Leerzeichen oder Sonderzeichen enthält, muss die gesamte Zeichenfolge in doppelte Anführungszeichen gesetzt werden. Bei Bezeichnern, die in doppelte Anführungszeichen eingeschlossen sind, ist auch die Groß- und Kleinschreibung zu beachten.

Nutzungshinweise

  • Gibt nur Ergebnisse für den Pipe-Eigentümer (d. h. die Rolle mit der Berechtigung OWNERSHIP für die Pipe), für eine Rolle mit der Berechtigung MONITOR oder OPERATE für die Pipe oder für eine Rolle mit der Berechtigung MONITOR EXECUTION für die Pipe zurück.

  • Fragen Sie die Funktion SYSTEM$PIPE_STATUS ab, um den aktuellen Status einer Pipe zu ermitteln.

  • Um die Ausgabe dieses Befehls nachzubearbeiten, können Sie den Befehl Pipe-Operator (->>) oder die RESULT_SCAN-Funktion verwenden. Beide Konstrukte behandeln die Ausgabe als Resultset, das Sie abfragen können.

    Sie können zum Beispiel den Pipe-Operator oder die RESULT_SCAN-Funktion verwenden, um bestimmte Spalten aus der SHOW-Befehlsausgabe auszuwählen oder die Zeilen zu filtern.

    Wenn Sie sich auf die Ausgabespalten beziehen, verwenden Sie Bezeichner mit doppelten Anführungszeichen für die Spaltennamen. Um beispielsweise die Ausgabespalte type auszuwählen, geben Sie SELECT "type" an.

    Sie müssen Bezeichner in doppelten Anführungszeichen verwenden, da die Ausgabespaltennamen für SHOW-Befehle in Kleinbuchstaben geschrieben sind. Die doppelten Anführungszeichen stellen sicher, dass die Spaltennamen in der SELECT-Liste oder WHERE-Klausel den Spaltennamen in der SHOW-Befehlsausgabe entsprechen, die gescannt wurde.

Ausgabe

Die Befehlsausgabe stellt Eigenschaften und Metadaten der Pipe in den folgenden Spalten bereit:

| created_on | name | database_name | schema_name | definition | owner | notification_channel | comment | integration | pattern | error_integration | invalid_reason | kind |
Copy

Spalte

Beschreibung

created_on

Datum und Uhrzeit der Erstellung der Pipe.

name

The name of the pipe object.

Manuell erstellte Pipes: Dies ist der in der CREATE PIPE-Anweisung definierte Name.

Standard-Pipe (Snowpipe Streaming, High-Performance): Der Wert wird vom Namen der Zieltabelle abgeleitet, zum Beispiel: MY_TABLE-STREAMING.

database_name

Der Name der Datenbank, die das Snowpipe-Objekt enthält.

Manuell erstellte Pipe: Der Name der Datenbank, zu der das Pipe-Objekt gehört.

Standard-Pipe (Snowpipe Streaming, High-Performance): Der Name der Datenbank der Zieltabelle.

schema_name

Der Name des Schemas, das das Snowpipe-Objekt enthält.

Manuell erstellte Pipe: Der Name des Schemas, zu dem das Pipe-Objekt gehört.

Standard-Pipe: Der Name des Schemas der Zieltabelle.

definition

COPY statement that is used to load data from queued files into a Snowflake table.

owner

The name of the role that possesses the OWNERSHIP privilege on the pipe object.

Benannte Pipe: Der Name der Rolle, der die Pipe gehört, d. h. die Rolle, die in der CREATE PIPE-Anweisung angegeben ist oder der später die Eigentümerschaft gewährt wird.

Standard-Pipe (Snowpipe Streaming, High-Performance): Diese Spalte zeigt NULL an.

notification_channel

Amazon Resource Name of the Amazon SQS queue for the stage that is named in the DEFINITION column.

comment

Eine vom Benutzenden bereitgestellte oder vom System generierte Textzeichenfolge, die das Pipe-Objekt beschreibt.

Benannte Pipe: Der benutzerdefinierte Kommentar, der im Rahmen der CREATE PIPE-Anweisung angegeben wird.

Standard-Pipe (Snowpipe Streaming, High-Performance): Eine vom System generierte Zeichenfolge, die immer die folgenden Sätze enthält: „Default pipe for Snowpipe Streaming High Performance ingestion to a table. Created and managed by Snowflake.“

integration

Name der Benachrichtigungsintegration für Pipes, die auf Benachrichtigungsereignisse angewiesen sind, um das Laden von Daten von Google Cloud Storage oder Microsoft Azure-Cloudspeicher auszulösen.

pattern

Wert der PATTERN-Kopieroption in der COPY INTO <Tabelle>-Anweisung der Pipedefinition, wenn die Kopieroption angegeben wurde.

error_integration

Name der Benachrichtigungsintegration für Pipes, die auf Fehlerereignisse im Amazon S3-Cloudspeicher angewiesen sind, um Benachrichtigungen auszulösen.

invalid_reason

Zeigt einige Detailinformationen zu Ihren Pipes an, bei denen möglicherweise Probleme auftreten. Sie können die bereitgestellten Informationen nutzen, um Probleme mit Ihren Pipes zusammen mit SYSTEM$PIPE_STATUS effektiver zu verwalten. Wenn es keine Probleme mit der Pipe gibt, ist der Wert NULL.

kind

Die Art der Pipe, die STAGE ist.

Kafka-bezogene Spalten

Spalte

Beschreibung

broker_integration

Name der mit Kafka verwendeten Integration für den externen Zugriff.

broker_secret

Name des mit Kafka verwendeten Geheimnisses.

row_format

Zeilenformat der Datensätze: JSON oder AVRO.

schema

Schema der als Variante dargestellten Datensätze.

topic

Name eines synchronisierten Themas.

Beispiele

Beschreiben Sie die Pipe mypipe, die in den Beispielen unter CREATE PIPE erstellt wurde:

desc pipe mypipe;

+-------------------------------+--------+---------------+-------------+---------------------------------+----------+---------+
| created_on                    | name   | database_name | schema_name | definition                      | owner    | comment |
|-------------------------------+--------+---------------+-------------+---------------------------------+----------+---------|
| 2017-08-15 06:11:05.703 -0700 | MYPIPE | MYDATABASE    | PUBLIC      | copy into mytable from @mystage | SYSADMIN |         |
+-------------------------------+--------+---------------+-------------+---------------------------------+----------+---------+
Copy