CF.EXISTS

Syntax text Syntax diagram API methods

CF.EXISTS key item

Client:

exists(
    key: str,  // The name of the Cuckoo filter
    item: str  // The item to check
) → bool  // True if item may exist, False if certainly doesn't

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

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

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

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

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

cfexists(
    $key: string,  // The name of the Cuckoo filter
    $item: mixed  // The item to check
) → mixed  // Result of the operation

Available in:: Redis Open Source / Bloom 1.0.0
Time complexity:: O(k), where k is the number of sub-filters
ACL categories:: @cuckoo, @read, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

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

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

Required arguments

key

is key name for a cuckoo filter.

item

is an item to check.

Examples

redis> CF.ADD cf item1
(integer) 1
redis> CF.EXISTS cf item1
(integer) 1
redis> CF.EXISTS cf item2
(integer) 0

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.