Package io.quarkus.redis.datasource.cuckoo

Interface TransactionalCuckooCommands<K,V>

Type Parameters:

K - the type of the key

V - the type of the value stored in the filter

All Superinterfaces:

TransactionalRedisCommands

All Known Implementing Classes:

BlockingTransactionalCuckooCommandsImpl

public interface TransactionalCuckooCommands<K,V>
extends TransactionalRedisCommands

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 void.

Method Summary

Modifier and Type	Method	Description
void	cfadd(K key, V value)	Execute the command CF.ADD.
void	cfaddnx(K key, V value)	Execute the command CF.ADDNX.
void	cfcount(K key, V value)	Execute the command CF.COUNT.
void	cfdel(K key, V value)	Execute the command CF.DEL.
void	cfexists(K key, V value)	Execute the command CF.EXISTS.
void	cfinsert(K key, CfInsertArgs args, V... values)	Execute the command CF.INSERT.
void	cfinsert(K key, V... values)	Execute the command CF.INSERT.
void	cfinsertnx(K key, CfInsertArgs args, V... values)	Execute the command CF.INSERTNX.
void	cfinsertnx(K key, V... values)	Execute the command CF.INSERTNX.
void	cfmexists(K key, V... values)	Execute the command CF.MEXISTS.
void	cfreserve(K key, long capacity)	Execute the command CF.RESERVE.
void	cfreserve(K key, long capacity, CfReserveArgs args)	Execute the command CF.RESERVE.

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

getDataSource

Method Detail

cfadd

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

cfaddnx

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

cfcount

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

cfdel

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

cfexists

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

cfinsert

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

cfinsert

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

cfinsertnx

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

cfinsertnx

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

cfmexists

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

cfreserve

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

cfreserve

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