io.lettuce.core.cluster.api.async

Interface NodeSelectionCMSAsyncCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

NodeSelectionAsyncCommands<K,V>

public interface NodeSelectionCMSAsyncCommands<K,V>

Asynchronous executed commands on a node selection for Count-Min Sketch.

Since:

7.7

Author:

Yordan Tsintsov

See Also:

Redis Count-Min Sketch

Method Summary

Modifier and Type	Method and Description
AsyncExecutions<List<Long>>	cmsIncrBy(K key, IncrementPair<V>... pairs) Increases the count of several items by their given increments in a single call.
AsyncExecutions<List<Long>>	cmsIncrBy(K key, IncrementPair<V> pair) Increases the count of an item by the given increment.
AsyncExecutions<CMSInfoValue>	cmsInfo(K key) Returns width, depth and total count of the sketch.
AsyncExecutions<String>	cmsInitByDim(K key, long width, long depth) Initializes a Count-Min Sketch to the dimensions specified by the user.
AsyncExecutions<String>	cmsInitByProb(K key, double error, double probability) Initializes a Count-Min Sketch to accommodate requested tolerances.
AsyncExecutions<String>	cmsMerge(K destination, K... sources) Merges several source sketches into a single destination sketch.
AsyncExecutions<String>	cmsMerge(K destination, K source) Merges a single source sketch into a destination sketch.
AsyncExecutions<String>	cmsMerge(K destination, MergePair<K>... sources) Merges several source sketches into a single destination sketch, scaling each source's contribution by the weight paired with it.
AsyncExecutions<String>	cmsMerge(K destination, MergePair<K> pair) Merges a single source sketch into a destination sketch, scaling its contribution by the weight paired with it.
AsyncExecutions<List<Long>>	cmsQuery(K key, V... values) Returns the count for one or more items in a sketch.
AsyncExecutions<List<Long>>	cmsQuery(K key, V value) Returns the count for one item in a sketch.

Method Detail

cmsIncrBy

AsyncExecutions<List<Long>> cmsIncrBy(K key,
                                      IncrementPair<V> pair)

Increases the count of an item by the given increment.

Parameters:

key - the key.

pair - the item paired with the increment to add to its count.

Returns:

List<Long> array-reply of the count of the item after the increment.

cmsIncrBy

AsyncExecutions<List<Long>> cmsIncrBy(K key,
                                      IncrementPair<V>... pairs)

Increases the count of several items by their given increments in a single call.

Parameters:

key - the key.

pairs - the items paired with the increment to add to each item's count.

Returns:

List<Long> array-reply of the count of each item after the increment, in the same order as pairs.

cmsInfo

AsyncExecutions<CMSInfoValue> cmsInfo(K key)

Returns width, depth and total count of the sketch.

Parameters:

key - the key.

Returns:

the CMSInfoValue holding the sketch information.

cmsInitByDim

AsyncExecutions<String> cmsInitByDim(K key,
                                     long width,
                                     long depth)

Initializes a Count-Min Sketch to the dimensions specified by the user.

Parameters:

key - the key. An error is returned if the key already exists.

width - the number of counters in each array. Reduces the error size.

depth - the number of counter-arrays. Reduces the probability of an error exceeding the estimated size.

Returns:

String simple-string-reply OK if CMS.INITBYDIM was executed correctly.

cmsInitByProb

AsyncExecutions<String> cmsInitByProb(K key,
                                      double error,
                                      double probability)

Initializes a Count-Min Sketch to accommodate requested tolerances.

Parameters:

key - the key. An error is returned if the key already exists.

error - estimate size of the error.

probability - the desired probability for inflated count.

Returns:

String simple-string-reply OK if CMS.INITBYPROB was executed correctly.

cmsMerge

AsyncExecutions<String> cmsMerge(K destination,
                                 K source)

Merges a single source sketch into a destination sketch. All sketches must have identical width and depth, and the destination must already exist.

Parameters:

destination - the name of destination sketch. Must be initialized.

source - the name of the source sketch to merge into destination.

Returns:

String simple-string-reply OK if CMS.MERGE was executed correctly.

cmsMerge

AsyncExecutions<String> cmsMerge(K destination,
                                 K... sources)

Merges several source sketches into a single destination sketch. All sketches must have identical width and depth, and the destination must already exist.

Parameters:

destination - the name of destination sketch. Must be initialized.

sources - the names of the source sketches to merge into destination.

Returns:

String simple-string-reply OK if CMS.MERGE was executed correctly.

cmsMerge

AsyncExecutions<String> cmsMerge(K destination,
                                 MergePair<K> pair)

Merges a single source sketch into a destination sketch, scaling its contribution by the weight paired with it. All sketches must have identical width and depth, and the destination must already exist.

Parameters:

destination - the name of destination sketch. Must be initialized.

pair - the source sketch to merge into destination, paired with the multiplication factor applied to it before merging.

Returns:

String simple-string-reply OK if CMS.MERGE was executed correctly.

cmsMerge

AsyncExecutions<String> cmsMerge(K destination,
                                 MergePair<K>... sources)

Merges several source sketches into a single destination sketch, scaling each source's contribution by the weight paired with it. All sketches must have identical width and depth, and the destination must already exist.

Parameters:

destination - the name of destination sketch. Must be initialized.

sources - the source sketches to merge into destination, each paired with the multiplication factor applied to it before merging.

Returns:

String simple-string-reply OK if CMS.MERGE was executed correctly.

cmsQuery

AsyncExecutions<List<Long>> cmsQuery(K key,
                                     V value)

Returns the count for one item in a sketch.

Parameters:

key - the key.

value - the item to query.

Returns:

List<Long> array-reply of the count of the item.

cmsQuery

AsyncExecutions<List<Long>> cmsQuery(K key,
                                     V... values)

Returns the count for one or more items in a sketch.

Parameters:

key - the key.

values - the items to query.

Returns:

List<Long> array-reply of the count of each item, in the same order as values.