Skip to content
Snippets Groups Projects
Commit a4c9b297 authored by Aivaras Gotovskis's avatar Aivaras Gotovskis
Browse files

Add filters aggregation doc.

parent 6950d2dc
No related branches found
No related tags found
No related merge requests found
# Filters Aggregation
> More info about filters aggregation is in the [official elasticsearch docs][1]
Defines a multi bucket aggregations where each bucket is associated with a filter.
Each bucket will collect all documents that match its associated filter.
Filters can have names or be anonymous, this is controlled by setAnonymous method.
By default filters are not anonymous and trying to add filter without name will result
in exception.
## Named example
```JSON
{
"aggregations" : {
"agg_messages" : {
"filters" : {
"filters" : {
"errors" : { "term" : { "body" : "error" }},
"warnings" : { "term" : { "body" : "warning" }}
}
},
"aggregations" : {
"agg_monthly" : {
"histogram" : {
"field" : "timestamp",
"interval" : "1M"
}
}
}
}
}
}
```
And now the query via DSL:
```php
$errorTermFilter = new TermFilter('body', 'error');
$warningTermFilter = new TermFilter('body', 'warning');
$histogramAggregation = new HistogramAggregation('monthly', 'timestamp');
$histogramAggregation->setInterval('1M');
$filterAggregation = new FiltersAggregation(
'grades_stats',
[
'error' => $errorTermFilter,
'warning' => $warningTermFilter,
]
);
$filterAggregation->addAggregation($histogramAggregation);
$search = new Search();
$search->addAggregation($filterAggregation);
$queryArray = $search->toArray();
```
## Anonymous example
```php
$errorTermFilter = new TermFilter('body', 'error');
$warningTermFilter = new TermFilter('body', 'warning');
$histogramAggregation = new HistogramAggregation('monthly', 'timestamp');
$histogramAggregation->setInterval('1M');
$filterAggregation = new FiltersAggregation(
'grades_stats',
[
$errorTermFilter,
$warningTermFilter,
],
true
);
$filterAggregation->addAggregation($histogramAggregation);
$search = new Search();
$search->addAggregation($filterAggregation);
$queryArray = $search->toArray();
```
[1]: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment