io.quarkus.redis.datasource.hyperloglog.ReactiveHyperLogLogCommands 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.hyperloglog;

import io.quarkus.redis.datasource.ReactiveRedisCommands;
import io.smallrye.mutiny.Uni;

/**
 * Allows executing commands from the {@code hyperloglog} group.
 * See the hyperloglog command list for further information about
 * these commands.
 * 
 *
 * @param  the type of the key
 * @param  the type of the value stored in the sets
 */
public interface ReactiveHyperLogLogCommands extends ReactiveRedisCommands {

    /**
     * Execute the command PFADD.
     * Summary: Adds the specified elements to the specified HyperLogLog.
     * Group: hyperloglog
     * Requires Redis 2.8.9
     *
     * @param key the key
     * @param values the values
     * @return {@code true} at least 1 HyperLogLog internal register was altered. {@code false} otherwise.
     **/
    Uni pfadd(K key, V... values);

    /**
     * Execute the command PFMERGE.
     * Summary: Merge N different HyperLogLogs into a single one.
     * Group: hyperloglog
     * Requires Redis 2.8.9
     *
     * @param destkey the key
     * @param sourcekeys the source keys
     * @return a Uni emitting a {@code null} item on completion
     **/
    Uni pfmerge(K destkey, K... sourcekeys);

    /**
     * Execute the command PFCOUNT.
     * Summary: Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).
     * Group: hyperloglog
     * Requires Redis 2.8.9
     *
     * @return The approximated number of unique elements observed via PFADD.
     **/
    Uni pfcount(K... keys);
}