io.lettuce.core.cluster.api.async

Interface NodeSelectionCuckooFilterAsyncCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

NodeSelectionAsyncCommands<K,V>

public interface NodeSelectionCuckooFilterAsyncCommands<K,V>

Asynchronous executed commands on a node selection for Cuckoo Filter.

Since:

7.7

Author:

Gyumin Hwang

See Also:

Redis Cuckoo Filter

Method Summary

Modifier and Type	Method and Description
AsyncExecutions<Boolean>	cfAdd(K key, V value) Add an item to the Cuckoo Filter.
AsyncExecutions<Boolean>	cfAddNx(K key, V value) Add an item to the Cuckoo Filter only if the item does not already exist.
AsyncExecutions<Long>	cfCount(K key, V value) Return the number of times an item may be in the Cuckoo Filter.
AsyncExecutions<Boolean>	cfDel(K key, V value) Delete an item from the Cuckoo Filter.
AsyncExecutions<Boolean>	cfExists(K key, V value) Check if an item exists in the Cuckoo Filter.
AsyncExecutions<CfInfoValue>	cfInfo(K key) Get information about the Cuckoo Filter.
AsyncExecutions<List<Boolean>>	cfInsert(K key, CfInsertArgs args, V... values) Add one or more items to a Cuckoo Filter.
AsyncExecutions<List<Boolean>>	cfInsert(K key, CfInsertArgs args, V value) Add one or more items to a Cuckoo Filter.
AsyncExecutions<List<Boolean>>	cfInsert(K key, V... values) Add one or more items to a Cuckoo Filter.
AsyncExecutions<List<Boolean>>	cfInsert(K key, V value) Add one or more items to a Cuckoo Filter.
AsyncExecutions<List<Boolean>>	cfInsertNx(K key, CfInsertArgs args, V... values) Add one or more items to a Cuckoo Filter only if the items do not already exist.
AsyncExecutions<List<Boolean>>	cfInsertNx(K key, CfInsertArgs args, V value) Add one or more items to a Cuckoo Filter only if the items do not already exist.
AsyncExecutions<List<Boolean>>	cfInsertNx(K key, V... values) Add one or more items to a Cuckoo Filter only if the items do not already exist.
AsyncExecutions<List<Boolean>>	cfInsertNx(K key, V value) Add one or more items to a Cuckoo Filter only if the items do not already exist.
AsyncExecutions<String>	cfLoadChunk(K key, long cursor, byte[] data) Restores a Cuckoo filter previously saved using CF.SCANDUMP.
AsyncExecutions<List<Boolean>>	cfMExists(K key, V... values) Check if one or more items exist in the Cuckoo Filter.
AsyncExecutions<String>	cfReserve(K key, long capacity) Creates an empty Cuckoo filter with a single sub-filter for the initial specified capacity.
AsyncExecutions<String>	cfReserve(K key, long capacity, CfReserveArgs args) Creates an empty Cuckoo filter with a single sub-filter for the initial specified capacity.
AsyncExecutions<ScanDumpValue>	cfScanDump(K key, long cursor) Begins an incremental save of the Cuckoo filter.

Method Detail

cfReserve

AsyncExecutions<String> cfReserve(K key,
                                  long capacity)

Creates an empty Cuckoo filter with a single sub-filter for the initial specified capacity.

Parameters:

key - the key.

capacity - the capacity.

Returns:

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

cfReserve

AsyncExecutions<String> cfReserve(K key,
                                  long capacity,
                                  CfReserveArgs args)

Creates an empty Cuckoo filter with a single sub-filter for the initial specified capacity.

Parameters:

key - the key.

capacity - the capacity.

args - the reserve arguments.

Returns:

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

cfAdd

AsyncExecutions<Boolean> cfAdd(K key,
                               V value)

Add an item to the Cuckoo Filter. A filter will be created if one does not exist.

Parameters:

key - the key.

value - the value.

Returns:

Boolean integer-reply true if the item was added.

Throws:

RedisCommandExecutionException - if the filter is full and cannot expand.

cfAddNx

AsyncExecutions<Boolean> cfAddNx(K key,
                                 V value)

Add an item to the Cuckoo Filter only if the item does not already exist. A filter will be created if one does not exist.

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.

cfInsert

AsyncExecutions<List<Boolean>> cfInsert(K key,
                                        V... values)

Add one or more items to a Cuckoo Filter. A filter will be created if one does not exist.

Parameters:

key - the key.

values - the values.

Returns:

List<Boolean> one entry per item: true if the item was added, false if the filter is full. CF.INSERT does not report already-existing items.

cfInsert

AsyncExecutions<List<Boolean>> cfInsert(K key,
                                        V value)

