Skip to content
This repository was archived by the owner on Nov 14, 2021. It is now read-only.

Commit aefb073

Browse files
committed
Docs update.
1 parent 3210a09 commit aefb073

2 files changed

Lines changed: 295 additions & 119 deletions

File tree

docs/aggregates.rst

Lines changed: 176 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@ Note that all Aggregate calls can also be passed additional keyword arguments no
66

77

88

9-
Aggregate.geo_bounds
10-
~~~~~~~~~~~~~~~~~~~~
9+
Aggregate.bucket_script
10+
~~~~~~~~~~~~~~~~~~~~~~~
1111

1212
.. code:: python
1313
14-
Aggregate.geo_bounds(name, field)
14+
Aggregate.bucket_script(name, {})
1515
1616
17-
Aggregate.date_histogram
18-
~~~~~~~~~~~~~~~~~~~~~~~~
17+
Aggregate.extended_stats_bucket
18+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1919

2020
.. code:: python
2121
22-
Aggregate.date_histogram(name, field, interval)
22+
Aggregate.extended_stats_bucket(name, buckets_path)
2323
2424
2525
Aggregate.global
@@ -54,14 +54,6 @@ Aggregate.filters
5454
Aggregate.filters(name, [Query])
5555
5656
57-
Aggregate.avg
58-
~~~~~~~~~~~~~
59-
60-
.. code:: python
61-
62-
Aggregate.avg(name, field)
63-
64-
6557
Aggregate.children
6658
~~~~~~~~~~~~~~~~~~
6759

@@ -70,14 +62,6 @@ Aggregate.children
7062
Aggregate.children(name, type)
7163
7264
73-
Aggregate.stats
74-
~~~~~~~~~~~~~~~
75-
76-
.. code:: python
77-
78-
Aggregate.stats(name, field)
79-
80-
8165
Aggregate.scripted_metric
8266
~~~~~~~~~~~~~~~~~~~~~~~~~
8367

@@ -86,20 +70,12 @@ Aggregate.scripted_metric
8670
Aggregate.scripted_metric(name)
8771
8872
89-
Aggregate.min
90-
~~~~~~~~~~~~~
91-
92-
.. code:: python
93-
94-
Aggregate.min(name, field)
95-
96-
97-
Aggregate.sum
98-
~~~~~~~~~~~~~
73+
Aggregate.top_hits
74+
~~~~~~~~~~~~~~~~~~
9975

10076
.. code:: python
10177
102-
Aggregate.sum(name, field)
78+
Aggregate.top_hits(name)
10379
10480
10581
Aggregate.extended_stats
@@ -118,36 +94,44 @@ Aggregate.value_count
11894
Aggregate.value_count(name, field)
11995
12096
121-
Aggregate.percentiles
122-
~~~~~~~~~~~~~~~~~~~~~
97+
Aggregate.date_histogram
98+
~~~~~~~~~~~~~~~~~~~~~~~~
12399

124100
.. code:: python
125101
126-
Aggregate.percentiles(name, field)
102+
Aggregate.date_histogram(name, field, interval)
127103
128104
129-
Aggregate.terms
130-
~~~~~~~~~~~~~~~
105+
Aggregate.sampler
106+
~~~~~~~~~~~~~~~~~
131107

132108
.. code:: python
133109
134-
Aggregate.terms(name, field)
110+
Aggregate.sampler(name, field)
135111
136112
137-
Aggregate.missing
138-
~~~~~~~~~~~~~~~~~
113+
Aggregate.derivative
114+
~~~~~~~~~~~~~~~~~~~~
139115

140116
.. code:: python
141117
142-
Aggregate.missing(name, field)
118+
Aggregate.derivative(name, buckets_path)
143119
144120
145-
Aggregate.max
146-
~~~~~~~~~~~~~
121+
Aggregate.sum_bucket
122+
~~~~~~~~~~~~~~~~~~~~
147123

148124
.. code:: python
149125
150-
Aggregate.max(name, field)
126+
Aggregate.sum_bucket(name, buckets_path)
127+
128+
129+
Aggregate.max_bucket
130+
~~~~~~~~~~~~~~~~~~~~
131+
132+
.. code:: python
133+
134+
Aggregate.max_bucket(name, buckets_path)
151135
152136
153137
Aggregate.histogram
@@ -190,12 +174,20 @@ Aggregate.geo_distance
190174
Aggregate.geo_distance(name, field, origin, [ranges])
191175
192176
193-
Aggregate.filter
194-
~~~~~~~~~~~~~~~~
177+
Aggregate.bucket_selector
178+
~~~~~~~~~~~~~~~~~~~~~~~~~
195179

