Interface BloomCommands<K,V>
-
- Type Parameters:
K
- the type of the keyV
- the type of the value stored in the filter
- All Superinterfaces:
RedisCommands
- All Known Implementing Classes:
BlockingBloomCommandsImpl
public interface BloomCommands<K,V> extends RedisCommands
Allows executing commands from thebloom
group. These commands require the Redis Bloom module to be installed in the Redis server.See the bloom command list for further information about these commands.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
bfadd(K key, V value)
Execute the command BF.ADD.boolean
bfexists(K key, V value)
Execute the command BF.EXISTS.List<Boolean>
bfinsert(K key, BfInsertArgs args, V... values)
Execute the command BF.INSERT.List<Boolean>
bfmadd(K key, V... values)
Execute the command BF.MADD.List<Boolean>
bfmexists(K key, V... values)
Execute the command BF.MEXISTS.void
bfreserve(K key, double errorRate, long capacity)
Execute the command BF.RESERVE.void
bfreserve(K key, double errorRate, long capacity, BfReserveArgs args)
Execute the command BF.RESERVE.-
Methods inherited from interface io.quarkus.redis.datasource.RedisCommands
getDataSource
-
-
-
-
Method Detail
-
bfadd
boolean bfadd(K key, V value)
Execute the command BF.ADD. Summary: Adds the specified element to the specified Bloom filter. Group: bloomIf the bloom filter does not exist, it creates a new one.
- Parameters:
key
- the keyvalue
- the value, must not benull
- Returns:
true
if the value did not exist in the filter,false
otherwise.
-
bfexists
boolean bfexists(K key, V value)
Execute the command BF.EXISTS. Summary: Determines whether an item may exist in the Bloom Filter or not. Group: bloom- Parameters:
key
- the keyvalue
- the value, must not benull
- Returns:
true
if the value may exist in the filter,false
means it does not exist in the filter.
-
bfmadd
List<Boolean> bfmadd(K key, V... values)
Execute the command BF.MADD. Summary: Adds one or more items to the Bloom Filter and creates the filter if it does not exist yet. This command operates identically to BF.ADD except that it allows multiple inputs and returns multiple values. Group: bloom- Parameters:
key
- the keyvalues
- the values, must not benull
, must not containnull
, must not be empty.- Returns:
- a list of booleans.
true
if the corresponding value did not exist in the filter,false
otherwise.
-
bfmexists
List<Boolean> bfmexists(K key, V... values)
Execute the command BF.MEXISTS. Summary: Determines if one or more items may exist in the filter or not. Group: bloom- Parameters:
key
- the keyvalues
- the values, must not benull
, must not containnull
, must not be empty.- Returns:
- a list of booleans.
true
if the corresponding value may exist in the filter,false
does not exist in the filter.
-
bfreserve
void bfreserve(K key, double errorRate, long capacity)
Execute the command BF.RESERVE. Summary: Creates an empty Bloom Filter with a single sub-filter for the initial capacity requested and with an upper bounderror_rate
. Group: bloom- Parameters:
key
- the keyerrorRate
- The desired probability for false positives. The rate is a decimal value between 0 and 1.capacity
- The number of entries intended to be added to the filter.
-
bfreserve
void bfreserve(K key, double errorRate, long capacity, BfReserveArgs args)
Execute the command BF.RESERVE. Summary: Creates an empty Bloom Filter with a single sub-filter for the initial capacity requested and with an upper bounderror_rate
. Group: bloom- Parameters:
key
- the keyerrorRate
- The desired probability for false positives. The rate is a decimal value between 0 and 1.capacity
- The number of entries intended to be added to the filter.args
- the extra parameters
-
bfinsert
List<Boolean> bfinsert(K key, BfInsertArgs args, V... values)
Execute the command BF.INSERT. Summary: BF.INSERT is a sugarcoated combination ofBF.RESERVE
andBF.ADD
. It creates a new filter if the key does not exist using the relevant arguments. Next, allITEMS
are inserted. Group: bloom- Parameters:
key
- the keyargs
- the creation parametersvalues
- the value to add, must not containnull
, must not benull
, must not be empty- Returns:
- a list of booleans.
true
if the corresponding value may exist in the filter,false
does not exist in the filter.
-
-