-
Notifications
You must be signed in to change notification settings - Fork 229
DEV: module configuration changes for CE8 #956
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
43a231d
DEV: CONFIG for modules changes for CE8
dwdougherty d945ab7
Renaming file
dwdougherty 96123c5
Apply suggestions from Rachel's code review
dwdougherty d8d704b
Apply suggestions from Rachel's code review (part 2)
dwdougherty 73d022d
Apply suggestions from Lior's code review
dwdougherty cdbd6ae
Apply suggestions from Lior's code review (part 2)
dwdougherty File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
101 changes: 0 additions & 101 deletions
101
content/develop/data-types/probabilistic/Configuration.md
This file was deleted.
Oops, something went wrong.
174 changes: 174 additions & 0 deletions
174
content/develop/data-types/probabilistic/configuration.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 ≥ 8.0) | Run-time | Redis<br />Software | Redis<br />Cloud | | ||
| :------- | :------- | :------- | :------- | :------- | | ||
| ERROR_RATE | [bf-error-rate](#bf-error-rate) | :white_check_mark: | <span title="Supported">✅ Supported</span><br /><span><br /></span> | <span title="Supported">✅ Flexible & Annual</span><br /><span title="Not supported"><nobr>❌ Free & Fixed</nobr></span> | | ||
dwdougherty marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| | [bf-expansion-factor](#bf-expansion-factor) | :white_check_mark: ||| | ||
| INITIAL_SIZE | [bf-initial-size](#bf-initial-size) | :white_check_mark: | <span title="Supported">✅ Supported</span><br /><span><br /></span> | <span title="Supported">✅ Flexible & Annual</span><br /><span title="Not supported"><nobr>❌ 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 ≥ 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">✅ Supported</span><br /><span><br /></span> | <span title="Supported">✅ Flexible & Annual</span><br /><span title="Not supported"><nobr>❌ 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 .. 1048576]` | ||
|
||
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 .. 1048576]` | ||
|
||
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]... | ||
``` |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.