1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
use crate::search::*;
use crate::util::*;
/// A `single-value` metrics aggregation that keeps track and returns the minimum value among numeric
/// values extracted from the aggregated documents.
///
/// > The `min` and `max` aggregation operate on the `double` representation of the data. As a
/// consequence, the result may be approximate when running on longs whose absolute value is greater
/// than `2^53`.
///
/// <https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-min-aggregation.html>
#[derive(Debug, Clone, Serialize, PartialEq)]
pub struct MinAggregation {
min: MinAggregationInner,
}
#[derive(Debug, Clone, Serialize, PartialEq)]
struct MinAggregationInner {
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
field: Option<String>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
script: Option<Script>,
#[serde(skip_serializing_if = "ShouldSkip::should_skip")]
missing: Option<Number>,
}
impl Aggregation {
/// Creates an instance of [`MinAggregation`]
///
/// - `field` - field to aggregate
pub fn min<T>(field: T) -> MinAggregation
where
T: ToString,
{
MinAggregation {
min: MinAggregationInner {
field: field.to_string().into(),
script: None,
missing: None,
},
}
}
/// Creates an instance of [`MinAggregation`]
///
/// - `script` - script to aggregate
pub fn min_script(script: Script) -> MinAggregation {
MinAggregation {
min: MinAggregationInner {
script: script.into(),
field: None,
missing: None,
},
}
}
}
impl MinAggregation {
/// The `missing` parameter defines how documents that are missing a value should be treated. By
/// default they will be ignored but it is also possible to treat them as if they had a value.
pub fn missing<T>(mut self, missing: T) -> Self
where
T: Into<Number>,
{
self.min.missing = Some(missing.into());
self
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn serialization() {
assert_serialize_aggregation(
Aggregation::min("test_field"),
json!({ "min": { "field": "test_field" } }),
);
assert_serialize_aggregation(
Aggregation::min("test_field").missing(100.1),
json!({
"min": {
"field": "test_field",
"missing": 100.1
}
}),
);
assert_serialize_aggregation(
Aggregation::min_script(Script::source("_score")),
json!({
"min": {
"script": {
"source": "_score"
}
}
}),
);
}
}