operator/statement/
set.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
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
// Copyright 2023 Greptime Team
//
// 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 std::time::Duration;

use common_time::Timezone;
use lazy_static::lazy_static;
use regex::Regex;
use session::context::Channel::Postgres;
use session::context::QueryContextRef;
use session::session_config::{PGByteaOutputValue, PGDateOrder, PGDateTimeStyle};
use snafu::{ensure, OptionExt, ResultExt};
use sql::ast::{Expr, Ident, Value};
use sql::statements::set_variables::SetVariables;

use crate::error::{InvalidConfigValueSnafu, InvalidSqlSnafu, NotSupportedSnafu, Result};

lazy_static! {
    // Regex rules:
    // The string must start with a number (one or more digits).
    // The number must be followed by one of the valid time units (ms, s, min, h, d).
    // The string must end immediately after the unit, meaning there can be no extra
    // characters or spaces after the valid time specification.
    static ref PG_TIME_INPUT_REGEX: Regex = Regex::new(r"^(\d+)(ms|s|min|h|d)$").unwrap();
}

pub fn set_timezone(exprs: Vec<Expr>, ctx: QueryContextRef) -> Result<()> {
    let tz_expr = exprs.first().context(NotSupportedSnafu {
        feat: "No timezone find in set variable statement",
    })?;
    match tz_expr {
        Expr::Value(Value::SingleQuotedString(tz)) | Expr::Value(Value::DoubleQuotedString(tz)) => {
            match Timezone::from_tz_string(tz.as_str()) {
                Ok(timezone) => ctx.set_timezone(timezone),
                Err(_) => {
                    return NotSupportedSnafu {
                        feat: format!("Invalid timezone expr {} in set variable statement", tz),
                    }
                    .fail()
                }
            }
            Ok(())
        }
        expr => NotSupportedSnafu {
            feat: format!(
                "Unsupported timezone expr {} in set variable statement",
                expr
            ),
        }
        .fail(),
    }
}

pub fn set_bytea_output(exprs: Vec<Expr>, ctx: QueryContextRef) -> Result<()> {
    let Some((var_value, [])) = exprs.split_first() else {
        return (NotSupportedSnafu {
            feat: "Set variable value must have one and only one value for bytea_output",
        })
        .fail();
    };
    let Expr::Value(value) = var_value else {
        return (NotSupportedSnafu {
            feat: "Set variable value must be a value",
        })
        .fail();
    };
    ctx.configuration_parameter().set_postgres_bytea_output(
        PGByteaOutputValue::try_from(value.clone()).context(InvalidConfigValueSnafu)?,
    );
    Ok(())
}

pub fn validate_client_encoding(set: SetVariables) -> Result<()> {
    let Some((encoding, [])) = set.value.split_first() else {
        return InvalidSqlSnafu {
            err_msg: "must provide one and only one client encoding value",
        }
        .fail();
    };
    let encoding = match encoding {
        Expr::Value(Value::SingleQuotedString(x))
        | Expr::Identifier(Ident {
            value: x,
            quote_style: _,
        }) => x.to_uppercase(),
        _ => {
            return InvalidSqlSnafu {
                err_msg: format!("client encoding must be a string, actual: {:?}", encoding),
            }
            .fail();
        }
    };
    // For the sake of simplicity, we only support "UTF8" ("UNICODE" is the alias for it,
    // see https://www.postgresql.org/docs/current/multibyte.html#MULTIBYTE-CHARSET-SUPPORTED).
    // "UTF8" is universal and sufficient for almost all cases.
    // GreptimeDB itself is always using "UTF8" as the internal encoding.
    ensure!(
        encoding == "UTF8" || encoding == "UNICODE",
        NotSupportedSnafu {
            feat: format!("client encoding of '{}'", encoding)
        }
    );
    Ok(())
}

// if one of original value and new value is none, return the other one
// returns new values only when it equals to original one else return error.
// This is only used for handling datestyle
fn merge_datestyle_value<T>(value: Option<T>, new_value: Option<T>) -> Result<Option<T>>
where
    T: PartialEq,
{
    match (&value, &new_value) {
        (None, _) => Ok(new_value),
        (_, None) => Ok(value),
        (Some(v1), Some(v2)) if v1 == v2 => Ok(new_value),
        _ => InvalidSqlSnafu {
            err_msg: "Conflicting \"datestyle\" specifications.",
        }
        .fail(),
    }
}

fn try_parse_datestyle(expr: &Expr) -> Result<(Option<PGDateTimeStyle>, Option<PGDateOrder>)> {
    enum ParsedDateStyle {
        Order(PGDateOrder),
        Style(PGDateTimeStyle),
    }
    fn try_parse_str(s: &str) -> Result<ParsedDateStyle> {
        PGDateTimeStyle::try_from(s)
            .map_or_else(
                |_| PGDateOrder::try_from(s).map(ParsedDateStyle::Order),
                |style| Ok(ParsedDateStyle::Style(style)),
            )
            .context(InvalidConfigValueSnafu)
    }
    match expr {
        Expr::Identifier(Ident {
            value: s,
            quote_style: _,
        })
        | Expr::Value(Value::SingleQuotedString(s))
        | Expr::Value(Value::DoubleQuotedString(s)) => {
            s.split(',')
                .map(|s| s.trim())
                .try_fold((None, None), |(style, order), s| match try_parse_str(s)? {
                    ParsedDateStyle::Order(o) => {
                        Ok((style, merge_datestyle_value(order, Some(o))?))
                    }
                    ParsedDateStyle::Style(s) => {
                        Ok((merge_datestyle_value(style, Some(s))?, order))
                    }
                })
        }
        _ => NotSupportedSnafu {
            feat: "Not supported expression for datestyle",
        }
        .fail(),
    }
}

