io.lettuce.core.api.reactive

Interface RedisBloomFilterReactiveCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

RedisAdvancedClusterReactiveCommands<K,V>, RedisClusterPubSubReactiveCommands<K,V>, RedisClusterReactiveCommands<K,V>, RedisPubSubReactiveCommands<K,V>, RedisReactiveCommands<K,V>

All Known Implementing Classes:

AbstractRedisReactiveCommands, RedisAdvancedClusterReactiveCommandsImpl, RedisClusterPubSubReactiveCommandsImpl, RedisPubSubReactiveCommandsImpl, RedisReactiveCommandsImpl, RedisSentinelReactiveCommandsImpl

public interface RedisBloomFilterReactiveCommands<K,V>

Reactive executed commands for Bloom Filter.

Since:

7.7

Author:

Yordan Tsintsov

See Also:

Redis Bloom Filter

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<Boolean>	bfAdd(K key, V value) Add an item to the Bloom Filter.
reactor.core.publisher.Mono<Long>	bfCard(K key) Get the number of items added and detected as unique in the Bloom Filter.
reactor.core.publisher.Mono<Boolean>	bfExists(K key, V value) Check if an item exists in the Bloom Filter.
reactor.core.publisher.Mono<BfInfoValue>	bfInfo(K key) Get information about the Bloom Filter.
reactor.core.publisher.Flux<Value<Boolean>>	bfInsert(K key, BfInsertArgs insertArgs, V... values) Add one or more items to the Bloom Filter.
reactor.core.publisher.Flux<Value<Boolean>>	bfInsert(K key, BfInsertArgs insertArgs, V value) Add an item to the Bloom Filter.
reactor.core.publisher.Flux<Value<Boolean>>	bfInsert(K key, V... values) Add one or more items to the Bloom Filter.
reactor.core.publisher.Flux<Value<Boolean>>	bfInsert(K key, V value) Add an item to the Bloom Filter.
reactor.core.publisher.Mono<String>	bfLoadChunk(K key, long iterator, byte[] data) Restores a Bloom filter previously saved using BF.SCANDUMP.
reactor.core.publisher.Flux<Value<Boolean>>	bfMAdd(K key, V... values) Add one or more items to the Bloom Filter.
reactor.core.publisher.Flux<Boolean>	bfMExists(K key, V... values) Check if one or more items exist in the filter.
reactor.core.publisher.Mono<String>	bfReserve(K key, double errorRate, long capacity) Creates an empty Bloom filter with a single sub-filter for the initial specified capacity and with an upper bound error rate.
reactor.core.publisher.Mono<String>	bfReserve(K key, double errorRate, long capacity, BfReserveArgs reserveArgs) Creates an empty Bloom filter with a single sub-filter for the initial specified capacity and with an upper bound error rate.
reactor.core.publisher.Mono<ScanDumpValue>	bfScanDump(K key, long iterator) Begins an incremental save of the Bloom filter.

Method Detail

bfAdd

reactor.core.publisher.Mono<Boolean> bfAdd(K key,
                                           V value)

Add an item to the Bloom Filter.

Parameters:

key - the key.

value - the value.

Returns:

Boolean integer-reply true if the item was added, false if it was already in the filter.

bfCard

reactor.core.publisher.Mono<Long> bfCard(K key)

Get the number of items added and detected as unique in the Bloom Filter.

Parameters:

key - the key.

Returns:

Long integer-reply the number of items in the filter.

bfExists

reactor.core.publisher.Mono<Boolean> bfExists(K key,
                                              V value)

Check if an item exists in the Bloom Filter.

Parameters:

key - the key.

value - the value.

Returns:

Boolean integer-reply true if the item may exist in the filter, false if it definitely does not.

bfInfo

reactor.core.publisher.Mono<BfInfoValue> bfInfo(K key)

Get information about the Bloom Filter.

Parameters:

key - the key.

Returns:

