BF.ADD

Syntax text Syntax diagram API methods

BF.ADD key item

Client:

add(
    key: str,  // The name of the Bloom filter
    item: str  // The item to add to the filter
) → int  // 1 if the item was newly added, 0 if it may have existed previously

BF.ADD(
    key: RedisArgument,  // The name of the Bloom filter
    item: RedisArgument  // The item to add
) → boolean  // true if newly added

bfAdd(
    key: String,  // The name of the Bloom filter
    item: String  // The item to add
) → boolean  // true if newly added, false if may have existed

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

Add(
    key: RedisKey,  // The name of the Bloom filter
    item: RedisValue  // The item to add
) → bool  // true if newly added

AddAsync(
    key: RedisKey,  // The name of the Bloom filter
    item: RedisValue  // The item to add
) → Task<bool>  // true if newly added

bfadd(
    $key: string,  // The name of the Bloom filter
    $item: mixed  // The item to add
) → mixed  // 1 if newly added, 0 otherwise

bf_add(
    key: K,  // The name of the Bloom filter
    value: V  // The item to add to the filter
) → (bool)  // true if the item was newly added, false if it may have existed previously

bf_add(
    key: K,  // The name of the Bloom filter
    value: V  // The item to add to the filter
) → (bool)  // true if the item was newly added, false if it may have existed previously

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, @write, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

Adds an item to a Bloom filter.

This command is similar to BF.MADD, except that only one item can be added.

Required arguments

key

is key name for a Bloom filter to add the item to.

If key does not exist - a new Bloom filter is created with default error rate, capacity, and expansion (see BF.RESERVE).

item

is an item to add.

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: 1 for successfully adding an item, or 0 if there's a probability that the item was already added to the filter.
Simple error reply in these cases: invalid arguments, wrong key type, or when the filter is full.