Package io.quarkus.redis.datasource.cuckoo

Interface ReactiveTransactionalCuckooCommands<K,V>

Type Parameters:
K - the type of the key
V - the type of the value stored in the filter
All Superinterfaces:
ReactiveTransactionalRedisCommands
All Known Implementing Classes:
ReactiveTransactionalCuckooCommandsImpl
public interface ReactiveTransactionalCuckooCommands<K,V> extends ReactiveTransactionalRedisCommands
Allows executing commands from the cuckoo group. These commands require the Redis Bloom module (this modules also include Cuckoo filters) to be installed in the Redis server.

See the cuckoo 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 Uni<Void>.

  • Method Details

    • cfadd

      io.smallrye.mutiny.Uni<Void> cfadd(K key, V value)
      Execute the command CF.ADD. Summary: Adds the specified element to the specified Cuckoo filter. Group: cuckoo

      If the cuckoo filter does not exist, it creates a new one.

      Parameters:
      key - the key
      value - the value, must not be null
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • cfaddnx

      io.smallrye.mutiny.Uni<Void> cfaddnx(K key, V value)
      Execute the command CF.ADDNX. Summary: Adds an item to a cuckoo filter if the item did not exist previously. Group: cuckoo

      If the cuckoo filter does not exist, it creates a new one.

      Parameters:
      key - the key
      value - the value, must not be null
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • cfcount

      io.smallrye.mutiny.Uni<Void> cfcount(K key, V value)
      Execute the command CF.COUNT. Summary: Returns the number of times an item may be in the filter. Because this is a probabilistic data structure, this may not necessarily be accurate. Group: cuckoo

      Parameters:
      key - the key
      value - the value, must not be null
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • cfdel

      io.smallrye.mutiny.Uni<Void> cfdel(K key, V value)
      Execute the command CF.DEL. Summary: Deletes an item once from the filter. If the item exists only once, it will be removed from the filter. If the item was added multiple times, it will still be present. Group: cuckoo

      Parameters:
      key - the key
      value - the value, must not be null
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • cfexists

      io.smallrye.mutiny.Uni<Void> cfexists(K key, V value)
      Execute the command CF.EXISTS. Summary: Check if an item exists in a Cuckoo filter Group: cuckoo

      Parameters:
      key - the key
      value - the value, must not be null
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • cfinsert

      io.smallrye.mutiny.Uni<Void> cfinsert(K key, V... values)
      Execute the command CF.INSERT. Summary: Adds one or more items to a cuckoo filter, allowing the filter to be created with a custom capacity if it does not exist yet. Group: cuckoo

      Parameters:
      key - the key
      values - the values, must not be null, must not be empty, must not contain null
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • cfinsert

      io.smallrye.mutiny.Uni<Void> cfinsert(K key, CfInsertArgs args, V... values)
      Execute the command CF.INSERT. Summary: Adds one or more items to a cuckoo filter, allowing the filter to be created with a custom capacity if it does not exist yet. Group: cuckoo

      Parameters:
      key - the key
      args - the extra arguments
      values - the values, must not be null, must not be empty, must not contain null
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • cfinsertnx

      io.smallrye.mutiny.Uni<Void> cfinsertnx(K key, V... values)
      Execute the command CF.INSERTNX. Summary: Adds one or more items to a cuckoo filter, allowing the filter to be created with a custom capacity if it does not exist yet. Group: cuckoo

      Parameters:
      key - the key
      values - the values, must not be null, must not be empty, must not contain null
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • cfinsertnx

      io.smallrye.mutiny.Uni<Void> cfinsertnx(K key, CfInsertArgs args, V... values)
      Execute the command CF.INSERTNX. Summary: Adds one or more items to a cuckoo filter, allowing the filter to be created with a custom capacity if it does not exist yet. Group: cuckoo

      Parameters:
      key - the key
      args - the extra arguments
      values - the values, must not be null, must not be empty, must not contain null
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • cfmexists

      io.smallrye.mutiny.Uni<Void> cfmexists(K key, V... values)
      Execute the command CF.MEXISTS. Summary: Check if an item exists in a Cuckoo filter Group: cuckoo

      Parameters:
      key - the key
      values - the values, must not be null, must not contain null, must not be empty
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • cfreserve

      io.smallrye.mutiny.Uni<Void> cfreserve(K key, long capacity)
      Execute the command CF.RESERVE. Summary: Create a Cuckoo Filter as key with a single sub-filter for the initial amount of capacity for items. Group: cuckoo

      Parameters:
      key - the key
      capacity - the capacity
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • cfreserve

      io.smallrye.mutiny.Uni<Void> cfreserve(K key, long capacity, CfReserveArgs args)
      Execute the command CF.RESERVE. Summary: Create a Cuckoo Filter as key with a single sub-filter for the initial amount of capacity for items. Group: cuckoo

      Parameters:
      key - the key
      capacity - the capacity
      args - the extra parameters
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.