Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions content/commands/ft.config-get/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,19 @@ categories:
command_flags:
- readonly
complexity: O(1)
deprecated_since: 8.0.0
description: Retrieves runtime configuration options
doc_flags:
- deprecated
group: search
hidden: false
linkTitle: FT.CONFIG GET
module: Search
replaced_by: '[`CONFIG GET`]({{< relref "/commands/config-get" >}})'
since: 1.0.0
stack_path: docs/interact/search-and-query
summary: Retrieves runtime configuration options
syntax: 'FT.CONFIG GET option

'
syntax: FT.CONFIG GET option
syntax_fmt: FT.CONFIG GET option
syntax_str: ''
title: FT.CONFIG GET
Expand Down
10 changes: 6 additions & 4 deletions content/commands/ft.config-set/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,19 @@ categories:
- kubernetes
- clients
complexity: O(1)
deprecated_since: 8.0.0
description: Sets runtime configuration options
doc_flags:
- deprecated
group: search
hidden: false
linkTitle: FT.CONFIG SET
module: Search
replaced_by: '[`CONFIG SET`]({{< relref "/commands/config-set" >}})'
since: 1.0.0
stack_path: docs/interact/search-and-query
summary: Sets runtime configuration options
syntax: 'FT.CONFIG SET option value

'
syntax: FT.CONFIG SET option value
syntax_fmt: FT.CONFIG SET option value
syntax_str: value
title: FT.CONFIG SET
Expand All @@ -35,7 +37,7 @@ Set the value of a RediSearch configuration parameter.

Values set using `FT.CONFIG SET` are not persisted after server restart.

RediSearch configuration parameters are detailed in [Configuration parameters]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}).
RediSearch configuration parameters are detailed in [Configuration parameters]({{< relref "/develop/interact/search-and-query/administration/configuration" >}}).

{{% alert title="Note" color="warning" %}}
As detailed in the link above, not all RediSearch configuration parameters can be set at runtime.
Expand Down
4 changes: 4 additions & 0 deletions content/commands/module-load/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,7 @@ unmodified to the module.

**Note**: modules can also be loaded at server startup with `loadmodule`
configuration directive in `redis.conf`.

{{< note >}}
As of Redis CE v8.0.0, loading a module via the Redis CLI with configuration parameters is deprecated.
{{< /note >}}
101 changes: 0 additions & 101 deletions content/develop/data-types/probabilistic/Configuration.md

This file was deleted.

174 changes: 174 additions & 0 deletions content/develop/data-types/probabilistic/configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
---
categories:
- docs
- develop
- stack
- oss
- rs
- rc
- oss
- kubernetes
- clients
description: Redis probabilistic data structures support multiple configuration parameters.
linkTitle: Configuration
title: Configuration Parameters
weight: 100
---
{{< note >}}
As of Redis Community Edition (CE) 8.0, configuration parameters for the probabilistic data structures are now set in the following ways:
* At load time via your `redis.conf` file.
* At run time (where applicable) using the [`CONFIG SET`]({{< relref "/commands/config-set" >}}) command.

Also, Redis CE 8.0 persists probabilistic configuration parameters just like any other configuration parameters (e.g., using the [`CONFIG REWRITE`]({{< baseurl >}}/commands/config-rewrite/) command).
{{< /note >}}


## Redis probabilistic data structure configuration parameters

The following table summarizes which Bloom filter configuration parameters can be set at run-time, and compatibility with Redis Software and Redis Cloud