pub fn set_datestyle(exprs: Vec<Expr>, ctx: QueryContextRef) -> Result<()> {
    // ORDER,
    // STYLE,
    // ORDER,ORDER
    // ORDER,STYLE
    // STYLE,ORDER
    let (style, order) = exprs
        .iter()
        .try_fold((None, None), |(style, order), expr| {
            let (new_style, new_order) = try_parse_datestyle(expr)?;
            Ok((
                merge_datestyle_value(style, new_style)?,
                merge_datestyle_value(order, new_order)?,
            ))
        })?;

    let (old_style, older_order) = *ctx.configuration_parameter().pg_datetime_style();
    ctx.configuration_parameter()
        .set_pg_datetime_style(style.unwrap_or(old_style), order.unwrap_or(older_order));
    Ok(())
}

pub fn set_query_timeout(exprs: Vec<Expr>, ctx: QueryContextRef) -> Result<()> {
    let timeout_expr = exprs.first().context(NotSupportedSnafu {
        feat: "No timeout value find in set query timeout statement",
    })?;
    match timeout_expr {
        Expr::Value(Value::Number(timeout, _)) => {
            match timeout.parse::<u64>() {
                Ok(timeout) => ctx.set_query_timeout(Duration::from_millis(timeout)),
                Err(_) => {
                    return NotSupportedSnafu {
                        feat: format!("Invalid timeout expr {} in set variable statement", timeout),
                    }
                    .fail()
                }
            }
            Ok(())
        }
        // postgres support time units i.e. SET STATEMENT_TIMEOUT = '50ms';
        Expr::Value(Value::SingleQuotedString(timeout))
        | Expr::Value(Value::DoubleQuotedString(timeout)) => {
            if ctx.channel() != Postgres {
                return NotSupportedSnafu {
                    feat: format!("Invalid timeout expr {} in set variable statement", timeout),
                }
                .fail();
            }
            let timeout = parse_pg_query_timeout_input(timeout)?;
            ctx.set_query_timeout(Duration::from_millis(timeout));
            Ok(())
        }
        expr => NotSupportedSnafu {
            feat: format!(
                "Unsupported timeout expr {} in set variable statement",
                expr
            ),
        }
        .fail(),
    }
}

// support time units in ms, s, min, h, d for postgres protocol.
// https://www.postgresql.org/docs/8.4/config-setting.html#:~:text=Valid%20memory%20units%20are%20kB,%2C%20and%20d%20(days).
fn parse_pg_query_timeout_input(input: &str) -> Result<u64> {
    match input.parse::<u64>() {
        Ok(timeout) => Ok(timeout),
        Err(_) => {
            if let Some(captures) = PG_TIME_INPUT_REGEX.captures(input) {
                let value = captures[1].parse::<u64>().expect("regex failed");
                let unit = &captures[2];

                match unit {
                    "ms" => Ok(value),
                    "s" => Ok(value * 1000),
                    "min" => Ok(value * 60 * 1000),
                    "h" => Ok(value * 60 * 60 * 1000),
                    "d" => Ok(value * 24 * 60 * 60 * 1000),
                    _ => unreachable!("regex failed"),
                }
            } else {
                NotSupportedSnafu {
                    feat: format!(
                        "Unsupported timeout expr {} in set variable statement",
                        input
                    ),
                }
                .fail()
            }
        }
    }
}

#[cfg(test)]
mod test {
    use crate::statement::set::parse_pg_query_timeout_input;

    #[test]
    fn test_parse_pg_query_timeout_input() {
        assert!(parse_pg_query_timeout_input("").is_err());
        assert!(parse_pg_query_timeout_input(" 50 ms").is_err());
        assert!(parse_pg_query_timeout_input("5s 1ms").is_err());
        assert!(parse_pg_query_timeout_input("3a").is_err());
        assert!(parse_pg_query_timeout_input("1.5min").is_err());
        assert!(parse_pg_query_timeout_input("ms").is_err());
        assert!(parse_pg_query_timeout_input("a").is_err());
        assert!(parse_pg_query_timeout_input("-1").is_err());

        assert_eq!(50, parse_pg_query_timeout_input("50").unwrap());
        assert_eq!(12, parse_pg_query_timeout_input("12ms").unwrap());
        assert_eq!(2000, parse_pg_query_timeout_input("2s").unwrap());
        assert_eq!(60000, parse_pg_query_timeout_input("1min").unwrap());
    }
}