risingwave_sqlparser/
parser.rs

1// Licensed under the Apache License, Version 2.0 (the "License");
2// you may not use this file except in compliance with the License.
3// You may obtain a copy of the License at
4//
5//     http://www.apache.org/licenses/LICENSE-2.0
6//
7// Unless required by applicable law or agreed to in writing, software
8// distributed under the License is distributed on an "AS IS" BASIS,
9// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10// See the License for the specific language governing permissions and
11// limitations under the License.
12
13//! SQL Parser
14
15use std::fmt;
16
17use ddl::WebhookSourceInfo;
18use itertools::Itertools;
19use tracing::{debug, instrument};
20use winnow::combinator::{
21    alt, cut_err, dispatch, fail, opt, peek, preceded, repeat, separated, separated_pair,
22};
23use winnow::{ModalResult, Parser as _};
24
25use crate::ast::*;
26use crate::keywords::{self, Keyword};
27use crate::parser_v2::{
28    ParserExt as _, dollar_quoted_string, keyword, literal_i64, literal_u32, literal_u64,
29    single_quoted_string,
30};
31use crate::tokenizer::*;
32use crate::{impl_parse_to, parser_v2};
33
34pub(crate) const UPSTREAM_SOURCE_KEY: &str = "connector";
35pub(crate) const WEBHOOK_CONNECTOR: &str = "webhook";
36
37const WEBHOOK_WAIT_FOR_PERSISTENCE: &str = "webhook.wait_for_persistence";
38const WEBHOOK_IS_BATCHED: &str = "is_batched";
39
40#[derive(Debug, Clone, PartialEq)]
41pub enum ParserError {
42    TokenizerError(String),
43    ParserError(String),
44}
45
46impl ParserError {
47    pub fn inner_msg(self) -> String {
48        match self {
49            ParserError::TokenizerError(s) | ParserError::ParserError(s) => s,
50        }
51    }
52}
53
54#[derive(Debug, thiserror::Error)]
55#[error("{0}")]
56pub struct StrError(pub String);
57
58// Use `Parser::expected` instead, if possible
59#[macro_export]
60macro_rules! parser_err {
61    ($($arg:tt)*) => {
62        return Err(winnow::error::ErrMode::Backtrack(<winnow::error::ContextError as winnow::error::FromExternalError<_, _>>::from_external_error(
63            &Parser::default(),
64            $crate::parser::StrError(format!($($arg)*)),
65        )))
66    };
67}
68
69impl From<StrError> for winnow::error::ErrMode<winnow::error::ContextError> {
70    fn from(e: StrError) -> Self {
71        winnow::error::ErrMode::Backtrack(<winnow::error::ContextError as winnow::error::FromExternalError<_, _>>::from_external_error(
72            &Parser::default(),
73            e,
74        ))
75    }
76}
77
78// Returns a successful result if the optional expression is some
79macro_rules! return_ok_if_some {
80    ($e:expr) => {{
81        if let Some(v) = $e {
82            return Ok(v);
83        }
84    }};
85}
86
87#[derive(PartialEq)]
88pub enum IsOptional {
89    Optional,
90    Mandatory,
91}
92
93use IsOptional::*;
94
95pub enum IsLateral {
96    Lateral,
97    NotLateral,
98}
99
100use IsLateral::*;
101
102use crate::ast::ddl::AlterFragmentOperation;
103
104pub type IncludeOption = Vec<IncludeOptionItem>;
105
106#[derive(Eq, Clone, Debug, PartialEq, Hash)]
107pub struct IncludeOptionItem {
108    pub column_type: Ident,
109    pub column_alias: Option<Ident>,
110    pub inner_field: Option<String>,
111    pub header_inner_expect_type: Option<DataType>,
112}
113
114#[derive(Debug)]
115pub enum WildcardOrExpr {
116    Expr(Expr),
117    /// Expr is an arbitrary expression, returning either a table or a column.
118    /// Idents are the prefix of `*`, which are consecutive field accesses.
119    /// e.g. `(table.v1).*` or `(table).v1.*`
120    ///
121    /// See also [`Expr::FieldIdentifier`] for behaviors of parentheses.
122    ExprQualifiedWildcard(Expr, Vec<Ident>),
123    /// `QualifiedWildcard` and `Wildcard` can be followed by EXCEPT (columns)
124    QualifiedWildcard(ObjectName, Option<Vec<Expr>>),
125    Wildcard(Option<Vec<Expr>>),
126}
127
128impl From<WildcardOrExpr> for FunctionArgExpr {
129    fn from(wildcard_expr: WildcardOrExpr) -> Self {
130        match wildcard_expr {
131            WildcardOrExpr::Expr(expr) => Self::Expr(expr),
132            WildcardOrExpr::ExprQualifiedWildcard(expr, prefix) => {
133                Self::ExprQualifiedWildcard(expr, prefix)
134            }
135            WildcardOrExpr::QualifiedWildcard(prefix, except) => {
136                Self::QualifiedWildcard(prefix, except)
137            }
138            WildcardOrExpr::Wildcard(except) => Self::Wildcard(except),
139        }
140    }
141}
142
143impl From<TokenizerError> for ParserError {
144    fn from(e: TokenizerError) -> Self {
145        ParserError::TokenizerError(e.to_string())
146    }
147}
148
149impl fmt::Display for ParserError {
150    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
151        write!(
152            f,
153            "sql parser error: {}",
154            match self {
155                ParserError::TokenizerError(s) => s,
156                ParserError::ParserError(s) => s,
157            }
158        )
159    }
160}
161
162impl std::error::Error for ParserError {}
163
164type ColumnsDefTuple = (
165    Vec<ColumnDef>,
166    Vec<TableConstraint>,
167    Vec<SourceWatermark>,
168    Option<usize>,
169);
170
171/// Reference:
172/// <https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-PRECEDENCE>
173#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
174pub enum Precedence {
175    Zero = 0,
176    LogicalOr, // 5 in upstream
177    LogicalXor,
178    LogicalAnd, // 10 in upstream
179    UnaryNot,   // 15 in upstream
180    Is,         // 17 in upstream
181    Cmp,
182    Like,    // 19 in upstream
183    Between, // 20 in upstream
184    Other,
185    PlusMinus, // 30 in upstream
186    MulDiv,    // 40 in upstream
187    Exp,
188    At,
189    Collate,
190    UnaryPosNeg,
191    Array,
192    DoubleColon, // 50 in upstream
193}
194
195#[derive(Clone, Copy, Default)]
196pub struct Parser<'a>(pub(crate) &'a [TokenWithLocation]);
197
198impl Parser<'_> {
199    /// Parse a SQL statement and produce an Abstract Syntax Tree (AST)
200    #[instrument(level = "debug")]
201    pub fn parse_sql(sql: &str) -> Result<Vec<Statement>, ParserError> {
202        let mut tokenizer = Tokenizer::new(sql);
203        let tokens = tokenizer.tokenize_with_location()?;
204        let parser = Parser(&tokens);
205        let stmts = Parser::parse_statements.parse(parser).map_err(|e| {
206            // append SQL context to the error message, e.g.:
207            // LINE 1: SELECT 1::int(2);
208            let loc = match tokens.get(e.offset()) {
209                Some(token) => token.location.clone(),
210                None => {
211                    // get location of EOF
212                    Location {
213                        line: sql.lines().count() as u64,
214                        column: sql.lines().last().map_or(0, |l| l.len() as u64) + 1,
215                    }
216                }
217            };
218            let prefix = format!("LINE {}: ", loc.line);
219            let sql_line = sql.split('\n').nth(loc.line as usize - 1).unwrap();
220            let cursor = " ".repeat(prefix.len() + loc.column as usize - 1);
221            ParserError::ParserError(format!(
222                "{}\n{}{}\n{}^",
223                e.inner().to_string().replace('\n', ": "),
224                prefix,
225                sql_line,
226                cursor
227            ))
228        })?;
229        Ok(stmts)
230    }
231
232    /// Parse exactly one statement from a string.
233    pub fn parse_exactly_one(sql: &str) -> Result<Statement, ParserError> {
234        Parser::parse_sql(sql)
235            .map_err(|e| {
236                ParserError::ParserError(format!("failed to parse definition sql: {}", e))
237            })?
238            .into_iter()
239            .exactly_one()
240            .map_err(|e| {
241                ParserError::ParserError(format!(
242                    "expecting exactly one statement in definition: {}",
243                    e
244                ))
245            })
246    }
247
248    /// Parse object name from a string.
249    pub fn parse_object_name_str(s: &str) -> Result<ObjectName, ParserError> {
250        let mut tokenizer = Tokenizer::new(s);
251        let tokens = tokenizer.tokenize_with_location()?;
252        let parser = Parser(&tokens);
253        Parser::parse_object_name
254            .parse(parser)
255            .map_err(|e| ParserError::ParserError(e.inner().to_string()))
256    }
257
258    /// Parse function description from a string.
259    pub fn parse_function_desc_str(func: &str) -> Result<FunctionDesc, ParserError> {
260        let mut tokenizer = Tokenizer::new(func);
261        let tokens = tokenizer.tokenize_with_location()?;
262        let parser = Parser(&tokens);
263        Parser::parse_function_desc
264            .parse(parser)
265            .map_err(|e| ParserError::ParserError(e.inner().to_string()))
266    }
267
268    /// Parse a list of semicolon-separated statements.
269    fn parse_statements(&mut self) -> ModalResult<Vec<Statement>> {
270        let mut stmts = Vec::new();
271        let mut expecting_statement_delimiter = false;
272        loop {
273            // ignore empty statements (between successive statement delimiters)
274            while self.consume_token(&Token::SemiColon) {
275                expecting_statement_delimiter = false;
276            }
277
278            if self.peek_token() == Token::EOF {
279                break;
280            }
281            if expecting_statement_delimiter {
282                return self.expected("end of statement");
283            }
284
285            let statement = self.parse_statement()?;
286            stmts.push(statement);
287            expecting_statement_delimiter = true;
288        }
289        debug!("parsed statements:\n{:#?}", stmts);
290        Ok(stmts)
291    }
292
293    /// Parse a single top-level statement (such as SELECT, INSERT, CREATE, etc.),
294    /// stopping before the statement separator, if any.
295    pub fn parse_statement(&mut self) -> ModalResult<Statement> {
296        let checkpoint = *self;
297        let token = self.next_token();
298        match token.token {
299            Token::Word(w) => match w.keyword {
300                Keyword::EXPLAIN => Ok(self.parse_explain()?),
301                Keyword::ANALYZE => Ok(self.parse_analyze()?),
302                Keyword::SELECT | Keyword::WITH | Keyword::VALUES => {
303                    *self = checkpoint;
304                    Ok(Statement::Query(Box::new(self.parse_query()?)))
305                }
306                Keyword::DECLARE => Ok(self.parse_declare()?),
307                Keyword::FETCH => Ok(self.parse_fetch_cursor()?),
308                Keyword::CLOSE => Ok(self.parse_close_cursor()?),
309                Keyword::TRUNCATE => Ok(self.parse_truncate()?),
310                Keyword::REFRESH => Ok(self.parse_refresh()?),
311                Keyword::CREATE => Ok(self.parse_create()?),
312                Keyword::DISCARD => Ok(self.parse_discard()?),
313                Keyword::DROP => Ok(self.parse_drop()?),
314                Keyword::DELETE => Ok(self.parse_delete()?),
315                Keyword::INSERT => Ok(self.parse_insert()?),
316                Keyword::UPDATE => Ok(self.parse_update()?),
317                Keyword::ALTER => Ok(self.parse_alter()?),
318                Keyword::COPY => Ok(self.parse_copy()?),
319                Keyword::SET => Ok(self.parse_set()?),
320                Keyword::SHOW => {
321                    if self.parse_keyword(Keyword::CREATE) {
322                        Ok(self.parse_show_create()?)
323                    } else {
324                        Ok(self.parse_show()?)
325                    }
326                }
327                Keyword::CANCEL => Ok(self.parse_cancel_job()?),
328                Keyword::KILL => Ok(self.parse_kill_process()?),
329                Keyword::DESCRIBE => Ok(self.parse_describe()?),
330                Keyword::GRANT => Ok(self.parse_grant()?),
331                Keyword::REVOKE => Ok(self.parse_revoke()?),
332                Keyword::START => Ok(self.parse_start_transaction()?),
333                Keyword::ABORT => Ok(Statement::Abort),
334                // `BEGIN` is a nonstandard but common alias for the
335                // standard `START TRANSACTION` statement. It is supported
336                // by at least PostgreSQL and MySQL.
337                Keyword::BEGIN => Ok(self.parse_begin()?),
338                Keyword::COMMIT => Ok(self.parse_commit()?),
339                Keyword::ROLLBACK => Ok(self.parse_rollback()?),
340                // `PREPARE`, `EXECUTE` and `DEALLOCATE` are Postgres-specific
341                // syntaxes. They are used for Postgres prepared statement.
342                Keyword::DEALLOCATE => Ok(self.parse_deallocate()?),
343                Keyword::EXECUTE => Ok(self.parse_execute()?),
344                Keyword::PREPARE => Ok(self.parse_prepare()?),
345                Keyword::COMMENT => Ok(self.parse_comment()?),
346                Keyword::FLUSH => Ok(Statement::Flush),
347                Keyword::WAIT => Ok(Statement::Wait),
348                Keyword::RECOVER => Ok(Statement::Recover),
349                Keyword::USE => Ok(self.parse_use()?),
350                Keyword::VACUUM => Ok(self.parse_vacuum()?),
351                _ => self.expected_at(checkpoint, "statement"),
352            },
353            Token::LParen => {
354                *self = checkpoint;
355                Ok(Statement::Query(Box::new(self.parse_query()?)))
356            }
357            _ => self.expected_at(checkpoint, "statement"),
358        }
359    }
360
361    pub fn parse_truncate(&mut self) -> ModalResult<Statement> {
362        let _ = self.parse_keyword(Keyword::TABLE);
363        let table_name = self.parse_object_name()?;
364        Ok(Statement::Truncate { table_name })
365    }
366
367    pub fn parse_refresh(&mut self) -> ModalResult<Statement> {
368        self.expect_keyword(Keyword::TABLE)?;
369        let table_name = self.parse_object_name()?;
370        Ok(Statement::Refresh { table_name })
371    }
372
373    pub fn parse_analyze(&mut self) -> ModalResult<Statement> {
374        let table_name = self.parse_object_name()?;
375
376        Ok(Statement::Analyze { table_name })
377    }
378
379    pub fn parse_vacuum(&mut self) -> ModalResult<Statement> {
380        let full = self.parse_keyword(Keyword::FULL);
381        let object_name = self.parse_object_name()?;
382
383        Ok(Statement::Vacuum { object_name, full })
384    }
385
386    /// Tries to parse a wildcard expression. If it is not a wildcard, parses an expression.
387    ///
388    /// A wildcard expression either means:
389    /// - Selecting all fields from a struct. In this case, it is a
390    ///   [`WildcardOrExpr::ExprQualifiedWildcard`]. Similar to [`Expr::FieldIdentifier`], It must
391    ///   contain parentheses.
392    /// - Selecting all columns from a table. In this case, it is a
393    ///   [`WildcardOrExpr::QualifiedWildcard`] or a [`WildcardOrExpr::Wildcard`].
394    pub fn parse_wildcard_or_expr(&mut self) -> ModalResult<WildcardOrExpr> {
395        let checkpoint = *self;
396
397        match self.next_token().token {
398            Token::Word(w) if self.peek_token() == Token::Period => {
399                // Since there's no parenthesis, `w` must be a column or a table
400                // So what follows must be dot-delimited identifiers, e.g. `a.b.c.*`
401                let wildcard_expr = self.parse_simple_wildcard_expr(checkpoint)?;
402                return self.word_concat_wildcard_expr(w.to_ident()?, wildcard_expr);
403            }
404            Token::Mul => {
405                return Ok(WildcardOrExpr::Wildcard(self.parse_except()?));
406            }
407            // parses wildcard field selection expression.
408            // Code is similar to `parse_struct_selection`
409            Token::LParen => {
410                let mut expr = self.parse_expr()?;
411                if self.consume_token(&Token::RParen) {
412                    // Unwrap parentheses
413                    while let Expr::Nested(inner) = expr {
414                        expr = *inner;
415                    }
416                    // Now that we have an expr, what follows must be
417                    // dot-delimited identifiers, e.g. `b.c.*` in `(a).b.c.*`
418                    let wildcard_expr = self.parse_simple_wildcard_expr(checkpoint)?;
419                    return self.expr_concat_wildcard_expr(expr, wildcard_expr);
420                }
421            }
422            _ => (),
423        };
424
425        *self = checkpoint;
426        self.parse_expr().map(WildcardOrExpr::Expr)
427    }
428
429    /// Concats `ident` and `wildcard_expr` in `ident.wildcard_expr`
430    pub fn word_concat_wildcard_expr(
431        &mut self,
432        ident: Ident,
433        simple_wildcard_expr: WildcardOrExpr,
434    ) -> ModalResult<WildcardOrExpr> {
435        let mut idents = vec![ident];
436        let mut except_cols = vec![];
437        match simple_wildcard_expr {
438            WildcardOrExpr::QualifiedWildcard(ids, except) => {
439                idents.extend(ids.0);
440                if let Some(cols) = except {
441                    except_cols = cols;
442                }
443            }
444            WildcardOrExpr::Wildcard(except) => {
445                if let Some(cols) = except {
446                    except_cols = cols;
447                }
448            }
449            WildcardOrExpr::ExprQualifiedWildcard(_, _) => unreachable!(),
450            WildcardOrExpr::Expr(e) => return Ok(WildcardOrExpr::Expr(e)),
451        }
452        Ok(WildcardOrExpr::QualifiedWildcard(
453            ObjectName(idents),
454            if except_cols.is_empty() {
455                None
456            } else {
457                Some(except_cols)
458            },
459        ))
460    }
461
462    /// Concats `expr` and `wildcard_expr` in `(expr).wildcard_expr`.
463    pub fn expr_concat_wildcard_expr(
464        &mut self,
465        expr: Expr,
466        simple_wildcard_expr: WildcardOrExpr,
467    ) -> ModalResult<WildcardOrExpr> {
468        if let WildcardOrExpr::Expr(e) = simple_wildcard_expr {
469            return Ok(WildcardOrExpr::Expr(e));
470        }
471
472        // similar to `parse_struct_selection`
473        let mut idents = vec![];
474        let expr = match expr {
475            // expr is `(foo)`
476            Expr::Identifier(_) => expr,
477            // expr is `(foo.v1)`
478            Expr::CompoundIdentifier(_) => expr,
479            // expr is `((1,2,3)::foo)`
480            Expr::Cast { .. } => expr,
481            // expr is `(func())`
482            Expr::Function(_) => expr,
483            // expr is `((foo.v1).v2)`
484            Expr::FieldIdentifier(expr, ids) => {
485                // Put `ids` to the latter part!
486                idents.extend(ids);
487                *expr
488            }
489            // expr is other things, e.g., `(1+2)`. It will become an unexpected period error at
490            // upper level.
491            _ => return Ok(WildcardOrExpr::Expr(expr)),
492        };
493
494        match simple_wildcard_expr {
495            WildcardOrExpr::QualifiedWildcard(ids, except) => {
496                if except.is_some() {
497                    return self.expected("Expr quantified wildcard does not support except");
498                }
499                idents.extend(ids.0);
500            }
501            WildcardOrExpr::Wildcard(except) => {
502                if except.is_some() {
503                    return self.expected("Expr quantified wildcard does not support except");
504                }
505            }
506            WildcardOrExpr::ExprQualifiedWildcard(_, _) => unreachable!(),
507            WildcardOrExpr::Expr(_) => unreachable!(),
508        }
509        Ok(WildcardOrExpr::ExprQualifiedWildcard(expr, idents))
510    }
511
512    /// Tries to parses a wildcard expression without any parentheses.
513    ///
514    /// If wildcard is not found, go back to `index` and parse an expression.
515    pub fn parse_simple_wildcard_expr(&mut self, checkpoint: Self) -> ModalResult<WildcardOrExpr> {
516        let mut id_parts = vec![];
517        while self.consume_token(&Token::Period) {
518            let ckpt = *self;
519            let token = self.next_token();
520            match token.token {
521                Token::Word(w) => id_parts.push(w.to_ident()?),
522                Token::Mul => {
523                    return if id_parts.is_empty() {
524                        Ok(WildcardOrExpr::Wildcard(self.parse_except()?))
525                    } else {
526                        Ok(WildcardOrExpr::QualifiedWildcard(
527                            ObjectName(id_parts),
528                            self.parse_except()?,
529                        ))
530                    };
531                }
532                _ => {
533                    *self = ckpt;
534                    return self.expected("an identifier or a '*' after '.'");
535                }
536            }
537        }
538        *self = checkpoint;
539        self.parse_expr().map(WildcardOrExpr::Expr)
540    }
541
542    pub fn parse_except(&mut self) -> ModalResult<Option<Vec<Expr>>> {
543        if !self.parse_keyword(Keyword::EXCEPT) {
544            return Ok(None);
545        }
546        if !self.consume_token(&Token::LParen) {
547            return self.expected("EXCEPT should be followed by (");
548        }
549        let exprs = self.parse_comma_separated(Parser::parse_expr)?;
550        if self.consume_token(&Token::RParen) {
551            Ok(Some(exprs))
552        } else {
553            self.expected("( should be followed by ) after column names")
554        }
555    }
556
557    /// Parse a new expression
558    pub fn parse_expr(&mut self) -> ModalResult<Expr> {
559        self.parse_subexpr(Precedence::Zero)
560    }
561
562    /// Parse tokens until the precedence changes
563    pub fn parse_subexpr(&mut self, precedence: Precedence) -> ModalResult<Expr> {
564        debug!("parsing expr, current token: {:?}", self.peek_token().token);
565        let mut expr = self.parse_prefix()?;
566        debug!("prefix: {:?}", expr);
567        loop {
568            let next_precedence = self.get_next_precedence()?;
569            debug!("precedence: {precedence:?}, next precedence: {next_precedence:?}");
570
571            if precedence >= next_precedence {
572                break;
573            }
574
575            expr = self.parse_infix(expr, next_precedence)?;
576        }
577        Ok(expr)
578    }
579
580    /// Parse an expression prefix
581    pub fn parse_prefix(&mut self) -> ModalResult<Expr> {
582        // PostgreSQL allows any string literal to be preceded by a type name, indicating that the
583        // string literal represents a literal of that type. Some examples:
584        //
585        //      DATE '2020-05-20'
586        //      TIMESTAMP WITH TIME ZONE '2020-05-20 7:43:54'
587        //      BOOL 'true'
588        //
589        // The first two are standard SQL, while the latter is a PostgreSQL extension. Complicating
590        // matters is the fact that INTERVAL string literals may optionally be followed by special
591        // keywords, e.g.:
592        //
593        //      INTERVAL '7' DAY
594        //
595        // Note also that naively `SELECT date` looks like a syntax error because the `date` type
596        // name is not followed by a string literal, but in fact in PostgreSQL it is a valid
597        // expression that should parse as the column name "date".
598        return_ok_if_some!(self.maybe_parse(|parser| {
599            match parser.parse_data_type()? {
600                DataType::Interval => parser.parse_literal_interval(),
601                // PostgreSQL allows almost any identifier to be used as custom data type name,
602                // and we support that in `parse_data_type()`. But unlike Postgres we don't
603                // have a list of globally reserved keywords (since they vary across dialects),
604                // so given `NOT 'a' LIKE 'b'`, we'd accept `NOT` as a possible custom data type
605                // name, resulting in `NOT 'a'` being recognized as a `TypedString` instead of
606                // an unary negation `NOT ('a' LIKE 'b')`. To solve this, we don't accept the
607                // `type 'string'` syntax for the custom data types at all.
608                DataType::Custom(..) => parser_err!("dummy"),
609                data_type => Ok(Expr::TypedString {
610                    data_type,
611                    value: parser.parse_literal_string()?,
612                }),
613            }
614        }));
615
616        let checkpoint = *self;
617        let token = self.next_token();
618        let expr = match token.token.clone() {
619            Token::Word(w) => match w.keyword {
620                Keyword::TRUE | Keyword::FALSE | Keyword::NULL => {
621                    *self = checkpoint;
622                    Ok(Expr::Value(self.ensure_parse_value()?))
623                }
624                Keyword::CASE => self.parse_case_expr(),
625                Keyword::CAST => self.parse_cast_expr(),
626                Keyword::TRY_CAST => self.parse_try_cast_expr(),
627                Keyword::EXISTS => self.parse_exists_expr(),
628                Keyword::EXTRACT => self.parse_extract_expr(),
629                Keyword::SUBSTRING => self.parse_substring_expr(),
630                Keyword::POSITION => self.parse_position_expr(),
631                Keyword::OVERLAY => self.parse_overlay_expr(),
632                Keyword::TRIM => self.parse_trim_expr(),
633                Keyword::INTERVAL => self.parse_literal_interval(),
634                Keyword::NOT => Ok(Expr::UnaryOp {
635                    op: UnaryOperator::Not,
636                    expr: Box::new(self.parse_subexpr(Precedence::UnaryNot)?),
637                }),
638                Keyword::ROW => self.parse_row_expr(),
639                Keyword::ARRAY if self.peek_token() == Token::LParen => {
640                    // similar to `exists(subquery)`
641                    self.expect_token(&Token::LParen)?;
642                    let exists_node = Expr::ArraySubquery(Box::new(self.parse_query()?));
643                    self.expect_token(&Token::RParen)?;
644                    Ok(exists_node)
645                }
646                Keyword::ARRAY if self.peek_token() == Token::LBracket => self.parse_array_expr(),
647                Keyword::MAP if self.peek_token() == Token::LBrace => self.parse_map_expr(),
648                // `LEFT` and `RIGHT` are reserved as identifier but okay as function
649                Keyword::LEFT | Keyword::RIGHT => {
650                    *self = checkpoint;
651                    self.parse_function()
652                }
653                Keyword::OPERATOR if self.peek_token().token == Token::LParen => {
654                    let op = UnaryOperator::PGQualified(Box::new(self.parse_qualified_operator()?));
655                    Ok(Expr::UnaryOp {
656                        op,
657                        expr: Box::new(self.parse_subexpr(Precedence::Other)?),
658                    })
659                }
660                keyword @ (Keyword::ALL | Keyword::ANY | Keyword::SOME) => {
661                    self.expect_token(&Token::LParen)?;
662                    // In upstream's PR of parser-rs, there is `self.parser_subexpr(precedence)` here.
663                    // But it will fail to parse `select 1 = any(null and true);`.
664                    let sub = self.parse_expr()?;
665                    self.expect_token(&Token::RParen)?;
666
667                    // TODO: support `all/any/some(subquery)`.
668                    if let Expr::Subquery(_) = &sub {
669                        parser_err!("ANY/SOME/ALL(Subquery) is not implemented");
670                    }
671
672                    Ok(match keyword {
673                        Keyword::ALL => Expr::AllOp(Box::new(sub)),
674                        // `SOME` is a synonym for `ANY`.
675                        Keyword::ANY | Keyword::SOME => Expr::SomeOp(Box::new(sub)),
676                        _ => unreachable!(),
677                    })
678                }
679                k if keywords::RESERVED_FOR_COLUMN_OR_TABLE_NAME.contains(&k) => {
680                    parser_err!("syntax error at or near {token}")
681                }
682                Keyword::AGGREGATE => {
683                    *self = checkpoint;
684                    self.parse_function()
685                }
686                // Here `w` is a word, check if it's a part of a multi-part
687                // identifier, a function call, or a simple identifier:
688                _ => match self.peek_token().token {
689                    Token::LParen | Token::Period => {
690                        *self = checkpoint;
691                        if let Ok(object_name) = self.parse_object_name()
692                            && !matches!(self.peek_token().token, Token::LParen)
693                        {
694                            Ok(Expr::CompoundIdentifier(object_name.0))
695                        } else {
696                            *self = checkpoint;
697                            self.parse_function()
698                        }
699                    }
700                    _ => Ok(Expr::Identifier(w.to_ident()?)),
701                },
702            }, // End of Token::Word
703
704            tok @ Token::Minus | tok @ Token::Plus => {
705                let op = if tok == Token::Plus {
706                    UnaryOperator::Plus
707                } else {
708                    UnaryOperator::Minus
709                };
710                let mut sub_expr = self.parse_subexpr(Precedence::UnaryPosNeg)?;
711                if let Expr::Value(Value::Number(ref mut s)) = sub_expr {
712                    if tok == Token::Minus {
713                        *s = format!("-{}", s);
714                    }
715                    return Ok(sub_expr);
716                }
717                Ok(Expr::UnaryOp {
718                    op,
719                    expr: Box::new(sub_expr),
720                })
721            }
722            Token::Op(name) => {
723                let op = UnaryOperator::Custom(name);
724                // Counter-intuitively, `|/ 4 + 12` means `|/ (4+12)` rather than `(|/4) + 12` in
725                // PostgreSQL.
726                Ok(Expr::UnaryOp {
727                    op,
728                    expr: Box::new(self.parse_subexpr(Precedence::Other)?),
729                })
730            }
731            Token::Number(_)
732            | Token::SingleQuotedString(_)
733            | Token::DollarQuotedString(_)
734            | Token::NationalStringLiteral(_)
735            | Token::HexStringLiteral(_)
736            | Token::CstyleEscapesString(_) => {
737                *self = checkpoint;
738                Ok(Expr::Value(self.ensure_parse_value()?))
739            }
740            Token::Parameter(number) => self.parse_param(number),
741            Token::Pipe => {
742                let args = self.parse_comma_separated(Parser::parse_identifier)?;
743                self.expect_token(&Token::Pipe)?;
744                let body = self.parse_expr()?;
745                Ok(Expr::LambdaFunction {
746                    args,
747                    body: Box::new(body),
748                })
749            }
750            Token::LParen => {
751                let expr = if matches!(self.peek_token().token, Token::Word(w) if w.keyword == Keyword::SELECT || w.keyword == Keyword::WITH)
752                {
753                    Expr::Subquery(Box::new(self.parse_query()?))
754                } else {
755                    let mut exprs = self.parse_comma_separated(Parser::parse_expr)?;
756                    if exprs.len() == 1 {
757                        Expr::Nested(Box::new(exprs.pop().unwrap()))
758                    } else {
759                        Expr::Row(exprs)
760                    }
761                };
762                self.expect_token(&Token::RParen)?;
763                if self.peek_token() == Token::Period && matches!(expr, Expr::Nested(_)) {
764                    self.parse_struct_selection(expr)
765                } else {
766                    Ok(expr)
767                }
768            }
769            _ => self.expected_at(checkpoint, "an expression"),
770        }?;
771
772        if self.parse_keyword(Keyword::COLLATE) {
773            Ok(Expr::Collate {
774                expr: Box::new(expr),
775                collation: self.parse_object_name()?,
776            })
777        } else {
778            Ok(expr)
779        }
780    }
781
782    fn parse_param(&mut self, param: String) -> ModalResult<Expr> {
783        let Ok(index) = param.parse() else {
784            parser_err!("Parameter symbol has a invalid index {}.", param);
785        };
786        Ok(Expr::Parameter { index })
787    }
788
789    /// Parses a field selection expression. See also [`Expr::FieldIdentifier`].
790    pub fn parse_struct_selection(&mut self, expr: Expr) -> ModalResult<Expr> {
791        let mut nested_expr = expr;
792        // Unwrap parentheses
793        while let Expr::Nested(inner) = nested_expr {
794            nested_expr = *inner;
795        }
796        let fields = self.parse_fields()?;
797        Ok(Expr::FieldIdentifier(Box::new(nested_expr), fields))
798    }
799
800    /// Parses consecutive field identifiers after a period. i.e., `.foo.bar.baz`
801    pub fn parse_fields(&mut self) -> ModalResult<Vec<Ident>> {
802        repeat(.., preceded(Token::Period, cut_err(Self::parse_identifier))).parse_next(self)
803    }
804
805    pub fn parse_qualified_operator(&mut self) -> ModalResult<QualifiedOperator> {
806        self.expect_token(&Token::LParen)?;
807
808        let checkpoint = *self;
809        let schema = match self.parse_identifier_non_reserved() {
810            Ok(ident) => {
811                self.expect_token(&Token::Period)?;
812                Some(ident)
813            }
814            Err(_) => {
815                *self = checkpoint;
816                None
817            }
818        };
819
820        // https://www.postgresql.org/docs/15/sql-syntax-lexical.html#SQL-SYNTAX-OPERATORS
821        const OP_CHARS: &[char] = &[
822            '+', '-', '*', '/', '<', '>', '=', '~', '!', '@', '#', '%', '^', '&', '|', '`', '?',
823        ];
824        let name = {
825            // Unlike PostgreSQL, we only take 1 token here rather than any sequence of `OP_CHARS`.
826            // This is enough because we do not support custom operators like `x *@ y` anyways,
827            // and all builtin sequences are already single tokens.
828            //
829            // To support custom operators and be fully compatible with PostgreSQL later, the
830            // tokenizer should also be updated.
831            let checkpoint = *self;
832            let token = self.next_token();
833            let name = token.token.to_string();
834            if !name.trim_matches(OP_CHARS).is_empty() {
835                return self
836                    .expected_at(checkpoint, &format!("one of {}", OP_CHARS.iter().join(" ")));
837            }
838            name
839        };
840
841        self.expect_token(&Token::RParen)?;
842        Ok(QualifiedOperator { schema, name })
843    }
844
845    /// Parse a function call.
846    pub fn parse_function(&mut self) -> ModalResult<Expr> {
847        // [aggregate:]
848        let scalar_as_agg = if self.parse_keyword(Keyword::AGGREGATE) {
849            self.expect_token(&Token::Colon)?;
850            true
851        } else {
852            false
853        };
854        let name = self.parse_object_name()?;
855        let arg_list = self.parse_argument_list()?;
856
857        let within_group = if self.parse_keywords(&[Keyword::WITHIN, Keyword::GROUP]) {
858            self.expect_token(&Token::LParen)?;
859            self.expect_keywords(&[Keyword::ORDER, Keyword::BY])?;
860            let order_by = self.parse_order_by_expr()?;
861            self.expect_token(&Token::RParen)?;
862            Some(Box::new(order_by))
863        } else {
864            None
865        };
866
867        let filter = if self.parse_keyword(Keyword::FILTER) {
868            self.expect_token(&Token::LParen)?;
869            self.expect_keyword(Keyword::WHERE)?;
870            let filter_expr = self.parse_expr()?;
871            self.expect_token(&Token::RParen)?;
872            Some(Box::new(filter_expr))
873        } else {
874            None
875        };
876
877        let over = if self.parse_keyword(Keyword::OVER) {
878            if self.peek_token() == Token::LParen {
879                // Inline window specification: OVER (...)
880                self.expect_token(&Token::LParen)?;
881                let window_spec = self.parse_window_spec()?;
882                self.expect_token(&Token::RParen)?;
883                Some(Window::Spec(window_spec))
884            } else {
885                // Named window: OVER window_name
886                let window_name = self.parse_identifier()?;
887                Some(Window::Name(window_name))
888            }
889        } else {
890            None
891        };
892
893        Ok(Expr::Function(Function {
894            scalar_as_agg,
895            name,
896            arg_list,
897            within_group,
898            filter,
899            over,
900        }))
901    }
902
903    pub fn parse_window_frame_units(&mut self) -> ModalResult<WindowFrameUnits> {
904        dispatch! { peek(keyword);
905            Keyword::ROWS => keyword.value(WindowFrameUnits::Rows),
906            Keyword::RANGE => keyword.value(WindowFrameUnits::Range),
907            Keyword::GROUPS => keyword.value(WindowFrameUnits::Groups),
908            Keyword::SESSION => keyword.value(WindowFrameUnits::Session),
909            _ => fail,
910        }
911        .expect("ROWS, RANGE, or GROUPS")
912        .parse_next(self)
913    }
914
915    pub fn parse_window_frame(&mut self) -> ModalResult<WindowFrame> {
916        let units = self.parse_window_frame_units()?;
917        let bounds = if self.parse_keyword(Keyword::BETWEEN) {
918            // `BETWEEN <frame_start> AND <frame_end>`
919            let start = self.parse_window_frame_bound()?;
920            self.expect_keyword(Keyword::AND)?;
921            let end = Some(self.parse_window_frame_bound()?);
922            WindowFrameBounds::Bounds { start, end }
923        } else if self.parse_keywords(&[Keyword::WITH, Keyword::GAP]) {
924            // `WITH GAP <gap>`, only for session frames
925            WindowFrameBounds::Gap(Box::new(self.parse_expr()?))
926        } else {
927            // `<frame_start>`
928            WindowFrameBounds::Bounds {
929                start: self.parse_window_frame_bound()?,
930                end: None,
931            }
932        };
933        let exclusion = if self.parse_keyword(Keyword::EXCLUDE) {
934            Some(self.parse_window_frame_exclusion()?)
935        } else {
936            None
937        };
938        Ok(WindowFrame {
939            units,
940            bounds,
941            exclusion,
942        })
943    }
944
945    /// Parse `CURRENT ROW` or `{ <non-negative numeric | datetime | interval> | UNBOUNDED } { PRECEDING | FOLLOWING }`
946    pub fn parse_window_frame_bound(&mut self) -> ModalResult<WindowFrameBound> {
947        if self.parse_keywords(&[Keyword::CURRENT, Keyword::ROW]) {
948            Ok(WindowFrameBound::CurrentRow)
949        } else {
950            let rows = if self.parse_keyword(Keyword::UNBOUNDED) {
951                None
952            } else {
953                Some(Box::new(self.parse_expr()?))
954            };
955            if self.parse_keyword(Keyword::PRECEDING) {
956                Ok(WindowFrameBound::Preceding(rows))
957            } else if self.parse_keyword(Keyword::FOLLOWING) {
958                Ok(WindowFrameBound::Following(rows))
959            } else {
960                self.expected("PRECEDING or FOLLOWING")
961            }
962        }
963    }
964
965    pub fn parse_window_frame_exclusion(&mut self) -> ModalResult<WindowFrameExclusion> {
966        if self.parse_keywords(&[Keyword::CURRENT, Keyword::ROW]) {
967            Ok(WindowFrameExclusion::CurrentRow)
968        } else if self.parse_keyword(Keyword::GROUP) {
969            Ok(WindowFrameExclusion::Group)
970        } else if self.parse_keyword(Keyword::TIES) {
971            Ok(WindowFrameExclusion::Ties)
972        } else if self.parse_keywords(&[Keyword::NO, Keyword::OTHERS]) {
973            Ok(WindowFrameExclusion::NoOthers)
974        } else {
975            self.expected("CURRENT ROW, GROUP, TIES, or NO OTHERS")
976        }
977    }
978
979    /// parse a group by expr. a group by expr can be one of group sets, roll up, cube, or simple
980    /// expr.
981    fn parse_group_by_expr(&mut self) -> ModalResult<Expr> {
982        if self.parse_keywords(&[Keyword::GROUPING, Keyword::SETS]) {
983            self.expect_token(&Token::LParen)?;
984            let result = self.parse_comma_separated(|p| p.parse_tuple(true, true))?;
985            self.expect_token(&Token::RParen)?;
986            Ok(Expr::GroupingSets(result))
987        } else if self.parse_keyword(Keyword::CUBE) {
988            self.expect_token(&Token::LParen)?;
989            let result = self.parse_comma_separated(|p| p.parse_tuple(true, false))?;
990            self.expect_token(&Token::RParen)?;
991            Ok(Expr::Cube(result))
992        } else if self.parse_keyword(Keyword::ROLLUP) {
993            self.expect_token(&Token::LParen)?;
994            let result = self.parse_comma_separated(|p| p.parse_tuple(true, false))?;
995            self.expect_token(&Token::RParen)?;
996            Ok(Expr::Rollup(result))
997        } else {
998            self.parse_expr()
999        }
1000    }
1001
1002    /// parse a tuple with `(` and `)`.
1003    /// If `lift_singleton` is true, then a singleton tuple is lifted to a tuple of length 1,
1004    /// otherwise it will fail. If `allow_empty` is true, then an empty tuple is allowed.
1005    fn parse_tuple(&mut self, lift_singleton: bool, allow_empty: bool) -> ModalResult<Vec<Expr>> {
1006        if lift_singleton {
1007            if self.consume_token(&Token::LParen) {
1008                let result = if allow_empty && self.consume_token(&Token::RParen) {
1009                    vec![]
1010                } else {
1011                    let result = self.parse_comma_separated(Parser::parse_expr)?;
1012                    self.expect_token(&Token::RParen)?;
1013                    result
1014                };
1015                Ok(result)
1016            } else {
1017                Ok(vec![self.parse_expr()?])
1018            }
1019        } else {
1020            self.expect_token(&Token::LParen)?;
1021            let result = if allow_empty && self.consume_token(&Token::RParen) {
1022                vec![]
1023            } else {
1024                let result = self.parse_comma_separated(Parser::parse_expr)?;
1025                self.expect_token(&Token::RParen)?;
1026                result
1027            };
1028            Ok(result)
1029        }
1030    }
1031
1032    pub fn parse_case_expr(&mut self) -> ModalResult<Expr> {
1033        parser_v2::expr_case(self)
1034    }
1035
1036    /// Parse a SQL CAST function e.g. `CAST(expr AS FLOAT)`
1037    pub fn parse_cast_expr(&mut self) -> ModalResult<Expr> {
1038        parser_v2::expr_cast(self)
1039    }
1040
1041    /// Parse a SQL TRY_CAST function e.g. `TRY_CAST(expr AS FLOAT)`
1042    pub fn parse_try_cast_expr(&mut self) -> ModalResult<Expr> {
1043        parser_v2::expr_try_cast(self)
1044    }
1045
1046    /// Parse a SQL EXISTS expression e.g. `WHERE EXISTS(SELECT ...)`.
1047    pub fn parse_exists_expr(&mut self) -> ModalResult<Expr> {
1048        self.expect_token(&Token::LParen)?;
1049        let exists_node = Expr::Exists(Box::new(self.parse_query()?));
1050        self.expect_token(&Token::RParen)?;
1051        Ok(exists_node)
1052    }
1053
1054    pub fn parse_extract_expr(&mut self) -> ModalResult<Expr> {
1055        parser_v2::expr_extract(self)
1056    }
1057
1058    pub fn parse_substring_expr(&mut self) -> ModalResult<Expr> {
1059        parser_v2::expr_substring(self)
1060    }
1061
1062    /// `POSITION(<expr> IN <expr>)`
1063    pub fn parse_position_expr(&mut self) -> ModalResult<Expr> {
1064        parser_v2::expr_position(self)
1065    }
1066
1067    /// `OVERLAY(<expr> PLACING <expr> FROM <expr> [ FOR <expr> ])`
1068    pub fn parse_overlay_expr(&mut self) -> ModalResult<Expr> {
1069        parser_v2::expr_overlay(self)
1070    }
1071
1072    /// `TRIM ([WHERE] ['text'] FROM 'text')`\
1073    /// `TRIM ([WHERE] [FROM] 'text' [, 'text'])`
1074    pub fn parse_trim_expr(&mut self) -> ModalResult<Expr> {
1075        self.expect_token(&Token::LParen)?;
1076        let mut trim_where = None;
1077        if let Token::Word(word) = self.peek_token().token
1078            && [Keyword::BOTH, Keyword::LEADING, Keyword::TRAILING].contains(&word.keyword)
1079        {
1080            trim_where = Some(self.parse_trim_where()?);
1081        }
1082
1083        let (mut trim_what, expr) = if self.parse_keyword(Keyword::FROM) {
1084            (None, self.parse_expr()?)
1085        } else {
1086            let mut expr = self.parse_expr()?;
1087            if self.parse_keyword(Keyword::FROM) {
1088                let trim_what = std::mem::replace(&mut expr, self.parse_expr()?);
1089                (Some(Box::new(trim_what)), expr)
1090            } else {
1091                (None, expr)
1092            }
1093        };
1094
1095        if trim_what.is_none() && self.consume_token(&Token::Comma) {
1096            trim_what = Some(Box::new(self.parse_expr()?));
1097        }
1098        self.expect_token(&Token::RParen)?;
1099
1100        Ok(Expr::Trim {
1101            expr: Box::new(expr),
1102            trim_where,
1103            trim_what,
1104        })
1105    }
1106
1107    pub fn parse_trim_where(&mut self) -> ModalResult<TrimWhereField> {
1108        dispatch! { peek(keyword);
1109            Keyword::BOTH => keyword.value(TrimWhereField::Both),
1110            Keyword::LEADING => keyword.value(TrimWhereField::Leading),
1111            Keyword::TRAILING => keyword.value(TrimWhereField::Trailing),
1112            _ => fail
1113        }
1114        .expect("BOTH, LEADING, or TRAILING")
1115        .parse_next(self)
1116    }
1117
1118    /// Parses an array expression `[ex1, ex2, ..]`
1119    pub fn parse_array_expr(&mut self) -> ModalResult<Expr> {
1120        let mut expected_depth = None;
1121        let exprs = self.parse_array_inner(0, &mut expected_depth)?;
1122        Ok(Expr::Array(Array {
1123            elem: exprs,
1124            // Top-level array is named.
1125            named: true,
1126        }))
1127    }
1128
1129    fn parse_array_inner(
1130        &mut self,
1131        depth: usize,
1132        expected_depth: &mut Option<usize>,
1133    ) -> ModalResult<Vec<Expr>> {
1134        self.expect_token(&Token::LBracket)?;
1135        if let Some(expected_depth) = *expected_depth
1136            && depth > expected_depth
1137        {
1138            return self.expected("]");
1139        }
1140        let exprs = if self.peek_token() == Token::LBracket {
1141            self.parse_comma_separated(|parser| {
1142                let exprs = parser.parse_array_inner(depth + 1, expected_depth)?;
1143                Ok(Expr::Array(Array {
1144                    elem: exprs,
1145                    named: false,
1146                }))
1147            })?
1148        } else {
1149            if let Some(expected_depth) = *expected_depth {
1150                if depth < expected_depth {
1151                    return self.expected("[");
1152                }
1153            } else {
1154                *expected_depth = Some(depth);
1155            }
1156            if self.consume_token(&Token::RBracket) {
1157                return Ok(vec![]);
1158            }
1159            self.parse_comma_separated(Self::parse_expr)?
1160        };
1161        self.expect_token(&Token::RBracket)?;
1162        Ok(exprs)
1163    }
1164
1165    /// Parses a map expression `MAP {k1:v1, k2:v2, ..}`
1166    pub fn parse_map_expr(&mut self) -> ModalResult<Expr> {
1167        self.expect_token(&Token::LBrace)?;
1168        if self.consume_token(&Token::RBrace) {
1169            return Ok(Expr::Map { entries: vec![] });
1170        }
1171        let entries = self.parse_comma_separated(|parser| {
1172            let key = parser.parse_expr()?;
1173            parser.expect_token(&Token::Colon)?;
1174            let value = parser.parse_expr()?;
1175            Ok((key, value))
1176        })?;
1177        self.expect_token(&Token::RBrace)?;
1178        Ok(Expr::Map { entries })
1179    }
1180
1181    // This function parses date/time fields for interval qualifiers.
1182    pub fn parse_date_time_field(&mut self) -> ModalResult<DateTimeField> {
1183        dispatch! { peek(keyword);
1184            Keyword::YEAR => keyword.value(DateTimeField::Year),
1185            Keyword::MONTH => keyword.value(DateTimeField::Month),
1186            Keyword::DAY => keyword.value(DateTimeField::Day),
1187            Keyword::HOUR => keyword.value(DateTimeField::Hour),
1188            Keyword::MINUTE => keyword.value(DateTimeField::Minute),
1189            Keyword::SECOND => keyword.value(DateTimeField::Second),
1190            _ => fail,
1191        }
1192        .expect("date/time field")
1193        .parse_next(self)
1194    }
1195
1196    // This function parses date/time fields for the EXTRACT function-like operator. PostgreSQL
1197    // allows arbitrary inputs including invalid ones.
1198    //
1199    // ```
1200    //   select extract(day from null::date);
1201    //   select extract(invalid from null::date);
1202    //   select extract("invaLId" from null::date);
1203    //   select extract('invaLId' from null::date);
1204    // ```
1205    pub fn parse_date_time_field_in_extract(&mut self) -> ModalResult<String> {
1206        let checkpoint = *self;
1207        let token = self.next_token();
1208        match token.token {
1209            Token::Word(w) => Ok(w.value.to_uppercase()),
1210            Token::SingleQuotedString(s) => Ok(s.to_uppercase()),
1211            _ => {
1212                *self = checkpoint;
1213                self.expected("date/time field")
1214            }
1215        }
1216    }
1217
1218    /// Parse an INTERVAL literal.
1219    ///
1220    /// Some syntactically valid intervals:
1221    ///
1222    ///   1. `INTERVAL '1' DAY`
1223    ///   2. `INTERVAL '1-1' YEAR TO MONTH`
1224    ///   3. `INTERVAL '1' SECOND`
1225    ///   4. `INTERVAL '1:1:1.1' HOUR (5) TO SECOND (5)`
1226    ///   5. `INTERVAL '1.1' SECOND (2, 2)`
1227    ///   6. `INTERVAL '1:1' HOUR (5) TO MINUTE (5)`
1228    ///
1229    /// Note that we do not currently attempt to parse the quoted value.
1230    pub fn parse_literal_interval(&mut self) -> ModalResult<Expr> {
1231        // The SQL standard allows an optional sign before the value string, but
1232        // it is not clear if any implementations support that syntax, so we
1233        // don't currently try to parse it. (The sign can instead be included
1234        // inside the value string.)
1235
1236        // The first token in an interval is a string literal which specifies
1237        // the duration of the interval.
1238        let value = self.parse_literal_string()?;
1239
1240        // Following the string literal is a qualifier which indicates the units
1241        // of the duration specified in the string literal.
1242        //
1243        // Note that PostgreSQL allows omitting the qualifier, so we provide
1244        // this more general implementation.
1245        let leading_field = match self.peek_token().token {
1246            Token::Word(kw)
1247                if [
1248                    Keyword::YEAR,
1249                    Keyword::MONTH,
1250                    Keyword::DAY,
1251                    Keyword::HOUR,
1252                    Keyword::MINUTE,
1253                    Keyword::SECOND,
1254                ]
1255                .contains(&kw.keyword) =>
1256            {
1257                Some(self.parse_date_time_field()?)
1258            }
1259            _ => None,
1260        };
1261
1262        let (leading_precision, last_field, fsec_precision) =
1263            if leading_field == Some(DateTimeField::Second) {
1264                // SQL mandates special syntax for `SECOND TO SECOND` literals.
1265                // Instead of
1266                //     `SECOND [(<leading precision>)] TO SECOND[(<fractional seconds precision>)]`
1267                // one must use the special format:
1268                //     `SECOND [( <leading precision> [ , <fractional seconds precision>] )]`
1269                let last_field = None;
1270                let (leading_precision, fsec_precision) = self.parse_optional_precision_scale()?;
1271                (leading_precision, last_field, fsec_precision)
1272            } else {
1273                let leading_precision = self.parse_optional_precision()?;
1274                if self.parse_keyword(Keyword::TO) {
1275                    let last_field = Some(self.parse_date_time_field()?);
1276                    let fsec_precision = if last_field == Some(DateTimeField::Second) {
1277                        self.parse_optional_precision()?
1278                    } else {
1279                        None
1280                    };
1281                    (leading_precision, last_field, fsec_precision)
1282                } else {
1283                    (leading_precision, None, None)
1284                }
1285            };
1286
1287        Ok(Expr::Value(Value::Interval {
1288            value,
1289            leading_field,
1290            leading_precision,
1291            last_field,
1292            fractional_seconds_precision: fsec_precision,
1293        }))
1294    }
1295
1296    /// Parse an operator following an expression
1297    pub fn parse_infix(&mut self, expr: Expr, precedence: Precedence) -> ModalResult<Expr> {
1298        let checkpoint = *self;
1299        let tok = self.next_token();
1300        debug!("parsing infix {:?}", tok.token);
1301        let regular_binary_operator = match &tok.token {
1302            Token::Eq => Some(BinaryOperator::Eq),
1303            Token::Neq => Some(BinaryOperator::NotEq),
1304            Token::Gt => Some(BinaryOperator::Gt),
1305            Token::GtEq => Some(BinaryOperator::GtEq),
1306            Token::Lt => Some(BinaryOperator::Lt),
1307            Token::LtEq => Some(BinaryOperator::LtEq),
1308            Token::Plus => Some(BinaryOperator::Plus),
1309            Token::Minus => Some(BinaryOperator::Minus),
1310            Token::Mul => Some(BinaryOperator::Multiply),
1311            Token::Mod => Some(BinaryOperator::Modulo),
1312            Token::Pipe => Some(BinaryOperator::Custom("|".to_owned())),
1313            Token::Caret => Some(BinaryOperator::Pow),
1314            Token::Div => Some(BinaryOperator::Divide),
1315            Token::Op(name) => Some(BinaryOperator::Custom(name.clone())),
1316            Token::Word(w) => match w.keyword {
1317                Keyword::AND => Some(BinaryOperator::And),
1318                Keyword::OR => Some(BinaryOperator::Or),
1319                Keyword::XOR => Some(BinaryOperator::Xor),
1320                Keyword::OPERATOR if self.peek_token() == Token::LParen => Some(
1321                    BinaryOperator::PGQualified(Box::new(self.parse_qualified_operator()?)),
1322                ),
1323                _ => None,
1324            },
1325            _ => None,
1326        };
1327
1328        if let Some(op) = regular_binary_operator {
1329            // // `all/any/some` only appears to the right of the binary op.
1330            // if let Some(keyword) =
1331            //     self.parse_one_of_keywords(&[Keyword::ANY, Keyword::ALL, Keyword::SOME])
1332            // {
1333            //     self.expect_token(&Token::LParen)?;
1334            //     // In upstream's PR of parser-rs, there is `self.parser_subexpr(precedence)` here.
1335            //     // But it will fail to parse `select 1 = any(null and true);`.
1336            //     let right = self.parse_expr()?;
1337            //     self.expect_token(&Token::RParen)?;
1338
1339            //     // TODO: support `all/any/some(subquery)`.
1340            //     if let Expr::Subquery(_) = &right {
1341            //         parser_err!("ANY/SOME/ALL(Subquery) is not implemented");
1342            //     }
1343
1344            //     let right = match keyword {
1345            //         Keyword::ALL => Box::new(Expr::AllOp(Box::new(right))),
1346            //         // `SOME` is a synonym for `ANY`.
1347            //         Keyword::ANY | Keyword::SOME => Box::new(Expr::SomeOp(Box::new(right))),
1348            //         _ => unreachable!(),
1349            //     };
1350
1351            //     Ok(Expr::BinaryOp {
1352            //         left: Box::new(expr),
1353            //         op,
1354            //         right,
1355            //     })
1356            // } else {
1357            Ok(Expr::BinaryOp {
1358                left: Box::new(expr),
1359                op,
1360                right: Box::new(self.parse_subexpr(precedence)?),
1361            })
1362            // }
1363        } else if let Token::Word(w) = &tok.token {
1364            match w.keyword {
1365                Keyword::IS => {
1366                    if self.parse_keyword(Keyword::TRUE) {
1367                        Ok(Expr::IsTrue(Box::new(expr)))
1368                    } else if self.parse_keywords(&[Keyword::NOT, Keyword::TRUE]) {
1369                        Ok(Expr::IsNotTrue(Box::new(expr)))
1370                    } else if self.parse_keyword(Keyword::FALSE) {
1371                        Ok(Expr::IsFalse(Box::new(expr)))
1372                    } else if self.parse_keywords(&[Keyword::NOT, Keyword::FALSE]) {
1373                        Ok(Expr::IsNotFalse(Box::new(expr)))
1374                    } else if self.parse_keyword(Keyword::UNKNOWN) {
1375                        Ok(Expr::IsUnknown(Box::new(expr)))
1376                    } else if self.parse_keywords(&[Keyword::NOT, Keyword::UNKNOWN]) {
1377                        Ok(Expr::IsNotUnknown(Box::new(expr)))
1378                    } else if self.parse_keyword(Keyword::NULL) {
1379                        Ok(Expr::IsNull(Box::new(expr)))
1380                    } else if self.parse_keywords(&[Keyword::NOT, Keyword::NULL]) {
1381                        Ok(Expr::IsNotNull(Box::new(expr)))
1382                    } else if self.parse_keywords(&[Keyword::DISTINCT, Keyword::FROM]) {
1383                        let expr2 = self.parse_expr()?;
1384                        Ok(Expr::IsDistinctFrom(Box::new(expr), Box::new(expr2)))
1385                    } else if self.parse_keywords(&[Keyword::NOT, Keyword::DISTINCT, Keyword::FROM])
1386                    {
1387                        let expr2 = self.parse_expr()?;
1388                        Ok(Expr::IsNotDistinctFrom(Box::new(expr), Box::new(expr2)))
1389                    } else {
1390                        let negated = self.parse_keyword(Keyword::NOT);
1391
1392                        if self.parse_keyword(Keyword::JSON) {
1393                            self.parse_is_json(expr, negated)
1394                        } else {
1395                            self.expected(
1396                                "[NOT] { TRUE | FALSE | UNKNOWN | NULL | DISTINCT FROM | JSON } after IS",
1397                            )
1398                        }
1399                    }
1400                }
1401                Keyword::AT => {
1402                    assert_eq!(precedence, Precedence::At);
1403                    let time_zone = Box::new(
1404                        preceded(
1405                            (Keyword::TIME, Keyword::ZONE),
1406                            cut_err(|p: &mut Self| p.parse_subexpr(precedence)),
1407                        )
1408                        .parse_next(self)?,
1409                    );
1410                    Ok(Expr::AtTimeZone {
1411                        timestamp: Box::new(expr),
1412                        time_zone,
1413                    })
1414                }
1415                keyword @ (Keyword::ALL | Keyword::ANY | Keyword::SOME) => {
1416                    self.expect_token(&Token::LParen)?;
1417                    // In upstream's PR of parser-rs, there is `self.parser_subexpr(precedence)` here.
1418                    // But it will fail to parse `select 1 = any(null and true);`.
1419                    let sub = self.parse_expr()?;
1420                    self.expect_token(&Token::RParen)?;
1421
1422                    // TODO: support `all/any/some(subquery)`.
1423                    if let Expr::Subquery(_) = &sub {
1424                        parser_err!("ANY/SOME/ALL(Subquery) is not implemented");
1425                    }
1426
1427                    Ok(match keyword {
1428                        Keyword::ALL => Expr::AllOp(Box::new(sub)),
1429                        // `SOME` is a synonym for `ANY`.
1430                        Keyword::ANY | Keyword::SOME => Expr::SomeOp(Box::new(sub)),
1431                        _ => unreachable!(),
1432                    })
1433                }
1434                Keyword::NOT
1435                | Keyword::IN
1436                | Keyword::BETWEEN
1437                | Keyword::LIKE
1438                | Keyword::ILIKE
1439                | Keyword::SIMILAR => {
1440                    *self = checkpoint;
1441                    let negated = self.parse_keyword(Keyword::NOT);
1442                    if self.parse_keyword(Keyword::IN) {
1443                        self.parse_in(expr, negated)
1444                    } else if self.parse_keyword(Keyword::BETWEEN) {
1445                        self.parse_between(expr, negated)
1446                    } else if self.parse_keyword(Keyword::LIKE) {
1447                        Ok(Expr::Like {
1448                            negated,
1449                            expr: Box::new(expr),
1450                            pattern: Box::new(self.parse_subexpr(Precedence::Like)?),
1451                            escape_char: self.parse_escape()?,
1452                        })
1453                    } else if self.parse_keyword(Keyword::ILIKE) {
1454                        Ok(Expr::ILike {
1455                            negated,
1456                            expr: Box::new(expr),
1457                            pattern: Box::new(self.parse_subexpr(Precedence::Like)?),
1458                            escape_char: self.parse_escape()?,
1459                        })
1460                    } else if self.parse_keywords(&[Keyword::SIMILAR, Keyword::TO]) {
1461                        Ok(Expr::SimilarTo {
1462                            negated,
1463                            expr: Box::new(expr),
1464                            pattern: Box::new(self.parse_subexpr(Precedence::Like)?),
1465                            escape_char: self.parse_escape()?,
1466                        })
1467                    } else {
1468                        self.expected("IN, BETWEEN or SIMILAR TO after NOT")
1469                    }
1470                }
1471                // Can only happen if `get_next_precedence` got out of sync with this function
1472                _ => parser_err!("No infix parser for token {:?}", tok),
1473            }
1474        } else if Token::DoubleColon == tok {
1475            self.parse_pg_cast(expr)
1476        } else if Token::LBracket == tok {
1477            self.parse_array_index(expr)
1478        } else {
1479            // Can only happen if `get_next_precedence` got out of sync with this function
1480            parser_err!("No infix parser for token {:?}", tok)
1481        }
1482    }
1483
1484    /// parse the ESCAPE CHAR portion of LIKE, ILIKE, and SIMILAR TO
1485    pub fn parse_escape(&mut self) -> ModalResult<Option<EscapeChar>> {
1486        if self.parse_keyword(Keyword::ESCAPE) {
1487            let s = self.parse_literal_string()?;
1488            let mut chs = s.chars();
1489            if let Some(ch) = chs.next() {
1490                if chs.next().is_some() {
1491                    parser_err!("Escape string must be empty or one character, found {s:?}")
1492                } else {
1493                    Ok(Some(EscapeChar::escape(ch)))
1494                }
1495            } else {
1496                Ok(Some(EscapeChar::empty()))
1497            }
1498        } else {
1499            Ok(None)
1500        }
1501    }
1502
1503    /// We parse both `array[1,9][1]`, `array[1,9][1:2]`, `array[1,9][:2]`, `array[1,9][1:]` and
1504    /// `array[1,9][:]` in this function.
1505    pub fn parse_array_index(&mut self, expr: Expr) -> ModalResult<Expr> {
1506        let new_expr = match self.peek_token().token {
1507            Token::Colon => {
1508                // [:] or [:N]
1509                assert!(self.consume_token(&Token::Colon));
1510                let end = match self.peek_token().token {
1511                    Token::RBracket => None,
1512                    _ => {
1513                        let end_index = Box::new(self.parse_expr()?);
1514                        Some(end_index)
1515                    }
1516                };
1517                Expr::ArrayRangeIndex {
1518                    obj: Box::new(expr),
1519                    start: None,
1520                    end,
1521                }
1522            }
1523            _ => {
1524                // [N], [N:], [N:M]
1525                let index = Box::new(self.parse_expr()?);
1526                match self.peek_token().token {
1527                    Token::Colon => {
1528                        // [N:], [N:M]
1529                        assert!(self.consume_token(&Token::Colon));
1530                        match self.peek_token().token {
1531                            Token::RBracket => {
1532                                // [N:]
1533                                Expr::ArrayRangeIndex {
1534                                    obj: Box::new(expr),
1535                                    start: Some(index),
1536                                    end: None,
1537                                }
1538                            }
1539                            _ => {
1540                                // [N:M]
1541                                let end = Some(Box::new(self.parse_expr()?));
1542                                Expr::ArrayRangeIndex {
1543                                    obj: Box::new(expr),
1544                                    start: Some(index),
1545                                    end,
1546                                }
1547                            }
1548                        }
1549                    }
1550                    _ => {
1551                        // [N]
1552                        Expr::Index {
1553                            obj: Box::new(expr),
1554                            index,
1555                        }
1556                    }
1557                }
1558            }
1559        };
1560        self.expect_token(&Token::RBracket)?;
1561        // recursively checking for more indices
1562        if self.consume_token(&Token::LBracket) {
1563            self.parse_array_index(new_expr)
1564        } else {
1565            Ok(new_expr)
1566        }
1567    }
1568
1569    /// Parses the optional constraints following the `IS [NOT] JSON` predicate
1570    pub fn parse_is_json(&mut self, expr: Expr, negated: bool) -> ModalResult<Expr> {
1571        let item_type = match self.peek_token().token {
1572            Token::Word(w) => match w.keyword {
1573                Keyword::VALUE => Some(JsonPredicateType::Value),
1574                Keyword::ARRAY => Some(JsonPredicateType::Array),
1575                Keyword::OBJECT => Some(JsonPredicateType::Object),
1576                Keyword::SCALAR => Some(JsonPredicateType::Scalar),
1577                _ => None,
1578            },
1579            _ => None,
1580        };
1581        if item_type.is_some() {
1582            self.next_token();
1583        }
1584        let item_type = item_type.unwrap_or_default();
1585
1586        let unique_keys = self.parse_one_of_keywords(&[Keyword::WITH, Keyword::WITHOUT]);
1587        if unique_keys.is_some() {
1588            self.expect_keyword(Keyword::UNIQUE)?;
1589            _ = self.parse_keyword(Keyword::KEYS);
1590        }
1591        let unique_keys = unique_keys.is_some_and(|w| w == Keyword::WITH);
1592
1593        Ok(Expr::IsJson {
1594            expr: Box::new(expr),
1595            negated,
1596            item_type,
1597            unique_keys,
1598        })
1599    }
1600
1601    /// Parses the parens following the `[ NOT ] IN` operator
1602    pub fn parse_in(&mut self, expr: Expr, negated: bool) -> ModalResult<Expr> {
1603        self.expect_token(&Token::LParen)?;
1604        let in_op = if matches!(self.peek_token().token, Token::Word(w) if w.keyword == Keyword::SELECT || w.keyword == Keyword::WITH)
1605        {
1606            Expr::InSubquery {
1607                expr: Box::new(expr),
1608                subquery: Box::new(self.parse_query()?),
1609                negated,
1610            }
1611        } else {
1612            Expr::InList {
1613                expr: Box::new(expr),
1614                list: self.parse_comma_separated(Parser::parse_expr)?,
1615                negated,
1616            }
1617        };
1618        self.expect_token(&Token::RParen)?;
1619        Ok(in_op)
1620    }
1621
1622    /// Parses `BETWEEN <low> AND <high>`, assuming the `BETWEEN` keyword was already consumed
1623    pub fn parse_between(&mut self, expr: Expr, negated: bool) -> ModalResult<Expr> {
1624        // Stop parsing subexpressions for <low> and <high> on tokens with
1625        // precedence lower than that of `BETWEEN`, such as `AND`, `IS`, etc.
1626        let low = self.parse_subexpr(Precedence::Between)?;
1627        self.expect_keyword(Keyword::AND)?;
1628        let high = self.parse_subexpr(Precedence::Between)?;
1629        Ok(Expr::Between {
1630            expr: Box::new(expr),
1631            negated,
1632            low: Box::new(low),
1633            high: Box::new(high),
1634        })
1635    }
1636
1637    /// Parse a postgresql casting style which is in the form of `expr::datatype`
1638    pub fn parse_pg_cast(&mut self, expr: Expr) -> ModalResult<Expr> {
1639        Ok(Expr::Cast {
1640            expr: Box::new(expr),
1641            data_type: self.parse_data_type()?,
1642        })
1643    }
1644
1645    /// Get the precedence of the next token
1646    pub fn get_next_precedence(&self) -> ModalResult<Precedence> {
1647        use Precedence as P;
1648
1649        let token = self.peek_token();
1650        debug!("get_next_precedence() {:?}", token);
1651        match token.token {
1652            Token::Word(w) if w.keyword == Keyword::OR => Ok(P::LogicalOr),
1653            Token::Word(w) if w.keyword == Keyword::XOR => Ok(P::LogicalXor),
1654            Token::Word(w) if w.keyword == Keyword::AND => Ok(P::LogicalAnd),
1655            Token::Word(w) if w.keyword == Keyword::AT => {
1656                match (self.peek_nth_token(1).token, self.peek_nth_token(2).token) {
1657                    (Token::Word(w), Token::Word(w2))
1658                        if w.keyword == Keyword::TIME && w2.keyword == Keyword::ZONE =>
1659                    {
1660                        Ok(P::At)
1661                    }
1662                    _ => Ok(P::Zero),
1663                }
1664            }
1665
1666            Token::Word(w) if w.keyword == Keyword::NOT => match self.peek_nth_token(1).token {
1667                // The precedence of NOT varies depending on keyword that
1668                // follows it. If it is followed by IN, BETWEEN, or LIKE,
1669                // it takes on the precedence of those tokens. Otherwise it
1670                // is not an infix operator, and therefore has zero
1671                // precedence.
1672                Token::Word(w) if w.keyword == Keyword::BETWEEN => Ok(P::Between),
1673                Token::Word(w) if w.keyword == Keyword::IN => Ok(P::Between),
1674                Token::Word(w) if w.keyword == Keyword::LIKE => Ok(P::Like),
1675                Token::Word(w) if w.keyword == Keyword::ILIKE => Ok(P::Like),
1676                Token::Word(w) if w.keyword == Keyword::SIMILAR => Ok(P::Like),
1677                _ => Ok(P::Zero),
1678            },
1679
1680            Token::Word(w) if w.keyword == Keyword::IS => Ok(P::Is),
1681            Token::Word(w) if w.keyword == Keyword::ISNULL => Ok(P::Is),
1682            Token::Word(w) if w.keyword == Keyword::NOTNULL => Ok(P::Is),
1683            Token::Eq | Token::Lt | Token::LtEq | Token::Neq | Token::Gt | Token::GtEq => {
1684                Ok(P::Cmp)
1685            }
1686            Token::Word(w) if w.keyword == Keyword::IN => Ok(P::Between),
1687            Token::Word(w) if w.keyword == Keyword::BETWEEN => Ok(P::Between),
1688            Token::Word(w) if w.keyword == Keyword::LIKE => Ok(P::Like),
1689            Token::Word(w) if w.keyword == Keyword::ILIKE => Ok(P::Like),
1690            Token::Word(w) if w.keyword == Keyword::SIMILAR => Ok(P::Like),
1691            Token::Word(w) if w.keyword == Keyword::ALL => Ok(P::Other),
1692            Token::Word(w) if w.keyword == Keyword::ANY => Ok(P::Other),
1693            Token::Word(w) if w.keyword == Keyword::SOME => Ok(P::Other),
1694            Token::Op(_) => Ok(P::Other),
1695            Token::Word(w)
1696                if w.keyword == Keyword::OPERATOR && self.peek_nth_token(1) == Token::LParen =>
1697            {
1698                Ok(P::Other)
1699            }
1700            // In some languages (incl. rust, c), bitwise operators have precedence:
1701            //   or < xor < and < shift
1702            // But in PostgreSQL, they are just left to right. So `2 | 3 & 4` is 0.
1703            Token::Pipe => Ok(P::Other),
1704            Token::Plus | Token::Minus => Ok(P::PlusMinus),
1705            Token::Mul | Token::Div | Token::Mod => Ok(P::MulDiv),
1706            Token::Caret => Ok(P::Exp),
1707            Token::LBracket => Ok(P::Array),
1708            Token::DoubleColon => Ok(P::DoubleColon),
1709            _ => Ok(P::Zero),
1710        }
1711    }
1712
1713    /// Return the first non-whitespace token that has not yet been processed
1714    /// (or None if reached end-of-file)
1715    pub fn peek_token(&self) -> TokenWithLocation {
1716        self.peek_nth_token(0)
1717    }
1718
1719    /// Return nth non-whitespace token that has not yet been processed
1720    pub fn peek_nth_token(&self, mut n: usize) -> TokenWithLocation {
1721        let mut index = 0;
1722        loop {
1723            let token = self.0.get(index);
1724            index += 1;
1725            match token.map(|x| &x.token) {
1726                Some(Token::Whitespace(_)) => continue,
1727                _ => {
1728                    if n == 0 {
1729                        return token.cloned().unwrap_or(TokenWithLocation::eof());
1730                    }
1731                    n -= 1;
1732                }
1733            }
1734        }
1735    }
1736
1737    /// Return the first non-whitespace token that has not yet been processed
1738    /// (or None if reached end-of-file) and mark it as processed. OK to call
1739    /// repeatedly after reaching EOF.
1740    pub fn next_token(&mut self) -> TokenWithLocation {
1741        loop {
1742            let Some(token) = self.0.first() else {
1743                return TokenWithLocation::eof();
1744            };
1745            self.0 = &self.0[1..];
1746            match token.token {
1747                Token::Whitespace(_) => continue,
1748                _ => return token.clone(),
1749            }
1750        }
1751    }
1752
1753    /// Return the first unprocessed token, possibly whitespace.
1754    pub fn next_token_no_skip(&mut self) -> Option<&TokenWithLocation> {
1755        if self.0.is_empty() {
1756            None
1757        } else {
1758            let (first, rest) = self.0.split_at(1);
1759            self.0 = rest;
1760            Some(&first[0])
1761        }
1762    }
1763
1764    /// Report an expected error at the current position.
1765    pub fn expected<T>(&self, expected: &str) -> ModalResult<T> {
1766        parser_err!("expected {}, found: {}", expected, self.peek_token().token)
1767    }
1768
1769    /// Revert the parser to a previous position and report an expected error.
1770    pub fn expected_at<T>(&mut self, checkpoint: Self, expected: &str) -> ModalResult<T> {
1771        *self = checkpoint;
1772        self.expected(expected)
1773    }
1774
1775    /// Check if the expected match is the next token.
1776    /// The equality check is case-insensitive.
1777    pub fn parse_word(&mut self, expected: &str) -> bool {
1778        match self.peek_token().token {
1779            Token::Word(w) if w.value.to_uppercase() == expected => {
1780                self.next_token();
1781                true
1782            }
1783            _ => false,
1784        }
1785    }
1786
1787    pub fn expect_word(&mut self, expected: &str) -> ModalResult<()> {
1788        if self.parse_word(expected) {
1789            Ok(())
1790        } else {
1791            self.expected(expected)
1792        }
1793    }
1794
1795    /// Look for an expected keyword and consume it if it exists
1796    #[must_use]
1797    pub fn parse_keyword(&mut self, expected: Keyword) -> bool {
1798        match self.peek_token().token {
1799            Token::Word(w) if expected == w.keyword => {
1800                self.next_token();
1801                true
1802            }
1803            _ => false,
1804        }
1805    }
1806
1807    /// Look for an expected sequence of keywords and consume them if they exist
1808    #[must_use]
1809    pub fn parse_keywords(&mut self, keywords: &[Keyword]) -> bool {
1810        let checkpoint = *self;
1811        for &keyword in keywords {
1812            if !self.parse_keyword(keyword) {
1813                // println!("parse_keywords aborting .. did not find {:?}", keyword);
1814                // reset index and return immediately
1815                *self = checkpoint;
1816                return false;
1817            }
1818        }
1819        true
1820    }
1821
1822    /// Look for one of the given keywords and return the one that matches.
1823    #[must_use]
1824    pub fn parse_one_of_keywords(&mut self, keywords: &[Keyword]) -> Option<Keyword> {
1825        match self.peek_token().token {
1826            Token::Word(w) => {
1827                keywords
1828                    .iter()
1829                    .find(|keyword| **keyword == w.keyword)
1830                    .map(|keyword| {
1831                        self.next_token();
1832                        *keyword
1833                    })
1834            }
1835            _ => None,
1836        }
1837    }
1838
1839    pub fn peek_nth_any_of_keywords(&mut self, n: usize, keywords: &[Keyword]) -> bool {
1840        match self.peek_nth_token(n).token {
1841            Token::Word(w) => keywords.contains(&w.keyword),
1842            _ => false,
1843        }
1844    }
1845
1846    /// Bail out if the current token is not one of the expected keywords, or consume it if it is
1847    pub fn expect_one_of_keywords(&mut self, keywords: &[Keyword]) -> ModalResult<Keyword> {
1848        if let Some(keyword) = self.parse_one_of_keywords(keywords) {
1849            Ok(keyword)
1850        } else {
1851            let keywords: Vec<String> = keywords.iter().map(|x| format!("{:?}", x)).collect();
1852            self.expected(&format!("one of {}", keywords.join(" or ")))
1853        }
1854    }
1855
1856    /// Bail out if the current token is not an expected keyword, or consume it if it is
1857    pub fn expect_keyword(&mut self, expected: Keyword) -> ModalResult<()> {
1858        if self.parse_keyword(expected) {
1859            Ok(())
1860        } else {
1861            self.expected(format!("{:?}", &expected).as_str())
1862        }
1863    }
1864
1865    /// Bail out if the following tokens are not the expected sequence of
1866    /// keywords, or consume them if they are.
1867    pub fn expect_keywords(&mut self, expected: &[Keyword]) -> ModalResult<()> {
1868        for &kw in expected {
1869            self.expect_keyword(kw)?;
1870        }
1871        Ok(())
1872    }
1873
1874    /// Consume the next token if it matches the expected token, otherwise return false
1875    #[must_use]
1876    pub fn consume_token(&mut self, expected: &Token) -> bool {
1877        if self.peek_token() == *expected {
1878            self.next_token();
1879            true
1880        } else {
1881            false
1882        }
1883    }
1884
1885    /// Bail out if the current token is not an expected keyword, or consume it if it is
1886    pub fn expect_token(&mut self, expected: &Token) -> ModalResult<()> {
1887        if self.consume_token(expected) {
1888            Ok(())
1889        } else {
1890            self.expected(&expected.to_string())
1891        }
1892    }
1893
1894    /// Parse a comma-separated list of 1+ items accepted by `F`
1895    pub fn parse_comma_separated<T, F>(&mut self, mut f: F) -> ModalResult<Vec<T>>
1896    where
1897        F: FnMut(&mut Self) -> ModalResult<T>,
1898    {
1899        let mut values = vec![];
1900        loop {
1901            values.push(f(self)?);
1902            if !self.consume_token(&Token::Comma) {
1903                break;
1904            }
1905        }
1906        Ok(values)
1907    }
1908
1909    /// Run a parser method `f`, reverting back to the current position
1910    /// if unsuccessful.
1911    #[must_use]
1912    fn maybe_parse<T, F>(&mut self, mut f: F) -> Option<T>
1913    where
1914        F: FnMut(&mut Self) -> ModalResult<T>,
1915    {
1916        let checkpoint = *self;
1917        match f(self) {
1918            Ok(t) => Some(t),
1919            _ => {
1920                *self = checkpoint;
1921                None
1922            }
1923        }
1924    }
1925
1926    /// Parse either `ALL` or `DISTINCT`. Returns `true` if `DISTINCT` is parsed and results in a
1927    /// `ParserError` if both `ALL` and `DISTINCT` are fround.
1928    pub fn parse_all_or_distinct(&mut self) -> ModalResult<bool> {
1929        let all = self.parse_keyword(Keyword::ALL);
1930        let distinct = self.parse_keyword(Keyword::DISTINCT);
1931        if all && distinct {
1932            parser_err!("Cannot specify both ALL and DISTINCT")
1933        } else {
1934            Ok(distinct)
1935        }
1936    }
1937
1938    /// Parse either `ALL` or `DISTINCT` or `DISTINCT ON (<expr>)`.
1939    pub fn parse_all_or_distinct_on(&mut self) -> ModalResult<Distinct> {
1940        if self.parse_keywords(&[Keyword::DISTINCT, Keyword::ON]) {
1941            self.expect_token(&Token::LParen)?;
1942            let exprs = self.parse_comma_separated(Parser::parse_expr)?;
1943            self.expect_token(&Token::RParen)?;
1944            return Ok(Distinct::DistinctOn(exprs));
1945        } else if self.parse_keyword(Keyword::DISTINCT) {
1946            return Ok(Distinct::Distinct);
1947        };
1948        _ = self.parse_keyword(Keyword::ALL);
1949        Ok(Distinct::All)
1950    }
1951
1952    /// Parse a SQL CREATE statement
1953    pub fn parse_create(&mut self) -> ModalResult<Statement> {
1954        let or_replace = self.parse_keywords(&[Keyword::OR, Keyword::REPLACE]);
1955        let temporary = self
1956            .parse_one_of_keywords(&[Keyword::TEMP, Keyword::TEMPORARY])
1957            .is_some();
1958        if self.parse_keyword(Keyword::TABLE) {
1959            self.parse_create_table(or_replace, temporary)
1960        } else if self.parse_keyword(Keyword::VIEW) {
1961            self.parse_create_view(false, or_replace)
1962        } else if self.parse_keywords(&[Keyword::MATERIALIZED, Keyword::VIEW]) {
1963            self.parse_create_view(true, or_replace)
1964        } else if self.parse_keywords(&[Keyword::MATERIALIZED, Keyword::SOURCE]) {
1965            parser_err!("CREATE MATERIALIZED SOURCE has been deprecated, use CREATE TABLE instead")
1966        } else if self.parse_keyword(Keyword::SOURCE) {
1967            self.parse_create_source(or_replace, temporary)
1968        } else if self.parse_keyword(Keyword::SINK) {
1969            self.parse_create_sink(or_replace)
1970        } else if self.parse_keyword(Keyword::SUBSCRIPTION) {
1971            self.parse_create_subscription(or_replace)
1972        } else if self.parse_keyword(Keyword::CONNECTION) {
1973            self.parse_create_connection()
1974        } else if self.parse_keyword(Keyword::FUNCTION) {
1975            self.parse_create_function(or_replace, temporary)
1976        } else if self.parse_keyword(Keyword::AGGREGATE) {
1977            self.parse_create_aggregate(or_replace)
1978        } else if or_replace {
1979            self.expected(
1980                "[EXTERNAL] TABLE or [MATERIALIZED] VIEW or [MATERIALIZED] SOURCE or SINK or FUNCTION after CREATE OR REPLACE",
1981            )
1982        } else if self.parse_keyword(Keyword::INDEX) {
1983            self.parse_create_index(false)
1984        } else if self.parse_keywords(&[Keyword::UNIQUE, Keyword::INDEX]) {
1985            self.parse_create_index(true)
1986        } else if self.parse_keyword(Keyword::SCHEMA) {
1987            self.parse_create_schema()
1988        } else if self.parse_keyword(Keyword::DATABASE) {
1989            self.parse_create_database()
1990        } else if self.parse_keyword(Keyword::USER) {
1991            self.parse_create_user()
1992        } else if self.parse_keyword(Keyword::SECRET) {
1993            self.parse_create_secret()
1994        } else {
1995            self.expected("an object type after CREATE")
1996        }
1997    }
1998
1999    pub fn parse_create_schema(&mut self) -> ModalResult<Statement> {
2000        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
2001        let (schema_name, owner) = if self.parse_keyword(Keyword::AUTHORIZATION) {
2002            let owner = self.parse_object_name()?;
2003            (owner.clone(), Some(owner))
2004        } else {
2005            let schema_name = self.parse_object_name()?;
2006            let owner = if self.parse_keyword(Keyword::AUTHORIZATION) {
2007                Some(self.parse_object_name()?)
2008            } else {
2009                None
2010            };
2011            (schema_name, owner)
2012        };
2013        Ok(Statement::CreateSchema {
2014            schema_name,
2015            if_not_exists,
2016            owner,
2017        })
2018    }
2019
2020    pub fn parse_create_database(&mut self) -> ModalResult<Statement> {
2021        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
2022        let db_name = self.parse_object_name()?;
2023        let _ = self.parse_keyword(Keyword::WITH);
2024
2025        let mut owner = None;
2026        let mut resource_group = None;
2027        let mut barrier_interval_ms = None;
2028        let mut checkpoint_frequency = None;
2029
2030        loop {
2031            if let Some(keyword) =
2032                self.parse_one_of_keywords(&[Keyword::OWNER, Keyword::RESOURCE_GROUP])
2033            {
2034                match keyword {
2035                    Keyword::OWNER => {
2036                        if owner.is_some() {
2037                            parser_err!("duplicate OWNER clause in CREATE DATABASE");
2038                        }
2039
2040                        let _ = self.consume_token(&Token::Eq);
2041                        owner = Some(self.parse_object_name()?);
2042                    }
2043                    Keyword::RESOURCE_GROUP => {
2044                        if resource_group.is_some() {
2045                            parser_err!("duplicate RESOURCE_GROUP clause in CREATE DATABASE");
2046                        }
2047
2048                        let _ = self.consume_token(&Token::Eq);
2049                        resource_group = Some(self.parse_set_variable()?);
2050                    }
2051                    _ => unreachable!(),
2052                }
2053            } else if self.parse_word("BARRIER_INTERVAL_MS") {
2054                if barrier_interval_ms.is_some() {
2055                    parser_err!("duplicate BARRIER_INTERVAL_MS clause in CREATE DATABASE");
2056                }
2057
2058                let _ = self.consume_token(&Token::Eq);
2059                barrier_interval_ms = Some(self.parse_literal_u32()?);
2060            } else if self.parse_word("CHECKPOINT_FREQUENCY") {
2061                if checkpoint_frequency.is_some() {
2062                    parser_err!("duplicate CHECKPOINT_FREQUENCY clause in CREATE DATABASE");
2063                }
2064
2065                let _ = self.consume_token(&Token::Eq);
2066                checkpoint_frequency = Some(self.parse_literal_u64()?);
2067            } else {
2068                break;
2069            }
2070        }
2071
2072        Ok(Statement::CreateDatabase {
2073            db_name,
2074            if_not_exists,
2075            owner,
2076            resource_group,
2077            barrier_interval_ms,
2078            checkpoint_frequency,
2079        })
2080    }
2081
2082    pub fn parse_create_view(
2083        &mut self,
2084        materialized: bool,
2085        or_replace: bool,
2086    ) -> ModalResult<Statement> {
2087        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
2088        // Many dialects support `OR ALTER` right after `CREATE`, but we don't (yet).
2089        // ANSI SQL and Postgres support RECURSIVE here, but we don't support it either.
2090        let name = self.parse_object_name()?;
2091        let columns = self.parse_parenthesized_column_list(Optional)?;
2092        let with_options = self.parse_options_with_preceding_keyword(Keyword::WITH)?;
2093        self.expect_keyword(Keyword::AS)?;
2094        let query = Box::new(self.parse_query()?);
2095        let emit_mode = if materialized {
2096            self.parse_emit_mode()?
2097        } else {
2098            None
2099        };
2100        // Optional `WITH [ CASCADED | LOCAL ] CHECK OPTION` is widely supported here.
2101        Ok(Statement::CreateView {
2102            if_not_exists,
2103            name,
2104            columns,
2105            query,
2106            materialized,
2107            or_replace,
2108            with_options,
2109            emit_mode,
2110        })
2111    }
2112
2113    // CREATE [OR REPLACE]?
2114    // [TEMPORARY] SOURCE
2115    // [IF NOT EXISTS]?
2116    // <source_name: Ident>
2117    // [COLUMNS]?
2118    // [WITH (properties)]?
2119    // ROW FORMAT <row_format: Ident>
2120    // [ROW SCHEMA LOCATION <row_schema_location: String>]?
2121    pub fn parse_create_source(
2122        &mut self,
2123        _or_replace: bool,
2124        temporary: bool,
2125    ) -> ModalResult<Statement> {
2126        impl_parse_to!(if_not_exists => [Keyword::IF, Keyword::NOT, Keyword::EXISTS], self);
2127        impl_parse_to!(source_name: ObjectName, self);
2128
2129        // parse columns
2130        let (columns, constraints, source_watermarks, wildcard_idx) =
2131            self.parse_columns_with_watermark()?;
2132        let include_options = self.parse_include_options()?;
2133
2134        let with_options = self.parse_with_properties()?;
2135        let option = with_options
2136            .iter()
2137            .find(|&opt| opt.name.real_value() == UPSTREAM_SOURCE_KEY);
2138        let connector: String = option.map(|opt| opt.value.to_string()).unwrap_or_default();
2139        let cdc_source_job = connector.contains("-cdc");
2140        if cdc_source_job && (!columns.is_empty() || !constraints.is_empty()) {
2141            parser_err!("CDC source cannot define columns and constraints");
2142        }
2143
2144        // row format for nexmark source must be native
2145        // default row format for datagen source is native
2146        let format_encode = self.parse_format_encode_with_connector(&connector, cdc_source_job)?;
2147
2148        let stmt = CreateSourceStatement {
2149            temporary,
2150            if_not_exists,
2151            columns,
2152            wildcard_idx,
2153            constraints,
2154            source_name,
2155            with_properties: WithProperties(with_options),
2156            format_encode,
2157            source_watermarks,
2158            include_column_options: include_options,
2159        };
2160
2161        Ok(Statement::CreateSource { stmt })
2162    }
2163
2164    // CREATE [OR REPLACE]?
2165    // SINK
2166    // [IF NOT EXISTS]?
2167    // <sink_name: Ident>
2168    // FROM
2169    // <materialized_view: Ident>
2170    // [WITH (properties)]?
2171    pub fn parse_create_sink(&mut self, _or_replace: bool) -> ModalResult<Statement> {
2172        Ok(Statement::CreateSink {
2173            stmt: CreateSinkStatement::parse_to(self)?,
2174        })
2175    }
2176
2177    // CREATE
2178    // SUBSCRIPTION
2179    // [IF NOT EXISTS]?
2180    // <subscription_name: Ident>
2181    // FROM
2182    // <materialized_view: Ident>
2183    // [WITH (properties)]?
2184    pub fn parse_create_subscription(&mut self, _or_replace: bool) -> ModalResult<Statement> {
2185        Ok(Statement::CreateSubscription {
2186            stmt: CreateSubscriptionStatement::parse_to(self)?,
2187        })
2188    }
2189
2190    // CREATE
2191    // CONNECTION
2192    // [IF NOT EXISTS]?
2193    // <connection_name: Ident>
2194    // [WITH (properties)]?
2195    pub fn parse_create_connection(&mut self) -> ModalResult<Statement> {
2196        Ok(Statement::CreateConnection {
2197            stmt: CreateConnectionStatement::parse_to(self)?,
2198        })
2199    }
2200
2201    pub fn parse_create_function(
2202        &mut self,
2203        or_replace: bool,
2204        temporary: bool,
2205    ) -> ModalResult<Statement> {
2206        impl_parse_to!(if_not_exists => [Keyword::IF, Keyword::NOT, Keyword::EXISTS], self);
2207
2208        let FunctionDesc { name, args } = self.parse_function_desc()?;
2209
2210        let return_type = if self.parse_keyword(Keyword::RETURNS) {
2211            if self.parse_keyword(Keyword::TABLE) {
2212                self.expect_token(&Token::LParen)?;
2213                let mut values = vec![];
2214                loop {
2215                    values.push(self.parse_table_column_def()?);
2216                    let comma = self.consume_token(&Token::Comma);
2217                    if self.consume_token(&Token::RParen) {
2218                        // allow a trailing comma, even though it's not in standard
2219                        break;
2220                    } else if !comma {
2221                        return self.expected("',' or ')'");
2222                    }
2223                }
2224                Some(CreateFunctionReturns::Table(values))
2225            } else {
2226                Some(CreateFunctionReturns::Value(self.parse_data_type()?))
2227            }
2228        } else {
2229            None
2230        };
2231
2232        let params = self.parse_create_function_body()?;
2233        let with_options = self.parse_options_with_preceding_keyword(Keyword::WITH)?;
2234        let with_options = with_options.try_into()?;
2235        Ok(Statement::CreateFunction {
2236            or_replace,
2237            temporary,
2238            if_not_exists,
2239            name,
2240            args,
2241            returns: return_type,
2242            params,
2243            with_options,
2244        })
2245    }
2246
2247    fn parse_create_aggregate(&mut self, or_replace: bool) -> ModalResult<Statement> {
2248        impl_parse_to!(if_not_exists => [Keyword::IF, Keyword::NOT, Keyword::EXISTS], self);
2249
2250        let name = self.parse_object_name()?;
2251        self.expect_token(&Token::LParen)?;
2252        let args = self.parse_comma_separated(Parser::parse_function_arg)?;
2253        self.expect_token(&Token::RParen)?;
2254
2255        self.expect_keyword(Keyword::RETURNS)?;
2256        let returns = self.parse_data_type()?;
2257
2258        let append_only = self.parse_keywords(&[Keyword::APPEND, Keyword::ONLY]);
2259        let params = self.parse_create_function_body()?;
2260
2261        Ok(Statement::CreateAggregate {
2262            or_replace,
2263            if_not_exists,
2264            name,
2265            args,
2266            returns,
2267            append_only,
2268            params,
2269        })
2270    }
2271
2272    pub fn parse_declare(&mut self) -> ModalResult<Statement> {
2273        Ok(Statement::DeclareCursor {
2274            stmt: DeclareCursorStatement::parse_to(self)?,
2275        })
2276    }
2277
2278    pub fn parse_fetch_cursor(&mut self) -> ModalResult<Statement> {
2279        Ok(Statement::FetchCursor {
2280            stmt: FetchCursorStatement::parse_to(self)?,
2281        })
2282    }
2283
2284    pub fn parse_close_cursor(&mut self) -> ModalResult<Statement> {
2285        Ok(Statement::CloseCursor {
2286            stmt: CloseCursorStatement::parse_to(self)?,
2287        })
2288    }
2289
2290    fn parse_table_column_def(&mut self) -> ModalResult<TableColumnDef> {
2291        Ok(TableColumnDef {
2292            name: self.parse_identifier_non_reserved()?,
2293            data_type: self.parse_data_type()?,
2294        })
2295    }
2296
2297    fn parse_function_arg(&mut self) -> ModalResult<OperateFunctionArg> {
2298        let mode = if self.parse_keyword(Keyword::IN) {
2299            Some(ArgMode::In)
2300        } else if self.parse_keyword(Keyword::OUT) {
2301            Some(ArgMode::Out)
2302        } else if self.parse_keyword(Keyword::INOUT) {
2303            Some(ArgMode::InOut)
2304        } else {
2305            None
2306        };
2307
2308        // parse: [ argname ] argtype
2309        let mut name = None;
2310        let mut data_type = self.parse_data_type()?;
2311        if let DataType::Custom(n) = &data_type
2312            && !matches!(self.peek_token().token, Token::Comma | Token::RParen)
2313        {
2314            // the first token is actually a name
2315            name = Some(n.0[0].clone());
2316            data_type = self.parse_data_type()?;
2317        }
2318
2319        let default_expr = if self.parse_keyword(Keyword::DEFAULT) || self.consume_token(&Token::Eq)
2320        {
2321            Some(self.parse_expr()?)
2322        } else {
2323            None
2324        };
2325        Ok(OperateFunctionArg {
2326            mode,
2327            name,
2328            data_type,
2329            default_expr,
2330        })
2331    }
2332
2333    fn parse_create_function_body(&mut self) -> ModalResult<CreateFunctionBody> {
2334        let mut body = CreateFunctionBody::default();
2335        loop {
2336            fn ensure_not_set<T>(field: &Option<T>, name: &str) -> ModalResult<()> {
2337                if field.is_some() {
2338                    parser_err!("{name} specified more than once");
2339                }
2340                Ok(())
2341            }
2342            if self.parse_keyword(Keyword::AS) {
2343                ensure_not_set(&body.as_, "AS")?;
2344                body.as_ = Some(self.parse_function_definition()?);
2345            } else if self.parse_keyword(Keyword::LANGUAGE) {
2346                ensure_not_set(&body.language, "LANGUAGE")?;
2347                body.language = Some(self.parse_identifier()?);
2348            } else if self.parse_keyword(Keyword::RUNTIME) {
2349                ensure_not_set(&body.runtime, "RUNTIME")?;
2350                body.runtime = Some(self.parse_identifier()?);
2351            } else if self.parse_keyword(Keyword::IMMUTABLE) {
2352                ensure_not_set(&body.behavior, "IMMUTABLE | STABLE | VOLATILE")?;
2353                body.behavior = Some(FunctionBehavior::Immutable);
2354            } else if self.parse_keyword(Keyword::STABLE) {
2355                ensure_not_set(&body.behavior, "IMMUTABLE | STABLE | VOLATILE")?;
2356                body.behavior = Some(FunctionBehavior::Stable);
2357            } else if self.parse_keyword(Keyword::VOLATILE) {
2358                ensure_not_set(&body.behavior, "IMMUTABLE | STABLE | VOLATILE")?;
2359                body.behavior = Some(FunctionBehavior::Volatile);
2360            } else if self.parse_keyword(Keyword::RETURN) {
2361                ensure_not_set(&body.return_, "RETURN")?;
2362                body.return_ = Some(self.parse_expr()?);
2363            } else if self.parse_keyword(Keyword::USING) {
2364                ensure_not_set(&body.using, "USING")?;
2365                body.using = Some(self.parse_create_function_using()?);
2366            } else {
2367                return Ok(body);
2368            }
2369        }
2370    }
2371
2372    fn parse_create_function_using(&mut self) -> ModalResult<CreateFunctionUsing> {
2373        let keyword = self.expect_one_of_keywords(&[Keyword::LINK, Keyword::BASE64])?;
2374
2375        match keyword {
2376            Keyword::LINK => {
2377                let uri = self.parse_literal_string()?;
2378                Ok(CreateFunctionUsing::Link(uri))
2379            }
2380            Keyword::BASE64 => {
2381                let base64 = self.parse_literal_string()?;
2382                Ok(CreateFunctionUsing::Base64(base64))
2383            }
2384            _ => unreachable!("{}", keyword),
2385        }
2386    }
2387
2388    // CREATE USER name [ [ WITH ] option [ ... ] ]
2389    // where option can be:
2390    //       SUPERUSER | NOSUPERUSER
2391    //     | CREATEDB | NOCREATEDB
2392    //     | CREATEUSER | NOCREATEUSER
2393    //     | LOGIN | NOLOGIN
2394    //     | [ ENCRYPTED ] PASSWORD 'password' | PASSWORD NULL | OAUTH
2395    fn parse_create_user(&mut self) -> ModalResult<Statement> {
2396        Ok(Statement::CreateUser(CreateUserStatement::parse_to(self)?))
2397    }
2398
2399    fn parse_create_secret(&mut self) -> ModalResult<Statement> {
2400        Ok(Statement::CreateSecret {
2401            stmt: CreateSecretStatement::parse_to(self)?,
2402        })
2403    }
2404
2405    pub fn parse_with_properties(&mut self) -> ModalResult<Vec<SqlOption>> {
2406        self.parse_options_with_preceding_keyword(Keyword::WITH)
2407    }
2408
2409    pub fn parse_discard(&mut self) -> ModalResult<Statement> {
2410        self.expect_keyword(Keyword::ALL)?;
2411        Ok(Statement::Discard(DiscardType::All))
2412    }
2413
2414    pub fn parse_drop(&mut self) -> ModalResult<Statement> {
2415        if self.parse_keyword(Keyword::FUNCTION) {
2416            return self.parse_drop_function();
2417        } else if self.parse_keyword(Keyword::AGGREGATE) {
2418            return self.parse_drop_aggregate();
2419        }
2420        Ok(Statement::Drop(DropStatement::parse_to(self)?))
2421    }
2422
2423    /// ```sql
2424    /// DROP FUNCTION [ IF EXISTS ] name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] [, ...]
2425    /// [ CASCADE | RESTRICT ]
2426    /// ```
2427    fn parse_drop_function(&mut self) -> ModalResult<Statement> {
2428        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
2429        let func_desc = self.parse_comma_separated(Parser::parse_function_desc)?;
2430        let option = match self.parse_one_of_keywords(&[Keyword::CASCADE, Keyword::RESTRICT]) {
2431            Some(Keyword::CASCADE) => Some(ReferentialAction::Cascade),
2432            Some(Keyword::RESTRICT) => Some(ReferentialAction::Restrict),
2433            _ => None,
2434        };
2435        Ok(Statement::DropFunction {
2436            if_exists,
2437            func_desc,
2438            option,
2439        })
2440    }
2441
2442    /// ```sql
2443    /// DROP AGGREGATE [ IF EXISTS ] name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] [, ...]
2444    /// [ CASCADE | RESTRICT ]
2445    /// ```
2446    fn parse_drop_aggregate(&mut self) -> ModalResult<Statement> {
2447        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
2448        let func_desc = self.parse_comma_separated(Parser::parse_function_desc)?;
2449        let option = match self.parse_one_of_keywords(&[Keyword::CASCADE, Keyword::RESTRICT]) {
2450            Some(Keyword::CASCADE) => Some(ReferentialAction::Cascade),
2451            Some(Keyword::RESTRICT) => Some(ReferentialAction::Restrict),
2452            _ => None,
2453        };
2454        Ok(Statement::DropAggregate {
2455            if_exists,
2456            func_desc,
2457            option,
2458        })
2459    }
2460
2461    fn parse_function_desc(&mut self) -> ModalResult<FunctionDesc> {
2462        let name = self.parse_object_name()?;
2463
2464        let args = if self.consume_token(&Token::LParen) {
2465            if self.consume_token(&Token::RParen) {
2466                Some(vec![])
2467            } else {
2468                let args = self.parse_comma_separated(Parser::parse_function_arg)?;
2469                self.expect_token(&Token::RParen)?;
2470                Some(args)
2471            }
2472        } else {
2473            None
2474        };
2475
2476        Ok(FunctionDesc { name, args })
2477    }
2478
2479    pub fn parse_create_index(&mut self, unique: bool) -> ModalResult<Statement> {
2480        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
2481        let index_name = self.parse_object_name()?;
2482        self.expect_keyword(Keyword::ON)?;
2483        let table_name = self.parse_object_name()?;
2484        let method = if self.parse_keyword(Keyword::USING) {
2485            let method = self.parse_identifier()?;
2486            Some(method)
2487        } else {
2488            None
2489        };
2490        self.expect_token(&Token::LParen)?;
2491        let columns = self.parse_comma_separated(Parser::parse_order_by_expr)?;
2492        self.expect_token(&Token::RParen)?;
2493        let mut include = vec![];
2494        if self.parse_keyword(Keyword::INCLUDE) {
2495            self.expect_token(&Token::LParen)?;
2496            include = self.parse_comma_separated(Parser::parse_identifier_non_reserved)?;
2497            self.expect_token(&Token::RParen)?;
2498        }
2499        let mut distributed_by = vec![];
2500        if self.parse_keywords(&[Keyword::DISTRIBUTED, Keyword::BY]) {
2501            self.expect_token(&Token::LParen)?;
2502            distributed_by = self.parse_comma_separated(Parser::parse_expr)?;
2503            self.expect_token(&Token::RParen)?;
2504        }
2505        let with_properties = WithProperties(self.parse_with_properties()?);
2506
2507        Ok(Statement::CreateIndex {
2508            name: index_name,
2509            table_name,
2510            method,
2511            columns,
2512            include,
2513            distributed_by,
2514            unique,
2515            if_not_exists,
2516            with_properties,
2517        })
2518    }
2519
2520    pub fn parse_with_version_columns(&mut self) -> ModalResult<Vec<Ident>> {
2521        if self.parse_keywords(&[Keyword::WITH, Keyword::VERSION, Keyword::COLUMN]) {
2522            self.expect_token(&Token::LParen)?;
2523            let columns =
2524                self.parse_comma_separated(|parser| parser.parse_identifier_non_reserved())?;
2525            self.expect_token(&Token::RParen)?;
2526            Ok(columns)
2527        } else {
2528            Ok(Vec::new())
2529        }
2530    }
2531
2532    pub fn parse_on_conflict(&mut self) -> ModalResult<Option<OnConflict>> {
2533        if self.parse_keywords(&[Keyword::ON, Keyword::CONFLICT]) {
2534            self.parse_handle_conflict_behavior()
2535        } else {
2536            Ok(None)
2537        }
2538    }
2539
2540    pub fn parse_create_table(
2541        &mut self,
2542        or_replace: bool,
2543        temporary: bool,
2544    ) -> ModalResult<Statement> {
2545        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
2546        let table_name = self.parse_object_name()?;
2547        // parse optional column list (schema) and watermarks on source.
2548        let (columns, constraints, source_watermarks, wildcard_idx) =
2549            self.parse_columns_with_watermark()?;
2550
2551        let append_only = if self.parse_keyword(Keyword::APPEND) {
2552            self.expect_keyword(Keyword::ONLY)?;
2553            true
2554        } else {
2555            false
2556        };
2557
2558        let on_conflict = self.parse_on_conflict()?;
2559
2560        let with_version_columns = self.parse_with_version_columns()?;
2561        let include_options = self.parse_include_options()?;
2562
2563        // PostgreSQL supports `WITH ( options )`, before `AS`
2564        let with_options = self.parse_with_properties()?;
2565
2566        let option = with_options
2567            .iter()
2568            .find(|&opt| opt.name.real_value() == UPSTREAM_SOURCE_KEY);
2569        let connector = option.map(|opt| opt.value.to_string());
2570        let contain_webhook =
2571            connector.is_some() && connector.as_ref().unwrap().contains(WEBHOOK_CONNECTOR);
2572
2573        // webhook connector does not require row format
2574        let format_encode = if let Some(connector) = connector
2575            && !contain_webhook
2576        {
2577            Some(self.parse_format_encode_with_connector(&connector, false)?)
2578        } else {
2579            None // Table is NOT created with an external connector.
2580        };
2581        // Parse optional `AS ( query )`
2582        let query = if self.parse_keyword(Keyword::AS) {
2583            if !source_watermarks.is_empty() {
2584                parser_err!("Watermarks can't be defined on table created by CREATE TABLE AS");
2585            }
2586            Some(Box::new(self.parse_query()?))
2587        } else {
2588            None
2589        };
2590
2591        let cdc_table_info = if self.parse_keyword(Keyword::FROM) {
2592            let source_name = self.parse_object_name()?;
2593            self.expect_keyword(Keyword::TABLE)?;
2594            let external_table_name = self.parse_literal_string()?;
2595            Some(CdcTableInfo {
2596                source_name,
2597                external_table_name,
2598            })
2599        } else {
2600            None
2601        };
2602
2603        let webhook_info = if self.parse_keyword(Keyword::VALIDATE) {
2604            if !contain_webhook {
2605                parser_err!("VALIDATE is only supported for tables created with webhook source");
2606            }
2607
2608            let wait_for_persistence = with_options
2609                .iter()
2610                .find(|&opt| opt.name.real_value() == WEBHOOK_WAIT_FOR_PERSISTENCE)
2611                .map(|opt| opt.value.to_string().eq_ignore_ascii_case("true"))
2612                .unwrap_or(true);
2613            let secret_ref = if self.parse_keyword(Keyword::SECRET) {
2614                let secret_ref = self.parse_secret_ref()?;
2615                if secret_ref.ref_as == SecretRefAsType::File {
2616                    parser_err!("Secret for SECURE_COMPARE() does not support AS FILE");
2617                };
2618                Some(secret_ref)
2619            } else {
2620                None
2621            };
2622
2623            self.expect_keyword(Keyword::AS)?;
2624            let signature_expr = self.parse_function()?;
2625
2626            let is_batched = with_options
2627                .iter()
2628                .find(|&opt| opt.name.real_value() == WEBHOOK_IS_BATCHED)
2629                .map(|opt| opt.value.to_string().eq_ignore_ascii_case("true"))
2630                .unwrap_or(false);
2631
2632            Some(WebhookSourceInfo {
2633                secret_ref,
2634                signature_expr,
2635                wait_for_persistence,
2636                is_batched,
2637            })
2638        } else {
2639            None
2640        };
2641
2642        let engine = if self.parse_keyword(Keyword::ENGINE) {
2643            self.expect_token(&Token::Eq)?;
2644            let engine_name = self.parse_object_name()?;
2645            if "iceberg".eq_ignore_ascii_case(&engine_name.real_value()) {
2646                Engine::Iceberg
2647            } else if "hummock".eq_ignore_ascii_case(&engine_name.real_value()) {
2648                Engine::Hummock
2649            } else {
2650                parser_err!("Unsupported engine: {}", engine_name);
2651            }
2652        } else {
2653            Engine::Hummock
2654        };
2655
2656        Ok(Statement::CreateTable {
2657            name: table_name,
2658            temporary,
2659            columns,
2660            wildcard_idx,
2661            constraints,
2662            with_options,
2663            or_replace,
2664            if_not_exists,
2665            format_encode,
2666            source_watermarks,
2667            append_only,
2668            on_conflict,
2669            with_version_columns,
2670            query,
2671            cdc_table_info,
2672            include_column_options: include_options,
2673            webhook_info,
2674            engine,
2675        })
2676    }
2677
2678    pub fn parse_include_options(&mut self) -> ModalResult<IncludeOption> {
2679        let mut options = vec![];
2680        while self.parse_keyword(Keyword::INCLUDE) {
2681            let column_type = self.parse_identifier()?;
2682
2683            let mut column_inner_field = None;
2684            let mut header_inner_expect_type = None;
2685            if let Token::SingleQuotedString(inner_field) = self.peek_token().token {
2686                self.next_token();
2687                column_inner_field = Some(inner_field);
2688
2689                // `verify` rejects `DataType::Custom` so that a following `INCLUDE` (or even `WITH`)
2690                // will not be misrecognized as a DataType.
2691                //
2692                // For example, the following look structurally the same because `INCLUDE` is not a
2693                // reserved keyword. (`AS` is reserved.)
2694                // * `INCLUDE header 'foo' varchar`
2695                // * `INCLUDE header 'foo' INCLUDE`
2696                //
2697                // To be honest `bytea` shall be a `DataType::Custom` rather than a keyword, and the
2698                // logic here shall be:
2699                // ```
2700                // match dt {
2701                //     DataType::Custom(name) => allowed.contains(name.real_value()),
2702                //     _ => true,
2703                // }
2704                // ```
2705                // An allowlist is better than a denylist, as the following token may be other than
2706                // `INCLUDE` or `WITH` in the future.
2707                //
2708                // If this sounds too complicated - it means we should have designed this extension
2709                // syntax differently to make ambiguity handling easier.
2710                header_inner_expect_type =
2711                    opt(parser_v2::data_type.verify(|dt| !matches!(dt, DataType::Custom(_))))
2712                        .parse_next(self)?;
2713            }
2714
2715            let mut column_alias = None;
2716            if self.parse_keyword(Keyword::AS) {
2717                column_alias = Some(self.parse_identifier()?);
2718            }
2719
2720            options.push(IncludeOptionItem {
2721                column_type,
2722                inner_field: column_inner_field,
2723                column_alias,
2724                header_inner_expect_type,
2725            });
2726
2727            // tolerate previous bug #18800 of displaying with comma separation
2728            let _ = self.consume_token(&Token::Comma);
2729        }
2730        Ok(options)
2731    }
2732
2733    pub fn parse_columns_with_watermark(&mut self) -> ModalResult<ColumnsDefTuple> {
2734        let mut columns = vec![];
2735        let mut constraints = vec![];
2736        let mut watermarks = vec![];
2737        let mut wildcard_idx = None;
2738        if !self.consume_token(&Token::LParen) || self.consume_token(&Token::RParen) {
2739            return Ok((columns, constraints, watermarks, wildcard_idx));
2740        }
2741
2742        loop {
2743            if self.consume_token(&Token::Mul) {
2744                if wildcard_idx.is_none() {
2745                    wildcard_idx = Some(columns.len());
2746                } else {
2747                    parser_err!("At most 1 wildcard is allowed in source definition");
2748                }
2749            } else if let Some(constraint) = self.parse_optional_table_constraint()? {
2750                constraints.push(constraint);
2751            } else if let Some(watermark) = self.parse_optional_watermark()? {
2752                watermarks.push(watermark);
2753                if watermarks.len() > 1 {
2754                    // TODO(yuhao): allow multiple watermark on source.
2755                    parser_err!("Only 1 watermark is allowed to be defined on source.");
2756                }
2757            } else if let Token::Word(_) = self.peek_token().token {
2758                columns.push(self.parse_column_def()?);
2759            } else {
2760                return self.expected("column name or constraint definition");
2761            }
2762            let comma = self.consume_token(&Token::Comma);
2763            if self.consume_token(&Token::RParen) {
2764                // allow a trailing comma, even though it's not in standard
2765                break;
2766            } else if !comma {
2767                return self.expected("',' or ')' after column definition");
2768            }
2769        }
2770
2771        Ok((columns, constraints, watermarks, wildcard_idx))
2772    }
2773
2774    fn parse_column_def(&mut self) -> ModalResult<ColumnDef> {
2775        let name = self.parse_identifier_non_reserved()?;
2776        let data_type = if let Token::Word(_) = self.peek_token().token {
2777            Some(self.parse_data_type()?)
2778        } else {
2779            None
2780        };
2781
2782        let collation = if self.parse_keyword(Keyword::COLLATE) {
2783            Some(self.parse_object_name()?)
2784        } else {
2785            None
2786        };
2787        let mut options = vec![];
2788        loop {
2789            if self.parse_keyword(Keyword::CONSTRAINT) {
2790                let name = Some(self.parse_identifier_non_reserved()?);
2791                if let Some(option) = self.parse_optional_column_option()? {
2792                    options.push(ColumnOptionDef { name, option });
2793                } else {
2794                    return self.expected("constraint details after CONSTRAINT <name>");
2795                }
2796            } else if let Some(option) = self.parse_optional_column_option()? {
2797                options.push(ColumnOptionDef { name: None, option });
2798            } else {
2799                break;
2800            };
2801        }
2802        Ok(ColumnDef {
2803            name,
2804            data_type,
2805            collation,
2806            options,
2807        })
2808    }
2809
2810    pub fn parse_optional_column_option(&mut self) -> ModalResult<Option<ColumnOption>> {
2811        if self.parse_keywords(&[Keyword::NOT, Keyword::NULL]) {
2812            Ok(Some(ColumnOption::NotNull))
2813        } else if self.parse_keyword(Keyword::NULL) {
2814            Ok(Some(ColumnOption::Null))
2815        } else if self.parse_keyword(Keyword::DEFAULT) {
2816            if self.parse_keyword(Keyword::INTERNAL) {
2817                Ok(Some(ColumnOption::DefaultValueInternal {
2818                    // Placeholder. Will fill during definition purification for schema change.
2819                    persisted: Default::default(),
2820                    expr: None,
2821                }))
2822            } else {
2823                Ok(Some(ColumnOption::DefaultValue(self.parse_expr()?)))
2824            }
2825        } else if self.parse_keywords(&[Keyword::PRIMARY, Keyword::KEY]) {
2826            Ok(Some(ColumnOption::Unique { is_primary: true }))
2827        } else if self.parse_keyword(Keyword::UNIQUE) {
2828            Ok(Some(ColumnOption::Unique { is_primary: false }))
2829        } else if self.parse_keyword(Keyword::REFERENCES) {
2830            let foreign_table = self.parse_object_name()?;
2831            // PostgreSQL allows omitting the column list and
2832            // uses the primary key column of the foreign table by default
2833            let referred_columns = self.parse_parenthesized_column_list(Optional)?;
2834            let mut on_delete = None;
2835            let mut on_update = None;
2836            loop {
2837                if on_delete.is_none() && self.parse_keywords(&[Keyword::ON, Keyword::DELETE]) {
2838                    on_delete = Some(self.parse_referential_action()?);
2839                } else if on_update.is_none()
2840                    && self.parse_keywords(&[Keyword::ON, Keyword::UPDATE])
2841                {
2842                    on_update = Some(self.parse_referential_action()?);
2843                } else {
2844                    break;
2845                }
2846            }
2847            Ok(Some(ColumnOption::ForeignKey {
2848                foreign_table,
2849                referred_columns,
2850                on_delete,
2851                on_update,
2852            }))
2853        } else if self.parse_keyword(Keyword::CHECK) {
2854            self.expect_token(&Token::LParen)?;
2855            let expr = self.parse_expr()?;
2856            self.expect_token(&Token::RParen)?;
2857            Ok(Some(ColumnOption::Check(expr)))
2858        } else if self.parse_keyword(Keyword::AS) {
2859            Ok(Some(ColumnOption::GeneratedColumns(self.parse_expr()?)))
2860        } else {
2861            Ok(None)
2862        }
2863    }
2864
2865    pub fn parse_handle_conflict_behavior(&mut self) -> ModalResult<Option<OnConflict>> {
2866        if self.parse_keyword(Keyword::OVERWRITE) {
2867            // compatible with v1.9 - v2.0
2868            Ok(Some(OnConflict::UpdateFull))
2869        } else if self.parse_keyword(Keyword::IGNORE) {
2870            // compatible with v1.9 - v2.0
2871            Ok(Some(OnConflict::Nothing))
2872        } else if self.parse_keywords(&[
2873            Keyword::DO,
2874            Keyword::UPDATE,
2875            Keyword::IF,
2876            Keyword::NOT,
2877            Keyword::NULL,
2878        ]) {
2879            Ok(Some(OnConflict::UpdateIfNotNull))
2880        } else if self.parse_keywords(&[Keyword::DO, Keyword::UPDATE, Keyword::FULL]) {
2881            Ok(Some(OnConflict::UpdateFull))
2882        } else if self.parse_keywords(&[Keyword::DO, Keyword::NOTHING]) {
2883            Ok(Some(OnConflict::Nothing))
2884        } else {
2885            Ok(None)
2886        }
2887    }
2888
2889    pub fn parse_referential_action(&mut self) -> ModalResult<ReferentialAction> {
2890        if self.parse_keyword(Keyword::RESTRICT) {
2891            Ok(ReferentialAction::Restrict)
2892        } else if self.parse_keyword(Keyword::CASCADE) {
2893            Ok(ReferentialAction::Cascade)
2894        } else if self.parse_keywords(&[Keyword::SET, Keyword::NULL]) {
2895            Ok(ReferentialAction::SetNull)
2896        } else if self.parse_keywords(&[Keyword::NO, Keyword::ACTION]) {
2897            Ok(ReferentialAction::NoAction)
2898        } else if self.parse_keywords(&[Keyword::SET, Keyword::DEFAULT]) {
2899            Ok(ReferentialAction::SetDefault)
2900        } else {
2901            self.expected("one of RESTRICT, CASCADE, SET NULL, NO ACTION or SET DEFAULT")
2902        }
2903    }
2904
2905    pub fn parse_optional_watermark(&mut self) -> ModalResult<Option<SourceWatermark>> {
2906        if self.parse_keyword(Keyword::WATERMARK) {
2907            self.expect_keyword(Keyword::FOR)?;
2908            let column = self.parse_identifier_non_reserved()?;
2909            self.expect_keyword(Keyword::AS)?;
2910            let expr = self.parse_expr()?;
2911            let with_ttl = self.parse_keywords(&[Keyword::WITH, Keyword::TTL]);
2912            Ok(Some(SourceWatermark {
2913                column,
2914                expr,
2915                with_ttl,
2916            }))
2917        } else {
2918            Ok(None)
2919        }
2920    }
2921
2922    pub fn parse_optional_table_constraint(&mut self) -> ModalResult<Option<TableConstraint>> {
2923        let name = if self.parse_keyword(Keyword::CONSTRAINT) {
2924            Some(self.parse_identifier_non_reserved()?)
2925        } else {
2926            None
2927        };
2928        let checkpoint = *self;
2929        let token = self.next_token();
2930        match token.token {
2931            Token::Word(w) if w.keyword == Keyword::PRIMARY || w.keyword == Keyword::UNIQUE => {
2932                let is_primary = w.keyword == Keyword::PRIMARY;
2933                if is_primary {
2934                    self.expect_keyword(Keyword::KEY)?;
2935                }
2936                let columns = self.parse_parenthesized_column_list(Mandatory)?;
2937                Ok(Some(TableConstraint::Unique {
2938                    name,
2939                    columns,
2940                    is_primary,
2941                }))
2942            }
2943            Token::Word(w) if w.keyword == Keyword::FOREIGN => {
2944                self.expect_keyword(Keyword::KEY)?;
2945                let columns = self.parse_parenthesized_column_list(Mandatory)?;
2946                self.expect_keyword(Keyword::REFERENCES)?;
2947                let foreign_table = self.parse_object_name()?;
2948                let referred_columns = self.parse_parenthesized_column_list(Mandatory)?;
2949                let mut on_delete = None;
2950                let mut on_update = None;
2951                loop {
2952                    if on_delete.is_none() && self.parse_keywords(&[Keyword::ON, Keyword::DELETE]) {
2953                        on_delete = Some(self.parse_referential_action()?);
2954                    } else if on_update.is_none()
2955                        && self.parse_keywords(&[Keyword::ON, Keyword::UPDATE])
2956                    {
2957                        on_update = Some(self.parse_referential_action()?);
2958                    } else {
2959                        break;
2960                    }
2961                }
2962                Ok(Some(TableConstraint::ForeignKey {
2963                    name,
2964                    columns,
2965                    foreign_table,
2966                    referred_columns,
2967                    on_delete,
2968                    on_update,
2969                }))
2970            }
2971            Token::Word(w) if w.keyword == Keyword::CHECK => {
2972                self.expect_token(&Token::LParen)?;
2973                let expr = Box::new(self.parse_expr()?);
2974                self.expect_token(&Token::RParen)?;
2975                Ok(Some(TableConstraint::Check { name, expr }))
2976            }
2977            _ => {
2978                *self = checkpoint;
2979                if name.is_some() {
2980                    self.expected("PRIMARY, UNIQUE, FOREIGN, or CHECK")
2981                } else {
2982                    Ok(None)
2983                }
2984            }
2985        }
2986    }
2987
2988    pub fn parse_options_with_preceding_keyword(
2989        &mut self,
2990        keyword: Keyword,
2991    ) -> ModalResult<Vec<SqlOption>> {
2992        if self.parse_keyword(keyword) {
2993            self.expect_token(&Token::LParen)?;
2994            self.parse_options_inner()
2995        } else {
2996            Ok(vec![])
2997        }
2998    }
2999
3000    pub fn parse_options(&mut self) -> ModalResult<Vec<SqlOption>> {
3001        if self.peek_token() == Token::LParen {
3002            self.next_token();
3003            self.parse_options_inner()
3004        } else {
3005            Ok(vec![])
3006        }
3007    }
3008
3009    // has parsed a LParen
3010    pub fn parse_options_inner(&mut self) -> ModalResult<Vec<SqlOption>> {
3011        let mut values = vec![];
3012        loop {
3013            values.push(Parser::parse_sql_option(self)?);
3014            let comma = self.consume_token(&Token::Comma);
3015            if self.consume_token(&Token::RParen) {
3016                // allow a trailing comma, even though it's not in standard
3017                break;
3018            } else if !comma {
3019                return self.expected("',' or ')' after option definition");
3020            }
3021        }
3022        Ok(values)
3023    }
3024
3025    pub fn parse_sql_option(&mut self) -> ModalResult<SqlOption> {
3026        const CONNECTION_REF_KEY: &str = "connection";
3027        const BACKFILL_ORDER: &str = "backfill_order";
3028
3029        let name = self.parse_object_name()?;
3030        self.expect_token(&Token::Eq)?;
3031        let value = {
3032            if name.real_value().eq_ignore_ascii_case(CONNECTION_REF_KEY) {
3033                let connection_name = self.parse_object_name()?;
3034                // tolerate previous buggy Display that outputs `connection = connection foo`
3035                let connection_name = match connection_name.0.as_slice() {
3036                    [ident] if ident.real_value() == CONNECTION_REF_KEY => {
3037                        self.parse_object_name()?
3038                    }
3039                    _ => connection_name,
3040                };
3041                SqlOptionValue::ConnectionRef(ConnectionRefValue { connection_name })
3042            } else if name.real_value().eq_ignore_ascii_case(BACKFILL_ORDER) {
3043                let order = self.parse_backfill_order_strategy()?;
3044                SqlOptionValue::BackfillOrder(order)
3045            } else {
3046                self.parse_value_and_obj_ref::<false>()?
3047            }
3048        };
3049        Ok(SqlOption { name, value })
3050    }
3051
3052    // <config_param> { TO | = } { <value> | DEFAULT }
3053    // <config_param> is not a keyword, but an identifier
3054    pub fn parse_config_param(&mut self) -> ModalResult<ConfigParam> {
3055        let param = self.parse_identifier()?;
3056        if !self.consume_token(&Token::Eq) && !self.parse_keyword(Keyword::TO) {
3057            return self.expected("'=' or 'TO' after config parameter");
3058        }
3059        let value = self.parse_set_variable()?;
3060        Ok(ConfigParam { param, value })
3061    }
3062
3063    pub fn parse_since(&mut self) -> ModalResult<Since> {
3064        if self.parse_keyword(Keyword::SINCE) {
3065            let checkpoint = *self;
3066            let token = self.next_token();
3067            match token.token {
3068                Token::Word(w) => {
3069                    let ident = w.to_ident()?;
3070                    // Backward compatibility for now.
3071                    if ident.real_value() == "proctime" || ident.real_value() == "now" {
3072                        self.expect_token(&Token::LParen)?;
3073                        self.expect_token(&Token::RParen)?;
3074                        Ok(Since::ProcessTime)
3075                    } else if ident.real_value() == "begin" {
3076                        self.expect_token(&Token::LParen)?;
3077                        self.expect_token(&Token::RParen)?;
3078                        Ok(Since::Begin)
3079                    } else {
3080                        parser_err!(
3081                            "Expected proctime(), begin() or now(), found: {}",
3082                            ident.real_value()
3083                        )
3084                    }
3085                }
3086                Token::Number(s) => {
3087                    let num = s
3088                        .parse::<u64>()
3089                        .map_err(|e| StrError(format!("Could not parse '{}' as u64: {}", s, e)))?;
3090                    Ok(Since::TimestampMsNum(num))
3091                }
3092                _ => self.expected_at(checkpoint, "proctime(), begin() , now(), Number"),
3093            }
3094        } else if self.parse_word("FULL") {
3095            Ok(Since::Full)
3096        } else {
3097            Ok(Since::ProcessTime)
3098        }
3099    }
3100
3101    pub fn parse_emit_mode(&mut self) -> ModalResult<Option<EmitMode>> {
3102        if self.parse_keyword(Keyword::EMIT) {
3103            match self.parse_one_of_keywords(&[Keyword::IMMEDIATELY, Keyword::ON]) {
3104                Some(Keyword::IMMEDIATELY) => Ok(Some(EmitMode::Immediately)),
3105                Some(Keyword::ON) => {
3106                    self.expect_keywords(&[Keyword::WINDOW, Keyword::CLOSE])?;
3107                    Ok(Some(EmitMode::OnWindowClose))
3108                }
3109                Some(_) => unreachable!(),
3110                None => self.expected("IMMEDIATELY or ON WINDOW CLOSE after EMIT"),
3111            }
3112        } else {
3113            Ok(None)
3114        }
3115    }
3116
3117    pub fn parse_alter(&mut self) -> ModalResult<Statement> {
3118        if self.parse_keyword(Keyword::DATABASE) {
3119            self.parse_alter_database()
3120        } else if self.parse_keyword(Keyword::SCHEMA) {
3121            self.parse_alter_schema()
3122        } else if self.parse_keyword(Keyword::TABLE) {
3123            self.parse_alter_table()
3124        } else if self.parse_keyword(Keyword::INDEX) {
3125            self.parse_alter_index()
3126        } else if self.parse_keyword(Keyword::VIEW) {
3127            self.parse_alter_view(false)
3128        } else if self.parse_keywords(&[Keyword::MATERIALIZED, Keyword::VIEW]) {
3129            self.parse_alter_view(true)
3130        } else if self.parse_keyword(Keyword::SINK) {
3131            self.parse_alter_sink()
3132        } else if self.parse_keyword(Keyword::SOURCE) {
3133            self.parse_alter_source()
3134        } else if self.parse_keyword(Keyword::FUNCTION) {
3135            self.parse_alter_function()
3136        } else if self.parse_keyword(Keyword::CONNECTION) {
3137            self.parse_alter_connection()
3138        } else if self.parse_keyword(Keyword::USER) {
3139            self.parse_alter_user()
3140        } else if self.parse_keyword(Keyword::SYSTEM) {
3141            self.parse_alter_system()
3142        } else if self.parse_keyword(Keyword::SUBSCRIPTION) {
3143            self.parse_alter_subscription()
3144        } else if self.parse_keyword(Keyword::SECRET) {
3145            self.parse_alter_secret()
3146        } else if self.parse_word("FRAGMENT") {
3147            self.parse_alter_fragment()
3148        } else if self.parse_keywords(&[Keyword::DEFAULT, Keyword::PRIVILEGES]) {
3149            self.parse_alter_default_privileges()
3150        } else {
3151            self.expected(
3152                "DATABASE, FRAGMENT, SCHEMA, TABLE, INDEX, MATERIALIZED, VIEW, SINK, SUBSCRIPTION, SOURCE, FUNCTION, USER, SECRET or SYSTEM after ALTER"
3153            )
3154        }
3155    }
3156
3157    pub fn parse_alter_database(&mut self) -> ModalResult<Statement> {
3158        let database_name = self.parse_object_name()?;
3159        let operation = if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
3160            let owner_name: Ident = self.parse_identifier()?;
3161            AlterDatabaseOperation::ChangeOwner {
3162                new_owner_name: owner_name,
3163            }
3164        } else if self.parse_keyword(Keyword::RENAME) {
3165            if self.parse_keyword(Keyword::TO) {
3166                let database_name = self.parse_object_name()?;
3167                AlterDatabaseOperation::RenameDatabase { database_name }
3168            } else {
3169                return self.expected("TO after RENAME");
3170            }
3171        } else if self.parse_keyword(Keyword::SET) {
3172            // check will be delayed to frontend
3173            AlterDatabaseOperation::SetParam(self.parse_config_param()?)
3174        } else {
3175            return self.expected("RENAME, OWNER TO, OR SET after ALTER DATABASE");
3176        };
3177
3178        Ok(Statement::AlterDatabase {
3179            name: database_name,
3180            operation,
3181        })
3182    }
3183
3184    pub fn parse_alter_schema(&mut self) -> ModalResult<Statement> {
3185        let schema_name = self.parse_object_name()?;
3186        let operation = if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
3187            let owner_name: Ident = self.parse_identifier()?;
3188            AlterSchemaOperation::ChangeOwner {
3189                new_owner_name: owner_name,
3190            }
3191        } else if self.parse_keyword(Keyword::RENAME) {
3192            self.expect_keyword(Keyword::TO)?;
3193            let schema_name = self.parse_object_name()?;
3194            AlterSchemaOperation::RenameSchema { schema_name }
3195        } else if self.parse_keywords(&[Keyword::SWAP, Keyword::WITH]) {
3196            let target_schema = self.parse_object_name()?;
3197            AlterSchemaOperation::SwapRenameSchema { target_schema }
3198        } else {
3199            return self.expected("RENAME, OWNER TO, OR SWAP WITH after ALTER SCHEMA");
3200        };
3201
3202        Ok(Statement::AlterSchema {
3203            name: schema_name,
3204            operation,
3205        })
3206    }
3207
3208    pub fn parse_alter_user(&mut self) -> ModalResult<Statement> {
3209        Ok(Statement::AlterUser(AlterUserStatement::parse_to(self)?))
3210    }
3211
3212    pub fn parse_alter_table(&mut self) -> ModalResult<Statement> {
3213        let _ = self.parse_keyword(Keyword::ONLY);
3214        let table_name = self.parse_object_name()?;
3215        let operation = if self.parse_keyword(Keyword::ADD) {
3216            if let Some(constraint) = self.parse_optional_table_constraint()? {
3217                AlterTableOperation::AddConstraint(constraint)
3218            } else {
3219                let _ = self.parse_keyword(Keyword::COLUMN);
3220                let _if_not_exists =
3221                    self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
3222                let column_def = self.parse_column_def()?;
3223                AlterTableOperation::AddColumn { column_def }
3224            }
3225        } else if self.parse_keywords(&[Keyword::DROP, Keyword::CONNECTOR]) {
3226            AlterTableOperation::DropConnector
3227        } else if self.parse_keyword(Keyword::RENAME) {
3228            if self.parse_keyword(Keyword::CONSTRAINT) {
3229                let old_name = self.parse_identifier_non_reserved()?;
3230                self.expect_keyword(Keyword::TO)?;
3231                let new_name = self.parse_identifier_non_reserved()?;
3232                AlterTableOperation::RenameConstraint { old_name, new_name }
3233            } else if self.parse_keyword(Keyword::TO) {
3234                let table_name = self.parse_object_name()?;
3235                AlterTableOperation::RenameTable { table_name }
3236            } else {
3237                let _ = self.parse_keyword(Keyword::COLUMN);
3238                let old_column_name = self.parse_identifier_non_reserved()?;
3239                self.expect_keyword(Keyword::TO)?;
3240                let new_column_name = self.parse_identifier_non_reserved()?;
3241                AlterTableOperation::RenameColumn {
3242                    old_column_name,
3243                    new_column_name,
3244                }
3245            }
3246        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
3247            let owner_name: Ident = self.parse_identifier()?;
3248            AlterTableOperation::ChangeOwner {
3249                new_owner_name: owner_name,
3250            }
3251        } else if self.parse_keyword(Keyword::SET) {
3252            if self.parse_keyword(Keyword::SCHEMA) {
3253                let schema_name = self.parse_object_name()?;
3254                AlterTableOperation::SetSchema {
3255                    new_schema_name: schema_name,
3256                }
3257            } else if self.parse_keyword(Keyword::PARALLELISM) {
3258                if self.expect_keyword(Keyword::TO).is_err()
3259                    && self.expect_token(&Token::Eq).is_err()
3260                {
3261                    return self.expected("TO or = after ALTER TABLE SET PARALLELISM");
3262                }
3263
3264                let value = self.parse_set_variable()?;
3265
3266                let deferred = self.parse_keyword(Keyword::DEFERRED);
3267
3268                AlterTableOperation::SetParallelism {
3269                    parallelism: value,
3270                    deferred,
3271                }
3272            } else if let Some(rate_limit) = self.parse_alter_source_rate_limit(true)? {
3273                AlterTableOperation::SetSourceRateLimit { rate_limit }
3274            } else if let Some(rate_limit) = self.parse_alter_backfill_rate_limit()? {
3275                AlterTableOperation::SetBackfillRateLimit { rate_limit }
3276            } else if let Some(rate_limit) = self.parse_alter_dml_rate_limit()? {
3277                AlterTableOperation::SetDmlRateLimit { rate_limit }
3278            } else if self.parse_keyword(Keyword::CONFIG) {
3279                let entries = self.parse_options()?;
3280                AlterTableOperation::SetConfig { entries }
3281            } else {
3282                return self.expected(
3283                    "SCHEMA/PARALLELISM/SOURCE_RATE_LIMIT/DML_RATE_LIMIT/CONFIG after SET",
3284                );
3285            }
3286        } else if self.parse_keyword(Keyword::RESET) {
3287            if self.parse_keyword(Keyword::CONFIG) {
3288                let keys = self.parse_parenthesized_object_name_list()?;
3289                AlterTableOperation::ResetConfig { keys }
3290            } else {
3291                return self.expected("CONFIG after RESET");
3292            }
3293        } else if self.parse_keyword(Keyword::DROP) {
3294            let _ = self.parse_keyword(Keyword::COLUMN);
3295            let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
3296            let column_name = self.parse_identifier_non_reserved()?;
3297            let cascade = self.parse_keyword(Keyword::CASCADE);
3298            AlterTableOperation::DropColumn {
3299                column_name,
3300                if_exists,
3301                cascade,
3302            }
3303        } else if self.parse_keyword(Keyword::ALTER) {
3304            let _ = self.parse_keyword(Keyword::COLUMN);
3305            let column_name = self.parse_identifier_non_reserved()?;
3306
3307            let op = if self.parse_keywords(&[Keyword::SET, Keyword::NOT, Keyword::NULL]) {
3308                AlterColumnOperation::SetNotNull {}
3309            } else if self.parse_keywords(&[Keyword::DROP, Keyword::NOT, Keyword::NULL]) {
3310                AlterColumnOperation::DropNotNull {}
3311            } else if self.parse_keywords(&[Keyword::SET, Keyword::DEFAULT]) {
3312                AlterColumnOperation::SetDefault {
3313                    value: self.parse_expr()?,
3314                }
3315            } else if self.parse_keywords(&[Keyword::DROP, Keyword::DEFAULT]) {
3316                AlterColumnOperation::DropDefault {}
3317            } else if self.parse_keywords(&[Keyword::SET, Keyword::DATA, Keyword::TYPE])
3318                || (self.parse_keyword(Keyword::TYPE))
3319            {
3320                let data_type = self.parse_data_type()?;
3321                let using = if self.parse_keyword(Keyword::USING) {
3322                    Some(self.parse_expr()?)
3323                } else {
3324                    None
3325                };
3326                AlterColumnOperation::SetDataType { data_type, using }
3327            } else {
3328                return self
3329                    .expected("SET/DROP NOT NULL, SET DEFAULT, SET DATA TYPE after ALTER COLUMN");
3330            };
3331            AlterTableOperation::AlterColumn { column_name, op }
3332        } else if self.parse_keywords(&[Keyword::REFRESH, Keyword::SCHEMA]) {
3333            AlterTableOperation::RefreshSchema
3334        } else if self.parse_keywords(&[Keyword::SWAP, Keyword::WITH]) {
3335            let target_table = self.parse_object_name()?;
3336            AlterTableOperation::SwapRenameTable { target_table }
3337        } else if self.parse_keyword(Keyword::CONNECTOR) {
3338            let with_options = self.parse_with_properties()?;
3339            AlterTableOperation::AlterConnectorProps {
3340                alter_props: with_options,
3341            }
3342        } else {
3343            return self.expected(
3344                "ADD or RENAME or OWNER TO or SET or RESET or DROP or SWAP or CONNECTOR after ALTER TABLE",
3345            );
3346        };
3347        Ok(Statement::AlterTable {
3348            name: table_name,
3349            operation,
3350        })
3351    }
3352
3353    /// BACKFILL_RATE_LIMIT = default | NUMBER
3354    /// BACKFILL_RATE_LIMIT TO default | NUMBER
3355    pub fn parse_alter_backfill_rate_limit(&mut self) -> ModalResult<Option<i32>> {
3356        if !self.parse_word("BACKFILL_RATE_LIMIT") {
3357            return Ok(None);
3358        }
3359        if self.expect_keyword(Keyword::TO).is_err() && self.expect_token(&Token::Eq).is_err() {
3360            return self.expected("TO or = after ALTER TABLE SET BACKFILL_RATE_LIMIT");
3361        }
3362        let rate_limit = if self.parse_keyword(Keyword::DEFAULT) {
3363            -1
3364        } else {
3365            let s = self.parse_number_value()?;
3366            if let Ok(n) = s.parse::<i32>() {
3367                n
3368            } else {
3369                return self.expected("number or DEFAULT");
3370            }
3371        };
3372        Ok(Some(rate_limit))
3373    }
3374
3375    /// DML_RATE_LIMIT = default | NUMBER
3376    /// DML_RATE_LIMIT TO default | NUMBER
3377    pub fn parse_alter_dml_rate_limit(&mut self) -> ModalResult<Option<i32>> {
3378        if !self.parse_word("DML_RATE_LIMIT") {
3379            return Ok(None);
3380        }
3381        if self.expect_keyword(Keyword::TO).is_err() && self.expect_token(&Token::Eq).is_err() {
3382            return self.expected("TO or = after ALTER TABLE SET DML_RATE_LIMIT");
3383        }
3384        let rate_limit = if self.parse_keyword(Keyword::DEFAULT) {
3385            -1
3386        } else {
3387            let s = self.parse_number_value()?;
3388            if let Ok(n) = s.parse::<i32>() {
3389                n
3390            } else {
3391                return self.expected("number or DEFAULT");
3392            }
3393        };
3394        Ok(Some(rate_limit))
3395    }
3396
3397    /// SOURCE_RATE_LIMIT = default | NUMBER
3398    /// SOURCE_RATE_LIMIT TO default | NUMBER
3399    pub fn parse_alter_source_rate_limit(&mut self, is_table: bool) -> ModalResult<Option<i32>> {
3400        if !self.parse_word("SOURCE_RATE_LIMIT") {
3401            return Ok(None);
3402        }
3403        if self.expect_keyword(Keyword::TO).is_err() && self.expect_token(&Token::Eq).is_err() {
3404            let ddl = if is_table { "TABLE" } else { "SOURCE" };
3405            return self.expected(&format!("TO or = after ALTER {ddl} SET SOURCE_RATE_LIMIT"));
3406        }
3407        let rate_limit = if self.parse_keyword(Keyword::DEFAULT) {
3408            -1
3409        } else {
3410            let s = self.parse_number_value()?;
3411            if let Ok(n) = s.parse::<i32>() {
3412                n
3413            } else {
3414                return self.expected("number or DEFAULT");
3415            }
3416        };
3417        Ok(Some(rate_limit))
3418    }
3419
3420    pub fn parse_alter_index(&mut self) -> ModalResult<Statement> {
3421        let index_name = self.parse_object_name()?;
3422        let operation = if self.parse_keyword(Keyword::RENAME) {
3423            if self.parse_keyword(Keyword::TO) {
3424                let index_name = self.parse_object_name()?;
3425                AlterIndexOperation::RenameIndex { index_name }
3426            } else {
3427                return self.expected("TO after RENAME");
3428            }
3429        } else if self.parse_keyword(Keyword::SET) {
3430            if self.parse_keyword(Keyword::PARALLELISM) {
3431                if self.expect_keyword(Keyword::TO).is_err()
3432                    && self.expect_token(&Token::Eq).is_err()
3433                {
3434                    return self.expected("TO or = after ALTER TABLE SET PARALLELISM");
3435                }
3436
3437                let value = self.parse_set_variable()?;
3438
3439                let deferred = self.parse_keyword(Keyword::DEFERRED);
3440
3441                AlterIndexOperation::SetParallelism {
3442                    parallelism: value,
3443                    deferred,
3444                }
3445            } else if self.parse_keyword(Keyword::CONFIG) {
3446                let entries = self.parse_options()?;
3447                AlterIndexOperation::SetConfig { entries }
3448            } else {
3449                return self.expected("PARALLELISM or CONFIG after SET");
3450            }
3451        } else if self.parse_keyword(Keyword::RESET) {
3452            if self.parse_keyword(Keyword::CONFIG) {
3453                let keys = self.parse_parenthesized_object_name_list()?;
3454                AlterIndexOperation::ResetConfig { keys }
3455            } else {
3456                return self.expected("CONFIG after RESET");
3457            }
3458        } else {
3459            return self.expected("RENAME, SET, or RESET after ALTER INDEX");
3460        };
3461
3462        Ok(Statement::AlterIndex {
3463            name: index_name,
3464            operation,
3465        })
3466    }
3467
3468    pub fn parse_alter_view(&mut self, materialized: bool) -> ModalResult<Statement> {
3469        let view_name = self.parse_object_name()?;
3470        let operation = if self.parse_keyword(Keyword::AS) {
3471            let query = Box::new(self.parse_query()?);
3472            AlterViewOperation::AsQuery { query }
3473        } else if self.parse_keyword(Keyword::RENAME) {
3474            if self.parse_keyword(Keyword::TO) {
3475                let view_name = self.parse_object_name()?;
3476                AlterViewOperation::RenameView { view_name }
3477            } else {
3478                return self.expected("TO after RENAME");
3479            }
3480        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
3481            let owner_name: Ident = self.parse_identifier()?;
3482            AlterViewOperation::ChangeOwner {
3483                new_owner_name: owner_name,
3484            }
3485        } else if self.parse_keywords(&[Keyword::SWAP, Keyword::WITH]) {
3486            let target_view = self.parse_object_name()?;
3487            AlterViewOperation::SwapRenameView { target_view }
3488        } else if self.parse_keyword(Keyword::SET) {
3489            if self.parse_keyword(Keyword::SCHEMA) {
3490                let schema_name = self.parse_object_name()?;
3491                AlterViewOperation::SetSchema {
3492                    new_schema_name: schema_name,
3493                }
3494            } else if self.parse_word("STREAMING_ENABLE_UNALIGNED_JOIN") {
3495                if self.expect_keyword(Keyword::TO).is_err()
3496                    && self.expect_token(&Token::Eq).is_err()
3497                {
3498                    return self
3499                        .expected("TO or = after ALTER TABLE SET STREAMING_ENABLE_UNALIGNED_JOIN");
3500                }
3501                let value = self.parse_boolean()?;
3502                AlterViewOperation::SetStreamingEnableUnalignedJoin { enable: value }
3503            } else if self.parse_keyword(Keyword::PARALLELISM) && materialized {
3504                if self.expect_keyword(Keyword::TO).is_err()
3505                    && self.expect_token(&Token::Eq).is_err()
3506                {
3507                    return self.expected("TO or = after ALTER TABLE SET PARALLELISM");
3508                }
3509
3510                let value = self.parse_set_variable()?;
3511
3512                let deferred = self.parse_keyword(Keyword::DEFERRED);
3513
3514                AlterViewOperation::SetParallelism {
3515                    parallelism: value,
3516                    deferred,
3517                }
3518            } else if self.parse_keyword(Keyword::RESOURCE_GROUP) && materialized {
3519                if self.expect_keyword(Keyword::TO).is_err()
3520                    && self.expect_token(&Token::Eq).is_err()
3521                {
3522                    return self
3523                        .expected("TO or = after ALTER MATERIALIZED VIEW SET RESOURCE_GROUP");
3524                }
3525                let value = self.parse_set_variable()?;
3526                let deferred = self.parse_keyword(Keyword::DEFERRED);
3527
3528                AlterViewOperation::SetResourceGroup {
3529                    resource_group: Some(value),
3530                    deferred,
3531                }
3532            } else if materialized
3533                && let Some(rate_limit) = self.parse_alter_backfill_rate_limit()?
3534            {
3535                AlterViewOperation::SetBackfillRateLimit { rate_limit }
3536            } else if self.parse_keyword(Keyword::CONFIG) && materialized {
3537                let entries = self.parse_options()?;
3538                AlterViewOperation::SetConfig { entries }
3539            } else {
3540                return self.expected("SCHEMA/PARALLELISM/BACKFILL_RATE_LIMIT/CONFIG after SET");
3541            }
3542        } else if self.parse_keyword(Keyword::RESET) {
3543            if self.parse_keyword(Keyword::RESOURCE_GROUP) && materialized {
3544                let deferred = self.parse_keyword(Keyword::DEFERRED);
3545
3546                AlterViewOperation::SetResourceGroup {
3547                    resource_group: None,
3548                    deferred,
3549                }
3550            } else if self.parse_keyword(Keyword::CONFIG) && materialized {
3551                let keys = self.parse_parenthesized_object_name_list()?;
3552                AlterViewOperation::ResetConfig { keys }
3553            } else {
3554                return self.expected("RESOURCE_GROUP or CONFIG after RESET");
3555            }
3556        } else {
3557            return self.expected(&format!(
3558                "AS, RENAME, OWNER TO, SET, or SWAP after ALTER {}VIEW",
3559                if materialized { "MATERIALIZED " } else { "" }
3560            ));
3561        };
3562
3563        Ok(Statement::AlterView {
3564            materialized,
3565            name: view_name,
3566            operation,
3567        })
3568    }
3569
3570    /// SINK_RATE_LIMIT = default | NUMBER
3571    /// SINK_RATE_LIMIT TO default | NUMBER
3572    pub fn parse_alter_sink_rate_limit(&mut self) -> ModalResult<Option<i32>> {
3573        if !self.parse_word("SINK_RATE_LIMIT") {
3574            return Ok(None);
3575        }
3576        if self.expect_keyword(Keyword::TO).is_err() && self.expect_token(&Token::Eq).is_err() {
3577            return self.expected("TO or = after ALTER SINK SET SINK_RATE_LIMIT");
3578        }
3579        let rate_limit = if self.parse_keyword(Keyword::DEFAULT) {
3580            -1
3581        } else {
3582            let s = self.parse_number_value()?;
3583            if let Ok(n) = s.parse::<i32>() {
3584                n
3585            } else {
3586                return self.expected("number or DEFAULT");
3587            }
3588        };
3589        Ok(Some(rate_limit))
3590    }
3591
3592    pub fn parse_alter_sink(&mut self) -> ModalResult<Statement> {
3593        let sink_name = self.parse_object_name()?;
3594        let operation = if self.parse_keyword(Keyword::RENAME) {
3595            if self.parse_keyword(Keyword::TO) {
3596                let sink_name = self.parse_object_name()?;
3597                AlterSinkOperation::RenameSink { sink_name }
3598            } else {
3599                return self.expected("TO after RENAME");
3600            }
3601        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
3602            let owner_name: Ident = self.parse_identifier()?;
3603            AlterSinkOperation::ChangeOwner {
3604                new_owner_name: owner_name,
3605            }
3606        } else if self.parse_keyword(Keyword::SET) {
3607            if self.parse_keyword(Keyword::SCHEMA) {
3608                let schema_name = self.parse_object_name()?;
3609                AlterSinkOperation::SetSchema {
3610                    new_schema_name: schema_name,
3611                }
3612            } else if self.parse_word("STREAMING_ENABLE_UNALIGNED_JOIN") {
3613                self.expect_keyword(Keyword::TO)?;
3614                let value = self.parse_boolean()?;
3615                AlterSinkOperation::SetStreamingEnableUnalignedJoin { enable: value }
3616            } else if self.parse_keyword(Keyword::PARALLELISM) {
3617                if self.expect_keyword(Keyword::TO).is_err()
3618                    && self.expect_token(&Token::Eq).is_err()
3619                {
3620                    return self.expected("TO or = after ALTER TABLE SET PARALLELISM");
3621                }
3622
3623                let value = self.parse_set_variable()?;
3624                let deferred = self.parse_keyword(Keyword::DEFERRED);
3625
3626                AlterSinkOperation::SetParallelism {
3627                    parallelism: value,
3628                    deferred,
3629                }
3630            } else if let Some(rate_limit) = self.parse_alter_sink_rate_limit()? {
3631                AlterSinkOperation::SetSinkRateLimit { rate_limit }
3632            } else if self.parse_keyword(Keyword::CONFIG) {
3633                let entries = self.parse_options()?;
3634                AlterSinkOperation::SetConfig { entries }
3635            } else {
3636                return self.expected(
3637                    "SCHEMA/PARALLELISM/SINK_RATE_LIMIT/STREAMING_ENABLE_UNALIGNED_JOIN/CONFIG after SET",
3638                );
3639            }
3640        } else if self.parse_keyword(Keyword::RESET) {
3641            if self.parse_keyword(Keyword::CONFIG) {
3642                let keys = self.parse_parenthesized_object_name_list()?;
3643                AlterSinkOperation::ResetConfig { keys }
3644            } else {
3645                return self.expected("CONFIG after RESET");
3646            }
3647        } else if self.parse_keywords(&[Keyword::SWAP, Keyword::WITH]) {
3648            let target_sink = self.parse_object_name()?;
3649            AlterSinkOperation::SwapRenameSink { target_sink }
3650        } else if self.parse_keyword(Keyword::CONNECTOR) {
3651            let changed_props = self.parse_with_properties()?;
3652            AlterSinkOperation::AlterConnectorProps {
3653                alter_props: changed_props,
3654            }
3655        } else {
3656            return self
3657                .expected("RENAME or OWNER TO or SET or RESET or CONNECTOR WITH after ALTER SINK");
3658        };
3659
3660        Ok(Statement::AlterSink {
3661            name: sink_name,
3662            operation,
3663        })
3664    }
3665
3666    pub fn parse_alter_subscription(&mut self) -> ModalResult<Statement> {
3667        let subscription_name = self.parse_object_name()?;
3668        let operation = if self.parse_keyword(Keyword::RENAME) {
3669            if self.parse_keyword(Keyword::TO) {
3670                let subscription_name = self.parse_object_name()?;
3671                AlterSubscriptionOperation::RenameSubscription { subscription_name }
3672            } else {
3673                return self.expected("TO after RENAME");
3674            }
3675        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
3676            let owner_name: Ident = self.parse_identifier()?;
3677            AlterSubscriptionOperation::ChangeOwner {
3678                new_owner_name: owner_name,
3679            }
3680        } else if self.parse_keyword(Keyword::SET) {
3681            if self.parse_keyword(Keyword::SCHEMA) {
3682                let schema_name = self.parse_object_name()?;
3683                AlterSubscriptionOperation::SetSchema {
3684                    new_schema_name: schema_name,
3685                }
3686            } else {
3687                return self.expected("SCHEMA after SET");
3688            }
3689        } else if self.parse_keywords(&[Keyword::SWAP, Keyword::WITH]) {
3690            let target_subscription = self.parse_object_name()?;
3691            AlterSubscriptionOperation::SwapRenameSubscription {
3692                target_subscription,
3693            }
3694        } else {
3695            return self.expected("RENAME or OWNER TO or SET or SWAP after ALTER SUBSCRIPTION");
3696        };
3697
3698        Ok(Statement::AlterSubscription {
3699            name: subscription_name,
3700            operation,
3701        })
3702    }
3703
3704    pub fn parse_alter_source(&mut self) -> ModalResult<Statement> {
3705        let source_name = self.parse_object_name()?;
3706        let operation = if self.parse_keyword(Keyword::RENAME) {
3707            if self.parse_keyword(Keyword::TO) {
3708                let source_name = self.parse_object_name()?;
3709                AlterSourceOperation::RenameSource { source_name }
3710            } else {
3711                return self.expected("TO after RENAME");
3712            }
3713        } else if self.parse_keyword(Keyword::ADD) {
3714            let _ = self.parse_keyword(Keyword::COLUMN);
3715            let _if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
3716            let column_def = self.parse_column_def()?;
3717            AlterSourceOperation::AddColumn { column_def }
3718        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
3719            let owner_name: Ident = self.parse_identifier()?;
3720            AlterSourceOperation::ChangeOwner {
3721                new_owner_name: owner_name,
3722            }
3723        } else if self.parse_keyword(Keyword::SET) {
3724            if self.parse_keyword(Keyword::SCHEMA) {
3725                let schema_name = self.parse_object_name()?;
3726                AlterSourceOperation::SetSchema {
3727                    new_schema_name: schema_name,
3728                }
3729            } else if let Some(rate_limit) = self.parse_alter_source_rate_limit(false)? {
3730                AlterSourceOperation::SetSourceRateLimit { rate_limit }
3731            } else if self.parse_keyword(Keyword::PARALLELISM) {
3732                if self.expect_keyword(Keyword::TO).is_err()
3733                    && self.expect_token(&Token::Eq).is_err()
3734                {
3735                    return self.expected("TO or = after ALTER SOURCE SET PARALLELISM");
3736                }
3737
3738                let value = self.parse_set_variable()?;
3739                let deferred = self.parse_keyword(Keyword::DEFERRED);
3740
3741                AlterSourceOperation::SetParallelism {
3742                    parallelism: value,
3743                    deferred,
3744                }
3745            } else if self.parse_keyword(Keyword::CONFIG) {
3746                let entries = self.parse_options()?;
3747                AlterSourceOperation::SetConfig { entries }
3748            } else {
3749                return self.expected("SCHEMA, SOURCE_RATE_LIMIT, PARALLELISM or CONFIG after SET");
3750            }
3751        } else if self.parse_keyword(Keyword::RESET) {
3752            if self.parse_keyword(Keyword::CONFIG) {
3753                let keys = self.parse_parenthesized_object_name_list()?;
3754                AlterSourceOperation::ResetConfig { keys }
3755            } else {
3756                return self.expected("CONFIG after RESET");
3757            }
3758        } else if self.peek_nth_any_of_keywords(0, &[Keyword::FORMAT]) {
3759            let format_encode = self.parse_schema()?.unwrap();
3760            if format_encode.key_encode.is_some() {
3761                parser_err!("key encode clause is not supported in source schema");
3762            }
3763            AlterSourceOperation::FormatEncode { format_encode }
3764        } else if self.parse_keywords(&[Keyword::REFRESH, Keyword::SCHEMA]) {
3765            AlterSourceOperation::RefreshSchema
3766        } else if self.parse_keywords(&[Keyword::SWAP, Keyword::WITH]) {
3767            let target_source = self.parse_object_name()?;
3768            AlterSourceOperation::SwapRenameSource { target_source }
3769        } else if self.parse_keyword(Keyword::CONNECTOR) {
3770            let with_options = self.parse_with_properties()?;
3771            AlterSourceOperation::AlterConnectorProps {
3772                alter_props: with_options,
3773            }
3774        } else {
3775            return self.expected(
3776                "RENAME, ADD COLUMN, OWNER TO, CONNECTOR, SET or RESET after ALTER SOURCE",
3777            );
3778        };
3779
3780        Ok(Statement::AlterSource {
3781            name: source_name,
3782            operation,
3783        })
3784    }
3785
3786    pub fn parse_alter_function(&mut self) -> ModalResult<Statement> {
3787        let FunctionDesc { name, args } = self.parse_function_desc()?;
3788
3789        let operation = if self.parse_keyword(Keyword::SET) {
3790            if self.parse_keyword(Keyword::SCHEMA) {
3791                let schema_name = self.parse_object_name()?;
3792                AlterFunctionOperation::SetSchema {
3793                    new_schema_name: schema_name,
3794                }
3795            } else {
3796                return self.expected("SCHEMA after SET");
3797            }
3798        } else {
3799            return self.expected("SET after ALTER FUNCTION");
3800        };
3801
3802        Ok(Statement::AlterFunction {
3803            name,
3804            args,
3805            operation,
3806        })
3807    }
3808
3809    pub fn parse_alter_connection(&mut self) -> ModalResult<Statement> {
3810        let connection_name = self.parse_object_name()?;
3811        let operation = if self.parse_keyword(Keyword::SET) {
3812            if self.parse_keyword(Keyword::SCHEMA) {
3813                let schema_name = self.parse_object_name()?;
3814                AlterConnectionOperation::SetSchema {
3815                    new_schema_name: schema_name,
3816                }
3817            } else {
3818                return self.expected("SCHEMA after SET");
3819            }
3820        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
3821            let owner_name: Ident = self.parse_identifier()?;
3822            AlterConnectionOperation::ChangeOwner {
3823                new_owner_name: owner_name,
3824            }
3825        } else if self.parse_keyword(Keyword::CONNECTOR) {
3826            let with_options = self.parse_with_properties()?;
3827            AlterConnectionOperation::AlterConnectorProps {
3828                alter_props: with_options,
3829            }
3830        } else {
3831            return self.expected("SET, OWNER TO, or CONNECTOR WITH after ALTER CONNECTION");
3832        };
3833
3834        Ok(Statement::AlterConnection {
3835            name: connection_name,
3836            operation,
3837        })
3838    }
3839
3840    pub fn parse_alter_system(&mut self) -> ModalResult<Statement> {
3841        self.expect_keyword(Keyword::SET)?;
3842        let param = self.parse_identifier()?;
3843        if self.expect_keyword(Keyword::TO).is_err() && self.expect_token(&Token::Eq).is_err() {
3844            return self.expected("TO or = after ALTER SYSTEM SET");
3845        }
3846        let value = self.parse_set_variable()?;
3847        Ok(Statement::AlterSystem { param, value })
3848    }
3849
3850    pub fn parse_alter_secret(&mut self) -> ModalResult<Statement> {
3851        let secret_name = self.parse_object_name()?;
3852        let with_options = self.parse_with_properties()?;
3853        self.expect_keyword(Keyword::AS)?;
3854        let new_credential = self.ensure_parse_value()?;
3855        let operation = AlterSecretOperation::ChangeCredential { new_credential };
3856        Ok(Statement::AlterSecret {
3857            name: secret_name,
3858            with_options,
3859            operation,
3860        })
3861    }
3862
3863    pub fn parse_alter_fragment(&mut self) -> ModalResult<Statement> {
3864        let mut fragment_ids = vec![self.parse_literal_u32()?];
3865        while self.consume_token(&Token::Comma) {
3866            fragment_ids.push(self.parse_literal_u32()?);
3867        }
3868        if !self.parse_keyword(Keyword::SET) {
3869            return self.expected("SET after ALTER FRAGMENT");
3870        }
3871        let operation = if self.parse_keyword(Keyword::PARALLELISM) {
3872            if self.expect_keyword(Keyword::TO).is_err() && self.expect_token(&Token::Eq).is_err() {
3873                return self.expected("TO or = after ALTER FRAGMENT SET PARALLELISM");
3874            }
3875            let parallelism = self.parse_set_variable()?;
3876            AlterFragmentOperation::SetParallelism { parallelism }
3877        } else {
3878            let rate_limit = self.parse_alter_fragment_rate_limit()?;
3879            AlterFragmentOperation::AlterBackfillRateLimit { rate_limit }
3880        };
3881        Ok(Statement::AlterFragment {
3882            fragment_ids,
3883            operation,
3884        })
3885    }
3886
3887    fn parse_alter_fragment_rate_limit(&mut self) -> ModalResult<i32> {
3888        if !self.parse_word("RATE_LIMIT") {
3889            return self.expected("expected RATE_LIMIT after SET");
3890        }
3891        if self.expect_keyword(Keyword::TO).is_err() && self.expect_token(&Token::Eq).is_err() {
3892            return self.expected("TO or = after RATE_LIMIT");
3893        }
3894        let rate_limit = if self.parse_keyword(Keyword::DEFAULT) {
3895            -1
3896        } else {
3897            let s = self.parse_number_value()?;
3898            if let Ok(n) = s.parse::<i32>() {
3899                n
3900            } else {
3901                return self.expected("number or DEFAULT");
3902            }
3903        };
3904        Ok(rate_limit)
3905    }
3906
3907    /// Parse a copy statement
3908    pub fn parse_copy(&mut self) -> ModalResult<Statement> {
3909        let entity = if self.consume_token(&Token::LParen) {
3910            let query = self.parse_query()?;
3911            self.expect_token(&Token::RParen)?;
3912            CopyEntity::Query(query.into())
3913        } else {
3914            let table_name = self.parse_object_name()?;
3915            let columns = self.parse_parenthesized_column_list(Optional)?;
3916            CopyEntity::Table {
3917                table_name,
3918                columns,
3919            }
3920        };
3921
3922        let target = if self.parse_keywords(&[Keyword::FROM, Keyword::STDIN]) {
3923            self.expect_token(&Token::SemiColon)?;
3924            let values = self.parse_tsv();
3925            CopyTarget::Stdin { values }
3926        } else if self.parse_keywords(&[Keyword::TO, Keyword::STDOUT]) {
3927            CopyTarget::Stdout
3928        } else {
3929            return self.expected("FROM STDIN or TO STDOUT");
3930        };
3931
3932        Ok(Statement::Copy { entity, target })
3933    }
3934
3935    /// Parse a tab separated values in
3936    /// COPY payload
3937    fn parse_tsv(&mut self) -> Vec<Option<String>> {
3938        self.parse_tab_value()
3939    }
3940
3941    fn parse_tab_value(&mut self) -> Vec<Option<String>> {
3942        let mut values = vec![];
3943        let mut content = String::from("");
3944        while let Some(t) = self.next_token_no_skip() {
3945            match t.token {
3946                Token::Whitespace(Whitespace::Tab) => {
3947                    values.push(Some(content.clone()));
3948                    content.clear();
3949                }
3950                Token::Whitespace(Whitespace::Newline) => {
3951                    values.push(Some(content.clone()));
3952                    content.clear();
3953                }
3954                Token::Backslash => {
3955                    if self.consume_token(&Token::Period) {
3956                        return values;
3957                    }
3958                    if let Token::Word(w) = self.next_token().token
3959                        && w.value == "N"
3960                    {
3961                        values.push(None);
3962                    }
3963                }
3964                _ => {
3965                    content.push_str(&t.to_string());
3966                }
3967            }
3968        }
3969        values
3970    }
3971
3972    pub fn ensure_parse_value(&mut self) -> ModalResult<Value> {
3973        match self.parse_value_and_obj_ref::<true>()? {
3974            SqlOptionValue::Value(value) => Ok(value),
3975            SqlOptionValue::SecretRef(_)
3976            | SqlOptionValue::ConnectionRef(_)
3977            | SqlOptionValue::BackfillOrder(_) => unreachable!(),
3978        }
3979    }
3980
3981    /// Parse a literal value (numbers, strings, date/time, booleans)
3982    pub fn parse_value_and_obj_ref<const FORBID_OBJ_REF: bool>(
3983        &mut self,
3984    ) -> ModalResult<SqlOptionValue> {
3985        let checkpoint = *self;
3986        let token = self.next_token();
3987        match token.token {
3988            Token::Word(w) => match w.keyword {
3989                Keyword::TRUE => Ok(Value::Boolean(true).into()),
3990                Keyword::FALSE => Ok(Value::Boolean(false).into()),
3991                Keyword::NULL => Ok(Value::Null.into()),
3992                Keyword::NoKeyword if w.quote_style.is_some() => match w.quote_style {
3993                    Some('"') => Ok(Value::DoubleQuotedString(w.value).into()),
3994                    Some('\'') => Ok(Value::SingleQuotedString(w.value).into()),
3995                    _ => self.expected_at(checkpoint, "A value")?,
3996                },
3997                Keyword::SECRET => {
3998                    if FORBID_OBJ_REF {
3999                        return self.expected_at(
4000                            checkpoint,
4001                            "a concrete value rather than a secret reference",
4002                        );
4003                    }
4004                    let secret = self.parse_secret_ref()?;
4005                    Ok(SqlOptionValue::SecretRef(secret))
4006                }
4007                _ => self.expected_at(checkpoint, "a concrete value"),
4008            },
4009            Token::Number(ref n) => Ok(Value::Number(n.clone()).into()),
4010            Token::SingleQuotedString(ref s) => Ok(Value::SingleQuotedString(s.clone()).into()),
4011            Token::DollarQuotedString(ref s) => Ok(Value::DollarQuotedString(s.clone()).into()),
4012            Token::CstyleEscapesString(ref s) => Ok(Value::CstyleEscapedString(s.clone()).into()),
4013            Token::NationalStringLiteral(ref s) => {
4014                Ok(Value::NationalStringLiteral(s.clone()).into())
4015            }
4016            Token::HexStringLiteral(ref s) => Ok(Value::HexStringLiteral(s.clone()).into()),
4017            _ => self.expected_at(checkpoint, "a value"),
4018        }
4019    }
4020
4021    fn parse_secret_ref(&mut self) -> ModalResult<SecretRefValue> {
4022        let secret_name = self.parse_object_name()?;
4023        let ref_as = if self.parse_keywords(&[Keyword::AS, Keyword::FILE]) {
4024            SecretRefAsType::File
4025        } else {
4026            SecretRefAsType::Text
4027        };
4028        Ok(SecretRefValue {
4029            secret_name,
4030            ref_as,
4031        })
4032    }
4033
4034    fn parse_set_variable(&mut self) -> ModalResult<SetVariableValue> {
4035        alt((
4036            Keyword::DEFAULT.value(SetVariableValue::Default),
4037            separated(
4038                1..,
4039                alt((
4040                    Self::ensure_parse_value.map(SetVariableValueSingle::Literal),
4041                    |parser: &mut Self| {
4042                        let checkpoint = *parser;
4043                        let ident = parser.parse_identifier()?;
4044                        if ident.value == "default" {
4045                            *parser = checkpoint;
4046                            return parser.expected("parameter list value").map_err(|e| e.cut());
4047                        }
4048                        Ok(SetVariableValueSingle::Ident(ident))
4049                    },
4050                    fail.expect("parameter value"),
4051                )),
4052                Token::Comma,
4053            )
4054            .map(|list: Vec<SetVariableValueSingle>| {
4055                if list.len() == 1 {
4056                    SetVariableValue::Single(list[0].clone())
4057                } else {
4058                    SetVariableValue::List(list)
4059                }
4060            }),
4061        ))
4062        .parse_next(self)
4063    }
4064
4065    fn parse_backfill_order_strategy(&mut self) -> ModalResult<BackfillOrderStrategy> {
4066        alt((
4067            Keyword::DEFAULT.value(BackfillOrderStrategy::Default),
4068            Keyword::NONE.value(BackfillOrderStrategy::None),
4069            Keyword::AUTO.value(BackfillOrderStrategy::Auto),
4070            Self::parse_fixed_backfill_order.map(BackfillOrderStrategy::Fixed),
4071            fail.expect("backfill order strategy"),
4072        ))
4073        .parse_next(self)
4074    }
4075
4076    fn parse_fixed_backfill_order(&mut self) -> ModalResult<Vec<(ObjectName, ObjectName)>> {
4077        self.expect_word("FIXED")?;
4078        self.expect_token(&Token::LParen)?;
4079        let edges = separated(
4080            0..,
4081            separated_pair(
4082                Self::parse_object_name,
4083                Token::Op("->".to_owned()),
4084                Self::parse_object_name,
4085            ),
4086            Token::Comma,
4087        )
4088        .parse_next(self)?;
4089        self.expect_token(&Token::RParen)?;
4090        Ok(edges)
4091    }
4092
4093    pub fn parse_number_value(&mut self) -> ModalResult<String> {
4094        let checkpoint = *self;
4095        match self.ensure_parse_value()? {
4096            Value::Number(v) => Ok(v),
4097            _ => self.expected_at(checkpoint, "literal number"),
4098        }
4099    }
4100
4101    pub fn parse_literal_u32(&mut self) -> ModalResult<u32> {
4102        literal_u32(self)
4103    }
4104
4105    pub fn parse_literal_u64(&mut self) -> ModalResult<u64> {
4106        literal_u64(self)
4107    }
4108
4109    pub fn parse_function_definition(&mut self) -> ModalResult<FunctionDefinition> {
4110        alt((
4111            single_quoted_string.map(FunctionDefinition::SingleQuotedDef),
4112            dollar_quoted_string.map(FunctionDefinition::DoubleDollarDef),
4113            Self::parse_identifier.map(|i| FunctionDefinition::Identifier(i.value)),
4114            fail.expect("function definition"),
4115        ))
4116        .parse_next(self)
4117    }
4118
4119    /// Parse a literal string
4120    pub fn parse_literal_string(&mut self) -> ModalResult<String> {
4121        let checkpoint = *self;
4122        let token = self.next_token();
4123        match token.token {
4124            Token::SingleQuotedString(s) => Ok(s),
4125            _ => self.expected_at(checkpoint, "literal string"),
4126        }
4127    }
4128
4129    /// Parse a SQL datatype (in the context of a CREATE TABLE statement for example)
4130    pub fn parse_data_type(&mut self) -> ModalResult<DataType> {
4131        parser_v2::data_type(self)
4132    }
4133
4134    /// Parse `AS identifier` (or simply `identifier` if it's not a reserved keyword)
4135    /// Some examples with aliases: `SELECT 1 foo`, `SELECT COUNT(*) AS cnt`,
4136    /// `SELECT ... FROM t1 foo, t2 bar`, `SELECT ... FROM (...) AS bar`
4137    pub fn parse_optional_alias(
4138        &mut self,
4139        reserved_kwds: &[Keyword],
4140    ) -> ModalResult<Option<Ident>> {
4141        let after_as = self.parse_keyword(Keyword::AS);
4142        let checkpoint = *self;
4143        let token = self.next_token();
4144        match token.token {
4145            // Accept any identifier after `AS` (though many dialects have restrictions on
4146            // keywords that may appear here). If there's no `AS`: don't parse keywords,
4147            // which may start a construct allowed in this position, to be parsed as aliases.
4148            // (For example, in `FROM t1 JOIN` the `JOIN` will always be parsed as a keyword,
4149            // not an alias.)
4150            Token::Word(w) if after_as || (!reserved_kwds.contains(&w.keyword)) => {
4151                Ok(Some(w.to_ident()?))
4152            }
4153            _ => {
4154                *self = checkpoint;
4155                if after_as {
4156                    return self.expected("an identifier after AS");
4157                }
4158                Ok(None) // no alias found
4159            }
4160        }
4161    }
4162
4163    /// Parse `AS identifier` when the AS is describing a table-valued object,
4164    /// like in `... FROM generate_series(1, 10) AS t (col)`. In this case
4165    /// the alias is allowed to optionally name the columns in the table, in
4166    /// addition to the table itself.
4167    pub fn parse_optional_table_alias(
4168        &mut self,
4169        reserved_kwds: &[Keyword],
4170    ) -> ModalResult<Option<TableAlias>> {
4171        match self.parse_optional_alias(reserved_kwds)? {
4172            Some(name) => {
4173                let columns = self.parse_parenthesized_column_list(Optional)?;
4174                Ok(Some(TableAlias { name, columns }))
4175            }
4176            None => Ok(None),
4177        }
4178    }
4179
4180    /// syntax `FOR SYSTEM_TIME AS OF PROCTIME()` is used for temporal join.
4181    pub fn parse_as_of(&mut self) -> ModalResult<AsOf> {
4182        Keyword::FOR.parse_next(self)?;
4183        alt((
4184            preceded(
4185                (Keyword::SYSTEM_TIME, Keyword::AS, Keyword::OF),
4186                cut_err(
4187                    alt((
4188                        preceded(
4189                            (
4190                                Self::parse_identifier.verify(|ident| ident.real_value() == "now"),
4191                                cut_err(Token::LParen),
4192                                cut_err(Token::RParen),
4193                                Token::Minus,
4194                            ),
4195                            Self::parse_literal_interval.try_map(|e| match e {
4196                                Expr::Value(v) => match v {
4197                                    Value::Interval {
4198                                        value,
4199                                        leading_field,
4200                                        ..
4201                                    } => {
4202                                        let Some(leading_field) = leading_field else {
4203                                            return Err(StrError("expect duration unit".into()));
4204                                        };
4205                                        Ok(AsOf::ProcessTimeWithInterval((value, leading_field)))
4206                                    }
4207                                    _ => Err(StrError("expect Value::Interval".into())),
4208                                },
4209                                _ => Err(StrError("expect Expr::Value".into())),
4210                            }),
4211                        ),
4212                        (
4213                            Self::parse_identifier.verify(|ident| ident.real_value() == "now"),
4214                            cut_err(Token::LParen),
4215                            cut_err(Token::RParen),
4216                        )
4217                            .value(AsOf::ProcessTimeWithInterval((
4218                                "0".to_owned(),
4219                                DateTimeField::Second,
4220                            ))),
4221                        (
4222                            Self::parse_identifier.verify(|ident| ident.real_value() == "proctime"),
4223                            cut_err(Token::LParen),
4224                            cut_err(Token::RParen),
4225                        )
4226                            .value(AsOf::ProcessTime),
4227                        literal_i64.map(AsOf::TimestampNum),
4228                        single_quoted_string.map(AsOf::TimestampString),
4229                    ))
4230                    .expect("proctime(), now(), number or string"),
4231                ),
4232            ),
4233            preceded(
4234                (Keyword::SYSTEM_VERSION, Keyword::AS, Keyword::OF),
4235                cut_err(
4236                    alt((
4237                        literal_i64.map(AsOf::VersionNum),
4238                        single_quoted_string.map(AsOf::VersionString),
4239                    ))
4240                    .expect("number or string"),
4241                ),
4242            ),
4243        ))
4244        .parse_next(self)
4245    }
4246
4247    /// Parse a possibly qualified, possibly quoted identifier, e.g.
4248    /// `foo` or `myschema."table"
4249    pub fn parse_object_name(&mut self) -> ModalResult<ObjectName> {
4250        let mut idents = vec![];
4251        loop {
4252            idents.push(self.parse_identifier()?);
4253            if !self.consume_token(&Token::Period) {
4254                break;
4255            }
4256        }
4257        Ok(ObjectName(idents))
4258    }
4259
4260    /// Parse a parenthesized comma-separated list of object names
4261    pub fn parse_parenthesized_object_name_list(&mut self) -> ModalResult<Vec<ObjectName>> {
4262        if self.consume_token(&Token::LParen) {
4263            let names = self.parse_comma_separated(Parser::parse_object_name)?;
4264            self.expect_token(&Token::RParen)?;
4265            Ok(names)
4266        } else {
4267            self.expected("a list of object names in parentheses")
4268        }
4269    }
4270
4271    /// Parse identifiers strictly i.e. don't parse keywords
4272    pub fn parse_identifiers_non_keywords(&mut self) -> ModalResult<Vec<Ident>> {
4273        let mut idents = vec![];
4274        loop {
4275            match self.peek_token().token {
4276                Token::Word(w) => {
4277                    if w.keyword != Keyword::NoKeyword {
4278                        break;
4279                    }
4280
4281                    idents.push(w.to_ident()?);
4282                }
4283                Token::EOF | Token::Eq => break,
4284                _ => {}
4285            }
4286
4287            self.next_token();
4288        }
4289
4290        Ok(idents)
4291    }
4292
4293    /// Parse identifiers
4294    pub fn parse_identifiers(&mut self) -> ModalResult<Vec<Ident>> {
4295        let mut idents = vec![];
4296        loop {
4297            let token = self.next_token();
4298            match token.token {
4299                Token::Word(w) => {
4300                    idents.push(w.to_ident()?);
4301                }
4302                Token::EOF => break,
4303                _ => {}
4304            }
4305        }
4306
4307        Ok(idents)
4308    }
4309
4310    /// Parse a simple one-word identifier (possibly quoted, possibly a keyword)
4311    pub fn parse_identifier(&mut self) -> ModalResult<Ident> {
4312        let checkpoint = *self;
4313        let token = self.next_token();
4314        match token.token {
4315            Token::Word(w) => Ok(w.to_ident()?),
4316            _ => self.expected_at(checkpoint, "identifier"),
4317        }
4318    }
4319
4320    /// Parse a simple one-word identifier (possibly quoted, possibly a non-reserved keyword)
4321    pub fn parse_identifier_non_reserved(&mut self) -> ModalResult<Ident> {
4322        let checkpoint = *self;
4323        let token = self.next_token();
4324        match token.token {
4325            Token::Word(w) => {
4326                match keywords::RESERVED_FOR_COLUMN_OR_TABLE_NAME.contains(&w.keyword) {
4327                    true => parser_err!("syntax error at or near {w}"),
4328                    false => Ok(w.to_ident()?),
4329                }
4330            }
4331            _ => self.expected_at(checkpoint, "identifier"),
4332        }
4333    }
4334
4335    /// Parse a parenthesized comma-separated list of unqualified, possibly quoted identifiers
4336    pub fn parse_parenthesized_column_list(
4337        &mut self,
4338        optional: IsOptional,
4339    ) -> ModalResult<Vec<Ident>> {
4340        if self.consume_token(&Token::LParen) {
4341            let cols = self.parse_comma_separated(Parser::parse_identifier_non_reserved)?;
4342            self.expect_token(&Token::RParen)?;
4343            Ok(cols)
4344        } else if optional == Optional {
4345            Ok(vec![])
4346        } else {
4347            self.expected("a list of columns in parentheses")
4348        }
4349    }
4350
4351    pub fn parse_returning(&mut self, optional: IsOptional) -> ModalResult<Vec<SelectItem>> {
4352        if self.parse_keyword(Keyword::RETURNING) {
4353            let cols = self.parse_comma_separated(Parser::parse_select_item)?;
4354            Ok(cols)
4355        } else if optional == Optional {
4356            Ok(vec![])
4357        } else {
4358            self.expected("a list of columns or * after returning")
4359        }
4360    }
4361
4362    pub fn parse_row_expr(&mut self) -> ModalResult<Expr> {
4363        Ok(Expr::Row(self.parse_token_wrapped_exprs(
4364            &Token::LParen,
4365            &Token::RParen,
4366        )?))
4367    }
4368
4369    /// Parse a comma-separated list (maybe empty) from a wrapped expression
4370    pub fn parse_token_wrapped_exprs(
4371        &mut self,
4372        left: &Token,
4373        right: &Token,
4374    ) -> ModalResult<Vec<Expr>> {
4375        if self.consume_token(left) {
4376            let exprs = if self.consume_token(right) {
4377                vec![]
4378            } else {
4379                let exprs = self.parse_comma_separated(Parser::parse_expr)?;
4380                self.expect_token(right)?;
4381                exprs
4382            };
4383            Ok(exprs)
4384        } else {
4385            self.expected(left.to_string().as_str())
4386        }
4387    }
4388
4389    pub fn parse_optional_precision(&mut self) -> ModalResult<Option<u64>> {
4390        if self.consume_token(&Token::LParen) {
4391            let n = self.parse_literal_u64()?;
4392            self.expect_token(&Token::RParen)?;
4393            Ok(Some(n))
4394        } else {
4395            Ok(None)
4396        }
4397    }
4398
4399    pub fn parse_optional_precision_scale(&mut self) -> ModalResult<(Option<u64>, Option<u64>)> {
4400        if self.consume_token(&Token::LParen) {
4401            let n = self.parse_literal_u64()?;
4402            let scale = if self.consume_token(&Token::Comma) {
4403                Some(self.parse_literal_u64()?)
4404            } else {
4405                None
4406            };
4407            self.expect_token(&Token::RParen)?;
4408            Ok((Some(n), scale))
4409        } else {
4410            Ok((None, None))
4411        }
4412    }
4413
4414    pub fn parse_delete(&mut self) -> ModalResult<Statement> {
4415        self.expect_keyword(Keyword::FROM)?;
4416        let table_name = self.parse_object_name()?;
4417        let selection = if self.parse_keyword(Keyword::WHERE) {
4418            Some(self.parse_expr()?)
4419        } else {
4420            None
4421        };
4422        let returning = self.parse_returning(Optional)?;
4423
4424        Ok(Statement::Delete {
4425            table_name,
4426            selection,
4427            returning,
4428        })
4429    }
4430
4431    pub fn parse_boolean(&mut self) -> ModalResult<bool> {
4432        if let Some(keyword) = self.parse_one_of_keywords(&[Keyword::TRUE, Keyword::FALSE]) {
4433            match keyword {
4434                Keyword::TRUE => Ok(true),
4435                Keyword::FALSE => Ok(false),
4436                _ => unreachable!(),
4437            }
4438        } else {
4439            self.expected("TRUE or FALSE")
4440        }
4441    }
4442
4443    pub fn parse_optional_boolean(&mut self, default: bool) -> bool {
4444        self.parse_boolean().unwrap_or(default)
4445    }
4446
4447    fn parse_explain_options(&mut self) -> ModalResult<(ExplainOptions, Option<u64>)> {
4448        let mut options = ExplainOptions::default();
4449        let mut analyze_duration = None;
4450
4451        const BACKFILL: &str = "backfill";
4452        const VERBOSE: &str = "verbose";
4453        const TRACE: &str = "trace";
4454        const TYPE: &str = "type";
4455        const LOGICAL: &str = "logical";
4456        const PHYSICAL: &str = "physical";
4457        const DISTSQL: &str = "distsql";
4458        const FORMAT: &str = "format";
4459        const DURATION_SECS: &str = "duration_secs";
4460
4461        let explain_options_identifiers = [
4462            BACKFILL,
4463            VERBOSE,
4464            TRACE,
4465            TYPE,
4466            LOGICAL,
4467            PHYSICAL,
4468            DISTSQL,
4469            FORMAT,
4470            DURATION_SECS,
4471        ];
4472
4473        let parse_explain_option = |parser: &mut Parser<'_>| -> ModalResult<()> {
4474            match parser.parse_identifier()?.real_value().as_str() {
4475                VERBOSE => options.verbose = parser.parse_optional_boolean(true),
4476                TRACE => options.trace = parser.parse_optional_boolean(true),
4477                BACKFILL => options.backfill = parser.parse_optional_boolean(true),
4478                TYPE => {
4479                    let explain_type = parser.parse_identifier()?.real_value();
4480                    match explain_type.as_str() {
4481                        LOGICAL => options.explain_type = ExplainType::Logical,
4482                        PHYSICAL => options.explain_type = ExplainType::Physical,
4483                        DISTSQL => options.explain_type = ExplainType::DistSql,
4484                        unexpected => {
4485                            parser_err!("unexpected explain type: [{unexpected}]")
4486                        }
4487                    }
4488                }
4489                LOGICAL => options.explain_type = ExplainType::Logical,
4490                PHYSICAL => options.explain_type = ExplainType::Physical,
4491                DISTSQL => options.explain_type = ExplainType::DistSql,
4492                FORMAT => {
4493                    options.explain_format = {
4494                        let format = parser.parse_identifier()?.real_value();
4495                        match format.as_str() {
4496                            "text" => ExplainFormat::Text,
4497                            "json" => ExplainFormat::Json,
4498                            "xml" => ExplainFormat::Xml,
4499                            "yaml" => ExplainFormat::Yaml,
4500                            "dot" => ExplainFormat::Dot,
4501                            unexpected => {
4502                                parser_err!("unexpected explain format [{unexpected}]")
4503                            }
4504                        }
4505                    }
4506                }
4507                DURATION_SECS => {
4508                    analyze_duration = Some(parser.parse_literal_u64()?);
4509                }
4510                unexpected => {
4511                    parser_err!("unexpected explain options: [{unexpected}]")
4512                }
4513            };
4514            Ok(())
4515        };
4516
4517        // In order to support following statement, we need to peek before consume.
4518        // explain (select 1) union (select 1)
4519        if self.peek_token() == Token::LParen
4520            && let Token::Word(word) = self.peek_nth_token(1).token
4521            && let Ok(ident) = word.to_ident()
4522            && explain_options_identifiers.contains(&ident.real_value().as_str())
4523        {
4524            assert!(self.consume_token(&Token::LParen));
4525            self.parse_comma_separated(parse_explain_option)?;
4526            self.expect_token(&Token::RParen)?;
4527        }
4528
4529        Ok((options, analyze_duration))
4530    }
4531
4532    pub fn parse_explain(&mut self) -> ModalResult<Statement> {
4533        let analyze = self.parse_keyword(Keyword::ANALYZE);
4534        let (options, analyze_duration) = self.parse_explain_options()?;
4535
4536        if analyze {
4537            fn parse_analyze_target(parser: &mut Parser<'_>) -> ModalResult<Option<AnalyzeTarget>> {
4538                if parser.parse_keyword(Keyword::TABLE) {
4539                    let table_name = parser.parse_object_name()?;
4540                    Ok(Some(AnalyzeTarget::Table(table_name)))
4541                } else if parser.parse_keyword(Keyword::INDEX) {
4542                    let index_name = parser.parse_object_name()?;
4543                    Ok(Some(AnalyzeTarget::Index(index_name)))
4544                } else if parser.parse_keywords(&[Keyword::MATERIALIZED, Keyword::VIEW]) {
4545                    let view_name = parser.parse_object_name()?;
4546                    Ok(Some(AnalyzeTarget::MaterializedView(view_name)))
4547                } else if parser.parse_keyword(Keyword::INDEX) {
4548                    let index_name = parser.parse_object_name()?;
4549                    Ok(Some(AnalyzeTarget::Index(index_name)))
4550                } else if parser.parse_keyword(Keyword::SINK) {
4551                    let sink_name = parser.parse_object_name()?;
4552                    Ok(Some(AnalyzeTarget::Sink(sink_name)))
4553                } else if parser.parse_word("ID") {
4554                    let job_id = parser.parse_literal_u32()?;
4555                    Ok(Some(AnalyzeTarget::Id(job_id)))
4556                } else {
4557                    Ok(None)
4558                }
4559            }
4560            if let Some(target) = parse_analyze_target(self)? {
4561                let statement = Statement::ExplainAnalyzeStreamJob {
4562                    target,
4563                    duration_secs: analyze_duration,
4564                };
4565                return Ok(statement);
4566            }
4567        }
4568
4569        let statement = match self.parse_statement() {
4570            Ok(statement) => statement,
4571            error @ Err(_) => {
4572                return if analyze {
4573                    self.expected_at(
4574                        *self,
4575                        "SINK, TABLE, MATERIALIZED VIEW, INDEX or a statement after ANALYZE",
4576                    )
4577                } else {
4578                    error
4579                };
4580            }
4581        };
4582        Ok(Statement::Explain {
4583            analyze,
4584            statement: Box::new(statement),
4585            options,
4586        })
4587    }
4588
4589    pub fn parse_describe(&mut self) -> ModalResult<Statement> {
4590        let kind = match self.parse_one_of_keywords(&[Keyword::FRAGMENT, Keyword::FRAGMENTS]) {
4591            Some(Keyword::FRAGMENT) => {
4592                let fragment_id = self.parse_literal_u32()?;
4593                return Ok(Statement::DescribeFragment { fragment_id });
4594            }
4595            Some(Keyword::FRAGMENTS) => DescribeKind::Fragments,
4596            None => DescribeKind::Plain,
4597            Some(_) => unreachable!(),
4598        };
4599        let name = self.parse_object_name()?;
4600        Ok(Statement::Describe { name, kind })
4601    }
4602
4603    /// Parse a query expression, i.e. a `SELECT` statement optionally
4604    /// preceded with some `WITH` CTE declarations and optionally followed
4605    /// by `ORDER BY`. Unlike some other parse_... methods, this one doesn't
4606    /// expect the initial keyword to be already consumed
4607    pub fn parse_query(&mut self) -> ModalResult<Query> {
4608        let with = if self.parse_keyword(Keyword::WITH) {
4609            Some(With {
4610                recursive: self.parse_keyword(Keyword::RECURSIVE),
4611                cte_tables: self.parse_comma_separated(Parser::parse_cte)?,
4612            })
4613        } else {
4614            None
4615        };
4616
4617        let body = self.parse_query_body(0)?;
4618
4619        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
4620            self.parse_comma_separated(Parser::parse_order_by_expr)?
4621        } else {
4622            vec![]
4623        };
4624
4625        let mut limit = None;
4626        let mut offset = None;
4627        for _x in 0..2 {
4628            if limit.is_none() && self.parse_keyword(Keyword::LIMIT) {
4629                limit = self.parse_limit()?
4630            }
4631
4632            if offset.is_none() && self.parse_keyword(Keyword::OFFSET) {
4633                offset = Some(self.parse_offset()?)
4634            }
4635        }
4636
4637        let fetch = if self.parse_keyword(Keyword::FETCH) {
4638            if limit.is_some() {
4639                parser_err!("Cannot specify both LIMIT and FETCH");
4640            }
4641            let fetch = self.parse_fetch()?;
4642            if fetch.with_ties && order_by.is_empty() {
4643                parser_err!("WITH TIES cannot be specified without ORDER BY clause");
4644            }
4645            Some(fetch)
4646        } else {
4647            None
4648        };
4649
4650        Ok(Query {
4651            with,
4652            body,
4653            order_by,
4654            limit,
4655            offset,
4656            fetch,
4657        })
4658    }
4659
4660    /// Parse a CTE (`alias [( col1, col2, ... )] AS (subquery)`)
4661    fn parse_cte(&mut self) -> ModalResult<Cte> {
4662        let name = self.parse_identifier_non_reserved()?;
4663        let cte = if self.parse_keyword(Keyword::AS) {
4664            let cte_inner = self.parse_cte_inner()?;
4665            let alias = TableAlias {
4666                name,
4667                columns: vec![],
4668            };
4669            Cte { alias, cte_inner }
4670        } else {
4671            let columns = self.parse_parenthesized_column_list(Optional)?;
4672            self.expect_keyword(Keyword::AS)?;
4673            let cte_inner = self.parse_cte_inner()?;
4674            let alias = TableAlias { name, columns };
4675            Cte { alias, cte_inner }
4676        };
4677        Ok(cte)
4678    }
4679
4680    fn parse_cte_inner(&mut self) -> ModalResult<CteInner> {
4681        match self.expect_token(&Token::LParen) {
4682            Ok(()) => {
4683                let query = self.parse_query()?;
4684                self.expect_token(&Token::RParen)?;
4685                Ok(CteInner::Query(Box::new(query)))
4686            }
4687            _ => {
4688                let changelog = self.parse_identifier_non_reserved()?;
4689                if changelog.to_string().to_lowercase() != "changelog" {
4690                    parser_err!("Expected 'changelog' but found '{}'", changelog);
4691                }
4692                self.expect_keyword(Keyword::FROM)?;
4693                Ok(CteInner::ChangeLog(self.parse_object_name()?))
4694            }
4695        }
4696    }
4697
4698    /// Parse a "query body", which is an expression with roughly the
4699    /// following grammar:
4700    /// ```text
4701    ///   query_body ::= restricted_select | '(' subquery ')' | set_operation
4702    ///   restricted_select ::= 'SELECT' [expr_list] [ from ] [ where ] [ groupby_having ]
4703    ///   subquery ::= query_body [ order_by_limit ]
4704    ///   set_operation ::= query_body { 'UNION' | 'EXCEPT' | 'INTERSECT' } [ 'ALL' ] query_body
4705    /// ```
4706    fn parse_query_body(&mut self, precedence: u8) -> ModalResult<SetExpr> {
4707        // We parse the expression using a Pratt parser, as in `parse_expr()`.
4708        // Start by parsing a restricted SELECT or a `(subquery)`:
4709        let mut expr = if self.parse_keyword(Keyword::SELECT) {
4710            SetExpr::Select(Box::new(self.parse_select()?))
4711        } else if self.consume_token(&Token::LParen) {
4712            // CTEs are not allowed here, but the parser currently accepts them
4713            let subquery = self.parse_query()?;
4714            self.expect_token(&Token::RParen)?;
4715            SetExpr::Query(Box::new(subquery))
4716        } else if self.parse_keyword(Keyword::VALUES) {
4717            SetExpr::Values(self.parse_values()?)
4718        } else {
4719            return self.expected("SELECT, VALUES, or a subquery in the query body");
4720        };
4721
4722        loop {
4723            // The query can be optionally followed by a set operator:
4724            let op = self.parse_set_operator(&self.peek_token().token);
4725            let next_precedence = match op {
4726                // UNION and EXCEPT have the same binding power and evaluate left-to-right
4727                Some(SetOperator::Union) | Some(SetOperator::Except) => 10,
4728                // INTERSECT has higher precedence than UNION/EXCEPT
4729                Some(SetOperator::Intersect) => 20,
4730                // Unexpected token or EOF => stop parsing the query body
4731                None => break,
4732            };
4733            if precedence >= next_precedence {
4734                break;
4735            }
4736            self.next_token(); // skip past the set operator
4737
4738            let all = self.parse_keyword(Keyword::ALL);
4739            let corresponding = self.parse_corresponding()?;
4740
4741            expr = SetExpr::SetOperation {
4742                left: Box::new(expr),
4743                op: op.unwrap(),
4744                corresponding,
4745                all,
4746                right: Box::new(self.parse_query_body(next_precedence)?),
4747            };
4748        }
4749
4750        Ok(expr)
4751    }
4752
4753    fn parse_set_operator(&mut self, token: &Token) -> Option<SetOperator> {
4754        match token {
4755            Token::Word(w) if w.keyword == Keyword::UNION => Some(SetOperator::Union),
4756            Token::Word(w) if w.keyword == Keyword::EXCEPT => Some(SetOperator::Except),
4757            Token::Word(w) if w.keyword == Keyword::INTERSECT => Some(SetOperator::Intersect),
4758            _ => None,
4759        }
4760    }
4761
4762    fn parse_corresponding(&mut self) -> ModalResult<Corresponding> {
4763        let corresponding = if self.parse_keyword(Keyword::CORRESPONDING) {
4764            let column_list = if self.parse_keyword(Keyword::BY) {
4765                Some(self.parse_parenthesized_column_list(IsOptional::Mandatory)?)
4766            } else {
4767                None
4768            };
4769            Corresponding::with_column_list(column_list)
4770        } else {
4771            Corresponding::none()
4772        };
4773        Ok(corresponding)
4774    }
4775
4776    /// Parse a restricted `SELECT` statement (no CTEs / `UNION` / `ORDER BY`),
4777    /// assuming the initial `SELECT` was already consumed
4778    pub fn parse_select(&mut self) -> ModalResult<Select> {
4779        let distinct = self.parse_all_or_distinct_on()?;
4780
4781        let projection = self.parse_comma_separated(Parser::parse_select_item)?;
4782
4783        // Note that for keywords to be properly handled here, they need to be
4784        // added to `RESERVED_FOR_COLUMN_ALIAS` / `RESERVED_FOR_TABLE_ALIAS`,
4785        // otherwise they may be parsed as an alias as part of the `projection`
4786        // or `from`.
4787
4788        let from = if self.parse_keyword(Keyword::FROM) {
4789            self.parse_comma_separated(Parser::parse_table_and_joins)?
4790        } else {
4791            vec![]
4792        };
4793        let mut lateral_views = vec![];
4794        loop {
4795            if self.parse_keywords(&[Keyword::LATERAL, Keyword::VIEW]) {
4796                let outer = self.parse_keyword(Keyword::OUTER);
4797                let lateral_view = self.parse_expr()?;
4798                let lateral_view_name = self.parse_object_name()?;
4799                let lateral_col_alias = self
4800                    .parse_comma_separated(|parser| {
4801                        parser.parse_optional_alias(&[
4802                            Keyword::WHERE,
4803                            Keyword::GROUP,
4804                            Keyword::CLUSTER,
4805                            Keyword::HAVING,
4806                            Keyword::LATERAL,
4807                        ]) // This couldn't possibly be a bad idea
4808                    })?
4809                    .into_iter()
4810                    .flatten()
4811                    .collect();
4812
4813                lateral_views.push(LateralView {
4814                    lateral_view,
4815                    lateral_view_name,
4816                    lateral_col_alias,
4817                    outer,
4818                });
4819            } else {
4820                break;
4821            }
4822        }
4823
4824        let selection = if self.parse_keyword(Keyword::WHERE) {
4825            Some(self.parse_expr()?)
4826        } else {
4827            None
4828        };
4829
4830        let group_by = if self.parse_keywords(&[Keyword::GROUP, Keyword::BY]) {
4831            self.parse_comma_separated(Parser::parse_group_by_expr)?
4832        } else {
4833            vec![]
4834        };
4835
4836        let having = if self.parse_keyword(Keyword::HAVING) {
4837            Some(self.parse_expr()?)
4838        } else {
4839            None
4840        };
4841
4842        let window = if self.parse_keyword(Keyword::WINDOW) {
4843            self.parse_comma_separated(Parser::parse_named_window)?
4844        } else {
4845            vec![]
4846        };
4847
4848        Ok(Select {
4849            distinct,
4850            projection,
4851            from,
4852            lateral_views,
4853            selection,
4854            group_by,
4855            having,
4856            window,
4857        })
4858    }
4859
4860    pub fn parse_set(&mut self) -> ModalResult<Statement> {
4861        let modifier = self.parse_one_of_keywords(&[Keyword::SESSION, Keyword::LOCAL]);
4862        if self.parse_keywords(&[Keyword::TIME, Keyword::ZONE]) {
4863            let value = alt((
4864                Keyword::DEFAULT.value(SetTimeZoneValue::Default),
4865                Keyword::LOCAL.value(SetTimeZoneValue::Local),
4866                preceded(
4867                    Keyword::INTERVAL,
4868                    cut_err(Self::parse_literal_interval.try_map(|e| match e {
4869                        // support a special case for clients which would send when initializing the connection
4870                        // like: SET TIME ZONE INTERVAL '+00:00' HOUR TO MINUTE;
4871                        Expr::Value(v) => match v {
4872                            Value::Interval { value, .. } => {
4873                                if value != "+00:00" {
4874                                    return Err(StrError("only support \"+00:00\" ".into()));
4875                                }
4876                                Ok(SetTimeZoneValue::Ident(Ident::with_quote_unchecked(
4877                                    '\'',
4878                                    "UTC".to_owned(),
4879                                )))
4880                            }
4881                            _ => Err(StrError("expect Value::Interval".into())),
4882                        },
4883                        _ => Err(StrError("expect Expr::Value".into())),
4884                    })),
4885                ),
4886                Self::parse_identifier.map(SetTimeZoneValue::Ident),
4887                Self::ensure_parse_value.map(SetTimeZoneValue::Literal),
4888            ))
4889            .expect("variable")
4890            .parse_next(self)?;
4891
4892            Ok(Statement::SetTimeZone {
4893                local: modifier == Some(Keyword::LOCAL),
4894                value,
4895            })
4896        } else if self.parse_keyword(Keyword::CHARACTERISTICS) && modifier == Some(Keyword::SESSION)
4897        {
4898            self.expect_keywords(&[Keyword::AS, Keyword::TRANSACTION])?;
4899            Ok(Statement::SetTransaction {
4900                modes: self.parse_transaction_modes()?,
4901                snapshot: None,
4902                session: true,
4903            })
4904        } else if self.parse_keyword(Keyword::TRANSACTION) && modifier.is_none() {
4905            if self.parse_keyword(Keyword::SNAPSHOT) {
4906                let snapshot_id = self.ensure_parse_value()?;
4907                return Ok(Statement::SetTransaction {
4908                    modes: vec![],
4909                    snapshot: Some(snapshot_id),
4910                    session: false,
4911                });
4912            }
4913            Ok(Statement::SetTransaction {
4914                modes: self.parse_transaction_modes()?,
4915                snapshot: None,
4916                session: false,
4917            })
4918        } else {
4919            let config_param = self.parse_config_param()?;
4920            Ok(Statement::SetVariable {
4921                local: modifier == Some(Keyword::LOCAL),
4922                variable: config_param.param,
4923                value: config_param.value,
4924            })
4925        }
4926    }
4927
4928    /// If have `databases`,`tables`,`columns`,`schemas` and `materialized views` after show,
4929    /// return `Statement::ShowCommand` or `Statement::ShowColumn`,
4930    /// otherwise, return `Statement::ShowVariable`.
4931    pub fn parse_show(&mut self) -> ModalResult<Statement> {
4932        let checkpoint = *self;
4933        if let Token::Word(w) = self.next_token().token {
4934            match w.keyword {
4935                Keyword::TABLES => {
4936                    return Ok(Statement::ShowObjects {
4937                        object: ShowObject::Table {
4938                            schema: self.parse_from_and_identifier()?,
4939                        },
4940                        filter: self.parse_show_statement_filter()?,
4941                    });
4942                }
4943                Keyword::INTERNAL => {
4944                    self.expect_keyword(Keyword::TABLES)?;
4945                    return Ok(Statement::ShowObjects {
4946                        object: ShowObject::InternalTable {
4947                            schema: self.parse_from_and_identifier()?,
4948                        },
4949                        filter: self.parse_show_statement_filter()?,
4950                    });
4951                }
4952                Keyword::SOURCES => {
4953                    return Ok(Statement::ShowObjects {
4954                        object: ShowObject::Source {
4955                            schema: self.parse_from_and_identifier()?,
4956                        },
4957                        filter: self.parse_show_statement_filter()?,
4958                    });
4959                }
4960                Keyword::SINKS => {
4961                    return Ok(Statement::ShowObjects {
4962                        object: ShowObject::Sink {
4963                            schema: self.parse_from_and_identifier()?,
4964                        },
4965                        filter: self.parse_show_statement_filter()?,
4966                    });
4967                }
4968                Keyword::SUBSCRIPTIONS => {
4969                    return Ok(Statement::ShowObjects {
4970                        object: ShowObject::Subscription {
4971                            schema: self.parse_from_and_identifier()?,
4972                        },
4973                        filter: self.parse_show_statement_filter()?,
4974                    });
4975                }
4976                Keyword::DATABASES => {
4977                    return Ok(Statement::ShowObjects {
4978                        object: ShowObject::Database,
4979                        filter: self.parse_show_statement_filter()?,
4980                    });
4981                }
4982                Keyword::SCHEMAS => {
4983                    return Ok(Statement::ShowObjects {
4984                        object: ShowObject::Schema,
4985                        filter: self.parse_show_statement_filter()?,
4986                    });
4987                }
4988                Keyword::VIEWS => {
4989                    return Ok(Statement::ShowObjects {
4990                        object: ShowObject::View {
4991                            schema: self.parse_from_and_identifier()?,
4992                        },
4993                        filter: self.parse_show_statement_filter()?,
4994                    });
4995                }
4996                Keyword::MATERIALIZED => {
4997                    if self.parse_keyword(Keyword::VIEWS) {
4998                        return Ok(Statement::ShowObjects {
4999                            object: ShowObject::MaterializedView {
5000                                schema: self.parse_from_and_identifier()?,
5001                            },
5002                            filter: self.parse_show_statement_filter()?,
5003                        });
5004                    } else {
5005                        return self.expected("VIEWS after MATERIALIZED");
5006                    }
5007                }
5008                Keyword::COLUMNS => {
5009                    if self.parse_keyword(Keyword::FROM) {
5010                        return Ok(Statement::ShowObjects {
5011                            object: ShowObject::Columns {
5012                                table: self.parse_object_name()?,
5013                            },
5014                            filter: self.parse_show_statement_filter()?,
5015                        });
5016                    } else {
5017                        return self.expected("from after columns");
5018                    }
5019                }
5020                Keyword::SECRETS => {
5021                    return Ok(Statement::ShowObjects {
5022                        object: ShowObject::Secret {
5023                            schema: self.parse_from_and_identifier()?,
5024                        },
5025                        filter: self.parse_show_statement_filter()?,
5026                    });
5027                }
5028                Keyword::CONNECTIONS => {
5029                    return Ok(Statement::ShowObjects {
5030                        object: ShowObject::Connection {
5031                            schema: self.parse_from_and_identifier()?,
5032                        },
5033                        filter: self.parse_show_statement_filter()?,
5034                    });
5035                }
5036                Keyword::FUNCTIONS => {
5037                    return Ok(Statement::ShowObjects {
5038                        object: ShowObject::Function {
5039                            schema: self.parse_from_and_identifier()?,
5040                        },
5041                        filter: self.parse_show_statement_filter()?,
5042                    });
5043                }
5044                Keyword::INDEXES => {
5045                    if self.parse_keyword(Keyword::FROM) {
5046                        return Ok(Statement::ShowObjects {
5047                            object: ShowObject::Indexes {
5048                                table: self.parse_object_name()?,
5049                            },
5050                            filter: self.parse_show_statement_filter()?,
5051                        });
5052                    } else {
5053                        return self.expected("from after indexes");
5054                    }
5055                }
5056                Keyword::CLUSTER => {
5057                    return Ok(Statement::ShowObjects {
5058                        object: ShowObject::Cluster,
5059                        filter: self.parse_show_statement_filter()?,
5060                    });
5061                }
5062                Keyword::JOBS => {
5063                    return Ok(Statement::ShowObjects {
5064                        object: ShowObject::Jobs,
5065                        filter: self.parse_show_statement_filter()?,
5066                    });
5067                }
5068                Keyword::PROCESSLIST => {
5069                    return Ok(Statement::ShowObjects {
5070                        object: ShowObject::ProcessList,
5071                        filter: self.parse_show_statement_filter()?,
5072                    });
5073                }
5074                Keyword::TRANSACTION => {
5075                    self.expect_keywords(&[Keyword::ISOLATION, Keyword::LEVEL])?;
5076                    return Ok(Statement::ShowTransactionIsolationLevel);
5077                }
5078                Keyword::CURSORS => {
5079                    return Ok(Statement::ShowObjects {
5080                        object: ShowObject::Cursor,
5081                        filter: None,
5082                    });
5083                }
5084                Keyword::SUBSCRIPTION => {
5085                    self.expect_keyword(Keyword::CURSORS)?;
5086                    return Ok(Statement::ShowObjects {
5087                        object: ShowObject::SubscriptionCursor,
5088                        filter: None,
5089                    });
5090                }
5091                _ => {}
5092            }
5093        }
5094        *self = checkpoint;
5095        Ok(Statement::ShowVariable {
5096            variable: self.parse_identifiers()?,
5097        })
5098    }
5099
5100    pub fn parse_cancel_job(&mut self) -> ModalResult<Statement> {
5101        // CANCEL [JOBS|JOB] job_ids
5102        match self.peek_token().token {
5103            Token::Word(w) if Keyword::JOBS == w.keyword || Keyword::JOB == w.keyword => {
5104                self.next_token();
5105            }
5106            _ => return self.expected("JOBS or JOB after CANCEL"),
5107        }
5108
5109        let mut job_ids = vec![];
5110        loop {
5111            job_ids.push(self.parse_literal_u32()?);
5112            if !self.consume_token(&Token::Comma) {
5113                break;
5114            }
5115        }
5116        Ok(Statement::CancelJobs(JobIdents(job_ids)))
5117    }
5118
5119    pub fn parse_kill_process(&mut self) -> ModalResult<Statement> {
5120        let worker_process_id = self.parse_literal_string()?;
5121        Ok(Statement::Kill(worker_process_id))
5122    }
5123
5124    /// Parser `from schema` after `show tables` and `show materialized views`, if not conclude
5125    /// `from` then use default schema name.
5126    pub fn parse_from_and_identifier(&mut self) -> ModalResult<Option<Ident>> {
5127        if self.parse_keyword(Keyword::FROM) {
5128            Ok(Some(self.parse_identifier_non_reserved()?))
5129        } else {
5130            Ok(None)
5131        }
5132    }
5133
5134    /// Parse object type and name after `show create`.
5135    pub fn parse_show_create(&mut self) -> ModalResult<Statement> {
5136        if let Token::Word(w) = self.next_token().token {
5137            let show_type = match w.keyword {
5138                Keyword::TABLE => ShowCreateType::Table,
5139                Keyword::MATERIALIZED => {
5140                    if self.parse_keyword(Keyword::VIEW) {
5141                        ShowCreateType::MaterializedView
5142                    } else {
5143                        return self.expected("VIEW after MATERIALIZED");
5144                    }
5145                }
5146                Keyword::VIEW => ShowCreateType::View,
5147                Keyword::INDEX => ShowCreateType::Index,
5148                Keyword::SOURCE => ShowCreateType::Source,
5149                Keyword::SINK => ShowCreateType::Sink,
5150                Keyword::SUBSCRIPTION => ShowCreateType::Subscription,
5151                Keyword::FUNCTION => ShowCreateType::Function,
5152                _ => return self.expected(
5153                    "TABLE, MATERIALIZED VIEW, VIEW, INDEX, FUNCTION, SOURCE, SUBSCRIPTION or SINK",
5154                ),
5155            };
5156            return Ok(Statement::ShowCreateObject {
5157                create_type: show_type,
5158                name: self.parse_object_name()?,
5159            });
5160        }
5161        self.expected(
5162            "TABLE, MATERIALIZED VIEW, VIEW, INDEX, FUNCTION, SOURCE, SUBSCRIPTION or SINK",
5163        )
5164    }
5165
5166    pub fn parse_show_statement_filter(&mut self) -> ModalResult<Option<ShowStatementFilter>> {
5167        if self.parse_keyword(Keyword::LIKE) {
5168            Ok(Some(ShowStatementFilter::Like(
5169                self.parse_literal_string()?,
5170            )))
5171        } else if self.parse_keyword(Keyword::ILIKE) {
5172            Ok(Some(ShowStatementFilter::ILike(
5173                self.parse_literal_string()?,
5174            )))
5175        } else if self.parse_keyword(Keyword::WHERE) {
5176            Ok(Some(ShowStatementFilter::Where(self.parse_expr()?)))
5177        } else {
5178            Ok(None)
5179        }
5180    }
5181
5182    pub fn parse_table_and_joins(&mut self) -> ModalResult<TableWithJoins> {
5183        let relation = self.parse_table_factor()?;
5184
5185        // Note that for keywords to be properly handled here, they need to be
5186        // added to `RESERVED_FOR_TABLE_ALIAS`, otherwise they may be parsed as
5187        // a table alias.
5188        let mut joins = vec![];
5189        loop {
5190            let join = if self.parse_keyword(Keyword::CROSS) {
5191                let join_operator = if self.parse_keyword(Keyword::JOIN) {
5192                    JoinOperator::CrossJoin
5193                } else {
5194                    return self.expected("JOIN after CROSS");
5195                };
5196                Join {
5197                    relation: self.parse_table_factor()?,
5198                    join_operator,
5199                }
5200            } else {
5201                let (natural, asof) =
5202                    match self.parse_one_of_keywords(&[Keyword::NATURAL, Keyword::ASOF]) {
5203                        Some(Keyword::NATURAL) => (true, false),
5204                        Some(Keyword::ASOF) => (false, true),
5205                        Some(_) => unreachable!(),
5206                        None => (false, false),
5207                    };
5208                let peek_keyword = if let Token::Word(w) = self.peek_token().token {
5209                    w.keyword
5210                } else {
5211                    Keyword::NoKeyword
5212                };
5213
5214                let join_operator_type = match peek_keyword {
5215                    Keyword::INNER | Keyword::JOIN => {
5216                        let _ = self.parse_keyword(Keyword::INNER);
5217                        self.expect_keyword(Keyword::JOIN)?;
5218                        if asof {
5219                            JoinOperator::AsOfInner
5220                        } else {
5221                            JoinOperator::Inner
5222                        }
5223                    }
5224                    kw @ Keyword::LEFT | kw @ Keyword::RIGHT | kw @ Keyword::FULL => {
5225                        let checkpoint = *self;
5226                        let _ = self.next_token();
5227                        let _ = self.parse_keyword(Keyword::OUTER);
5228                        self.expect_keyword(Keyword::JOIN)?;
5229                        if asof {
5230                            if Keyword::LEFT == kw {
5231                                JoinOperator::AsOfLeft
5232                            } else {
5233                                return self.expected_at(
5234                                    checkpoint,
5235                                    "LEFT after ASOF. RIGHT or FULL are not supported",
5236                                );
5237                            }
5238                        } else {
5239                            match kw {
5240                                Keyword::LEFT => JoinOperator::LeftOuter,
5241                                Keyword::RIGHT => JoinOperator::RightOuter,
5242                                Keyword::FULL => JoinOperator::FullOuter,
5243                                _ => unreachable!(),
5244                            }
5245                        }
5246                    }
5247                    Keyword::OUTER => {
5248                        return self.expected("LEFT, RIGHT, or FULL");
5249                    }
5250                    _ if natural => {
5251                        return self.expected("a join type after NATURAL");
5252                    }
5253                    _ if asof => {
5254                        return self.expected("a join type after ASOF");
5255                    }
5256                    _ => break,
5257                };
5258                let relation = self.parse_table_factor()?;
5259                let join_constraint = self.parse_join_constraint(natural)?;
5260                let join_operator = join_operator_type(join_constraint);
5261                let need_constraint = match join_operator {
5262                    JoinOperator::Inner(JoinConstraint::None) => Some("INNER JOIN"),
5263                    JoinOperator::AsOfInner(JoinConstraint::None) => Some("ASOF INNER JOIN"),
5264                    JoinOperator::AsOfLeft(JoinConstraint::None) => Some("ASOF LEFT JOIN"),
5265                    _ => None,
5266                };
5267                if let Some(join_type) = need_constraint {
5268                    return self.expected(&format!("join constraint after {join_type}"));
5269                }
5270
5271                Join {
5272                    relation,
5273                    join_operator,
5274                }
5275            };
5276            joins.push(join);
5277        }
5278        Ok(TableWithJoins { relation, joins })
5279    }
5280
5281    /// A table name or a parenthesized subquery, followed by optional `[AS] alias`
5282    pub fn parse_table_factor(&mut self) -> ModalResult<TableFactor> {
5283        if self.parse_keyword(Keyword::LATERAL) {
5284            // LATERAL must always be followed by a subquery.
5285            if !self.consume_token(&Token::LParen) {
5286                self.expected("subquery after LATERAL")?;
5287            }
5288            self.parse_derived_table_factor(Lateral)
5289        } else if self.consume_token(&Token::LParen) {
5290            // A left paren introduces either a derived table (i.e., a subquery)
5291            // or a nested join. It's nearly impossible to determine ahead of
5292            // time which it is... so we just try to parse both.
5293            //
5294            // Here's an example that demonstrates the complexity:
5295            //                     /-------------------------------------------------------\
5296            //                     | /-----------------------------------\                 |
5297            //     SELECT * FROM ( ( ( (SELECT 1) UNION (SELECT 2) ) AS t1 NATURAL JOIN t2 ) )
5298            //                   ^ ^ ^ ^
5299            //                   | | | |
5300            //                   | | | |
5301            //                   | | | (4) belongs to a SetExpr::Query inside the subquery
5302            //                   | | (3) starts a derived table (subquery)
5303            //                   | (2) starts a nested join
5304            //                   (1) an additional set of parens around a nested join
5305            //
5306
5307            // It can only be a subquery. We don't use `maybe_parse` so that a meaningful error can
5308            // be returned.
5309            match self.peek_token().token {
5310                Token::Word(w)
5311                    if [Keyword::SELECT, Keyword::WITH, Keyword::VALUES].contains(&w.keyword) =>
5312                {
5313                    return self.parse_derived_table_factor(NotLateral);
5314                }
5315                _ => {}
5316            };
5317            // It can still be a subquery, e.g., the case (3) in the example above:
5318            // (SELECT 1) UNION (SELECT 2)
5319            // TODO: how to produce a good error message here?
5320            if self.peek_token() == Token::LParen {
5321                return_ok_if_some!(
5322                    self.maybe_parse(|parser| parser.parse_derived_table_factor(NotLateral))
5323                );
5324            }
5325
5326            // A parsing error from `parse_derived_table_factor` indicates that the '(' we've
5327            // recently consumed does not start a derived table (cases 1, 2, or 4).
5328            // `maybe_parse` will ignore such an error and rewind to be after the opening '('.
5329
5330            // Inside the parentheses we expect to find an (A) table factor
5331            // followed by some joins or (B) another level of nesting.
5332            let table_and_joins = self.parse_table_and_joins()?;
5333
5334            #[allow(clippy::if_same_then_else)]
5335            if !table_and_joins.joins.is_empty() {
5336                self.expect_token(&Token::RParen)?;
5337                Ok(TableFactor::NestedJoin(Box::new(table_and_joins))) // (A)
5338            } else if let TableFactor::NestedJoin(_) = &table_and_joins.relation {
5339                // (B): `table_and_joins` (what we found inside the parentheses)
5340                // is a nested join `(foo JOIN bar)`, not followed by other joins.
5341                self.expect_token(&Token::RParen)?;
5342                Ok(TableFactor::NestedJoin(Box::new(table_and_joins)))
5343            } else {
5344                // The SQL spec prohibits derived tables and bare tables from
5345                // appearing alone in parentheses (e.g. `FROM (mytable)`)
5346                parser_err!(
5347                    "Expected joined table, found: {table_and_joins}, next_token: {}",
5348                    self.peek_token()
5349                );
5350            }
5351        } else {
5352            let name = self.parse_object_name()?;
5353            if self.peek_token() == Token::LParen {
5354                // table-valued function
5355
5356                let arg_list = self.parse_argument_list()?;
5357                if arg_list.distinct {
5358                    parser_err!("DISTINCT is not supported in table-valued function calls");
5359                }
5360                if !arg_list.order_by.is_empty() {
5361                    parser_err!("ORDER BY is not supported in table-valued function calls");
5362                }
5363                if arg_list.ignore_nulls {
5364                    parser_err!("IGNORE NULLS is not supported in table-valued function calls");
5365                }
5366
5367                let args = arg_list.args;
5368                let with_ordinality = self.parse_keywords(&[Keyword::WITH, Keyword::ORDINALITY]);
5369                let alias = self.parse_optional_table_alias(keywords::RESERVED_FOR_TABLE_ALIAS)?;
5370
5371                Ok(TableFactor::TableFunction {
5372                    name,
5373                    alias,
5374                    args,
5375                    with_ordinality,
5376                })
5377            } else {
5378                let as_of = opt(Self::parse_as_of).parse_next(self)?;
5379                let alias = self.parse_optional_table_alias(keywords::RESERVED_FOR_TABLE_ALIAS)?;
5380                Ok(TableFactor::Table { name, alias, as_of })
5381            }
5382        }
5383    }
5384
5385    pub fn parse_derived_table_factor(&mut self, lateral: IsLateral) -> ModalResult<TableFactor> {
5386        let subquery = Box::new(self.parse_query()?);
5387        self.expect_token(&Token::RParen)?;
5388        let alias = self.parse_optional_table_alias(keywords::RESERVED_FOR_TABLE_ALIAS)?;
5389        Ok(TableFactor::Derived {
5390            lateral: match lateral {
5391                Lateral => true,
5392                NotLateral => false,
5393            },
5394            subquery,
5395            alias,
5396        })
5397    }
5398
5399    fn parse_join_constraint(&mut self, natural: bool) -> ModalResult<JoinConstraint> {
5400        if natural {
5401            Ok(JoinConstraint::Natural)
5402        } else if self.parse_keyword(Keyword::ON) {
5403            let constraint = self.parse_expr()?;
5404            Ok(JoinConstraint::On(constraint))
5405        } else if self.parse_keyword(Keyword::USING) {
5406            let columns = self.parse_parenthesized_column_list(Mandatory)?;
5407            Ok(JoinConstraint::Using(columns))
5408        } else {
5409            Ok(JoinConstraint::None)
5410            // self.expected("ON, or USING after JOIN")
5411        }
5412    }
5413
5414    /// Parse a GRANT statement.
5415    pub fn parse_grant(&mut self) -> ModalResult<Statement> {
5416        let (privileges, objects) = self.parse_grant_revoke_privileges_objects()?;
5417
5418        self.expect_keyword(Keyword::TO)?;
5419        let grantees = self.parse_comma_separated(Parser::parse_identifier)?;
5420
5421        let with_grant_option =
5422            self.parse_keywords(&[Keyword::WITH, Keyword::GRANT, Keyword::OPTION]);
5423
5424        let granted_by = self
5425            .parse_keywords(&[Keyword::GRANTED, Keyword::BY])
5426            .then(|| self.parse_identifier().unwrap());
5427
5428        Ok(Statement::Grant {
5429            privileges,
5430            objects,
5431            grantees,
5432            with_grant_option,
5433            granted_by,
5434        })
5435    }
5436
5437    fn parse_privileges(&mut self) -> ModalResult<Privileges> {
5438        let privileges = if self.parse_keyword(Keyword::ALL) {
5439            Privileges::All {
5440                with_privileges_keyword: self.parse_keyword(Keyword::PRIVILEGES),
5441            }
5442        } else {
5443            Privileges::Actions(
5444                self.parse_comma_separated(Parser::parse_grant_permission)?
5445                    .into_iter()
5446                    .map(|(kw, columns)| match kw {
5447                        Keyword::CONNECT => Action::Connect,
5448                        Keyword::CREATE => Action::Create,
5449                        Keyword::DELETE => Action::Delete,
5450                        Keyword::EXECUTE => Action::Execute,
5451                        Keyword::INSERT => Action::Insert { columns },
5452                        Keyword::REFERENCES => Action::References { columns },
5453                        Keyword::SELECT => Action::Select { columns },
5454                        Keyword::TEMPORARY => Action::Temporary,
5455                        Keyword::TRIGGER => Action::Trigger,
5456                        Keyword::TRUNCATE => Action::Truncate,
5457                        Keyword::UPDATE => Action::Update { columns },
5458                        Keyword::USAGE => Action::Usage,
5459                        _ => unreachable!(),
5460                    })
5461                    .collect(),
5462            )
5463        };
5464
5465        Ok(privileges)
5466    }
5467
5468    fn parse_grant_revoke_privileges_objects(&mut self) -> ModalResult<(Privileges, GrantObjects)> {
5469        let privileges = self.parse_privileges()?;
5470
5471        self.expect_keyword(Keyword::ON)?;
5472
5473        let objects = if self.parse_keywords(&[
5474            Keyword::ALL,
5475            Keyword::TABLES,
5476            Keyword::IN,
5477            Keyword::SCHEMA,
5478        ]) {
5479            GrantObjects::AllTablesInSchema {
5480                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5481            }
5482        } else if self.parse_keywords(&[
5483            Keyword::ALL,
5484            Keyword::SEQUENCES,
5485            Keyword::IN,
5486            Keyword::SCHEMA,
5487        ]) {
5488            GrantObjects::AllSequencesInSchema {
5489                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5490            }
5491        } else if self.parse_keywords(&[
5492            Keyword::ALL,
5493            Keyword::SOURCES,
5494            Keyword::IN,
5495            Keyword::SCHEMA,
5496        ]) {
5497            GrantObjects::AllSourcesInSchema {
5498                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5499            }
5500        } else if self.parse_keywords(&[Keyword::ALL, Keyword::SINKS, Keyword::IN, Keyword::SCHEMA])
5501        {
5502            GrantObjects::AllSinksInSchema {
5503                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5504            }
5505        } else if self.parse_keywords(&[
5506            Keyword::ALL,
5507            Keyword::MATERIALIZED,
5508            Keyword::VIEWS,
5509            Keyword::IN,
5510            Keyword::SCHEMA,
5511        ]) {
5512            GrantObjects::AllMviewsInSchema {
5513                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5514            }
5515        } else if self.parse_keywords(&[Keyword::ALL, Keyword::VIEWS, Keyword::IN, Keyword::SCHEMA])
5516        {
5517            GrantObjects::AllViewsInSchema {
5518                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5519            }
5520        } else if self.parse_keywords(&[
5521            Keyword::ALL,
5522            Keyword::FUNCTIONS,
5523            Keyword::IN,
5524            Keyword::SCHEMA,
5525        ]) {
5526            GrantObjects::AllFunctionsInSchema {
5527                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5528            }
5529        } else if self.parse_keywords(&[
5530            Keyword::ALL,
5531            Keyword::SECRETS,
5532            Keyword::IN,
5533            Keyword::SCHEMA,
5534        ]) {
5535            GrantObjects::AllSecretsInSchema {
5536                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5537            }
5538        } else if self.parse_keywords(&[
5539            Keyword::ALL,
5540            Keyword::CONNECTIONS,
5541            Keyword::IN,
5542            Keyword::SCHEMA,
5543        ]) {
5544            GrantObjects::AllConnectionsInSchema {
5545                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5546            }
5547        } else if self.parse_keywords(&[
5548            Keyword::ALL,
5549            Keyword::SUBSCRIPTIONS,
5550            Keyword::IN,
5551            Keyword::SCHEMA,
5552        ]) {
5553            GrantObjects::AllSubscriptionsInSchema {
5554                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5555            }
5556        } else if self.parse_keywords(&[Keyword::MATERIALIZED, Keyword::VIEW]) {
5557            GrantObjects::Mviews(self.parse_comma_separated(Parser::parse_object_name)?)
5558        } else {
5559            let object_type = self.parse_one_of_keywords(&[
5560                Keyword::SEQUENCE,
5561                Keyword::DATABASE,
5562                Keyword::SCHEMA,
5563                Keyword::TABLE,
5564                Keyword::SOURCE,
5565                Keyword::SINK,
5566                Keyword::VIEW,
5567                Keyword::SUBSCRIPTION,
5568                Keyword::FUNCTION,
5569                Keyword::CONNECTION,
5570                Keyword::SECRET,
5571            ]);
5572            if let Some(Keyword::FUNCTION) = object_type {
5573                let func_descs = self.parse_comma_separated(Parser::parse_function_desc)?;
5574                GrantObjects::Functions(func_descs)
5575            } else {
5576                let objects = self.parse_comma_separated(Parser::parse_object_name);
5577                match object_type {
5578                    Some(Keyword::DATABASE) => GrantObjects::Databases(objects?),
5579                    Some(Keyword::SCHEMA) => GrantObjects::Schemas(objects?),
5580                    Some(Keyword::SEQUENCE) => GrantObjects::Sequences(objects?),
5581                    Some(Keyword::SOURCE) => GrantObjects::Sources(objects?),
5582                    Some(Keyword::SINK) => GrantObjects::Sinks(objects?),
5583                    Some(Keyword::VIEW) => GrantObjects::Views(objects?),
5584                    Some(Keyword::SUBSCRIPTION) => GrantObjects::Subscriptions(objects?),
5585                    Some(Keyword::CONNECTION) => GrantObjects::Connections(objects?),
5586                    Some(Keyword::SECRET) => GrantObjects::Secrets(objects?),
5587                    Some(Keyword::TABLE) | None => GrantObjects::Tables(objects?),
5588                    _ => unreachable!(),
5589                }
5590            }
5591        };
5592
5593        Ok((privileges, objects))
5594    }
5595
5596    fn parse_grant_permission(&mut self) -> ModalResult<(Keyword, Option<Vec<Ident>>)> {
5597        let kw = self.expect_one_of_keywords(&[
5598            Keyword::CONNECT,
5599            Keyword::CREATE,
5600            Keyword::DELETE,
5601            Keyword::EXECUTE,
5602            Keyword::INSERT,
5603            Keyword::REFERENCES,
5604            Keyword::SELECT,
5605            Keyword::TEMPORARY,
5606            Keyword::TRIGGER,
5607            Keyword::TRUNCATE,
5608            Keyword::UPDATE,
5609            Keyword::USAGE,
5610        ])?;
5611        let columns = match kw {
5612            Keyword::INSERT | Keyword::REFERENCES | Keyword::SELECT | Keyword::UPDATE => {
5613                let columns = self.parse_parenthesized_column_list(Optional)?;
5614                if columns.is_empty() {
5615                    None
5616                } else {
5617                    Some(columns)
5618                }
5619            }
5620            _ => None,
5621        };
5622        Ok((kw, columns))
5623    }
5624
5625    /// Parse a REVOKE statement
5626    pub fn parse_revoke(&mut self) -> ModalResult<Statement> {
5627        let revoke_grant_option =
5628            self.parse_keywords(&[Keyword::GRANT, Keyword::OPTION, Keyword::FOR]);
5629        let (privileges, objects) = self.parse_grant_revoke_privileges_objects()?;
5630
5631        self.expect_keyword(Keyword::FROM)?;
5632        let grantees = self.parse_comma_separated(Parser::parse_identifier)?;
5633
5634        let granted_by = self
5635            .parse_keywords(&[Keyword::GRANTED, Keyword::BY])
5636            .then(|| self.parse_identifier().unwrap());
5637
5638        let cascade = self.parse_keyword(Keyword::CASCADE);
5639        let restrict = self.parse_keyword(Keyword::RESTRICT);
5640        if cascade && restrict {
5641            parser_err!("Cannot specify both CASCADE and RESTRICT in REVOKE");
5642        }
5643
5644        Ok(Statement::Revoke {
5645            privileges,
5646            objects,
5647            grantees,
5648            granted_by,
5649            revoke_grant_option,
5650            cascade,
5651        })
5652    }
5653
5654    fn parse_privilege_object_types(&mut self) -> ModalResult<PrivilegeObjectType> {
5655        let object_type = if self.parse_keyword(Keyword::TABLES) {
5656            PrivilegeObjectType::Tables
5657        } else if self.parse_keyword(Keyword::SOURCES) {
5658            PrivilegeObjectType::Sources
5659        } else if self.parse_keyword(Keyword::SINKS) {
5660            PrivilegeObjectType::Sinks
5661        } else if self.parse_keywords(&[Keyword::MATERIALIZED, Keyword::VIEWS]) {
5662            PrivilegeObjectType::Mviews
5663        } else if self.parse_keyword(Keyword::VIEWS) {
5664            PrivilegeObjectType::Views
5665        } else if self.parse_keyword(Keyword::FUNCTIONS) {
5666            PrivilegeObjectType::Functions
5667        } else if self.parse_keyword(Keyword::SECRETS) {
5668            PrivilegeObjectType::Secrets
5669        } else if self.parse_keyword(Keyword::CONNECTIONS) {
5670            PrivilegeObjectType::Connections
5671        } else if self.parse_keyword(Keyword::SUBSCRIPTIONS) {
5672            PrivilegeObjectType::Subscriptions
5673        } else if self.parse_keyword(Keyword::SCHEMAS) {
5674            PrivilegeObjectType::Schemas
5675        } else {
5676            return self.expected("TABLES, SOURCES, SINKS, MATERIALIZED VIEWS, VIEWS, FUNCTIONS, SECRETS, CONNECTIONS, SUBSCRIPTIONS or SCHEMAS");
5677        };
5678
5679        Ok(object_type)
5680    }
5681
5682    pub fn parse_alter_default_privileges(&mut self) -> ModalResult<Statement> {
5683        // [ FOR USER target_user [, ...] ]
5684        let target_users = if self.parse_keyword(Keyword::FOR) {
5685            self.expect_keyword(Keyword::USER)?;
5686            Some(self.parse_comma_separated(Parser::parse_identifier)?)
5687        } else {
5688            None
5689        };
5690
5691        // [ IN SCHEMA schema_name [, ...] ]
5692        let schema_names = if self.parse_keywords(&[Keyword::IN, Keyword::SCHEMA]) {
5693            Some(self.parse_comma_separated(Parser::parse_object_name)?)
5694        } else {
5695            None
5696        };
5697        let keyword = self.expect_one_of_keywords(&[Keyword::GRANT, Keyword::REVOKE])?;
5698        let for_grant = keyword == Keyword::GRANT;
5699        if for_grant {
5700            let privileges = self.parse_privileges()?;
5701            self.expect_keyword(Keyword::ON)?;
5702            let object_type = self.parse_privilege_object_types()?;
5703            if schema_names.is_some() && object_type == PrivilegeObjectType::Schemas {
5704                parser_err!("cannot use IN SCHEMA clause when using GRANT/REVOKE ON SCHEMAS");
5705            }
5706            self.expect_keyword(Keyword::TO)?;
5707            let grantees = self.parse_comma_separated(Parser::parse_identifier)?;
5708
5709            let with_grant_option =
5710                self.parse_keywords(&[Keyword::WITH, Keyword::GRANT, Keyword::OPTION]);
5711
5712            Ok(Statement::AlterDefaultPrivileges {
5713                target_users,
5714                schema_names,
5715                operation: DefaultPrivilegeOperation::Grant {
5716                    privileges,
5717                    object_type,
5718                    grantees,
5719                    with_grant_option,
5720                },
5721            })
5722        } else {
5723            let revoke_grant_option =
5724                self.parse_keywords(&[Keyword::GRANT, Keyword::OPTION, Keyword::FOR]);
5725            let privileges = self.parse_privileges()?;
5726            self.expect_keyword(Keyword::ON)?;
5727            let object_type = self.parse_privilege_object_types()?;
5728            if schema_names.is_some() && object_type == PrivilegeObjectType::Schemas {
5729                parser_err!("cannot use IN SCHEMA clause when using GRANT/REVOKE ON SCHEMAS");
5730            }
5731            self.expect_keyword(Keyword::FROM)?;
5732            let grantees = self.parse_comma_separated(Parser::parse_identifier)?;
5733            let cascade = self.parse_keyword(Keyword::CASCADE);
5734            let restrict = self.parse_keyword(Keyword::RESTRICT);
5735            if cascade && restrict {
5736                parser_err!("Cannot specify both CASCADE and RESTRICT in REVOKE");
5737            }
5738
5739            Ok(Statement::AlterDefaultPrivileges {
5740                target_users,
5741                schema_names,
5742                operation: DefaultPrivilegeOperation::Revoke {
5743                    privileges,
5744                    object_type,
5745                    grantees,
5746                    revoke_grant_option,
5747                    cascade,
5748                },
5749            })
5750        }
5751    }
5752
5753    /// Parse an INSERT statement
5754    pub fn parse_insert(&mut self) -> ModalResult<Statement> {
5755        self.expect_keyword(Keyword::INTO)?;
5756
5757        let table_name = self.parse_object_name()?;
5758        let columns = self.parse_parenthesized_column_list(Optional)?;
5759
5760        let source = Box::new(self.parse_query()?);
5761        let returning = self.parse_returning(Optional)?;
5762        Ok(Statement::Insert {
5763            table_name,
5764            columns,
5765            source,
5766            returning,
5767        })
5768    }
5769
5770    pub fn parse_update(&mut self) -> ModalResult<Statement> {
5771        let table_name = self.parse_object_name()?;
5772
5773        self.expect_keyword(Keyword::SET)?;
5774        let assignments = self.parse_comma_separated(Parser::parse_assignment)?;
5775        let selection = if self.parse_keyword(Keyword::WHERE) {
5776            Some(self.parse_expr()?)
5777        } else {
5778            None
5779        };
5780        let returning = self.parse_returning(Optional)?;
5781        Ok(Statement::Update {
5782            table_name,
5783            assignments,
5784            selection,
5785            returning,
5786        })
5787    }
5788
5789    /// Parse a `var = expr` assignment, used in an UPDATE statement
5790    pub fn parse_assignment(&mut self) -> ModalResult<Assignment> {
5791        let id = self.parse_identifiers_non_keywords()?;
5792        self.expect_token(&Token::Eq)?;
5793
5794        let value = if self.parse_keyword(Keyword::DEFAULT) {
5795            AssignmentValue::Default
5796        } else {
5797            AssignmentValue::Expr(self.parse_expr()?)
5798        };
5799
5800        Ok(Assignment { id, value })
5801    }
5802
5803    /// Parse a `[VARIADIC] name => expr`.
5804    fn parse_function_args(&mut self) -> ModalResult<(bool, FunctionArg)> {
5805        let variadic = self.parse_keyword(Keyword::VARIADIC);
5806        let arg = if self.peek_nth_token(1) == Token::RArrow {
5807            let name = self.parse_identifier()?;
5808
5809            self.expect_token(&Token::RArrow)?;
5810            let arg = self.parse_wildcard_or_expr()?.into();
5811
5812            FunctionArg::Named { name, arg }
5813        } else {
5814            FunctionArg::Unnamed(self.parse_wildcard_or_expr()?.into())
5815        };
5816        Ok((variadic, arg))
5817    }
5818
5819    pub fn parse_argument_list(&mut self) -> ModalResult<FunctionArgList> {
5820        self.expect_token(&Token::LParen)?;
5821        if self.consume_token(&Token::RParen) {
5822            Ok(FunctionArgList::empty())
5823        } else {
5824            let distinct = self.parse_all_or_distinct()?;
5825            let args = self.parse_comma_separated(Parser::parse_function_args)?;
5826            if args
5827                .iter()
5828                .take(args.len() - 1)
5829                .any(|(variadic, _)| *variadic)
5830            {
5831                parser_err!("VARIADIC argument must be the last");
5832            }
5833            let variadic = args.last().map(|(variadic, _)| *variadic).unwrap_or(false);
5834            let args = args.into_iter().map(|(_, arg)| arg).collect();
5835
5836            let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
5837                self.parse_comma_separated(Parser::parse_order_by_expr)?
5838            } else {
5839                vec![]
5840            };
5841
5842            let ignore_nulls = self.parse_keywords(&[Keyword::IGNORE, Keyword::NULLS]);
5843
5844            let arg_list = FunctionArgList {
5845                distinct,
5846                args,
5847                variadic,
5848                order_by,
5849                ignore_nulls,
5850            };
5851
5852            self.expect_token(&Token::RParen)?;
5853            Ok(arg_list)
5854        }
5855    }
5856
5857    /// Parse a comma-delimited list of projections after SELECT
5858    pub fn parse_select_item(&mut self) -> ModalResult<SelectItem> {
5859        match self.parse_wildcard_or_expr()? {
5860            WildcardOrExpr::Expr(expr) => self
5861                .parse_optional_alias(keywords::RESERVED_FOR_COLUMN_ALIAS)
5862                .map(|alias| match alias {
5863                    Some(alias) => SelectItem::ExprWithAlias { expr, alias },
5864                    None => SelectItem::UnnamedExpr(expr),
5865                }),
5866            WildcardOrExpr::QualifiedWildcard(prefix, except) => {
5867                Ok(SelectItem::QualifiedWildcard(prefix, except))
5868            }
5869            WildcardOrExpr::ExprQualifiedWildcard(expr, prefix) => {
5870                Ok(SelectItem::ExprQualifiedWildcard(expr, prefix))
5871            }
5872            WildcardOrExpr::Wildcard(except) => Ok(SelectItem::Wildcard(except)),
5873        }
5874    }
5875
5876    /// Parse an expression, optionally followed by ASC or DESC (used in ORDER BY)
5877    pub fn parse_order_by_expr(&mut self) -> ModalResult<OrderByExpr> {
5878        let expr = self.parse_expr()?;
5879
5880        let asc = if self.parse_keyword(Keyword::ASC) {
5881            Some(true)
5882        } else if self.parse_keyword(Keyword::DESC) {
5883            Some(false)
5884        } else {
5885            None
5886        };
5887
5888        let nulls_first = if self.parse_keywords(&[Keyword::NULLS, Keyword::FIRST]) {
5889            Some(true)
5890        } else if self.parse_keywords(&[Keyword::NULLS, Keyword::LAST]) {
5891            Some(false)
5892        } else {
5893            None
5894        };
5895
5896        Ok(OrderByExpr {
5897            expr,
5898            asc,
5899            nulls_first,
5900        })
5901    }
5902
5903    /// Parse a LIMIT clause
5904    pub fn parse_limit(&mut self) -> ModalResult<Option<Expr>> {
5905        if self.parse_keyword(Keyword::ALL) {
5906            Ok(None)
5907        } else {
5908            let expr = self.parse_expr()?;
5909            Ok(Some(expr))
5910        }
5911    }
5912
5913    /// Parse an OFFSET clause
5914    pub fn parse_offset(&mut self) -> ModalResult<String> {
5915        let value = self.parse_number_value()?;
5916        // TODO(Kexiang): support LIMIT expr
5917        if self.consume_token(&Token::DoubleColon) {
5918            self.expect_keyword(Keyword::BIGINT)?;
5919        }
5920        _ = self.parse_one_of_keywords(&[Keyword::ROW, Keyword::ROWS]);
5921        Ok(value)
5922    }
5923
5924    /// Parse a FETCH clause
5925    pub fn parse_fetch(&mut self) -> ModalResult<Fetch> {
5926        self.expect_one_of_keywords(&[Keyword::FIRST, Keyword::NEXT])?;
5927        let quantity = if self
5928            .parse_one_of_keywords(&[Keyword::ROW, Keyword::ROWS])
5929            .is_some()
5930        {
5931            None
5932        } else {
5933            let quantity = self.parse_number_value()?;
5934            self.expect_one_of_keywords(&[Keyword::ROW, Keyword::ROWS])?;
5935            Some(quantity)
5936        };
5937        let with_ties = if self.parse_keyword(Keyword::ONLY) {
5938            false
5939        } else if self.parse_keywords(&[Keyword::WITH, Keyword::TIES]) {
5940            true
5941        } else {
5942            return self.expected("one of ONLY or WITH TIES");
5943        };
5944        Ok(Fetch {
5945            with_ties,
5946            quantity,
5947        })
5948    }
5949
5950    pub fn parse_values(&mut self) -> ModalResult<Values> {
5951        let values = self.parse_comma_separated(|parser| {
5952            parser.expect_token(&Token::LParen)?;
5953            let exprs = parser.parse_comma_separated(Parser::parse_expr)?;
5954            parser.expect_token(&Token::RParen)?;
5955            Ok(exprs)
5956        })?;
5957        Ok(Values(values))
5958    }
5959
5960    pub fn parse_start_transaction(&mut self) -> ModalResult<Statement> {
5961        self.expect_keyword(Keyword::TRANSACTION)?;
5962        Ok(Statement::StartTransaction {
5963            modes: self.parse_transaction_modes()?,
5964        })
5965    }
5966
5967    pub fn parse_begin(&mut self) -> ModalResult<Statement> {
5968        let _ = self.parse_one_of_keywords(&[Keyword::TRANSACTION, Keyword::WORK]);
5969        Ok(Statement::Begin {
5970            modes: self.parse_transaction_modes()?,
5971        })
5972    }
5973
5974    pub fn parse_transaction_modes(&mut self) -> ModalResult<Vec<TransactionMode>> {
5975        let mut modes = vec![];
5976        let mut required = false;
5977        loop {
5978            let mode = if self.parse_keywords(&[Keyword::ISOLATION, Keyword::LEVEL]) {
5979                let iso_level = if self.parse_keywords(&[Keyword::READ, Keyword::UNCOMMITTED]) {
5980                    TransactionIsolationLevel::ReadUncommitted
5981                } else if self.parse_keywords(&[Keyword::READ, Keyword::COMMITTED]) {
5982                    TransactionIsolationLevel::ReadCommitted
5983                } else if self.parse_keywords(&[Keyword::REPEATABLE, Keyword::READ]) {
5984                    TransactionIsolationLevel::RepeatableRead
5985                } else if self.parse_keyword(Keyword::SERIALIZABLE) {
5986                    TransactionIsolationLevel::Serializable
5987                } else {
5988                    self.expected("isolation level")?
5989                };
5990                TransactionMode::IsolationLevel(iso_level)
5991            } else if self.parse_keywords(&[Keyword::READ, Keyword::ONLY]) {
5992                TransactionMode::AccessMode(TransactionAccessMode::ReadOnly)
5993            } else if self.parse_keywords(&[Keyword::READ, Keyword::WRITE]) {
5994                TransactionMode::AccessMode(TransactionAccessMode::ReadWrite)
5995            } else if required {
5996                self.expected("transaction mode")?
5997            } else {
5998                break;
5999            };
6000            modes.push(mode);
6001            // ANSI requires a comma after each transaction mode, but
6002            // PostgreSQL, for historical reasons, does not. We follow
6003            // PostgreSQL in making the comma optional, since that is strictly
6004            // more general.
6005            required = self.consume_token(&Token::Comma);
6006        }
6007        Ok(modes)
6008    }
6009
6010    pub fn parse_commit(&mut self) -> ModalResult<Statement> {
6011        Ok(Statement::Commit {
6012            chain: self.parse_commit_rollback_chain()?,
6013        })
6014    }
6015
6016    pub fn parse_rollback(&mut self) -> ModalResult<Statement> {
6017        Ok(Statement::Rollback {
6018            chain: self.parse_commit_rollback_chain()?,
6019        })
6020    }
6021
6022    pub fn parse_commit_rollback_chain(&mut self) -> ModalResult<bool> {
6023        let _ = self.parse_one_of_keywords(&[Keyword::TRANSACTION, Keyword::WORK]);
6024        if self.parse_keyword(Keyword::AND) {
6025            let chain = !self.parse_keyword(Keyword::NO);
6026            self.expect_keyword(Keyword::CHAIN)?;
6027            Ok(chain)
6028        } else {
6029            Ok(false)
6030        }
6031    }
6032
6033    fn parse_deallocate(&mut self) -> ModalResult<Statement> {
6034        let prepare = self.parse_keyword(Keyword::PREPARE);
6035        let name = if self.parse_keyword(Keyword::ALL) {
6036            None
6037        } else {
6038            Some(self.parse_identifier()?)
6039        };
6040        Ok(Statement::Deallocate { name, prepare })
6041    }
6042
6043    fn parse_execute(&mut self) -> ModalResult<Statement> {
6044        let name = self.parse_identifier()?;
6045
6046        let mut parameters = vec![];
6047        if self.consume_token(&Token::LParen) {
6048            parameters = self.parse_comma_separated(Parser::parse_expr)?;
6049            self.expect_token(&Token::RParen)?;
6050        }
6051
6052        Ok(Statement::Execute { name, parameters })
6053    }
6054
6055    fn parse_prepare(&mut self) -> ModalResult<Statement> {
6056        let name = self.parse_identifier()?;
6057
6058        let mut data_types = vec![];
6059        if self.consume_token(&Token::LParen) {
6060            data_types = self.parse_comma_separated(Parser::parse_data_type)?;
6061            self.expect_token(&Token::RParen)?;
6062        }
6063
6064        self.expect_keyword(Keyword::AS)?;
6065        let statement = Box::new(self.parse_statement()?);
6066        Ok(Statement::Prepare {
6067            name,
6068            data_types,
6069            statement,
6070        })
6071    }
6072
6073    fn parse_comment(&mut self) -> ModalResult<Statement> {
6074        self.expect_keyword(Keyword::ON)?;
6075        let checkpoint = *self;
6076        let token = self.next_token();
6077
6078        let (object_type, object_name) = match token.token {
6079            Token::Word(w) if w.keyword == Keyword::COLUMN => {
6080                let object_name = self.parse_object_name()?;
6081                (CommentObject::Column, object_name)
6082            }
6083            Token::Word(w) if w.keyword == Keyword::TABLE => {
6084                let object_name = self.parse_object_name()?;
6085                (CommentObject::Table, object_name)
6086            }
6087            _ => self.expected_at(checkpoint, "comment object_type")?,
6088        };
6089
6090        self.expect_keyword(Keyword::IS)?;
6091        let comment = if self.parse_keyword(Keyword::NULL) {
6092            None
6093        } else {
6094            Some(self.parse_literal_string()?)
6095        };
6096        Ok(Statement::Comment {
6097            object_type,
6098            object_name,
6099            comment,
6100        })
6101    }
6102
6103    fn parse_use(&mut self) -> ModalResult<Statement> {
6104        let db_name = self.parse_object_name()?;
6105        Ok(Statement::Use { db_name })
6106    }
6107
6108    /// Parse a named window definition for the WINDOW clause
6109    pub fn parse_named_window(&mut self) -> ModalResult<NamedWindow> {
6110        let name = self.parse_identifier()?;
6111        self.expect_keywords(&[Keyword::AS])?;
6112        self.expect_token(&Token::LParen)?;
6113        let window_spec = self.parse_window_spec()?;
6114        self.expect_token(&Token::RParen)?;
6115        Ok(NamedWindow { name, window_spec })
6116    }
6117
6118    /// Parse a window specification (contents of OVER clause or WINDOW clause)
6119    pub fn parse_window_spec(&mut self) -> ModalResult<WindowSpec> {
6120        let partition_by = if self.parse_keywords(&[Keyword::PARTITION, Keyword::BY]) {
6121            self.parse_comma_separated(Parser::parse_expr)?
6122        } else {
6123            vec![]
6124        };
6125        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
6126            self.parse_comma_separated(Parser::parse_order_by_expr)?
6127        } else {
6128            vec![]
6129        };
6130        let window_frame = if !self.peek_token().eq(&Token::RParen) {
6131            Some(self.parse_window_frame()?)
6132        } else {
6133            None
6134        };
6135        Ok(WindowSpec {
6136            partition_by,
6137            order_by,
6138            window_frame,
6139        })
6140    }
6141}
6142
6143impl Word {
6144    /// Convert a Word to a Identifier, return ParserError when the Word's value is a empty string.
6145    pub fn to_ident(&self) -> ModalResult<Ident> {
6146        if self.value.is_empty() {
6147            parser_err!("zero-length delimited identifier at or near \"{self}\"")
6148        } else {
6149            Ok(Ident {
6150                value: self.value.clone(),
6151                quote_style: self.quote_style,
6152            })
6153        }
6154    }
6155}
6156
6157#[cfg(test)]
6158mod tests {
6159    use super::*;
6160    use crate::test_utils::run_parser_method;
6161
6162    #[test]
6163    fn test_parse_integer_min() {
6164        let min_bigint = "-9223372036854775808";
6165        run_parser_method(min_bigint, |parser| {
6166            assert_eq!(
6167                parser.parse_expr().unwrap(),
6168                Expr::Value(Value::Number("-9223372036854775808".to_owned()))
6169            )
6170        });
6171    }
6172}