io.quarkus.redis.datasource.countmin.CountMinCommands Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of quarkus-redis-client Show documentation
Connect to Redis in either imperative or reactive style
There is a newer version: 3.17.5
package io.quarkus.redis.datasource.countmin;

import java.util.List;
import java.util.Map;

import io.quarkus.redis.datasource.RedisCommands;

/**
 * Allows executing commands from the {@code count-min} group.
 * These commands require the Redis Bloom module (this modules also
 * include Count-Min Sketches) to be installed in the Redis server.
 * 
 * See the count-min command list for further information about
 * these commands.
 * 

 *
 * @param  the type of the key
 * @param  the type of the value stored in the sketch
 */
public interface CountMinCommands extends RedisCommands {

    /**
     * Execute the command CMS.INCRBY.
     * Summary: Increases the count of item by increment. Multiple items can be increased with one call.
     * Group: count-min
     * 

     *
     * @param key the name of the sketch, must not be {@code null}
     * @param value the value, must not be {@code null}
     * @param increment the increment
     * @return the updated min-count for the added value
     */
    long cmsIncrBy(K key, V value, long increment);

    /**
     * Execute the command CMS.INCRBY.
     * Summary: Increases the count of item by increment. Multiple items can be increased with one call.
     * Group: count-min
     * 

     *
     * @param key the name of the sketch, must not be {@code null}
     * @param couples the set of value/increment pair, must not be {@code null}, must not be empty
     * @return a map containing the updated min-count for each added value
     */
    Map cmsIncrBy(K key, Map couples);

    /**
     * Execute the command CMS.INITBYDIM.
     * Summary: Initializes a Count-Min Sketch to dimensions specified by user.
     * Group: count-min
     * 

     *
     * @param key the name of the sketch, must not be {@code null}
     * @param width the number of counters in each array. Reduces the error size.
     * @param depth the number of counter-arrays. Reduces the probability for an error of a certain size (percentage of total
     *        count).
     */
    void cmsInitByDim(K key, long width, long depth);

    /**
     * Execute the command CMS.INITBYPROB.
     * Summary: Initializes a Count-Min Sketch to accommodate requested tolerances.
     * Group: count-min
     * 

     *
     * @param key the name of the sketch, must not be {@code null}
     * @param error estimate size of error. The error is a percent of total counted items (in decimal). This
     *        effects the width of the sketch.
     * @param probability the desired probability for inflated count. This should be a decimal value between 0 and 1.
     */
    void cmsInitByProb(K key, double error, double probability);

    /**
     * Execute the command CMS.QUERY.
     * Summary: Returns the count for one or more items in a sketch.
     * Group: count-min
     * 

     *
     * @param key the name of the sketch, must not be {@code null}
     * @param item the item to check, must not be {@code null}
     * @return the count for the given item
     */
    long cmsQuery(K key, V item);

    /**
     * Execute the command CMS.QUERY.
     * Summary: Returns the count for one or more items in a sketch.
     * Group: count-min
     * 

     *
     * @param key the name of the sketch, must not be {@code null}
     * @param items the items to check, must not be {@code null}, empty or contain {@code null}
     * @return a list containing the count for the corresponding item
     */
    List cmsQuery(K key, V... items);

    /**
     * Execute the command CMS.MERGE.
     * Summary: Merges several sketches into one sketch. All sketches must have identical width and depth. Weights can
     * be used to multiply certain sketches. Default weight is 1.
     * Group: count-min
     * 
     *
     * @param dest The name of destination sketch. Must be initialized, must not be {@code null}
     * @param src The names of source sketches to be merged. Must not be {@code null}, must not contain {@code null},
     *        must not be empty.
     * @param weight The multiple of each sketch. Default =1, can be empty, can be {@code null}
     */
    void cmsMerge(K dest, List src, List weight);
}