DESCRIBE STREAM¶

Describes the properties specified for a stream.

DESCRIBE can be abbreviated to DESC.

Syntax¶

DESC[RIBE] STREAM <name>

Copy

name: Specifies the identifier for the stream 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.

To post-process the output of this command, you can use the pipe operator (->>) or the RESULT_SCAN function. Both constructs treat the output as a result set that you can query.

The output column names for this command are generated in lowercase. If you consume a result set from this command with the pipe operator or the RESULT_SCAN function, use double-quoted identifiers for the column names in the query to ensure that they match the column names in the output that was scanned. For example, if the name of an output column is type, then specify "type" for the identifier.

Create an example stream:

CREATE STREAM mystream ( ... );

Copy

Describe the columns in the stream:

DESC STREAM mystream;

Copy