TOPK.LIST

Syntax text Syntax diagram API methods

TOPK.LIST key [WITHCOUNT]

Client:

list(
    key: str,
    withcount: bool  // Include counts, default: False
) → List  // Top-K items, with counts if withcount=True

TOPK.LIST(
    key: RedisArgument
) → ArrayReply<BlobStringReply>  // Top-K items

TOPK.LIST_WITHCOUNT(
    key: RedisArgument
) → Map<string, number>  // Top-K items with counts

topkList(
    key: String
) → List<String>  // k (or less) items in Top K list

topkListWithCount(
    key: String
) → Map<String, Long>  // k (or less) items with counts

TopKList(
    ctx: context.Context,
    key: string
) → *StringSliceCmd  // Top-K items

TopKListWithCount(
    ctx: context.Context,
    key: string
) → *MapStringIntCmd  // Top-K items with counts

List(
    key: RedisKey,
    withcount: bool  // Include counts, default: false
) → RedisResult[]  // Top-K items

ListAsync(
    key: RedisKey,
    withcount: bool  // Include counts, default: false
) → Task<RedisResult[]>  // Top-K items

topklist(
    key: string
) → array  // Top-K items

Available in:: Redis Open Source / Bloom 2.0.0
Time complexity:: O(k) where k is the value of top-k
ACL categories:: @topk, @read, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

Return the full list of items in Top-K sketch.

Required arguments

key

the name of the sketch.

Optional arguments

WITHCOUNT

the count of each element is also returned.

Examples

TOPK.LIST topk
1) foo
2) 42
3) bar

TOPK.LIST topk WITHCOUNT
1) foo
2) (integer) 12
3) 42
4) (integer) 7
5) bar
6) (integer) 2

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Supported	✅ Flexible & Annual ✅ Free & Fixed

Return information

k (or less) items in the given Top-k sketch. The list is sorted by decreased count estimation.

RESP2 RESP3

One of the following:

Array of bulk string replies representing the names of items in the given sketch. If WITHCOUNT is requested, an array of bulk string reply and integer reply pairs, representing the names of the items in the sketch together with their counts.
Simple error reply in these cases: invalid arguments, non-existant key, or key of the incorrect type.