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

use crate::search::*;
use crate::util::*;

/// Wraps a [filter query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html)
/// and returns every matching document with a
/// [relevance score](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#relevance-scores)
/// equal to the `boost` parameter value.
///
/// To create constant score query:
/// ```
/// # use elasticsearch_dsl::queries::*;
/// # use elasticsearch_dsl::queries::params::*;
/// # let query =
/// Query::constant_score(Query::term("test1", 123))
///     .boost(3)
///     .name("test");
/// ```
/// <https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-constant-score-query.html>
#[derive(Debug, Clone, PartialEq, Serialize)]
pub struct ConstantScoreQuery {
    #[serde(rename = "constant_score")]
    inner: Inner,
}

#[derive(Debug, Clone, PartialEq, Serialize)]
struct Inner {
    filter: Box<Query>,

    #[serde(skip_serializing_if = "ShouldSkip::should_skip")]
    boost: Option<Boost>,

    #[serde(skip_serializing_if = "ShouldSkip::should_skip")]
    _name: Option<String>,
}

impl Query {
    /// Creates an instance of [`ConstantScoreQuery`]
    ///
    /// - `filter` - [Filter query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html)
    /// you wish to run. Any returned documents must match this query.<br>
    /// Filter queries do not calculate
    /// [relevance scores](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#relevance-scores).
    /// To speed up performance, Elasticsearch automatically caches frequently used filter queries.
    pub fn constant_score(filter: impl Into<Query>) -> ConstantScoreQuery {
        ConstantScoreQuery {
            inner: Inner {
                filter: Box::new(filter.into()),
                boost: None,
                _name: None,
            },
        }
    }
}

impl ConstantScoreQuery {
    add_boost_and_name!();
}

impl ShouldSkip for ConstantScoreQuery {
    fn should_skip(&self) -> bool {
        self.inner.filter.should_skip()
    }
}

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

    test_serialization! {
        with_required_fields(
            Query::constant_score(Query::term("test1", 123)),
            json!({
                "constant_score": {
                    "filter": {
                        "term": {
                            "test1": {
                                "value": 123
                            }
                        }
                    }
                }
            })
        );

        with_all_fields(
            Query::constant_score(Query::term("test1", 123)).boost(3).name("test"),
            json!({
                "constant_score": {
                    "filter": {
                        "term": {
                            "test1": {
                                "value": 123
                            }
                        }
                    },
                    "boost": 3,
                    "_name": "test"
                }
            })
        );
    }
}