diff --git a/content/develop/interact/search-and-query/administration/configuration.md b/content/develop/interact/search-and-query/administration/configuration.md index 048188c6f..d83a9f227 100644 --- a/content/develop/interact/search-and-query/administration/configuration.md +++ b/content/develop/interact/search-and-query/administration/configuration.md @@ -17,12 +17,12 @@ linkTitle: Configuration parameters title: Configuration parameters weight: 1 --- -{{{< note >}} -As of Redis Community Edition 8.0, configuration parameters for the time series data structure are now set in the following ways: +{{< note >}} +As of Redis Community Edition (CE) 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. -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). +Also, 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 Query Engine configuration parameters @@ -39,28 +39,27 @@ The following table summarizes which configuration parameters can be set at run- | 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 | +| FORKGC_SLEEP_BEFORE_EXIT | [search-fork-gc-sleep-before-exit](#search-fork-gc-sleep-before-exit) | :white_check_mark: ||| +| FRISOINI | [search-friso-ini](#search-friso-ini) | :white_large_square: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| [GC_POLICY](#gc_policy) | There is no matching `CONFIG` parameter. | :white_large_square: | ✅ Supported

 | ✅ Flexible & Annual
❌ Free & Fixed | +| GCSCANSIZE | [search-gc-scan-size](#search-gc-scan-size) | :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 | +| MAXSEARCHRESULTS | [search-max-search-results](#search-max-search-results) | :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 | +| NOGC | [search-no-gc](#search-no-gc) | :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: ||| @@ -74,10 +73,11 @@ The following table summarizes which configuration parameters can be set at run- | 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: ||| +| MT_MODE | Deprecated in v8.0.0. Use search-workers. | :white_large_square: ||| +| PRIVILEGED_THREADS_NUM | Deprecated in v8.0.0. Use search-workers-priority-bias-threshold.| :white_large_square: ||| +| WORKER_THREADS | Deprecated in v8.0.0. Use search-min-operation-workers. | :white_large_square: ||| +| SAFEMODE | Deprecated in v1.6.0. This is now the default setting. | :white_large_square: ||| +| FORK_GC_CLEAN_NUMERIC_EMPTY_NODES | Deprecated in v8.0.0. | :white_large_square: ||| {{< note >}} Parameter names for Redis CE versions < 8.0, while deprecated, will still be supported in version 8.0. @@ -199,7 +199,7 @@ Valid range: `[1 .. 9,223,372,036,854,775,807]` Default: `30` -### search-forkgc-sleep-before-exit +### search-fork-gc-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. @@ -209,7 +209,7 @@ Valid range: `[1 .. 9,223,372,036,854,775,807]` Default: `0` -### search-frisoini +### search-friso-ini 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. @@ -217,13 +217,13 @@ Type: string Default: not set -### search-gc-policy +### 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. +Note: When `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 @@ -231,7 +231,7 @@ Valid values: `FORK` or `DEFAULT` Default: `FORK` -### search-gc-scansize +### search-gc-scan-size The bulk size of the internal GC used for cleaning up indexes. @@ -306,7 +306,7 @@ Valid range: `[1 .. 9,223,372,036,854,775,807]` Default: `200` -### search-max-searchresults +### search-max-search-results 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. @@ -383,7 +383,7 @@ Type: boolean Default: `FALSE` -### search-nogc +### search-no-gc If set to `TRUE`, garbage collection is disabled for all indexes. diff --git a/content/develop/interact/search-and-query/advanced-concepts/dialects.md b/content/develop/interact/search-and-query/advanced-concepts/dialects.md index d061f238e..f429c0adb 100644 --- a/content/develop/interact/search-and-query/advanced-concepts/dialects.md +++ b/content/develop/interact/search-and-query/advanced-concepts/dialects.md @@ -15,10 +15,13 @@ title: Query dialects weight: 5 --- -Redis Community Edition currently supports four query dialects for use with the [`FT.SEARCH`]({{< baseurl >}}/commands/ft.search/), [`FT.AGGREGATE`]({{< baseurl >}}/commands/ft.aggregate/), and other Redis Query Engine commands. +Redis Community Edition (CE) currently supports four query dialects for use with the [`FT.SEARCH`]({{< baseurl >}}/commands/ft.search/), [`FT.AGGREGATE`]({{< baseurl >}}/commands/ft.aggregate/), and other Redis Query Engine commands. Dialects provide for enhancing the query API incrementally, introducing innovative behaviors and new features that support new use cases in a way that does not break the API for existing applications. -## `DIALECT 1` +{{< note >}}Dialects 1, 3, and 4 are deprecated in CE version 8. However, DIALECT 1 remains the default. +{{< /note >}} + +## `DIALECT 1` (Deprecated) Dialect version 1 was the default query syntax dialect from the first release of search and query until dialect version 2 was introduced with version [2.4](https://github.com/RediSearch/RediSearch/releases/tag/v2.4.3). This dialect is also the default dialect. See below for information about changing the default dialect. @@ -124,7 +127,7 @@ The Dialect version 2 enhancements also introduce simplified syntax for logical `FT.SEARCH idx "(@tag:{3d3586fe-0416-4572-8ce1} ~@tag{3d3586fe-0416-6758-4ri8})" DIALECT 2` -## `DIALECT 3` +## `DIALECT 3` (Deprecated) Dialect version 3 was introduced in the [2.6](https://github.com/RediSearch/RediSearch/releases/tag/v2.6.3) release. This version introduced support for multi-value indexing and querying of attributes for any attribute type ( [TEXT]({{< baseurl >}}/develop/interact/search-and-query/indexing/#index-json-arrays-as-text), [TAG]({{< baseurl >}}/develop/interact/search-and-query/indexing/#index-json-arrays-as-tag), [NUMERIC]({{< baseurl >}}/develop/interact/search-and-query/indexing/#index-json-arrays-as-numeric), [GEO]({{< baseurl >}}/develop/interact/search-and-query/indexing/#index-json-arrays-as-geo) and [VECTOR]({{< baseurl >}}/develop/interact/search-and-query/indexing/#index-json-arrays-as-vector)) defined by a [JSONPath]({{< relref "/develop/data-types/json/path" >}}) leading to an array or multiple scalar values. Support for [GEOSHAPE]({{< relref "/develop/interact/search-and-query/query/geo-spatial" >}}) queries was also introduced in this dialect. @@ -190,7 +193,7 @@ Now search, with and without `DIALECT 3`. DIALECT 3 is required for shape-based (`POINT` or `POLYGON`) geospatial queries. {{% /alert %}} -## `DIALECT 4` +## `DIALECT 4` (Deprecated) Dialect version 4 was introduced in the [2.8](https://github.com/RediSearch/RediSearch/releases/tag/v2.8.4) release. It introduces performance optimizations for sorting operations on [`FT.SEARCH`]({{< baseurl >}}/commands/ft.search/) and [`FT.AGGREGATE`]({{< baseurl >}}/commands/ft.aggregate/). Apart from specifying `DIALECT 4` at the end of a [`FT.SEARCH`]({{< baseurl >}}/commands/ft.search/) command, there are no other syntactic changes. Dialect version 1 remains the default dialect. To use dialect version 4, append `DIALECT 4` to your query command.