solidb 2.0.2

A lightweight, high-performance structured database server written in 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

use super::error::DriverError;
use serde::{Deserialize, Serialize};
use serde_json::Value;

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "status", rename_all = "snake_case")]
pub enum Response {
    Ok {
        #[serde(skip_serializing_if = "Option::is_none")]
        data: Option<Value>,
        #[serde(skip_serializing_if = "Option::is_none")]
        count: Option<usize>,
        #[serde(skip_serializing_if = "Option::is_none")]
        tx_id: Option<String>,
    },
    Error {
        error: DriverError,
    },
    Pong {
        timestamp: i64,
    },
    Batch {
        responses: Vec<Response>,
    },
    /// An `Ok` whose rows are shared with the query cache. It encodes exactly
    /// like `Ok { data: [...] }`; it exists so a cache hit is written straight
    /// from the cached rows. Built as `json!(rows.clone())` it was two deep
    /// copies of every row per request — the clone, then a round trip through
    /// `serde_json::Value`'s serializer.
    #[serde(rename = "ok", skip_deserializing)]
    Rows {
        data: SharedRows,
    },
}

/// Query rows shared with the query cache; serializes as an array.
#[derive(Debug, Clone)]
pub struct SharedRows(pub std::sync::Arc<Vec<Value>>);

impl Serialize for SharedRows {
    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        self.0.as_slice().serialize(serializer)
    }
}

impl Response {
    pub fn ok(data: Value) -> Self {
        Response::Ok {
            data: Some(data),
            count: None,
            tx_id: None,
        }
    }

    /// Rows shared with the query cache, sent without copying them.
    pub fn ok_shared_rows(rows: std::sync::Arc<Vec<Value>>) -> Self {
        Response::Rows {
            data: SharedRows(rows),
        }
    }

    pub fn ok_count(count: usize) -> Self {
        Response::Ok {
            data: None,
            count: Some(count),
            tx_id: None,
        }
    }

    pub fn ok_empty() -> Self {
        Response::Ok {
            data: None,
            count: None,
            tx_id: None,
        }
    }

    pub fn ok_tx(tx_id: String) -> Self {
        Response::Ok {
            data: None,
            count: None,
            tx_id: Some(tx_id),
        }
    }

    pub fn error(err: DriverError) -> Self {
        Response::Error { error: err }
    }

    pub fn pong() -> Self {
        Response::Pong {
            timestamp: chrono::Utc::now().timestamp_millis(),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::driver::protocol::codec::encode_response;

    /// A cache hit is sent as `Rows`; a client must not be able to tell it
    /// from the `Ok` a cache miss sends.
    #[test]
    fn shared_rows_encode_like_ok_data() {
        let rows = vec![
            serde_json::json!({"id": 1, "title": "Post title 1", "views": 7}),
            serde_json::json!({"id": 2, "title": "Post title 2", "views": 14}),
        ];
        let owned = encode_response(&Response::ok(Value::Array(rows.clone()))).unwrap();
        let shared = encode_response(&Response::ok_shared_rows(std::sync::Arc::new(rows))).unwrap();
        assert_eq!(owned, shared);
    }
}