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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
/*
 * Copyright 2023-2025 Alberto Paro
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#![allow(missing_docs)]

use serde::{Deserialize, Serialize};
use serde_json::Value;

use super::Hit;
use crate::{
    Map, search::aggregations::Aggregation as RequestAggregation, search::params::GeoLocation,
};

/// Main aggregation trait equivalent
pub trait AggregationTrait {
    /// Meta information of aggregation
    fn meta(&self) -> Option<&Value>;

    /// Aggregation source
    fn source_aggregation(&self) -> Option<&RequestAggregation>;

    /// Set aggregation source
    fn set_source_aggregation(&mut self, agg: Option<RequestAggregation>);

    /// If the aggregation is empty
    fn is_empty(&self) -> bool;

    /// If the aggregation is not empty
    fn non_empty(&self) -> bool {
        !self.is_empty()
    }

    /// Extract label and count from an aggregation
    fn extract_label_values(&self) -> (Vec<String>, Vec<f64>) {
        (vec![], vec![])
    }
}

/// Main aggregation response enum
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(untagged)]
pub enum AggregationResponse {
    /// Bucket aggregation response
    Bucket(BucketAggregation),
    /// Multi-bucket aggregation response  
    MultiBucket(MultiBucketAggregation),
    /// Document count aggregation response
    DocCount(DocCountAggregation),
    /// Geo bounds aggregation response
    GeoBounds(GeoBoundsValue),
    /// Extended metric statistics aggregation response
    MetricExtendedStats(MetricExtendedStats),
    /// Metric statistics aggregation response
    MetricStats(MetricStats),
    /// Metric value aggregation response
    MetricValue(MetricValue),
    /// Top hits aggregation response
    TopHits(TopHitsStats),
    /// Simple aggregation response
    Simple(Simple),
}

impl AggregationTrait for AggregationResponse {
    fn meta(&self) -> Option<&Value> {
        match self {
            AggregationResponse::Bucket(agg) => agg.meta.as_ref(),
            AggregationResponse::MultiBucket(agg) => agg.meta.as_ref(),
            AggregationResponse::DocCount(agg) => agg.meta.as_ref(),
            AggregationResponse::GeoBounds(agg) => agg.meta.as_ref(),
            AggregationResponse::MetricExtendedStats(agg) => agg.meta.as_ref(),
            AggregationResponse::MetricStats(agg) => agg.meta.as_ref(),
            AggregationResponse::MetricValue(agg) => agg.meta.as_ref(),
            AggregationResponse::TopHits(agg) => agg.meta.as_ref(),
            AggregationResponse::Simple(agg) => agg.meta.as_ref(),
        }
    }

    fn source_aggregation(&self) -> Option<&RequestAggregation> {
        match self {
            AggregationResponse::Bucket(agg) => agg.source_aggregation.as_ref(),
            AggregationResponse::MultiBucket(agg) => agg.source_aggregation.as_ref(),
            AggregationResponse::DocCount(agg) => agg.source_aggregation.as_ref(),
            AggregationResponse::GeoBounds(agg) => agg.source_aggregation.as_ref(),
            AggregationResponse::MetricExtendedStats(agg) => agg.source_aggregation.as_ref(),
            AggregationResponse::MetricStats(agg) => agg.source_aggregation.as_ref(),
            AggregationResponse::MetricValue(agg) => agg.source_aggregation.as_ref(),
            AggregationResponse::TopHits(agg) => agg.source_aggregation.as_ref(),
            AggregationResponse::Simple(agg) => agg.source_aggregation.as_ref(),
        }
    }

    fn set_source_aggregation(&mut self, agg: Option<RequestAggregation>) {
        match self {
            AggregationResponse::Bucket(a) => a.source_aggregation = agg,
            AggregationResponse::MultiBucket(a) => a.source_aggregation = agg,
            AggregationResponse::DocCount(a) => a.source_aggregation = agg,
            AggregationResponse::GeoBounds(a) => a.source_aggregation = agg,
            AggregationResponse::MetricExtendedStats(a) => a.source_aggregation = agg,
            AggregationResponse::MetricStats(a) => a.source_aggregation = agg,
            AggregationResponse::MetricValue(a) => a.source_aggregation = agg,
            AggregationResponse::TopHits(a) => a.source_aggregation = agg,
            AggregationResponse::Simple(a) => a.source_aggregation = agg,
        }
    }

    fn is_empty(&self) -> bool {
        match self {
            AggregationResponse::Bucket(agg) => agg.buckets.is_empty(),
            AggregationResponse::MultiBucket(_) => true,
            AggregationResponse::DocCount(_) => false,
            AggregationResponse::GeoBounds(_) => false,
            AggregationResponse::MetricExtendedStats(_) => false,
            AggregationResponse::MetricStats(_) => false,
            AggregationResponse::MetricValue(_) => false,
            AggregationResponse::TopHits(_) => false,
            AggregationResponse::Simple(_) => false,
        }
    }

    fn extract_label_values(&self) -> (Vec<String>, Vec<f64>) {
        match self {
            AggregationResponse::Bucket(agg) => {
                let labels: Vec<String> = agg.buckets.iter().map(|b| b.key_to_string()).collect();
                let values: Vec<f64> = agg.buckets.iter().map(|b| b.doc_count as f64).collect();
                (labels, values)
            }
            _ => (vec![], vec![]),
        }
    }
}

/// TopHitsResult equivalent
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct TopHitsResult {
    pub total: i64,
    #[serde(rename = "max_score")]
    pub max_score: Option<f64>,
    pub hits: Vec<Hit>,
}

impl Default for TopHitsResult {
    fn default() -> Self {
        Self {
            total: 0,
            max_score: None,
            hits: vec![],
        }
    }
}

/// Simple aggregation
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct Simple {
    #[serde(rename = "_source")]
    pub source_aggregation: Option<RequestAggregation>,
    pub meta: Option<Value>,
}

/// Bucket structure
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct Bucket {
    pub key: Value,
    #[serde(rename = "doc_count")]
    pub doc_count: i64,
    #[serde(rename = "bg_count")]
    pub bg_count: Option<i64>,
    pub score: Option<f64>,
    #[serde(rename = "key_as_string")]
    pub key_as_string: Option<String>,
    #[serde(flatten)]
    pub sub_aggs: Map<String, AggregationResponse>,
}

impl Bucket {
    pub fn key_to_string(&self) -> String {
        if let Some(ref key_as_string) = self.key_as_string {
            key_as_string.clone()
        } else {
            match &self.key {
                Value::String(s) => s.clone(),
                _ => self.key.to_string(),
            }
        }
    }
}

/// MultiBucketBucket structure
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct MultiBucketBucket {
    #[serde(rename = "doc_count")]
    pub doc_count: i64,
    pub buckets: Map<String, BucketAggregation>,
}

/// MultiBucketAggregation
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct MultiBucketAggregation {
    pub buckets: Map<String, MultiBucketBucket>,
    #[serde(rename = "_source")]
    pub source_aggregation: Option<RequestAggregation>,
    pub meta: Option<Value>,
}

/// BucketAggregation
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct BucketAggregation {
    pub buckets: Vec<Bucket>,
    #[serde(rename = "doc_count_error_upper_bound")]
    pub doc_count_error_upper_bound: i64,
    #[serde(rename = "sum_other_doc_count")]
    pub sum_other_doc_count: i64,
    #[serde(rename = "_source")]
    pub source_aggregation: Option<RequestAggregation>,
    pub meta: Option<Value>,
}

impl Default for BucketAggregation {
    fn default() -> Self {
        Self {
            buckets: vec![],
            doc_count_error_upper_bound: 0,
            sum_other_doc_count: 0,
            source_aggregation: None,
            meta: None,
        }
    }
}

impl BucketAggregation {
    pub fn buckets_count_as_list(&self) -> Vec<(String, i64)> {
        self.buckets
            .iter()
            .map(|b| (b.key_to_string(), b.doc_count))
            .collect()
    }

    pub fn buckets_count_as_map(&self) -> Map<String, i64> {
        self.buckets
            .iter()
            .map(|b| (b.key_to_string(), b.doc_count))
            .collect()
    }
}

/// DocCountAggregation
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct DocCountAggregation {
    #[serde(rename = "doc_count")]
    pub doc_count: f64,
    #[serde(flatten)]
    pub sub_aggs: Map<String, AggregationResponse>,
    #[serde(rename = "_source")]
    pub source_aggregation: Option<RequestAggregation>,
    pub meta: Option<Value>,
}

/// GeoBoundsValue
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct GeoBoundsValue {
    #[serde(rename = "top_left")]
    pub top_left: GeoLocation,
    #[serde(rename = "bottom_right")]
    pub bottom_right: GeoLocation,
    #[serde(rename = "_source")]
    pub source_aggregation: Option<RequestAggregation>,
    pub meta: Option<Value>,
}

/// MetricExtendedStats
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct MetricExtendedStats {
    pub count: i64,
    pub min: f64,
    pub max: f64,
    pub avg: f64,
    pub sum: f64,
    #[serde(rename = "sum_of_squares")]
    pub sum_of_squares: f64,
    pub variance: f64,
    #[serde(rename = "std_deviation")]
    pub std_deviation: f64,
    #[serde(rename = "_source")]
    pub source_aggregation: Option<RequestAggregation>,
    pub meta: Option<Value>,
}

impl Default for MetricExtendedStats {
    fn default() -> Self {
        Self {
            count: 0,
            min: 0.0,
            max: 0.0,
            avg: 0.0,
            sum: 0.0,
            sum_of_squares: 0.0,
            variance: 0.0,
            std_deviation: 0.0,
            source_aggregation: None,
            meta: None,
        }
    }
}

/// TopHitsStats
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct TopHitsStats {
    pub hits: TopHitsResult,
    #[serde(rename = "_source")]
    pub source_aggregation: Option<RequestAggregation>,
    pub meta: Option<Value>,
}

/// MetricStats
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct MetricStats {
    pub count: i64,
    pub min: f64,
    pub max: f64,
    pub avg: f64,
    pub sum: f64,
    #[serde(rename = "_source")]
    pub source_aggregation: Option<RequestAggregation>,
    pub meta: Option<Value>,
}

impl Default for MetricStats {
    fn default() -> Self {
        Self {
            count: 0,
            min: 0.0,
            max: 0.0,
            avg: 0.0,
            sum: 0.0,
            source_aggregation: None,
            meta: None,
        }
    }
}

/// MetricValue
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct MetricValue {
    pub value: f64,
    #[serde(rename = "_source")]
    pub source_aggregation: Option<RequestAggregation>,
    pub meta: Option<Value>,
}

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

    #[test]
    fn test_metric_value_serialization() {
        let metric = MetricValue {
            value: 42.5,
            source_aggregation: None,
            meta: None,
        };

        let json = serde_json::to_value(&metric).unwrap();
        assert_eq!(json["value"], 42.5);
    }

    #[test]
    fn test_bucket_key_to_string() {
        let bucket = Bucket {
            key: json!("test_key"),
            doc_count: 10,
            bg_count: None,
            score: None,
            key_as_string: Some("test_key_string".to_string()),
            sub_aggs: Map::new(),
        };

        assert_eq!(bucket.key_to_string(), "test_key_string");

        let bucket2 = Bucket {
            key: json!("another_key"),
            doc_count: 5,
            bg_count: None,
            score: None,
            key_as_string: None,
            sub_aggs: Map::new(),
        };

        assert_eq!(bucket2.key_to_string(), "another_key");
    }

    #[test]
    fn test_aggregation_trait() {
        let bucket_agg = BucketAggregation {
            buckets: vec![],
            doc_count_error_upper_bound: 0,
            sum_other_doc_count: 0,
            source_aggregation: None,
            meta: None,
        };

        let agg = AggregationResponse::Bucket(bucket_agg);
        assert!(agg.is_empty());
        assert!(!agg.non_empty());
    }
}