You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/QueryString.java
+14-8Lines changed: 14 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -138,25 +138,27 @@ public QueryString(
138
138
name = "allow_leading_wildcard",
139
139
type = "boolean",
140
140
valueHint = { "true", "false" },
141
-
description = "If true, the wildcard characters * and ? are allowed as the first character of the query string."
141
+
description = "If true, the wildcard characters * and ? are allowed as the first character of the query string. "
142
+
+ "Defaults to true."
142
143
),
143
144
@MapParam.MapParamEntry(
144
145
name = "allow_wildcard",
145
146
type = "boolean",
146
147
valueHint = { "false", "true" },
147
-
description = "If true, the query attempts to analyze wildcard terms in the query string."
148
+
description = "If true, the query attempts to analyze wildcard terms in the query string. Defaults to false. "
148
149
),
149
150
@MapParam.MapParamEntry(
150
151
name = "analyzer",
151
152
type = "keyword",
152
153
valueHint = { "standard" },
153
-
description = "Analyzer used to convert the text in the query value into token."
154
+
description = "Analyzer used to convert the text in the query value into token. "
155
+
+ "Defaults to the index-time analyzer mapped for the default_field."
154
156
),
155
157
@MapParam.MapParamEntry(
156
158
name = "auto_generate_synonyms_phrase_query",
157
159
type = "boolean",
158
160
valueHint = { "true", "false" },
159
-
description = "If true, match phrase queries are automatically created for multi-term synonyms."
161
+
description = "If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true."
160
162
),
161
163
@MapParam.MapParamEntry(
162
164
name = "fuzziness",
@@ -204,13 +206,15 @@ public QueryString(
204
206
name = "fuzzy_transpositions",
205
207
type = "boolean",
206
208
valueHint = { "true", "false" },
207
-
description = "If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba)."
209
+
description = "If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). "
210
+
+ "Defaults to true."
208
211
),
209
212
@MapParam.MapParamEntry(
210
213
name = "lenient",
211
214
type = "boolean",
212
215
valueHint = { "true", "false" },
213
-
description = "If false, format-based errors, such as providing a text query value for a numeric field, are returned."
216
+
description = "If false, format-based errors, such as providing a text query value for a numeric field, are returned. "
217
+
+ "Defaults to false."
214
218
),
215
219
@MapParam.MapParamEntry(
216
220
name = "max_determinized_states",
@@ -228,13 +232,15 @@ public QueryString(
228
232
name = "quote_analyzer",
229
233
type = "keyword",
230
234
valueHint = { "standard" },
231
-
description = "Analyzer used to convert quoted text in the query string into tokens."
235
+
description = "Analyzer used to convert quoted text in the query string into tokens. "
236
+
+ "Defaults to the search_quote_analyzer mapped for the default_field."
232
237
),
233
238
@MapParam.MapParamEntry(
234
239
name = "phrase_slop",
235
240
type = "integer",
236
241
valueHint = { "0" },
237
-
description = "Maximum number of positions allowed between matching tokens for phrases."
242
+
description = "Maximum number of positions allowed between matching tokens for phrases. "
243
+
+ "Defaults to 0 (which means exact matches are required)."
0 commit comments