elastiql 0.5.0

An opinionated Elasticsearch query language for Rust.
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

//! Range aggregation types.

use serde::{Deserialize, Serialize};

use crate::search::Script;

#[cfg(feature = "graphql")]
use crate::search::ScriptInput;

/// A [*multi-bucket*] value source based aggregation that enables the user to
/// define a set of ranges - each representing a bucket. During the aggregation
/// process, the values extracted from each document will be checked against
/// each bucket range and "bucket" the relevant/matching document.
///
/// **Note**: this aggregation *includes* the `from` value and *excludes* the
/// `to` value for each range.
///
/// **Note**: until GraphQL [Union input types] are supported either `field` or
/// `script` *must* be specified but *not* both.
///
/// [Union input types]: https://github.com/graphql/graphql-spec/blob/master/rfcs/InputUnion.md
/// [*multi-bucket*]: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket.html
#[cfg(feature = "graphql")]
#[cfg_attr(feature = "builder", derive(typed_builder::TypedBuilder))]
#[derive(async_graphql::InputObject, Serialize, Clone, Debug)]
#[cfg_attr(feature = "builder", builder(field_defaults(setter(into))))]
pub struct RangeAggregationInput {
    /// The field to perform the aggregation over.
    #[cfg_attr(feature = "builder", builder(default))]
    pub field: Option<String>,

    /// A script used to calculate the field to perform the aggregation over.
    #[cfg_attr(feature = "builder", builder(default))]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub script: Option<ScriptInput>,

    /// The ranges to use for the aggregation.
    #[graphql(default)]
    #[cfg_attr(feature = "builder", builder(default))]
    #[serde(default)]
    pub ranges: Vec<RangeInput>,
}

/// A [*multi-bucket*] value source based aggregation that enables the user to
/// define a set of ranges - each representing a bucket. During the aggregation
/// process, the values extracted from each document will be checked against
/// each bucket range and "bucket" the relevant/matching document.
///
/// **Note**: this aggregation *includes* the `from` value and *excludes* the
/// `to` value for each range.
///
/// **Note**: until GraphQL [Union input types] are supported either `field` or
/// `script` *must* be specified but *not* both.
///
/// [Union input types]: https://github.com/graphql/graphql-spec/blob/master/rfcs/InputUnion.md
/// [*multi-bucket*]: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket.html
#[cfg_attr(test, derive(PartialEq))]
#[cfg_attr(feature = "graphql", derive(async_graphql::SimpleObject))]
#[cfg_attr(feature = "builder", derive(typed_builder::TypedBuilder))]
#[derive(Serialize, Deserialize, Clone, Debug)]
#[cfg_attr(feature = "builder", builder(field_defaults(setter(into))))]
pub struct RangeAggregation {
    /// The field to perform the aggregation over.
    #[cfg_attr(feature = "builder", builder(default))]
    pub field: Option<String>,

    /// A script used to calculate the field to perform the aggregation over.
    #[cfg_attr(feature = "builder", builder(default))]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub script: Option<Script>,

    /// The ranges to use for the aggregation.
    #[cfg_attr(feature = "builder", builder(default))]
    #[cfg_attr(feature = "builder", builder(default))]
    #[serde(default)]
    pub ranges: Vec<Range>,
}

#[cfg(feature = "graphql")]
impl From<RangeAggregationInput> for RangeAggregation {
    #[inline]
    fn from(input: RangeAggregationInput) -> Self {
        RangeAggregation {
            field: input.field,
            script: input.script.map(Into::into),
            ranges: input.ranges.into_iter().map(Into::into).collect(),
        }
    }
}

/// A range/span of data.
#[cfg(feature = "graphql")]
#[cfg_attr(feature = "builder", derive(typed_builder::TypedBuilder))]
#[derive(async_graphql::InputObject, Serialize, Clone, Debug)]
#[cfg_attr(feature = "builder", builder(field_defaults(setter(into))))]
pub struct RangeInput {
    /// The value to return results *from* and including.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "builder", builder(default))]
    from: Option<f64>,

    /// The value to return results up *to* but *not* including.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "builder", builder(default))]
    to: Option<f64>,
}

/// A range/span of data.
#[cfg_attr(test, derive(PartialEq))]
#[cfg_attr(feature = "graphql", derive(async_graphql::SimpleObject))]
#[cfg_attr(feature = "builder", derive(typed_builder::TypedBuilder))]
#[derive(Serialize, Deserialize, Clone, Debug)]
#[cfg_attr(feature = "builder", builder(field_defaults(setter(into))))]
pub struct Range {
    /// The value to return results *from* and including.
    #[cfg_attr(feature = "builder", builder(default))]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    from: Option<f64>,

    /// The value to return results up *to* but *not* including.
    #[cfg_attr(feature = "builder", builder(default))]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    to: Option<f64>,
}

// TODO: generate this with a proc-macro?
#[cfg(feature = "graphql")]
impl From<RangeInput> for Range {
    #[inline]
    fn from(input: RangeInput) -> Self {
        Range {
            from: input.from,
            to: input.to,
        }
    }
}