opensearch-dsl 0.3.1

Strongly typed OpenSearch DSL
Documentation 
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

use crate::{search::*, util::*};

/// A `single-value` metrics aggregation that sums up numeric values that are
/// extracted from the aggregated documents. These values can be extracted
/// either from specific numeric or histogram fields.
///
/// <https://www.elastic.co/guide/en/opensearch/reference/current/search-aggregations-metrics-sum-aggregation.html>
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
pub struct SumAggregation {
    sum: SumAggregationInner,
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
struct SumAggregationInner {
    #[serde(default, skip_serializing_if = "ShouldSkip::should_skip")]
    field: Option<String>,

    #[serde(default, skip_serializing_if = "ShouldSkip::should_skip")]
    script: Option<Script>,

    #[serde(default, skip_serializing_if = "ShouldSkip::should_skip")]
    missing: Option<Number>,
}

impl Aggregation {
    /// Creates an instance of [`SumAggregation`]
    ///
    /// - `field` - field to aggregate
    pub fn sum<T>(field: T) -> SumAggregation
    where
        T: ToString,
    {
        SumAggregation {
            sum: SumAggregationInner {
                field: field.to_string().into(),
                script: None,
                missing: None,
            },
        }
    }

    /// Creates an instance of [`SumAggregation`]
    ///
    /// - `script` - script to aggregate
    pub fn sum_script(script: Script) -> SumAggregation {
        SumAggregation {
            sum: SumAggregationInner {
                script: script.into(),
                field: None,
                missing: None,
            },
        }
    }
}

impl SumAggregation {
    /// The `missing` parameter defines how documents that are missing a value
    /// should be treated. By default documents missing the value 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.sum.missing = Some(missing.into());
        self
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn serialization() {
        assert_serialize_aggregation(
            Aggregation::sum("test_field"),
            json!({ "sum": { "field": "test_field" } }),
        );

        assert_serialize_aggregation(
            Aggregation::sum("test_field").missing(100.1),
            json!({
                "sum": {
                    "field": "test_field",
                    "missing": 100.1
                }
            }),
        );

        assert_serialize_aggregation(
            Aggregation::sum_script(Script::source("_score")),
            json!({
                "sum": {
                    "script": {
                        "source": "_score"
                    }
                }
            }),
        );
    }
}