Describe Window

The DESCRIBE WINDOW command is used to obtain the properties of an existing window in RioDB.

Access Rule

Requires any role.

Syntax

DESCRIBE WINDOW <window name>;

Example

DESCRIBE WINDOW last_10_bids;

Output: A JSON formatted description of the window properties.

Sample output:

{
  "status": 200,
  "statements": 1,
  "milliseconds": 1,
  "details": [
    {
      "statement": 1,
      "response": {
        "name": "last_10_bids",
        "steam": "my_bench_stream",
        "field": "bid",
        "running": [
          "avg",
          "count",
          "count_distinct",
          "max",
          "min",
          "stddev_pop"
        ],
        "range_by": "quantity",
        "range": 10
      }
    }
  ]
}