ContextQMD
Back to Redis

TDIGEST.INFO

content/commands/tdigest.info.md

latest5.1 KB
Original Source

Returns information and statistics about a t-digest sketch.

Required arguments

<details open><summary><code>key</code></summary>

is the key name for an existing t-digest sketch.

</details>

Examples

{{< highlight bash >}} redis> TDIGEST.CREATE t OK redis> TDIGEST.ADD t 1 2 3 4 5 OK redis> TDIGEST.INFO t

  1. Compression
  2. (integer) 100
  3. Capacity
  4. (integer) 610
  5. Merged nodes
  6. (integer) 0
  7. Unmerged nodes
  8. (integer) 5
  9. Merged weight
  10. (integer) 0
  11. Unmerged weight
  12. (integer) 5
  13. Observations
  14. (integer) 5
  15. Total compressions
  16. (integer) 0
  17. Memory usage
  18. (integer) 9768 {{< / highlight >}}

Redis Software and Redis Cloud compatibility

| Redis Software | Redis Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> | |:----------------------|:-----------------|:------| | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Flexible & Annual</span> <span title="Supported">✅ Free & Fixed</nobr></span> | |

Return information

{{< multitabs id="tdigest-info-return-info" tab1="RESP2" tab2="RESP3" >}}

One of the following:

  • [Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) with information about the given sketch as name-value pairs:

    | Name

    [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}})Description
    Compression[Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}})

The compression (controllable trade-off between accuracy and memory consumption) of the sketch | Capacity | [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) Size of the buffer used for storing the centroids and for the incoming unmerged observations | Merged nodes | [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) Number of merged observations | Unmerged nodes | [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) Number of buffered nodes (uncompressed observations) | Merged weight | [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) Weight of values of the merged nodes | Unmerged weight | [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) Weight of values of the unmerged nodes (uncompressed observations) | Observations | [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) Number of observations added to the sketch | Total compressions | [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) Number of times this sketch compressed data together | Memory usage | [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) Number of bytes allocated for the sketch

  • [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: the given key does not exist or is of an incorrect type or an incorrect number of arguments.

-tab-sep-

One of the following:

  • [Map reply]({{< relref "/develop/reference/protocol-spec#maps" >}}) with information about the given sketch as name-value pairs:

    | Name

    [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}})Description
    Compression[Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}})

The compression (controllable trade-off between accuracy and memory consumption) of the sketch | Capacity | [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) Size of the buffer used for storing the centroids and for the incoming unmerged observations | Merged nodes | [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) Number of merged observations | Unmerged nodes | [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) Number of buffered nodes (uncompressed observations) | Merged weight | [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) Weight of values of the merged nodes | Unmerged weight | [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) Weight of values of the unmerged nodes (uncompressed observations) | Observations | [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) Number of observations added to the sketch | Total compressions | [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) Number of times this sketch compressed data together | Memory usage | [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) Number of bytes allocated for the sketch

  • [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: the given key does not exist or is of an incorrect type or an incorrect number of arguments.

{{< /multitabs >}}