Struct Aggregation 

pub struct Aggregation { /* private fields */ }

One aggregation.

Sub-aggregations nest with Aggregation::aggregate, which is how a “average price per tag” is expressed: a terms on the tag with a stats inside it.

Implementations

impl Aggregation

pub fn terms(field: impl Into<String>) -> Aggregation

A bucket per distinct value.

Only works on a field that is not analysed — keyword, a number, a date. On a text field the cluster answers 400 and tells you to enable fielddata, which is almost never the right answer; adding a keyword sub-field to the mapping is. See crate::Field::text.

pub fn stats(field: impl Into<String>) -> Aggregation

Count, min, max, average and sum of a numeric field, in one pass.

pub fn min(field: impl Into<String>) -> Aggregation

pub fn max(field: impl Into<String>) -> Aggregation

pub fn avg(field: impl Into<String>) -> Aggregation

pub fn sum(field: impl Into<String>) -> Aggregation

pub fn cardinality(field: impl Into<String>) -> Aggregation

How many distinct values — approximate, and deliberately so: an exact count would mean holding every value in memory on one node.

pub fn value_count(field: impl Into<String>) -> Aggregation

How many documents have the field at all.

pub fn date_histogram( field: impl Into<String>, interval: impl Into<String>, ) -> Aggregation

Buckets over time: date_histogram("created_at", "day").

Sent as calendar_interval, so a month is a real month and a day survives a daylight-saving change. fixed_interval — exact multiples of a duration — is available through Aggregation::option.

pub fn raw(kind: impl Into<String>, body: Json) -> Aggregation

An aggregation this module does not name.

pub fn size(self, size: u32) -> Aggregation

How many buckets to return.

Applies to the bucket aggregations. The default is 10, which is the quietest way to lose data in this API: the eleventh tag simply is not in the answer, and nothing in the response says a number is missing except crate::TermsResult::is_approximate.

pub fn min_doc_count(self, count: u64) -> Aggregation

Ignore buckets with fewer than this many documents.

pub fn missing(self, value: impl Into<Json>) -> Aggregation

Treat documents without the field as having this value, instead of leaving them out entirely.

pub fn option(self, name: impl Into<String>, value: Json) -> Aggregation

Any other option the aggregation takes.

pub fn aggregate( self, name: impl Into<String>, sub: impl Into<Aggregation>, ) -> Aggregation

Nest another aggregation inside each bucket of this one.

pub fn body(&self) -> Json

The JSON this aggregation sends.

Trait Implementations

impl Clone for Aggregation

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Aggregation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Aggregation

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Aggregation