BF.INFO

Syntax text Syntax diagram API methods

BF.INFO key [CAPACITY | SIZE | FILTERS | ITEMS | EXPANSION]

Client:

info(
    key: str  // The name of the Bloom filter
) → dict  // Dictionary with capacity, size, number of filters, items inserted, and expansion rate

BF.INFO(
    key: RedisArgument  // The name of the Bloom filter
) → BfInfoReplyMap  // Map with Capacity, Size, Number of filters, Items inserted, Expansion rate

bfInfo(
    key: String  // The name of the Bloom filter
) → Map<String, Object>  // Map containing filter information

BFInfo(
    ctx: context.Context,  // Context
    key: string  // The name of the Bloom filter
) → *BFInfoCmd  // BFInfo command result with Capacity, Size, Filters, ItemsInserted, ExpansionRate

Info(
    key: RedisKey  // The name of the Bloom filter
) → BloomInformation  // Object containing filter information

InfoAsync(
    key: RedisKey  // The name of the Bloom filter
) → Task<BloomInformation>  // Object containing filter information

bfinfo(
    $key: string,  // The name of the Bloom filter
    $modifier: string  // Optional modifier (CAPACITY, SIZE, FILTERS, ITEMS, EXPANSION)
) → array  // Array containing filter information

bf_info(
    key: K  // The name of the Bloom filter
) → (HashMap<String, BloomFilterInfoTypeResponse>)  // A map of all available information about the filter

bf_info_type(
    key: K,  // The name of the Bloom filter
    info_type: BloomFilterInfoType  // The single piece of information to return
) → (BloomFilterInfoTypeResponse)  // The requested information value (derefs to f64)

bf_info(
    key: K  // The name of the Bloom filter
) → (HashMap<String, BloomFilterInfoTypeResponse>)  // A map of all available information about the filter

bf_info_type(
    key: K,  // The name of the Bloom filter
    info_type: BloomFilterInfoType  // The single piece of information to return
) → (BloomFilterInfoTypeResponse)  // The requested information value (derefs to f64)

Available in:: Redis Open Source / Bloom 1.0.0
Time complexity:: O(1)
ACL categories:: @bloom, @read, @fast,
Compatibility:: Redis Software and Redis Cloud compatibility

Returns information about a Bloom filter.

Required arguments

key

is key name for a Bloom filter.

Optional arguments

CAPACITY

Return the number of unique items that can be stored in this Bloom filter before scaling would be required (including already added items).

SIZE

Return the memory size: number of bytes allocated for this Bloom filter.

FILTERS

Return the number of sub-filters.

ITEMS

Return the number of items that were added to this Bloom filter and detected as unique (items that caused at least one bit to be set in at least one sub-filter).

EXPANSION

Return the expansion rate.

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:

A singleton array reply with an integer representing the value of the requested property.
An array reply with simple string and integer pairs.
Simple error reply in these cases: invalid arguments, wrong key type, or when the key does not exist.