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.

Par exemple, vous pouvez utiliser l’opérateur de canal ou la fonction RESULT_SCAN pour sélectionner des colonnes spécifiques à partir de la sortie de la commande SHOW ou pour filtrer les lignes.

Lorsque vous faites référence aux colonnes de sortie, utilisez des identificateurs entre guillemets doubles pour les noms des colonnes. Par exemple, pour sélectionner la colonne de sortie type, spécifiez SELECT "type".

Vous devez utiliser des identificateurs entre guillemets doubles, car les noms des colonnes de sortie pour les commandes SHOW sont en minuscules. Les guillemets doubles garantissent que les noms des colonnes dans la liste SELECT ou dans la clause WHERE correspondent aux noms des colonnes dans la sortie de la commande SHOW qui a été analysée.

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. Canaux créés manuellement : Nom défini dans l’instruction CREATE PIPE. Canal par défaut (Snowpipe Streaming haute performance) : La valeur est dérivée du nom de la table cible ; par exemple, MY_TABLE-STREAMING.
`database_name`	Nom de la base de données contenant l’objet Snowpipe. Canal créé manuellement : Nom de la base de données à laquelle appartient l’objet de canal. Canal par défaut (Snowpipe Streaming haute performance) : Nom de la base de données de la table cible.
`schema_name`	Nom du schéma contenant l’objet Snowpipe. Canal créé manuellement : Nom du schéma auquel appartient l’objet de canal. Canal par défaut : Nom du schéma de la table cible.
`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. Canal nommé : Nom du rôle propriétaire du canal, qui est le rôle spécifié dans l’instruction CREATE PIPE ou auquel la propriété a été attribuée ultérieurement. Canal par défaut (Snowpipe Streaming haute performance) : La colonne affiche NULL.
`notification_channel`	Amazon Resource Name of the Amazon SQS queue for the stage that is named in the DEFINITION column.
`comment`	Chaîne de texte fournie par l’utilisateur ou générée par le système qui décrit l’objet de canal. Canal nommé : Le commentaire défini par l’utilisateur qui est fourni lors de l’instruction CREATE PIPE. Canal par défaut (Snowpipe Streaming haute performance) : Une chaîne générée par le système qui est toujours la phrase suivante : « Canal par défaut pour l’ingestion de Snowpipe Streaming haute performance dans une table. Créé et géré par 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