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.

    Por exemplo, é possível usar o operador de canal ou a função RESULT_SCAN para selecionar colunas específicas da saída do comando SHOW ou filtrar as linhas.

    Quando você fizer referência a colunas de saída, use identificadores entre aspas duplas para os nomes das colunas. Por exemplo, para selecionar a coluna de saída type, especifique SELECT "type".

    Você deve usar identificadores entre aspas duplas porque os nomes das colunas de saída para os comandos SHOW estão em minúsculas. As aspas duplas garantem que os nomes das colunas na lista SELECT ou na cláusula WHERE correspondam aos nomes das colunas na saída do comando SHOW que foi verificada.

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

The name of the pipe object.

Canais criados manualmente: esse é o nome definido na instrução CREATE PIPE.

Canal padrão (alto desempenho do Snowpipe Streaming): o valor é derivado do nome da tabela de destino; por exemplo, MY_TABLE-STREAMING.

database_name

O nome do banco de dados com o objeto Snowpipe.

Canal criado manualmente: o nome do banco de dados ao qual pertence o objeto de canal.

Canal padrão (alto desempenho do Snowpipe Streaming): o nome do banco de dados da tabela de destino.

schema_name

O nome do esquema com o objeto Snowpipe.

Canal criado manualmente: o nome do esquema ao qual pertence o objeto de canal.

Canal padrão: o nome do esquema da tabela de destino.

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 nomeado: o nome da função proprietária do canal, que é a função especificada na instrução CREATE PIPE ou a propriedade concedida posteriormente.

Canal padrão (alto desempenho do Snowpipe Streaming): essa coluna mostra NULL.

notification_channel

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

comment

Uma cadeia de caracteres de texto fornecida pelo usuário ou gerada pelo sistema que descreve o objeto de canal.

Canal nomeado: o comentário definido pelo usuário que é fornecido na instrução CREATE PIPE.

Canal padrão (alto desempenho do Snowpipe Streaming): uma cadeia de caracteres gerada pelo sistema que sempre são estas frases: «Default pipe for Snowpipe Streaming High Performance ingestion to a table. Created and managed by Snowflake.»

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