forked from databendlabs/databend
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathparser.rs
More file actions
385 lines (342 loc) · 12.1 KB
/
Copy pathparser.rs
File metadata and controls
385 lines (342 loc) · 12.1 KB
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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
// 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 nom::Parser;
use crate::ParseError;
use crate::Result;
use crate::ast::*;
use crate::parser::Backtrace;
use crate::parser::common::IResult;
use crate::parser::common::comma_separated_list0;
use crate::parser::common::comma_separated_list1;
use crate::parser::common::database_ref;
use crate::parser::common::ident;
use crate::parser::common::table_ref;
use crate::parser::common::transform_span;
use crate::parser::error::display_parser_error;
use crate::parser::expr::expr;
use crate::parser::expr::values;
use crate::parser::input::Dialect;
use crate::parser::input::Input;
use crate::parser::input::ParseMode;
use crate::parser::statement::insert_stmt;
use crate::parser::statement::procedure_type_name;
use crate::parser::statement::replace_stmt;
use crate::parser::statement::statement;
use crate::parser::token::Token;
use crate::parser::token::TokenKind;
use crate::parser::token::Tokenizer;
pub fn tokenize_sql(sql: &str) -> Result<Vec<Token<'_>>> {
let mut tokens = Vec::with_capacity((sql.len() / 4).clamp(4, 256));
for token in Tokenizer::new(sql) {
tokens.push(token?);
}
Ok(tokens)
}
/// Parse a SQL string into `Statement`s.
#[fastrace::trace]
pub fn parse_sql(tokens: &[Token], dialect: Dialect) -> Result<(Statement, Option<String>)> {
let stmt = run_parser(tokens, dialect, ParseMode::Default, false, statement)?;
#[cfg(debug_assertions)]
if let Err(message) = assert_reparse(tokens[0].source, stmt.clone()) {
eprintln!("[WARN] {message}");
}
Ok((stmt.stmt, stmt.format))
}
/// Parse udf function into Expr
pub fn parse_expr(tokens: &[Token], dialect: Dialect) -> Result<Expr> {
run_parser(tokens, dialect, ParseMode::Default, false, expr)
}
/// Parse a table reference string like "table", "db.table", or "catalog.db.table".
/// Correctly handles quoted identifiers like `"my.weird.table"`.
pub fn parse_table_ref(sql: &str, dialect: Dialect) -> Result<TableRef> {
let tokens = tokenize_sql(sql)?;
run_parser(&tokens, dialect, ParseMode::Default, false, table_ref)
}
/// Parse a database reference string like "db" or "catalog.db".
/// Correctly handles quoted identifiers.
pub fn parse_database_ref(sql: &str, dialect: Dialect) -> Result<DatabaseRef> {
let tokens = tokenize_sql(sql)?;
run_parser(&tokens, dialect, ParseMode::Default, false, database_ref)
}
/// Parse a procedure reference string like "my_proc(INT, STRING)" or "my_proc()".
/// Returns a `ProcedureIdentity` with the procedure name and argument types.
pub fn parse_procedure_ref(sql: &str, dialect: Dialect) -> Result<ProcedureIdentity> {
let tokens = tokenize_sql(sql)?;
run_parser(&tokens, dialect, ParseMode::Default, false, |i| {
nom::combinator::map(
nom::sequence::pair(ident, procedure_type_name),
|(name, args_type): (Identifier, _)| ProcedureIdentity {
name: name.to_string(),
args_type,
},
)
.parse(i)
})
}
/// Parse a UDF name string (a single identifier).
/// Rejects trailing tokens to avoid silently ignoring malformed input.
pub fn parse_udf_ref(sql: &str, dialect: Dialect) -> Result<Identifier> {
let tokens = tokenize_sql(sql)?;
run_parser(&tokens, dialect, ParseMode::Default, false, ident)
}
pub fn parse_comma_separated_exprs(tokens: &[Token], dialect: Dialect) -> Result<Vec<Expr>> {
run_parser(tokens, dialect, ParseMode::Default, true, |i| {
comma_separated_list0(expr)(i)
})
}
pub fn parse_comma_separated_idents(tokens: &[Token], dialect: Dialect) -> Result<Vec<Identifier>> {
run_parser(tokens, dialect, ParseMode::Default, true, |i| {
comma_separated_list1(ident).parse(i)
})
}
pub fn parse_values(tokens: &[Token], dialect: Dialect) -> Result<Vec<Expr>> {
run_parser(tokens, dialect, ParseMode::Default, false, values)
}
pub fn parse_cluster_key_exprs(cluster_key: &str) -> Result<Vec<Expr>> {
// `cluster_key` is persisted in table metadata and may be created/rewritten under a
// different session dialect. Parse it with a dialect that accepts both identifier
// quote styles to keep ALTER behavior stable across sessions.
let tokens = tokenize_sql(cluster_key)?;
let mut ast_exprs = parse_comma_separated_exprs(&tokens, Dialect::default())?;
// unwrap tuple.
if ast_exprs.len() == 1
&& let Expr::Tuple { exprs, .. } = &ast_exprs[0]
{
ast_exprs = exprs.clone();
}
Ok(ast_exprs)
}
pub fn parse_raw_insert_stmt(
tokens: &[Token],
dialect: Dialect,
in_streaming_load: bool,
) -> Result<Statement> {
run_parser(
tokens,
dialect,
ParseMode::Default,
false,
insert_stmt(true, in_streaming_load),
)
}
pub fn parse_raw_replace_stmt(tokens: &[Token], dialect: Dialect) -> Result<Statement> {
run_parser(
tokens,
dialect,
ParseMode::Default,
false,
replace_stmt(true),
)
}
pub fn run_parser<O>(
tokens: &[Token],
dialect: Dialect,
mode: ParseMode,
allow_partial: bool,
mut parser: impl FnMut(Input) -> IResult<O>,
) -> Result<O> {
let backtrace = Backtrace::disabled();
let input = Input {
tokens,
dialect,
mode,
backtrace: &backtrace,
};
match parser(input) {
Ok((rest, res)) => {
let is_complete = rest[0].kind == TokenKind::EOI;
if is_complete || allow_partial {
Ok(res)
} else {
Err(ParseError(
transform_span(&rest[..1]),
format!(
"unable to parse rest of the sql, rest tokens: {:?} ",
rest.tokens
),
))
}
}
Err(nom::Err::Error(err) | nom::Err::Failure(err)) => {
let source = tokens[0].source;
let backtrace = Backtrace::new();
let input = Input {
tokens,
dialect,
mode,
backtrace: &backtrace,
};
let err = match parser(input) {
Err(nom::Err::Error(err) | nom::Err::Failure(err)) => err,
Ok(_) => err,
Err(nom::Err::Incomplete(_)) => unreachable!(),
};
Err(ParseError(None, display_parser_error(err, source)))
}
Err(nom::Err::Incomplete(_)) => unreachable!(),
}
}
/// Check that the statement can be displayed and reparsed without loss
#[cfg(debug_assertions)]
fn assert_reparse(sql: &str, stmt: StatementWithFormat) -> std::result::Result<(), String> {
let stmt = reset_ast(stmt);
let normalized_sql = stmt.to_string();
let new_tokens = crate::parser::tokenize_sql(&normalized_sql).map_err(|err| {
format!(
"failed to tokenize round-tripped SQL: {} in {}",
err.1, normalized_sql
)
})?;
let new_stmt = run_parser(
&new_tokens,
Dialect::PostgreSQL,
ParseMode::Default,
false,
statement,
)
.map_err(|err| {
format!(
"failed to reparse round-tripped SQL: {} in {}",
err.1, normalized_sql
)
})?;
let reparsed_sql = reset_ast(new_stmt).to_string();
if normalized_sql != reparsed_sql {
return Err(format!(
"statement changed after round-tripping.\noriginal:\n{}\nnormalized:\n{}\nreparsed:\n{}",
sql, normalized_sql, reparsed_sql
));
}
Ok(())
}
#[cfg(debug_assertions)]
fn reset_ast(mut stmt: StatementWithFormat) -> StatementWithFormat {
use crate::visit::VisitControl;
use crate::visit::VisitorMut;
use crate::visit::WalkMut;
struct ResetAst;
impl ResetAst {
fn reset_select_targets(select_list: &mut [SelectTarget]) {
for target in select_list {
if let SelectTarget::StarColumns { column_filter, .. } = target {
*column_filter = None;
}
}
}
fn is_grouping_wrapper(query: &Query) -> bool {
query.with.is_none()
&& query.order_by.is_empty()
&& query.limit.is_empty()
&& query.offset.is_none()
&& !query.ignore_result
}
}
impl VisitorMut for ResetAst {
fn visit_statement(
&mut self,
stmt: &mut Statement,
) -> std::result::Result<VisitControl, !> {
if let Statement::CreateTag(stmt) = stmt
&& let Some(allowed_values) = &mut stmt.allowed_values
{
for value in allowed_values {
*value = Literal::Null;
}
}
Ok(VisitControl::Continue)
}
fn visit_set_expr(
&mut self,
set_expr: &mut SetExpr,
) -> std::result::Result<VisitControl, !> {
let collapsed = match set_expr {
SetExpr::Query(query) if Self::is_grouping_wrapper(query) => {
Some(query.body.clone())
}
_ => None,
};
if let Some(body) = collapsed {
*set_expr = body;
}
Ok(VisitControl::Continue)
}
fn visit_select_stmt(
&mut self,
select: &mut crate::ast::SelectStmt,
) -> std::result::Result<VisitControl, !> {
Self::reset_select_targets(&mut select.select_list);
Ok(VisitControl::Continue)
}
fn visit_expr(&mut self, expr: &mut Expr) -> std::result::Result<VisitControl, !> {
match expr {
Expr::Literal { value, .. } => {
*value = Literal::Null;
}
Expr::Map { kvs, .. } => {
for (key, _) in kvs {
*key = Literal::Null;
}
}
_ => {}
}
Ok(VisitControl::Continue)
}
}
let _ = stmt.stmt.walk_mut(&mut ResetAst);
stmt
}
#[cfg(test)]
mod tests {
use super::*;
fn parse_statement_with_format(sql: &str) -> StatementWithFormat {
let tokens = tokenize_sql(sql).unwrap();
run_parser(
&tokens,
Dialect::PostgreSQL,
ParseMode::Default,
false,
statement,
)
.unwrap()
}
#[test]
fn test_reset_ast_normalizes_select_star_filters_and_literals() {
let stmt = reset_ast(parse_statement_with_format(
"SELECT * EXCLUDE (c1), 1, 'x' FROM customer",
));
assert_eq!(stmt.to_string(), "SELECT *, NULL, NULL FROM customer");
}
#[test]
fn test_reset_ast_normalizes_tag_allowed_values() {
let stmt = reset_ast(parse_statement_with_format(
"CREATE TAG IF NOT EXISTS tag_a ALLOWED_VALUES = ('dev', 'prod') COMMENT = 'environment tag'",
));
assert_eq!(
stmt.to_string(),
"CREATE TAG IF NOT EXISTS tag_a ALLOWED_VALUES = (NULL, NULL) COMMENT = 'environment tag'"
);
}
#[test]
fn test_assert_reparse_uses_normalized_sql_fixpoint() {
let sql = "SELECT * EXCLUDE (c1), 1 FROM customer";
let stmt = parse_statement_with_format(sql);
assert!(assert_reparse(sql, stmt).is_ok());
}
#[test]
fn test_assert_reparse_unset_workload_group_quotas_list() {
let sql = "ALTER WORKLOAD GROUP wg UNSET (cpu_quota, max_concurrency)";
let stmt = parse_statement_with_format(sql);
assert!(assert_reparse(sql, stmt).is_ok());
}
}