196180
.. code:: python
197181
198-
Aggregate.filter(name, Query)
182+
Aggregate.bucket_selector(name, {})
183+
184+
185+
Aggregate.percentiles_bucket
186+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
187+
188+
.. code:: python
189+
190+
Aggregate.percentiles_bucket(name, buckets_path)
199191
200192
201193
Aggregate.percentile_ranks
@@ -206,28 +198,156 @@ Aggregate.percentile_ranks
206198
Aggregate.percentile_ranks(name, field)
207199
208200
209-
Aggregate.range
201+
Aggregate.cumulative_sum
202+
~~~~~~~~~~~~~~~~~~~~~~~~
203+
204+
.. code:: python
205+
206+
Aggregate.cumulative_sum(name, buckets_path)
207+
208+
209+
Aggregate.moving_avg
210+
~~~~~~~~~~~~~~~~~~~~
211+
212+
.. code:: python
213+
214+
Aggregate.moving_avg(name, buckets_path)
215+
216+
217+
Aggregate.geo_bounds
218+
~~~~~~~~~~~~~~~~~~~~
219+
220+
.. code:: python
221+
222+
Aggregate.geo_bounds(name, field)
223+
224+
225+
Aggregate.stats_bucket
226+
~~~~~~~~~~~~~~~~~~~~~~
227+
228+
.. code:: python
229+
230+
Aggregate.stats_bucket(name, buckets_path)
231+
232+
233+
Aggregate.avg_bucket
234+
~~~~~~~~~~~~~~~~~~~~
235+
236+
.. code:: python
237+
238+
Aggregate.avg_bucket(name, buckets_path)
239+
240+
241+
Aggregate.avg
242+
~~~~~~~~~~~~~
243+
244+
.. code:: python
245+
246+
Aggregate.avg(name, field)
247+
248+
249+
Aggregate.stats
210250
~~~~~~~~~~~~~~~
211251

212252
.. code:: python
213253
214-
Aggregate.range(name, field, [ranges])
254+
Aggregate.stats(name, field)
215255
216256
217-
Aggregate.significant_terms
218-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
257+
Aggregate.min
258+
~~~~~~~~~~~~~
219259

220260
.. code:: python
221261
222-
Aggregate.significant_terms(name, field)
262+
Aggregate.min(name, field)
223263
224264
225-
Aggregate.top_hits
226-
~~~~~~~~~~~~~~~~~~
265+
Aggregate.sum
266+
~~~~~~~~~~~~~
227267

228268
.. code:: python
229269
230-
Aggregate.top_hits(name)
270+
Aggregate.sum(name, field)
271+
272+
273+
Aggregate.percentiles
274+
~~~~~~~~~~~~~~~~~~~~~
275+
276+
.. code:: python
277+
278+
Aggregate.percentiles(name, field)
279+
280+
281+
Aggregate.min_bucket
282+
~~~~~~~~~~~~~~~~~~~~
283+
284+
.. code:: python
285+
286+
Aggregate.min_bucket(name, buckets_path)
287+
288+
289+
Aggregate.terms
290+
~~~~~~~~~~~~~~~
291+
292+
.. code:: python
293+
294+
Aggregate.terms(name, field)
295+
296+
297+
Aggregate.missing
298+
~~~~~~~~~~~~~~~~~
299+
300+
.. code:: python
301+
302+
Aggregate.missing(name, field)
303+
304+
305+
Aggregate.max
306+
~~~~~~~~~~~~~
307+
308+
.. code:: python
309+
310+
Aggregate.max(name, field)
311+
312+
313+
Aggregate.geo_centroid
314+
~~~~~~~~~~~~~~~~~~~~~~
315+
316+
.. code:: python
317+
318+
Aggregate.geo_centroid(name, field)
319+
320+
321+
Aggregate.serial_diff
322+
~~~~~~~~~~~~~~~~~~~~~
323+
324+
.. code:: python
325+
326+
Aggregate.serial_diff(name, buckets_path)
327+
328+
329+
Aggregate.filter
330+
~~~~~~~~~~~~~~~~
331+
332+
.. code:: python
333+
334+
Aggregate.filter(name, Query)
335+
336+
337+
Aggregate.range
338+
~~~~~~~~~~~~~~~
339+
340+
.. code:: python
341+
342+
Aggregate.range(name, field, [ranges])
343+
344+
345+
Aggregate.significant_terms
346+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
347+
348+
.. code:: python
349+
350+
Aggregate.significant_terms(name, field)
231351
232352
233353
Aggregate.reverse_nested

0 commit comments

Comments
 (0)