Skip to content

Commit

Permalink
[DOCS] Add filter example to nested agg docs (#76118) (#76178)
Browse files Browse the repository at this point in the history
Changes:
* Simplifies and formats several snippets in the nested agg docs
* Adds a `filter` sub-aggregration example
# Conflicts:
#	docs/reference/aggregations/bucket/nested-aggregation.asciidoc
  • Loading branch information
jrodewig authored Aug 5, 2021
1 parent 926eae1 commit df22082
Showing 1 changed file with 95 additions and 19 deletions.
114 changes: 95 additions & 19 deletions docs/reference/aggregations/bucket/nested-aggregation.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,34 @@ A special single bucket aggregation that enables aggregating nested documents.
For example, lets say we have an index of products, and each product holds the list of resellers - each having its own
price for the product. The mapping could look like:

[source,console]
--------------------------------------------------
[source,console,id=nested-aggregation-example]
----
PUT /products
{
"mappings": {
"properties": {
"resellers": { <1>
"type": "nested",
"properties": {
"reseller": { "type": "text" },
"price": { "type": "double" }
"reseller": {
"type": "keyword"
},
"price": {
"type": "double"
}
}
}
}
}
}
--------------------------------------------------
----
<1> `resellers` is an array that holds nested documents.

The following request adds a product with two resellers:

[source,console]
--------------------------------------------------
PUT /products/_doc/0
----
PUT /products/_doc/0?refresh
{
"name": "LED TV", <1>
"resellers": [
Expand All @@ -46,34 +50,40 @@ PUT /products/_doc/0
}
]
}
--------------------------------------------------
// TEST[s/PUT \/products\/_doc\/0/PUT \/products\/_doc\/0\?refresh/]
----
// TEST[continued]

<1> We are using a dynamic mapping for the `name` attribute.


The following request returns the minimum price a product can be purchased for:

[source,console]
--------------------------------------------------
GET /products/_search
----
GET /products/_search?size=0
{
"query": {
"match": { "name": "led tv" }
"match": {
"name": "led tv"
}
},
"aggs": {
"resellers": {
"nested": {
"path": "resellers"
},
"aggs": {
"min_price": { "min": { "field": "resellers.price" } }
"min_price": {
"min": {
"field": "resellers.price"
}
}
}
}
}
}
--------------------------------------------------
// TEST[s/GET \/products\/_search/GET \/products\/_search\?filter_path=aggregations/]
----
// TEST[s/size=0/size=0&filter_path=aggregations/]
// TEST[continued]

As you can see above, the nested aggregation requires the `path` of the nested documents within the top level documents.
Expand All @@ -82,18 +92,84 @@ Then one can define any type of aggregation over these nested documents.
Response:

[source,console-result]
--------------------------------------------------
----
{
...
"aggregations": {
"resellers": {
"doc_count": 2,
"min_price": {
"value": 350
"value": 350.0
}
}
}
}
----
// TESTRESPONSE[s/\.\.\.//]

You can use a <<search-aggregations-bucket-filter-aggregation,`filter`>>
sub-aggregation to return results for a specific reseller.

[source,console]
----
GET /products/_search?size=0
{
"query": {
"match": {
"name": "led tv"
}
},
"aggs": {
"resellers": {
"nested": {
"path": "resellers"
},
"aggs": {
"filter_reseller": {
"filter": {
"bool": {
"filter": [
{
"term": {
"resellers.reseller": "companyB"
}
}
]
}
},
"aggs": {
"min_price": {
"min": {
"field": "resellers.price"
}
}
}
}
}
}
}
}
----
// TEST[s/size=0/size=0&filter_path=aggregations/]
// TEST[continued]

The search returns:

[source,console-result]
----
{
...
"aggregations": {
"resellers": {
"doc_count": 2,
"filter_reseller": {
"doc_count": 1,
"min_price": {
"value": 500.0
}
}
}
}
}
--------------------------------------------------
----
// TESTRESPONSE[s/\.\.\.//]
// TESTRESPONSE[s/: [0-9]+/: $body.$_path/]

0 comments on commit df22082

Please sign in to comment.