io.valkey.bloom.commands

Interface BloomFilterCommands

All Known Subinterfaces:

RedisBloomCommands, RedisModuleCommands

All Known Implementing Classes:

JedisCluster, JedisPooled, JedisSentineled, JedisSharding, UnifiedJedis

public interface BloomFilterCommands

Method Summary

Modifier and Type	Method and Description
boolean	bfAdd(String key, String item) BF.ADD {key} {item}
long	bfCard(String key)
boolean	bfExists(String key, String item) BF.EXISTS {key} {item}
Map<String,Object>	bfInfo(String key)
List<Boolean>	bfInsert(String key, BFInsertParams insertParams, String... items) BF.INSERT {key} [CAPACITY {cap}] [ERROR {error}] [EXPANSION {expansion}] [NOCREATE] [NONSCALING] ITEMS {item ...}
List<Boolean>	bfInsert(String key, String... items) BF.INSERT {key} ITEMS {item ...}
String	bfLoadChunk(String key, long iterator, byte[] data) BF.LOADCHUNK {key} {iterator} {data}
List<Boolean>	bfMAdd(String key, String... items) BF.MADD {key} {item ...}
List<Boolean>	bfMExists(String key, String... items) BF.MEXISTS {key} {item ...}
String	bfReserve(String key, double errorRate, long capacity) BF.RESERVE {key} {error_rate} {capacity}
String	bfReserve(String key, double errorRate, long capacity, BFReserveParams reserveParams) BF.RESERVE {key} {error_rate} {capacity} [EXPANSION {expansion}] [NONSCALING]
Map.Entry<Long,byte[]>	bfScanDump(String key, long iterator) BF.SCANDUMP {key} {iterator}

Method Detail

bfReserve

String bfReserve(String key,
                 double errorRate,
                 long capacity)

BF.RESERVE {key} {error_rate} {capacity}

Parameters:

key -

errorRate -

capacity -

Returns:

OK

bfReserve

String bfReserve(String key,
                 double errorRate,
                 long capacity,
                 BFReserveParams reserveParams)

BF.RESERVE {key} {error_rate} {capacity} [EXPANSION {expansion}] [NONSCALING]

Parameters:

key -

errorRate -

capacity -

reserveParams -

Returns:

OK

bfAdd

boolean bfAdd(String key,
              String item)

BF.ADD {key} {item}

Parameters:

key -

item -

bfMAdd

List<Boolean> bfMAdd(String key,
                     String... items)

BF.MADD {key} {item ...}

Parameters:

key -

items -

bfInsert

List<Boolean> bfInsert(String key,
                       String... items)

BF.INSERT {key} ITEMS {item ...}

Parameters:

key -

items -

bfInsert

List<Boolean> bfInsert(String key,
                       BFInsertParams insertParams,
                       String... items)

BF.INSERT {key} [CAPACITY {cap}] [ERROR {error}] [EXPANSION {expansion}] [NOCREATE] [NONSCALING] ITEMS {item ...}

Parameters:

key -

insertParams -

items -

bfExists

boolean bfExists(String key,
                 String item)

BF.EXISTS {key} {item}

Parameters:

key -

item -

Returns:

if the item may exist

bfMExists

List<Boolean> bfMExists(String key,
                        String... items)

BF.MEXISTS {key} {item ...}

Parameters:

key -

items -

bfScanDump

Map.Entry<Long,byte[]> bfScanDump(String key,
                                  long iterator)

BF.SCANDUMP {key} {iterator}

Parameters:

key -

iterator -

Returns:

Pair of next iterator and current data

bfLoadChunk

String bfLoadChunk(String key,
                   long iterator,
                   byte[] data)

BF.LOADCHUNK {key} {iterator} {data}

Parameters:

key -

iterator -

data -

Returns:

OK

bfCard

long bfCard(String key)

bfInfo

Map<String,Object> bfInfo(String key)