elasticsearch_dsl/search/aggregations/pipeline/mod.rs
1//! Pipeline aggregations work on the outputs produced from other aggregations rather than from document sets, adding
2//! information to the output tree. There are many different types of pipeline aggregation, each computing different information from
3//! other aggregations, but these types can be broken down into two families:
4//!
5//! **Parent**
6//! > A family of pipeline aggregations that is provided with the output of its parent aggregation and is able
7//! > to compute new buckets or new aggregations to add to existing buckets.
8//!
9//! **Sibling**
10//! > Pipeline aggregations that are provided with the output of a sibling aggregation and are able to compute a
11//! > new aggregation which will be at the same level as the sibling aggregation.
12//!
13//! Pipeline aggregations can reference the aggregations they need to perform their computation by using the `buckets_path`
14//! parameter to indicate the paths to the required metrics. The syntax for defining these paths can be found in the
15//! <<buckets-path-syntax, `buckets_path` Syntax>> section below.
16//!
17//! Pipeline aggregations cannot have sub-aggregations but depending on the type it can reference another pipeline in the `buckets_path`
18//! allowing pipeline aggregations to be chained. For example, you can chain together two derivatives to calculate the second derivative
19//! (i.e. a derivative of a derivative).
20//!
21//! > **NOTE**: Because pipeline aggregations only add to the output, when chaining pipeline aggregations the output of each pipeline aggregation
22//! > will be included in the final output.
23//!
24//! <https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html>
25
26#[doc(hidden)]
27pub mod todo {}