2013-08-28 19:24:34 -04:00
|
|
|
[[query-dsl-nested-query]]
|
2019-07-18 10:18:11 -04:00
|
|
|
=== Nested query
|
|
|
|
++++
|
|
|
|
<titleabbrev>Nested</titleabbrev>
|
|
|
|
++++
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2019-07-10 08:50:54 -04:00
|
|
|
Wraps another query to search <<nested,nested>> fields.
|
|
|
|
|
|
|
|
The `nested` query searches nested field objects as if they were indexed as
|
|
|
|
separate documents. If an object matches the search, the `nested` query returns
|
|
|
|
the root parent document.
|
|
|
|
|
|
|
|
[[nested-query-ex-request]]
|
|
|
|
==== Example request
|
|
|
|
|
|
|
|
[[nested-query-index-setup]]
|
|
|
|
===== Index setup
|
|
|
|
|
|
|
|
To use the `nested` query, your index must include a <<nested,nested>> field
|
|
|
|
mapping. For example:
|
2013-08-28 19:24:34 -04:00
|
|
|
|
|
|
|
[source,js]
|
2019-07-10 08:50:54 -04:00
|
|
|
----
|
2019-01-22 09:13:52 -05:00
|
|
|
PUT /my_index
|
2013-08-28 19:24:34 -04:00
|
|
|
{
|
2016-05-24 05:58:43 -04:00
|
|
|
"mappings": {
|
2019-01-22 09:13:52 -05:00
|
|
|
"properties" : {
|
|
|
|
"obj1" : {
|
|
|
|
"type" : "nested"
|
2013-08-28 19:24:34 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2016-05-24 12:15:52 -04:00
|
|
|
|
2019-07-10 08:50:54 -04:00
|
|
|
----
|
2016-05-24 05:58:43 -04:00
|
|
|
// CONSOLE
|
|
|
|
// TESTSETUP
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2019-07-10 08:50:54 -04:00
|
|
|
[[nested-query-ex-query]]
|
|
|
|
===== Example query
|
2013-08-28 19:24:34 -04:00
|
|
|
|
|
|
|
[source,js]
|
2019-07-10 08:50:54 -04:00
|
|
|
----
|
|
|
|
GET /my_index/_search
|
2013-08-28 19:24:34 -04:00
|
|
|
{
|
2016-05-24 05:58:43 -04:00
|
|
|
"query": {
|
|
|
|
"nested" : {
|
|
|
|
"path" : "obj1",
|
|
|
|
"query" : {
|
|
|
|
"bool" : {
|
|
|
|
"must" : [
|
|
|
|
{ "match" : {"obj1.name" : "blue"} },
|
|
|
|
{ "range" : {"obj1.count" : {"gt" : 5}} }
|
|
|
|
]
|
|
|
|
}
|
2019-07-10 08:50:54 -04:00
|
|
|
},
|
|
|
|
"score_mode" : "avg"
|
2013-08-28 19:24:34 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2019-07-10 08:50:54 -04:00
|
|
|
----
|
2016-05-24 05:58:43 -04:00
|
|
|
// CONSOLE
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2019-07-10 08:50:54 -04:00
|
|
|
[[nested-top-level-params]]
|
|
|
|
==== Top-level parameters for `nested`
|
|
|
|
|
2019-07-31 14:18:22 -04:00
|
|
|
`path`::
|
|
|
|
(Required, string) Path to the nested object you wish to search.
|
2019-07-10 08:50:54 -04:00
|
|
|
|
2019-07-31 14:18:22 -04:00
|
|
|
`query`::
|
2019-07-10 08:50:54 -04:00
|
|
|
+
|
|
|
|
--
|
2019-07-31 14:18:22 -04:00
|
|
|
(Required, query object) Query you wish to run on nested objects in the `path`.
|
|
|
|
If an object matches the search, the `nested` query returns the root parent
|
|
|
|
document.
|
2019-07-10 08:50:54 -04:00
|
|
|
|
|
|
|
You can search nested fields using dot notation that includes the complete path,
|
|
|
|
such as `obj1.name`.
|
|
|
|
|
|
|
|
Multi-level nesting is automatically supported, and detected, resulting in an
|
|
|
|
inner nested query to automatically match the relevant nesting level, rather
|
|
|
|
than root, if it exists within another nested query.
|
|
|
|
--
|
|
|
|
|
2019-07-31 14:18:22 -04:00
|
|
|
`score_mode`::
|
2019-07-10 08:50:54 -04:00
|
|
|
+
|
|
|
|
--
|
2019-07-31 14:18:22 -04:00
|
|
|
(Optional, string) Indicates how scores for matching child objects affect the
|
2019-08-02 14:15:12 -04:00
|
|
|
root parent document's <<relevance-scores,relevance score>>. Valid values
|
2019-07-31 14:18:22 -04:00
|
|
|
are:
|
2019-07-10 08:50:54 -04:00
|
|
|
|
|
|
|
`avg` (Default)::
|
|
|
|
Use the mean relevance score of all matching child objects.
|
|
|
|
|
|
|
|
`max`::
|
|
|
|
Uses the highest relevance score of all matching child objects.
|
|
|
|
|
|
|
|
`min`::
|
|
|
|
Uses the lowest relevance score of all matching child objects.
|
|
|
|
|
|
|
|
`none`::
|
|
|
|
Do not use the relevance scores of matching child objects. The query assigns
|
|
|
|
parent documents a score of `0`.
|
|
|
|
|
|
|
|
`sum`::
|
|
|
|
Add together the relevance scores of all matching child objects.
|
|
|
|
--
|
|
|
|
|
2019-07-31 14:18:22 -04:00
|
|
|
`ignore_unmapped`::
|
2019-07-10 08:50:54 -04:00
|
|
|
+
|
|
|
|
--
|
2019-07-31 14:18:22 -04:00
|
|
|
(Optional, boolean) Indicates whether to ignore an unmapped `path` and not
|
|
|
|
return any documents instead of an error. Defaults to `false`.
|
2019-07-10 08:50:54 -04:00
|
|
|
|
2019-07-10 10:07:49 -04:00
|
|
|
If `false`, {es} returns an error if the `path` is an unmapped field.
|
2019-07-10 08:50:54 -04:00
|
|
|
|
|
|
|
You can use this parameter to query multiple indices that may not contain the
|
|
|
|
field `path`.
|
|
|
|
--
|