hotdata 0.5.0

Powerful data platform API for datasets, queries, and analytics.
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

/*
 * Hotdata API
 *
 * Powerful data platform API for managed databases, queries, and analytics.
 *
 * The version of the OpenAPI document: 1.0.0
 * Contact: developers@hotdata.dev
 * Generated by: https://openapi-generator.tech
 */

use crate::models;
use serde::{Deserialize, Serialize};

/// QueryRunInfo : Single query run for listing
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct QueryRunInfo {
    /// Total bytes of table data read from storage to run this query. `null` when the query touches no table at all (for example a constant expression like `SELECT 1`). May be `0` when the query reads a table but not its row data — for example a row count served from table statistics.
    #[serde(
        rename = "bytes_scanned",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub bytes_scanned: Option<Option<i64>>,
    #[serde(
        rename = "completed_at",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub completed_at: Option<Option<String>>,
    #[serde(rename = "created_at")]
    pub created_at: String,
    #[serde(
        rename = "error_message",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub error_message: Option<Option<String>>,
    #[serde(
        rename = "execution_time_ms",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub execution_time_ms: Option<Option<i64>>,
    #[serde(rename = "id")]
    pub id: String,
    #[serde(
        rename = "result_id",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub result_id: Option<Option<String>>,
    #[serde(
        rename = "row_count",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub row_count: Option<Option<i64>>,
    /// Total rows read from storage to run this query, before any filtering or aggregation. Distinct from `row_count`, which is how many rows the query returned. `null` when the query reads no table data from storage.
    #[serde(
        rename = "rows_scanned",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub rows_scanned: Option<Option<i64>>,
    #[serde(
        rename = "saved_query_id",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub saved_query_id: Option<Option<String>>,
    #[serde(
        rename = "saved_query_version",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub saved_query_version: Option<Option<i32>>,
    /// Total server-side processing time for this query (milliseconds). Measured from query start to result ready. Includes SQL execution, task spawning, and result preparation. Does not include network transit. Populated for all completed query runs (sync and async).
    #[serde(
        rename = "server_processing_ms",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub server_processing_ms: Option<Option<i64>>,
    #[serde(rename = "snapshot_id")]
    pub snapshot_id: String,
    #[serde(rename = "sql_hash")]
    pub sql_hash: String,
    #[serde(rename = "sql_text")]
    pub sql_text: String,
    #[serde(rename = "status")]
    pub status: String,
    #[serde(
        rename = "trace_id",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub trace_id: Option<Option<String>>,
    /// Caller identity derived from the Authorization Bearer token (SHA-256 hash). Format: `user_{first_10_hex_chars}`.
    #[serde(
        rename = "user_public_id",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub user_public_id: Option<Option<String>>,
    #[serde(
        rename = "warning_message",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub warning_message: Option<Option<String>>,
}

impl QueryRunInfo {
    /// Single query run for listing
    pub fn new(
        created_at: String,
        id: String,
        snapshot_id: String,
        sql_hash: String,
        sql_text: String,
        status: String,
    ) -> QueryRunInfo {
        QueryRunInfo {
            bytes_scanned: None,
            completed_at: None,
            created_at,
            error_message: None,
            execution_time_ms: None,
            id,
            result_id: None,
            row_count: None,
            rows_scanned: None,
            saved_query_id: None,
            saved_query_version: None,
            server_processing_ms: None,
            snapshot_id,
            sql_hash,
            sql_text,
            status,
            trace_id: None,
            user_public_id: None,
            warning_message: None,
        }
    }
}