io.lettuce.core.cluster.api.sync

Interface NodeSelectionBloomFilterCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

NodeSelectionCommands<K,V>

public interface NodeSelectionBloomFilterCommands<K,V>

Synchronous executed commands on a node selection for Bloom Filter.

Since:

7.7

Author:

Yordan Tsintsov

See Also:

Redis Bloom Filter

Method Summary

Modifier and Type	Method and Description
Executions<Boolean>	bfAdd(K key, V value) Add an item to the Bloom Filter.
Executions<Long>	bfCard(K key) Get the number of items added and detected as unique in the Bloom Filter.
Executions<Boolean>	bfExists(K key, V value) Check if an item exists in the Bloom Filter.
Executions<BfInfoValue>	bfInfo(K key) Get information about the Bloom Filter.
Executions<List<Boolean>>	bfInsert(K key, BfInsertArgs insertArgs, V... values) Add one or more items to the Bloom Filter.
Executions<List<Boolean>>	bfInsert(K key, BfInsertArgs insertArgs, V value) Add an item to the Bloom Filter.
Executions<List<Boolean>>	bfInsert(K key, V... values) Add one or more items to the Bloom Filter.
Executions<List<Boolean>>	bfInsert(K key, V value) Add an item to the Bloom Filter.
Executions<String>	bfLoadChunk(K key, long iterator, byte[] data) Restores a Bloom filter previously saved using BF.SCANDUMP.
Executions<List<Boolean>>	bfMAdd(K key, V... values) Add one or more items to the Bloom Filter.
Executions<List<Boolean>>	bfMExists(K key, V... values) Check if one or more items exist in the filter.
Executions<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.
Executions<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.
Executions<ScanDumpValue>	bfScanDump(K key, long iterator) Begins an incremental save of the Bloom filter.

Method Detail

bfAdd

Executions<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

Executions<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

Executions<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

Executions<BfInfoValue> bfInfo(K key)

Get information about the Bloom Filter.

Parameters:

key - the key.

Returns:

BfInfoValue the information about the filter.

bfInsert

Executions<List<Boolean>> bfInsert(K key,
                                   V value)

Add an item to the Bloom Filter.

Parameters:

key - the key.

value - the value.

Returns:

List<Boolean> 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; null when filter is full and nonscaling.

bfInsert

Executions<List<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:

List<Boolean> 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; null when filter is full and nonscaling.

bfInsert

Executions<List<Boolean>> bfInsert(K key,
                                   V... values)

Add one or more items to the Bloom Filter.

Parameters:

key - the key.

values - the values.

Returns:

List<Boolean> 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; null when filter is full and nonscaling.

bfInsert

Executions<List<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:

List<Boolean> 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; null when filter is full and nonscaling.

bfLoadChunk

Executions<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

Executions<List<Boolean>> bfMAdd(K key,
                                 V... values)

Add one or more items to the Bloom Filter.

Parameters:

key - the key.

values - the values.

Returns:

List<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; null when filter is full and nonscaling.

bfMExists

Executions<List<Boolean>> bfMExists(K key,
                                    V... values)

Check if one or more items exist in the filter.

Parameters:

key - the key.

values - the values.

Returns:

List<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

Executions<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

Executions<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

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