Describe Stream

The DESCRIBE STREAM command is used for describing the properties of an existing stream.

Access Rule

Requires any role.

Syntax

DESCRIBE STREAM <stream name>;

Example

DESCRIBE STREAM my_udp_stream;

Output: A JSON formatted description of the stream fields.

Sample output:

{
  "status": 200,
  "statements": 1,
  "milliseconds": 1,
  "details": [
    {
      "statement": 1,
      "response": {
        "name": "my_bench_stream",
        "fields": [
          {
            "order": 0,
            "name": "symbol",
            "type": "STRING"
          },
          {
            "order": 1,
            "name": "bid",
            "type": "NUMBER"
          }
        ],
        "type": "BENCH",
        "timestamp": "clock"
      }
    }
  ]
}