@@ -161,86 +161,62 @@ shards. This is usually slower but more accurate.
161
161
Specifies whether aggregation and suggester names should be prefixed by their
162
162
respective types in the response.
163
163
164
+ [role="child_attributes"]
164
165
[[search-multi-search-api-request-body]]
165
166
==== {api-request-body-title}
166
167
167
168
The request body contains a newline-delimited list of search `<header>` and
168
169
search `<body>` objects.
169
170
170
171
`<header>`::
171
- +
172
- --
173
172
(Required, object)
174
173
Contains parameters used to limit or change the subsequent search body request.
175
-
174
+ +
176
175
This object is required for each search body but can be empty (`{}`) or a blank
177
176
line.
178
- --
179
-
180
- `allow_no_indices`:::
177
+ +
178
+ .Properties of `<header>` objects
179
+ [%collapsible%open]
180
+ ====
181
+ `allow_no_indices`::
181
182
(Optional, Boolean)
182
183
If `true`, the request does *not* return an error if a wildcard expression or
183
184
`_all` value retrieves only missing or closed indices.
184
185
+
185
186
This parameter also applies to <<indices-aliases,index aliases>> that point to a
186
187
missing or closed index.
187
188
188
- `expand_wildcards`:::
189
- +
190
- --
191
- (Optional, string)
192
- Type of index that wildcard expressions can match. If the request can target
193
- data streams, this argument determines whether wildcard expressions match
194
- hidden data streams. Supports comma-separated values, such as `open,hidden`.
195
- Valid values are:
196
-
197
- `all`::
198
- Match any data stream or index, including <<hidden-indices,hidden>> ones.
199
-
200
- `open`::
201
- Match open, non-hidden indices. Also matches any non-hidden data stream.
202
-
203
- `closed`::
204
- Match closed, non-hidden indices. Also matches any non-hidden data stream. Data
205
- streams cannot be closed.
206
-
207
- `hidden`::
208
- Match hidden data streams and hidden indices. Must be combined with `open`,
209
- `closed`, or both.
210
-
211
- `none`::
212
- Wildcard expressions are not accepted.
213
- --
189
+ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
214
190
+
215
191
Defaults to `open`.
216
192
217
- `ignore_unavailable`:::
193
+ `ignore_unavailable`::
218
194
(Optional, Boolean) If `true`, documents from missing or closed indices are not
219
195
included in the response. Defaults to `false`.
220
196
221
- `index`:::
197
+ `index`::
222
198
(Optional, string or array of strings)
223
199
Data streams, indices, and index aliases to search. Wildcard (`*`) expressions
224
200
are supported. You can specify multiple targets as an array.
225
201
+
226
202
If this parameter is not specified, the `<target>` request path parameter
227
203
is used as a fallback.
228
204
229
- `preference`:::
205
+ `preference`::
230
206
(Optional, string)
231
207
Node or shard used to perform the search. Random by default.
232
208
233
- `request_cache`:::
209
+ `request_cache`::
234
210
(Optional, Boolean)
235
211
If `true`, the request cache can be used for this search. Defaults to
236
212
index-level settings. See <<shard-request-cache>>.
237
213
238
- `routing`:::
214
+ `routing`::
239
215
(Optional, string)
240
216
Custom <<mapping-routing-field,routing value>> used to route search operations
241
217
to a specific shard.
242
218
243
- `search_type`:::
219
+ `search_type`::
244
220
+
245
221
--
246
222
(Optional, string)
@@ -249,35 +225,40 @@ scoring returned documents.
249
225
250
226
Options are:
251
227
252
- `query_then_fetch`::
228
+ `query_then_fetch`:::
253
229
(default)
254
230
Documents are scored using local term and document frequencies for the shard.
255
231
This is usually faster but less accurate.
256
232
257
- `dfs_query_then_fetch`::
233
+ `dfs_query_then_fetch`:::
258
234
Documents are scored using global term and document frequencies across all
259
235
shards. This is usually slower but more accurate.
260
236
--
237
+ ====
261
238
262
239
`<body>`::
263
240
(Optional, object)
264
241
Contains parameters for a search request:
265
-
266
- `aggregations`:::
242
+ +
243
+ .Properties of `<body>` objects
244
+ [%collapsible%open]
245
+ ====
246
+ `aggregations`::
267
247
(Optional, <<search-aggregations,aggregation object>>)
268
248
Aggregations you wish to run during the search. See <<search-aggregations>>.
269
249
270
- `query`:::
250
+ `query`::
271
251
(Optional, <<query-dsl,query DSL object>>) Query you wish to run during the
272
252
search. Hits matching this query are returned in the response.
273
253
274
- `from`:::
254
+ `from`::
275
255
(Optional, integer)
276
256
Starting offset for returned hits. Defaults to `0`.
277
257
278
- `size`:::
258
+ `size`::
279
259
(Optional, integer)
280
260
Number of hits to return. Defaults to `10`.
261
+ ====
281
262
282
263
[[search-multi-search-api-response-body]]
283
264
==== {api-response-body-title}
0 commit comments