1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
# Run-time configuration
RediSearch supports a few run-time configuration options that should be determined when loading the module. In time more options will be added.
!!! tip "Passing Configuration Options"
In general, passing configuration options is done by appending arguments after the `--loadmodule` argument in the command line, `loadmodule` configuration directive in a Redis config file, or the `MODULE LOAD` command. For example:
In redis.conf:
```
loadmodule redisearch.so OPT1 OPT2
```
From redis-cli:
```
127.0.0.6379> MODULE load redisearch.so OPT1 OPT2
```
From command line:
```
$ redis-server --loadmodule ./redisearch.so OPT1 OPT2
```
# RediSearch configuration options
## TIMEOUT
The maximum amount of time **in milliseconds** that a search query is allowed to run. If this time is exceeded we return the top results accumulated so far, or an error depending on the policy set with `ON_TIMEOUT`. The timeout can be disabled by setting it to 0.
!!! note
This works only in concurrent mode, so enabling `SAFEMODE` disables this option.
### Default
500
### Example
```
$ redis-server --loadmodule ./redisearch.so TIMEOUT 100
```
---
## ON_TIMEOUT {policy}
The response policy for queries that exceed the `TIMEOUT` setting.
The policy can be one of the following:
* **RETURN**: this policy will return the top results accumulated by the query until it timed out.
* **FAIL**: will return an error when the query exeeds the timeout value.
### Default
RETURN
### Example
```
$ redis-server --loadmodule ./redisearch.so ON_TIMEOUT fail
```
---
## SAFEMODE
If present in the argument list, RediSearch will turn off concurrency for query processing, and work in a single thread.
This is useful if data consistency is extremely important, and avoids a situation where deletion of documents while querying them can cause momentarily inconsistent results (i.e. documents that were valid during the invocation of the query are not returned because they were deleted during query processing).
### Default
Off (not present)
### Example
```
$ redis-server --loadmodule ./redisearch.so SAFEMODE
```
---
## EXTLOAD {file_name}
If present, we try to load a RediSearch extension dynamic library from the specified file path. See [Extensions](/Extensions) for details.
### Default
None
### Example
```
$ redis-server --loadmodule ./redisearch.so EXTLOAD ./ext/my_extension.so
```
---
## NOGC
If set, we turn off Garbage Collection for all indexes. This is used mainly for debugging and testing, and should not be set by users.
### Default
Not set
### Example
```
$ redis-server --loadmodule ./redisearch.so NOGC
```
---
## MINPREFIX
The minimum number of characters we allow for prefix queries (e.g. `hel*`). Setting it to 1 can hurt performance.
### Default
2
### Example
```
$ redis-server --loadmodule ./redisearch.so MINPREFIX 3
```
---
## MAXEXPANSIONS
The maximum number of expansions we allow for query prefixes. Setting it too high can cause performance issues.
### Default
200
### Example
```
$ redis-server --loadmodule ./redisearch.so MAXEXPANSIONS 1000
```
---
## MAXDOCTABLESIZE
The maximum size of the internal hash table used for storing the documents.
### Default
1000000
### Example
```
$ redis-server --loadmodule ./redisearch.so MAXDOCTABLESIZE 3000000
```
---
## FRISOINI {file_name}
If present, we load the custom Chinese dictionary from the specified path. See [Using custom dictionaries](/Chinese#using_custom_dictionaries) for more details.
### Default
Not set
### Example
```
$ redis-server --loadmodule ./redisearch.so FRISOINI /opt/dict/friso.ini
```
## GC_SCANSIZE
The garbage collection bulk size of the internal gc used for cleaning up the indexes.
### Default
100
### Example
```
$ redis-server --loadmodule ./redisearch.so GC_SCANSIZE 10
```
|
