Skip to content

Commit e7cac41

Browse files
authored
Document 'search-on-oom' configuration parameter
Added documentation for the 'search-on-oom' configuration parameter, including its valid values and default setting.
1 parent a0195b5 commit e7cac41

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

content/develop/ai/search-and-query/administration/configuration.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -541,6 +541,24 @@ Valid range: `[0 .. 8192]`
541541

542542
Default: `0`
543543

544+
### search-on-oom
545+
546+
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.
547+
548+
* `IGNORE`: Execute the query regardless of current memory usage.
549+
* `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.
550+
* `FAIL`: Will return an error if memory usage exceeds memory limit.
551+
552+
Type: string
553+
554+
Valid values: `IGNORE`, `RETURN`, `FAIL`
555+
556+
Default: `IGNORE`
557+
558+
{{% alert title="Notes" color="info" %}}
559+
To prevent potential out-of-memory conditions, it is recommended to set this parameter to FAIL or RETURN rather than IGNORE.
560+
{{% /alert %}}
561+
544562
## Set configuration parameters at module load-time (deprecated)
545563

546564
These methods are deprecated beginning with Redis 8.
@@ -584,4 +602,4 @@ FT.CONFIG GET OPT1
584602
FT.CONFIG GET *
585603
```
586604

587-
Values set using [`FT.CONFIG SET`]({{< relref "/commands/ft.config-set/" >}}) are not persisted after server restart.
605+
Values set using [`FT.CONFIG SET`]({{< relref "/commands/ft.config-set/" >}}) are not persisted after server restart.

0 commit comments

Comments
 (0)