redis.clients.jedis.bloom.commands

Interface CuckooFilterCommands

All Known Subinterfaces:

RedisBloomCommands, RedisModuleCommands

All Known Implementing Classes:

JedisCluster, JedisPooled, JedisSentineled, MultiDbClient, UnifiedJedis

public interface CuckooFilterCommands

Interface for RedisBloom Cuckoo Filter Commands

See Also:

RedisBloom Cuckoo Filter Documentation

Method Summary

Modifier and Type	Method and Description
boolean	cfAdd(java.lang.String key, java.lang.String item) CF.ADD Adds an item to the cuckoo filter, creating the filter if it does not exist
boolean	cfAddNx(java.lang.String key, java.lang.String item) CF.ADDNX Adds an item to the cuckoo filter, only if it does not exist yet
long	cfCount(java.lang.String key, java.lang.String item) CF.COUNT Returns the number of times an item may be in the filter.
boolean	cfDel(java.lang.String key, java.lang.String item) CF.DEL Deletes an item once from the filter.
boolean	cfExists(java.lang.String key, java.lang.String item) CF.EXISTS Check if an item exists in a Cuckoo Filter
java.util.Map<java.lang.String,java.lang.Object>	cfInfo(java.lang.String key) CF.INFO Return information about filter
java.util.List<java.lang.Boolean>	cfInsert(java.lang.String key, CFInsertParams insertParams, java.lang.String... items) CF.INSERT Adds one or more items to a cuckoo filter, using the passed options
java.util.List<java.lang.Boolean>	cfInsert(java.lang.String key, java.lang.String... items) CF.INSERT Adds one or more items to a cuckoo filter, creating it if it does not exist yet.
java.util.List<java.lang.Boolean>	cfInsertNx(java.lang.String key, CFInsertParams insertParams, java.lang.String... items) CF.INSERTNX Adds one or more items to a cuckoo filter, using the passed options
java.util.List<java.lang.Boolean>	cfInsertNx(java.lang.String key, java.lang.String... items) CF.INSERTNX Adds one or more items to a cuckoo filter, only if it does not exist yet
java.lang.String	cfLoadChunk(java.lang.String key, long iterator, byte[] data) CF.LOADCHUNK Restores a filter previously saved using SCANDUMP.
java.util.List<java.lang.Boolean>	cfMExists(java.lang.String key, java.lang.String... items) CF.MEXISTS {key} {item ...}
java.lang.String	cfReserve(java.lang.String key, long capacity) CF.RESERVE Creates a Cuckoo Filter under key with the given parameters
java.lang.String	cfReserve(java.lang.String key, long capacity, CFReserveParams reserveParams) CF.RESERVE Creates a Cuckoo Filter under key with the given parameters
java.util.Map.Entry<java.lang.Long,byte[]>	cfScanDump(java.lang.String key, long iterator) CF.SCANDUMP Begins an incremental save of the cuckoo filter.

Method Detail

cfReserve

java.lang.String cfReserve(java.lang.String key,
                           long capacity)

CF.RESERVE Creates a Cuckoo Filter under key with the given parameters

Parameters:

key - The name of the filter

capacity -

Returns:

OK

cfReserve

java.lang.String cfReserve(java.lang.String key,
                           long capacity,
                           CFReserveParams reserveParams)

CF.RESERVE Creates a Cuckoo Filter under key with the given parameters

Parameters:

key - The name of the filter

capacity -

reserveParams - An instance of CFReserveParams containing the options

Returns:

OK

cfAdd

boolean cfAdd(java.lang.String key,
              java.lang.String item)

CF.ADD Adds an item to the cuckoo filter, creating the filter if it does not exist

Parameters:

key - The name of the filter

item - The item to add

Returns:

true on success, false otherwise

cfAddNx

boolean cfAddNx(java.lang.String key,
                java.lang.String item)

CF.ADDNX Adds an item to the cuckoo filter, only if it does not exist yet

Parameters:

key - The name of the filter

item - The item to add

Returns:

