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

//! Response types for [bulk] queries.
//!
//! [bulk]: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html

use crate::search::ErrResponse;
use serde::Deserialize;

// TODO: add these upstream https://github.com/elastic/elasticsearch-rs/issues/75
// TODO: add missing fields...

/// The bulk API’s response contains the individual results of each operation in
/// the request, returned in the order submitted. The success or failure of an
/// individual operation does not affect other operations in the request.
#[derive(Deserialize, Debug)]
pub struct Response<T> {
    /// How long, in milliseconds, it took to process the bulk request.
    pub took: u64,

    /// If `true`, one or more of the operations in the bulk request did not
    /// complete successfully.
    pub errors: bool,

    /// The bulk response items.
    #[serde(default = "Vec::new")]
    pub items: Vec<Action<T>>,
}

/// The result of a bulk operation.
#[derive(Deserialize, Debug)]
#[serde(rename_all = "snake_case")]
pub enum Action<T> {
    /// The result from performing a bulk `Create` operation.
    Create(Item<T>),

    /// The result from performing a bulk `Index` operation.
    Index(Item<T>),

    /// The result from performing a bulk `Update` operation.
    Update(Item<T>),

    /// The result from performing a bulk `Delete` operation.
    Delete(Item<T>),
}

/// An individual bulk item.
///
/// *TODO*: somehow use `std::error::Error` instead of this...
#[derive(Deserialize, Debug)]
#[serde(untagged)]
pub enum Item<T> {
    /// An `Ok` item.
    Ok(OkItem<T>),

    /// An `Err` item.
    Err {
        /// The error.
        error: ErrResponse,

        /// The [HTTP status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status).
        status: u16,
    },
}

/// An individual item from performing a successful bulk operation.
#[derive(Deserialize, Debug)]
pub struct OkItem<T> {
    status: u16,

    /// The document ID associated with the operation.
    #[serde(rename = "_id")]
    pub id: String,

    /// The index the document belongs to.
    #[serde(rename = "_index")]
    pub index: String,

    /// The document's source (if requested).
    pub get: Option<Get<T>>,
}

/// Encompasses the `source` document.
#[derive(Deserialize, Debug)]
pub struct Get<T> {
    /// The document's source (if requested).
    #[serde(rename = "_source")]
    pub source: Option<T>,
}