diff --git a/content/develop/ai/search-and-query/administration/configuration.md b/content/develop/ai/search-and-query/administration/configuration.md index 21a650f117..35a6c8d873 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 the 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 that you 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.