Categories:

Data Loading / Unloading DDL

DESCRIBE PIPE

Describes the properties specified for a pipe, as well as the default values of the properties.

DESCRIBE can be abbreviated to DESC.

See also:

ALTER PIPE , CREATE PIPE , SHOW PIPES

Syntax

DESC[RIBE] PIPE <name>

Parameters

name

Specifies the identifier for the pipe to describe. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.

Usage Notes

  • Returns results only for the pipe owner (i.e. the role with the OWNERSHIP privilege on the pipe), a role with the MONITOR or OPERATE privilege on the pipe, or a role with the global MONITOR EXECUTION privilege.

  • To determine the current status of a pipe, query the SYSTEM$PIPE_STATUS function.

  • To post-process the output of this command, you can use the RESULT_SCAN function, which treats the output as a table that can be queried.

Examples

Describe the mypipe pipe created in the examples in 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 |         |
+-------------------------------+--------+---------------+-------------+---------------------------------+----------+---------+