From 51895ced8d586c26de9f9eb81c8ff2ba2c1e7e02 Mon Sep 17 00:00:00 2001 From: Aivaras Gotovskis <aivaras.gotovskis@ongr.io> Date: Fri, 10 Jul 2015 12:07:40 +0300 Subject: [PATCH] Add terms aggregation doc. --- docs/Aggregation/Terms.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 docs/Aggregation/Terms.md diff --git a/docs/Aggregation/Terms.md b/docs/Aggregation/Terms.md new file mode 100644 index 0000000..66a8213 --- /dev/null +++ b/docs/Aggregation/Terms.md @@ -0,0 +1,31 @@ +# Terms Aggregation + +> More info about terms aggregation is in the [official elasticsearch docs][1] + +A multi-bucket value source based aggregation where buckets are dynamically +built - one per unique value. + +## Simple example + +```JSON +{ + "aggregations" : { + "agg_genders" : { + "terms" : { "field" : "gender" } + } + } +} +``` + +And now the query via DSL: + +```php +$termsAggregation = new TermsAggregation('genders', 'gender'); + +$search = new Search(); +$search->addAggregation($termsAggregation); + +$queryArray = $search->toArray(); +``` + +[1]: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html -- GitLab