Skip to content

Commit 43a231d

Browse files
dwdoughertydwdougherty
committed
DEV: CONFIG for modules changes for CE8
1 parent c39ae61 commit 43a231d

File tree

13 files changed

+849
-861
lines changed

13 files changed

+849
-861
lines changed

‎content/commands/ft.config-get/index.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,19 @@ categories:
1515
command_flags:
1616
- readonly
1717
complexity: O(1)
18+
deprecated_since: 8.0.0
1819
description: Retrieves runtime configuration options
20+
doc_flags:
21+
- deprecated
1922
group: search
2023
hidden: false
2124
linkTitle: FT.CONFIG GET
2225
module: Search
26+
replaced_by: '[`CONFIG GET`]({{< relref "/commands/config-get" >}})'
2327
since: 1.0.0
2428
stack_path: docs/interact/search-and-query
2529
summary: Retrieves runtime configuration options
26-
syntax: 'FT.CONFIG GET option
27-
28-
'
30+
syntax: FT.CONFIG GET option
2931
syntax_fmt: FT.CONFIG GET option
3032
syntax_str: ''
3133
title: FT.CONFIG GET

‎content/commands/ft.config-set/index.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,19 @@ categories:
1515
- kubernetes
1616
- clients
1717
complexity: O(1)
18+
deprecated_since: 8.0.0
1819
description: Sets runtime configuration options
20+
doc_flags:
21+
- deprecated
1922
group: search
2023
hidden: false
2124
linkTitle: FT.CONFIG SET
2225
module: Search
26+
replaced_by: '[`CONFIG SET`]({{< relref "/commands/config-set" >}})'
2327
since: 1.0.0
2428
stack_path: docs/interact/search-and-query
2529
summary: Sets runtime configuration options
26-
syntax: 'FT.CONFIG SET option value
27-
28-
'
30+
syntax: FT.CONFIG SET option value
2931
syntax_fmt: FT.CONFIG SET option value
3032
syntax_str: value
3133
title: FT.CONFIG SET
@@ -35,7 +37,7 @@ Set the value of a RediSearch configuration parameter.
3537

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

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

4042
{{% alert title="Note" color="warning" %}}
4143
As detailed in the link above, not all RediSearch configuration parameters can be set at runtime.

‎content/commands/module-load/index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,7 @@ unmodified to the module.
4747

4848
**Note**: modules can also be loaded at server startup with `loadmodule`
4949
configuration directive in `redis.conf`.
50+
51+
{{< note >}}
52+
As of Redis CE v8.0.0, loading a module via the Redis CLI with configuration parameters is deprecated.
53+
{{< /note >}}

‎content/develop/data-types/probabilistic/Configuration.md‎

Lines changed: 117 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -9,93 +9,158 @@ categories:
99
- oss
1010
- kubernetes
1111
- clients
12-
description: 'RedisBloom supports multiple module configuration parameters. All of
13-
these parameters can only be set at load-time.
14-
15-
'
12+
description: Redis probabilistic data structures support multiple configuration parameters.
1613
linkTitle: Configuration
1714
title: Configuration Parameters
1815
weight: 100
1916
---
17+
{{< note >}}
18+
As of Redis Community Edition 8.0, configuration parameters for the probabilistic data structures are now set in the following ways:
19+
* At load time via your `redis.conf` file.
20+
* At run time (where applicable) using the [`CONFIG SET`]({{< relref "/commands/config-set" >}}) command.
21+
{{< /note >}}
2022

21-
## Setting configuration parameters on module load
2223

23-
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:
24+
## Redis probabilistic data structure configuration parameters
2425

25-
In [redis.conf]({{< relref "/operate/oss_and_stack/management/config" >}}):
26+
The following table summarizes which Bloom filter configuration parameters can be set at run-time, and compatibility with Redis Enterprise and Redis Cloud
2627

