Package io.quarkus.redis.datasource.topk

Interface ReactiveTopKCommands<K,V>

Type Parameters:
K - the type of the key
V - the type of the value stored in the sketch
All Superinterfaces:
ReactiveRedisCommands
All Known Implementing Classes:
ReactiveTopKCommandsImpl
public interface ReactiveTopKCommands<K,V> extends ReactiveRedisCommands
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.

  • Method Details

    • topkAdd

      io.smallrye.mutiny.Uni<V> 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
      Returns:
      a uni producing the item that get expelled if any, emit null otherwise

    • topkAdd

      io.smallrye.mutiny.Uni<List<V>> 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
      Returns:
      a uni producing a list containing for each corresponding added item the expelled item if any, null otherwise.

    • topkIncrBy

      io.smallrye.mutiny.Uni<V> 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.
      Returns:
      a uni producing the item that get expelled if any, emit null otherwise

    • topkIncrBy

      io.smallrye.mutiny.Uni<Map<V,V>> 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
      Returns:
      a uni producing a map containing for each added item the expelled item if any, null otherwise

    • topkList

      io.smallrye.mutiny.Uni<List<V>> 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
      Returns:
      a uni producing the list of items

    • topkListWithCount

      io.smallrye.mutiny.Uni<Map<V,Integer>> 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
      Returns:
      a uni producing the Map of items with the associated count

    • topkQuery

      io.smallrye.mutiny.Uni<Boolean> 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
      Returns:
      a uni producing true if the item is in the list, false otherwise

    • topkQuery

      io.smallrye.mutiny.Uni<List<Boolean>> 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
      Returns:
      a uni producing a list containing true if the corresponding item is in the list, false otherwise

    • topkReserve

      io.smallrye.mutiny.Uni<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.
      Returns:
      a uni producing null once the operation completes

    • topkReserve

      io.smallrye.mutiny.Uni<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)
      Returns:
      a uni producing null once the operation completes