Probabilistic data structure commands
The following tables list probabilistic data structure commands. See the command links for more information about each command’s syntax, arguments, and examples.
Bloom filter commands
| Command | Redis Enterprise | Redis Cloud | Description |
|---|---|---|---|
| BF.ADD | ✅ Supported | ✅ Free & Fixed | Adds an item to the filter. |
| BF.EXISTS | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Checks if an item exists in the filter. |
| BF.INFO | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Returns information about a Bloom filter. |
| BF.INSERT | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Adds multiple items to a filter. If the key does not exist, it creates a new filter. |
| BF.LOADCHUNK | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Restores a Bloom filter previously saved with BF.SCANDUMP. |
| BF.MADD | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Adds multiple items to the filter. |
| BF.MEXISTS | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | For multiple items, checks if each item exists in the filter. |
| BF.RESERVE | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Creates a Bloom filter. Sets the false positive rate and capacity. |
| BF.SCANDUMP | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Starts an incremental save of a Bloom filter. |
Cuckoo filter commands
| Command | Redis Enterprise | Redis Cloud | Description |
|---|---|---|---|
| CF.ADD | ✅ Supported | ✅ Free & Fixed | Adds an item to a filter. |
| CF.ADDNX | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Adds an item to a filter only if the item does not already exist. |
| CF.COUNT | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Returns the probable number of times an item occurs in the filter. |
| CF.DEL | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Removes one instance of an item from the filter. |
| CF.EXISTS | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Checks if an item exists in the filter. |
| CF.INFO | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Returns information about a cuckoo filter. |
| CF.INSERT | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Adds multiple items to a filter. Optionally sets the capacity if the filter does not already exist. |
| CF.INSERTNX | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Adds multiple items to a filter if they do not already exist. Optionally sets the capacity if the filter does not already exist. |
| CF.LOADCHUNK | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Restores a cuckoo filter previously saved with CF.SCANDUMP. |
| CF.MEXISTS | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | For multiple items, checks if each item exists in the filter. |
| CF.RESERVE | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Creates a cuckoo filter and sets its capacity. |
| CF.SCANDUMP | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Starts an incremental save of a cuckoo filter. |
Count-min sketch commands
| Command | Redis Enterprise | Redis Cloud | Description |
|---|---|---|---|
| CMS.INCRBY | ✅ Supported | ✅ Free & Fixed | Increases item counts. |
| CMS.INFO | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Returns width, depth, and total count of the sketch. |
| CMS.INITBYDIM | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Initializes a count-min sketch to the specified dimensions (width and depth). |
| CMS.INITBYPROB | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Initializes a count-min sketch to allow the specified overestimation percent for the item count and the probability of overestimation. |
| CMS.MERGE | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Merges several sketches into one sketch. |
| CMS.QUERY | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Returns the count for one or more items in a sketch. |
Top-k commands
| Command | Redis Enterprise | Redis Cloud | Description |
|---|---|---|---|
| TOPK.ADD | ✅ Supported | ✅ Free & Fixed | Adds an item to the data structure. |
| TOPK.COUNT | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Returns probable item counts. |
| TOPK.INCRBY | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Increases the score of an item by the specified number. |
| TOPK.INFO | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Returns the number of required items (k), width, depth, and decay values. |
| TOPK.LIST | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Returns the keys of items in the top-k list. Optionally returns their item counts. |
| TOPK.QUERY | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Checks whether an item is one of top-k items. |
| TOPK.RESERVE | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Initializes a top-k with the specified number of top occurring items to keep, width, depth, and decay. |
T-digest sketch commands
| Command | Redis Enterprise | Redis Cloud | Description |
|---|---|---|---|
| TDIGEST.ADD | ✅ Supported | ✅ Free & Fixed | Adds one or more samples to a t-digest sketch. |
| TDIGEST.CDF | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Estimates the fraction of all observations which are less than or equal to the specified value. |
| TDIGEST.CREATE | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Allocates memory and initializes a t-digest sketch. |
| TDIGEST.INFO | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Returns information about the t-digest sketch. |
| TDIGEST.MAX | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Returns the maximum value from the sketch. |
| TDIGEST.MERGE | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Copies values from one sketch to another. |
| TDIGEST.MERGESTORE | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Merges multiple sketches and stores the combined sketch in a new key. |
| TDIGEST.MIN | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Returns the minimum value from the sketch. |
| TDIGEST.QUANTILE | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Estimates one or more cutoffs. |
| TDIGEST.RESET | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Resets the sketch and reinitializes it. |
| TDIGEST.TRIMMED_MEAN | ✅ Supported | ✅ Flexible & Annual ✅ Free & Fixed | Estimates the mean value from the sketch, excluding values outside the specified range. |