Skip to content

DOC-4513 add INDEX_CURSOR_LIMIT #855

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 1 commit into from
Nov 7, 2024
Merged

DOC-4513 add INDEX_CURSOR_LIMIT #855

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions .../develop/interact/search-and-query/basic-constructs/configuration-parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ The following table summarizes which configuration parameters can be set at modu
| [OSS_GLOBAL_PASSWORD](#oss_global_password) | :white_check_mark: | :white_large_square: |
| [DEFAULT_DIALECT](#default_dialect) | :white_check_mark: | :white_check_mark: |
| [VSS_MAX_RESIZE](#vss_max_resize) | :white_check_mark: | :white_check_mark: |
| [INDEX_CURSOR_LIMIT](#index_cursor_limit) | :white_check_mark: | :white_check_mark: |

---

Expand Down Expand Up @@ -579,3 +580,25 @@ $ redis-server --loadmodule ./redisearch.so VSS_MAX_RESIZE 52428800 # 50MB
* Added in v2.4.8

{{% /alert %}}
### INDEX_CURSOR_LIMIT

The maximum number of cursors that can be opened, per shard, at any given time. Cursors can be opened by the user via [`FT.AGGREGATE WITHCURSOR`]({{< baseurl >}}/commands/ft.aggregate/). Cursors are also opened internally by the Redis Query Engine for long-running queries. Once `INDEX_CURSOR_LIMIT` is reached, any further attempts at opening a cursor will result in an error.

{{% alert title="Notes" color="info" %}}

* Caution should be used in modifying this parameter. Every open cursor results in additional memory usage.
* Cursor usage should be regulated first by use of [`FT.CURSOR DEL`]({{< baseurl >}}/commands/ft.cursor-del/) and/or [`MAXIDLE`]({{< baseurl >}}/commands/ft.aggregate/) prior to modifying `INDEX_CURSOR_LIMIT`
* See [Cursor API]({{< baseurl >}}/develop/interact/search-and-query/advanced-concepts/aggregations#cursor-api) for more details.

* Added in 2.10.8
{{% /alert %}}

#### Default

128

#### Example

```
$ redis-server --loadmodule ./redisearch.so INDEX_CURSOR_LIMIT 180
```
Loading