BF.INFO

Syntax
BF.INFO key [CAPACITY | SIZE | FILTERS | ITEMS | EXPANSION]
Available in:
Redis Stack / Bloom 1.0.0
Time complexity:
O(1)

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.

When no optional argument is specified: return all information fields.

Return value

When no optional argument is specified, returns one of these replies:

When an optional argument is specified, returns one of these replies:

  • Integer reply - argument value
  • Error reply on error (invalid arguments, key does not exist, wrong key type, and so on)

Examples

redis> BF.ADD bf1 observation1
(integer) 1
redis> BF.INFO bf1
 1) Capacity
 2) (integer) 100
 3) Size
 4) (integer) 240
 5) Number of filters
 6) (integer) 1
 7) Number of items inserted
 8) (integer) 1
 9) Expansion rate
10) (integer) 2
redis> BF.INFO bf1 CAPACITY
1) (integer) 100
Rate this page