Skip to content

Commit b20b4f9

Browse files
authored
DOC-4513 add INDEX_CURSOR_LIMIT (#855)
1 parent 218d52a commit b20b4f9

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

content/develop/interact/search-and-query/basic-constructs/configuration-parameters.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ The following table summarizes which configuration parameters can be set at modu
9090
| [OSS_GLOBAL_PASSWORD](#oss_global_password) | :white_check_mark: | :white_large_square: |
9191
| [DEFAULT_DIALECT](#default_dialect) | :white_check_mark: | :white_check_mark: |
9292
| [VSS_MAX_RESIZE](#vss_max_resize) | :white_check_mark: | :white_check_mark: |
93+
| [INDEX_CURSOR_LIMIT](#index_cursor_limit) | :white_check_mark: | :white_check_mark: |
9394

9495
---
9596

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

581582
{{% /alert %}}
583+
### INDEX_CURSOR_LIMIT
584+
585+
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.
586+
587+
{{% alert title="Notes" color="info" %}}
588+
589+
* Caution should be used in modifying this parameter. Every open cursor results in additional memory usage.
590+
* 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`
591+
* See [Cursor API]({{< baseurl >}}/develop/interact/search-and-query/advanced-concepts/aggregations#cursor-api) for more details.
592+
593+
* Added in 2.10.8
594+
{{% /alert %}}
595+
596+
#### Default
597+
598+
128
599+
600+
#### Example
601+
602+
```
603+
$ redis-server --loadmodule ./redisearch.so INDEX_CURSOR_LIMIT 180
604+
```

0 commit comments

Comments
 (0)