Skip to content

Document 'search-on-oom' configuration parameter #2301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 27, 2025
Merged

Document 'search-on-oom' configuration parameter #2301

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7cac41
Document 'search-on-oom' configuration parameter
lerman25 Oct 26, 2025
3b1935d
Apply suggestions from code review
dwdougherty Oct 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion content/develop/ai/search-and-query/administration/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Values set using [`FT.CONFIG SET`]({{< relref "/commands/ft.config-set/" >}}) are not persisted after server restart.