DESCRIBE PIPE¶

Décrit les propriétés spécifiées pour un canal, ainsi que les valeurs par défaut des propriétés.

DESCRIBE peut être abrégé en DESC.

Voir aussi :: DROP PIPE , ALTER PIPE , CREATE PIPE , SHOW PIPES

Syntaxe¶

DESC[RIBE] PIPE <name>

Copy

Paramètres¶

name: Spécifie l’identificateur du canal à décrire. Si l’identificateur contient des espaces ou des caractères spéciaux, toute la chaîne doit être délimitée par des guillemets doubles. Les identificateurs entre guillemets doubles sont également sensibles à la casse.

Notes sur l’utilisation¶

Renvoie les résultats uniquement pour le propriétaire du canal (c’est-à-dire le rôle avec le privilège OWNERSHIP sur le canal), un rôle avec le privilège MONITOR ou OPERATE sur le canal, ou un rôle disposant du privilège global MONITOR EXECUTION.
Pour déterminer le statut actuel d’un canal, interrogez la fonction SYSTEM$PIPE_STATUS.

Pour post-traiter la sortie de cette commande, vous pouvez utiliser la syntaxe opérateur de canal (->>) ou la fonction RESULT_SCAN. Les deux constructions traitent la sortie comme un jeu de résultats que vous pouvez interroger.

For example, you can use the pipe operator or RESULT_SCAN function to select specific columns from the SHOW command output or filter the rows.

When you refer to the output columns, use double-quoted identifiers for the column names. For example, to select the output column type, specify SELECT "type".

You must use double-quoted identifiers because the output column names for SHOW commands are in lowercase. The double quotes ensure that the column names in the SELECT list or WHERE clause match the column names in the SHOW command output that was scanned.

Sortie¶

La sortie de commande fournit les propriétés des canaux et les métadonnées dans les colonnes suivantes :

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

Copy

Colonne	Description
`created_on`	Date et heure de création du canal.
`name`	The name of the pipe object. Manually created pipes: This is the name defined in the CREATE PIPE statement. Default pipe (Snowpipe Streaming high-performance): The value is derived from the target table name; for example, MY_TABLE-STREAMING.
`database_name`	The name of the database that contains the Snowpipe object. Manually created pipe: The name of the database that the pipe object belongs to. Default pipe (Snowpipe Streaming high-performance): The name of the target table’s database.
`schema_name`	The name of the schema that contains the Snowpipe object. Manually created pipe: The name of the schema that the pipe object belongs to. Default pipe: The name of the target table’s schema.
`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. Named pipe: The name of the role that owns the pipe, which is the role specified in the CREATE PIPE statement or granted ownership later. Default pipe (Snowpipe Streaming high-performance): This column displays NULL.
`notification_channel`	Amazon Resource Name of the Amazon SQS queue for the stage that is named in the DEFINITION column.
`comment`	A user-provided or system-generated text string that describes the pipe object. Named pipe: The user-defined comment that is provided during the CREATE PIPE statement. Default pipe (Snowpipe Streaming High-Performance): A system-generated string that is always the following sentences: « Default pipe for Snowpipe Streaming High Performance ingestion to a table. Created and managed by Snowflake. »
`integration`	Nom de l’intégration de notification pour les canaux qui s’appuient sur des événements de notification pour déclencher des chargements de données à partir du stockage dans le Cloud de Google Cloud Storage ou Microsoft Azure.
`pattern`	La valeur de l’option de copie PATTERN dans l’instruction COPY INTO <table> de la définition du canal, si l’option de copie a été spécifiée.
`error_integration`	Nom de l’intégration des notifications pour les canaux qui s’appuient sur les événements d’erreur dans le stockage Cloud Amazon S3 pour déclencher des notifications.
`invalid_reason`	Affiche des informations détaillées sur les canaux susceptibles de présenter des problèmes. Vous pouvez utiliser les informations fournies pour dépanner plus efficacement vos canaux avec SYSTEM$PIPE_STATUS. S’il n’y a pas de problème avec le canal, la valeur est NULL.
`kind`	Le type de canal, qui est STAGE.

Colonnes reliées à Kafka

Colonne	Description
`broker_integration`	Nom de l’intégration d’accès externe utilisée avec Kafka.
`broker_secret`	Nom du secret utilisé avec Kafka.
`row_format`	Format de ligne des enregistrements : `JSON` ou `AVRO`.
`schema`	Schéma d’enregistrements représentés comme variante.
`topic`	Nom d’une rubrique synchronisée.

Exemples¶

Décrire le canal mypipe créé dans les exemples dans CREATE PIPE :

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