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.

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.

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. 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`	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