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            Ok(Some(SourceWatermark { column, expr }))
2912        } else {
2913            Ok(None)
2914        }
2915    }
2916
2917    pub fn parse_optional_table_constraint(&mut self) -> ModalResult<Option<TableConstraint>> {
2918        let name = if self.parse_keyword(Keyword::CONSTRAINT) {
2919            Some(self.parse_identifier_non_reserved()?)
2920        } else {
2921            None
2922        };
2923        let checkpoint = *self;
2924        let token = self.next_token();
2925        match token.token {
2926            Token::Word(w) if w.keyword == Keyword::PRIMARY || w.keyword == Keyword::UNIQUE => {
2927                let is_primary = w.keyword == Keyword::PRIMARY;
2928                if is_primary {
2929                    self.expect_keyword(Keyword::KEY)?;
2930                }
2931                let columns = self.parse_parenthesized_column_list(Mandatory)?;
2932                Ok(Some(TableConstraint::Unique {
2933                    name,
2934                    columns,
2935                    is_primary,
2936                }))
2937            }
2938            Token::Word(w) if w.keyword == Keyword::FOREIGN => {
2939                self.expect_keyword(Keyword::KEY)?;
2940                let columns = self.parse_parenthesized_column_list(Mandatory)?;
2941                self.expect_keyword(Keyword::REFERENCES)?;
2942                let foreign_table = self.parse_object_name()?;
2943                let referred_columns = self.parse_parenthesized_column_list(Mandatory)?;
2944                let mut on_delete = None;
2945                let mut on_update = None;
2946                loop {
2947                    if on_delete.is_none() && self.parse_keywords(&[Keyword::ON, Keyword::DELETE]) {
2948                        on_delete = Some(self.parse_referential_action()?);
2949                    } else if on_update.is_none()
2950                        && self.parse_keywords(&[Keyword::ON, Keyword::UPDATE])
2951                    {
2952                        on_update = Some(self.parse_referential_action()?);
2953                    } else {
2954                        break;
2955                    }
2956                }
2957                Ok(Some(TableConstraint::ForeignKey {
2958                    name,
2959                    columns,
2960                    foreign_table,
2961                    referred_columns,
2962                    on_delete,
2963                    on_update,
2964                }))
2965            }
2966            Token::Word(w) if w.keyword == Keyword::CHECK => {
2967                self.expect_token(&Token::LParen)?;
2968                let expr = Box::new(self.parse_expr()?);
2969                self.expect_token(&Token::RParen)?;
2970                Ok(Some(TableConstraint::Check { name, expr }))
2971            }
2972            _ => {
2973                *self = checkpoint;
2974                if name.is_some() {
2975                    self.expected("PRIMARY, UNIQUE, FOREIGN, or CHECK")
2976                } else {
2977                    Ok(None)
2978                }
2979            }
2980        }
2981    }
2982
2983    pub fn parse_options_with_preceding_keyword(
2984        &mut self,
2985        keyword: Keyword,
2986    ) -> ModalResult<Vec<SqlOption>> {
2987        if self.parse_keyword(keyword) {
2988            self.expect_token(&Token::LParen)?;
2989            self.parse_options_inner()
2990        } else {
2991            Ok(vec![])
2992        }
2993    }
2994
2995    pub fn parse_options(&mut self) -> ModalResult<Vec<SqlOption>> {
2996        if self.peek_token() == Token::LParen {
2997            self.next_token();
2998            self.parse_options_inner()
2999        } else {
3000            Ok(vec![])
3001        }
3002    }
3003
3004    // has parsed a LParen
3005    pub fn parse_options_inner(&mut self) -> ModalResult<Vec<SqlOption>> {
3006        let mut values = vec![];
3007        loop {
3008            values.push(Parser::parse_sql_option(self)?);
3009            let comma = self.consume_token(&Token::Comma);
3010            if self.consume_token(&Token::RParen) {
3011                // allow a trailing comma, even though it's not in standard
3012                break;
3013            } else if !comma {
3014                return self.expected("',' or ')' after option definition");
3015            }
3016        }
3017        Ok(values)
3018    }
3019
3020    pub fn parse_sql_option(&mut self) -> ModalResult<SqlOption> {
3021        const CONNECTION_REF_KEY: &str = "connection";
3022        const BACKFILL_ORDER: &str = "backfill_order";
3023
3024        let name = self.parse_object_name()?;
3025        self.expect_token(&Token::Eq)?;
3026        let value = {
3027            if name.real_value().eq_ignore_ascii_case(CONNECTION_REF_KEY) {
3028                let connection_name = self.parse_object_name()?;
3029                // tolerate previous buggy Display that outputs `connection = connection foo`
3030                let connection_name = match connection_name.0.as_slice() {
3031                    [ident] if ident.real_value() == CONNECTION_REF_KEY => {
3032                        self.parse_object_name()?
3033                    }
3034                    _ => connection_name,
3035                };
3036                SqlOptionValue::ConnectionRef(ConnectionRefValue { connection_name })
3037            } else if name.real_value().eq_ignore_ascii_case(BACKFILL_ORDER) {
3038                let order = self.parse_backfill_order_strategy()?;
3039                SqlOptionValue::BackfillOrder(order)
3040            } else {
3041                self.parse_value_and_obj_ref::<false>()?
3042            }
3043        };
3044        Ok(SqlOption { name, value })
3045    }
3046
3047    // <config_param> { TO | = } { <value> | DEFAULT }
3048    // <config_param> is not a keyword, but an identifier
3049    pub fn parse_config_param(&mut self) -> ModalResult<ConfigParam> {
3050        let param = self.parse_identifier()?;
3051        if !self.consume_token(&Token::Eq) && !self.parse_keyword(Keyword::TO) {
3052            return self.expected("'=' or 'TO' after config parameter");
3053        }
3054        let value = self.parse_set_variable()?;
3055        Ok(ConfigParam { param, value })
3056    }
3057
3058    pub fn parse_since(&mut self) -> ModalResult<Since> {
3059        if self.parse_keyword(Keyword::SINCE) {
3060            let checkpoint = *self;
3061            let token = self.next_token();
3062            match token.token {
3063                Token::Word(w) => {
3064                    let ident = w.to_ident()?;
3065                    // Backward compatibility for now.
3066                    if ident.real_value() == "proctime" || ident.real_value() == "now" {
3067                        self.expect_token(&Token::LParen)?;
3068                        self.expect_token(&Token::RParen)?;
3069                        Ok(Since::ProcessTime)
3070                    } else if ident.real_value() == "begin" {
3071                        self.expect_token(&Token::LParen)?;
3072                        self.expect_token(&Token::RParen)?;
3073                        Ok(Since::Begin)
3074                    } else {
3075                        parser_err!(
3076                            "Expected proctime(), begin() or now(), found: {}",
3077                            ident.real_value()
3078                        )
3079                    }
3080                }
3081                Token::Number(s) => {
3082                    let num = s
3083                        .parse::<u64>()
3084                        .map_err(|e| StrError(format!("Could not parse '{}' as u64: {}", s, e)))?;
3085                    Ok(Since::TimestampMsNum(num))
3086                }
3087                _ => self.expected_at(checkpoint, "proctime(), begin() , now(), Number"),
3088            }
3089        } else if self.parse_word("FULL") {
3090            Ok(Since::Full)
3091        } else {
3092            Ok(Since::ProcessTime)
3093        }
3094    }
3095
3096    pub fn parse_emit_mode(&mut self) -> ModalResult<Option<EmitMode>> {
3097        if self.parse_keyword(Keyword::EMIT) {
3098            match self.parse_one_of_keywords(&[Keyword::IMMEDIATELY, Keyword::ON]) {
3099                Some(Keyword::IMMEDIATELY) => Ok(Some(EmitMode::Immediately)),
3100                Some(Keyword::ON) => {
3101                    self.expect_keywords(&[Keyword::WINDOW, Keyword::CLOSE])?;
3102                    Ok(Some(EmitMode::OnWindowClose))
3103                }
3104                Some(_) => unreachable!(),
3105                None => self.expected("IMMEDIATELY or ON WINDOW CLOSE after EMIT"),
3106            }
3107        } else {
3108            Ok(None)
3109        }
3110    }
3111
3112    pub fn parse_alter(&mut self) -> ModalResult<Statement> {
3113        if self.parse_keyword(Keyword::DATABASE) {
3114            self.parse_alter_database()
3115        } else if self.parse_keyword(Keyword::SCHEMA) {
3116            self.parse_alter_schema()
3117        } else if self.parse_keyword(Keyword::TABLE) {
3118            self.parse_alter_table()
3119        } else if self.parse_keyword(Keyword::INDEX) {
3120            self.parse_alter_index()
3121        } else if self.parse_keyword(Keyword::VIEW) {
3122            self.parse_alter_view(false)
3123        } else if self.parse_keywords(&[Keyword::MATERIALIZED, Keyword::VIEW]) {
3124            self.parse_alter_view(true)
3125        } else if self.parse_keyword(Keyword::SINK) {
3126            self.parse_alter_sink()
3127        } else if self.parse_keyword(Keyword::SOURCE) {
3128            self.parse_alter_source()
3129        } else if self.parse_keyword(Keyword::FUNCTION) {
3130            self.parse_alter_function()
3131        } else if self.parse_keyword(Keyword::CONNECTION) {
3132            self.parse_alter_connection()
3133        } else if self.parse_keyword(Keyword::USER) {
3134            self.parse_alter_user()
3135        } else if self.parse_keyword(Keyword::SYSTEM) {
3136            self.parse_alter_system()
3137        } else if self.parse_keyword(Keyword::SUBSCRIPTION) {
3138            self.parse_alter_subscription()
3139        } else if self.parse_keyword(Keyword::SECRET) {
3140            self.parse_alter_secret()
3141        } else if self.parse_word("FRAGMENT") {
3142            self.parse_alter_fragment()
3143        } else if self.parse_keywords(&[Keyword::DEFAULT, Keyword::PRIVILEGES]) {
3144            self.parse_alter_default_privileges()
3145        } else {
3146            self.expected(
3147                "DATABASE, FRAGMENT, SCHEMA, TABLE, INDEX, MATERIALIZED, VIEW, SINK, SUBSCRIPTION, SOURCE, FUNCTION, USER, SECRET or SYSTEM after ALTER"
3148            )
3149        }
3150    }
3151
3152    pub fn parse_alter_database(&mut self) -> ModalResult<Statement> {
3153        let database_name = self.parse_object_name()?;
3154        let operation = if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
3155            let owner_name: Ident = self.parse_identifier()?;
3156            AlterDatabaseOperation::ChangeOwner {
3157                new_owner_name: owner_name,
3158            }
3159        } else if self.parse_keyword(Keyword::RENAME) {
3160            if self.parse_keyword(Keyword::TO) {
3161                let database_name = self.parse_object_name()?;
3162                AlterDatabaseOperation::RenameDatabase { database_name }
3163            } else {
3164                return self.expected("TO after RENAME");
3165            }
3166        } else if self.parse_keyword(Keyword::SET) {
3167            // check will be delayed to frontend
3168            AlterDatabaseOperation::SetParam(self.parse_config_param()?)
3169        } else {
3170            return self.expected("RENAME, OWNER TO, OR SET after ALTER DATABASE");
3171        };
3172
3173        Ok(Statement::AlterDatabase {
3174            name: database_name,
3175            operation,
3176        })
3177    }
3178
3179    pub fn parse_alter_schema(&mut self) -> ModalResult<Statement> {
3180        let schema_name = self.parse_object_name()?;
3181        let operation = if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
3182            let owner_name: Ident = self.parse_identifier()?;
3183            AlterSchemaOperation::ChangeOwner {
3184                new_owner_name: owner_name,
3185            }
3186        } else if self.parse_keyword(Keyword::RENAME) {
3187            self.expect_keyword(Keyword::TO)?;
3188            let schema_name = self.parse_object_name()?;
3189            AlterSchemaOperation::RenameSchema { schema_name }
3190        } else if self.parse_keywords(&[Keyword::SWAP, Keyword::WITH]) {
3191            let target_schema = self.parse_object_name()?;
3192            AlterSchemaOperation::SwapRenameSchema { target_schema }
3193        } else {
3194            return self.expected("RENAME, OWNER TO, OR SWAP WITH after ALTER SCHEMA");
3195        };
3196
3197        Ok(Statement::AlterSchema {
3198            name: schema_name,
3199            operation,
3200        })
3201    }
3202
3203    pub fn parse_alter_user(&mut self) -> ModalResult<Statement> {
3204        Ok(Statement::AlterUser(AlterUserStatement::parse_to(self)?))
3205    }
3206
3207    pub fn parse_alter_table(&mut self) -> ModalResult<Statement> {
3208        let _ = self.parse_keyword(Keyword::ONLY);
3209        let table_name = self.parse_object_name()?;
3210        let operation = if self.parse_keyword(Keyword::ADD) {
3211            if let Some(constraint) = self.parse_optional_table_constraint()? {
3212                AlterTableOperation::AddConstraint(constraint)
3213            } else {
3214                let _ = self.parse_keyword(Keyword::COLUMN);
3215                let _if_not_exists =
3216                    self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
3217                let column_def = self.parse_column_def()?;
3218                AlterTableOperation::AddColumn { column_def }
3219            }
3220        } else if self.parse_keywords(&[Keyword::DROP, Keyword::CONNECTOR]) {
3221            AlterTableOperation::DropConnector
3222        } else if self.parse_keyword(Keyword::RENAME) {
3223            if self.parse_keyword(Keyword::CONSTRAINT) {
3224                let old_name = self.parse_identifier_non_reserved()?;
3225                self.expect_keyword(Keyword::TO)?;
3226                let new_name = self.parse_identifier_non_reserved()?;
3227                AlterTableOperation::RenameConstraint { old_name, new_name }
3228            } else if self.parse_keyword(Keyword::TO) {
3229                let table_name = self.parse_object_name()?;
3230                AlterTableOperation::RenameTable { table_name }
3231            } else {
3232                let _ = self.parse_keyword(Keyword::COLUMN);
3233                let old_column_name = self.parse_identifier_non_reserved()?;
3234                self.expect_keyword(Keyword::TO)?;
3235                let new_column_name = self.parse_identifier_non_reserved()?;
3236                AlterTableOperation::RenameColumn {
3237                    old_column_name,
3238                    new_column_name,
3239                }
3240            }
3241        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
3242            let owner_name: Ident = self.parse_identifier()?;
3243            AlterTableOperation::ChangeOwner {
3244                new_owner_name: owner_name,
3245            }
3246        } else if self.parse_keyword(Keyword::SET) {
3247            if self.parse_keyword(Keyword::SCHEMA) {
3248                let schema_name = self.parse_object_name()?;
3249                AlterTableOperation::SetSchema {
3250                    new_schema_name: schema_name,
3251                }
3252            } else if self.parse_keyword(Keyword::PARALLELISM) {
3253                if self.expect_keyword(Keyword::TO).is_err()
3254                    && self.expect_token(&Token::Eq).is_err()
3255                {
3256                    return self.expected("TO or = after ALTER TABLE SET PARALLELISM");
3257                }
3258
3259                let value = self.parse_set_variable()?;
3260
3261                let deferred = self.parse_keyword(Keyword::DEFERRED);
3262
3263                AlterTableOperation::SetParallelism {
3264                    parallelism: value,
3265                    deferred,
3266                }
3267            } else if let Some(rate_limit) = self.parse_alter_source_rate_limit(true)? {
3268                AlterTableOperation::SetSourceRateLimit { rate_limit }
3269            } else if let Some(rate_limit) = self.parse_alter_backfill_rate_limit()? {
3270                AlterTableOperation::SetBackfillRateLimit { rate_limit }
3271            } else if let Some(rate_limit) = self.parse_alter_dml_rate_limit()? {
3272                AlterTableOperation::SetDmlRateLimit { rate_limit }
3273            } else if self.parse_keyword(Keyword::CONFIG) {
3274                let entries = self.parse_options()?;
3275                AlterTableOperation::SetConfig { entries }
3276            } else {
3277                return self.expected(
3278                    "SCHEMA/PARALLELISM/SOURCE_RATE_LIMIT/DML_RATE_LIMIT/CONFIG after SET",
3279                );
3280            }
3281        } else if self.parse_keyword(Keyword::RESET) {
3282            if self.parse_keyword(Keyword::CONFIG) {
3283                let keys = self.parse_parenthesized_object_name_list()?;
3284                AlterTableOperation::ResetConfig { keys }
3285            } else {
3286                return self.expected("CONFIG after RESET");
3287            }
3288        } else if self.parse_keyword(Keyword::DROP) {
3289            let _ = self.parse_keyword(Keyword::COLUMN);
3290            let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
3291            let column_name = self.parse_identifier_non_reserved()?;
3292            let cascade = self.parse_keyword(Keyword::CASCADE);
3293            AlterTableOperation::DropColumn {
3294                column_name,
3295                if_exists,
3296                cascade,
3297            }
3298        } else if self.parse_keyword(Keyword::ALTER) {
3299            let _ = self.parse_keyword(Keyword::COLUMN);
3300            let column_name = self.parse_identifier_non_reserved()?;
3301
3302            let op = if self.parse_keywords(&[Keyword::SET, Keyword::NOT, Keyword::NULL]) {
3303                AlterColumnOperation::SetNotNull {}
3304            } else if self.parse_keywords(&[Keyword::DROP, Keyword::NOT, Keyword::NULL]) {
3305                AlterColumnOperation::DropNotNull {}
3306            } else if self.parse_keywords(&[Keyword::SET, Keyword::DEFAULT]) {
3307                AlterColumnOperation::SetDefault {
3308                    value: self.parse_expr()?,
3309                }
3310            } else if self.parse_keywords(&[Keyword::DROP, Keyword::DEFAULT]) {
3311                AlterColumnOperation::DropDefault {}
3312            } else if self.parse_keywords(&[Keyword::SET, Keyword::DATA, Keyword::TYPE])
3313                || (self.parse_keyword(Keyword::TYPE))
3314            {
3315                let data_type = self.parse_data_type()?;
3316                let using = if self.parse_keyword(Keyword::USING) {
3317                    Some(self.parse_expr()?)
3318                } else {
3319                    None
3320                };
3321                AlterColumnOperation::SetDataType { data_type, using }
3322            } else {
3323                return self
3324                    .expected("SET/DROP NOT NULL, SET DEFAULT, SET DATA TYPE after ALTER COLUMN");
3325            };
3326            AlterTableOperation::AlterColumn { column_name, op }
3327        } else if self.parse_keywords(&[Keyword::REFRESH, Keyword::SCHEMA]) {
3328            AlterTableOperation::RefreshSchema
3329        } else if self.parse_keywords(&[Keyword::SWAP, Keyword::WITH]) {
3330            let target_table = self.parse_object_name()?;
3331            AlterTableOperation::SwapRenameTable { target_table }
3332        } else if self.parse_keyword(Keyword::CONNECTOR) {
3333            let with_options = self.parse_with_properties()?;
3334            AlterTableOperation::AlterConnectorProps {
3335                alter_props: with_options,
3336            }
3337        } else {
3338            return self.expected(
3339                "ADD or RENAME or OWNER TO or SET or RESET or DROP or SWAP or CONNECTOR after ALTER TABLE",
3340            );
3341        };
3342        Ok(Statement::AlterTable {
3343            name: table_name,
3344            operation,
3345        })
3346    }
3347
3348    /// BACKFILL_RATE_LIMIT = default | NUMBER
3349    /// BACKFILL_RATE_LIMIT TO default | NUMBER
3350    pub fn parse_alter_backfill_rate_limit(&mut self) -> ModalResult<Option<i32>> {
3351        if !self.parse_word("BACKFILL_RATE_LIMIT") {
3352            return Ok(None);
3353        }
3354        if self.expect_keyword(Keyword::TO).is_err() && self.expect_token(&Token::Eq).is_err() {
3355            return self.expected("TO or = after ALTER TABLE SET BACKFILL_RATE_LIMIT");
3356        }
3357        let rate_limit = if self.parse_keyword(Keyword::DEFAULT) {
3358            -1
3359        } else {
3360            let s = self.parse_number_value()?;
3361            if let Ok(n) = s.parse::<i32>() {
3362                n
3363            } else {
3364                return self.expected("number or DEFAULT");
3365            }
3366        };
3367        Ok(Some(rate_limit))
3368    }
3369
3370    /// DML_RATE_LIMIT = default | NUMBER
3371    /// DML_RATE_LIMIT TO default | NUMBER
3372    pub fn parse_alter_dml_rate_limit(&mut self) -> ModalResult<Option<i32>> {
3373        if !self.parse_word("DML_RATE_LIMIT") {
3374            return Ok(None);
3375        }
3376        if self.expect_keyword(Keyword::TO).is_err() && self.expect_token(&Token::Eq).is_err() {
3377            return self.expected("TO or = after ALTER TABLE SET DML_RATE_LIMIT");
3378        }
3379        let rate_limit = if self.parse_keyword(Keyword::DEFAULT) {
3380            -1
3381        } else {
3382            let s = self.parse_number_value()?;
3383            if let Ok(n) = s.parse::<i32>() {
3384                n
3385            } else {
3386                return self.expected("number or DEFAULT");
3387            }
3388        };
3389        Ok(Some(rate_limit))
3390    }
3391
3392    /// SOURCE_RATE_LIMIT = default | NUMBER
3393    /// SOURCE_RATE_LIMIT TO default | NUMBER
3394    pub fn parse_alter_source_rate_limit(&mut self, is_table: bool) -> ModalResult<Option<i32>> {
3395        if !self.parse_word("SOURCE_RATE_LIMIT") {
3396            return Ok(None);
3397        }
3398        if self.expect_keyword(Keyword::TO).is_err() && self.expect_token(&Token::Eq).is_err() {
3399            let ddl = if is_table { "TABLE" } else { "SOURCE" };
3400            return self.expected(&format!("TO or = after ALTER {ddl} SET SOURCE_RATE_LIMIT"));
3401        }
3402        let rate_limit = if self.parse_keyword(Keyword::DEFAULT) {
3403            -1
3404        } else {
3405            let s = self.parse_number_value()?;
3406            if let Ok(n) = s.parse::<i32>() {
3407                n
3408            } else {
3409                return self.expected("number or DEFAULT");
3410            }
3411        };
3412        Ok(Some(rate_limit))
3413    }
3414
3415    pub fn parse_alter_index(&mut self) -> ModalResult<Statement> {
3416        let index_name = self.parse_object_name()?;
3417        let operation = if self.parse_keyword(Keyword::RENAME) {
3418            if self.parse_keyword(Keyword::TO) {
3419                let index_name = self.parse_object_name()?;
3420                AlterIndexOperation::RenameIndex { index_name }
3421            } else {
3422                return self.expected("TO after RENAME");
3423            }
3424        } else if self.parse_keyword(Keyword::SET) {
3425            if self.parse_keyword(Keyword::PARALLELISM) {
3426                if self.expect_keyword(Keyword::TO).is_err()
3427                    && self.expect_token(&Token::Eq).is_err()
3428                {
3429                    return self.expected("TO or = after ALTER TABLE SET PARALLELISM");
3430                }
3431
3432                let value = self.parse_set_variable()?;
3433
3434                let deferred = self.parse_keyword(Keyword::DEFERRED);
3435
3436                AlterIndexOperation::SetParallelism {
3437                    parallelism: value,
3438                    deferred,
3439                }
3440            } else if self.parse_keyword(Keyword::CONFIG) {
3441                let entries = self.parse_options()?;
3442                AlterIndexOperation::SetConfig { entries }
3443            } else {
3444                return self.expected("PARALLELISM or CONFIG after SET");
3445            }
3446        } else if self.parse_keyword(Keyword::RESET) {
3447            if self.parse_keyword(Keyword::CONFIG) {
3448                let keys = self.parse_parenthesized_object_name_list()?;
3449                AlterIndexOperation::ResetConfig { keys }
3450            } else {
3451                return self.expected("CONFIG after RESET");
3452            }
3453        } else {
3454            return self.expected("RENAME, SET, or RESET after ALTER INDEX");
3455        };
3456
3457        Ok(Statement::AlterIndex {
3458            name: index_name,
3459            operation,
3460        })
3461    }
3462
3463    pub fn parse_alter_view(&mut self, materialized: bool) -> ModalResult<Statement> {
3464        let view_name = self.parse_object_name()?;
3465        let operation = if self.parse_keyword(Keyword::AS) {
3466            let query = Box::new(self.parse_query()?);
3467            AlterViewOperation::AsQuery { query }
3468        } else if self.parse_keyword(Keyword::RENAME) {
3469            if self.parse_keyword(Keyword::TO) {
3470                let view_name = self.parse_object_name()?;
3471                AlterViewOperation::RenameView { view_name }
3472            } else {
3473                return self.expected("TO after RENAME");
3474            }
3475        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
3476            let owner_name: Ident = self.parse_identifier()?;
3477            AlterViewOperation::ChangeOwner {
3478                new_owner_name: owner_name,
3479            }
3480        } else if self.parse_keywords(&[Keyword::SWAP, Keyword::WITH]) {
3481            let target_view = self.parse_object_name()?;
3482            AlterViewOperation::SwapRenameView { target_view }
3483        } else if self.parse_keyword(Keyword::SET) {
3484            if self.parse_keyword(Keyword::SCHEMA) {
3485                let schema_name = self.parse_object_name()?;
3486                AlterViewOperation::SetSchema {
3487                    new_schema_name: schema_name,
3488                }
3489            } else if self.parse_word("STREAMING_ENABLE_UNALIGNED_JOIN") {
3490                if self.expect_keyword(Keyword::TO).is_err()
3491                    && self.expect_token(&Token::Eq).is_err()
3492                {
3493                    return self
3494                        .expected("TO or = after ALTER TABLE SET STREAMING_ENABLE_UNALIGNED_JOIN");
3495                }
3496                let value = self.parse_boolean()?;
3497                AlterViewOperation::SetStreamingEnableUnalignedJoin { enable: value }
3498            } else if self.parse_keyword(Keyword::PARALLELISM) && materialized {
3499                if self.expect_keyword(Keyword::TO).is_err()
3500                    && self.expect_token(&Token::Eq).is_err()
3501                {
3502                    return self.expected("TO or = after ALTER TABLE SET PARALLELISM");
3503                }
3504
3505                let value = self.parse_set_variable()?;
3506
3507                let deferred = self.parse_keyword(Keyword::DEFERRED);
3508
3509                AlterViewOperation::SetParallelism {
3510                    parallelism: value,
3511                    deferred,
3512                }
3513            } else if self.parse_keyword(Keyword::RESOURCE_GROUP) && materialized {
3514                if self.expect_keyword(Keyword::TO).is_err()
3515                    && self.expect_token(&Token::Eq).is_err()
3516                {
3517                    return self
3518                        .expected("TO or = after ALTER MATERIALIZED VIEW SET RESOURCE_GROUP");
3519                }
3520                let value = self.parse_set_variable()?;
3521                let deferred = self.parse_keyword(Keyword::DEFERRED);
3522
3523                AlterViewOperation::SetResourceGroup {
3524                    resource_group: Some(value),
3525                    deferred,
3526                }
3527            } else if materialized
3528                && let Some(rate_limit) = self.parse_alter_backfill_rate_limit()?
3529            {
3530                AlterViewOperation::SetBackfillRateLimit { rate_limit }
3531            } else if self.parse_keyword(Keyword::CONFIG) && materialized {
3532                let entries = self.parse_options()?;
3533                AlterViewOperation::SetConfig { entries }
3534            } else {
3535                return self.expected("SCHEMA/PARALLELISM/BACKFILL_RATE_LIMIT/CONFIG after SET");
3536            }
3537        } else if self.parse_keyword(Keyword::RESET) {
3538            if self.parse_keyword(Keyword::RESOURCE_GROUP) && materialized {
3539                let deferred = self.parse_keyword(Keyword::DEFERRED);
3540
3541                AlterViewOperation::SetResourceGroup {
3542                    resource_group: None,
3543                    deferred,
3544                }
3545            } else if self.parse_keyword(Keyword::CONFIG) && materialized {
3546                let keys = self.parse_parenthesized_object_name_list()?;
3547                AlterViewOperation::ResetConfig { keys }
3548            } else {
3549                return self.expected("RESOURCE_GROUP or CONFIG after RESET");
3550            }
3551        } else {
3552            return self.expected(&format!(
3553                "AS, RENAME, OWNER TO, SET, or SWAP after ALTER {}VIEW",
3554                if materialized { "MATERIALIZED " } else { "" }
3555            ));
3556        };
3557
3558        Ok(Statement::AlterView {
3559            materialized,
3560            name: view_name,
3561            operation,
3562        })
3563    }
3564
3565    /// SINK_RATE_LIMIT = default | NUMBER
3566    /// SINK_RATE_LIMIT TO default | NUMBER
3567    pub fn parse_alter_sink_rate_limit(&mut self) -> ModalResult<Option<i32>> {
3568        if !self.parse_word("SINK_RATE_LIMIT") {
3569            return Ok(None);
3570        }
3571        if self.expect_keyword(Keyword::TO).is_err() && self.expect_token(&Token::Eq).is_err() {
3572            return self.expected("TO or = after ALTER SINK SET SINK_RATE_LIMIT");
3573        }
3574        let rate_limit = if self.parse_keyword(Keyword::DEFAULT) {
3575            -1
3576        } else {
3577            let s = self.parse_number_value()?;
3578            if let Ok(n) = s.parse::<i32>() {
3579                n
3580            } else {
3581                return self.expected("number or DEFAULT");
3582            }
3583        };
3584        Ok(Some(rate_limit))
3585    }
3586
3587    pub fn parse_alter_sink(&mut self) -> ModalResult<Statement> {
3588        let sink_name = self.parse_object_name()?;
3589        let operation = if self.parse_keyword(Keyword::RENAME) {
3590            if self.parse_keyword(Keyword::TO) {
3591                let sink_name = self.parse_object_name()?;
3592                AlterSinkOperation::RenameSink { sink_name }
3593            } else {
3594                return self.expected("TO after RENAME");
3595            }
3596        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
3597            let owner_name: Ident = self.parse_identifier()?;
3598            AlterSinkOperation::ChangeOwner {
3599                new_owner_name: owner_name,
3600            }
3601        } else if self.parse_keyword(Keyword::SET) {
3602            if self.parse_keyword(Keyword::SCHEMA) {
3603                let schema_name = self.parse_object_name()?;
3604                AlterSinkOperation::SetSchema {
3605                    new_schema_name: schema_name,
3606                }
3607            } else if self.parse_word("STREAMING_ENABLE_UNALIGNED_JOIN") {
3608                self.expect_keyword(Keyword::TO)?;
3609                let value = self.parse_boolean()?;
3610                AlterSinkOperation::SetStreamingEnableUnalignedJoin { enable: value }
3611            } else if self.parse_keyword(Keyword::PARALLELISM) {
3612                if self.expect_keyword(Keyword::TO).is_err()
3613                    && self.expect_token(&Token::Eq).is_err()
3614                {
3615                    return self.expected("TO or = after ALTER TABLE SET PARALLELISM");
3616                }
3617
3618                let value = self.parse_set_variable()?;
3619                let deferred = self.parse_keyword(Keyword::DEFERRED);
3620
3621                AlterSinkOperation::SetParallelism {
3622                    parallelism: value,
3623                    deferred,
3624                }
3625            } else if let Some(rate_limit) = self.parse_alter_sink_rate_limit()? {
3626                AlterSinkOperation::SetSinkRateLimit { rate_limit }
3627            } else if self.parse_keyword(Keyword::CONFIG) {
3628                let entries = self.parse_options()?;
3629                AlterSinkOperation::SetConfig { entries }
3630            } else {
3631                return self.expected(
3632                    "SCHEMA/PARALLELISM/SINK_RATE_LIMIT/STREAMING_ENABLE_UNALIGNED_JOIN/CONFIG after SET",
3633                );
3634            }
3635        } else if self.parse_keyword(Keyword::RESET) {
3636            if self.parse_keyword(Keyword::CONFIG) {
3637                let keys = self.parse_parenthesized_object_name_list()?;
3638                AlterSinkOperation::ResetConfig { keys }
3639            } else {
3640                return self.expected("CONFIG after RESET");
3641            }
3642        } else if self.parse_keywords(&[Keyword::SWAP, Keyword::WITH]) {
3643            let target_sink = self.parse_object_name()?;
3644            AlterSinkOperation::SwapRenameSink { target_sink }
3645        } else if self.parse_keyword(Keyword::CONNECTOR) {
3646            let changed_props = self.parse_with_properties()?;
3647            AlterSinkOperation::AlterConnectorProps {
3648                alter_props: changed_props,
3649            }
3650        } else {
3651            return self
3652                .expected("RENAME or OWNER TO or SET or RESET or CONNECTOR WITH after ALTER SINK");
3653        };
3654
3655        Ok(Statement::AlterSink {
3656            name: sink_name,
3657            operation,
3658        })
3659    }
3660
3661    pub fn parse_alter_subscription(&mut self) -> ModalResult<Statement> {
3662        let subscription_name = self.parse_object_name()?;
3663        let operation = if self.parse_keyword(Keyword::RENAME) {
3664            if self.parse_keyword(Keyword::TO) {
3665                let subscription_name = self.parse_object_name()?;
3666                AlterSubscriptionOperation::RenameSubscription { subscription_name }
3667            } else {
3668                return self.expected("TO after RENAME");
3669            }
3670        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
3671            let owner_name: Ident = self.parse_identifier()?;
3672            AlterSubscriptionOperation::ChangeOwner {
3673                new_owner_name: owner_name,
3674            }
3675        } else if self.parse_keyword(Keyword::SET) {
3676            if self.parse_keyword(Keyword::SCHEMA) {
3677                let schema_name = self.parse_object_name()?;
3678                AlterSubscriptionOperation::SetSchema {
3679                    new_schema_name: schema_name,
3680                }
3681            } else {
3682                return self.expected("SCHEMA after SET");
3683            }
3684        } else if self.parse_keywords(&[Keyword::SWAP, Keyword::WITH]) {
3685            let target_subscription = self.parse_object_name()?;
3686            AlterSubscriptionOperation::SwapRenameSubscription {
3687                target_subscription,
3688            }
3689        } else {
3690            return self.expected("RENAME or OWNER TO or SET or SWAP after ALTER SUBSCRIPTION");
3691        };
3692
3693        Ok(Statement::AlterSubscription {
3694            name: subscription_name,
3695            operation,
3696        })
3697    }
3698
3699    pub fn parse_alter_source(&mut self) -> ModalResult<Statement> {
3700        let source_name = self.parse_object_name()?;
3701        let operation = if self.parse_keyword(Keyword::RENAME) {
3702            if self.parse_keyword(Keyword::TO) {
3703                let source_name = self.parse_object_name()?;
3704                AlterSourceOperation::RenameSource { source_name }
3705            } else {
3706                return self.expected("TO after RENAME");
3707            }
3708        } else if self.parse_keyword(Keyword::ADD) {
3709            let _ = self.parse_keyword(Keyword::COLUMN);
3710            let _if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
3711            let column_def = self.parse_column_def()?;
3712            AlterSourceOperation::AddColumn { column_def }
3713        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
3714            let owner_name: Ident = self.parse_identifier()?;
3715            AlterSourceOperation::ChangeOwner {
3716                new_owner_name: owner_name,
3717            }
3718        } else if self.parse_keyword(Keyword::SET) {
3719            if self.parse_keyword(Keyword::SCHEMA) {
3720                let schema_name = self.parse_object_name()?;
3721                AlterSourceOperation::SetSchema {
3722                    new_schema_name: schema_name,
3723                }
3724            } else if let Some(rate_limit) = self.parse_alter_source_rate_limit(false)? {
3725                AlterSourceOperation::SetSourceRateLimit { rate_limit }
3726            } else if self.parse_keyword(Keyword::PARALLELISM) {
3727                if self.expect_keyword(Keyword::TO).is_err()
3728                    && self.expect_token(&Token::Eq).is_err()
3729                {
3730                    return self.expected("TO or = after ALTER SOURCE SET PARALLELISM");
3731                }
3732
3733                let value = self.parse_set_variable()?;
3734                let deferred = self.parse_keyword(Keyword::DEFERRED);
3735
3736                AlterSourceOperation::SetParallelism {
3737                    parallelism: value,
3738                    deferred,
3739                }
3740            } else if self.parse_keyword(Keyword::CONFIG) {
3741                let entries = self.parse_options()?;
3742                AlterSourceOperation::SetConfig { entries }
3743            } else {
3744                return self.expected("SCHEMA, SOURCE_RATE_LIMIT, PARALLELISM or CONFIG after SET");
3745            }
3746        } else if self.parse_keyword(Keyword::RESET) {
3747            if self.parse_keyword(Keyword::CONFIG) {
3748                let keys = self.parse_parenthesized_object_name_list()?;
3749                AlterSourceOperation::ResetConfig { keys }
3750            } else {
3751                return self.expected("CONFIG after RESET");
3752            }
3753        } else if self.peek_nth_any_of_keywords(0, &[Keyword::FORMAT]) {
3754            let format_encode = self.parse_schema()?.unwrap();
3755            if format_encode.key_encode.is_some() {
3756                parser_err!("key encode clause is not supported in source schema");
3757            }
3758            AlterSourceOperation::FormatEncode { format_encode }
3759        } else if self.parse_keywords(&[Keyword::REFRESH, Keyword::SCHEMA]) {
3760            AlterSourceOperation::RefreshSchema
3761        } else if self.parse_keywords(&[Keyword::SWAP, Keyword::WITH]) {
3762            let target_source = self.parse_object_name()?;
3763            AlterSourceOperation::SwapRenameSource { target_source }
3764        } else if self.parse_keyword(Keyword::CONNECTOR) {
3765            let with_options = self.parse_with_properties()?;
3766            AlterSourceOperation::AlterConnectorProps {
3767                alter_props: with_options,
3768            }
3769        } else {
3770            return self.expected(
3771                "RENAME, ADD COLUMN, OWNER TO, CONNECTOR, SET or RESET after ALTER SOURCE",
3772            );
3773        };
3774
3775        Ok(Statement::AlterSource {
3776            name: source_name,
3777            operation,
3778        })
3779    }
3780
3781    pub fn parse_alter_function(&mut self) -> ModalResult<Statement> {
3782        let FunctionDesc { name, args } = self.parse_function_desc()?;
3783
3784        let operation = if self.parse_keyword(Keyword::SET) {
3785            if self.parse_keyword(Keyword::SCHEMA) {
3786                let schema_name = self.parse_object_name()?;
3787                AlterFunctionOperation::SetSchema {
3788                    new_schema_name: schema_name,
3789                }
3790            } else {
3791                return self.expected("SCHEMA after SET");
3792            }
3793        } else {
3794            return self.expected("SET after ALTER FUNCTION");
3795        };
3796
3797        Ok(Statement::AlterFunction {
3798            name,
3799            args,
3800            operation,
3801        })
3802    }
3803
3804    pub fn parse_alter_connection(&mut self) -> ModalResult<Statement> {
3805        let connection_name = self.parse_object_name()?;
3806        let operation = if self.parse_keyword(Keyword::SET) {
3807            if self.parse_keyword(Keyword::SCHEMA) {
3808                let schema_name = self.parse_object_name()?;
3809                AlterConnectionOperation::SetSchema {
3810                    new_schema_name: schema_name,
3811                }
3812            } else {
3813                return self.expected("SCHEMA after SET");
3814            }
3815        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
3816            let owner_name: Ident = self.parse_identifier()?;
3817            AlterConnectionOperation::ChangeOwner {
3818                new_owner_name: owner_name,
3819            }
3820        } else {
3821            return self.expected("SET, or OWNER TO after ALTER CONNECTION");
3822        };
3823
3824        Ok(Statement::AlterConnection {
3825            name: connection_name,
3826            operation,
3827        })
3828    }
3829
3830    pub fn parse_alter_system(&mut self) -> ModalResult<Statement> {
3831        self.expect_keyword(Keyword::SET)?;
3832        let param = self.parse_identifier()?;
3833        if self.expect_keyword(Keyword::TO).is_err() && self.expect_token(&Token::Eq).is_err() {
3834            return self.expected("TO or = after ALTER SYSTEM SET");
3835        }
3836        let value = self.parse_set_variable()?;
3837        Ok(Statement::AlterSystem { param, value })
3838    }
3839
3840    pub fn parse_alter_secret(&mut self) -> ModalResult<Statement> {
3841        let secret_name = self.parse_object_name()?;
3842        let with_options = self.parse_with_properties()?;
3843        self.expect_keyword(Keyword::AS)?;
3844        let new_credential = self.ensure_parse_value()?;
3845        let operation = AlterSecretOperation::ChangeCredential { new_credential };
3846        Ok(Statement::AlterSecret {
3847            name: secret_name,
3848            with_options,
3849            operation,
3850        })
3851    }
3852
3853    pub fn parse_alter_fragment(&mut self) -> ModalResult<Statement> {
3854        let mut fragment_ids = vec![self.parse_literal_u32()?];
3855        while self.consume_token(&Token::Comma) {
3856            fragment_ids.push(self.parse_literal_u32()?);
3857        }
3858        if !self.parse_keyword(Keyword::SET) {
3859            return self.expected("SET after ALTER FRAGMENT");
3860        }
3861        let operation = if self.parse_keyword(Keyword::PARALLELISM) {
3862            if self.expect_keyword(Keyword::TO).is_err() && self.expect_token(&Token::Eq).is_err() {
3863                return self.expected("TO or = after ALTER FRAGMENT SET PARALLELISM");
3864            }
3865            let parallelism = self.parse_set_variable()?;
3866            AlterFragmentOperation::SetParallelism { parallelism }
3867        } else {
3868            let rate_limit = self.parse_alter_fragment_rate_limit()?;
3869            AlterFragmentOperation::AlterBackfillRateLimit { rate_limit }
3870        };
3871        Ok(Statement::AlterFragment {
3872            fragment_ids,
3873            operation,
3874        })
3875    }
3876
3877    fn parse_alter_fragment_rate_limit(&mut self) -> ModalResult<i32> {
3878        if !self.parse_word("RATE_LIMIT") {
3879            return self.expected("expected RATE_LIMIT after SET");
3880        }
3881        if self.expect_keyword(Keyword::TO).is_err() && self.expect_token(&Token::Eq).is_err() {
3882            return self.expected("TO or = after RATE_LIMIT");
3883        }
3884        let rate_limit = if self.parse_keyword(Keyword::DEFAULT) {
3885            -1
3886        } else {
3887            let s = self.parse_number_value()?;
3888            if let Ok(n) = s.parse::<i32>() {
3889                n
3890            } else {
3891                return self.expected("number or DEFAULT");
3892            }
3893        };
3894        Ok(rate_limit)
3895    }
3896
3897    /// Parse a copy statement
3898    pub fn parse_copy(&mut self) -> ModalResult<Statement> {
3899        let entity = if self.consume_token(&Token::LParen) {
3900            let query = self.parse_query()?;
3901            self.expect_token(&Token::RParen)?;
3902            CopyEntity::Query(query.into())
3903        } else {
3904            let table_name = self.parse_object_name()?;
3905            let columns = self.parse_parenthesized_column_list(Optional)?;
3906            CopyEntity::Table {
3907                table_name,
3908                columns,
3909            }
3910        };
3911
3912        let target = if self.parse_keywords(&[Keyword::FROM, Keyword::STDIN]) {
3913            self.expect_token(&Token::SemiColon)?;
3914            let values = self.parse_tsv();
3915            CopyTarget::Stdin { values }
3916        } else if self.parse_keywords(&[Keyword::TO, Keyword::STDOUT]) {
3917            CopyTarget::Stdout
3918        } else {
3919            return self.expected("FROM STDIN or TO STDOUT");
3920        };
3921
3922        Ok(Statement::Copy { entity, target })
3923    }
3924
3925    /// Parse a tab separated values in
3926    /// COPY payload
3927    fn parse_tsv(&mut self) -> Vec<Option<String>> {
3928        self.parse_tab_value()
3929    }
3930
3931    fn parse_tab_value(&mut self) -> Vec<Option<String>> {
3932        let mut values = vec![];
3933        let mut content = String::from("");
3934        while let Some(t) = self.next_token_no_skip() {
3935            match t.token {
3936                Token::Whitespace(Whitespace::Tab) => {
3937                    values.push(Some(content.clone()));
3938                    content.clear();
3939                }
3940                Token::Whitespace(Whitespace::Newline) => {
3941                    values.push(Some(content.clone()));
3942                    content.clear();
3943                }
3944                Token::Backslash => {
3945                    if self.consume_token(&Token::Period) {
3946                        return values;
3947                    }
3948                    if let Token::Word(w) = self.next_token().token
3949                        && w.value == "N"
3950                    {
3951                        values.push(None);
3952                    }
3953                }
3954                _ => {
3955                    content.push_str(&t.to_string());
3956                }
3957            }
3958        }
3959        values
3960    }
3961
3962    pub fn ensure_parse_value(&mut self) -> ModalResult<Value> {
3963        match self.parse_value_and_obj_ref::<true>()? {
3964            SqlOptionValue::Value(value) => Ok(value),
3965            SqlOptionValue::SecretRef(_)
3966            | SqlOptionValue::ConnectionRef(_)
3967            | SqlOptionValue::BackfillOrder(_) => unreachable!(),
3968        }
3969    }
3970
3971    /// Parse a literal value (numbers, strings, date/time, booleans)
3972    pub fn parse_value_and_obj_ref<const FORBID_OBJ_REF: bool>(
3973        &mut self,
3974    ) -> ModalResult<SqlOptionValue> {
3975        let checkpoint = *self;
3976        let token = self.next_token();
3977        match token.token {
3978            Token::Word(w) => match w.keyword {
3979                Keyword::TRUE => Ok(Value::Boolean(true).into()),
3980                Keyword::FALSE => Ok(Value::Boolean(false).into()),
3981                Keyword::NULL => Ok(Value::Null.into()),
3982                Keyword::NoKeyword if w.quote_style.is_some() => match w.quote_style {
3983                    Some('"') => Ok(Value::DoubleQuotedString(w.value).into()),
3984                    Some('\'') => Ok(Value::SingleQuotedString(w.value).into()),
3985                    _ => self.expected_at(checkpoint, "A value")?,
3986                },
3987                Keyword::SECRET => {
3988                    if FORBID_OBJ_REF {
3989                        return self.expected_at(
3990                            checkpoint,
3991                            "a concrete value rather than a secret reference",
3992                        );
3993                    }
3994                    let secret = self.parse_secret_ref()?;
3995                    Ok(SqlOptionValue::SecretRef(secret))
3996                }
3997                _ => self.expected_at(checkpoint, "a concrete value"),
3998            },
3999            Token::Number(ref n) => Ok(Value::Number(n.clone()).into()),
4000            Token::SingleQuotedString(ref s) => Ok(Value::SingleQuotedString(s.clone()).into()),
4001            Token::DollarQuotedString(ref s) => Ok(Value::DollarQuotedString(s.clone()).into()),
4002            Token::CstyleEscapesString(ref s) => Ok(Value::CstyleEscapedString(s.clone()).into()),
4003            Token::NationalStringLiteral(ref s) => {
4004                Ok(Value::NationalStringLiteral(s.clone()).into())
4005            }
4006            Token::HexStringLiteral(ref s) => Ok(Value::HexStringLiteral(s.clone()).into()),
4007            _ => self.expected_at(checkpoint, "a value"),
4008        }
4009    }
4010
4011    fn parse_secret_ref(&mut self) -> ModalResult<SecretRefValue> {
4012        let secret_name = self.parse_object_name()?;
4013        let ref_as = if self.parse_keywords(&[Keyword::AS, Keyword::FILE]) {
4014            SecretRefAsType::File
4015        } else {
4016            SecretRefAsType::Text
4017        };
4018        Ok(SecretRefValue {
4019            secret_name,
4020            ref_as,
4021        })
4022    }
4023
4024    fn parse_set_variable(&mut self) -> ModalResult<SetVariableValue> {
4025        alt((
4026            Keyword::DEFAULT.value(SetVariableValue::Default),
4027            separated(
4028                1..,
4029                alt((
4030                    Self::ensure_parse_value.map(SetVariableValueSingle::Literal),
4031                    |parser: &mut Self| {
4032                        let checkpoint = *parser;
4033                        let ident = parser.parse_identifier()?;
4034                        if ident.value == "default" {
4035                            *parser = checkpoint;
4036                            return parser.expected("parameter list value").map_err(|e| e.cut());
4037                        }
4038                        Ok(SetVariableValueSingle::Ident(ident))
4039                    },
4040                    fail.expect("parameter value"),
4041                )),
4042                Token::Comma,
4043            )
4044            .map(|list: Vec<SetVariableValueSingle>| {
4045                if list.len() == 1 {
4046                    SetVariableValue::Single(list[0].clone())
4047                } else {
4048                    SetVariableValue::List(list)
4049                }
4050            }),
4051        ))
4052        .parse_next(self)
4053    }
4054
4055    fn parse_backfill_order_strategy(&mut self) -> ModalResult<BackfillOrderStrategy> {
4056        alt((
4057            Keyword::DEFAULT.value(BackfillOrderStrategy::Default),
4058            Keyword::NONE.value(BackfillOrderStrategy::None),
4059            Keyword::AUTO.value(BackfillOrderStrategy::Auto),
4060            Self::parse_fixed_backfill_order.map(BackfillOrderStrategy::Fixed),
4061            fail.expect("backfill order strategy"),
4062        ))
4063        .parse_next(self)
4064    }
4065
4066    fn parse_fixed_backfill_order(&mut self) -> ModalResult<Vec<(ObjectName, ObjectName)>> {
4067        self.expect_word("FIXED")?;
4068        self.expect_token(&Token::LParen)?;
4069        let edges = separated(
4070            0..,
4071            separated_pair(
4072                Self::parse_object_name,
4073                Token::Op("->".to_owned()),
4074                Self::parse_object_name,
4075            ),
4076            Token::Comma,
4077        )
4078        .parse_next(self)?;
4079        self.expect_token(&Token::RParen)?;
4080        Ok(edges)
4081    }
4082
4083    pub fn parse_number_value(&mut self) -> ModalResult<String> {
4084        let checkpoint = *self;
4085        match self.ensure_parse_value()? {
4086            Value::Number(v) => Ok(v),
4087            _ => self.expected_at(checkpoint, "literal number"),
4088        }
4089    }
4090
4091    pub fn parse_literal_u32(&mut self) -> ModalResult<u32> {
4092        literal_u32(self)
4093    }
4094
4095    pub fn parse_literal_u64(&mut self) -> ModalResult<u64> {
4096        literal_u64(self)
4097    }
4098
4099    pub fn parse_function_definition(&mut self) -> ModalResult<FunctionDefinition> {
4100        alt((
4101            single_quoted_string.map(FunctionDefinition::SingleQuotedDef),
4102            dollar_quoted_string.map(FunctionDefinition::DoubleDollarDef),
4103            Self::parse_identifier.map(|i| FunctionDefinition::Identifier(i.value)),
4104            fail.expect("function definition"),
4105        ))
4106        .parse_next(self)
4107    }
4108
4109    /// Parse a literal string
4110    pub fn parse_literal_string(&mut self) -> ModalResult<String> {
4111        let checkpoint = *self;
4112        let token = self.next_token();
4113        match token.token {
4114            Token::SingleQuotedString(s) => Ok(s),
4115            _ => self.expected_at(checkpoint, "literal string"),
4116        }
4117    }
4118
4119    /// Parse a SQL datatype (in the context of a CREATE TABLE statement for example)
4120    pub fn parse_data_type(&mut self) -> ModalResult<DataType> {
4121        parser_v2::data_type(self)
4122    }
4123
4124    /// Parse `AS identifier` (or simply `identifier` if it's not a reserved keyword)
4125    /// Some examples with aliases: `SELECT 1 foo`, `SELECT COUNT(*) AS cnt`,
4126    /// `SELECT ... FROM t1 foo, t2 bar`, `SELECT ... FROM (...) AS bar`
4127    pub fn parse_optional_alias(
4128        &mut self,
4129        reserved_kwds: &[Keyword],
4130    ) -> ModalResult<Option<Ident>> {
4131        let after_as = self.parse_keyword(Keyword::AS);
4132        let checkpoint = *self;
4133        let token = self.next_token();
4134        match token.token {
4135            // Accept any identifier after `AS` (though many dialects have restrictions on
4136            // keywords that may appear here). If there's no `AS`: don't parse keywords,
4137            // which may start a construct allowed in this position, to be parsed as aliases.
4138            // (For example, in `FROM t1 JOIN` the `JOIN` will always be parsed as a keyword,
4139            // not an alias.)
4140            Token::Word(w) if after_as || (!reserved_kwds.contains(&w.keyword)) => {
4141                Ok(Some(w.to_ident()?))
4142            }
4143            _ => {
4144                *self = checkpoint;
4145                if after_as {
4146                    return self.expected("an identifier after AS");
4147                }
4148                Ok(None) // no alias found
4149            }
4150        }
4151    }
4152
4153    /// Parse `AS identifier` when the AS is describing a table-valued object,
4154    /// like in `... FROM generate_series(1, 10) AS t (col)`. In this case
4155    /// the alias is allowed to optionally name the columns in the table, in
4156    /// addition to the table itself.
4157    pub fn parse_optional_table_alias(
4158        &mut self,
4159        reserved_kwds: &[Keyword],
4160    ) -> ModalResult<Option<TableAlias>> {
4161        match self.parse_optional_alias(reserved_kwds)? {
4162            Some(name) => {
4163                let columns = self.parse_parenthesized_column_list(Optional)?;
4164                Ok(Some(TableAlias { name, columns }))
4165            }
4166            None => Ok(None),
4167        }
4168    }
4169
4170    /// syntax `FOR SYSTEM_TIME AS OF PROCTIME()` is used for temporal join.
4171    pub fn parse_as_of(&mut self) -> ModalResult<AsOf> {
4172        Keyword::FOR.parse_next(self)?;
4173        alt((
4174            preceded(
4175                (Keyword::SYSTEM_TIME, Keyword::AS, Keyword::OF),
4176                cut_err(
4177                    alt((
4178                        preceded(
4179                            (
4180                                Self::parse_identifier.verify(|ident| ident.real_value() == "now"),
4181                                cut_err(Token::LParen),
4182                                cut_err(Token::RParen),
4183                                Token::Minus,
4184                            ),
4185                            Self::parse_literal_interval.try_map(|e| match e {
4186                                Expr::Value(v) => match v {
4187                                    Value::Interval {
4188                                        value,
4189                                        leading_field,
4190                                        ..
4191                                    } => {
4192                                        let Some(leading_field) = leading_field else {
4193                                            return Err(StrError("expect duration unit".into()));
4194                                        };
4195                                        Ok(AsOf::ProcessTimeWithInterval((value, leading_field)))
4196                                    }
4197                                    _ => Err(StrError("expect Value::Interval".into())),
4198                                },
4199                                _ => Err(StrError("expect Expr::Value".into())),
4200                            }),
4201                        ),
4202                        (
4203                            Self::parse_identifier.verify(|ident| ident.real_value() == "now"),
4204                            cut_err(Token::LParen),
4205                            cut_err(Token::RParen),
4206                        )
4207                            .value(AsOf::ProcessTimeWithInterval((
4208                                "0".to_owned(),
4209                                DateTimeField::Second,
4210                            ))),
4211                        (
4212                            Self::parse_identifier.verify(|ident| ident.real_value() == "proctime"),
4213                            cut_err(Token::LParen),
4214                            cut_err(Token::RParen),
4215                        )
4216                            .value(AsOf::ProcessTime),
4217                        literal_i64.map(AsOf::TimestampNum),
4218                        single_quoted_string.map(AsOf::TimestampString),
4219                    ))
4220                    .expect("proctime(), now(), number or string"),
4221                ),
4222            ),
4223            preceded(
4224                (Keyword::SYSTEM_VERSION, Keyword::AS, Keyword::OF),
4225                cut_err(
4226                    alt((
4227                        literal_i64.map(AsOf::VersionNum),
4228                        single_quoted_string.map(AsOf::VersionString),
4229                    ))
4230                    .expect("number or string"),
4231                ),
4232            ),
4233        ))
4234        .parse_next(self)
4235    }
4236
4237    /// Parse a possibly qualified, possibly quoted identifier, e.g.
4238    /// `foo` or `myschema."table"
4239    pub fn parse_object_name(&mut self) -> ModalResult<ObjectName> {
4240        let mut idents = vec![];
4241        loop {
4242            idents.push(self.parse_identifier()?);
4243            if !self.consume_token(&Token::Period) {
4244                break;
4245            }
4246        }
4247        Ok(ObjectName(idents))
4248    }
4249
4250    /// Parse a parenthesized comma-separated list of object names
4251    pub fn parse_parenthesized_object_name_list(&mut self) -> ModalResult<Vec<ObjectName>> {
4252        if self.consume_token(&Token::LParen) {
4253            let names = self.parse_comma_separated(Parser::parse_object_name)?;
4254            self.expect_token(&Token::RParen)?;
4255            Ok(names)
4256        } else {
4257            self.expected("a list of object names in parentheses")
4258        }
4259    }
4260
4261    /// Parse identifiers strictly i.e. don't parse keywords
4262    pub fn parse_identifiers_non_keywords(&mut self) -> ModalResult<Vec<Ident>> {
4263        let mut idents = vec![];
4264        loop {
4265            match self.peek_token().token {
4266                Token::Word(w) => {
4267                    if w.keyword != Keyword::NoKeyword {
4268                        break;
4269                    }
4270
4271                    idents.push(w.to_ident()?);
4272                }
4273                Token::EOF | Token::Eq => break,
4274                _ => {}
4275            }
4276
4277            self.next_token();
4278        }
4279
4280        Ok(idents)
4281    }
4282
4283    /// Parse identifiers
4284    pub fn parse_identifiers(&mut self) -> ModalResult<Vec<Ident>> {
4285        let mut idents = vec![];
4286        loop {
4287            let token = self.next_token();
4288            match token.token {
4289                Token::Word(w) => {
4290                    idents.push(w.to_ident()?);
4291                }
4292                Token::EOF => break,
4293                _ => {}
4294            }
4295        }
4296
4297        Ok(idents)
4298    }
4299
4300    /// Parse a simple one-word identifier (possibly quoted, possibly a keyword)
4301    pub fn parse_identifier(&mut self) -> ModalResult<Ident> {
4302        let checkpoint = *self;
4303        let token = self.next_token();
4304        match token.token {
4305            Token::Word(w) => Ok(w.to_ident()?),
4306            _ => self.expected_at(checkpoint, "identifier"),
4307        }
4308    }
4309
4310    /// Parse a simple one-word identifier (possibly quoted, possibly a non-reserved keyword)
4311    pub fn parse_identifier_non_reserved(&mut self) -> ModalResult<Ident> {
4312        let checkpoint = *self;
4313        let token = self.next_token();
4314        match token.token {
4315            Token::Word(w) => {
4316                match keywords::RESERVED_FOR_COLUMN_OR_TABLE_NAME.contains(&w.keyword) {
4317                    true => parser_err!("syntax error at or near {w}"),
4318                    false => Ok(w.to_ident()?),
4319                }
4320            }
4321            _ => self.expected_at(checkpoint, "identifier"),
4322        }
4323    }
4324
4325    /// Parse a parenthesized comma-separated list of unqualified, possibly quoted identifiers
4326    pub fn parse_parenthesized_column_list(
4327        &mut self,
4328        optional: IsOptional,
4329    ) -> ModalResult<Vec<Ident>> {
4330        if self.consume_token(&Token::LParen) {
4331            let cols = self.parse_comma_separated(Parser::parse_identifier_non_reserved)?;
4332            self.expect_token(&Token::RParen)?;
4333            Ok(cols)
4334        } else if optional == Optional {
4335            Ok(vec![])
4336        } else {
4337            self.expected("a list of columns in parentheses")
4338        }
4339    }
4340
4341    pub fn parse_returning(&mut self, optional: IsOptional) -> ModalResult<Vec<SelectItem>> {
4342        if self.parse_keyword(Keyword::RETURNING) {
4343            let cols = self.parse_comma_separated(Parser::parse_select_item)?;
4344            Ok(cols)
4345        } else if optional == Optional {
4346            Ok(vec![])
4347        } else {
4348            self.expected("a list of columns or * after returning")
4349        }
4350    }
4351
4352    pub fn parse_row_expr(&mut self) -> ModalResult<Expr> {
4353        Ok(Expr::Row(self.parse_token_wrapped_exprs(
4354            &Token::LParen,
4355            &Token::RParen,
4356        )?))
4357    }
4358
4359    /// Parse a comma-separated list (maybe empty) from a wrapped expression
4360    pub fn parse_token_wrapped_exprs(
4361        &mut self,
4362        left: &Token,
4363        right: &Token,
4364    ) -> ModalResult<Vec<Expr>> {
4365        if self.consume_token(left) {
4366            let exprs = if self.consume_token(right) {
4367                vec![]
4368            } else {
4369                let exprs = self.parse_comma_separated(Parser::parse_expr)?;
4370                self.expect_token(right)?;
4371                exprs
4372            };
4373            Ok(exprs)
4374        } else {
4375            self.expected(left.to_string().as_str())
4376        }
4377    }
4378
4379    pub fn parse_optional_precision(&mut self) -> ModalResult<Option<u64>> {
4380        if self.consume_token(&Token::LParen) {
4381            let n = self.parse_literal_u64()?;
4382            self.expect_token(&Token::RParen)?;
4383            Ok(Some(n))
4384        } else {
4385            Ok(None)
4386        }
4387    }
4388
4389    pub fn parse_optional_precision_scale(&mut self) -> ModalResult<(Option<u64>, Option<u64>)> {
4390        if self.consume_token(&Token::LParen) {
4391            let n = self.parse_literal_u64()?;
4392            let scale = if self.consume_token(&Token::Comma) {
4393                Some(self.parse_literal_u64()?)
4394            } else {
4395                None
4396            };
4397            self.expect_token(&Token::RParen)?;
4398            Ok((Some(n), scale))
4399        } else {
4400            Ok((None, None))
4401        }
4402    }
4403
4404    pub fn parse_delete(&mut self) -> ModalResult<Statement> {
4405        self.expect_keyword(Keyword::FROM)?;
4406        let table_name = self.parse_object_name()?;
4407        let selection = if self.parse_keyword(Keyword::WHERE) {
4408            Some(self.parse_expr()?)
4409        } else {
4410            None
4411        };
4412        let returning = self.parse_returning(Optional)?;
4413
4414        Ok(Statement::Delete {
4415            table_name,
4416            selection,
4417            returning,
4418        })
4419    }
4420
4421    pub fn parse_boolean(&mut self) -> ModalResult<bool> {
4422        if let Some(keyword) = self.parse_one_of_keywords(&[Keyword::TRUE, Keyword::FALSE]) {
4423            match keyword {
4424                Keyword::TRUE => Ok(true),
4425                Keyword::FALSE => Ok(false),
4426                _ => unreachable!(),
4427            }
4428        } else {
4429            self.expected("TRUE or FALSE")
4430        }
4431    }
4432
4433    pub fn parse_optional_boolean(&mut self, default: bool) -> bool {
4434        self.parse_boolean().unwrap_or(default)
4435    }
4436
4437    fn parse_explain_options(&mut self) -> ModalResult<(ExplainOptions, Option<u64>)> {
4438        let mut options = ExplainOptions::default();
4439        let mut analyze_duration = None;
4440
4441        const BACKFILL: &str = "backfill";
4442        const VERBOSE: &str = "verbose";
4443        const TRACE: &str = "trace";
4444        const TYPE: &str = "type";
4445        const LOGICAL: &str = "logical";
4446        const PHYSICAL: &str = "physical";
4447        const DISTSQL: &str = "distsql";
4448        const FORMAT: &str = "format";
4449        const DURATION_SECS: &str = "duration_secs";
4450
4451        let explain_options_identifiers = [
4452            BACKFILL,
4453            VERBOSE,
4454            TRACE,
4455            TYPE,
4456            LOGICAL,
4457            PHYSICAL,
4458            DISTSQL,
4459            FORMAT,
4460            DURATION_SECS,
4461        ];
4462
4463        let parse_explain_option = |parser: &mut Parser<'_>| -> ModalResult<()> {
4464            match parser.parse_identifier()?.real_value().as_str() {
4465                VERBOSE => options.verbose = parser.parse_optional_boolean(true),
4466                TRACE => options.trace = parser.parse_optional_boolean(true),
4467                BACKFILL => options.backfill = parser.parse_optional_boolean(true),
4468                TYPE => {
4469                    let explain_type = parser.parse_identifier()?.real_value();
4470                    match explain_type.as_str() {
4471                        LOGICAL => options.explain_type = ExplainType::Logical,
4472                        PHYSICAL => options.explain_type = ExplainType::Physical,
4473                        DISTSQL => options.explain_type = ExplainType::DistSql,
4474                        unexpected => {
4475                            parser_err!("unexpected explain type: [{unexpected}]")
4476                        }
4477                    }
4478                }
4479                LOGICAL => options.explain_type = ExplainType::Logical,
4480                PHYSICAL => options.explain_type = ExplainType::Physical,
4481                DISTSQL => options.explain_type = ExplainType::DistSql,
4482                FORMAT => {
4483                    options.explain_format = {
4484                        let format = parser.parse_identifier()?.real_value();
4485                        match format.as_str() {
4486                            "text" => ExplainFormat::Text,
4487                            "json" => ExplainFormat::Json,
4488                            "xml" => ExplainFormat::Xml,
4489                            "yaml" => ExplainFormat::Yaml,
4490                            "dot" => ExplainFormat::Dot,
4491                            unexpected => {
4492                                parser_err!("unexpected explain format [{unexpected}]")
4493                            }
4494                        }
4495                    }
4496                }
4497                DURATION_SECS => {
4498                    analyze_duration = Some(parser.parse_literal_u64()?);
4499                }
4500                unexpected => {
4501                    parser_err!("unexpected explain options: [{unexpected}]")
4502                }
4503            };
4504            Ok(())
4505        };
4506
4507        // In order to support following statement, we need to peek before consume.
4508        // explain (select 1) union (select 1)
4509        if self.peek_token() == Token::LParen
4510            && let Token::Word(word) = self.peek_nth_token(1).token
4511            && let Ok(ident) = word.to_ident()
4512            && explain_options_identifiers.contains(&ident.real_value().as_str())
4513        {
4514            assert!(self.consume_token(&Token::LParen));
4515            self.parse_comma_separated(parse_explain_option)?;
4516            self.expect_token(&Token::RParen)?;
4517        }
4518
4519        Ok((options, analyze_duration))
4520    }
4521
4522    pub fn parse_explain(&mut self) -> ModalResult<Statement> {
4523        let analyze = self.parse_keyword(Keyword::ANALYZE);
4524        let (options, analyze_duration) = self.parse_explain_options()?;
4525
4526        if analyze {
4527            fn parse_analyze_target(parser: &mut Parser<'_>) -> ModalResult<Option<AnalyzeTarget>> {
4528                if parser.parse_keyword(Keyword::TABLE) {
4529                    let table_name = parser.parse_object_name()?;
4530                    Ok(Some(AnalyzeTarget::Table(table_name)))
4531                } else if parser.parse_keyword(Keyword::INDEX) {
4532                    let index_name = parser.parse_object_name()?;
4533                    Ok(Some(AnalyzeTarget::Index(index_name)))
4534                } else if parser.parse_keywords(&[Keyword::MATERIALIZED, Keyword::VIEW]) {
4535                    let view_name = parser.parse_object_name()?;
4536                    Ok(Some(AnalyzeTarget::MaterializedView(view_name)))
4537                } else if parser.parse_keyword(Keyword::INDEX) {
4538                    let index_name = parser.parse_object_name()?;
4539                    Ok(Some(AnalyzeTarget::Index(index_name)))
4540                } else if parser.parse_keyword(Keyword::SINK) {
4541                    let sink_name = parser.parse_object_name()?;
4542                    Ok(Some(AnalyzeTarget::Sink(sink_name)))
4543                } else if parser.parse_word("ID") {
4544                    let job_id = parser.parse_literal_u32()?;
4545                    Ok(Some(AnalyzeTarget::Id(job_id)))
4546                } else {
4547                    Ok(None)
4548                }
4549            }
4550            if let Some(target) = parse_analyze_target(self)? {
4551                let statement = Statement::ExplainAnalyzeStreamJob {
4552                    target,
4553                    duration_secs: analyze_duration,
4554                };
4555                return Ok(statement);
4556            }
4557        }
4558
4559        let statement = match self.parse_statement() {
4560            Ok(statement) => statement,
4561            error @ Err(_) => {
4562                return if analyze {
4563                    self.expected_at(
4564                        *self,
4565                        "SINK, TABLE, MATERIALIZED VIEW, INDEX or a statement after ANALYZE",
4566                    )
4567                } else {
4568                    error
4569                };
4570            }
4571        };
4572        Ok(Statement::Explain {
4573            analyze,
4574            statement: Box::new(statement),
4575            options,
4576        })
4577    }
4578
4579    pub fn parse_describe(&mut self) -> ModalResult<Statement> {
4580        let kind = match self.parse_one_of_keywords(&[Keyword::FRAGMENT, Keyword::FRAGMENTS]) {
4581            Some(Keyword::FRAGMENT) => {
4582                let fragment_id = self.parse_literal_u32()?;
4583                return Ok(Statement::DescribeFragment { fragment_id });
4584            }
4585            Some(Keyword::FRAGMENTS) => DescribeKind::Fragments,
4586            None => DescribeKind::Plain,
4587            Some(_) => unreachable!(),
4588        };
4589        let name = self.parse_object_name()?;
4590        Ok(Statement::Describe { name, kind })
4591    }
4592
4593    /// Parse a query expression, i.e. a `SELECT` statement optionally
4594    /// preceded with some `WITH` CTE declarations and optionally followed
4595    /// by `ORDER BY`. Unlike some other parse_... methods, this one doesn't
4596    /// expect the initial keyword to be already consumed
4597    pub fn parse_query(&mut self) -> ModalResult<Query> {
4598        let with = if self.parse_keyword(Keyword::WITH) {
4599            Some(With {
4600                recursive: self.parse_keyword(Keyword::RECURSIVE),
4601                cte_tables: self.parse_comma_separated(Parser::parse_cte)?,
4602            })
4603        } else {
4604            None
4605        };
4606
4607        let body = self.parse_query_body(0)?;
4608
4609        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
4610            self.parse_comma_separated(Parser::parse_order_by_expr)?
4611        } else {
4612            vec![]
4613        };
4614
4615        let mut limit = None;
4616        let mut offset = None;
4617        for _x in 0..2 {
4618            if limit.is_none() && self.parse_keyword(Keyword::LIMIT) {
4619                limit = self.parse_limit()?
4620            }
4621
4622            if offset.is_none() && self.parse_keyword(Keyword::OFFSET) {
4623                offset = Some(self.parse_offset()?)
4624            }
4625        }
4626
4627        let fetch = if self.parse_keyword(Keyword::FETCH) {
4628            if limit.is_some() {
4629                parser_err!("Cannot specify both LIMIT and FETCH");
4630            }
4631            let fetch = self.parse_fetch()?;
4632            if fetch.with_ties && order_by.is_empty() {
4633                parser_err!("WITH TIES cannot be specified without ORDER BY clause");
4634            }
4635            Some(fetch)
4636        } else {
4637            None
4638        };
4639
4640        Ok(Query {
4641            with,
4642            body,
4643            order_by,
4644            limit,
4645            offset,
4646            fetch,
4647        })
4648    }
4649
4650    /// Parse a CTE (`alias [( col1, col2, ... )] AS (subquery)`)
4651    fn parse_cte(&mut self) -> ModalResult<Cte> {
4652        let name = self.parse_identifier_non_reserved()?;
4653        let cte = if self.parse_keyword(Keyword::AS) {
4654            let cte_inner = self.parse_cte_inner()?;
4655            let alias = TableAlias {
4656                name,
4657                columns: vec![],
4658            };
4659            Cte { alias, cte_inner }
4660        } else {
4661            let columns = self.parse_parenthesized_column_list(Optional)?;
4662            self.expect_keyword(Keyword::AS)?;
4663            let cte_inner = self.parse_cte_inner()?;
4664            let alias = TableAlias { name, columns };
4665            Cte { alias, cte_inner }
4666        };
4667        Ok(cte)
4668    }
4669
4670    fn parse_cte_inner(&mut self) -> ModalResult<CteInner> {
4671        match self.expect_token(&Token::LParen) {
4672            Ok(()) => {
4673                let query = self.parse_query()?;
4674                self.expect_token(&Token::RParen)?;
4675                Ok(CteInner::Query(Box::new(query)))
4676            }
4677            _ => {
4678                let changelog = self.parse_identifier_non_reserved()?;
4679                if changelog.to_string().to_lowercase() != "changelog" {
4680                    parser_err!("Expected 'changelog' but found '{}'", changelog);
4681                }
4682                self.expect_keyword(Keyword::FROM)?;
4683                Ok(CteInner::ChangeLog(self.parse_object_name()?))
4684            }
4685        }
4686    }
4687
4688    /// Parse a "query body", which is an expression with roughly the
4689    /// following grammar:
4690    /// ```text
4691    ///   query_body ::= restricted_select | '(' subquery ')' | set_operation
4692    ///   restricted_select ::= 'SELECT' [expr_list] [ from ] [ where ] [ groupby_having ]
4693    ///   subquery ::= query_body [ order_by_limit ]
4694    ///   set_operation ::= query_body { 'UNION' | 'EXCEPT' | 'INTERSECT' } [ 'ALL' ] query_body
4695    /// ```
4696    fn parse_query_body(&mut self, precedence: u8) -> ModalResult<SetExpr> {
4697        // We parse the expression using a Pratt parser, as in `parse_expr()`.
4698        // Start by parsing a restricted SELECT or a `(subquery)`:
4699        let mut expr = if self.parse_keyword(Keyword::SELECT) {
4700            SetExpr::Select(Box::new(self.parse_select()?))
4701        } else if self.consume_token(&Token::LParen) {
4702            // CTEs are not allowed here, but the parser currently accepts them
4703            let subquery = self.parse_query()?;
4704            self.expect_token(&Token::RParen)?;
4705            SetExpr::Query(Box::new(subquery))
4706        } else if self.parse_keyword(Keyword::VALUES) {
4707            SetExpr::Values(self.parse_values()?)
4708        } else {
4709            return self.expected("SELECT, VALUES, or a subquery in the query body");
4710        };
4711
4712        loop {
4713            // The query can be optionally followed by a set operator:
4714            let op = self.parse_set_operator(&self.peek_token().token);
4715            let next_precedence = match op {
4716                // UNION and EXCEPT have the same binding power and evaluate left-to-right
4717                Some(SetOperator::Union) | Some(SetOperator::Except) => 10,
4718                // INTERSECT has higher precedence than UNION/EXCEPT
4719                Some(SetOperator::Intersect) => 20,
4720                // Unexpected token or EOF => stop parsing the query body
4721                None => break,
4722            };
4723            if precedence >= next_precedence {
4724                break;
4725            }
4726            self.next_token(); // skip past the set operator
4727
4728            let all = self.parse_keyword(Keyword::ALL);
4729            let corresponding = self.parse_corresponding()?;
4730
4731            expr = SetExpr::SetOperation {
4732                left: Box::new(expr),
4733                op: op.unwrap(),
4734                corresponding,
4735                all,
4736                right: Box::new(self.parse_query_body(next_precedence)?),
4737            };
4738        }
4739
4740        Ok(expr)
4741    }
4742
4743    fn parse_set_operator(&mut self, token: &Token) -> Option<SetOperator> {
4744        match token {
4745            Token::Word(w) if w.keyword == Keyword::UNION => Some(SetOperator::Union),
4746            Token::Word(w) if w.keyword == Keyword::EXCEPT => Some(SetOperator::Except),
4747            Token::Word(w) if w.keyword == Keyword::INTERSECT => Some(SetOperator::Intersect),
4748            _ => None,
4749        }
4750    }
4751
4752    fn parse_corresponding(&mut self) -> ModalResult<Corresponding> {
4753        let corresponding = if self.parse_keyword(Keyword::CORRESPONDING) {
4754            let column_list = if self.parse_keyword(Keyword::BY) {
4755                Some(self.parse_parenthesized_column_list(IsOptional::Mandatory)?)
4756            } else {
4757                None
4758            };
4759            Corresponding::with_column_list(column_list)
4760        } else {
4761            Corresponding::none()
4762        };
4763        Ok(corresponding)
4764    }
4765
4766    /// Parse a restricted `SELECT` statement (no CTEs / `UNION` / `ORDER BY`),
4767    /// assuming the initial `SELECT` was already consumed
4768    pub fn parse_select(&mut self) -> ModalResult<Select> {
4769        let distinct = self.parse_all_or_distinct_on()?;
4770
4771        let projection = self.parse_comma_separated(Parser::parse_select_item)?;
4772
4773        // Note that for keywords to be properly handled here, they need to be
4774        // added to `RESERVED_FOR_COLUMN_ALIAS` / `RESERVED_FOR_TABLE_ALIAS`,
4775        // otherwise they may be parsed as an alias as part of the `projection`
4776        // or `from`.
4777
4778        let from = if self.parse_keyword(Keyword::FROM) {
4779            self.parse_comma_separated(Parser::parse_table_and_joins)?
4780        } else {
4781            vec![]
4782        };
4783        let mut lateral_views = vec![];
4784        loop {
4785            if self.parse_keywords(&[Keyword::LATERAL, Keyword::VIEW]) {
4786                let outer = self.parse_keyword(Keyword::OUTER);
4787                let lateral_view = self.parse_expr()?;
4788                let lateral_view_name = self.parse_object_name()?;
4789                let lateral_col_alias = self
4790                    .parse_comma_separated(|parser| {
4791                        parser.parse_optional_alias(&[
4792                            Keyword::WHERE,
4793                            Keyword::GROUP,
4794                            Keyword::CLUSTER,
4795                            Keyword::HAVING,
4796                            Keyword::LATERAL,
4797                        ]) // This couldn't possibly be a bad idea
4798                    })?
4799                    .into_iter()
4800                    .flatten()
4801                    .collect();
4802
4803                lateral_views.push(LateralView {
4804                    lateral_view,
4805                    lateral_view_name,
4806                    lateral_col_alias,
4807                    outer,
4808                });
4809            } else {
4810                break;
4811            }
4812        }
4813
4814        let selection = if self.parse_keyword(Keyword::WHERE) {
4815            Some(self.parse_expr()?)
4816        } else {
4817            None
4818        };
4819
4820        let group_by = if self.parse_keywords(&[Keyword::GROUP, Keyword::BY]) {
4821            self.parse_comma_separated(Parser::parse_group_by_expr)?
4822        } else {
4823            vec![]
4824        };
4825
4826        let having = if self.parse_keyword(Keyword::HAVING) {
4827            Some(self.parse_expr()?)
4828        } else {
4829            None
4830        };
4831
4832        let window = if self.parse_keyword(Keyword::WINDOW) {
4833            self.parse_comma_separated(Parser::parse_named_window)?
4834        } else {
4835            vec![]
4836        };
4837
4838        Ok(Select {
4839            distinct,
4840            projection,
4841            from,
4842            lateral_views,
4843            selection,
4844            group_by,
4845            having,
4846            window,
4847        })
4848    }
4849
4850    pub fn parse_set(&mut self) -> ModalResult<Statement> {
4851        let modifier = self.parse_one_of_keywords(&[Keyword::SESSION, Keyword::LOCAL]);
4852        if self.parse_keywords(&[Keyword::TIME, Keyword::ZONE]) {
4853            let value = alt((
4854                Keyword::DEFAULT.value(SetTimeZoneValue::Default),
4855                Keyword::LOCAL.value(SetTimeZoneValue::Local),
4856                preceded(
4857                    Keyword::INTERVAL,
4858                    cut_err(Self::parse_literal_interval.try_map(|e| match e {
4859                        // support a special case for clients which would send when initializing the connection
4860                        // like: SET TIME ZONE INTERVAL '+00:00' HOUR TO MINUTE;
4861                        Expr::Value(v) => match v {
4862                            Value::Interval { value, .. } => {
4863                                if value != "+00:00" {
4864                                    return Err(StrError("only support \"+00:00\" ".into()));
4865                                }
4866                                Ok(SetTimeZoneValue::Ident(Ident::with_quote_unchecked(
4867                                    '\'',
4868                                    "UTC".to_owned(),
4869                                )))
4870                            }
4871                            _ => Err(StrError("expect Value::Interval".into())),
4872                        },
4873                        _ => Err(StrError("expect Expr::Value".into())),
4874                    })),
4875                ),
4876                Self::parse_identifier.map(SetTimeZoneValue::Ident),
4877                Self::ensure_parse_value.map(SetTimeZoneValue::Literal),
4878            ))
4879            .expect("variable")
4880            .parse_next(self)?;
4881
4882            Ok(Statement::SetTimeZone {
4883                local: modifier == Some(Keyword::LOCAL),
4884                value,
4885            })
4886        } else if self.parse_keyword(Keyword::CHARACTERISTICS) && modifier == Some(Keyword::SESSION)
4887        {
4888            self.expect_keywords(&[Keyword::AS, Keyword::TRANSACTION])?;
4889            Ok(Statement::SetTransaction {
4890                modes: self.parse_transaction_modes()?,
4891                snapshot: None,
4892                session: true,
4893            })
4894        } else if self.parse_keyword(Keyword::TRANSACTION) && modifier.is_none() {
4895            if self.parse_keyword(Keyword::SNAPSHOT) {
4896                let snapshot_id = self.ensure_parse_value()?;
4897                return Ok(Statement::SetTransaction {
4898                    modes: vec![],
4899                    snapshot: Some(snapshot_id),
4900                    session: false,
4901                });
4902            }
4903            Ok(Statement::SetTransaction {
4904                modes: self.parse_transaction_modes()?,
4905                snapshot: None,
4906                session: false,
4907            })
4908        } else {
4909            let config_param = self.parse_config_param()?;
4910            Ok(Statement::SetVariable {
4911                local: modifier == Some(Keyword::LOCAL),
4912                variable: config_param.param,
4913                value: config_param.value,
4914            })
4915        }
4916    }
4917
4918    /// If have `databases`,`tables`,`columns`,`schemas` and `materialized views` after show,
4919    /// return `Statement::ShowCommand` or `Statement::ShowColumn`,
4920    /// otherwise, return `Statement::ShowVariable`.
4921    pub fn parse_show(&mut self) -> ModalResult<Statement> {
4922        let checkpoint = *self;
4923        if let Token::Word(w) = self.next_token().token {
4924            match w.keyword {
4925                Keyword::TABLES => {
4926                    return Ok(Statement::ShowObjects {
4927                        object: ShowObject::Table {
4928                            schema: self.parse_from_and_identifier()?,
4929                        },
4930                        filter: self.parse_show_statement_filter()?,
4931                    });
4932                }
4933                Keyword::INTERNAL => {
4934                    self.expect_keyword(Keyword::TABLES)?;
4935                    return Ok(Statement::ShowObjects {
4936                        object: ShowObject::InternalTable {
4937                            schema: self.parse_from_and_identifier()?,
4938                        },
4939                        filter: self.parse_show_statement_filter()?,
4940                    });
4941                }
4942                Keyword::SOURCES => {
4943                    return Ok(Statement::ShowObjects {
4944                        object: ShowObject::Source {
4945                            schema: self.parse_from_and_identifier()?,
4946                        },
4947                        filter: self.parse_show_statement_filter()?,
4948                    });
4949                }
4950                Keyword::SINKS => {
4951                    return Ok(Statement::ShowObjects {
4952                        object: ShowObject::Sink {
4953                            schema: self.parse_from_and_identifier()?,
4954                        },
4955                        filter: self.parse_show_statement_filter()?,
4956                    });
4957                }
4958                Keyword::SUBSCRIPTIONS => {
4959                    return Ok(Statement::ShowObjects {
4960                        object: ShowObject::Subscription {
4961                            schema: self.parse_from_and_identifier()?,
4962                        },
4963                        filter: self.parse_show_statement_filter()?,
4964                    });
4965                }
4966                Keyword::DATABASES => {
4967                    return Ok(Statement::ShowObjects {
4968                        object: ShowObject::Database,
4969                        filter: self.parse_show_statement_filter()?,
4970                    });
4971                }
4972                Keyword::SCHEMAS => {
4973                    return Ok(Statement::ShowObjects {
4974                        object: ShowObject::Schema,
4975                        filter: self.parse_show_statement_filter()?,
4976                    });
4977                }
4978                Keyword::VIEWS => {
4979                    return Ok(Statement::ShowObjects {
4980                        object: ShowObject::View {
4981                            schema: self.parse_from_and_identifier()?,
4982                        },
4983                        filter: self.parse_show_statement_filter()?,
4984                    });
4985                }
4986                Keyword::MATERIALIZED => {
4987                    if self.parse_keyword(Keyword::VIEWS) {
4988                        return Ok(Statement::ShowObjects {
4989                            object: ShowObject::MaterializedView {
4990                                schema: self.parse_from_and_identifier()?,
4991                            },
4992                            filter: self.parse_show_statement_filter()?,
4993                        });
4994                    } else {
4995                        return self.expected("VIEWS after MATERIALIZED");
4996                    }
4997                }
4998                Keyword::COLUMNS => {
4999                    if self.parse_keyword(Keyword::FROM) {
5000                        return Ok(Statement::ShowObjects {
5001                            object: ShowObject::Columns {
5002                                table: self.parse_object_name()?,
5003                            },
5004                            filter: self.parse_show_statement_filter()?,
5005                        });
5006                    } else {
5007                        return self.expected("from after columns");
5008                    }
5009                }
5010                Keyword::SECRETS => {
5011                    return Ok(Statement::ShowObjects {
5012                        object: ShowObject::Secret {
5013                            schema: self.parse_from_and_identifier()?,
5014                        },
5015                        filter: self.parse_show_statement_filter()?,
5016                    });
5017                }
5018                Keyword::CONNECTIONS => {
5019                    return Ok(Statement::ShowObjects {
5020                        object: ShowObject::Connection {
5021                            schema: self.parse_from_and_identifier()?,
5022                        },
5023                        filter: self.parse_show_statement_filter()?,
5024                    });
5025                }
5026                Keyword::FUNCTIONS => {
5027                    return Ok(Statement::ShowObjects {
5028                        object: ShowObject::Function {
5029                            schema: self.parse_from_and_identifier()?,
5030                        },
5031                        filter: self.parse_show_statement_filter()?,
5032                    });
5033                }
5034                Keyword::INDEXES => {
5035                    if self.parse_keyword(Keyword::FROM) {
5036                        return Ok(Statement::ShowObjects {
5037                            object: ShowObject::Indexes {
5038                                table: self.parse_object_name()?,
5039                            },
5040                            filter: self.parse_show_statement_filter()?,
5041                        });
5042                    } else {
5043                        return self.expected("from after indexes");
5044                    }
5045                }
5046                Keyword::CLUSTER => {
5047                    return Ok(Statement::ShowObjects {
5048                        object: ShowObject::Cluster,
5049                        filter: self.parse_show_statement_filter()?,
5050                    });
5051                }
5052                Keyword::JOBS => {
5053                    return Ok(Statement::ShowObjects {
5054                        object: ShowObject::Jobs,
5055                        filter: self.parse_show_statement_filter()?,
5056                    });
5057                }
5058                Keyword::PROCESSLIST => {
5059                    return Ok(Statement::ShowObjects {
5060                        object: ShowObject::ProcessList,
5061                        filter: self.parse_show_statement_filter()?,
5062                    });
5063                }
5064                Keyword::TRANSACTION => {
5065                    self.expect_keywords(&[Keyword::ISOLATION, Keyword::LEVEL])?;
5066                    return Ok(Statement::ShowTransactionIsolationLevel);
5067                }
5068                Keyword::CURSORS => {
5069                    return Ok(Statement::ShowObjects {
5070                        object: ShowObject::Cursor,
5071                        filter: None,
5072                    });
5073                }
5074                Keyword::SUBSCRIPTION => {
5075                    self.expect_keyword(Keyword::CURSORS)?;
5076                    return Ok(Statement::ShowObjects {
5077                        object: ShowObject::SubscriptionCursor,
5078                        filter: None,
5079                    });
5080                }
5081                _ => {}
5082            }
5083        }
5084        *self = checkpoint;
5085        Ok(Statement::ShowVariable {
5086            variable: self.parse_identifiers()?,
5087        })
5088    }
5089
5090    pub fn parse_cancel_job(&mut self) -> ModalResult<Statement> {
5091        // CANCEL [JOBS|JOB] job_ids
5092        match self.peek_token().token {
5093            Token::Word(w) if Keyword::JOBS == w.keyword || Keyword::JOB == w.keyword => {
5094                self.next_token();
5095            }
5096            _ => return self.expected("JOBS or JOB after CANCEL"),
5097        }
5098
5099        let mut job_ids = vec![];
5100        loop {
5101            job_ids.push(self.parse_literal_u32()?);
5102            if !self.consume_token(&Token::Comma) {
5103                break;
5104            }
5105        }
5106        Ok(Statement::CancelJobs(JobIdents(job_ids)))
5107    }
5108
5109    pub fn parse_kill_process(&mut self) -> ModalResult<Statement> {
5110        let worker_process_id = self.parse_literal_string()?;
5111        Ok(Statement::Kill(worker_process_id))
5112    }
5113
5114    /// Parser `from schema` after `show tables` and `show materialized views`, if not conclude
5115    /// `from` then use default schema name.
5116    pub fn parse_from_and_identifier(&mut self) -> ModalResult<Option<Ident>> {
5117        if self.parse_keyword(Keyword::FROM) {
5118            Ok(Some(self.parse_identifier_non_reserved()?))
5119        } else {
5120            Ok(None)
5121        }
5122    }
5123
5124    /// Parse object type and name after `show create`.
5125    pub fn parse_show_create(&mut self) -> ModalResult<Statement> {
5126        if let Token::Word(w) = self.next_token().token {
5127            let show_type = match w.keyword {
5128                Keyword::TABLE => ShowCreateType::Table,
5129                Keyword::MATERIALIZED => {
5130                    if self.parse_keyword(Keyword::VIEW) {
5131                        ShowCreateType::MaterializedView
5132                    } else {
5133                        return self.expected("VIEW after MATERIALIZED");
5134                    }
5135                }
5136                Keyword::VIEW => ShowCreateType::View,
5137                Keyword::INDEX => ShowCreateType::Index,
5138                Keyword::SOURCE => ShowCreateType::Source,
5139                Keyword::SINK => ShowCreateType::Sink,
5140                Keyword::SUBSCRIPTION => ShowCreateType::Subscription,
5141                Keyword::FUNCTION => ShowCreateType::Function,
5142                _ => return self.expected(
5143                    "TABLE, MATERIALIZED VIEW, VIEW, INDEX, FUNCTION, SOURCE, SUBSCRIPTION or SINK",
5144                ),
5145            };
5146            return Ok(Statement::ShowCreateObject {
5147                create_type: show_type,
5148                name: self.parse_object_name()?,
5149            });
5150        }
5151        self.expected(
5152            "TABLE, MATERIALIZED VIEW, VIEW, INDEX, FUNCTION, SOURCE, SUBSCRIPTION or SINK",
5153        )
5154    }
5155
5156    pub fn parse_show_statement_filter(&mut self) -> ModalResult<Option<ShowStatementFilter>> {
5157        if self.parse_keyword(Keyword::LIKE) {
5158            Ok(Some(ShowStatementFilter::Like(
5159                self.parse_literal_string()?,
5160            )))
5161        } else if self.parse_keyword(Keyword::ILIKE) {
5162            Ok(Some(ShowStatementFilter::ILike(
5163                self.parse_literal_string()?,
5164            )))
5165        } else if self.parse_keyword(Keyword::WHERE) {
5166            Ok(Some(ShowStatementFilter::Where(self.parse_expr()?)))
5167        } else {
5168            Ok(None)
5169        }
5170    }
5171
5172    pub fn parse_table_and_joins(&mut self) -> ModalResult<TableWithJoins> {
5173        let relation = self.parse_table_factor()?;
5174
5175        // Note that for keywords to be properly handled here, they need to be
5176        // added to `RESERVED_FOR_TABLE_ALIAS`, otherwise they may be parsed as
5177        // a table alias.
5178        let mut joins = vec![];
5179        loop {
5180            let join = if self.parse_keyword(Keyword::CROSS) {
5181                let join_operator = if self.parse_keyword(Keyword::JOIN) {
5182                    JoinOperator::CrossJoin
5183                } else {
5184                    return self.expected("JOIN after CROSS");
5185                };
5186                Join {
5187                    relation: self.parse_table_factor()?,
5188                    join_operator,
5189                }
5190            } else {
5191                let (natural, asof) =
5192                    match self.parse_one_of_keywords(&[Keyword::NATURAL, Keyword::ASOF]) {
5193                        Some(Keyword::NATURAL) => (true, false),
5194                        Some(Keyword::ASOF) => (false, true),
5195                        Some(_) => unreachable!(),
5196                        None => (false, false),
5197                    };
5198                let peek_keyword = if let Token::Word(w) = self.peek_token().token {
5199                    w.keyword
5200                } else {
5201                    Keyword::NoKeyword
5202                };
5203
5204                let join_operator_type = match peek_keyword {
5205                    Keyword::INNER | Keyword::JOIN => {
5206                        let _ = self.parse_keyword(Keyword::INNER);
5207                        self.expect_keyword(Keyword::JOIN)?;
5208                        if asof {
5209                            JoinOperator::AsOfInner
5210                        } else {
5211                            JoinOperator::Inner
5212                        }
5213                    }
5214                    kw @ Keyword::LEFT | kw @ Keyword::RIGHT | kw @ Keyword::FULL => {
5215                        let checkpoint = *self;
5216                        let _ = self.next_token();
5217                        let _ = self.parse_keyword(Keyword::OUTER);
5218                        self.expect_keyword(Keyword::JOIN)?;
5219                        if asof {
5220                            if Keyword::LEFT == kw {
5221                                JoinOperator::AsOfLeft
5222                            } else {
5223                                return self.expected_at(
5224                                    checkpoint,
5225                                    "LEFT after ASOF. RIGHT or FULL are not supported",
5226                                );
5227                            }
5228                        } else {
5229                            match kw {
5230                                Keyword::LEFT => JoinOperator::LeftOuter,
5231                                Keyword::RIGHT => JoinOperator::RightOuter,
5232                                Keyword::FULL => JoinOperator::FullOuter,
5233                                _ => unreachable!(),
5234                            }
5235                        }
5236                    }
5237                    Keyword::OUTER => {
5238                        return self.expected("LEFT, RIGHT, or FULL");
5239                    }
5240                    _ if natural => {
5241                        return self.expected("a join type after NATURAL");
5242                    }
5243                    _ if asof => {
5244                        return self.expected("a join type after ASOF");
5245                    }
5246                    _ => break,
5247                };
5248                let relation = self.parse_table_factor()?;
5249                let join_constraint = self.parse_join_constraint(natural)?;
5250                let join_operator = join_operator_type(join_constraint);
5251                let need_constraint = match join_operator {
5252                    JoinOperator::Inner(JoinConstraint::None) => Some("INNER JOIN"),
5253                    JoinOperator::AsOfInner(JoinConstraint::None) => Some("ASOF INNER JOIN"),
5254                    JoinOperator::AsOfLeft(JoinConstraint::None) => Some("ASOF LEFT JOIN"),
5255                    _ => None,
5256                };
5257                if let Some(join_type) = need_constraint {
5258                    return self.expected(&format!("join constraint after {join_type}"));
5259                }
5260
5261                Join {
5262                    relation,
5263                    join_operator,
5264                }
5265            };
5266            joins.push(join);
5267        }
5268        Ok(TableWithJoins { relation, joins })
5269    }
5270
5271    /// A table name or a parenthesized subquery, followed by optional `[AS] alias`
5272    pub fn parse_table_factor(&mut self) -> ModalResult<TableFactor> {
5273        if self.parse_keyword(Keyword::LATERAL) {
5274            // LATERAL must always be followed by a subquery.
5275            if !self.consume_token(&Token::LParen) {
5276                self.expected("subquery after LATERAL")?;
5277            }
5278            self.parse_derived_table_factor(Lateral)
5279        } else if self.consume_token(&Token::LParen) {
5280            // A left paren introduces either a derived table (i.e., a subquery)
5281            // or a nested join. It's nearly impossible to determine ahead of
5282            // time which it is... so we just try to parse both.
5283            //
5284            // Here's an example that demonstrates the complexity:
5285            //                     /-------------------------------------------------------\
5286            //                     | /-----------------------------------\                 |
5287            //     SELECT * FROM ( ( ( (SELECT 1) UNION (SELECT 2) ) AS t1 NATURAL JOIN t2 ) )
5288            //                   ^ ^ ^ ^
5289            //                   | | | |
5290            //                   | | | |
5291            //                   | | | (4) belongs to a SetExpr::Query inside the subquery
5292            //                   | | (3) starts a derived table (subquery)
5293            //                   | (2) starts a nested join
5294            //                   (1) an additional set of parens around a nested join
5295            //
5296
5297            // It can only be a subquery. We don't use `maybe_parse` so that a meaningful error can
5298            // be returned.
5299            match self.peek_token().token {
5300                Token::Word(w)
5301                    if [Keyword::SELECT, Keyword::WITH, Keyword::VALUES].contains(&w.keyword) =>
5302                {
5303                    return self.parse_derived_table_factor(NotLateral);
5304                }
5305                _ => {}
5306            };
5307            // It can still be a subquery, e.g., the case (3) in the example above:
5308            // (SELECT 1) UNION (SELECT 2)
5309            // TODO: how to produce a good error message here?
5310            if self.peek_token() == Token::LParen {
5311                return_ok_if_some!(
5312                    self.maybe_parse(|parser| parser.parse_derived_table_factor(NotLateral))
5313                );
5314            }
5315
5316            // A parsing error from `parse_derived_table_factor` indicates that the '(' we've
5317            // recently consumed does not start a derived table (cases 1, 2, or 4).
5318            // `maybe_parse` will ignore such an error and rewind to be after the opening '('.
5319
5320            // Inside the parentheses we expect to find an (A) table factor
5321            // followed by some joins or (B) another level of nesting.
5322            let table_and_joins = self.parse_table_and_joins()?;
5323
5324            #[allow(clippy::if_same_then_else)]
5325            if !table_and_joins.joins.is_empty() {
5326                self.expect_token(&Token::RParen)?;
5327                Ok(TableFactor::NestedJoin(Box::new(table_and_joins))) // (A)
5328            } else if let TableFactor::NestedJoin(_) = &table_and_joins.relation {
5329                // (B): `table_and_joins` (what we found inside the parentheses)
5330                // is a nested join `(foo JOIN bar)`, not followed by other joins.
5331                self.expect_token(&Token::RParen)?;
5332                Ok(TableFactor::NestedJoin(Box::new(table_and_joins)))
5333            } else {
5334                // The SQL spec prohibits derived tables and bare tables from
5335                // appearing alone in parentheses (e.g. `FROM (mytable)`)
5336                parser_err!(
5337                    "Expected joined table, found: {table_and_joins}, next_token: {}",
5338                    self.peek_token()
5339                );
5340            }
5341        } else {
5342            let name = self.parse_object_name()?;
5343            if self.peek_token() == Token::LParen {
5344                // table-valued function
5345
5346                let arg_list = self.parse_argument_list()?;
5347                if arg_list.distinct {
5348                    parser_err!("DISTINCT is not supported in table-valued function calls");
5349                }
5350                if !arg_list.order_by.is_empty() {
5351                    parser_err!("ORDER BY is not supported in table-valued function calls");
5352                }
5353                if arg_list.ignore_nulls {
5354                    parser_err!("IGNORE NULLS is not supported in table-valued function calls");
5355                }
5356
5357                let args = arg_list.args;
5358                let with_ordinality = self.parse_keywords(&[Keyword::WITH, Keyword::ORDINALITY]);
5359                let alias = self.parse_optional_table_alias(keywords::RESERVED_FOR_TABLE_ALIAS)?;
5360
5361                Ok(TableFactor::TableFunction {
5362                    name,
5363                    alias,
5364                    args,
5365                    with_ordinality,
5366                })
5367            } else {
5368                let as_of = opt(Self::parse_as_of).parse_next(self)?;
5369                let alias = self.parse_optional_table_alias(keywords::RESERVED_FOR_TABLE_ALIAS)?;
5370                Ok(TableFactor::Table { name, alias, as_of })
5371            }
5372        }
5373    }
5374
5375    pub fn parse_derived_table_factor(&mut self, lateral: IsLateral) -> ModalResult<TableFactor> {
5376        let subquery = Box::new(self.parse_query()?);
5377        self.expect_token(&Token::RParen)?;
5378        let alias = self.parse_optional_table_alias(keywords::RESERVED_FOR_TABLE_ALIAS)?;
5379        Ok(TableFactor::Derived {
5380            lateral: match lateral {
5381                Lateral => true,
5382                NotLateral => false,
5383            },
5384            subquery,
5385            alias,
5386        })
5387    }
5388
5389    fn parse_join_constraint(&mut self, natural: bool) -> ModalResult<JoinConstraint> {
5390        if natural {
5391            Ok(JoinConstraint::Natural)
5392        } else if self.parse_keyword(Keyword::ON) {
5393            let constraint = self.parse_expr()?;
5394            Ok(JoinConstraint::On(constraint))
5395        } else if self.parse_keyword(Keyword::USING) {
5396            let columns = self.parse_parenthesized_column_list(Mandatory)?;
5397            Ok(JoinConstraint::Using(columns))
5398        } else {
5399            Ok(JoinConstraint::None)
5400            // self.expected("ON, or USING after JOIN")
5401        }
5402    }
5403
5404    /// Parse a GRANT statement.
5405    pub fn parse_grant(&mut self) -> ModalResult<Statement> {
5406        let (privileges, objects) = self.parse_grant_revoke_privileges_objects()?;
5407
5408        self.expect_keyword(Keyword::TO)?;
5409        let grantees = self.parse_comma_separated(Parser::parse_identifier)?;
5410
5411        let with_grant_option =
5412            self.parse_keywords(&[Keyword::WITH, Keyword::GRANT, Keyword::OPTION]);
5413
5414        let granted_by = self
5415            .parse_keywords(&[Keyword::GRANTED, Keyword::BY])
5416            .then(|| self.parse_identifier().unwrap());
5417
5418        Ok(Statement::Grant {
5419            privileges,
5420            objects,
5421            grantees,
5422            with_grant_option,
5423            granted_by,
5424        })
5425    }
5426
5427    fn parse_privileges(&mut self) -> ModalResult<Privileges> {
5428        let privileges = if self.parse_keyword(Keyword::ALL) {
5429            Privileges::All {
5430                with_privileges_keyword: self.parse_keyword(Keyword::PRIVILEGES),
5431            }
5432        } else {
5433            Privileges::Actions(
5434                self.parse_comma_separated(Parser::parse_grant_permission)?
5435                    .into_iter()
5436                    .map(|(kw, columns)| match kw {
5437                        Keyword::CONNECT => Action::Connect,
5438                        Keyword::CREATE => Action::Create,
5439                        Keyword::DELETE => Action::Delete,
5440                        Keyword::EXECUTE => Action::Execute,
5441                        Keyword::INSERT => Action::Insert { columns },
5442                        Keyword::REFERENCES => Action::References { columns },
5443                        Keyword::SELECT => Action::Select { columns },
5444                        Keyword::TEMPORARY => Action::Temporary,
5445                        Keyword::TRIGGER => Action::Trigger,
5446                        Keyword::TRUNCATE => Action::Truncate,
5447                        Keyword::UPDATE => Action::Update { columns },
5448                        Keyword::USAGE => Action::Usage,
5449                        _ => unreachable!(),
5450                    })
5451                    .collect(),
5452            )
5453        };
5454
5455        Ok(privileges)
5456    }
5457
5458    fn parse_grant_revoke_privileges_objects(&mut self) -> ModalResult<(Privileges, GrantObjects)> {
5459        let privileges = self.parse_privileges()?;
5460
5461        self.expect_keyword(Keyword::ON)?;
5462
5463        let objects = if self.parse_keywords(&[
5464            Keyword::ALL,
5465            Keyword::TABLES,
5466            Keyword::IN,
5467            Keyword::SCHEMA,
5468        ]) {
5469            GrantObjects::AllTablesInSchema {
5470                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5471            }
5472        } else if self.parse_keywords(&[
5473            Keyword::ALL,
5474            Keyword::SEQUENCES,
5475            Keyword::IN,
5476            Keyword::SCHEMA,
5477        ]) {
5478            GrantObjects::AllSequencesInSchema {
5479                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5480            }
5481        } else if self.parse_keywords(&[
5482            Keyword::ALL,
5483            Keyword::SOURCES,
5484            Keyword::IN,
5485            Keyword::SCHEMA,
5486        ]) {
5487            GrantObjects::AllSourcesInSchema {
5488                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5489            }
5490        } else if self.parse_keywords(&[Keyword::ALL, Keyword::SINKS, Keyword::IN, Keyword::SCHEMA])
5491        {
5492            GrantObjects::AllSinksInSchema {
5493                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5494            }
5495        } else if self.parse_keywords(&[
5496            Keyword::ALL,
5497            Keyword::MATERIALIZED,
5498            Keyword::VIEWS,
5499            Keyword::IN,
5500            Keyword::SCHEMA,
5501        ]) {
5502            GrantObjects::AllMviewsInSchema {
5503                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5504            }
5505        } else if self.parse_keywords(&[Keyword::ALL, Keyword::VIEWS, Keyword::IN, Keyword::SCHEMA])
5506        {
5507            GrantObjects::AllViewsInSchema {
5508                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5509            }
5510        } else if self.parse_keywords(&[
5511            Keyword::ALL,
5512            Keyword::FUNCTIONS,
5513            Keyword::IN,
5514            Keyword::SCHEMA,
5515        ]) {
5516            GrantObjects::AllFunctionsInSchema {
5517                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5518            }
5519        } else if self.parse_keywords(&[
5520            Keyword::ALL,
5521            Keyword::SECRETS,
5522            Keyword::IN,
5523            Keyword::SCHEMA,
5524        ]) {
5525            GrantObjects::AllSecretsInSchema {
5526                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5527            }
5528        } else if self.parse_keywords(&[
5529            Keyword::ALL,
5530            Keyword::CONNECTIONS,
5531            Keyword::IN,
5532            Keyword::SCHEMA,
5533        ]) {
5534            GrantObjects::AllConnectionsInSchema {
5535                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5536            }
5537        } else if self.parse_keywords(&[
5538            Keyword::ALL,
5539            Keyword::SUBSCRIPTIONS,
5540            Keyword::IN,
5541            Keyword::SCHEMA,
5542        ]) {
5543            GrantObjects::AllSubscriptionsInSchema {
5544                schemas: self.parse_comma_separated(Parser::parse_object_name)?,
5545            }
5546        } else if self.parse_keywords(&[Keyword::MATERIALIZED, Keyword::VIEW]) {
5547            GrantObjects::Mviews(self.parse_comma_separated(Parser::parse_object_name)?)
5548        } else {
5549            let object_type = self.parse_one_of_keywords(&[
5550                Keyword::SEQUENCE,
5551                Keyword::DATABASE,
5552                Keyword::SCHEMA,
5553                Keyword::TABLE,
5554                Keyword::SOURCE,
5555                Keyword::SINK,
5556                Keyword::VIEW,
5557                Keyword::SUBSCRIPTION,
5558                Keyword::FUNCTION,
5559                Keyword::CONNECTION,
5560                Keyword::SECRET,
5561            ]);
5562            if let Some(Keyword::FUNCTION) = object_type {
5563                let func_descs = self.parse_comma_separated(Parser::parse_function_desc)?;
5564                GrantObjects::Functions(func_descs)
5565            } else {
5566                let objects = self.parse_comma_separated(Parser::parse_object_name);
5567                match object_type {
5568                    Some(Keyword::DATABASE) => GrantObjects::Databases(objects?),
5569                    Some(Keyword::SCHEMA) => GrantObjects::Schemas(objects?),
5570                    Some(Keyword::SEQUENCE) => GrantObjects::Sequences(objects?),
5571                    Some(Keyword::SOURCE) => GrantObjects::Sources(objects?),
5572                    Some(Keyword::SINK) => GrantObjects::Sinks(objects?),
5573                    Some(Keyword::VIEW) => GrantObjects::Views(objects?),
5574                    Some(Keyword::SUBSCRIPTION) => GrantObjects::Subscriptions(objects?),
5575                    Some(Keyword::CONNECTION) => GrantObjects::Connections(objects?),
5576                    Some(Keyword::SECRET) => GrantObjects::Secrets(objects?),
5577                    Some(Keyword::TABLE) | None => GrantObjects::Tables(objects?),
5578                    _ => unreachable!(),
5579                }
5580            }
5581        };
5582
5583        Ok((privileges, objects))
5584    }
5585
5586    fn parse_grant_permission(&mut self) -> ModalResult<(Keyword, Option<Vec<Ident>>)> {
5587        let kw = self.expect_one_of_keywords(&[
5588            Keyword::CONNECT,
5589            Keyword::CREATE,
5590            Keyword::DELETE,
5591            Keyword::EXECUTE,
5592            Keyword::INSERT,
5593            Keyword::REFERENCES,
5594            Keyword::SELECT,
5595            Keyword::TEMPORARY,
5596            Keyword::TRIGGER,
5597            Keyword::TRUNCATE,
5598            Keyword::UPDATE,
5599            Keyword::USAGE,
5600        ])?;
5601        let columns = match kw {
5602            Keyword::INSERT | Keyword::REFERENCES | Keyword::SELECT | Keyword::UPDATE => {
5603                let columns = self.parse_parenthesized_column_list(Optional)?;
5604                if columns.is_empty() {
5605                    None
5606                } else {
5607                    Some(columns)
5608                }
5609            }
5610            _ => None,
5611        };
5612        Ok((kw, columns))
5613    }
5614
5615    /// Parse a REVOKE statement
5616    pub fn parse_revoke(&mut self) -> ModalResult<Statement> {
5617        let revoke_grant_option =
5618            self.parse_keywords(&[Keyword::GRANT, Keyword::OPTION, Keyword::FOR]);
5619        let (privileges, objects) = self.parse_grant_revoke_privileges_objects()?;
5620
5621        self.expect_keyword(Keyword::FROM)?;
5622        let grantees = self.parse_comma_separated(Parser::parse_identifier)?;
5623
5624        let granted_by = self
5625            .parse_keywords(&[Keyword::GRANTED, Keyword::BY])
5626            .then(|| self.parse_identifier().unwrap());
5627
5628        let cascade = self.parse_keyword(Keyword::CASCADE);
5629        let restrict = self.parse_keyword(Keyword::RESTRICT);
5630        if cascade && restrict {
5631            parser_err!("Cannot specify both CASCADE and RESTRICT in REVOKE");
5632        }
5633
5634        Ok(Statement::Revoke {
5635            privileges,
5636            objects,
5637            grantees,
5638            granted_by,
5639            revoke_grant_option,
5640            cascade,
5641        })
5642    }
5643
5644    fn parse_privilege_object_types(&mut self) -> ModalResult<PrivilegeObjectType> {
5645        let object_type = if self.parse_keyword(Keyword::TABLES) {
5646            PrivilegeObjectType::Tables
5647        } else if self.parse_keyword(Keyword::SOURCES) {
5648            PrivilegeObjectType::Sources
5649        } else if self.parse_keyword(Keyword::SINKS) {
5650            PrivilegeObjectType::Sinks
5651        } else if self.parse_keywords(&[Keyword::MATERIALIZED, Keyword::VIEWS]) {
5652            PrivilegeObjectType::Mviews
5653        } else if self.parse_keyword(Keyword::VIEWS) {
5654            PrivilegeObjectType::Views
5655        } else if self.parse_keyword(Keyword::FUNCTIONS) {
5656            PrivilegeObjectType::Functions
5657        } else if self.parse_keyword(Keyword::SECRETS) {
5658            PrivilegeObjectType::Secrets
5659        } else if self.parse_keyword(Keyword::CONNECTIONS) {
5660            PrivilegeObjectType::Connections
5661        } else if self.parse_keyword(Keyword::SUBSCRIPTIONS) {
5662            PrivilegeObjectType::Subscriptions
5663        } else if self.parse_keyword(Keyword::SCHEMAS) {
5664            PrivilegeObjectType::Schemas
5665        } else {
5666            return self.expected("TABLES, SOURCES, SINKS, MATERIALIZED VIEWS, VIEWS, FUNCTIONS, SECRETS, CONNECTIONS, SUBSCRIPTIONS or SCHEMAS");
5667        };
5668
5669        Ok(object_type)
5670    }
5671
5672    pub fn parse_alter_default_privileges(&mut self) -> ModalResult<Statement> {
5673        // [ FOR USER target_user [, ...] ]
5674        let target_users = if self.parse_keyword(Keyword::FOR) {
5675            self.expect_keyword(Keyword::USER)?;
5676            Some(self.parse_comma_separated(Parser::parse_identifier)?)
5677        } else {
5678            None
5679        };
5680
5681        // [ IN SCHEMA schema_name [, ...] ]
5682        let schema_names = if self.parse_keywords(&[Keyword::IN, Keyword::SCHEMA]) {
5683            Some(self.parse_comma_separated(Parser::parse_object_name)?)
5684        } else {
5685            None
5686        };
5687        let keyword = self.expect_one_of_keywords(&[Keyword::GRANT, Keyword::REVOKE])?;
5688        let for_grant = keyword == Keyword::GRANT;
5689        if for_grant {
5690            let privileges = self.parse_privileges()?;
5691            self.expect_keyword(Keyword::ON)?;
5692            let object_type = self.parse_privilege_object_types()?;
5693            if schema_names.is_some() && object_type == PrivilegeObjectType::Schemas {
5694                parser_err!("cannot use IN SCHEMA clause when using GRANT/REVOKE ON SCHEMAS");
5695            }
5696            self.expect_keyword(Keyword::TO)?;
5697            let grantees = self.parse_comma_separated(Parser::parse_identifier)?;
5698
5699            let with_grant_option =
5700                self.parse_keywords(&[Keyword::WITH, Keyword::GRANT, Keyword::OPTION]);
5701
5702            Ok(Statement::AlterDefaultPrivileges {
5703                target_users,
5704                schema_names,
5705                operation: DefaultPrivilegeOperation::Grant {
5706                    privileges,
5707                    object_type,
5708                    grantees,
5709                    with_grant_option,
5710                },
5711            })
5712        } else {
5713            let revoke_grant_option =
5714                self.parse_keywords(&[Keyword::GRANT, Keyword::OPTION, Keyword::FOR]);
5715            let privileges = self.parse_privileges()?;
5716            self.expect_keyword(Keyword::ON)?;
5717            let object_type = self.parse_privilege_object_types()?;
5718            if schema_names.is_some() && object_type == PrivilegeObjectType::Schemas {
5719                parser_err!("cannot use IN SCHEMA clause when using GRANT/REVOKE ON SCHEMAS");
5720            }
5721            self.expect_keyword(Keyword::FROM)?;
5722            let grantees = self.parse_comma_separated(Parser::parse_identifier)?;
5723            let cascade = self.parse_keyword(Keyword::CASCADE);
5724            let restrict = self.parse_keyword(Keyword::RESTRICT);
5725            if cascade && restrict {
5726                parser_err!("Cannot specify both CASCADE and RESTRICT in REVOKE");
5727            }
5728
5729            Ok(Statement::AlterDefaultPrivileges {
5730                target_users,
5731                schema_names,
5732                operation: DefaultPrivilegeOperation::Revoke {
5733                    privileges,
5734                    object_type,
5735                    grantees,
5736                    revoke_grant_option,
5737                    cascade,
5738                },
5739            })
5740        }
5741    }
5742
5743    /// Parse an INSERT statement
5744    pub fn parse_insert(&mut self) -> ModalResult<Statement> {
5745        self.expect_keyword(Keyword::INTO)?;
5746
5747        let table_name = self.parse_object_name()?;
5748        let columns = self.parse_parenthesized_column_list(Optional)?;
5749
5750        let source = Box::new(self.parse_query()?);
5751        let returning = self.parse_returning(Optional)?;
5752        Ok(Statement::Insert {
5753            table_name,
5754            columns,
5755            source,
5756            returning,
5757        })
5758    }
5759
5760    pub fn parse_update(&mut self) -> ModalResult<Statement> {
5761        let table_name = self.parse_object_name()?;
5762
5763        self.expect_keyword(Keyword::SET)?;
5764        let assignments = self.parse_comma_separated(Parser::parse_assignment)?;
5765        let selection = if self.parse_keyword(Keyword::WHERE) {
5766            Some(self.parse_expr()?)
5767        } else {
5768            None
5769        };
5770        let returning = self.parse_returning(Optional)?;
5771        Ok(Statement::Update {
5772            table_name,
5773            assignments,
5774            selection,
5775            returning,
5776        })
5777    }
5778
5779    /// Parse a `var = expr` assignment, used in an UPDATE statement
5780    pub fn parse_assignment(&mut self) -> ModalResult<Assignment> {
5781        let id = self.parse_identifiers_non_keywords()?;
5782        self.expect_token(&Token::Eq)?;
5783
5784        let value = if self.parse_keyword(Keyword::DEFAULT) {
5785            AssignmentValue::Default
5786        } else {
5787            AssignmentValue::Expr(self.parse_expr()?)
5788        };
5789
5790        Ok(Assignment { id, value })
5791    }
5792
5793    /// Parse a `[VARIADIC] name => expr`.
5794    fn parse_function_args(&mut self) -> ModalResult<(bool, FunctionArg)> {
5795        let variadic = self.parse_keyword(Keyword::VARIADIC);
5796        let arg = if self.peek_nth_token(1) == Token::RArrow {
5797            let name = self.parse_identifier()?;
5798
5799            self.expect_token(&Token::RArrow)?;
5800            let arg = self.parse_wildcard_or_expr()?.into();
5801
5802            FunctionArg::Named { name, arg }
5803        } else {
5804            FunctionArg::Unnamed(self.parse_wildcard_or_expr()?.into())
5805        };
5806        Ok((variadic, arg))
5807    }
5808
5809    pub fn parse_argument_list(&mut self) -> ModalResult<FunctionArgList> {
5810        self.expect_token(&Token::LParen)?;
5811        if self.consume_token(&Token::RParen) {
5812            Ok(FunctionArgList::empty())
5813        } else {
5814            let distinct = self.parse_all_or_distinct()?;
5815            let args = self.parse_comma_separated(Parser::parse_function_args)?;
5816            if args
5817                .iter()
5818                .take(args.len() - 1)
5819                .any(|(variadic, _)| *variadic)
5820            {
5821                parser_err!("VARIADIC argument must be the last");
5822            }
5823            let variadic = args.last().map(|(variadic, _)| *variadic).unwrap_or(false);
5824            let args = args.into_iter().map(|(_, arg)| arg).collect();
5825
5826            let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
5827                self.parse_comma_separated(Parser::parse_order_by_expr)?
5828            } else {
5829                vec![]
5830            };
5831
5832            let ignore_nulls = self.parse_keywords(&[Keyword::IGNORE, Keyword::NULLS]);
5833
5834            let arg_list = FunctionArgList {
5835                distinct,
5836                args,
5837                variadic,
5838                order_by,
5839                ignore_nulls,
5840            };
5841
5842            self.expect_token(&Token::RParen)?;
5843            Ok(arg_list)
5844        }
5845    }
5846
5847    /// Parse a comma-delimited list of projections after SELECT
5848    pub fn parse_select_item(&mut self) -> ModalResult<SelectItem> {
5849        match self.parse_wildcard_or_expr()? {
5850            WildcardOrExpr::Expr(expr) => self
5851                .parse_optional_alias(keywords::RESERVED_FOR_COLUMN_ALIAS)
5852                .map(|alias| match alias {
5853                    Some(alias) => SelectItem::ExprWithAlias { expr, alias },
5854                    None => SelectItem::UnnamedExpr(expr),
5855                }),
5856            WildcardOrExpr::QualifiedWildcard(prefix, except) => {
5857                Ok(SelectItem::QualifiedWildcard(prefix, except))
5858            }
5859            WildcardOrExpr::ExprQualifiedWildcard(expr, prefix) => {
5860                Ok(SelectItem::ExprQualifiedWildcard(expr, prefix))
5861            }
5862            WildcardOrExpr::Wildcard(except) => Ok(SelectItem::Wildcard(except)),
5863        }
5864    }
5865
5866    /// Parse an expression, optionally followed by ASC or DESC (used in ORDER BY)
5867    pub fn parse_order_by_expr(&mut self) -> ModalResult<OrderByExpr> {
5868        let expr = self.parse_expr()?;
5869
5870        let asc = if self.parse_keyword(Keyword::ASC) {
5871            Some(true)
5872        } else if self.parse_keyword(Keyword::DESC) {
5873            Some(false)
5874        } else {
5875            None
5876        };
5877
5878        let nulls_first = if self.parse_keywords(&[Keyword::NULLS, Keyword::FIRST]) {
5879            Some(true)
5880        } else if self.parse_keywords(&[Keyword::NULLS, Keyword::LAST]) {
5881            Some(false)
5882        } else {
5883            None
5884        };
5885
5886        Ok(OrderByExpr {
5887            expr,
5888            asc,
5889            nulls_first,
5890        })
5891    }
5892
5893    /// Parse a LIMIT clause
5894    pub fn parse_limit(&mut self) -> ModalResult<Option<Expr>> {
5895        if self.parse_keyword(Keyword::ALL) {
5896            Ok(None)
5897        } else {
5898            let expr = self.parse_expr()?;
5899            Ok(Some(expr))
5900        }
5901    }
5902
5903    /// Parse an OFFSET clause
5904    pub fn parse_offset(&mut self) -> ModalResult<String> {
5905        let value = self.parse_number_value()?;
5906        // TODO(Kexiang): support LIMIT expr
5907        if self.consume_token(&Token::DoubleColon) {
5908            self.expect_keyword(Keyword::BIGINT)?;
5909        }
5910        _ = self.parse_one_of_keywords(&[Keyword::ROW, Keyword::ROWS]);
5911        Ok(value)
5912    }
5913
5914    /// Parse a FETCH clause
5915    pub fn parse_fetch(&mut self) -> ModalResult<Fetch> {
5916        self.expect_one_of_keywords(&[Keyword::FIRST, Keyword::NEXT])?;
5917        let quantity = if self
5918            .parse_one_of_keywords(&[Keyword::ROW, Keyword::ROWS])
5919            .is_some()
5920        {
5921            None
5922        } else {
5923            let quantity = self.parse_number_value()?;
5924            self.expect_one_of_keywords(&[Keyword::ROW, Keyword::ROWS])?;
5925            Some(quantity)
5926        };
5927        let with_ties = if self.parse_keyword(Keyword::ONLY) {
5928            false
5929        } else if self.parse_keywords(&[Keyword::WITH, Keyword::TIES]) {
5930            true
5931        } else {
5932            return self.expected("one of ONLY or WITH TIES");
5933        };
5934        Ok(Fetch {
5935            with_ties,
5936            quantity,
5937        })
5938    }
5939
5940    pub fn parse_values(&mut self) -> ModalResult<Values> {
5941        let values = self.parse_comma_separated(|parser| {
5942            parser.expect_token(&Token::LParen)?;
5943            let exprs = parser.parse_comma_separated(Parser::parse_expr)?;
5944            parser.expect_token(&Token::RParen)?;
5945            Ok(exprs)
5946        })?;
5947        Ok(Values(values))
5948    }
5949
5950    pub fn parse_start_transaction(&mut self) -> ModalResult<Statement> {
5951        self.expect_keyword(Keyword::TRANSACTION)?;
5952        Ok(Statement::StartTransaction {
5953            modes: self.parse_transaction_modes()?,
5954        })
5955    }
5956
5957    pub fn parse_begin(&mut self) -> ModalResult<Statement> {
5958        let _ = self.parse_one_of_keywords(&[Keyword::TRANSACTION, Keyword::WORK]);
5959        Ok(Statement::Begin {
5960            modes: self.parse_transaction_modes()?,
5961        })
5962    }
5963
5964    pub fn parse_transaction_modes(&mut self) -> ModalResult<Vec<TransactionMode>> {
5965        let mut modes = vec![];
5966        let mut required = false;
5967        loop {
5968            let mode = if self.parse_keywords(&[Keyword::ISOLATION, Keyword::LEVEL]) {
5969                let iso_level = if self.parse_keywords(&[Keyword::READ, Keyword::UNCOMMITTED]) {
5970                    TransactionIsolationLevel::ReadUncommitted
5971                } else if self.parse_keywords(&[Keyword::READ, Keyword::COMMITTED]) {
5972                    TransactionIsolationLevel::ReadCommitted
5973                } else if self.parse_keywords(&[Keyword::REPEATABLE, Keyword::READ]) {
5974                    TransactionIsolationLevel::RepeatableRead
5975                } else if self.parse_keyword(Keyword::SERIALIZABLE) {
5976                    TransactionIsolationLevel::Serializable
5977                } else {
5978                    self.expected("isolation level")?
5979                };
5980                TransactionMode::IsolationLevel(iso_level)
5981            } else if self.parse_keywords(&[Keyword::READ, Keyword::ONLY]) {
5982                TransactionMode::AccessMode(TransactionAccessMode::ReadOnly)
5983            } else if self.parse_keywords(&[Keyword::READ, Keyword::WRITE]) {
5984                TransactionMode::AccessMode(TransactionAccessMode::ReadWrite)
5985            } else if required {
5986                self.expected("transaction mode")?
5987            } else {
5988                break;
5989            };
5990            modes.push(mode);
5991            // ANSI requires a comma after each transaction mode, but
5992            // PostgreSQL, for historical reasons, does not. We follow
5993            // PostgreSQL in making the comma optional, since that is strictly
5994            // more general.
5995            required = self.consume_token(&Token::Comma);
5996        }
5997        Ok(modes)
5998    }
5999
6000    pub fn parse_commit(&mut self) -> ModalResult<Statement> {
6001        Ok(Statement::Commit {
6002            chain: self.parse_commit_rollback_chain()?,
6003        })
6004    }
6005
6006    pub fn parse_rollback(&mut self) -> ModalResult<Statement> {
6007        Ok(Statement::Rollback {
6008            chain: self.parse_commit_rollback_chain()?,
6009        })
6010    }
6011
6012    pub fn parse_commit_rollback_chain(&mut self) -> ModalResult<bool> {
6013        let _ = self.parse_one_of_keywords(&[Keyword::TRANSACTION, Keyword::WORK]);
6014        if self.parse_keyword(Keyword::AND) {
6015            let chain = !self.parse_keyword(Keyword::NO);
6016            self.expect_keyword(Keyword::CHAIN)?;
6017            Ok(chain)
6018        } else {
6019            Ok(false)
6020        }
6021    }
6022
6023    fn parse_deallocate(&mut self) -> ModalResult<Statement> {
6024        let prepare = self.parse_keyword(Keyword::PREPARE);
6025        let name = if self.parse_keyword(Keyword::ALL) {
6026            None
6027        } else {
6028            Some(self.parse_identifier()?)
6029        };
6030        Ok(Statement::Deallocate { name, prepare })
6031    }
6032
6033    fn parse_execute(&mut self) -> ModalResult<Statement> {
6034        let name = self.parse_identifier()?;
6035
6036        let mut parameters = vec![];
6037        if self.consume_token(&Token::LParen) {
6038            parameters = self.parse_comma_separated(Parser::parse_expr)?;
6039            self.expect_token(&Token::RParen)?;
6040        }
6041
6042        Ok(Statement::Execute { name, parameters })
6043    }
6044
6045    fn parse_prepare(&mut self) -> ModalResult<Statement> {
6046        let name = self.parse_identifier()?;
6047
6048        let mut data_types = vec![];
6049        if self.consume_token(&Token::LParen) {
6050            data_types = self.parse_comma_separated(Parser::parse_data_type)?;
6051            self.expect_token(&Token::RParen)?;
6052        }
6053
6054        self.expect_keyword(Keyword::AS)?;
6055        let statement = Box::new(self.parse_statement()?);
6056        Ok(Statement::Prepare {
6057            name,
6058            data_types,
6059            statement,
6060        })
6061    }
6062
6063    fn parse_comment(&mut self) -> ModalResult<Statement> {
6064        self.expect_keyword(Keyword::ON)?;
6065        let checkpoint = *self;
6066        let token = self.next_token();
6067
6068        let (object_type, object_name) = match token.token {
6069            Token::Word(w) if w.keyword == Keyword::COLUMN => {
6070                let object_name = self.parse_object_name()?;
6071                (CommentObject::Column, object_name)
6072            }
6073            Token::Word(w) if w.keyword == Keyword::TABLE => {
6074                let object_name = self.parse_object_name()?;
6075                (CommentObject::Table, object_name)
6076            }
6077            _ => self.expected_at(checkpoint, "comment object_type")?,
6078        };
6079
6080        self.expect_keyword(Keyword::IS)?;
6081        let comment = if self.parse_keyword(Keyword::NULL) {
6082            None
6083        } else {
6084            Some(self.parse_literal_string()?)
6085        };
6086        Ok(Statement::Comment {
6087            object_type,
6088            object_name,
6089            comment,
6090        })
6091    }
6092
6093    fn parse_use(&mut self) -> ModalResult<Statement> {
6094        let db_name = self.parse_object_name()?;
6095        Ok(Statement::Use { db_name })
6096    }
6097
6098    /// Parse a named window definition for the WINDOW clause
6099    pub fn parse_named_window(&mut self) -> ModalResult<NamedWindow> {
6100        let name = self.parse_identifier()?;
6101        self.expect_keywords(&[Keyword::AS])?;
6102        self.expect_token(&Token::LParen)?;
6103        let window_spec = self.parse_window_spec()?;
6104        self.expect_token(&Token::RParen)?;
6105        Ok(NamedWindow { name, window_spec })
6106    }
6107
6108    /// Parse a window specification (contents of OVER clause or WINDOW clause)
6109    pub fn parse_window_spec(&mut self) -> ModalResult<WindowSpec> {
6110        let partition_by = if self.parse_keywords(&[Keyword::PARTITION, Keyword::BY]) {
6111            self.parse_comma_separated(Parser::parse_expr)?
6112        } else {
6113            vec![]
6114        };
6115        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
6116            self.parse_comma_separated(Parser::parse_order_by_expr)?
6117        } else {
6118            vec![]
6119        };
6120        let window_frame = if !self.peek_token().eq(&Token::RParen) {
6121            Some(self.parse_window_frame()?)
6122        } else {
6123            None
6124        };
6125        Ok(WindowSpec {
6126            partition_by,
6127            order_by,
6128            window_frame,
6129        })
6130    }
6131}
6132
6133impl Word {
6134    /// Convert a Word to a Identifier, return ParserError when the Word's value is a empty string.
6135    pub fn to_ident(&self) -> ModalResult<Ident> {
6136        if self.value.is_empty() {
6137            parser_err!("zero-length delimited identifier at or near \"{self}\"")
6138        } else {
6139            Ok(Ident {
6140                value: self.value.clone(),
6141                quote_style: self.quote_style,
6142            })
6143        }
6144    }
6145}
6146
6147#[cfg(test)]
6148mod tests {
6149    use super::*;
6150    use crate::test_utils::run_parser_method;
6151
6152    #[test]
6153    fn test_parse_integer_min() {
6154        let min_bigint = "-9223372036854775808";
6155        run_parser_method(min_bigint, |parser| {
6156            assert_eq!(
6157                parser.parse_expr().unwrap(),
6158                Expr::Value(Value::Number("-9223372036854775808".to_owned()))
6159            )
6160        });
6161    }
6162}