CF.ADD

Adds an item to the cuckoo filter.

Cuckoo filters can contain the same item multiple times, and consider each addition as separate. Use [CF.ADDNX]({{< relref "commands/cf.addnx/" >}}) to add an item only if it does not exist.

Required arguments

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

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

If key does not exist - a new cuckoo filter is created.

</details> <details open><summary><code>item</code></summary>

is an item to add.

</details>

Complexity

O(n + i), where n is the number of sub-filters and i is maxIterations. Adding items requires up to 2 memory accesses per sub-filter. But as the filter fills up, both locations for an item might be full. The filter attempts to Cuckoo swap items up to maxIterations times.

Examples

{{< highlight bash >}} redis> CF.ADD cf item1 (integer) 1 redis> CF.ADD cf item1 (integer) 1 {{< / 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"><nobr>✅ Flexible & Annual</nobr></span> <span title="Supported">✅ Free & Fixed</nobr></span> | |

Return information

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

One of the following:

• [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}): 1 for successfully adding an item to the filter.
• [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, or when the filter is full.

-tab-sep-

One of the following:

• [Boolean reply]({{< relref "/develop/reference/protocol-spec#booleans" >}}): true for successfully adding an item to the filter.
• [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, or when the filter is full.

{{< /multitabs >}}