27-
```sh
28-
loadmodule ./redisbloom.so [OPT VAL]...
29-
```
28+
| Old parameter name | New parameter name | Run-time | Redis<br />Enterprise | Redis<br />Cloud |
29+
| :------- | :------- | :------- | :------- | :------- |
30+
| 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> |
31+
| | [bf-expansion-factor](#bf-expansion-factor) | :white_check_mark: |||
32+
| 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> |
3033

31-
From the [Redis CLI]({{< relref "/develop/tools/cli" >}}), using the [MODULE LOAD]({{< relref "/commands/module-load" >}}) command:
34+
The following table summarizes which Cuckoo filter configuration parameters can be set at run-time, and compatibility with Redis Enterprise and Redis Cloud.
3235

33-
```
34-
127.0.0.6379> MODULE LOAD redisbloom.so [OPT VAL]...
35-
```
36+
| Old parameter name | New parameter name | Run-time | Redis<br />Enterprise | Redis<br />Cloud |
37+
| :------- | :------- | :------- | :------- | :------- |
38+
| | [cf-bucket-size](#cf-bucket-size) | :white_check_mark: |||
39+
| | [cf-initial-size](#cf-initial-size) | :white_check_mark: |||
40+
| | [cf-expansion-factor](#cf-expansion-factor) | :white_check_mark: |||
41+
| 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> |
42+
| | [cf-max-iterations](#cf-max-iterations) | :white_check_mark: |||
3643

37-
From the command line:
44+
{{< warning >}}
45+
A filter should always be sized for the expected capacity and the desired error rate.
46+
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.
47+
Not optimizing a filter for its intended use will result in degradation of performance and memory efficiency.
48+
{{< /warning >}}
3849

39-
```sh
40-
$ redis-server --loadmodule ./redisbloom.so [OPT VAL]...
41-
```
50+
## Default parameters for Bloom filters
4251

43-
## RedisBloom configuration parameters
52+
### bf-error-rate
4453

45-
The following table summarizes which configuration parameters can be set at module load-time and which can be set on run-time:
54+
Default error ratio for Bloom filters.
4655

47-
| Configuration Parameter | Load-time | Run-time |
48-
| :------- | :----- | :----------- |
49-
| [ERROR_RATE](#error_rate) | :white_check_mark: | :white_large_square: |
50-
| [INITIAL_SIZE](#initial_size) | :white_check_mark: | :white_large_square: |
51-
| [CF_MAX_EXPANSIONS](#cf_max_expansions) | :white_check_mark: | :white_large_square: |
56+
Type: double
5257

58+
Valid range: `[0 .. 1]`; consider limiting the range to `[0 .. 0.25]`.
5359

54-
## Default parameters
60+
Default: `0.01`
5561

56-
!!! warning "Note on using initialization default sizes"
57-
A filter should always be sized for the expected capacity and the desired error-rate.
58-
Using the `INSERT` family commands with the default values should be used in cases where many small filter exist and the expectation is most will remain at about that size.
59-
Not optimizing a filter for its intended use will result in degradation of performance and memory efficiency.
62+
### bf-expansion-factor
6063

61-
### ERROR_RATE
64+
Added in v8.0.0.
6265

63-
Default error ratio for Bloom filters.
66+
Expansion factor for Bloom filters.
6467

65-
#### Default
68+
Type: integer
6669

67-
`0.01`
70+
Valid range: `[0 .. 32768]`.
6871

69-
#### Example
72+
Default: `2`
7073

71-
```
72-
$ redis-server --loadmodule /path/to/redisbloom.so ERROR_RATE 0.004
73-
```
74+
### bf-initial-size
7475

75-
### INITIAL_SIZE
76+
Initial capacity for Bloom filters.
7677

77-
Default initial capacity for Bloom filters.
78+
Type: integer
7879

79-
#### Default
80+
Valid range: `[1 .. 1GB]`
8081

81-
`100`
82+
Default: `100`
8283

83-
#### Example
84+
## Default parameters for Cuckoo filters
8485

85-
```
86-
$ redis-server --loadmodule /path/to/redisbloom.so INITIAL_SIZE 400
87-
```
86+
### cf-bucket-size
87+
88+
Added in v8.0.0.
89+
90+
The number of items in each Cuckoo filter bucket.
91+
92+
Type: integer
93+
94+
Valid range: `[1 .. 255]`
95+
96+
Default: `2`
97+
98+
### cf-initial-size
99+
100+
Added in v8.0.0.
101+
102+
Cuckoo filter initial capacity.
103+
104+
Type: integer
105+
106+
Valid range: `[2*CF_BUCKET_SIZE .. 1GB]`
107+
108+
Default: `1024`
88109

89-
### CF_MAX_EXPANSIONS
110+
### cf-expansion-factor
90111

91-
Default maximum expansions for Cuckoo filters.
112+
Added in v8.0.0.
92113

93-
#### Default
114+
Expansion factor for Cuckoo filters.
94115

95-
`32`
116+
Type: integer
96117

97-
#### Example
118+
Valid range: `[0 .. 32768]`
98119

120+
Default: `1`
121+
122+
### cf-max-expansions
123+
124+
The maximum number of expansions for Cuckoo filters.
125+
126+
Type: integer
127+
128+
Valid range: `[1 .. 65535]`
129+
130+
Default: `32`
131+
132+
### cf-max-iterations
133+
134+
Added in v8.0.0
135+
136+
The maximum number of iterations for Cuckoo filters.
137+
138+
Type: integer
139+
140+
Valid range: `[1 .. 65535]`
141+
142+
Default: `20`
143+
144+
## Setting configuration parameters on module load (deprecated)
145+
146+
These methods are deprecated beginning with Redis CE v8.0.0.
147+
148+
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:
149+
150+
In [redis.conf]({{< relref "/operate/oss_and_stack/management/config" >}}):
151+
152+
```sh
153+
loadmodule ./redisbloom.so [OPT VAL]...
99154
```
100-
$ redis-server --loadmodule /path/to/redisbloom.so CF_MAX_EXPANSIONS 16
155+
156+
From the [Redis CLI]({{< relref "/develop/tools/cli" >}}), using the [MODULE LOAD]({{< relref "/commands/module-load" >}}) command:
157+
101158
```
159+
127.0.0.6379> MODULE LOAD redisbloom.so [OPT VAL]...
160+
```
161+
162+
From the command line:
163+
164+
```sh
165+
$ redis-server --loadmodule ./redisbloom.so [OPT VAL]...
166+
```

0 commit comments

Comments
 (0)