| Parameter name<br />(version < 8.0) | Parameter name<br />(version &#8805; 8.0) | Run-time | Redis<br />Software | Redis<br />Cloud |
| :------- | :------- | :------- | :------- | :------- |
| ERROR_RATE | [bf-error-rate](#bf-error-rate) | :white_check_mark: | <span title="Supported">&#x2705; Supported</span><br /><span><br /></span> | <span title="Supported">&#x2705; Flexible & Annual</span><br /><span title="Not supported"><nobr>&#x274c; Free & Fixed</nobr></span> |
| | [bf-expansion-factor](#bf-expansion-factor) | :white_check_mark: |||
| INITIAL_SIZE | [bf-initial-size](#bf-initial-size) | :white_check_mark: | <span title="Supported">&#x2705; Supported</span><br /><span><br /></span> | <span title="Supported">&#x2705; Flexible & Annual</span><br /><span title="Not supported"><nobr>&#x274c; Free & Fixed</nobr></span> |

The following table summarizes which Cuckoo filter configuration parameters can be set at run-time, and compatibility with Redis Software and Redis Cloud.

| Parameter name<br />(version < 8.0) | Parameter name<br />(version &#8805; 8.0) | Run-time | Redis<br />Software | Redis<br />Cloud |
| :------- | :------- | :------- | :------- | :------- |
| | [cf-bucket-size](#cf-bucket-size) | :white_check_mark: |||
| | [cf-initial-size](#cf-initial-size) | :white_check_mark: |||
| | [cf-expansion-factor](#cf-expansion-factor) | :white_check_mark: |||
| CF_MAX_EXPANSIONS | [cf-max-expansions](#cf-max-expansions) | :white_check_mark: | <span title="Supported">&#x2705; Supported</span><br /><span><br /></span> | <span title="Supported">&#x2705; Flexible & Annual</span><br /><span title="Not supported"><nobr>&#x274c; Free & Fixed</nobr></span> |
| | [cf-max-iterations](#cf-max-iterations) | :white_check_mark: |||

{{< note >}}
Parameter names for Redis CE versions < 8.0, while deprecated, will still be supported in version 8.0.
{{< /note >}}

---

{{< warning >}}
A filter should always be sized for the expected capacity and the desired error rate.
Using the `INSERT` family commands with the default values should be used in cases where many small filters exist and the expectation is most will remain at around the default sizes.
Not optimizing a filter for its intended use will result in degradation of performance and memory efficiency.
{{< /warning >}}

## Default parameters for Bloom filters

### bf-error-rate

Default error ratio for Bloom filters.

Type: double

Valid range: `[0 .. 1]`

Default: `0.01`

### bf-expansion-factor

Added in v8.0.0.

Expansion factor for Bloom filters.

Type: integer

Valid range: `[0 .. 32768]`.

Default: `2`

### bf-initial-size

Initial capacity for Bloom filters.

Type: integer

Valid range: `[1 .. 1,048,576]`

Default: `100`

## Default parameters for Cuckoo filters

### cf-bucket-size

Added in v8.0.0.

The number of items in each Cuckoo filter bucket.

Type: integer

Valid range: `[1 .. 255]`

Default: `2`

### cf-initial-size

Added in v8.0.0.

Cuckoo filter initial capacity.

Type: integer

Valid range: `[2*cf-bucket-size .. 1GB]`

Default: `1024`

### cf-expansion-factor

Added in v8.0.0.

Expansion factor for Cuckoo filters.

Type: integer

Valid range: `[0 .. 32768]`

Default: `1`

### cf-max-expansions

The maximum number of expansions for Cuckoo filters.

Type: integer

Valid range: `[1 .. 65535]`

Default: `32`

### cf-max-iterations

Added in v8.0.0

The maximum number of iterations for Cuckoo filters.

Type: integer

Valid range: `[1 .. 65535]`

Default: `20`

## Setting configuration parameters on module load (deprecated)

These methods are deprecated beginning with Redis CE v8.0.0.

Setting configuration parameters at load-time is done by appending arguments after the `--loadmodule` argument when starting a server from the command line or after the `loadmodule` directive in a Redis config file. For example:

In [redis.conf]({{< relref "/operate/oss_and_stack/management/config" >}}):

```sh
loadmodule ./redisbloom.so [OPT VAL]...
```

From the [Redis CLI]({{< relref "/develop/tools/cli" >}}), using the [MODULE LOAD]({{< relref "/commands/module-load" >}}) command:

```
127.0.0.6379> MODULE LOAD redisbloom.so [OPT VAL]...
```

From the command line:

```sh
$ redis-server --loadmodule ./redisbloom.so [OPT VAL]...
```
Loading
Loading