Merge pull request #169 from benregn/patch-1

add an example of adding an A object to Search
elastic · Jun 1, 2015 · ab578ce · ab578ce
2 parents edfdbc8 + 914a297
commit ab578ce
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/docs/search_dsl.rst b/docs/search_dsl.rst
@@ -215,6 +215,24 @@ To nest aggregations, you can use the ``.bucket()`` and ``.metric()`` methods:
 To add aggregations to the ``Search`` object, use the ``.aggs`` property, which
 acts as a top-level aggregation:
 
+.. code:: python
+
+    s = Search()
+    a = A('terms', field='category')
+    s.aggs.bucket('category_terms', a)
+    s.to_dict()
+    # {
+    #   'aggs': {
+    #     'category_terms': {
+    #       'terms': {
+    #         'field': 'category'
+    #       }
+    #     }
+    #   }
+    # }
+    
+or
+
 .. code:: python
 
     s = Search()