io.lettuce.core.api.sync

Interface RedisTopKCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

RedisAdvancedClusterCommands<K,V>, RedisClusterCommands<K,V>, RedisClusterPubSubCommands<K,V>, RedisCommands<K,V>, RedisPubSubCommands<K,V>

public interface RedisTopKCommands<K,V>

Synchronous executed commands for Top-K.

Since:

7.7

Author:

Yordan Tsintsov

See Also:

Redis Top-K

Method Summary

Modifier and Type	Method and Description
List<String>	topKAdd(K key, V... values) Adds a value to a Top-k sketch.
List<String>	topKAdd(K key, V value) Adds a value to a Top-k sketch.
List<String>	topKIncrBy(K key, IncrementPair<V>... pairs) Adds a value to a Top-k sketch.
List<String>	topKIncrBy(K key, V value, long increment) Increments the count of a value in a Top-K sketch by the given increment.
TopKInfoValue	topKInfo(K key) Returns information about the Top-K sketch.
List<String>	topKList(K key) Returns the full list of values in Top-K sketch.
List<TopKListValue>	topKList(K key, boolean withCount) Returns the full list of values in Top-K sketch paired with their count if withCount is true.
List<Boolean>	topKQuery(K key, V... values) Checks whether values are in the Top-K sketch.
List<Boolean>	topKQuery(K key, V value) Checks whether value is one of the top-k elements of the sketch.
String	topKReserve(K key, long k) Initializes a Top-K sketch with specified parameters.
String	topKReserve(K key, long k, TopKReserveArgs args) Initializes a Top-K sketch with specified parameters.

Method Detail

topKAdd

List<String> topKAdd(K key,
                     V value)

Adds a value to a Top-k sketch. If a value enters the Top-K sketch, the value that is expelled (if any) is returned. This allows dynamic heavy-hitter detection of values being entered or expelled from Top-K sketch.

Parameters:

key - the key.

value - the value.

Returns:

List<String> where each element is the value expelled from the Top-K sketch when the corresponding value entered it, or null if no value was expelled.

topKAdd

List<String> topKAdd(K key,
                     V... values)

Adds a value to a Top-k sketch. Multiple values can be added at the same time. If a value enters the Top-K sketch, the value that is expelled (if any) is returned. This allows dynamic heavy-hitter detection of values being entered or expelled from Top-K sketch.

Parameters:

key - the key.

values - the values.

Returns:

List<String> where each element is the value expelled from the Top-K sketch when the corresponding value entered it, or null if no value was expelled.

topKIncrBy

List<String> topKIncrBy(K key,
                        V value,
                        long increment)

Increments the count of a value in a Top-K sketch by the given increment. If the value enters the Top-K sketch, the value that is expelled (if any) is returned.

Parameters:

key - the key.

value - the value.

increment - the increment.

Returns:

List<String> where each element is the value expelled from the Top-K sketch when the corresponding value entered it, or null if no value was expelled.

topKIncrBy

List<String> topKIncrBy(K key,
                        IncrementPair<V>... pairs)

Adds a value to a Top-k sketch. Multiple values can be added at the same time. If a value enters the Top-K sketch, the value that is expelled (if any) is returned. This allows dynamic heavy-hitter detection of values being entered or expelled from Top-K sketch.

Parameters:

key - the key.

pairs - the value and increment pairs.

Returns:

List<String> where each element is the value expelled from the Top-K sketch when the corresponding value entered it, or null if no value was expelled.

topKInfo

TopKInfoValue topKInfo(K key)

Returns information about the Top-K sketch.

Parameters:

key - the key.

Returns:

TopKInfoValue the information about the sketch.

topKList

List<String> topKList(K key)

Returns the full list of values in Top-K sketch.

Parameters:

key - the key.

Returns:

List<String> containing the current top-k values in the sketch.

topKList

List<TopKListValue> topKList(K key,
                             boolean withCount)

Returns the full list of values in Top-K sketch paired with their count if withCount is true.

Parameters:

key - the key.

withCount - whether to return the count of each value.

Returns:

List<TopKListValue> containing the current top-k values in the sketch paired with their count.

topKQuery

List<Boolean> topKQuery(K key,
                        V value)

Checks whether value is one of the top-k elements of the sketch.

Parameters:

key - the key.

value - the value.

Returns:

List<Boolean> where true means the corresponding value is one of the top-k elements of the sketch, false otherwise.

topKQuery

List<Boolean> topKQuery(K key,
                        V... values)

Checks whether values are in the Top-K sketch.

Parameters:

key - the key.

values - the values.

Returns:

List<Boolean> where true means the corresponding value is one of the top-k elements of the sketch, false otherwise.

topKReserve

String topKReserve(K key,
                   long k)

Initializes a Top-K sketch with specified parameters.

Parameters:

key - the key.

k - the maximum number of values to keep.

Returns:

String simple-string-reply OK if the sketch was created.

topKReserve

String topKReserve(K key,
                   long k,
                   TopKReserveArgs args)

Initializes a Top-K sketch with specified parameters.

Parameters:

key - the key.

k - the maximum number of values to keep.

args - the reserve arguments.

Returns:

String simple-string-reply OK if the sketch was created.