From e7cac41ae3a4893deff27cc9f210a1f3dcb3040a Mon Sep 17 00:00:00 2001 From: lerman25 <58445352+lerman25@users.noreply.github.com> Date: Sun, 26 Oct 2025 14:22:01 +0200 Subject: [PATCH 1/2] Document 'search-on-oom' configuration parameter Added documentation for the 'search-on-oom' configuration parameter, including its valid values and default setting. --- .../administration/configuration.md | 20 ++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/content/develop/ai/search-and-query/administration/configuration.md b/content/develop/ai/search-and-query/administration/configuration.md index 21a650f117..acac3c42bf 100644 --- a/content/develop/ai/search-and-query/administration/configuration.md +++ b/content/develop/ai/search-and-query/administration/configuration.md @@ -541,6 +541,24 @@ Valid range: `[0 .. 8192]` Default: `0` +### search-on-oom + +Specifies the response policy for queries when the server's current memory usage exceeds the configured [maxmemory](https://redis.io/docs/latest/develop/reference/eviction/#maxmem) limit. + +* `IGNORE`: Execute the query regardless of current memory usage. +* `RETURN`: In cluster mode, the query returns partial results from shards that did not exceed the memory limit. Shards that exceed the limit will not contribute results. +* `FAIL`: Will return an error if memory usage exceeds memory limit. + +Type: string + +Valid values: `IGNORE`, `RETURN`, `FAIL` + +Default: `IGNORE` + +{{% alert title="Notes" color="info" %}} +To prevent potential out-of-memory conditions, it is recommended to set this parameter to FAIL or RETURN rather than IGNORE. +{{% /alert %}} + ## Set configuration parameters at module load-time (deprecated) These methods are deprecated beginning with Redis 8. @@ -584,4 +602,4 @@ FT.CONFIG GET OPT1 FT.CONFIG GET * ``` -Values set using [`FT.CONFIG SET`]({{< relref "/commands/ft.config-set/" >}}) are not persisted after server restart. \ No newline at end of file +Values set using [`FT.CONFIG SET`]({{< relref "/commands/ft.config-set/" >}}) are not persisted after server restart. From 3b1935dd3fbafadc3fd1b88fa6fed4fa78b69867 Mon Sep 17 00:00:00 2001 From: David Dougherty Date: Mon, 27 Oct 2025 06:21:32 -0700 Subject: [PATCH 2/2] Apply suggestions from code review --- .../ai/search-and-query/administration/configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/develop/ai/search-and-query/administration/configuration.md b/content/develop/ai/search-and-query/administration/configuration.md index acac3c42bf..35a6c8d873 100644 --- a/content/develop/ai/search-and-query/administration/configuration.md +++ b/content/develop/ai/search-and-query/administration/configuration.md @@ -547,7 +547,7 @@ Specifies the response policy for queries when the server's current memory usage * `IGNORE`: Execute the query regardless of current memory usage. * `RETURN`: In cluster mode, the query returns partial results from shards that did not exceed the memory limit. Shards that exceed the limit will not contribute results. -* `FAIL`: Will return an error if memory usage exceeds memory limit. +* `FAIL`: Will return an error if memory usage exceeds the memory limit. Type: string @@ -556,7 +556,7 @@ Valid values: `IGNORE`, `RETURN`, `FAIL` Default: `IGNORE` {{% alert title="Notes" color="info" %}} -To prevent potential out-of-memory conditions, it is recommended to set this parameter to FAIL or RETURN rather than IGNORE. +To prevent potential out-of-memory conditions, it is recommended that you set this parameter to FAIL or RETURN rather than IGNORE. {{% /alert %}} ## Set configuration parameters at module load-time (deprecated)