arangoq 0.3.4

An AQL query builder layer and ArangoDb client 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

use serde::{Deserialize, Serialize};

#[derive(Debug, PartialEq, Serialize, Deserialize, Default)]
pub struct ArangoResponse<T> {
    #[serde(default = "Vec::new")]
    pub result: Vec<T>,

    #[serde(rename = "hasMore", default)]
    pub has_more: bool,
    #[serde(default)]
    pub cached: bool,
    #[serde(default)]
    pub extra: ResponseExtra,
    #[serde(default)]
    pub error: bool,
    #[serde(default)]
    pub code: u16,

    #[serde(rename = "errorMessage", skip_serializing_if = "String::is_empty", default)]
    pub error_message: String,
    #[serde(rename = "errorNum", skip_serializing, default)]
    pub error_num: u64,

    #[serde(skip_serializing_if = "String::is_empty", default)]
    pub id: String,
}

#[cfg(test)]
#[allow(clippy::too_many_arguments)]
impl<T> ArangoResponse<T> {
    pub(crate) fn new(
        result: Vec<T>,
        has_more: bool,
        cached: bool,
        extra: ResponseExtra,
        error: bool,
        code: u16,
        error_message: String,
        error_num: u64,
        id: String,
    ) -> Self {
        Self { result, has_more, cached, extra, error, code, error_message, error_num, id }
    }
}

#[derive(Debug, PartialEq, Serialize, Deserialize, Default)]
pub struct ResponseExtra {
    #[serde(default)]
    pub stats: ArangoStats,
    #[serde(default)]
    pub warnings: Vec<String>,
}

#[allow(clippy::too_many_arguments)]
impl ResponseExtra {
    #[must_use]
    pub fn new(
        writes_executed: usize,
        writes_ignored: usize,
        scanned_full: usize,
        scanned_index: usize,
        filtered: usize,
        http_requests: usize,
        execution_time: f64,
        full_count: usize,
        peak_memory_usage: usize,
        warnings: Vec<String>,
    ) -> Self {
        Self {
            stats: ArangoStats {
                writes_executed,
                writes_ignored,
                scanned_full,
                scanned_index,
                filtered,
                http_requests,
                execution_time,
                full_count,
                peak_memory_usage,
            },
            warnings,
        }
    }
}

/// <https://www.arangodb.com/docs/stable/aql/execution-and-performance-query-statistics.html>
#[derive(Debug, PartialEq, Serialize, Deserialize, Default)]
pub struct ArangoStats {
    /// The total number of data-modification operations successfully executed.
    #[serde(rename = "writesExecuted", default)]
    pub writes_executed: usize,

    /// The total number of data-modification operations that were unsuccessful, but have been ignored because of query option `ignoreErrors`.
    #[serde(rename = "writesIgnored", default)]
    pub writes_ignored: usize,

    /// The total number of documents iterated over when scanning a collection without an index.
    #[serde(rename = "scannedFull", default)]
    pub scanned_full: usize,

    /// The total number of documents iterated over when scanning a collection using an index.
    #[serde(rename = "scannedIndex", default)]
    pub scanned_index: usize,

    /// The total number of documents that were removed after executing a filter condition.
    #[serde(default)]
    pub filtered: usize,

    #[serde(rename = "httpRequests", default)]
    pub http_requests: usize,

    #[serde(rename = "executionTime", default)]
    pub execution_time: f64,

    /// The total number of documents that matched the search condition.
    #[serde(rename = "fullCount", default)]
    pub full_count: usize,

    /// The maximum memory usage of the query while it was running.
    #[serde(rename = "peakMemoryUsage", default)]
    pub peak_memory_usage: usize,
}