BF.EXISTS

Syntax text Syntax diagram API methods

BF.EXISTS key item

Client:

exists(
    key: str,  // The name of the Bloom filter
    item: str  // The item to check
) → int  // 1 if item may exist, 0 if item definitely does not exist

BF.EXISTS(
    key: RedisArgument,  // The name of the Bloom filter
    item: RedisArgument  // The item to check
) → boolean  // true if item may exist

bfExists(
    key: String,  // The name of the Bloom filter
    item: String  // The item to check
) → boolean  // true if item may exist

BFExists(
    ctx: context.Context,  // Context
    key: string,  // The name of the Bloom filter
    element: interface{}  // The item to check
) → *BoolCmd  // Boolean command result

Exists(
    key: RedisKey,  // The name of the Bloom filter
    item: RedisValue  // The item to check
) → bool  // true if item may exist

ExistsAsync(
    key: RedisKey,  // The name of the Bloom filter
    item: RedisValue  // The item to check
) → Task<bool>  // true if item may exist

bfexists(
    $key: string,  // The name of the Bloom filter
    $item: mixed  // The item to check
) → mixed  // 1 if may exist, 0 otherwise

bf_exists(
    key: K,  // The name of the Bloom filter
    value: V  // The item to check for
) → (bool)  // true if the item may exist, false if it definitely does not

bf_exists(
    key: K,  // The name of the Bloom filter
    value: V  // The item to check for
) → (bool)  // true if the item may exist, false if it definitely does not

Available in:: Redis Open Source / Bloom 1.0.0
Time complexity:: O(k), where k is the number of hash functions used by the last sub-filter
ACL categories:: @bloom, @read, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

Determines whether a given item was added to a Bloom filter.

This command is similar to BF.MEXISTS, except that only one item can be checked.

Required arguments

key

is key name for a Bloom filter.

item

is an item to check.

Examples

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Supported	✅ Flexible & Annual ✅ Free & Fixed

Return information

RESP2 RESP3

One of the following:

Integer reply, where a value of 1 means the item was probably already added to the filter. A value of 0 means the item was definitely not added, key does not exist, or key contains a value of the wrong type.
Simple error reply if invalid arguments are passed.