true if the item was added to the filter, false if the item already exists.

cfInsert

java.util.List<java.lang.Boolean> cfInsert(java.lang.String key,
                                           java.lang.String... items)

CF.INSERT Adds one or more items to a cuckoo filter, creating it if it does not exist yet.

Parameters:

key - The name of the filter

items - One or more items to add

Returns:

true if the item was successfully inserted, false if an error occurred

cfInsert

java.util.List<java.lang.Boolean> cfInsert(java.lang.String key,
                                           CFInsertParams insertParams,
                                           java.lang.String... items)

CF.INSERT Adds one or more items to a cuckoo filter, using the passed options

Parameters:

key - The name of the filter

insertParams - An instance of CFInsertParams containing the options

items - One or more items to add

Returns:

true if the item was successfully inserted, false if an error occurred

cfInsertNx

java.util.List<java.lang.Boolean> cfInsertNx(java.lang.String key,
                                             java.lang.String... items)

CF.INSERTNX Adds one or more items to a cuckoo filter, only if it does not exist yet

Parameters:

key - The name of the filter

items - One or more items to add

Returns:

true if the item was added to the filter, false if the item already exists.

cfInsertNx

java.util.List<java.lang.Boolean> cfInsertNx(java.lang.String key,
                                             CFInsertParams insertParams,
                                             java.lang.String... items)

CF.INSERTNX Adds one or more items to a cuckoo filter, using the passed options

Parameters:

key - The name of the filter

insertParams - An instance of CFInsertParams containing the options (CAPACITY/NOCREATE)

items - One or more items to add

Returns:

true if the item was added to the filter, false if the item already exists.

cfExists

boolean cfExists(java.lang.String key,
                 java.lang.String item)

CF.EXISTS Check if an item exists in a Cuckoo Filter

Parameters:

key - The name of the filter

item - The item to check for

Returns:

false if the item certainly does not exist, true if the item may exist.

cfMExists

java.util.List<java.lang.Boolean> cfMExists(java.lang.String key,
                                            java.lang.String... items)

CF.MEXISTS {key} {item ...}

Parameters:

key - The name of the filter

items - Items to check for (non empty sequence)

Returns:

a list of booleans where false if the item certainly does not exist, true if the item may exist.

cfDel

boolean cfDel(java.lang.String key,
              java.lang.String item)

CF.DEL 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.

Parameters:

key - The name of the filter

item - The item to delete from the filter

Returns:

true if the item has been deleted, false if the item was not found.

cfCount

long cfCount(java.lang.String key,
             java.lang.String item)

CF.COUNT Returns the number of times an item may be in the filter.

Parameters:

key - The name of the filter

item - The item to count

Returns:

The number of times the item exists in the filter

cfScanDump

java.util.Map.Entry<java.lang.Long,byte[]> cfScanDump(java.lang.String key,
                                                      long iterator)

CF.SCANDUMP Begins an incremental save of the cuckoo filter. This is useful for large cuckoo filters which cannot fit into the normal SAVE and RESTORE model. The Iterator is passed as input to the next invocation of SCANDUMP . If Iterator is 0, the iteration has completed.

Parameters:

key - Name of the filter

iterator - This is either 0, or the iterator from a previous invocation of this command

Returns:

a Map.Entry containing the Iterator and Data.

cfLoadChunk

java.lang.String cfLoadChunk(java.lang.String key,
                             long iterator,
                             byte[] data)

CF.LOADCHUNK Restores a filter previously saved using SCANDUMP.

Parameters:

key - Name of the filter to restore

iterator - Iterator from CF.SCANDUMP

data - Data from CF.SCANDUMP

Returns:

OK

cfInfo

java.util.Map<java.lang.String,java.lang.Object> cfInfo(java.lang.String key)

CF.INFO Return information about filter

Parameters:

key - Name of the filter to restore

Returns:

A Map containing Size, Number of buckets, Number of filter, Number of items inserted, Number of items deleted, Bucket size, Expansion rate, Max iteration