Package io.quarkus.redis.datasource.topk

Interface TransactionalTopKCommands<K,V>

Type Parameters:

K - the type of the key

V - the type of the value stored in the sketch

All Superinterfaces:

TransactionalRedisCommands

All Known Implementing Classes:

BlockingTransactionalTopKCommandsImpl

public interface TransactionalTopKCommands<K,V>
extends TransactionalRedisCommands

Allows executing commands from the top-k group. These commands require the Redis Bloom module (this modules also include Top-K list support) to be installed in the Redis server.

See the top-k command list for further information about these commands.

This API is intended to be used in a Redis transaction (MULTI), thus, all command methods return void.

Method Summary

Modifier and Type	Method	Description
void	topkAdd(K key, V item)	Execute the command TOPK.ADD.
void	topkAdd(K key, V... items)	Execute the command TOPK.ADD.
void	topkIncrBy(K key, Map<V,Integer> couples)	Execute the command TOPK.INCRBY.
void	topkIncrBy(K key, V item, int increment)	Execute the command TOPK.INCRBY.
void	topkList(K key)	Execute the command TOPK.LIST.
void	topkListWithCount(K key)	Execute the command TOPK.LIST.
void	topkQuery(K key, V item)	Execute the command TOPK.QUERY.
void	topkQuery(K key, V... items)	Execute the command TOPK.QUERY.
void	topkReserve(K key, int topk)	Execute the command TOPK.RESERVE.
void	topkReserve(K key, int topk, int width, int depth, double decay)	Execute the command TOPK.RESERVE.

Methods inherited from interface io.quarkus.redis.datasource.TransactionalRedisCommands

getDataSource

Method Detail

topkAdd

void topkAdd(K key,
             V item)

Execute the command TOPK.ADD. Summary: Adds an item to the data structure. Multiple items can be added at once. If an item enters the Top-K list, the item which is expelled is returned. This allows dynamic heavy-hitter detection of items being entered or expelled from Top-K list. Group: top-k

Parameters:

key - the name of list where item is added, must not be null

item - the item to add, must not be null

topkAdd

void topkAdd(K key,
             V... items)

Execute the command TOPK.ADD. Summary: Adds an item to the data structure. Multiple items can be added at once. If an item enters the Top-K list, the item which is expelled is returned. This allows dynamic heavy-hitter detection of items being entered or expelled from Top-K list. Group: top-k

Parameters:

key - the name of list where item is added, must not be null

items - the items to add, must not be null, must not be empty, must not contain null

topkIncrBy

void topkIncrBy(K key,
                V item,
                int increment)

Execute the command TOPK.INCRBY. Summary: Increase the score of an item in the data structure by increment. Multiple items' score can be increased at once. If an item enters the Top-K list, the item which is expelled is returned. Group: top-k

Parameters:

key - the name of list where item is added, must not be null

item - the item to add, must not be null

increment - increment to current item score. Increment must be greater or equal to 1. Increment is limited to 100,000 to avoid server freeze.

topkIncrBy

void topkIncrBy(K key,
                Map<V,Integer> couples)

Execute the command TOPK.INCRBY. Summary: Increase the score of an item in the data structure by increment. Multiple items' score can be increased at once. If an item enters the Top-K list, the item which is expelled is returned. Group: top-k

Parameters:

key - the name of list where item is added, must not be null

couples - The map containing the item / increment, must not be null, must not be empty

topkList

void topkList(K key)

Execute the command TOPK.LIST. Summary: Return full list of items in Top K list. Group: top-k

Parameters:

key - the name of list, must not be null

topkListWithCount

void topkListWithCount(K key)

Execute the command TOPK.LIST. Summary: Return full list of items in Top K list. Group: top-k

Parameters:

key - the name of list, must not be null

topkQuery

void topkQuery(K key,
               V item)

Execute the command TOPK.QUERY. Summary: Checks whether an item is one of Top-K items. Multiple items can be checked at once. Group: top-k

Parameters:

key - the name of list, must not be null

item - the item to check, must not be null

topkQuery

void topkQuery(K key,
               V... items)

Execute the command TOPK.QUERY. Summary: Checks whether an item is one of Top-K items. Multiple items can be checked at once. Group: top-k

Parameters:

key - the name of list, must not be null

items - the items to check, must not be null, must not contain null, must not be empty

topkReserve

void topkReserve(K key,
                 int topk)

Execute the command TOPK.RESERVE. Summary: Initializes a TopK with specified parameters. Group: top-k

Parameters:

key - the name of list, must not be null

topk - the number of top occurring items to keep.

topkReserve

void topkReserve(K key,
                 int topk,
                 int width,
                 int depth,
                 double decay)

Execute the command TOPK.RESERVE. Summary: Initializes a TopK with specified parameters. Group: top-k

Parameters:

key - the name of list, must not be null

topk - the number of top occurring items to keep.

width - the number of counters kept in each array. (Default 8)

depth - the number of arrays. (Default 7)

decay - the probability of reducing a counter in an occupied bucket. It is raised to power of it's counter (decay ^ bucket[i].counter). Therefore, as the counter gets higher, the chance of a reduction is being reduced. (Default 0.9)