BF.INFO

Returns information about a Bloom filter.

Required arguments

<details open><summary><code>key</code></summary>

is key name for a Bloom filter.

</details>

Optional arguments

<details open><summary><code>CAPACITY</code></summary>

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

</details> <details open><summary><code>SIZE</code></summary>

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

</details> <details open><summary><code>FILTERS</code></summary>

Return the number of sub-filters.

</details> <details open><summary><code>ITEMS</code></summary>

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).

</details> <details open><summary><code>EXPANSION</code></summary>

Return the expansion rate.

</details>

Examples

{{< highlight bash >}} 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
11. (integer) 100 {{< / highlight >}}

Redis Software and Redis Cloud compatibility

| Redis Software | Redis Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> | |:----------------------|:-----------------|:------| | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Flexible & Annual</span> <span title="Supported">✅ Free & Fixed</nobr></span> | |

Return information

{{< multitabs id="bf-info-return-info" tab1="RESP2" tab2="RESP3" >}}

One of the following:

• A singleton [array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) with an [integer]({{< relref "/develop/reference/protocol-spec#integers" >}}) representing the value of the requested property.
• An [array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) with [simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) and [integer]({{< relref "/develop/reference/protocol-spec#integers" >}}) pairs.
• [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, or when the key does not exist.

-tab-sep-

One of the following:

• [Map reply]({{< relref "/develop/reference/protocol-spec#maps" >}}) with [simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) and [integer]({{< relref "/develop/reference/protocol-spec#integers" >}}) pairs.
• [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, or when the key does not exist.

{{< /multitabs >}}