Add one or more items to a Cuckoo Filter. A filter will be created if one does not exist.

Parameters:

key - the key.

value - the value.

Returns:

List<Boolean> one entry per item: true if the item was added, false if the filter is full. CF.INSERT does not report already-existing items.

cfInsert

AsyncExecutions<List<Boolean>> cfInsert(K key,
                                        CfInsertArgs args,
                                        V... values)

Add one or more items to a Cuckoo Filter. A filter will be created if one does not exist.

Parameters:

key - the key.

args - the insert arguments.

values - the values.

Returns:

List<Boolean> one entry per item: true if the item was added, false if the filter is full. CF.INSERT does not report already-existing items.

cfInsert

AsyncExecutions<List<Boolean>> cfInsert(K key,
                                        CfInsertArgs args,
                                        V value)

Add one or more items to a Cuckoo Filter. A filter will be created if one does not exist.

Parameters:

key - the key.

args - the insert arguments.

value - the value.

Returns:

List<Boolean> one entry per item: true if the item was added, false if the filter is full. CF.INSERT does not report already-existing items.

cfInsertNx

AsyncExecutions<List<Boolean>> cfInsertNx(K key,
                                          V... values)

Add one or more items to a Cuckoo Filter only if the items do not already exist. A filter will be created if one does not exist.

Parameters:

key - the key.

values - the values.

Returns:

List<Boolean> one entry per item: true if the item was added (server reply 1); false if the item already exists in the filter (server reply 0); null if the item could not be added because the filter is full (server reply -1).

cfInsertNx

AsyncExecutions<List<Boolean>> cfInsertNx(K key,
                                          V value)

Add one or more items to a Cuckoo Filter only if the items do not already exist. A filter will be created if one does not exist.

Parameters:

key - the key.

value - the value.

Returns:

List<Boolean> one entry per item: true if the item was added (server reply 1); false if the item already exists in the filter (server reply 0); null if the item could not be added because the filter is full (server reply -1).

cfInsertNx

AsyncExecutions<List<Boolean>> cfInsertNx(K key,
                                          CfInsertArgs args,
                                          V... values)

Add one or more items to a Cuckoo Filter only if the items do not already exist. A filter will be created if one does not exist.

Parameters:

key - the key.

args - the insert arguments.

values - the values.

Returns:

List<Boolean> one entry per item: true if the item was added (server reply 1); false if the item already exists in the filter (server reply 0); null if the item could not be added because the filter is full (server reply -1).

cfInsertNx

AsyncExecutions<List<Boolean>> cfInsertNx(K key,
                                          CfInsertArgs args,
                                          V value)

Add one or more items to a Cuckoo Filter only if the items do not already exist. A filter will be created if one does not exist.

Parameters:

key - the key.

args - the insert arguments.

value - the value.

Returns:

List<Boolean> one entry per item: true if the item was added (server reply 1); false if the item already exists in the filter (server reply 0); null if the item could not be added because the filter is full (server reply -1).

cfExists

AsyncExecutions<Boolean> cfExists(K key,
                                  V value)

Check if an item exists in the Cuckoo 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.

cfMExists

AsyncExecutions<List<Boolean>> cfMExists(K key,
                                         V... values)

Check if one or more items exist in the Cuckoo 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 the item was definitely not added to the filter.

cfDel

AsyncExecutions<Boolean> cfDel(K key,
                               V value)

Delete an item from the Cuckoo Filter.

Warning: Deleting an item that was not previously added to the filter may cause false negatives for items that are actually present. Only delete items that have been previously added.

Parameters:

key - the key.

value - the value.

Returns:

Boolean integer-reply true if the item was deleted, false if the item was not found.

cfCount

AsyncExecutions<Long> cfCount(K key,
                              V value)

Return the number of times an item may be in the Cuckoo Filter.

Parameters:

key - the key.

value - the value.

Returns:

Long integer-reply the number of times the item may be in the filter.

cfScanDump

AsyncExecutions<ScanDumpValue> cfScanDump(K key,
                                          long cursor)

Begins an incremental save of the Cuckoo filter.

Parameters:

key - the key.

cursor - the cursor.

Returns:

ScanDumpValue the scan dump value.

cfLoadChunk

AsyncExecutions<String> cfLoadChunk(K key,
                                    long cursor,
                                    byte[] data)

Restores a Cuckoo filter previously saved using CF.SCANDUMP.

Parameters:

key - the key.

cursor - the cursor.

data - the data.

Returns:

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

cfInfo

AsyncExecutions<CfInfoValue> cfInfo(K key)

Get information about the Cuckoo Filter.

Parameters:

key - the key.

Returns:

CfInfoValue the information about the filter.