Skip to content

Commit 73d022d

Browse files
dwdoughertydwdougherty
committed
Apply suggestions from Lior's code review
1 parent d8d704b commit 73d022d

File tree

3 files changed

+39
-18
lines changed

3 files changed

+39
-18
lines changed

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

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,32 +15,40 @@ title: Configuration Parameters
1515
weight: 100
1616
---
1717
{{< note >}}
18-
As of Redis Community Edition 8.0, configuration parameters for the probabilistic data structures are now set in the following ways:
18+
As of Redis Community Edition (CE) 8.0, configuration parameters for the probabilistic data structures are now set in the following ways:
1919
* At load time via your `redis.conf` file.
2020
* 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).
2123
{{< /note >}}
2224

2325

2426
## Redis probabilistic data structure configuration parameters
2527

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

28-
| Old parameter name | New parameter name | Run-time | Redis<br />Software | Redis<br />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+
| :------- | :------- | :------- | :------- | :------- |
3032
| 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> |
3133
| | [bf-expansion-factor](#bf-expansion-factor) | :white_check_mark: |||
3234
| 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> |
3335

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

36-
| Old parameter name | New parameter name | Run-time | Redis<br />Software | Redis<br />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+
| :------- | :------- | :------- | :------- | :------- |
3840
| | [cf-bucket-size](#cf-bucket-size) | :white_check_mark: |||
3941
| | [cf-initial-size](#cf-initial-size) | :white_check_mark: |||
4042
| | [cf-expansion-factor](#cf-expansion-factor) | :white_check_mark: |||
4143
| 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> |
4244
| | [cf-max-iterations](#cf-max-iterations) | :white_check_mark: |||
4345

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+
4452
{{< warning >}}
4553
A filter should always be sized for the expected capacity and the desired error rate.
4654
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,7 +63,7 @@ Default error ratio for Bloom filters.
5563

5664
Type: double
5765

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

6068
Default: `0.01`
6169

@@ -77,7 +85,7 @@ Initial capacity for Bloom filters.
7785

7886
Type: integer
7987

80-
Valid range: `[1 .. 1GB]`
88+
Valid range: `[1 .. 1,048,576]`
8189

8290
Default: `100`
8391

@@ -103,7 +111,7 @@ Cuckoo filter initial capacity.
103111

104112
Type: integer
105113

106-
Valid range: `[2*CF_BUCKET_SIZE .. 1GB]`
114+
Valid range: `[2*cf-bucket-size .. 1GB]`
107115

108116
Default: `1024`
109117

‎content/develop/data-types/timeseries/configuration.md‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,14 @@ weight: 3
1818
As of Redis Community Edition 8.0, configuration parameters for the time series data structure are now set in the following ways:
1919
* At load time via your `redis.conf` file.
2020
* 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).
2123
{{< /note >}}
2224

23-
## Redis time series configuration parameters
25+
## Time series configuration parameters
2426

25-
| Old parameter name | New parameter name | Run-time | Redis<br />Software | Redis<br />Cloud |
26-
| :------- | :------- | :------- | :------- | :------- |
27+
| Parameter name<br />(version < 8.0) | Parameter name<br />(version &#8805; 8.0) | Run-time | Redis<br />Software | Redis<br />Cloud |
28+
| :------- | :------- | :------- | :------- | :------- |
2729
| CHUNK_SIZE_BYTES | [ts-chunk-size-bytes](#ts-chunk-size-bytes) | :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> |
2830
| COMPACTION_POLICY | [ts-compaction-policy](#ts-compaction-policy) | :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> |
2931
| DUPLICATE_POLICY | [ts-duplicate-policy](#ts-duplicate-policy) | :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> |
@@ -34,6 +36,12 @@ As of Redis Community Edition 8.0, configuration parameters for the time series
3436
| RETENTION_POLICY | [ts-retention-policy](#ts-retention-policy) | :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> |
3537
| OSS_GLOBAL_PASSWORD | Deprecated in v8.0.0. Replace with the `masterauth` password. | :white_check_mark: |||
3638

39+
{{< note >}}
40+
Parameter names for Redis CE versions < 8.0, while deprecated, will still be supported in version 8.0.
41+
{{< /note >}}
42+
43+
---
44+
3745
### ts-chunk-size-bytes
3846

3947
Default initial allocation size, in bytes, for the data part of each new chunk.

‎content/develop/interact/search-and-query/administration/configuration.md‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,20 @@ linkTitle: Configuration parameters
1717
title: Configuration parameters
1818
weight: 1
1919
---
20-
{{< note >}}
21-
As of Redis Community Edition 8.0, the `FT.CONFIG SET` and `FT.CONFIG GET` commands are deprecated.
22-
Configuration parameters for Redis Query Engine are now set in the following ways:
23-
* At load-time via your `redis.conf` file.
24-
* At run-time (where applicable) using the [`CONFIG SET`]({{< relref "/commands/config-set" >}}) command.
20+
{{{< note >}}
21+
As of Redis Community Edition 8.0, configuration parameters for the time series data structure are now set in the following ways:
22+
* At load time via your `redis.conf` file.
23+
* At run time (where applicable) using the [`CONFIG SET`]({{< relref "/commands/config-set" >}}) command.
24+
25+
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).
2526
{{< /note >}}
2627

2728
## Redis Query Engine configuration parameters
2829

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

31-
| Old parameter name | New parameter name | Run-time | Redis<br />Software | Redis<br />Cloud |
32-
| :------- | :----- | :----------- | :--| :-- |
32+
| Parameter name<br />(version < 8.0) | Parameter name<br />(version &#8805; 8.0) | Run-time | Redis<br />Software | Redis<br />Cloud |
33+
| :------- | :------- | :------- | :------- | :------- |
3334
| BG_INDEX_SLEEP_GAP | [search-bg-index-sleep-gap](#search-bg-index-sleep-gap) | :white_large_square: |||
3435
| CONCURRENT_WRITE_MODE | [search-concurrent-write-mode](#search-concurrent-write-mode) | :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> |
3536
| CONN_PER_SHARD | [search-conn-per-shard](#search-conn-per-shard) | :white_check_mark: |||
@@ -78,6 +79,10 @@ The following table summarizes which configuration parameters can be set at run-
7879
| WORKER_THREADS | Deprecated in v8.0.0. | :white_large_square: |||
7980
| SAFEMODE | Deprecated in v1.6.0. This is now the default setting | :white_large_square: |||
8081

82+
{{< note >}}
83+
Parameter names for Redis CE versions < 8.0, while deprecated, will still be supported in version 8.0.
84+
{{< /note >}}
85+
8186
---
8287

8388
### search-bg-index-sleep-gap

0 commit comments

Comments
 (0)