BfInfoValue the information about the filter.

bfInsert

reactor.core.publisher.Flux<Value<Boolean>> bfInsert(K key,
                                                     V value)

Add an item to the Bloom Filter.

Parameters:

key - the key.

value - the value.

Returns:

Value with where true means that the item was added; false means that there's a probability that the item was already added to the filter or the filter is full; {Value.empty() when filter is full and nonscaling.

bfInsert

reactor.core.publisher.Flux<Value<Boolean>> bfInsert(K key,
                                                     BfInsertArgs insertArgs,
                                                     V value)

Add an item to the Bloom Filter.

Parameters:

key - the key.

insertArgs - the insert arguments.

value - the value.

Returns:

Value with where true means that the item was added; false means that there's a probability that the item was already added to the filter or the filter is full; {Value.empty() when filter is full and nonscaling.

bfInsert

reactor.core.publisher.Flux<Value<Boolean>> bfInsert(K key,
                                                     V... values)

Add one or more items to the Bloom Filter.

Parameters:

key - the key.

values - the values.

Returns:

Value with where true means that the item was added; false means that there's a probability that the item was already added to the filter or the filter is full; {Value.empty() when filter is full and nonscaling.

bfInsert

reactor.core.publisher.Flux<Value<Boolean>> bfInsert(K key,
                                                     BfInsertArgs insertArgs,
                                                     V... values)

Add one or more items to the Bloom Filter.

Parameters:

key - the key.

insertArgs - the insert arguments.

values - the values.

Returns:

Value with where true means that the item was added; false means that there's a probability that the item was already added to the filter or the filter is full; {Value.empty() when filter is full and nonscaling.

bfLoadChunk

reactor.core.publisher.Mono<String> bfLoadChunk(K key,
                                                long iterator,
                                                byte[] data)

Restores a Bloom filter previously saved using BF.SCANDUMP.

Parameters:

key - the key.

iterator - the iterator.

data - the data.

Returns:

String simple-string-reply OK if BF.LOADCHUNK was executed correctly.

bfMAdd

reactor.core.publisher.Flux<Value<Boolean>> bfMAdd(K key,
                                                   V... values)

Add one or more items to the Bloom Filter.

Parameters:

key - the key.

values - the values.

Returns:

Boolean of true or false where true means that the item was newly added and false means that there's a probability that the item was already added to the filter; Value.empty() when filter is full and nonscaling.

bfMExists

reactor.core.publisher.Flux<Boolean> bfMExists(K key,
                                               V... values)

Check if one or more items exist in the filter.

Parameters:

key - the key.

values - the values.

Returns:

Boolean of true or false where true means that, with high probability, the item was already added to the filter, and false means that key does not exist or that item was definitely not added to the filter.

bfReserve

reactor.core.publisher.Mono<String> bfReserve(K key,
                                              double errorRate,
                                              long capacity)

Creates an empty Bloom filter with a single sub-filter for the initial specified capacity and with an upper bound error rate.

Parameters:

key - the key.

errorRate - the error rate.

capacity - the capacity.

Returns:

String simple-string-reply OK if BF.RESERVE was executed correctly.

bfReserve

reactor.core.publisher.Mono<String> bfReserve(K key,
                                              double errorRate,
                                              long capacity,
                                              BfReserveArgs reserveArgs)

Creates an empty Bloom filter with a single sub-filter for the initial specified capacity and with an upper bound error rate.

Parameters:

key - the key.

errorRate - the error rate.

capacity - the capacity.

reserveArgs - the reserve arguments.

Returns:

String simple-string-reply OK if BF.RESERVE was executed correctly.

bfScanDump

reactor.core.publisher.Mono<ScanDumpValue> bfScanDump(K key,
                                                      long iterator)

Begins an incremental save of the Bloom filter.

Parameters:

key - the key.

iterator - the iterator.

Returns:

ScanDumpValue the scan dump value.