Skip to content

Commit 63505c7

Browse files
committed
Add more configurations
Signed-off-by: Arad Zilberstein <[email protected]>
1 parent 95b7425 commit 63505c7

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

topics/search.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,21 @@ The following list of configurations can be passed to the `loadmodule` command:
181181
sizes may improve performance by enhancing CPU cache efficiency, but come at the cost of increased memory usage due
182182
to pre-allocation for potential future growth. (Default: 10K)
183183
5. `--log-level` Controls the log verbosity level. Possible values are: `debug`, `verbose`, `notice` and `warning`. (Default: Valkey's log level)
184+
6. `--query-string-bytes`: (Optional) Controls the maximum length in bytes of the query string for FT.SEARCH commands. (Default: 10240)
185+
7. `--query-string-depth`: (Optional) Controls the maximum depth of query string parsing for FT.SEARCH commands. (Default: 1000)
186+
8. `--query-string-terms-count`: (Optional) Controls the maximum number of terms allowed in a query string. (Default: 16)
187+
9. `--max-indexes`: (Optional) Controls the maximum number of search indexes that can be created. (Default: 10)
188+
10. `--max-prefixes`: (Optional) Controls the maximum number of key prefixes per index during FT.CREATE. (Default: 8)
189+
11. `--max-tag-field-length`: (Optional) Controls the maximum length of tag field identifiers during index creation. (Default: 256)
190+
12. `--max-numeric-field-length`: (Optional) Controls the maximum length of numeric field identifiers during index creation. (Default: 128)
191+
13. `--max-vector-attributes`: (Optional) Controls the maximum number of attributes per index. (Default: 50)
192+
14. `--max-vector-dimensions`: (Optional) Controls the maximum number of dimensions for vector indexes. (Default: 32768)
193+
15. `--max-vector-m`: (Optional) Controls the maximum M parameter for HNSW algorithm. (Default: 2000000)
194+
16. `--max-vector-ef-construction`: (Optional) Controls the maximum EF_CONSTRUCTION parameter for HNSW algorithm. (Default: 4096)
195+
17. `--max-vector-ef-runtime`: (Optional) Controls the maximum EF_RUNTIME parameter for HNSW algorithm. (Default: 4096)
196+
18. `--max-vector-knn`: (Optional) Controls the maximum K value for K-nearest neighbor searches. (Default: 128)
197+
19. `--max-search-result-record-size`: (Optional) Controls the maximum size in bytes for search result records. (Default: 5242880)
198+
20. `--max-search-result-fields-count`: (Optional) Controls the maximum number of fields in search result records. (Default: 500)
184199

185200
### Runtime configuration
186201

@@ -190,4 +205,46 @@ The following list of configurations can be modified at runtime using the `CONFI
190205
sizes may improve performance by enhancing CPU cache efficiency, but come at the cost of increased memory usage due
191206
to pre-allocation for potential future growth. (Default: 10K)
192207

208+
2. `search.query-string-bytes`: Controls the maximum length in bytes of the query string for FT.SEARCH commands.
193209

210+
3. `search.query-string-depth`: Controls the maximum depth of query string parsing for FT.SEARCH commands, preventing
211+
overly complex nested queries. (Default: 1000, Min: 1, Max: UINT_MAX)
212+
213+
4. `search.query-string-terms-count`: Controls the maximum number of terms (nodes in the predicate tree) allowed in a
214+
query string for FT.SEARCH commands. (Default: 16, Min: 1, Max: 32)
215+
216+
5. `search.max-indexes`: Controls the maximum number of search indexes that can be created.
217+
(Default: 10, Min: 1, Max: 10)
218+
219+
6. `search.max-prefixes`: Controls the maximum number of key prefixes that can be specified per index during FT.CREATE.
220+
(Default: 8, Min: 1, Max: 16)
221+
222+
7. `search.max-tag-field-length`: Controls the maximum length of tag field identifiers during index creation.
223+
(Default: 256, Min: 1, Max: 10000)
224+
225+
8. `search.max-numeric-field-length`: Controls the maximum length of numeric field identifiers during index creation.
226+
(Default: 128, Min: 1, Max: 256)
227+
228+
9. `search.max-vector-attributes`: Controls the maximum number of attributes that can be defined per index.
229+
(Default: 50, Min: 1, Max: 100)
230+
231+
10. `search.max-vector-dimensions`: Controls the maximum number of dimensions allowed for vector indexes.
232+
(Default: 32768, Min: 1, Max: 64000)
233+
234+
11. `search.max-vector-m`: Controls the maximum M parameter for HNSW algorithm, which affects the connectivity of the graph.
235+
Higher values improve recall but increase memory usage. (Default: 2000000, Min: 1, Max: 2000000)
236+
237+
12. `search.max-vector-ef-construction`: Controls the maximum EF_CONSTRUCTION parameter for HNSW algorithm during index
238+
building. Higher values improve index quality but slow down construction. (Default: 4096, Min: 1, Max: 4096)
239+
240+
13. `search.max-vector-ef-runtime`: Controls the maximum EF_RUNTIME parameter for HNSW algorithm during search. Higher
241+
values improve recall but slow down search. (Default: 4096, Min: 1, Max: 4096)
242+
243+
14. `search.max-vector-knn`: Controls the maximum K value for K-nearest neighbor searches.
244+
(Default: 128, Min: 1, Max: 1000)
245+
246+
15. `search.max-search-result-record-size`: Controls the maximum size in bytes for individual search result records.
247+
Records exceeding this limit will be dropped from results. (Default: 5MB, Min: 100, Max: 10MB)
248+
249+
16. `search.max-search-result-fields-count`: Controls the maximum number of fields allowed in individual search result records.
250+
Records exceeding this limit will be dropped from results. (Default: 500, Min: 1, Max: 1000)

0 commit comments

Comments
 (0)