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

//! Types for searching/aggregating using [scripts]
//!
//! [scripts]: https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html

use std::default::Default;

use serde::{Deserialize, Serialize};

/// Available sandboxed scripting [languages].
///
/// [languages]: https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
#[cfg_attr(all(test, not(feature = "graphql")), derive(PartialEq))]
#[cfg_attr(feature = "graphql", derive(async_graphql::Enum, Eq, PartialEq, Copy))]
#[derive(Serialize, Deserialize, Clone, Debug)]
pub enum ScriptLanguage {
    /// [Lucene expressions language] compile a Javascript expression to
    /// bytecode. They are designed for high-performance custom ranking and
    /// sorting functions.
    ///
    /// ## Example
    ///
    /// ```notrust
    /// (doc['silence_duration'] / doc['duration']) * 100.0
    /// ```
    ///
    /// [Lucene expressions language]: https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting-expression.html
    Expressions,

    /// General purpose [scripting] language similar to Java.
    ///
    /// Refer to the [Painless API reference] for more information.
    ///
    /// ## Examples
    ///
    /// ```notrust
    /// (doc.getOrDefault​('silence_duration', 0.0) / doc['duration']) * 100.0
    /// ```
    ///
    /// ```notrust
    /// int total = 0;
    /// for (int i = 0; i < doc['goals'].length; ++i) {
    ///     total += doc['goals'][i];
    /// }
    /// return total;
    /// ```
    ///
    /// [scripting]: https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-walkthrough.html
    /// [Painless API reference]: https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-api-reference.html
    Painless,
}

impl Default for ScriptLanguage {
    #[inline]
    fn default() -> Self {
        ScriptLanguage::Expressions
    }
}

/// Evaluates custom expressions/[scripts].
///
/// [scripts]: https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
#[cfg(feature = "graphql")]
#[derive(async_graphql::InputObject, Serialize, Deserialize, PartialEq, Clone, Debug)]
pub struct ScriptInput {
    source: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    params: Option<crate::scalars::Map>,
    // #[graphql(default]
    // #[serde(default, skip_serializing_if = "Option::is_none")]
    // lang: Option<ScriptLanguage>,
}

/// Evaluates custom expressions/[scripts].
///
/// [scripts]: https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
#[cfg_attr(all(test, not(feature = "graphql")), derive(PartialEq))]
#[cfg_attr(feature = "graphql", derive(async_graphql::SimpleObject, PartialEq))]
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct Script {
    source: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    params: Option<crate::scalars::Map>,
}

#[cfg(feature = "graphql")]
impl From<ScriptInput> for Script {
    #[inline]
    fn from(script: ScriptInput) -> Self {
        Script {
            source: script.source,
            params: script.params,
        }
    }
}