elasticsearch_dsl/search/queries/term_level/
ids_query.rs

1use crate::search::*;
2use crate::util::*;
3use crate::Set;
4
5/// Returns documents based on their IDs. This query uses document IDs stored in the
6/// [`_id`](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-id-field.html)
7/// field.
8///
9/// To create IDs query:
10/// ```
11/// # use elasticsearch_dsl::queries::*;
12/// # use elasticsearch_dsl::queries::params::*;
13/// # let query =
14/// Query::ids(vec!["2"]);
15/// ```
16/// <https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html>
17#[derive(Debug, Clone, PartialEq, Serialize)]
18#[serde(remote = "Self")]
19pub struct IdsQuery {
20    #[serde(skip_serializing_if = "ShouldSkip::should_skip")]
21    values: Set<String>,
22
23    #[serde(skip_serializing_if = "ShouldSkip::should_skip")]
24    boost: Option<f32>,
25
26    #[serde(skip_serializing_if = "ShouldSkip::should_skip")]
27    _name: Option<String>,
28}
29
30impl Query {
31    /// Creates an instance of [`IdsQuery`]
32    ///
33    /// - `values` - An array of
34    ///   [document IDs](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-id-field.html).
35    pub fn ids<I>(values: I) -> IdsQuery
36    where
37        I: IntoIterator,
38        I::Item: ToString,
39    {
40        IdsQuery {
41            values: values.into_iter().map(|value| value.to_string()).collect(),
42            boost: None,
43            _name: None,
44        }
45    }
46}
47
48impl IdsQuery {
49    add_boost_and_name!();
50}
51
52impl ShouldSkip for IdsQuery {
53    fn should_skip(&self) -> bool {
54        self.values.should_skip()
55    }
56}
57
58serialize_with_root!("ids": IdsQuery);
59
60#[cfg(test)]
61mod tests {
62    use super::*;
63
64    #[test]
65    fn serialization() {
66        assert_serialize_query(
67            Query::ids(vec![1, 3, 2, 5, 4, 6]),
68            json!({
69                "ids": {
70                    "values": ["1", "2", "3", "4", "5", "6"],
71                }
72            }),
73        );
74
75        assert_serialize_query(
76            Query::ids(vec![1, 3, 2, 5, 4, 6]).boost(1.3).name("test"),
77            json!({
78                "ids": {
79                    "values": ["1", "2", "3", "4", "5", "6"],
80                    "boost": 1.3,
81                    "_name": "test"
82                }
83            }),
84        );
85    }
86}
elasticsearch_dsl/search/queries/term_level/ids_query.rs

elasticsearch_dsl/search/queries/term_level/
ids_query.rs
