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 fonction RESULT_SCAN qui traite la sortie comme une table qui peut être interrogé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`	Nom du canal.
`database_name`	Base de données dans laquelle le canal est stocké.
`schema_name`	Schéma dans lequel le canal est stocké.
`definition`	Instruction COPY utilisée pour charger des données à partir de fichiers en file d’attente dans une table Snowflake.
`owner`	Nom du rôle qui possède le canal (c’est-à-dire qui dispose du privilège OWNERSHIP sur le canal).
`notification_channel`	Nom de la ressource Amazon de la file d’attente SQS d’Amazon pour la zone de préparation nommée dans la colonne DEFINITION.
`comment`	Commentaire pour ce canal.
`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