databend_client/
response.rs

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
// Copyright 2021 Datafuse Labs
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use crate::error_code::ErrorCode;
use crate::session::SessionState;
use serde::Deserialize;

#[derive(Deserialize, Debug)]
pub struct QueryStats {
    #[serde(flatten)]
    pub progresses: Progresses,
    pub running_time_ms: f64,
}

#[derive(Deserialize, Debug)]
pub struct Progresses {
    pub scan_progress: ProgressValues,
    pub write_progress: ProgressValues,
    pub result_progress: ProgressValues,
    // make it optional for backward compatibility
    pub total_scan: Option<ProgressValues>,
}

impl Progresses {
    pub fn has_progress(&self) -> bool {
        self.scan_progress.bytes > 0
            || self.scan_progress.rows > 0
            || self.write_progress.bytes > 0
            || self.write_progress.rows > 0
            || self.result_progress.bytes > 0
            || self.result_progress.rows > 0
            || self
                .total_scan
                .as_ref()
                .map_or(false, |v| v.bytes > 0 || v.rows > 0)
    }
}

#[derive(Debug, Deserialize)]
pub struct ProgressValues {
    pub rows: usize,
    pub bytes: usize,
}

#[derive(Deserialize, Debug, Clone)]
pub struct SchemaField {
    pub name: String,
    #[serde(rename = "type")]
    pub data_type: String,
}

#[derive(Deserialize, Debug)]
pub struct QueryResponse {
    pub id: String,
    pub node_id: Option<String>,
    pub session_id: Option<String>,
    pub session: Option<SessionState>,
    pub schema: Vec<SchemaField>,
    pub data: Vec<Vec<Option<String>>>,
    pub state: String,
    pub error: Option<ErrorCode>,
    // make it optional for backward compatibility
    pub warnings: Option<Vec<String>>,
    pub stats: QueryStats,
    // pub affect: Option<QueryAffect>,
    pub stats_uri: Option<String>,
    pub final_uri: Option<String>,
    pub next_uri: Option<String>,
    pub kill_uri: Option<String>,
}

#[cfg(test)]
mod test {
    use std::collections::BTreeMap;

    use super::*;

    #[test]
    fn deserialize_session_config() {
        let session_json = r#"{"database":"default","settings":{}}"#;
        let session_config: SessionState = serde_json::from_str(session_json).unwrap();
        assert_eq!(session_config.database, Some("default".to_string()));
        assert_eq!(session_config.settings, Some(BTreeMap::default()));
        assert_eq!(session_config.role, None);
        assert_eq!(session_config.secondary_roles, None);

        let session_json = r#"{"database":"default","settings":{},"role": "role1", "secondary_roles": [], "unknown_field": 1}"#;
        let session_config: SessionState = serde_json::from_str(session_json).unwrap();
        assert_eq!(session_config.database, Some("default".to_string()));
        assert_eq!(session_config.settings, Some(BTreeMap::default()));
        assert_eq!(session_config.role, Some("role1".to_string()));
        assert_eq!(session_config.secondary_roles, Some(vec![]));
    }
}