DESCRIBE PIPE

Descreve as propriedades especificadas para um canal, bem como os valores padrão das propriedades.

DESCRIBE pode ser abreviado como DESC.

Consulte também:

DROP PIPE , ALTER PIPE , CREATE PIPE , SHOW PIPES

Sintaxe

DESC[RIBE] PIPE <name>
Copy

Parâmetros

name

Especifica o identificador do canal a ser descrito. Se o identificador contiver espaços ou caracteres especiais, toda a cadeia de caracteres deverá ser delimitada por aspas duplas. Os identificadores delimitados por aspas duplas também diferenciam letras maiúsculas de minúsculas.

Notas de uso

  • Retorna resultados somente para o proprietário do canal (ou seja, a função com o privilégio OWNERSHIP no canal), uma função com o privilégio MONITOR ou OPERATE no canal, ou uma função com o privilégio global MONITOR EXECUTION.

  • Para determinar o status atual de um canal, consulte a função SYSTEM$PIPE_STATUS.

  • Para pós-processar a saída deste comando, você pode usar o operador de canal (->>) ou a função RESULT_SCAN. Ambos os constructos tratam a saída como um conjunto de resultados que você pode consultar.

    Os nomes das colunas de saída para este comando são gerados em minúsculas. Se você consumir um conjunto de resultados deste comando com o operador de canal ou a função RESULT_SCAN, use identificadores entre aspas duplas para os nomes das colunas na consulta para garantir que eles correspondam aos nomes das colunas na saída que foi verificada. Por exemplo, se o nome de uma coluna de saída for type, especifique "type" para o identificador.

Saída

O comando de saída fornece propriedades de canal e metadados nas seguintes colunas:

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

Coluna

Descrição

created_on

Data e hora em que o canal foi criado.

name

Nome do canal.

database_name

Banco de dados no qual o canal é armazenado.

schema_name

Esquema no qual o canal está armazenado.

definition

Instrução COPY usada para carregar dados de arquivos em fila em uma tabela do Snowflake.

owner

Nome da função proprietária do canal (ou seja, que tem o privilégio OWNERSHIP no canal).

notification_channel

Fila do Amazon Resource Name of the Amazon SQS para o estágio nomeado na coluna DEFINITION.

comment

Comentário para este canal.

integration

Nome da integração de notificação para canais que dependem de eventos de notificação para acionar carregamentos de dados do armazenamento em nuvem do armazenamento em nuvem do Google Cloud Storage ou Microsoft Azure.

pattern

Valor da opção de cópia PATTERN na instrução COPY INTO <tabela> da definição do canal, se a opção de cópia tiver sido especificada

error_integration

Nome de integração de notificação para canais que dependem de eventos de erro no armazenamento em nuvem Amazon S3 para acionar notificações.

invalid_reason

Exibe algumas informações detalhadas para seus canais que podem ter problemas. Você pode usar as informações fornecidas para solucionar problemas de seus canais com mais eficiência com SYSTEM$PIPE_STATUS. Se não houver nenhum problema com o canal, o valor será NULL.

kind

O tipo de canal, que é STAGE.

Colunas relacionadas ao Kafka

Coluna

Descrição

broker_integration

Nome da integração de acesso externo usada com o Kafka.

broker_secret

Nome do segredo usado com o Kafka.

row_format

Formato de linha dos registros: JSON ou AVRO.

schema

Esquema de registros representados como variante.

topic

Nome de um tópico sincronizado.

Exemplos

Descrever o canal mypipe criado nos exemplos em 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
Linguagem: Português