risingwave_sqlparser/
parser.rs

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