Skip to content

Commit 24c08ac

Browse files
DEV: module configuration changes for CE8 (#956)
* DEV: CONFIG for modules changes for CE8 * Renaming file * Apply suggestions from Rachel's code review Co-authored-by: Rachel Elledge <[email protected]> * Apply suggestions from Rachel's code review (part 2) Co-authored-by: Rachel Elledge <[email protected]> * Apply suggestions from Lior's code review * Apply suggestions from Lior's code review (part 2) --------- Co-authored-by: Rachel Elledge <[email protected]>
1 parent c39ae61 commit 24c08ac

File tree

14 files changed

+920
-911
lines changed

14 files changed

+920
-911
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: 0 additions & 101 deletions
This file was deleted.
Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
---
2+
categories:
3+
- docs
4+
- develop
5+
- stack
6+
- oss
7+
- rs
8+
- rc
9+
- oss
10+
- kubernetes
11+
- clients
12+
description: Redis probabilistic data structures support multiple configuration parameters.
13+
linkTitle: Configuration
14+
title: Configuration Parameters
15+
weight: 100
16+
---
17+
{{< note >}}
18+
As of Redis Community Edition (CE) 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+
22+
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).
23+
{{< /note >}}
24+
25+
26+
## Redis probabilistic data structure configuration parameters
27+
28+
The following table summarizes which Bloom filter configuration parameters can be set at run-time, and compatibility with Redis Software and Redis Cloud
29+
30+
| Parameter name<br />(version < 8.0) | Parameter name<br />(version &#8805; 8.0) | Run-time | Redis<br />Software | Redis<br />Cloud |
31+
| :------- | :------- | :------- | :------- | :------- |
32+
| 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> |
33+
| | [bf-expansion-factor](#bf-expansion-factor) | :white_check_mark: |||
34+
| 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> |
35+
36+
The following table summarizes which Cuckoo filter configuration parameters can be set at run-time, and compatibility with Redis Software and Redis Cloud.
37+
38+
| Parameter name<br />(version < 8.0) | Parameter name<br />(version &#8805; 8.0) | Run-time | Redis<br />Software | Redis<br />Cloud |
39+
| :------- | :------- | :------- | :------- | :------- |
40+
| | [cf-bucket-size](#cf-bucket-size) | :white_check_mark: |||
41+
| | [cf-initial-size](#cf-initial-size) | :white_check_mark: |||
42+
| | [cf-expansion-factor](#cf-expansion-factor) | :white_check_mark: |||
43+
| 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> |
44+
| | [cf-max-iterations](#cf-max-iterations) | :white_check_mark: |||
45+
46+
{{< note >}}
47+
Parameter names for Redis CE versions < 8.0, while deprecated, will still be supported in version 8.0.
48+
{{< /note >}}
49+
50+
---
51+
52+
{{< warning >}}
53+
A filter should always be sized for the expected capacity and the desired error rate.
54+
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.
55+
Not optimizing a filter for its intended use will result in degradation of performance and memory efficiency.
56+
{{< /warning >}}
57+
58+
## Default parameters for Bloom filters
59+
60+
### bf-error-rate
61+
62+
Default error ratio for Bloom filters.
63+
64+
Type: double
65+
66+
Valid range: `[0 .. 1]`
67+
68+
Default: `0.01`
69+
70+
### bf-expansion-factor
71+
72+
Added in v8.0.0.
73+
74+
Expansion factor for Bloom filters.
75+
76+
Type: integer
77+
78+
Valid range: `[0 .. 32768]`.
79+
80+
Default: `2`
81+
82+
### bf-initial-size
83+
84+
Initial capacity for Bloom filters.
85+
86+
Type: integer
87+
88+
Valid range: `[1 .. 1048576]`
89+
90+
Default: `100`
91+
92+
## Default parameters for Cuckoo filters
93+
94+
### cf-bucket-size
95+
96+
Added in v8.0.0.
97+
98+
The number of items in each Cuckoo filter bucket.
99+
100+
Type: integer
101+
102+
Valid range: `[1 .. 255]`
103+
104+
Default: `2`
105+
106+
### cf-initial-size
107+
108+
Added in v8.0.0.
109+
110+
Cuckoo filter initial capacity.
111+
112+
Type: integer
113+
114+
Valid range: `[2*cf-bucket-size .. 1048576]`
115+
116+
Default: `1024`
117+
118+
### cf-expansion-factor
119+
120+
Added in v8.0.0.
121+
122+
Expansion factor for Cuckoo filters.
123+
124+
Type: integer
125+
126+
Valid range: `[0 .. 32768]`
127+
128+
Default: `1`
129+
130+
### cf-max-expansions
131+
132+
The maximum number of expansions for Cuckoo filters.
133+
134+
Type: integer
135+
136+
Valid range: `[1 .. 65535]`
137+
138+
Default: `32`
139+
140+
### cf-max-iterations
141+
142+
Added in v8.0.0
143+
144+
The maximum number of iterations for Cuckoo filters.
145+
146+
Type: integer
147+
148+
Valid range: `[1 .. 65535]`
149+
150+
Default: `20`
151+
152+
## Setting configuration parameters on module load (deprecated)
153+
154+
These methods are deprecated beginning with Redis CE v8.0.0.
155+
156+
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:
157+
158+
In [redis.conf]({{< relref "/operate/oss_and_stack/management/config" >}}):
159+
160+
```sh
161+
loadmodule ./redisbloom.so [OPT VAL]...
162+
```
163+
164+
From the [Redis CLI]({{< relref "/develop/tools/cli" >}}), using the [MODULE LOAD]({{< relref "/commands/module-load" >}}) command:
165+
166+
```
167+
127.0.0.6379> MODULE LOAD redisbloom.so [OPT VAL]...
168+
```
169+
170+
From the command line:
171+
172+
```sh
173+
$ redis-server --loadmodule ./redisbloom.so [OPT VAL]...
174+
```

0 commit comments

Comments
 (0)