diff --git a/content/commands/ft.config-get/index.md b/content/commands/ft.config-get/index.md index 2113fc9a7..f000e44b4 100644 --- a/content/commands/ft.config-get/index.md +++ b/content/commands/ft.config-get/index.md @@ -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 diff --git a/content/commands/ft.config-set/index.md b/content/commands/ft.config-set/index.md index e5cd3d165..4c100b117 100644 --- a/content/commands/ft.config-set/index.md +++ b/content/commands/ft.config-set/index.md @@ -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 @@ -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. diff --git a/content/commands/module-load/index.md b/content/commands/module-load/index.md index 734c291b4..a20b4ea6a 100644 --- a/content/commands/module-load/index.md +++ b/content/commands/module-load/index.md @@ -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 >}} \ No newline at end of file diff --git a/content/develop/data-types/probabilistic/Configuration.md b/content/develop/data-types/probabilistic/Configuration.md index 0cc9071f9..22008f335 100644 --- a/content/develop/data-types/probabilistic/Configuration.md +++ b/content/develop/data-types/probabilistic/Configuration.md @@ -9,93 +9,158 @@ categories: - oss - kubernetes - clients -description: 'RedisBloom supports multiple module configuration parameters. All of - these parameters can only be set at load-time. - - ' +description: Redis probabilistic data structures support multiple configuration parameters. linkTitle: Configuration title: Configuration Parameters weight: 100 --- +{{< note >}} +As of Redis Community Edition 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. +{{< /note >}} -## Setting configuration parameters on module load -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: +## Redis probabilistic data structure configuration parameters -In [redis.conf]({{< relref "/operate/oss_and_stack/management/config" >}}): +The following table summarizes which Bloom filter configuration parameters can be set at run-time, and compatibility with Redis Enterprise and Redis Cloud -```sh -loadmodule ./redisbloom.so [OPT VAL]... -``` +| Old parameter name | New parameter name | Run-time | Redis
Enterprise | Redis
Cloud | +| :------- | :------- | :------- | :------- | :------- | +| ERROR_RATE | [bf-error-rate](#bf-error-rate) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| | [bf-expansion-factor](#bf-expansion-factor) | :white_check_mark: ||| +| INITIAL_SIZE | [bf-initial-size](#bf-initial-size) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | -From the [Redis CLI]({{< relref "/develop/tools/cli" >}}), using the [MODULE LOAD]({{< relref "/commands/module-load" >}}) command: +The following table summarizes which Cuckoo filter configuration parameters can be set at run-time, and compatibility with Redis Enterprise and Redis Cloud. -``` -127.0.0.6379> MODULE LOAD redisbloom.so [OPT VAL]... -``` +| Old parameter name | New parameter name | Run-time | Redis
Enterprise | Redis
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: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| | [cf-max-iterations](#cf-max-iterations) | :white_check_mark: ||| -From the command line: +{{< 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 >}} -```sh -$ redis-server --loadmodule ./redisbloom.so [OPT VAL]... -``` +## Default parameters for Bloom filters -## RedisBloom configuration parameters +### bf-error-rate -The following table summarizes which configuration parameters can be set at module load-time and which can be set on run-time: +Default error ratio for Bloom filters. -| Configuration Parameter | Load-time | Run-time | -| :------- | :----- | :----------- | -| [ERROR_RATE](#error_rate) | :white_check_mark: | :white_large_square: | -| [INITIAL_SIZE](#initial_size) | :white_check_mark: | :white_large_square: | -| [CF_MAX_EXPANSIONS](#cf_max_expansions) | :white_check_mark: | :white_large_square: | +Type: double +Valid range: `[0 .. 1]`; consider limiting the range to `[0 .. 0.25]`. -## Default parameters +Default: `0.01` -!!! warning "Note on using initialization default sizes" - 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 filter exist and the expectation is most will remain at about that size. - Not optimizing a filter for its intended use will result in degradation of performance and memory efficiency. +### bf-expansion-factor -### ERROR_RATE +Added in v8.0.0. -Default error ratio for Bloom filters. +Expansion factor for Bloom filters. -#### Default +Type: integer -`0.01` +Valid range: `[0 .. 32768]`. -#### Example +Default: `2` -``` -$ redis-server --loadmodule /path/to/redisbloom.so ERROR_RATE 0.004 -``` +### bf-initial-size -### INITIAL_SIZE +Initial capacity for Bloom filters. -Default initial capacity for Bloom filters. +Type: integer -#### Default +Valid range: `[1 .. 1GB]` -`100` +Default: `100` -#### Example +## Default parameters for Cuckoo filters -``` -$ redis-server --loadmodule /path/to/redisbloom.so INITIAL_SIZE 400 -``` +### 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_MAX_EXPANSIONS +### cf-expansion-factor -Default maximum expansions for Cuckoo filters. +Added in v8.0.0. -#### Default +Expansion factor for Cuckoo filters. -`32` +Type: integer -#### Example +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]... ``` -$ redis-server --loadmodule /path/to/redisbloom.so CF_MAX_EXPANSIONS 16 + +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]... +``` \ No newline at end of file diff --git a/content/develop/data-types/timeseries/configuration.md b/content/develop/data-types/timeseries/configuration.md index 2ae0b9696..4c4fbbe2c 100644 --- a/content/develop/data-types/timeseries/configuration.md +++ b/content/develop/data-types/timeseries/configuration.md @@ -9,91 +9,74 @@ categories: - oss - kubernetes - clients -description: 'RedisTimeSeries supports multiple module configuration parameters. All - of these parameters can only be set at load-time. - - ' +description: Redis time series support multiple configuration parameters. linkTitle: Configuration title: Configuration Parameters weight: 3 --- +{{< note >}} +As of Redis Community Edition 8.0, configuration parameters for the time series data structure 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. +{{< /note >}} -## Setting configuration parameters on module load +## Redis time series configuration parameters -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: +| Old parameter name | New parameter name | Run-time | Redis
Enterprise | Redis
Cloud | +| :------- | :------- | :------- | :------- | :------- | +| CHUNK_SIZE_BYTES | [ts-chunk-size-bytes](#ts-chunk-size-bytes) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| COMPACTION_POLICY | [ts-compaction-policy](#ts-compaction-policy) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| DUPLICATE_POLICY | [ts-duplicate-policy](#ts-duplicate-policy) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| ENCODING | [ts-encoding](#ts-encoding) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| IGNORE_MAX_TIME_DIFF | [ts-ignore-max-time-diff](#ts-ignore-max-time-diff-and-ts-ignore-max-val-diff) | :white_check_mark: ||| +| IGNORE_MAX_VAL_DIFF | [ts-ignore-max-val-diff](#ts-ignore-max-time-diff-and-ts-ignore-max-val-diff) | :white_check_mark: ||| +| NUM_THREADS | [ts-num-threads](#ts-num-threads) | :white_large_square: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| RETENTION_POLICY | [ts-retention-policy](#ts-retention-policy) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| OSS_GLOBAL_PASSWORD | Deprecated in v8.0.0. Replace with the `masterauth` password. | :white_check_mark: ||| -In [redis.conf]({{< relref "/operate/oss_and_stack/management/config" >}}): +### ts-chunk-size-bytes -```sh -loadmodule ./redistimeseries.so [OPT VAL]... -``` +Default initial allocation size, in bytes, for the data part of each new chunk. +This default value is applied to each new time series upon its creation. +Actual chunks may consume more memory. -From the [Redis CLI]({{< relref "/develop/tools/cli" >}}), using the [MODULE LOAD]({{< relref "/commands/module-load" >}}) command: +Type: integer -``` -127.0.0.6379> MODULE LOAD redistimeseries.so [OPT VAL]... -``` +Valid range: `[48 .. 1048576]`; must be a multiple of 8 -From the command line: - -```sh -$ redis-server --loadmodule ./redistimeseries.so [OPT VAL]... -``` +Default: `4096` -## RedisTimeSeries configuration parameters +### ts-compaction-policy -The following table summarizes which configuration parameters can be set at module load-time and run-time: +Default compaction rules for newly created keys with [`TS.ADD`]({{< baseurl >}}/commands/ts.add/), [`TS.INCRBY`]({{< baseurl >}}/commands/ts.incrby/), and [`TS.DECRBY`]({{< baseurl >}}/commands/ts.decrby/). -| Configuration Parameter | Load-time | Run-time | -| :------- | :----- | :----------- | -| [NUM_THREADS](#num_threads) (since RedisTimeSeries v1.6) | :white_check_mark: | :white_large_square: | -| [COMPACTION_POLICY](#compaction_policy) | :white_check_mark: | :white_large_square: | -| [RETENTION_POLICY](#retention_policy) | :white_check_mark: | :white_large_square: | -| [DUPLICATE_POLICY](#duplicate_policy) | :white_check_mark: | :white_large_square: | -| [ENCODING](#encoding) (since RedisTimeSeries v1.6) | :white_check_mark: | :white_large_square: | -| [CHUNK_SIZE_BYTES](#chunk_size_bytes) | :white_check_mark: | :white_large_square: | -| [OSS_GLOBAL_PASSWORD](#oss_global_password) (since RedisTimeSeries v1.8.4) | :white_check_mark: | :white_large_square: | -| [IGNORE_MAX_TIME_DIFF](#ignore_max_time_diff-and-ignore_max_val_diff) (since RedisTimeSeries v1.12) | :white_check_mark: | :white_large_square: | -| [IGNORE_MAX_VAL_DIFF](#ignore_max_time_diff-and-ignore_max_val_diff) (since RedisTimeSeries v1.12) | :white_check_mark: | :white_large_square: | +Type: string -### NUM_THREADS +Default: No compaction rules. -The maximal number of per-shard threads for cross-key queries when using cluster mode (TS.MRANGE, TS.MREVRANGE, TS.MGET, and TS.QUERYINDEX). The value must be equal to or greater than 1. Note that increasing this value may either increase or decrease the performance! +**Discussion** -#### Default - -`3` - -#### Example - -``` -$ redis-server --loadmodule ./redistimeseries.so NUM_THREADS 3 -``` - -### COMPACTION_POLICY - -Default compaction rules for newly created key with [`TS.ADD`]({{< baseurl >}}/commands/ts.add/), [`TS.INCRBY`]({{< baseurl >}}/commands/ts.incrby/), and [`TS.DECRBY`]({{< baseurl >}}/commands/ts.decrby/). - -Note that `COMPACTION_POLICY` has no effect on keys created with [`TS.CREATE`]({{< baseurl >}}/commands/ts.create/). To understand the motivation for this behavior, consider the following scenario: Suppose a `COMPACTION_POLICY` is defined, but then one wants to manually create an additional compaction rule (using [`TS.CREATERULE`]({{< baseurl >}}/commands/ts.createrule/)) which requires first creating an empty destination key (using [`TS.CREATE`]({{< baseurl >}}/commands/ts.create/)). But now there is a problem: due to the `COMPACTION_POLICY`, automatic compactions would be undesirably created for that destination key. +`COMPACTION_POLICY` has no effect on keys created with [`TS.CREATE`]({{< baseurl >}}/commands/ts.create/). To understand the motivation for this behavior, consider the following scenario: Suppose a `COMPACTION_POLICY` is defined, but then one wants to manually create an additional compaction rule (using [`TS.CREATERULE`]({{< baseurl >}}/commands/ts.createrule/)) which requires first creating an empty destination key (using [`TS.CREATE`]({{< baseurl >}}/commands/ts.create/)). But now there is a problem: due to the `COMPACTION_POLICY`, automatic compactions would be undesirably created for that destination key. Each rule is separated by a semicolon (`;`), the rule consists of multiple fields that are separated by a colon (`:`): * Aggregation type: One of the following: - | aggregator | description | + + | Aggregator | Description | | ---------- | ---------------------------------------------------------------- | - | `avg` | arithmetic mean of all values | - | `sum` | sum of all values | - | `min` | minimum value | - | `max` | maximum value | - | `range` | difference between the highest and the lowest value | - | `count` | number of values | - | `first` | the value with the lowest timestamp in the bucket | - | `last` | the value with the highest timestamp in the bucket | - | `std.p` | population standard deviation of the values | - | `std.s` | sample standard deviation of the values | - | `var.p` | population variance of the values | - | `var.s` | sample variance of the values | - | `twa` | time-weighted average of all values (since RedisTimeSeries v1.8) | + | `avg` | Arithmetic mean of all values | + | `sum` | Sum of all values | + | `min` | Minimum value | + | `max` | Maximum value | + | `range` | Difference between the highest and the lowest value | + | `count` | Number of values | + | `first` | The value with the lowest timestamp in the bucket | + | `last` | The value with the highest timestamp in the bucket | + | `std.p` | Population standard deviation of the values | + | `std.s` | Sample standard deviation of the values | + | `var.p` | Population variance of the values | + | `var.s` | Sample variance of the values | + | `twa` | Time-weighted average of all values (since v1.8) | * Duration of each time bucket - number and the time representation (Example for one minute: `1M`, `60s`, or `60000m`) @@ -113,7 +96,7 @@ Each rule is separated by a semicolon (`;`), the rule consists of multiple field `0m`, `0s`, `0M`, `0h`, or `0d` means no expiration. -* (since RedisTimeSeries v1.8): +* (Since v1.8): Optional: Time bucket alignment - number and the time representation (Example for one minute: `1M`, `60s`, or `60000m`) @@ -127,152 +110,141 @@ Each rule is separated by a semicolon (`;`), the rule consists of multiple field When a compaction policy is defined, compaction rules will be created automatically for newly created time series, and their key would be set to: -* Before RedisTimeSeries v1.8: +* Before v1.8: _key_dur_agg_ where _key_ is the key of the source time series, _dur_ is the bucket duration, and _agg_ is the aggregator. -* Since RedisTimeSeries v1.8: +* Since v1.8: _key_dur_agg_aln_ where _key_ is the key of the source time series, _dur_ is the bucket duration, _agg_ is the aggregator, and _aln_ is the alignment timestamp. -Examples: - -- `max:1M:1h` - Aggregate using `max` over one minute and retain the last hour -- `twa:1d:0m:360M` - Aggregate daily [06:00 .. 06:00) using `twa`; no expiration - -#### Default - -No compaction rules. - -#### Example +**Examples** -``` -$ redis-server --loadmodule ./redistimeseries.so COMPACTION_POLICY max:1m:1h;min:10s:5d:10d;last:5M:10m;avg:2h:10d;avg:3d:100d -``` +- `max:1M:1h` - Aggregate using `max` over one minute and retain the last hour. +- `twa:1d:0m:360M` - Aggregate daily [06:00 .. 06:00) using `twa`; no expiration. -### RETENTION_POLICY +### ts-duplicate-policy -Default retention period, in milliseconds, for newly created keys. +The default policy for handling insertion ([`TS.ADD`]({{< baseurl >}}/commands/ts.add/) and [`TS.MADD`]({{< baseurl >}}/commands/ts.madd/)) of multiple samples with identical timestamps, with one of the following values: -Retention period is the maximum age of samples compared to highest reported timestamp, per key. Samples are expired based solely on the difference between their timestamp and the timestamps passed to subsequent [`TS.ADD`]({{< baseurl >}}/commands/ts.add/), [`TS.MADD`]({{< baseurl >}}/commands/ts.madd/), [`TS.INCRBY`]({{< baseurl >}}/commands/ts.incrby/), and [`TS.DECRBY`]({{< baseurl >}}/commands/ts.decrby/) calls. - -The value `0` means no expiration. - -When both `COMPACTION_POLICY` and `RETENTION_POLICY` are specified, the retention of newly created compactions is according to the retention time specified in `COMPACTION_POLICY`. + | Policy | Description | + | ---------- | ---------------------------------------------------------------- | + | `BLOCK` | Ignore any newly reported value and reply with an error | + | `FIRST` | Ignore any newly reported value | + | `LAST` | Override with the newly reported value | + | `MIN` | Only override if the value is lower than the existing value | + | `MAX` | Only override if the value is higher than the existing value | + | `SUM` | If a previous sample exists, add the new sample to it so that the updated value is equal to (previous + new). If no previous sample exists, set the updated value equal to the new value. | -#### Default +The default value is applied to each new time series upon its creation. -0 +Type: string -#### Example +Default: `BLOCK` -Setting the default retention to 300 days: +**Precedence order** -``` -$ redis-server --loadmodule ./redistimeseries.so RETENTION_POLICY 25920000000 -``` +Since the duplication policy can be provided at different levels, the actual precedence of the used policy will be: -### DUPLICATE_POLICY +1. [`TS.ADD`]({{< baseurl >}}/commands/ts.add/)'s `ON_DUPLICATE_POLICY` optional argument. +1. Key-level policy, as set with [`TS.CREATE`]({{< baseurl >}}/commands/ts.create/)'s and [`TS.ALTER`]({{< baseurl >}}/commands/ts.alter/)'s `DUPLICATE_POLICY` optional argument. +1. The `ts-duplicate-policy` configuration parameter. +1. The default policy. -Is policy for handling insertion ([`TS.ADD`]({{< baseurl >}}/commands/ts.add/) and [`TS.MADD`]({{< baseurl >}}/commands/ts.madd/)) of multiple samples with identical timestamps, with one of the following values: +### ts-encoding - | policy | description | - | ---------- | ---------------------------------------------------------------- | - | `BLOCK` | ignore any newly reported value and reply with an error | - | `FIRST` | ignore any newly reported value | - | `LAST` | override with the newly reported value | - | `MIN` | only override if the value is lower than the existing value | - | `MAX` | only override if the value is higher than the existing value | - | `SUM` | If a previous sample exists, add the new sample to it so that the updated value is equal to (previous + new). If no previous sample exists, set the updated value equal to the new value. | +Note: Before v1.6 this configuration parameter was named `CHUNK_TYPE`. -#### Precedence order -Since the duplication policy can be provided at different levels, the actual precedence of the used policy will be: +Default chunk encoding for automatically created time series keys when [ts-compaction-policy](#ts-compaction-policy) is configured. -1. [`TS.ADD`]({{< baseurl >}}/commands/ts.add/)'s `ON_DUPLICATE_policy` optional argument -2. Key-level policy (as set with [`TS.CREATE`]({{< baseurl >}}/commands/ts.create/)'s and [`TS.ALTER`]({{< baseurl >}}/commands/ts.alter/)'s `DUPLICATE_POLICY` optional argument) -3. The `DUPLICATE_POLICY` module configuration parameter -4. The default policy +Type: string -#### Default +Valid values: `COMPRESSED`, `UNCOMPRESSED` -The default policy is `BLOCK`. Both new and pre-existing keys will conform to this default policy. +Default: `COMPRESSED` -#### Example +### ts-ignore-max-time-diff and ts-ignore-max-val-diff -``` -$ redis-server --loadmodule ./redistimeseries.so DUPLICATE_POLICY LAST -``` - -### ENCODING +Default values for newly created keys. -Default chunk encoding for automatically created keys when [COMPACTION_POLICY](#COMPACTION_POLICY) is configured. +Types: +- `ts-ignore-max-time-diff`: integer +- `ts-ignore-max-val-diff`: double -Possible values: `COMPRESSED`, `UNCOMPRESSED`. +Valid ranges: +- `ts-ignore-max-time-diff`: `[0 .. 9,223,372,036,854,775,807]` +- `ts-ignore-max-val-diff`: `[0 .. 1.7976931348623157e+308]` -Note: Before RedisTimeSeries 1.6 this configuration parameter was named `CHUNK_TYPE`. +Defaults: +- `ts-ignore-max-time-diff`: 0 +- `ts-ignore-max-val-diff`: 0.0 -#### Default +**Discussion** -`COMPRESSED` +Many sensors report data periodically. Often, the difference between the measured value and the previous measured value is negligible and related to random noise or to measurement accuracy limitations. In such situations it may be preferable not to add the new measurement to the time series. -#### Example +A new sample is considered a duplicate and is ignored if the following conditions are met: -``` -$ redis-server --loadmodule ./redistimeseries.so COMPACTION_POLICY max:1m:1h; ENCODING COMPRESSED -``` +1. The time series is not a compaction. +1. The time series' `ts-duplicate-policy` is `LAST`. +1. The sample is added in-order (`timestamp ≥ max_timestamp`). +1. The difference of the current timestamp from the previous timestamp (`timestamp - max_timestamp`) is less than or equal to `ts-ignore-max-time-diff`. +1. The absolute value difference of the current value from the value at the previous maximum timestamp (`abs(value - value_at_max_timestamp`) is less than or equal to `ts-ignore-max-val-diff`. -### CHUNK_SIZE_BYTES +where `max_timestamp` is the timestamp of the sample with the largest timestamp in the time series, and `value_at_max_timestamp` is the value at `max_timestamp`. -Default initial allocation size, in bytes, for the data part of each new chunk, for newly created time series. Actual chunks may consume more memory. +### ts-num-threads -#### Default +The maximum number of per-shard threads for cross-key queries when using cluster mode ([`TS.MRANGE`]({{< baseurl >}}/commands/ts.mrange/), [`TS.MREVRANGE`]({{< baseurl >}}/commands/ts.mrevrange/), [`TS.MGET`]({{< baseurl >}}/commands/ts.mget/), and [`TS.QUERYINDEX`]({{< baseurl >}}/commands/ts.queryindex/)). The value must be equal to or greater than `1`. Note that increasing this value may either increase or decrease the performance! -4096 +Type: integer -#### Example +Valid range: `[1..16]` -``` -$ redis-server --loadmodule ./redistimeseries.so COMPACTION_POLICY max:1m:1h; CHUNK_SIZE_BYTES 2048 -``` +Redis CE default: `3` -### OSS_GLOBAL_PASSWORD +Redis Enterprise default: Set by plan, and automatically updates when you change your plan. -Global Redis Community Edition cluster password used for connecting to other shards. +Redis Cloud defaults: +- Flexible & Annual: Set by plan +- Free & Fixed: `1` -#### Default +### ts-retention-policy -Not set +Default retention period, in milliseconds, for newly created keys. -#### Example +Type: integer -``` -$ redis-server --loadmodule ./redistimeseries.so OSS_GLOBAL_PASSWORD password -``` +Valid range: `[0 .. 9,223,372,036,854,775,807]` -### IGNORE_MAX_TIME_DIFF and IGNORE_MAX_VAL_DIFF +Default: `0` -Default values for newly created keys. +Retention period is the maximum age of samples compared to highest reported timestamp, per key. Samples are expired based solely on the difference between their timestamps and the timestamps passed to subsequent [`TS.ADD`]({{< baseurl >}}/commands/ts.add/), [`TS.MADD`]({{< baseurl >}}/commands/ts.madd/), [`TS.INCRBY`]({{< baseurl >}}/commands/ts.incrby/), and [`TS.DECRBY`]({{< baseurl >}}/commands/ts.decrby/) calls. -Many sensors report data periodically. Often, the difference between the measured value and the previous measured value is negligible and related to random noise or to measurement accuracy limitations. In such situations it may be preferable not to add the new measurement to the time series. +The value `0` means no expiration. -A new sample is considered a duplicate and is ignored if the following conditions are met: +When both `ts-compaction-policy` and `ts-retention-policy` are specified, the retention of newly created compactions is according to the retention time specified in `ts-compaction-policy`. -1. The time series is not a compaction; -1. The time series' `DUPLICATE_POLICY` IS `LAST`; -1. The sample is added in-order (`timestamp ≥ max_timestamp`); -1. The difference of the current timestamp from the previous timestamp (`timestamp - max_timestamp`) is less than or equal to `IGNORE_MAX_TIME_DIFF`; -1. The absolute value difference of the current value from the value at the previous maximum timestamp (`abs(value - value_at_max_timestamp`) is less than or equal to `IGNORE_MAX_VAL_DIFF`. +## Setting configuration parameters on module load (deprecated) -where `max_timestamp` is the timestamp of the sample with the largest timestamp in the time series, and `value_at_max_timestamp` is the value at `max_timestamp`. +These methods are deprecated beginning with Redis CE v8.0.0. -#### Defaults +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: -`IGNORE_MAX_TIME_DIFF`: 0 +In [redis.conf]({{< relref "/operate/oss_and_stack/management/config" >}}): -`IGNORE_MAX_VAL_DIFF`: 0.0 +```sh +loadmodule ./redistimeseries.so [OPT VAL]... +``` -#### Example +From the [Redis CLI]({{< relref "/develop/tools/cli" >}}), using the [MODULE LOAD]({{< relref "/commands/module-load" >}}) command: ``` -$ redis-server --loadmodule ./redistimeseries.so IGNORE_MAX_TIME_DIFF 1 IGNORE_MAX_VALUE_DIFF 0.1 +127.0.0.6379> MODULE LOAD redistimeseries.so [OPT VAL]... ``` + +From the command line: + +```sh +$ redis-server --loadmodule ./redistimeseries.so [OPT VAL]... +``` \ No newline at end of file diff --git a/content/develop/interact/search-and-query/administration/configuration.md b/content/develop/interact/search-and-query/administration/configuration.md new file mode 100644 index 000000000..3277ea073 --- /dev/null +++ b/content/develop/interact/search-and-query/administration/configuration.md @@ -0,0 +1,582 @@ +--- +aliases: /develop/interact/search-and-query/basic-constructs/configuration-parameters +categories: +- docs +- develop +- stack +- oss +- rs +- rc +- oss +- kubernetes +- clients +description: 'Redis Query Engine can be tuned through multiple + configuration parameters. Some of these parameters can only be set at load-time, + while other parameters can be set either at load-time or at run-time.' +linkTitle: Configuration parameters +title: Configuration parameters +weight: 1 +--- +{{< note >}} +As of Redis Community Edition 8.0, the `FT.CONFIG SET` and `FT.CONFIG GET` commands are deprecated. +Configuration parameters for Redis Query Engine 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. +{{< /note >}} + +## Redis Query Engine configuration parameters + +The following table summarizes which configuration parameters can be set at run-time, and compatibility with Redis Enterprise and Redis Cloud. + +| Old parameter name | New parameter name | Run-time | Redis
Enterprise | Redis
Cloud | +| :------- | :----- | :----------- | :--| :-- | +| BG_INDEX_SLEEP_GAP | [search-bg-index-sleep-gap](#search-bg-index-sleep-gap) | :white_large_square: ||| +| CONCURRENT_WRITE_MODE | [search-concurrent-write-mode](#search-concurrent-write-mode) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| CONN_PER_SHARD | [search-conn-per-shard](#search-conn-per-shard) | :white_check_mark: ||| +| CURSOR_MAX_IDLE | [search-cursor-max-idle](#search-cursor-max-idle) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| CURSOR_READ_SIZE | [search-cursor-read-size](#search-cursor-read-size) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| CURSOR_REPLY_THRESHOLD | [search-cursor-reply-threshold](#search-cursor-reply-threshold) | :white_check_mark: ||| +| DEFAULT_DIALECT | [search-default-dialect](#search-default-dialect) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| EXTLOAD | [search-ext-load](#search-ext-load) | :white_large_square: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| FORK_GC_CLEAN_NUMERIC_EMPTY_NODES | [search-fork-gc-clean-numeric-empty-nodes](#search-fork-gc-clean-numeric-empty-nodes) | :white_large_square: ||| +| FORK_GC_CLEAN_THRESHOLD | [search-fork-gc-clean-threshold](#search-fork-gc-clean-threshold) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| FORK_GC_RETRY_INTERVAL | [search-fork-gc-retry-interval](#search-fork-gc-retry-interval) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| FORK_GC_RUN_INTERVAL | [search-fork-gc-run-interval](#search-fork-gc-run-interval) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| FORKGC_SLEEP_BEFORE_EXIT | [search-forkgc-sleep-before-exit](#search-forkgc-sleep-before-exit) | :white_check_mark: ||| +| FRISOINI | [search-frisoini](#search-frisoini) | :white_large_square: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| GC_POLICY | [search-gc-policy](#search-gc-policy) | :white_large_square: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| GCSCANSIZE | [search-gc-scansize](#search-gc-scansize) | :white_large_square: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| INDEX_CURSOR_LIMIT | [search-index-cursor-limit](#search-index-cursor-limit) | :white_large_square: ||| +| INDEX_THREADS | search-index-threads | :white_large_square: ||| +| MAXAGGREGATERESULTS | [search-max-aggregate-results](#search-max-aggregate-results) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| MAXDOCTABLESIZE | [search-max-doctablesize](#search-max-doctablesize) | :white_large_square: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| MAXEXPANSIONS | [search-max-expansions](#search-max-expansions) | :white_check_mark: ||| +| MAXPREFIXEXPANSIONS | [search-max-prefix-expansions](#search-max-prefix-expansions) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| MAXSEARCHRESULTS | [search-max-searchresults](#search-max-searchresults) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| MIN_OPERATION_WORKERS | [search-min-operation-workers](#search-min-operation-workers) | :white_check_mark: ||| +| MIN_PHONETIC_TERM_LEN | [search-min-phonetic-term-len](#search-min-phonetic-term-len) | :white_check_mark: ||| +| MINPREFIX | [search-min-prefix](#search-min-prefix) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| MINSTEMLEN | [search-min-stem-len](#search-min-stem-len) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| MULTI_TEXT_SLOP | [search-multi-text-slop](#search-multi-text-slop) | :white_large_square: ||| +| NO_MEM_POOLS | [search-no-mem-pools](#search-no-mem-pools) | :white_large_square: ||| +| NOGC | [search-nogc](#search-nogc) | :white_large_square: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| ON_TIMEOUT | [search-on-timeout](#search-on-timeout) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| PARTIAL_INDEXED_DOCS | [search-partial-indexed-docs](#search-partial-indexed-docs) | :white_large_square: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| RAW_DOCID_ENCODING | [search-raw-docid-encoding](#search-raw-docid-encoding) | :white_large_square: ||| +| SEARCH_THREADS | [search-threads](#search-threads) | :white_large_square: ||| +| TIERED_HNSW_BUFFER_LIMIT | [search-tiered-hnsw-buffer-limit](#search-tiered-hnsw-buffer-limit) | :white_large_square: ||| +| TIMEOUT | [search-timeout](#search-timeout) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| TOPOLOGY_VALIDATION_TIMEOUT | [search-topology-validation-timeout](#search-topology-validation-timeout) | :white_check_mark: ||| +| UNION_ITERATOR_HEAP | [search-union-iterator-heap](#search-union-iterator-heap) | :white_check_mark: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| UPGRADE_INDEX | [search-upgrade-index](#search-upgrade-index) | :white_large_square: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| VSS_MAX_RESIZE | [search-vss-max-resize](#search-vss-max-resize) | :white_check_mark: ||| +| WORKERS_PRIORITY_BIAS_THRESHOLD | [search-workers-priority-bias-threshold](#search-workers-priority-bias-threshold) | :white_large_square: ||| +| WORKERS | [search-workers](#search-workers) | :white_check_mark: ||| +| OSS_GLOBAL_PASSWORD | Deprecated in v8.0.0. Replace with the `masterauth` password. | :white_large_square: | ✅ Supported

 | ❌ Flexible & Annual
❌ Free & Fixed | +| MT_MODE | Deprecated in v8.0.0. | :white_large_square: ||| +| PRIVILEGED_THREADS_NUM | Deprecated in v8.0.0. | :white_large_square: ||| +| WORKER_THREADS | Deprecated in v8.0.0. | :white_large_square: ||| +| SAFEMODE | Deprecated in v1.6.0. This is now the default setting | :white_large_square: ||| + +--- + +### search-bg-index-sleep-gap + +The number of iterations to run while performing background indexing before `usleep(1)` (sleep for 1 microsecond) is called, ensuring that Redis can process other commands. + +Type: integer + +Valid range: `[1 .. 4294967295]` + +Default: `100` + +### search-concurrent-write-mode + +If enabled, the tokenization of write queries will be performed concurrently. + +Type: boolean + +Default: `FALSE` + +### search-conn-per-shard + +The number of connections to each shard in a cluster. +If `0`, the number of connections is set to `search-workers` + 1. + +Type: integer + +Valid range: `[0 .. 9,223,372,036,854,775,807]` + +Default: `0` + +### search-cursor-max-idle + +The maximum idle time (in ms) that can be set to the [cursor api]({{< baseurl >}}/develop/interact/search-and-query/advanced-concepts/aggregations#cursor-api). + +Type: integer + +Valid range: `[0 .. 9,223,372,036,854,775,807]` + +Default: `300000` + +### search-cursor-read-size + +Type: integer + +Default: `1000` + +### search-cursor-reply-threshold + +The maximum number of replies to accumulate before triggering `_FT.CURSOR READ` on the shards. + +Type: integer + +Valid range: `[1 .. 9,223,372,036,854,775,807]` + +Default: `1` + +### search-default-dialect + +The default +[DIALECT]({{< relref "/develop/interact/search-and-query/advanced-concepts/dialects" >}}) +to be used by [`FT.CREATE`]({{< baseurl >}}/commands/ft.create/), [`FT.AGGREGATE`]({{< baseurl >}}/commands/ft.aggregate/), [`FT.EXPLAIN`]({{< baseurl >}}/commands/ft.explain/), [`FT.EXPLAINCLI`]({{< baseurl >}}/commands/ft.explaincli/), and [`FT.SPELLCHECK`]({{< baseurl >}}/commands/ft.spellcheck/). +See [Query dialects]({{< relref "/develop/interact/search-and-query/advanced-concepts/dialects" >}}) +for more information. + +Default: `1` + +### search-ext-load + +If present, Redis will try to load an extension dynamic library from the specified file path. +See [Extensions]({{< relref "/develop/interact/search-and-query/administration/extensions" >}}) for details. + +Type: string + +Default: not set + +### search-fork-gc-clean-numeric-empty-nodes + +Clean empty nodes from numeric tree. + +Type: boolean + +Default: `TRUE` + +### search-fork-gc-clean-threshold + +The fork GC will only start to clean when the number of uncleaned documents exceeds this threshold, otherwise it will skip this run. + +Type: integer + +Valid range: `[1 .. 9,223,372,036,854,775,807]` + +Default: `100` + +### search-fork-gc-retry-interval + +Interval (in seconds) in which Redis will retry to run fork GC in case of a failure. +This setting can only be combined with the [`search-gc-policy`](#search-gc-policy) `FORK` setting. + +Type: integer + +Valid range: `[1 .. 9,223,372,036,854,775,807]` + +Default: `5` + +### search-fork-gc-run-interval + +Interval (in seconds) between two consecutive fork GC runs. +This setting can only be combined with the [`search-gc-policy`](#search-gc-policy) `FORK` setting. + +Type: integer + +Valid range: `[1 .. 9,223,372,036,854,775,807]` + +Default: `30` + +### search-forkgc-sleep-before-exit + +The number of seconds for the fork GC to sleep before exit. This value should always be set to 0 except when testing. + +Type: integer + +Valid range: `[1 .. 9,223,372,036,854,775,807]` + +Default: `0` + +### search-frisoini + +If present, load the custom Chinese dictionary from the specified path. See [Using custom dictionaries]({{< baseurl >}}/develop/interact/search-and-query/advanced-concepts/chinese#using-custom-dictionaries) for more details. + +Type: string + +Default: not set + +### search-gc-policy + +The garbage collection policy. The two supported policies are: +* FORK: uses a forked thread for garbage collection (v1.4.1 and above). This is the default GC policy since v1.6.1 and is ideal for general purpose workloads. +* LEGACY: uses a synchronous, in-process fork. This is ideal for read-heavy and append-heavy workloads with very few updates/deletes. Deprecated in v2.6.0. + +Note: When `search-gc-policy` is set to `FORK`, it can be combined with the `search-fork-gc-run-interval` and `search-fork-gc-retry-interval` settings. + +Type: string + +Valid values: `FORK` or `DEFAULT` + +Default: `FORK` + +### search-gc-scansize + +The bulk size of the internal GC used for cleaning up indexes. + +Type: integer + +Valid range: `[1 .. 9,223,372,036,854,775,807]` + +Redis CE default: `100` + +Redis Enterprise default: `-1` (unlimited) + +Redis Cloud defaults: +- Flexible & Annual: `-1` (unlimited) +- Free & Fixed: `10000` + +### search-index-cursor-limit + +Added in v2.10.8. + +The maximum number of cursors that can be opened, per shard, at any given time. Cursors can be opened by the user via [`FT.AGGREGATE WITHCURSOR`]({{< baseurl >}}/commands/ft.aggregate/). Cursors are also opened internally by the Redis Query Engine for long-running queries. Once `INDEX_CURSOR_LIMIT` is reached, any further attempts to open a cursor will result in an error. + +{{% alert title="Notes" color="info" %}} +* Caution should be used in modifying this parameter. Every open cursor results in additional memory usage. +* Cursor usage should be regulated first by use of [`FT.CURSOR DEL`]({{< baseurl >}}/commands/ft.cursor-del/) and/or [`MAXIDLE`]({{< baseurl >}}/commands/ft.aggregate/) prior to modifying `INDEX_CURSOR_LIMIT` +* See [Cursor API]({{< baseurl >}}/develop/interact/search-and-query/advanced-concepts/aggregations#cursor-api) for more details. +{{% /alert %}} + +Type: integer + +Default: `128` + +### search-max-aggregate-results + +The maximum number of results to be returned by the `FT.AGGREGATE` command if `LIMIT` is used. + +Type: integer + +Valid range: `[1 .. 9,223,372,036,854,775,807]` + +Redis CE default: `-1` (unlimited) + +Redis Enterprise default: `-1` (unlimited) + +Redis Cloud defaults: +- Flexible & Annual: `-1` (unlimited) +- Free & Fixed: `10000` + +### search-max-doctablesize + +The maximum size of the internal hash table used for storing documents. +Note: this configuration option doesn't limit the number of documents that can be stored. It only affects the hash table internal array maximum size. +Decreasing this property can decrease the memory overhead in cases where the index holds a small number of documents that are constantly updated. + +Type: integer + +Valid range: `[1 .. 18,446,744,073,709,551,615]` + +Default: `1000000` + +### search-max-expansions + +This parameter is an alias for [search-max-prefix-expansions](#search-max-prefix-expansions). + +### search-max-prefix-expansions + +The maximum number of expansions allowed for query prefixes. +The maximum number of expansions allowed for query prefixes. Setting it too high can cause performance issues. If `search-max-prefix-expansions` is reached, the query will continue with the first acquired results. The configuration is applicable for all affix queries including prefix, suffix, and infix (contains) queries. + +Type: integer + +Valid range: `[1 .. 9,223,372,036,854,775,807]` + +Default: `200` + +### search-max-searchresults + +The maximum number of results to be returned by the `FT.SEARCH` command if `LIMIT` is used. Set it to `-1` to remove the limit. + +Type: integer + +Valid range: `[1 .. 9,223,372,036,854,775,807]` + +Redis CE default: `1000000` + +Redis Enterprise default: `1000000` + +Redis Cloud defaults: +- Flexible & Annual: `1000000` +- Free & Fixed: `10000` + +### search-min-operation-workers + +The number of worker threads to use for background tasks when the server is in an operation event. + +Type: integer + +Valid range: `[0 .. 8192]` + +Default: `4` + +### search-min-phonetic-term-len + +The minimum length of term to be considered for phonetic matching. + +Type: integer + +Valid range: `[1 .. 9,223,372,036,854,775,807]` + +Default: `3` + +### search-min-prefix + +The minimum number of characters allowed for prefix queries (e.g., hel*). Setting it to `1` can reduce performance. + +Type: integer + +Valid range: `[1 .. 9,223,372,036,854,775,807]` + +Default: `2` + +### search-min-stem-len + +The minimum word length to stem. Setting it lower than `4` can reduce performance. + +Type: integer + +Valid range: `[2 .. 4,294,967,295]` + +Redis CE default: `4` + +Redis Enterprise and Redis Cloud default: `2` + +### search-multi-text-slop + +Set the delta that is used to increase positional offsets between array slots for multi text values. +This will allow you to control the level of separation between phrases in different array slots; related to the `SLOP` parameter of `FT.SEARCH` command. + +Type: integer + +Valid range: `[0 .. 4,294,967,295]` + +Default: `100` + +### search-no-mem-pools + +Set Redis Query Engine to run without memory pools. + +Type: boolean + +Default: `FALSE` + +### search-nogc + +If set to `TRUE`, garbage collection is disabled for all indexes. + +Type: boolean + +Default: `FALSE` + +### search-on-timeout + +The response policy for queries that exceed the [`search-timeout`](#search-timeout) setting can be one of the following: + +* `RETURN`: this policy will return the top results accumulated by the query until it timed out. +* `FAIL`: will return an error when the query exceeds the timeout value. + +Type: string + +Valid values: `RETURN`, `FAIL` + +Default: `RETURN` + +### search-partial-indexed-docs + +Added in v2.0.0. + +Enable/disable the Redis command filter. The filter optimizes partial updates of hashes +and may avoid re-indexing the hash if changed fields are not part of the schema. + +The Redis command filter will be executed upon each Redis command. Though the filter is +optimized, this will introduce a small increase in latency on all commands. +This configuration is best used with partially indexed documents where the non-indexed fields are updated frequently. + +Type: integer + +Valid values: `0` (false), `1` (true) + +Default: `0` + +### search-raw-docid-encoding + +Disable compression for DocID inverted indexes to boost CPU performance. + +Type: boolean + +Default: `FALSE` + +### search-threads + +Sets the number of search threads in the coordinator thread pool. + +Type: integer + +### search-tiered-hnsw-buffer-limit + +Used for setting the buffer limit threshold for vector tiered HNSW indexes. If Redis is using `WORKERS` for indexing, and the number of vectors waiting in the buffer to be indexed exceeds this limit, new vectors are inserted directly into HNSW. + +Type: integer + +Valid range: `[0 .. 9,223,372,036,854,775,807]` + +Default: `1024` + +### search-timeout + +The maximum amount of time in milliseconds that a search query is allowed to run. If this time is exceeded, Redis returns the top results accumulated so far, or an error depending on the policy set with [`search-on-timeout`](#search-on-timeout). The timeout can be disabled by setting it to `0`. + +{{% alert title="Notes" color="info" %}} +* `search-timeout` refers to query time only. +* Parsing the query is not counted towards `search-timeout`. +* If `search-timeout` was not reached during the search, finalizing operations such as loading document content or reducers continue. +{{% /alert %}} + +Type: integer + +Value range: `[1 .. 9,223,372,036,854,775,807]` + +Redis CE default: `500` + +Redis Enterprise default: `500` + +Redis Cloud defaults: +- Flexible & Annual: `500` +- Free & Fixed: `100` + +### search-topology-validation-timeout + +Sets the timeout in milliseconds for topology validation. After this timeout, any pending requests will be processed, even if the topology is not fully connected. A value of `0` means no timeout. + +Type: integer + +Valid range: `[1 .. 9,223,372,036,854,775,807]` + +Default: `30000` + +### search-union-iterator-heap + +The minimum number of iterators in a union at which the iterator will switch to a heap based implementation. + +Type: integer + +Valid range: `[1 .. 9,223,372,036,854,775,807]` + +Default: `20` + +### search-upgrade-index + +Relevant only when loading an v1.x RDB file. Specify the argument for upgrading the index. +This configuration setting is a special configuration option introduced to upgrade indexes from v1.x Redis Query Engine versions, otherwise known as legacy indexes. This configuration option needs to be given for each legacy index, followed by the index name and all valid options for the index description (also referred to as the `ON` arguments for following hashes) as described on [FT.CREATE]({{< baseurl >}}/commands/ft.create/) command page. + +Type: string + +Default: there is no default for index name, and the other arguments have the same defaults as with the [`FT.CREATE`]({{< baseurl >}}/commands/ft.create/) command. + +**Example** + +``` +search-upgrade-index idx PREFIX 1 tt LANGUAGE french LANGUAGE_FIELD MyLang SCORE 0.5 SCORE_FIELD MyScore + PAYLOAD_FIELD MyPayload UPGRADE_INDEX idx1 +``` + +{{% alert title="Notes" color="info" %}} +* If the RDB file does not contain a legacy index that's specified in the configuration, a warning message will be added to the log file, and loading will continue. +* If the RDB file contains a legacy index that wasn't specified in the configuration, loading will fail and the server won't start. +{{% /alert %}} + +### search-vss-max-resize + +Added in v2.4.8. + +The maximum memory resize (in bytes) for vector indexes. +The maximum memory resize (in bytes) for vector indexes. This value will override default memory limits if you need to allow for a large [`BLOCK_SIZE`]({{< baseurl >}}/develop/interact/search-and-query/advanced-concepts/vectors/#creation-attributes-per-algorithm). + +Type: integer + +Valid range: `[0 .. 4,294,967,295]` + +Default: `0` + +### search-workers-priority-bias-threshold + +The number of high priority tasks to be executed at any given time by the worker thread pool before executing low priority tasks. After this number of high priority tasks are being executed, the worker thread pool will execute high and low priority tasks alternately. + +Type: integer + +Valid range: `[1 .. 9,223,372,036,854,775,807]` + +Default: `1` + +### search-workers + +The number of worker threads to use for query processing and background tasks. + +Type: integer + +Valid range: `[0 .. 8192]` + +Default: `0` + +## Set configuration parameters at module load-time (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" >}}): + +``` +loadmodule ./redisearch.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 redisearch.so [OPT VAL]... +``` + +From the command line: + +``` +$ redis-server --loadmodule ./redisearch.so [OPT VAL]... +``` + +## Set configuration parameters at run-time (for supported parameters, deprecated) + +These methods are deprecated beginning with Redis CE v8.0.0. + +Redis Query Engine exposes the `FT.CONFIG` endpoint to allow for the setting and retrieval of configuration parameters at run-time. + +To set the value of a configuration parameter at run-time (for supported parameters), simply run: + +```sh +FT.CONFIG SET OPT1 VAL1 +``` + +Similarly, you can retrieve current configuration parameter values using: + +```sh +FT.CONFIG GET OPT1 +FT.CONFIG GET * +``` + +Values set using [`FT.CONFIG SET`]({{< baseurl >}}/commands/ft.config-set/) are not persisted after server restart. \ No newline at end of file diff --git a/content/develop/interact/search-and-query/advanced-concepts/query_syntax.md b/content/develop/interact/search-and-query/advanced-concepts/query_syntax.md index cf5f3258d..1892b163a 100644 --- a/content/develop/interact/search-and-query/advanced-concepts/query_syntax.md +++ b/content/develop/interact/search-and-query/advanced-concepts/query_syntax.md @@ -478,4 +478,4 @@ As of v2.6.1, the query attributes syntax supports these additional attributes: The query parser is built using the Lemon Parser Generator and a Ragel based lexer. You can see the `DIALECT 2` grammar definition [at this git repo](https://github.com/RediSearch/RediSearch/blob/master/src/query_parser/v2/parser.y). -You can also see the [DEFAULT_DIALECT]({{< baseurl >}}/develop/interact/search-and-query/basic-constructs/configuration-parameters#default_dialect) configuration parameter. +You can also see the [DEFAULT_DIALECT]({{< baseurl >}}/develop/interact/search-and-query/administration/configuration#default_dialect) configuration parameter. diff --git a/content/develop/interact/search-and-query/basic-constructs/configuration-parameters.md b/content/develop/interact/search-and-query/basic-constructs/configuration-parameters.md deleted file mode 100644 index df2e870b1..000000000 --- a/content/develop/interact/search-and-query/basic-constructs/configuration-parameters.md +++ /dev/null @@ -1,602 +0,0 @@ ---- -categories: -- docs -- develop -- stack -- oss -- rs -- rc -- oss -- kubernetes -- clients -description: 'Redis Query Engine can be tuned through multiple - configuration parameters. Some of these parameters can only be set at load-time, - while other parameters can be set either at load-time or at run-time.' -linkTitle: Configuration parameters -title: Configuration parameters -weight: 4 ---- - -## Set configuration parameters at module load-time - -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" >}}): - -``` -loadmodule ./redisearch.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 redisearch.so [OPT VAL]... -``` - -From the command line: - -``` -$ redis-server --loadmodule ./redisearch.so [OPT VAL]... -``` - -## Set configuration parameters at run-time (for supported parameters) - -Redis Query Engine exposes the `FT.CONFIG` endpoint to allow for the setting and retrieval of configuration parameters at run-time. - -To set the value of a configuration parameter at run-time (for supported parameters), simply run: - -```sh -FT.CONFIG SET OPT1 VAL1 -``` - -Similarly, you can retrieve current configuration parameter values using: - -```sh -FT.CONFIG GET OPT1 -FT.CONFIG GET * -``` - -Values set using [`FT.CONFIG SET`]({{< baseurl >}}/commands/ft.config-set/) are not persisted after server restart. - -## Redis Query Engine configuration parameters - -The following table summarizes which configuration parameters can be set at module load-time and run-time: - -| Configuration Parameter | Load-time | Run-time | -| :------- | :----- | :----------- | -| [TIMEOUT](#timeout) | :white_check_mark: | :white_check_mark: | -| [ON_TIMEOUT](#on_timeout) | :white_check_mark: | :white_check_mark: | -| [SAFEMODE](#safemode) deprecated in v1.6 | :white_check_mark: | :white_check_mark: | -| [CONCURRENT_WRITE_MODE](#concurrent_write_mode) | :white_check_mark: | :white_check_mark: | -| [EXTLOAD](#extload) | :white_check_mark: | :white_check_mark: | -| [MINPREFIX](#minprefix) | :white_check_mark: | :white_check_mark: | -| [MINSTEMLEN](#minstemlen) | :white_check_mark: | :white_check_mark: | -| [MAXPREFIXEXPANSIONS](#maxprefixexpansions) | :white_check_mark: | :white_check_mark: | -| [MAXDOCTABLESIZE](#maxdoctablesize) | :white_check_mark: | :white_check_mark: | -| [MAXSEARCHRESULTS](#maxsearchresults) | :white_check_mark: | :white_check_mark: | -| [MAXAGGREGATERESULTS](#maxaggregateresults) | :white_check_mark: | :white_check_mark: | -| [FRISOINI](#frisoini) | :white_check_mark: | :white_check_mark: | -| [CURSOR_MAX_IDLE](#cursor_max_idle) | :white_check_mark: | :white_check_mark: | -| [PARTIAL_INDEXED_DOCS](#partial_indexed_docs) | :white_check_mark: | :white_check_mark: | -| [GC_SCANSIZE](#gc_scansize) | :white_check_mark: | :white_large_square: | -| [GC_POLICY](#gc_policy) | :white_check_mark: | :white_check_mark: | -| [NOGC](#nogc) | :white_check_mark: | :white_check_mark: | -| [FORK_GC_RUN_INTERVAL](#fork_gc_run_interval) | :white_check_mark: | :white_check_mark: | -| [FORK_GC_RETRY_INTERVAL](#fork_gc_retry_interval) | :white_check_mark: | :white_check_mark: | -| [FORK_GC_CLEAN_THRESHOLD](#fork_gc_clean_threshold) | :white_check_mark: | :white_check_mark: | -| [UPGRADE_INDEX](#upgrade_index) | :white_check_mark: | :white_check_mark: | -| [OSS_GLOBAL_PASSWORD](#oss_global_password) | :white_check_mark: | :white_large_square: | -| [DEFAULT_DIALECT](#default_dialect) | :white_check_mark: | :white_check_mark: | -| [VSS_MAX_RESIZE](#vss_max_resize) | :white_check_mark: | :white_check_mark: | -| [INDEX_CURSOR_LIMIT](#index_cursor_limit) | :white_check_mark: | :white_check_mark: | - ---- - -### TIMEOUT - -The maximum amount of time in milliseconds that a search query is allowed to run. If this time is exceeded, Redis returns the top results accumulated so far, or an error depending on the policy set with `ON_TIMEOUT`. The timeout can be disabled by setting it to 0. - -{{% alert title="Notes" color="info" %}} - -* `TIMEOUT` refers to query time only. -* Parsing the query is not counted towards `TIMEOUT`. -* If `TIMEOUT` was not reached during the search, finalizing operations such as loading document content or reducers continue. - -{{% /alert %}} - -#### Default - -500 - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so TIMEOUT 100 -``` - ---- - -### ON_TIMEOUT - -The response policy for queries that exceed the `TIMEOUT` setting can be one of the following: - -* **RETURN**: this policy will return the top results accumulated by the query until it timed out. -* **FAIL**: will return an error when the query exceeds the timeout value. - -#### Default - -RETURN - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so ON_TIMEOUT fail -``` - ---- - -### SAFEMODE - -{{% alert title="Deprecated" color="info" %}} - -Deprecated in v1.6. From this version, SAFEMODE is the default. If you would still like to re-enable the concurrent mode for writes, use [CONCURRENT_WRITE_MODE](#concurrent_write_mode). - -{{% /alert %}} - -If present in the argument list, Redis Query Engine will turn off concurrency for query processing and work in a single thread. - -This is useful if data consistency is extremely important, and avoids a situation where deletion of documents while querying them can cause momentarily inconsistent results. For example, documents that were valid during the invocation of the query are not returned because they were deleted during query processing. - -#### Default -Off (not present) - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so SAFEMODE -``` - -___ - -### CONCURRENT_WRITE_MODE - -If enabled, write queries will be performed concurrently, but only the tokenization part is executed concurrently. The actual write operation still requires holding the Redis Global Lock. - -#### Default - -Not set - "disabled" - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so CONCURRENT_WRITE_MODE -``` - -{{% alert title="Note" color="info" %}} - -* Added in v1.6 - -{{% /alert %}} - ---- - -### EXTLOAD - -If present, Redis Query Engine will try to load an extension dynamic library from its specified file path. See [Extensions]({{< relref "/develop/interact/search-and-query/administration/extensions" >}}) for details. - -#### Default - -None - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so EXTLOAD ./ext/my_extension.so -``` - ---- - -### MINPREFIX - -The minimum number of characters allowed for prefix queries (e.g., `hel*`). Setting it to 1 can hurt performance. - -#### Default - -2 - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so MINPREFIX 3 -``` - ---- - -### MINSTEMLEN - -The minimum word length to stem. The default value is `4`. Setting it lower than `4` can reduce performance. - -#### Default - -4 - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so MINSTEMLEN 3 -``` - ---- - -### MAXPREFIXEXPANSIONS - -The maximum number of expansions allowed for query prefixes. Setting it too high can cause performance issues. If MAXPREFIXEXPANSIONS is reached, the query will continue with the first acquired results. The configuration is applicable for all affix queries including prefix, suffix, and infix (contains) queries. - -#### Default - -200 - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so MAXPREFIXEXPANSIONS 1000 -``` - ---- - -### MAXDOCTABLESIZE - -The maximum size of the internal hash table used for storing the documents. -Note: this configuration option doesn't limit the number of documents that can be stored. It only affects the hash table internal array maximum size. -Decreasing this property can decrease the memory overhead in cases where the index holds a small number of documents that are constantly updated. - -#### Default - -1000000 - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so MAXDOCTABLESIZE 3000000 -``` - ---- - -### MAXSEARCHRESULTS - -The maximum number of results to be returned by the [`FT.SEARCH`]({{< baseurl >}}/commands/ft.search/) command if LIMIT is used. -Setting value to `-1` will remove the limit. - -#### Default - -1000000 - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so MAXSEARCHRESULTS 3000000 -``` - ---- - -### MAXAGGREGATERESULTS - -The maximum number of results to be returned by the [`FT.AGGREGATE`]({{< baseurl >}}/commands/ft.aggregate/) command if LIMIT is used. -Setting value to `-1` will remove the limit. - -#### Default - -unlimited - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so MAXAGGREGATERESULTS 3000000 -``` - ---- - -### FRISOINI - -If present, load the custom Chinese dictionary from the specified path. See [Using custom dictionaries]({{< baseurl >}}/develop/interact/search-and-query/advanced-concepts/chinese#using-custom-dictionaries) for more details. - -#### Default - -Not set - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so FRISOINI /opt/dict/friso.ini -``` - ---- - -### CURSOR_MAX_IDLE - -The maximum idle time (in ms) that can be set to the [cursor api]({{< baseurl >}}/develop/interact/search-and-query/advanced-concepts/aggregations#cursor-api). - -#### Default - -300000 - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so CURSOR_MAX_IDLE 500000 -``` - -{{% alert title="Note" color="info" %}} - -* Added in v1.6 - -{{% /alert %}} - ---- - -### PARTIAL_INDEXED_DOCS - -Enable/disable the Redis command filter. The filter optimizes partial updates of hashes -and may avoid re-indexing the hash if changed fields are not part of the schema. - -#### Considerations - -The Redis command filter will be executed upon each Redis command. Though the filter is -optimized, this will introduce a small increase in latency on all commands. -This configuration is best used with partially indexed documents where the non-indexed fields are updated frequently. - -#### Default - -0 - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so PARTIAL_INDEXED_DOCS 1 -``` - -{{% alert title="Note" color="info" %}} - -* Added in v2.0.0 - -{{% /alert %}} - - ---- - -### GC_SCANSIZE - -The bulk size of the internal GC used for cleaning up indexes. - -#### Default - -100 - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so GC_SCANSIZE 10 -``` - ---- - -### GC_POLICY - -The garbage collection policy. Supported policies are: - -* **FORK**: uses a forked thread for garbage collection (v1.4.1 and above). - This is the default GC policy since version 1.6.1 and is ideal - for general purpose workloads. -* **LEGACY**: Uses a synchronous, in-process fork. This is ideal for read-heavy - and append-heavy workloads with very few updates/deletes. - Deprecated in v2.6.0. - -#### Default - -FORK - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so GC_POLICY FORK -``` - -{{% alert title="Note" color="info" %}} - -* When the `GC_POLICY` is `FORK` it can be combined with the options below. - -{{% /alert %}} - ---- - -### NOGC - -If set, Garbage Collection is disabled for all indexes. This is used mainly for debugging and testing and should not be set by users. - -#### Default - -Not set - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so NOGC -``` - ---- - -### FORK_GC_RUN_INTERVAL - -Interval (in seconds) between two consecutive `fork GC` runs. - -#### Default - -30 - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so GC_POLICY FORK FORK_GC_RUN_INTERVAL 60 -``` - -{{% alert title="Note" color="info" %}} - -* Can only be combined with `GC_POLICY FORK` - -{{% /alert %}} - ---- - -### FORK_GC_RETRY_INTERVAL - -Interval (in seconds) in which Redis Query Engine will retry to run `fork GC` in case of a failure. Usually, a failure could happen when the Redis fork API does not allow for more than one fork to be created at the same time. - -#### Default - -5 - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so GC_POLICY FORK FORK_GC_RETRY_INTERVAL 10 -``` - -{{% alert title="Notes" color="info" %}} - -* Can only be combined with `GC_POLICY FORK` -* Added in v1.4.16 - -{{% /alert %}} - ---- - -### FORK_GC_CLEAN_THRESHOLD - -The `fork GC` will only start to clean when the number of not cleaned documents exceeds this threshold, otherwise it will skip this run. While the default value is 100, it's highly recommended to change it to a higher number. - -#### Default - -100 - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so GC_POLICY FORK FORK_GC_CLEAN_THRESHOLD 10000 -``` - -{{% alert title="Notes" color="info" %}} - -* Can only be combined with `GC_POLICY FORK` -* Added in v1.4.16 - -{{% /alert %}} - ---- - -### UPGRADE_INDEX - -This configuration is a special configuration option introduced to upgrade indices from v1.x Redis Query Engine versions, otherwise known as legacy indices. This configuration option needs to be given for each legacy index, followed by the index name and all valid options for the index description (also referred to as the `ON` arguments for following hashes) as described on [ft.create api]({{< baseurl >}}/commands/ft.create/). - -#### Default - -There is no default for index name, and the other arguments have the same defaults as with the [`FT.CREATE`]({{< baseurl >}}/commands/ft.create/) API. - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so UPGRADE_INDEX idx PREFIX 1 tt LANGUAGE french LANGUAGE_FIELD MyLang SCORE 0.5 SCORE_FIELD MyScore PAYLOAD_FIELD MyPayload UPGRADE_INDEX idx1 -``` - -{{% alert title="Notes" color="info" %}} - -* If the RDB file does not contain a legacy index that's specified in the configuration, a warning message will be added to the log file, and loading will continue. -* If the RDB file contains a legacy index that wasn't specified in the configuration, loading will fail and the server won't start. - -{{% /alert %}} - ---- - -### OSS_GLOBAL_PASSWORD - -Global Redis Community Edition cluster password that will be used to connect to other shards. - -#### Default - -Not set - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so OSS_GLOBAL_PASSWORD password -``` - -{{% alert title="Notes" color="info" %}} - -* Only relevant when Coordinator is used -* Added in v2.0.3 - -{{% /alert %}} - ---- - -### DEFAULT_DIALECT - -The default -[DIALECT]({{< relref "/develop/interact/search-and-query/advanced-concepts/dialects" >}}) -to be used by [`FT.CREATE`]({{< baseurl >}}/commands/ft.create/), [`FT.AGGREGATE`]({{< baseurl >}}/commands/ft.aggregate/), [`FT.EXPLAIN`]({{< baseurl >}}/commands/ft.explain/), [`FT.EXPLAINCLI`]({{< baseurl >}}/commands/ft.explaincli/), and [`FT.SPELLCHECK`]({{< baseurl >}}/commands/ft.spellcheck/). -See [Query dialects]({{< relref "/develop/interact/search-and-query/advanced-concepts/dialects" >}}) -for more information. - -#### Default - -1 - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so DEFAULT_DIALECT 2 -``` - ---- - -### VSS_MAX_RESIZE - -The maximum memory resize for vector similarity indexes in bytes. This value will override default memory limits if you need to allow for a large [`BLOCK_SIZE`]({{< baseurl >}}/develop/interact/search-and-query/advanced-concepts/vectors/#creation-attributes-per-algorithm). - -#### Default - -0 - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so VSS_MAX_RESIZE 52428800 # 50MB -``` - -{{% alert title="Note" color="info" %}} - -* Added in v2.4.8 - -{{% /alert %}} -### INDEX_CURSOR_LIMIT - -The maximum number of cursors that can be opened, per shard, at any given time. Cursors can be opened by the user via [`FT.AGGREGATE WITHCURSOR`]({{< baseurl >}}/commands/ft.aggregate/). Cursors are also opened internally by the Redis Query Engine for long-running queries. Once `INDEX_CURSOR_LIMIT` is reached, any further attempts at opening a cursor will result in an error. - -{{% alert title="Notes" color="info" %}} - -* Caution should be used in modifying this parameter. Every open cursor results in additional memory usage. -* Cursor usage should be regulated first by use of [`FT.CURSOR DEL`]({{< baseurl >}}/commands/ft.cursor-del/) and/or [`MAXIDLE`]({{< baseurl >}}/commands/ft.aggregate/) prior to modifying `INDEX_CURSOR_LIMIT` -* See [Cursor API]({{< baseurl >}}/develop/interact/search-and-query/advanced-concepts/aggregations#cursor-api) for more details. - -* Added in 2.10.8 -{{% /alert %}} - -#### Default - -128 - -#### Example - -``` -$ redis-server --loadmodule ./redisearch.so INDEX_CURSOR_LIMIT 180 -``` \ No newline at end of file diff --git a/content/develop/interact/search-and-query/query/combined.md b/content/develop/interact/search-and-query/query/combined.md index 0a043b025..29de811b4 100644 --- a/content/develop/interact/search-and-query/query/combined.md +++ b/content/develop/interact/search-and-query/query/combined.md @@ -26,7 +26,7 @@ A combined query is a combination of several query types, such as: You can use logical query operators to combine query expressions for numeric, tag, and text fields. For vector fields, you can combine a KNN query with a pre-filter. {{% alert title="Note" color="warning" %}} -The operators are interpreted slightly differently depending on the query dialect used. The default dialect is `DIALECT 1`; see [this article]({{< baseurl >}}/develop/interact/search-and-query/basic-constructs/configuration-parameters#default_dialect) for information on how to change the dialect version. This article uses the second version of the query dialect, `DIALECT 2`, and uses additional brackets (`(...)`) to help clarify the examples. Further details can be found in the [query syntax documentation]({{< relref "/develop/interact/search-and-query/advanced-concepts/query_syntax" >}}). +The operators are interpreted slightly differently depending on the query dialect used. The default dialect is `DIALECT 1`; see [this article]({{< baseurl >}}/develop/interact/search-and-query/administration/configuration#default_dialect) for information on how to change the dialect version. This article uses the second version of the query dialect, `DIALECT 2`, and uses additional brackets (`(...)`) to help clarify the examples. Further details can be found in the [query syntax documentation]({{< relref "/develop/interact/search-and-query/advanced-concepts/query_syntax" >}}). {{% /alert %}} The examples in this article use the following schema: diff --git a/content/operate/oss_and_stack/stack-with-enterprise/bloom/config.md b/content/operate/oss_and_stack/stack-with-enterprise/bloom/config.md index abcf8e336..3daf665ce 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/bloom/config.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/bloom/config.md @@ -33,8 +33,4 @@ To change the RedisBloom configuration using the Redis Software Cluster Manager ## Configuration settings -| Setting | Redis
Enterprise | Redis
Cloud | Notes | -|:--------|:----------------------|:-----------------|:------| -| [CF_MAX_EXPANSIONS]({{< relref "/develop/data-types/probabilistic/" >}}configuration/#cf_max_expansions) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: 32 | -| [ERROR_RATE]({{< relref "/develop/data-types/probabilistic/" >}}configuration/#error_rate) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: 0.01 | -| [INITIAL_SIZE]({{< relref "/develop/data-types/probabilistic/" >}}configuration/#initial_size) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: 100 | +See [configuration settings]({{< relref "/develop/data-types/probabilistic/configuration" >}}) in the Develop section. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-1.4-release-notes.md b/content/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-1.4-release-notes.md index d214f63e0..542431993 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-1.4-release-notes.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-1.4-release-notes.md @@ -382,7 +382,7 @@ redis-server --loadmodule ./redisearch.so GC_POLICY FORK ### Runtime configuration -RediSearch's [configuration]({{}}) is applied via arguments passed to the module at load time. This release introduces the new `FT.CONFIG` command that allows to retrieve the current configuration as well as change it during runtime. +RediSearch's [configuration]({{}}) is applied via arguments passed to the module at load time. This release introduces the new `FT.CONFIG` command that allows to retrieve the current configuration as well as change it during runtime. ### Unlimited autocomplete results diff --git a/content/operate/oss_and_stack/stack-with-enterprise/search/config.md b/content/operate/oss_and_stack/stack-with-enterprise/search/config.md index eb43029fb..f9efe0d0d 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/search/config.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/search/config.md @@ -66,29 +66,4 @@ For Redis Enterprise Software, use one of the following methods: ## Configuration settings -| Setting | Redis
Enterprise | Redis
Cloud | Notes | -|:--------|:----------------------|:-----------------|:------| -| [CONCURRENT_WRITE_MODE]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: Not enabled | -| [CURSOR_MAX_IDLE]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: 300000 | -| CURSOR_READ_SIZE | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: 1000 | -| [DEFAULT_DIALECT]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: 1 | -| [EXTLOAD]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: None | -| [FORK_GC_CLEAN_THRESHOLD]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: 100 | -| [FORK_GC_RETRY_INTERVAL]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: 5 | -| [FORK_GC_RUN_INTERVAL]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: 30 | -| [FRISOINI]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: Not set | -| [GC_POLICY]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: FORK | -| [GC_SCANSIZE]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: 100 | -| [MAXAGGREGATERESULTS]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Redis Enterprise default: Unlimited

Redis Cloud defaults:
• Flexible & Annual: Unlimited
• Free & Fixed: 10000
| -| [MAXDOCTABLESIZE]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: 1000000 | -| [MAXPREFIXEXPANSIONS]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: 200 | -| [MAXSEARCHRESULTS]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Redis Enterprise default: 1000000

Redis Cloud defaults:
• Flexible & Annual: 1000000
• Free & Fixed: 10000
| -| [MINPREFIX]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: 2 | -| [MINSTEMLEN]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: 2 | -| [NOGC]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: Not set | -| [ON_TIMEOUT]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: RETURN | -| [OSS_GLOBAL_PASSWORD]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ❌ Flexible & Annual
❌ Free & Fixed | | -| [PARTIAL_INDEXED_DOCS]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: 0 | -| [TIMEOUT]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Redis Enterprise default: 500

Redis Cloud defaults:
• Flexible & Annual: 500
• Free & Fixed: 100
| -| UNION_ITERATOR_HEAP| ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed -| [UPGRADE_INDEX]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: No default index name | +See [configuration settings]({{< relref "/develop/interact/search-and-query/administration/configuration" >}}) in the Develop section. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/timeseries/config.md b/content/operate/oss_and_stack/stack-with-enterprise/timeseries/config.md index c44d040f5..4bead9fc6 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/timeseries/config.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/timeseries/config.md @@ -33,12 +33,4 @@ To change RedisTimeSeries configuration using the Redis Software Cluster Manager ## Configuration settings -| Setting | Redis
Enterprise | Redis
Cloud | Notes | -|:--------|:----------------------|:-----------------|:------| -| [CHUNK_SIZE_BYTES]({{< relref "/develop/data-types/timeseries/configuration" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: `4096` | -| [COMPACTION_POLICY]({{< relref "/develop/data-types/timeseries/configuration" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: No default compaction rules | -| [DUPLICATE_POLICY]({{< relref "/develop/data-types/timeseries/configuration" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: `BLOCK` | -| [ENCODING]({{< relref "/develop/data-types/timeseries/configuration" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: `COMPRESSED` | -| [NUM_THREADS]({{< relref "/develop/data-types/timeseries/configuration" >}}) | ✅ Supported

 | ✅ Flexible & Annual\*
❌ Free & Fixed | \* Updates automatically when you change your plan.

Redis Enterprise default: Set by plan

Redis Cloud defaults:
• Flexible & Annual: Set by plan
• Free & Fixed: `1`
| -| [RETENTION_POLICY]({{< relref "/develop/data-types/timeseries/configuration" >}}) | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | Default: `0` | - +See [configuration settings]({{< relref "/develop/data-types/timeseries/configuration" >}}) in the Develop section.