Skip to main content

sqlparser/parser/
mod.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
15#[cfg(not(feature = "std"))]
16use alloc::{
17    boxed::Box,
18    format,
19    string::{String, ToString},
20    vec,
21    vec::Vec,
22};
23use core::{
24    fmt::{self, Display},
25    str::FromStr,
26};
27use helpers::attached_token::AttachedToken;
28
29use log::debug;
30
31use recursion::RecursionCounter;
32use IsLateral::*;
33use IsOptional::*;
34
35use crate::ast::*;
36use crate::ast::{
37    comments,
38    helpers::{
39        key_value_options::{
40            KeyValueOption, KeyValueOptionKind, KeyValueOptions, KeyValueOptionsDelimiter,
41        },
42        stmt_create_table::{CreateTableBuilder, CreateTableConfiguration},
43    },
44};
45use crate::dialect::*;
46use crate::keywords::{Keyword, ALL_KEYWORDS};
47use crate::tokenizer::*;
48use sqlparser::parser::ParserState::ColumnDefinition;
49
50/// Errors produced by the SQL parser.
51#[derive(Debug, Clone, PartialEq, Eq)]
52pub enum ParserError {
53    /// Error originating from the tokenizer with a message.
54    TokenizerError(String),
55    /// Generic parser error with a message.
56    ParserError(String),
57    /// Raised when a recursion depth limit is exceeded.
58    RecursionLimitExceeded,
59}
60
61// Use `Parser::expected` instead, if possible
62macro_rules! parser_err {
63    ($MSG:expr, $loc:expr) => {
64        Err(ParserError::ParserError(format!("{}{}", $MSG, $loc)))
65    };
66}
67
68mod alter;
69mod merge;
70
71#[cfg(feature = "std")]
72/// Implementation [`RecursionCounter`] if std is available
73mod recursion {
74    use std::cell::Cell;
75    use std::rc::Rc;
76
77    use super::ParserError;
78
79    /// Tracks remaining recursion depth. This value is decremented on
80    /// each call to [`RecursionCounter::try_decrease()`], when it reaches 0 an error will
81    /// be returned.
82    ///
83    /// Note: Uses an [`std::rc::Rc`] and [`std::cell::Cell`] in order to satisfy the Rust
84    /// borrow checker so the automatic [`DepthGuard`] decrement a
85    /// reference to the counter.
86    ///
87    /// Note: when "recursive-protection" feature is enabled, this crate uses additional stack overflow protection
88    /// for some of its recursive methods. See [`recursive::recursive`] for more information.
89    pub(crate) struct RecursionCounter {
90        remaining_depth: Rc<Cell<usize>>,
91    }
92
93    impl RecursionCounter {
94        /// Creates a [`RecursionCounter`] with the specified maximum
95        /// depth
96        pub fn new(remaining_depth: usize) -> Self {
97            Self {
98                remaining_depth: Rc::new(remaining_depth.into()),
99            }
100        }
101
102        /// Decreases the remaining depth by 1.
103        ///
104        /// Returns [`Err`] if the remaining depth falls to 0.
105        ///
106        /// Returns a [`DepthGuard`] which will adds 1 to the
107        /// remaining depth upon drop;
108        pub fn try_decrease(&self) -> Result<DepthGuard, ParserError> {
109            let old_value = self.remaining_depth.get();
110            // ran out of space
111            if old_value == 0 {
112                Err(ParserError::RecursionLimitExceeded)
113            } else {
114                self.remaining_depth.set(old_value - 1);
115                Ok(DepthGuard::new(Rc::clone(&self.remaining_depth)))
116            }
117        }
118    }
119
120    /// Guard that increases the remaining depth by 1 on drop
121    pub struct DepthGuard {
122        remaining_depth: Rc<Cell<usize>>,
123    }
124
125    impl DepthGuard {
126        fn new(remaining_depth: Rc<Cell<usize>>) -> Self {
127            Self { remaining_depth }
128        }
129    }
130    impl Drop for DepthGuard {
131        fn drop(&mut self) {
132            let old_value = self.remaining_depth.get();
133            self.remaining_depth.set(old_value + 1);
134        }
135    }
136}
137
138#[cfg(not(feature = "std"))]
139mod recursion {
140    /// Implementation [`RecursionCounter`] if std is NOT available (and does not
141    /// guard against stack overflow).
142    ///
143    /// Has the same API as the std [`RecursionCounter`] implementation
144    /// but does not actually limit stack depth.
145    pub(crate) struct RecursionCounter {}
146
147    impl RecursionCounter {
148        pub fn new(_remaining_depth: usize) -> Self {
149            Self {}
150        }
151        pub fn try_decrease(&self) -> Result<DepthGuard, super::ParserError> {
152            Ok(DepthGuard {})
153        }
154    }
155
156    pub struct DepthGuard {}
157}
158
159#[derive(PartialEq, Eq)]
160/// Indicates whether a parser element is optional or mandatory.
161pub enum IsOptional {
162    /// The element is optional.
163    Optional,
164    /// The element is mandatory.
165    Mandatory,
166}
167
168/// Indicates if a table expression is lateral.
169pub enum IsLateral {
170    /// The expression is lateral.
171    Lateral,
172    /// The expression is not lateral.
173    NotLateral,
174}
175
176/// Represents a wildcard expression used in SELECT lists.
177pub enum WildcardExpr {
178    /// A specific expression used instead of a wildcard.
179    Expr(Expr),
180    /// A qualified wildcard like `table.*`.
181    QualifiedWildcard(ObjectName),
182    /// An unqualified `*` wildcard.
183    Wildcard,
184}
185
186impl From<TokenizerError> for ParserError {
187    fn from(e: TokenizerError) -> Self {
188        ParserError::TokenizerError(e.to_string())
189    }
190}
191
192impl fmt::Display for ParserError {
193    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
194        write!(
195            f,
196            "sql parser error: {}",
197            match self {
198                ParserError::TokenizerError(s) => s,
199                ParserError::ParserError(s) => s,
200                ParserError::RecursionLimitExceeded => "recursion limit exceeded",
201            }
202        )
203    }
204}
205
206impl core::error::Error for ParserError {}
207
208// By default, allow expressions up to this deep before erroring
209const DEFAULT_REMAINING_DEPTH: usize = 50;
210
211// A constant EOF token that can be referenced.
212const EOF_TOKEN: TokenWithSpan = TokenWithSpan {
213    token: Token::EOF,
214    span: Span {
215        start: Location { line: 0, column: 0 },
216        end: Location { line: 0, column: 0 },
217    },
218};
219
220/// Composite types declarations using angle brackets syntax can be arbitrary
221/// nested such that the following declaration is possible:
222///      `ARRAY<ARRAY<INT>>`
223/// But the tokenizer recognizes the `>>` as a ShiftRight token.
224/// We work around that limitation when parsing a data type by accepting
225/// either a `>` or `>>` token in such cases, remembering which variant we
226/// matched.
227/// In the latter case having matched a `>>`, the parent type will not look to
228/// match its closing `>` as a result since that will have taken place at the
229/// child type.
230///
231/// See [Parser::parse_data_type] for details
232struct MatchedTrailingBracket(bool);
233
234impl From<bool> for MatchedTrailingBracket {
235    fn from(value: bool) -> Self {
236        Self(value)
237    }
238}
239
240/// Options that control how the [`Parser`] parses SQL text
241#[derive(Debug, Clone, PartialEq, Eq)]
242pub struct ParserOptions {
243    /// Allow trailing commas in lists (e.g. `a, b,`).
244    pub trailing_commas: bool,
245    /// Controls how literal values are unescaped. See
246    /// [`Tokenizer::with_unescape`] for more details.
247    pub unescape: bool,
248    /// Controls if the parser expects a semi-colon token
249    /// between statements. Default is `true`.
250    pub require_semicolon_stmt_delimiter: bool,
251}
252
253impl Default for ParserOptions {
254    fn default() -> Self {
255        Self {
256            trailing_commas: false,
257            unescape: true,
258            require_semicolon_stmt_delimiter: true,
259        }
260    }
261}
262
263impl ParserOptions {
264    /// Create a new [`ParserOptions`]
265    pub fn new() -> Self {
266        Default::default()
267    }
268
269    /// Set if trailing commas are allowed.
270    ///
271    /// If this option is `false` (the default), the following SQL will
272    /// not parse. If the option is `true`, the SQL will parse.
273    ///
274    /// ```sql
275    ///  SELECT
276    ///   foo,
277    ///   bar,
278    ///  FROM baz
279    /// ```
280    pub fn with_trailing_commas(mut self, trailing_commas: bool) -> Self {
281        self.trailing_commas = trailing_commas;
282        self
283    }
284
285    /// Set if literal values are unescaped. Defaults to true. See
286    /// [`Tokenizer::with_unescape`] for more details.
287    pub fn with_unescape(mut self, unescape: bool) -> Self {
288        self.unescape = unescape;
289        self
290    }
291}
292
293#[derive(Copy, Clone)]
294enum ParserState {
295    /// The default state of the parser.
296    Normal,
297    /// The state when parsing a CONNECT BY expression. This allows parsing
298    /// PRIOR expressions while still allowing prior as an identifier name
299    /// in other contexts.
300    ConnectBy,
301    /// The state when parsing column definitions.  This state prohibits
302    /// NOT NULL as an alias for IS NOT NULL.  For example:
303    /// ```sql
304    /// CREATE TABLE foo (abc BIGINT NOT NULL);
305    /// ```
306    ColumnDefinition,
307}
308
309/// A SQL Parser
310///
311/// This struct is the main entry point for parsing SQL queries.
312///
313/// # Functionality:
314/// * Parsing SQL: see examples on [`Parser::new`] and [`Parser::parse_sql`]
315/// * Controlling recursion: See [`Parser::with_recursion_limit`]
316/// * Controlling parser options: See [`Parser::with_options`]
317/// * Providing your own tokens: See [`Parser::with_tokens`]
318///
319/// # Internals
320///
321/// The parser uses a [`Tokenizer`] to tokenize the input SQL string into a
322/// `Vec` of [`TokenWithSpan`]s and maintains an `index` to the current token
323/// being processed. The token vec may contain multiple SQL statements.
324///
325/// * The "current" token is the token at `index - 1`
326/// * The "next" token is the token at `index`
327/// * The "previous" token is the token at `index - 2`
328///
329/// If `index` is equal to the length of the token stream, the 'next' token is
330/// [`Token::EOF`].
331///
332/// For example, the SQL string "SELECT * FROM foo" will be tokenized into
333/// following tokens:
334/// ```text
335///  [
336///    "SELECT", // token index 0
337///    " ",      // whitespace
338///    "*",
339///    " ",
340///    "FROM",
341///    " ",
342///    "foo"
343///   ]
344/// ```
345///
346///
347pub struct Parser<'a> {
348    /// The tokens
349    tokens: Vec<TokenWithSpan>,
350    /// The index of the first unprocessed token in [`Parser::tokens`].
351    index: usize,
352    /// The current state of the parser.
353    state: ParserState,
354    /// The SQL dialect to use.
355    dialect: &'a dyn Dialect,
356    /// Additional options that allow you to mix & match behavior
357    /// otherwise constrained to certain dialects (e.g. trailing
358    /// commas) and/or format of parse (e.g. unescaping).
359    options: ParserOptions,
360    /// Ensures the stack does not overflow by limiting recursion depth.
361    recursion_counter: RecursionCounter,
362}
363
364impl<'a> Parser<'a> {
365    /// Create a parser for a [`Dialect`]
366    ///
367    /// See also [`Parser::parse_sql`]
368    ///
369    /// Example:
370    /// ```
371    /// # use sqlparser::{parser::{Parser, ParserError}, dialect::GenericDialect};
372    /// # fn main() -> Result<(), ParserError> {
373    /// let dialect = GenericDialect{};
374    /// let statements = Parser::new(&dialect)
375    ///   .try_with_sql("SELECT * FROM foo")?
376    ///   .parse_statements()?;
377    /// # Ok(())
378    /// # }
379    /// ```
380    pub fn new(dialect: &'a dyn Dialect) -> Self {
381        Self {
382            tokens: vec![],
383            index: 0,
384            state: ParserState::Normal,
385            dialect,
386            recursion_counter: RecursionCounter::new(DEFAULT_REMAINING_DEPTH),
387            options: ParserOptions::new().with_trailing_commas(dialect.supports_trailing_commas()),
388        }
389    }
390
391    /// Specify the maximum recursion limit while parsing.
392    ///
393    /// [`Parser`] prevents stack overflows by returning
394    /// [`ParserError::RecursionLimitExceeded`] if the parser exceeds
395    /// this depth while processing the query.
396    ///
397    /// Example:
398    /// ```
399    /// # use sqlparser::{parser::{Parser, ParserError}, dialect::GenericDialect};
400    /// # fn main() -> Result<(), ParserError> {
401    /// let dialect = GenericDialect{};
402    /// let result = Parser::new(&dialect)
403    ///   .with_recursion_limit(1)
404    ///   .try_with_sql("SELECT * FROM foo WHERE (a OR (b OR (c OR d)))")?
405    ///   .parse_statements();
406    ///   assert_eq!(result, Err(ParserError::RecursionLimitExceeded));
407    /// # Ok(())
408    /// # }
409    /// ```
410    ///
411    /// Note: when "recursive-protection" feature is enabled, this crate uses additional stack overflow protection
412    //  for some of its recursive methods. See [`recursive::recursive`] for more information.
413    pub fn with_recursion_limit(mut self, recursion_limit: usize) -> Self {
414        self.recursion_counter = RecursionCounter::new(recursion_limit);
415        self
416    }
417
418    /// Specify additional parser options
419    ///
420    /// [`Parser`] supports additional options ([`ParserOptions`])
421    /// that allow you to mix & match behavior otherwise constrained
422    /// to certain dialects (e.g. trailing commas).
423    ///
424    /// Example:
425    /// ```
426    /// # use sqlparser::{parser::{Parser, ParserError, ParserOptions}, dialect::GenericDialect};
427    /// # fn main() -> Result<(), ParserError> {
428    /// let dialect = GenericDialect{};
429    /// let options = ParserOptions::new()
430    ///    .with_trailing_commas(true)
431    ///    .with_unescape(false);
432    /// let result = Parser::new(&dialect)
433    ///   .with_options(options)
434    ///   .try_with_sql("SELECT a, b, COUNT(*), FROM foo GROUP BY a, b,")?
435    ///   .parse_statements();
436    ///   assert!(matches!(result, Ok(_)));
437    /// # Ok(())
438    /// # }
439    /// ```
440    pub fn with_options(mut self, options: ParserOptions) -> Self {
441        self.options = options;
442        self
443    }
444
445    /// Reset this parser to parse the specified token stream
446    pub fn with_tokens_with_locations(mut self, tokens: Vec<TokenWithSpan>) -> Self {
447        self.tokens = tokens;
448        self.index = 0;
449        self
450    }
451
452    /// Reset this parser state to parse the specified tokens
453    pub fn with_tokens(self, tokens: Vec<Token>) -> Self {
454        // Put in dummy locations
455        let tokens_with_locations: Vec<TokenWithSpan> = tokens
456            .into_iter()
457            .map(|token| TokenWithSpan {
458                token,
459                span: Span::empty(),
460            })
461            .collect();
462        self.with_tokens_with_locations(tokens_with_locations)
463    }
464
465    /// Tokenize the sql string and sets this [`Parser`]'s state to
466    /// parse the resulting tokens
467    ///
468    /// Returns an error if there was an error tokenizing the SQL string.
469    ///
470    /// See example on [`Parser::new()`] for an example
471    pub fn try_with_sql(self, sql: &str) -> Result<Self, ParserError> {
472        debug!("Parsing sql '{sql}'...");
473        let tokens = Tokenizer::new(self.dialect, sql)
474            .with_unescape(self.options.unescape)
475            .tokenize_with_location()?;
476        Ok(self.with_tokens_with_locations(tokens))
477    }
478
479    /// Parse potentially multiple statements
480    ///
481    /// Example
482    /// ```
483    /// # use sqlparser::{parser::{Parser, ParserError}, dialect::GenericDialect};
484    /// # fn main() -> Result<(), ParserError> {
485    /// let dialect = GenericDialect{};
486    /// let statements = Parser::new(&dialect)
487    ///   // Parse a SQL string with 2 separate statements
488    ///   .try_with_sql("SELECT * FROM foo; SELECT * FROM bar;")?
489    ///   .parse_statements()?;
490    /// assert_eq!(statements.len(), 2);
491    /// # Ok(())
492    /// # }
493    /// ```
494    pub fn parse_statements(&mut self) -> Result<Vec<Statement>, ParserError> {
495        let mut stmts = Vec::new();
496        let mut expecting_statement_delimiter = false;
497        loop {
498            // ignore empty statements (between successive statement delimiters)
499            while self.consume_token(&Token::SemiColon) {
500                expecting_statement_delimiter = false;
501            }
502
503            if !self.options.require_semicolon_stmt_delimiter {
504                expecting_statement_delimiter = false;
505            }
506
507            match &self.peek_token_ref().token {
508                Token::EOF => break,
509
510                // end of statement
511                Token::Word(word)
512                    if expecting_statement_delimiter && word.keyword == Keyword::END =>
513                {
514                    break;
515                }
516                _ => {}
517            }
518
519            if expecting_statement_delimiter {
520                return self.expected_ref("end of statement", self.peek_token_ref());
521            }
522
523            let statement = self.parse_statement()?;
524            stmts.push(statement);
525            expecting_statement_delimiter = true;
526        }
527        Ok(stmts)
528    }
529
530    /// Convenience method to parse a string with one or more SQL
531    /// statements into produce an Abstract Syntax Tree (AST).
532    ///
533    /// Example
534    /// ```
535    /// # use sqlparser::{parser::{Parser, ParserError}, dialect::GenericDialect};
536    /// # fn main() -> Result<(), ParserError> {
537    /// let dialect = GenericDialect{};
538    /// let statements = Parser::parse_sql(
539    ///   &dialect, "SELECT * FROM foo"
540    /// )?;
541    /// assert_eq!(statements.len(), 1);
542    /// # Ok(())
543    /// # }
544    /// ```
545    pub fn parse_sql(dialect: &dyn Dialect, sql: &str) -> Result<Vec<Statement>, ParserError> {
546        Parser::new(dialect).try_with_sql(sql)?.parse_statements()
547    }
548
549    /// Parses the given `sql` into an Abstract Syntax Tree (AST), returning
550    /// also encountered source code comments.
551    ///
552    /// See [Parser::parse_sql].
553    pub fn parse_sql_with_comments(
554        dialect: &'a dyn Dialect,
555        sql: &str,
556    ) -> Result<(Vec<Statement>, comments::Comments), ParserError> {
557        let mut p = Parser::new(dialect).try_with_sql(sql)?;
558        p.parse_statements().map(|stmts| (stmts, p.into_comments()))
559    }
560
561    /// Consumes this parser returning comments from the parsed token stream.
562    fn into_comments(self) -> comments::Comments {
563        let mut comments = comments::Comments::default();
564        for t in self.tokens.into_iter() {
565            match t.token {
566                Token::Whitespace(Whitespace::SingleLineComment { comment, prefix }) => {
567                    comments.offer(comments::CommentWithSpan {
568                        comment: comments::Comment::SingleLine {
569                            content: comment,
570                            prefix,
571                        },
572                        span: t.span,
573                    });
574                }
575                Token::Whitespace(Whitespace::MultiLineComment(comment)) => {
576                    comments.offer(comments::CommentWithSpan {
577                        comment: comments::Comment::MultiLine(comment),
578                        span: t.span,
579                    });
580                }
581                _ => {}
582            }
583        }
584        comments
585    }
586
587    /// Parse a single top-level statement (such as SELECT, INSERT, CREATE, etc.),
588    /// stopping before the statement separator, if any.
589    pub fn parse_statement(&mut self) -> Result<Statement, ParserError> {
590        let _guard = self.recursion_counter.try_decrease()?;
591
592        // allow the dialect to override statement parsing
593        if let Some(statement) = self.dialect.parse_statement(self) {
594            return statement;
595        }
596
597        let next_token = self.next_token();
598        match &next_token.token {
599            Token::Word(w) => match w.keyword {
600                Keyword::KILL => self.parse_kill(),
601                Keyword::FLUSH => self.parse_flush(),
602                Keyword::DESC => self.parse_explain(DescribeAlias::Desc),
603                Keyword::DESCRIBE => self.parse_explain(DescribeAlias::Describe),
604                Keyword::EXPLAIN => self.parse_explain(DescribeAlias::Explain),
605                Keyword::ANALYZE => self.parse_analyze().map(Into::into),
606                Keyword::CASE => {
607                    self.prev_token();
608                    self.parse_case_stmt().map(Into::into)
609                }
610                Keyword::IF => {
611                    self.prev_token();
612                    self.parse_if_stmt().map(Into::into)
613                }
614                Keyword::WHILE => {
615                    self.prev_token();
616                    self.parse_while().map(Into::into)
617                }
618                Keyword::RAISE => {
619                    self.prev_token();
620                    self.parse_raise_stmt().map(Into::into)
621                }
622                Keyword::SELECT | Keyword::WITH | Keyword::VALUES | Keyword::FROM => {
623                    self.prev_token();
624                    self.parse_query().map(Into::into)
625                }
626                Keyword::TRUNCATE => self.parse_truncate().map(Into::into),
627                Keyword::ATTACH => {
628                    if dialect_of!(self is DuckDbDialect) {
629                        self.parse_attach_duckdb_database()
630                    } else {
631                        self.parse_attach_database()
632                    }
633                }
634                Keyword::DETACH if self.dialect.supports_detach() => {
635                    self.parse_detach_duckdb_database()
636                }
637                Keyword::MSCK => self.parse_msck().map(Into::into),
638                Keyword::CREATE => self.parse_create(),
639                Keyword::CACHE => self.parse_cache_table(),
640                Keyword::DROP => self.parse_drop(),
641                Keyword::DISCARD => self.parse_discard(),
642                Keyword::DECLARE => self.parse_declare(),
643                Keyword::FETCH => self.parse_fetch_statement(),
644                Keyword::DELETE => self.parse_delete(next_token),
645                Keyword::INSERT => self.parse_insert(next_token),
646                Keyword::REPLACE => self.parse_replace(next_token),
647                Keyword::UNCACHE => self.parse_uncache_table(),
648                Keyword::UPDATE => self.parse_update(next_token),
649                Keyword::ALTER => self.parse_alter(),
650                Keyword::CALL => self.parse_call(),
651                Keyword::COPY => self.parse_copy(),
652                Keyword::OPEN => {
653                    self.prev_token();
654                    self.parse_open()
655                }
656                Keyword::CLOSE => self.parse_close(),
657                Keyword::SET => self.parse_set(),
658                Keyword::SHOW => self.parse_show(),
659                Keyword::USE => self.parse_use(),
660                Keyword::GRANT => self.parse_grant().map(Into::into),
661                Keyword::DENY => {
662                    self.prev_token();
663                    self.parse_deny()
664                }
665                Keyword::REVOKE => self.parse_revoke().map(Into::into),
666                Keyword::START => self.parse_start_transaction(),
667                Keyword::BEGIN => self.parse_begin(),
668                Keyword::END => self.parse_end(),
669                Keyword::SAVEPOINT => self.parse_savepoint(),
670                Keyword::RELEASE => self.parse_release(),
671                Keyword::COMMIT => self.parse_commit(),
672                Keyword::RAISERROR => Ok(self.parse_raiserror()?),
673                Keyword::THROW => {
674                    self.prev_token();
675                    self.parse_throw().map(Into::into)
676                }
677                Keyword::ROLLBACK => self.parse_rollback(),
678                Keyword::ASSERT => self.parse_assert(),
679                // `PREPARE`, `EXECUTE` and `DEALLOCATE` are Postgres-specific
680                // syntaxes. They are used for Postgres prepared statement.
681                Keyword::DEALLOCATE => self.parse_deallocate(),
682                Keyword::EXECUTE | Keyword::EXEC => self.parse_execute(),
683                Keyword::PREPARE => self.parse_prepare(),
684                Keyword::MERGE => self.parse_merge(next_token).map(Into::into),
685                // `LISTEN`, `UNLISTEN` and `NOTIFY` are Postgres-specific
686                // syntaxes. They are used for Postgres statement.
687                Keyword::LISTEN if self.dialect.supports_listen_notify() => self.parse_listen(),
688                Keyword::UNLISTEN if self.dialect.supports_listen_notify() => self.parse_unlisten(),
689                Keyword::NOTIFY if self.dialect.supports_listen_notify() => self.parse_notify(),
690                // `PRAGMA` is sqlite specific https://www.sqlite.org/pragma.html
691                Keyword::PRAGMA => self.parse_pragma(),
692                Keyword::UNLOAD => {
693                    self.prev_token();
694                    self.parse_unload()
695                }
696                Keyword::RENAME => self.parse_rename(),
697                // `INSTALL` is duckdb specific https://duckdb.org/docs/extensions/overview
698                Keyword::INSTALL if self.dialect.supports_install() => self.parse_install(),
699                Keyword::LOAD => self.parse_load(),
700                Keyword::LOCK => {
701                    self.prev_token();
702                    self.parse_lock_statement().map(Into::into)
703                }
704                Keyword::OPTIMIZE if self.dialect.supports_optimize_table() => {
705                    self.parse_optimize_table()
706                }
707                // `COMMENT` is snowflake specific https://docs.snowflake.com/en/sql-reference/sql/comment
708                Keyword::COMMENT if self.dialect.supports_comment_on() => self.parse_comment(),
709                Keyword::PRINT => self.parse_print(),
710                // `WAITFOR` is MSSQL specific https://learn.microsoft.com/en-us/sql/t-sql/language-elements/waitfor-transact-sql
711                Keyword::WAITFOR => self.parse_waitfor(),
712                Keyword::RETURN => self.parse_return(),
713                Keyword::EXPORT => {
714                    self.prev_token();
715                    self.parse_export_data()
716                }
717                Keyword::VACUUM => {
718                    self.prev_token();
719                    self.parse_vacuum()
720                }
721                Keyword::RESET => self.parse_reset().map(Into::into),
722                _ => self.expected("an SQL statement", next_token),
723            },
724            Token::LParen => {
725                self.prev_token();
726                self.parse_query().map(Into::into)
727            }
728            _ => self.expected("an SQL statement", next_token),
729        }
730    }
731
732    /// Parse a `CASE` statement.
733    ///
734    /// See [Statement::Case]
735    pub fn parse_case_stmt(&mut self) -> Result<CaseStatement, ParserError> {
736        let case_token = self.expect_keyword(Keyword::CASE)?;
737
738        let match_expr = if self.peek_keyword(Keyword::WHEN) {
739            None
740        } else {
741            Some(self.parse_expr()?)
742        };
743
744        self.expect_keyword_is(Keyword::WHEN)?;
745        let when_blocks = self.parse_keyword_separated(Keyword::WHEN, |parser| {
746            parser.parse_conditional_statement_block(&[Keyword::WHEN, Keyword::ELSE, Keyword::END])
747        })?;
748
749        let else_block = if self.parse_keyword(Keyword::ELSE) {
750            Some(self.parse_conditional_statement_block(&[Keyword::END])?)
751        } else {
752            None
753        };
754
755        let mut end_case_token = self.expect_keyword(Keyword::END)?;
756        if self.peek_keyword(Keyword::CASE) {
757            end_case_token = self.expect_keyword(Keyword::CASE)?;
758        }
759
760        Ok(CaseStatement {
761            case_token: AttachedToken(case_token),
762            match_expr,
763            when_blocks,
764            else_block,
765            end_case_token: AttachedToken(end_case_token),
766        })
767    }
768
769    /// Parse an `IF` statement.
770    ///
771    /// See [Statement::If]
772    pub fn parse_if_stmt(&mut self) -> Result<IfStatement, ParserError> {
773        self.expect_keyword_is(Keyword::IF)?;
774        let if_block = self.parse_conditional_statement_block(&[
775            Keyword::ELSE,
776            Keyword::ELSEIF,
777            Keyword::END,
778        ])?;
779
780        let elseif_blocks = if self.parse_keyword(Keyword::ELSEIF) {
781            self.parse_keyword_separated(Keyword::ELSEIF, |parser| {
782                parser.parse_conditional_statement_block(&[
783                    Keyword::ELSEIF,
784                    Keyword::ELSE,
785                    Keyword::END,
786                ])
787            })?
788        } else {
789            vec![]
790        };
791
792        let else_block = if self.parse_keyword(Keyword::ELSE) {
793            Some(self.parse_conditional_statement_block(&[Keyword::END])?)
794        } else {
795            None
796        };
797
798        self.expect_keyword_is(Keyword::END)?;
799        let end_token = self.expect_keyword(Keyword::IF)?;
800
801        Ok(IfStatement {
802            if_block,
803            elseif_blocks,
804            else_block,
805            end_token: Some(AttachedToken(end_token)),
806        })
807    }
808
809    /// Parse a `WHILE` statement.
810    ///
811    /// See [Statement::While]
812    fn parse_while(&mut self) -> Result<WhileStatement, ParserError> {
813        self.expect_keyword_is(Keyword::WHILE)?;
814        let while_block = self.parse_conditional_statement_block(&[Keyword::END])?;
815
816        Ok(WhileStatement { while_block })
817    }
818
819    /// Parses an expression and associated list of statements
820    /// belonging to a conditional statement like `IF` or `WHEN` or `WHILE`.
821    ///
822    /// Example:
823    /// ```sql
824    /// IF condition THEN statement1; statement2;
825    /// ```
826    fn parse_conditional_statement_block(
827        &mut self,
828        terminal_keywords: &[Keyword],
829    ) -> Result<ConditionalStatementBlock, ParserError> {
830        let start_token = self.get_current_token().clone(); // self.expect_keyword(keyword)?;
831        let mut then_token = None;
832
833        let condition = match &start_token.token {
834            Token::Word(w) if w.keyword == Keyword::ELSE => None,
835            Token::Word(w) if w.keyword == Keyword::WHILE => {
836                let expr = self.parse_expr()?;
837                Some(expr)
838            }
839            _ => {
840                let expr = self.parse_expr()?;
841                then_token = Some(AttachedToken(self.expect_keyword(Keyword::THEN)?));
842                Some(expr)
843            }
844        };
845
846        let conditional_statements = self.parse_conditional_statements(terminal_keywords)?;
847
848        Ok(ConditionalStatementBlock {
849            start_token: AttachedToken(start_token),
850            condition,
851            then_token,
852            conditional_statements,
853        })
854    }
855
856    /// Parse a BEGIN/END block or a sequence of statements
857    /// This could be inside of a conditional (IF, CASE, WHILE etc.) or an object body defined optionally BEGIN/END and one or more statements.
858    pub(crate) fn parse_conditional_statements(
859        &mut self,
860        terminal_keywords: &[Keyword],
861    ) -> Result<ConditionalStatements, ParserError> {
862        let conditional_statements = if self.peek_keyword(Keyword::BEGIN) {
863            let begin_token = self.expect_keyword(Keyword::BEGIN)?;
864            let statements = self.parse_statement_list(terminal_keywords)?;
865            let end_token = self.expect_keyword(Keyword::END)?;
866
867            ConditionalStatements::BeginEnd(BeginEndStatements {
868                begin_token: AttachedToken(begin_token),
869                statements,
870                end_token: AttachedToken(end_token),
871            })
872        } else {
873            ConditionalStatements::Sequence {
874                statements: self.parse_statement_list(terminal_keywords)?,
875            }
876        };
877        Ok(conditional_statements)
878    }
879
880    /// Parse a `RAISE` statement.
881    ///
882    /// See [Statement::Raise]
883    pub fn parse_raise_stmt(&mut self) -> Result<RaiseStatement, ParserError> {
884        self.expect_keyword_is(Keyword::RAISE)?;
885
886        let value = if self.parse_keywords(&[Keyword::USING, Keyword::MESSAGE]) {
887            self.expect_token(&Token::Eq)?;
888            Some(RaiseStatementValue::UsingMessage(self.parse_expr()?))
889        } else {
890            self.maybe_parse(|parser| parser.parse_expr().map(RaiseStatementValue::Expr))?
891        };
892
893        Ok(RaiseStatement { value })
894    }
895    /// Parse a COMMENT statement.
896    ///
897    /// See [Statement::Comment]
898    pub fn parse_comment(&mut self) -> Result<Statement, ParserError> {
899        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
900
901        self.expect_keyword_is(Keyword::ON)?;
902        let token = self.next_token();
903
904        let (object_type, object_name) = match token.token {
905            Token::Word(w) if w.keyword == Keyword::COLLATION => {
906                (CommentObject::Collation, self.parse_object_name(false)?)
907            }
908            Token::Word(w) if w.keyword == Keyword::COLUMN => {
909                (CommentObject::Column, self.parse_object_name(false)?)
910            }
911            Token::Word(w) if w.keyword == Keyword::DATABASE => {
912                (CommentObject::Database, self.parse_object_name(false)?)
913            }
914            Token::Word(w) if w.keyword == Keyword::DOMAIN => {
915                (CommentObject::Domain, self.parse_object_name(false)?)
916            }
917            Token::Word(w) if w.keyword == Keyword::EXTENSION => {
918                (CommentObject::Extension, self.parse_object_name(false)?)
919            }
920            Token::Word(w) if w.keyword == Keyword::FUNCTION => {
921                (CommentObject::Function, self.parse_object_name(false)?)
922            }
923            Token::Word(w) if w.keyword == Keyword::INDEX => {
924                (CommentObject::Index, self.parse_object_name(false)?)
925            }
926            Token::Word(w) if w.keyword == Keyword::MATERIALIZED => {
927                self.expect_keyword_is(Keyword::VIEW)?;
928                (
929                    CommentObject::MaterializedView,
930                    self.parse_object_name(false)?,
931                )
932            }
933            Token::Word(w) if w.keyword == Keyword::PROCEDURE => {
934                (CommentObject::Procedure, self.parse_object_name(false)?)
935            }
936            Token::Word(w) if w.keyword == Keyword::ROLE => {
937                (CommentObject::Role, self.parse_object_name(false)?)
938            }
939            Token::Word(w) if w.keyword == Keyword::SCHEMA => {
940                (CommentObject::Schema, self.parse_object_name(false)?)
941            }
942            Token::Word(w) if w.keyword == Keyword::SEQUENCE => {
943                (CommentObject::Sequence, self.parse_object_name(false)?)
944            }
945            Token::Word(w) if w.keyword == Keyword::TABLE => {
946                (CommentObject::Table, self.parse_object_name(false)?)
947            }
948            Token::Word(w) if w.keyword == Keyword::TYPE => {
949                (CommentObject::Type, self.parse_object_name(false)?)
950            }
951            Token::Word(w) if w.keyword == Keyword::USER => {
952                (CommentObject::User, self.parse_object_name(false)?)
953            }
954            Token::Word(w) if w.keyword == Keyword::VIEW => {
955                (CommentObject::View, self.parse_object_name(false)?)
956            }
957            _ => self.expected("comment object_type", token)?,
958        };
959
960        self.expect_keyword_is(Keyword::IS)?;
961        let comment = if self.parse_keyword(Keyword::NULL) {
962            None
963        } else {
964            Some(self.parse_literal_string()?)
965        };
966        Ok(Statement::Comment {
967            object_type,
968            object_name,
969            comment,
970            if_exists,
971        })
972    }
973
974    /// Parse `FLUSH` statement.
975    pub fn parse_flush(&mut self) -> Result<Statement, ParserError> {
976        let mut channel = None;
977        let mut tables: Vec<ObjectName> = vec![];
978        let mut read_lock = false;
979        let mut export = false;
980
981        if !dialect_of!(self is MySqlDialect | GenericDialect) {
982            return parser_err!(
983                "Unsupported statement FLUSH",
984                self.peek_token_ref().span.start
985            );
986        }
987
988        let location = if self.parse_keyword(Keyword::NO_WRITE_TO_BINLOG) {
989            Some(FlushLocation::NoWriteToBinlog)
990        } else if self.parse_keyword(Keyword::LOCAL) {
991            Some(FlushLocation::Local)
992        } else {
993            None
994        };
995
996        let object_type = if self.parse_keywords(&[Keyword::BINARY, Keyword::LOGS]) {
997            FlushType::BinaryLogs
998        } else if self.parse_keywords(&[Keyword::ENGINE, Keyword::LOGS]) {
999            FlushType::EngineLogs
1000        } else if self.parse_keywords(&[Keyword::ERROR, Keyword::LOGS]) {
1001            FlushType::ErrorLogs
1002        } else if self.parse_keywords(&[Keyword::GENERAL, Keyword::LOGS]) {
1003            FlushType::GeneralLogs
1004        } else if self.parse_keywords(&[Keyword::HOSTS]) {
1005            FlushType::Hosts
1006        } else if self.parse_keyword(Keyword::PRIVILEGES) {
1007            FlushType::Privileges
1008        } else if self.parse_keyword(Keyword::OPTIMIZER_COSTS) {
1009            FlushType::OptimizerCosts
1010        } else if self.parse_keywords(&[Keyword::RELAY, Keyword::LOGS]) {
1011            if self.parse_keywords(&[Keyword::FOR, Keyword::CHANNEL]) {
1012                channel = Some(self.parse_object_name(false)?.to_string());
1013            }
1014            FlushType::RelayLogs
1015        } else if self.parse_keywords(&[Keyword::SLOW, Keyword::LOGS]) {
1016            FlushType::SlowLogs
1017        } else if self.parse_keyword(Keyword::STATUS) {
1018            FlushType::Status
1019        } else if self.parse_keyword(Keyword::USER_RESOURCES) {
1020            FlushType::UserResources
1021        } else if self.parse_keywords(&[Keyword::LOGS]) {
1022            FlushType::Logs
1023        } else if self.parse_keywords(&[Keyword::TABLES]) {
1024            loop {
1025                let next_token = self.next_token();
1026                match &next_token.token {
1027                    Token::Word(w) => match w.keyword {
1028                        Keyword::WITH => {
1029                            read_lock = self.parse_keywords(&[Keyword::READ, Keyword::LOCK]);
1030                        }
1031                        Keyword::FOR => {
1032                            export = self.parse_keyword(Keyword::EXPORT);
1033                        }
1034                        Keyword::NoKeyword => {
1035                            self.prev_token();
1036                            tables = self.parse_comma_separated(|p| p.parse_object_name(false))?;
1037                        }
1038                        _ => {}
1039                    },
1040                    _ => {
1041                        break;
1042                    }
1043                }
1044            }
1045
1046            FlushType::Tables
1047        } else {
1048            return self.expected_ref(
1049                "BINARY LOGS, ENGINE LOGS, ERROR LOGS, GENERAL LOGS, HOSTS, LOGS, PRIVILEGES, OPTIMIZER_COSTS,\
1050                 RELAY LOGS [FOR CHANNEL channel], SLOW LOGS, STATUS, USER_RESOURCES",
1051                self.peek_token_ref(),
1052            );
1053        };
1054
1055        Ok(Statement::Flush {
1056            object_type,
1057            location,
1058            channel,
1059            read_lock,
1060            export,
1061            tables,
1062        })
1063    }
1064
1065    /// Parse `MSCK` statement.
1066    pub fn parse_msck(&mut self) -> Result<Msck, ParserError> {
1067        let repair = self.parse_keyword(Keyword::REPAIR);
1068        self.expect_keyword_is(Keyword::TABLE)?;
1069        let table_name = self.parse_object_name(false)?;
1070        let partition_action = self
1071            .maybe_parse(|parser| {
1072                let pa = match parser.parse_one_of_keywords(&[
1073                    Keyword::ADD,
1074                    Keyword::DROP,
1075                    Keyword::SYNC,
1076                ]) {
1077                    Some(Keyword::ADD) => Some(AddDropSync::ADD),
1078                    Some(Keyword::DROP) => Some(AddDropSync::DROP),
1079                    Some(Keyword::SYNC) => Some(AddDropSync::SYNC),
1080                    _ => None,
1081                };
1082                parser.expect_keyword_is(Keyword::PARTITIONS)?;
1083                Ok(pa)
1084            })?
1085            .unwrap_or_default();
1086        Ok(Msck {
1087            repair,
1088            table_name,
1089            partition_action,
1090        })
1091    }
1092
1093    /// Parse `TRUNCATE` statement.
1094    pub fn parse_truncate(&mut self) -> Result<Truncate, ParserError> {
1095        let table = self.parse_keyword(Keyword::TABLE);
1096        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
1097
1098        let table_names = self.parse_comma_separated(|p| {
1099            let only = p.parse_keyword(Keyword::ONLY);
1100            let name = p.parse_object_name(false)?;
1101            let has_asterisk = p.consume_token(&Token::Mul);
1102            Ok(TruncateTableTarget {
1103                name,
1104                only,
1105                has_asterisk,
1106            })
1107        })?;
1108
1109        let mut partitions = None;
1110        if self.parse_keyword(Keyword::PARTITION) {
1111            self.expect_token(&Token::LParen)?;
1112            partitions = Some(self.parse_comma_separated(Parser::parse_expr)?);
1113            self.expect_token(&Token::RParen)?;
1114        }
1115
1116        let mut identity = None;
1117        let mut cascade = None;
1118
1119        if dialect_of!(self is PostgreSqlDialect | GenericDialect) {
1120            identity = if self.parse_keywords(&[Keyword::RESTART, Keyword::IDENTITY]) {
1121                Some(TruncateIdentityOption::Restart)
1122            } else if self.parse_keywords(&[Keyword::CONTINUE, Keyword::IDENTITY]) {
1123                Some(TruncateIdentityOption::Continue)
1124            } else {
1125                None
1126            };
1127
1128            cascade = self.parse_cascade_option();
1129        };
1130
1131        let on_cluster = self.parse_optional_on_cluster()?;
1132
1133        Ok(Truncate {
1134            table_names,
1135            partitions,
1136            table,
1137            if_exists,
1138            identity,
1139            cascade,
1140            on_cluster,
1141        })
1142    }
1143
1144    fn parse_cascade_option(&mut self) -> Option<CascadeOption> {
1145        if self.parse_keyword(Keyword::CASCADE) {
1146            Some(CascadeOption::Cascade)
1147        } else if self.parse_keyword(Keyword::RESTRICT) {
1148            Some(CascadeOption::Restrict)
1149        } else {
1150            None
1151        }
1152    }
1153
1154    /// Parse options for `ATTACH DUCKDB DATABASE` statement.
1155    pub fn parse_attach_duckdb_database_options(
1156        &mut self,
1157    ) -> Result<Vec<AttachDuckDBDatabaseOption>, ParserError> {
1158        if !self.consume_token(&Token::LParen) {
1159            return Ok(vec![]);
1160        }
1161
1162        let mut options = vec![];
1163        loop {
1164            if self.parse_keyword(Keyword::READ_ONLY) {
1165                let boolean = if self.parse_keyword(Keyword::TRUE) {
1166                    Some(true)
1167                } else if self.parse_keyword(Keyword::FALSE) {
1168                    Some(false)
1169                } else {
1170                    None
1171                };
1172                options.push(AttachDuckDBDatabaseOption::ReadOnly(boolean));
1173            } else if self.parse_keyword(Keyword::TYPE) {
1174                let ident = self.parse_identifier()?;
1175                options.push(AttachDuckDBDatabaseOption::Type(ident));
1176            } else {
1177                return self
1178                    .expected_ref("expected one of: ), READ_ONLY, TYPE", self.peek_token_ref());
1179            };
1180
1181            if self.consume_token(&Token::RParen) {
1182                return Ok(options);
1183            } else if self.consume_token(&Token::Comma) {
1184                continue;
1185            } else {
1186                return self.expected_ref("expected one of: ')', ','", self.peek_token_ref());
1187            }
1188        }
1189    }
1190
1191    /// Parse `ATTACH DUCKDB DATABASE` statement.
1192    pub fn parse_attach_duckdb_database(&mut self) -> Result<Statement, ParserError> {
1193        let database = self.parse_keyword(Keyword::DATABASE);
1194        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
1195        let database_path = self.parse_identifier()?;
1196        let database_alias = if self.parse_keyword(Keyword::AS) {
1197            Some(self.parse_identifier()?)
1198        } else {
1199            None
1200        };
1201
1202        let attach_options = self.parse_attach_duckdb_database_options()?;
1203        Ok(Statement::AttachDuckDBDatabase {
1204            if_not_exists,
1205            database,
1206            database_path,
1207            database_alias,
1208            attach_options,
1209        })
1210    }
1211
1212    /// Parse `DETACH DUCKDB DATABASE` statement.
1213    pub fn parse_detach_duckdb_database(&mut self) -> Result<Statement, ParserError> {
1214        let database = self.parse_keyword(Keyword::DATABASE);
1215        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
1216        let database_alias = self.parse_identifier()?;
1217        Ok(Statement::DetachDuckDBDatabase {
1218            if_exists,
1219            database,
1220            database_alias,
1221        })
1222    }
1223
1224    /// Parse `ATTACH DATABASE` statement.
1225    pub fn parse_attach_database(&mut self) -> Result<Statement, ParserError> {
1226        let database = self.parse_keyword(Keyword::DATABASE);
1227        let database_file_name = self.parse_expr()?;
1228        self.expect_keyword_is(Keyword::AS)?;
1229        let schema_name = self.parse_identifier()?;
1230        Ok(Statement::AttachDatabase {
1231            database,
1232            schema_name,
1233            database_file_name,
1234        })
1235    }
1236
1237    /// Parse `ANALYZE` statement.
1238    pub fn parse_analyze(&mut self) -> Result<Analyze, ParserError> {
1239        let has_table_keyword = self.parse_keyword(Keyword::TABLE);
1240        let table_name = self.maybe_parse(|parser| parser.parse_object_name(false))?;
1241        let mut for_columns = false;
1242        let mut cache_metadata = false;
1243        let mut noscan = false;
1244        let mut partitions = None;
1245        let mut compute_statistics = false;
1246        let mut columns = vec![];
1247
1248        // PostgreSQL syntax: ANALYZE t (col1, col2)
1249        if table_name.is_some() && self.consume_token(&Token::LParen) {
1250            columns = self.parse_comma_separated(|p| p.parse_identifier())?;
1251            self.expect_token(&Token::RParen)?;
1252        }
1253
1254        loop {
1255            match self.parse_one_of_keywords(&[
1256                Keyword::PARTITION,
1257                Keyword::FOR,
1258                Keyword::CACHE,
1259                Keyword::NOSCAN,
1260                Keyword::COMPUTE,
1261            ]) {
1262                Some(Keyword::PARTITION) => {
1263                    self.expect_token(&Token::LParen)?;
1264                    partitions = Some(self.parse_comma_separated(Parser::parse_expr)?);
1265                    self.expect_token(&Token::RParen)?;
1266                }
1267                Some(Keyword::NOSCAN) => noscan = true,
1268                Some(Keyword::FOR) => {
1269                    self.expect_keyword_is(Keyword::COLUMNS)?;
1270
1271                    columns = self
1272                        .maybe_parse(|parser| {
1273                            parser.parse_comma_separated(|p| p.parse_identifier())
1274                        })?
1275                        .unwrap_or_default();
1276                    for_columns = true
1277                }
1278                Some(Keyword::CACHE) => {
1279                    self.expect_keyword_is(Keyword::METADATA)?;
1280                    cache_metadata = true
1281                }
1282                Some(Keyword::COMPUTE) => {
1283                    self.expect_keyword_is(Keyword::STATISTICS)?;
1284                    compute_statistics = true
1285                }
1286                _ => break,
1287            }
1288        }
1289
1290        Ok(Analyze {
1291            has_table_keyword,
1292            table_name,
1293            for_columns,
1294            columns,
1295            partitions,
1296            cache_metadata,
1297            noscan,
1298            compute_statistics,
1299        })
1300    }
1301
1302    /// Parse a new expression including wildcard & qualified wildcard.
1303    pub fn parse_wildcard_expr(&mut self) -> Result<Expr, ParserError> {
1304        let index = self.index;
1305
1306        let next_token = self.next_token();
1307        match next_token.token {
1308            t @ (Token::Word(_) | Token::SingleQuotedString(_))
1309                if self.peek_token_ref().token == Token::Period =>
1310            {
1311                let mut id_parts: Vec<Ident> = vec![match t {
1312                    Token::Word(w) => w.into_ident(next_token.span),
1313                    Token::SingleQuotedString(s) => Ident::with_quote('\'', s),
1314                    _ => {
1315                        return Err(ParserError::ParserError(
1316                            "Internal parser error: unexpected token type".to_string(),
1317                        ))
1318                    }
1319                }];
1320
1321                while self.consume_token(&Token::Period) {
1322                    let next_token = self.next_token();
1323                    match next_token.token {
1324                        Token::Word(w) => id_parts.push(w.into_ident(next_token.span)),
1325                        Token::SingleQuotedString(s) => {
1326                            // SQLite has single-quoted identifiers
1327                            id_parts.push(Ident::with_quote('\'', s))
1328                        }
1329                        Token::Placeholder(s) => {
1330                            // Snowflake uses $1, $2, etc. for positional column references
1331                            // in staged data queries like: SELECT t.$1 FROM @stage t
1332                            id_parts.push(Ident::new(s))
1333                        }
1334                        Token::Mul => {
1335                            return Ok(Expr::QualifiedWildcard(
1336                                ObjectName::from(id_parts),
1337                                AttachedToken(next_token),
1338                            ));
1339                        }
1340                        _ => {
1341                            return self.expected("an identifier or a '*' after '.'", next_token);
1342                        }
1343                    }
1344                }
1345            }
1346            Token::Mul => {
1347                return Ok(Expr::Wildcard(AttachedToken(next_token)));
1348            }
1349            // Handle parenthesized wildcard: (*)
1350            Token::LParen => {
1351                let [maybe_mul, maybe_rparen] = self.peek_tokens_ref();
1352                if maybe_mul.token == Token::Mul && maybe_rparen.token == Token::RParen {
1353                    let mul_token = self.next_token(); // consume Mul
1354                    self.next_token(); // consume RParen
1355                    return Ok(Expr::Wildcard(AttachedToken(mul_token)));
1356                }
1357            }
1358            _ => (),
1359        };
1360
1361        self.index = index;
1362        self.parse_expr()
1363    }
1364
1365    /// Parse a new expression.
1366    pub fn parse_expr(&mut self) -> Result<Expr, ParserError> {
1367        self.parse_subexpr(self.dialect.prec_unknown())
1368    }
1369
1370    /// Parse expression with optional alias and order by.
1371    pub fn parse_expr_with_alias_and_order_by(
1372        &mut self,
1373    ) -> Result<ExprWithAliasAndOrderBy, ParserError> {
1374        let expr = self.parse_expr()?;
1375
1376        fn validator(explicit: bool, kw: &Keyword, _parser: &mut Parser) -> bool {
1377            explicit || !&[Keyword::ASC, Keyword::DESC, Keyword::GROUP].contains(kw)
1378        }
1379        let alias = self.parse_optional_alias_inner(None, validator)?;
1380        let order_by = OrderByOptions {
1381            sort: self.parse_optional_order_by_sort(),
1382            nulls_first: None,
1383        };
1384        Ok(ExprWithAliasAndOrderBy {
1385            expr: ExprWithAlias { expr, alias },
1386            order_by,
1387        })
1388    }
1389
1390    /// Parse tokens until the precedence changes.
1391    #[cfg_attr(feature = "recursive-protection", recursive::recursive)]
1392    pub fn parse_subexpr(&mut self, precedence: u8) -> Result<Expr, ParserError> {
1393        let _guard = self.recursion_counter.try_decrease()?;
1394        debug!("parsing expr");
1395        let mut expr = self.parse_prefix()?;
1396
1397        expr = self.parse_compound_expr(expr, vec![])?;
1398
1399        // Parse an optional collation cast operator following `expr`.
1400        //
1401        // For example (MSSQL): t1.a COLLATE Latin1_General_CI_AS
1402        if !self.in_column_definition_state() && self.parse_keyword(Keyword::COLLATE) {
1403            expr = Expr::Collate {
1404                expr: Box::new(expr),
1405                collation: self.parse_object_name(false)?,
1406            };
1407        }
1408
1409        debug!("prefix: {expr:?}");
1410        loop {
1411            let next_precedence = self.get_next_precedence()?;
1412            debug!("next precedence: {next_precedence:?}");
1413
1414            if precedence >= next_precedence {
1415                break;
1416            }
1417
1418            // The period operator is handled exclusively by the
1419            // compound field access parsing.
1420            if Token::Period == self.peek_token_ref().token {
1421                break;
1422            }
1423
1424            expr = self.parse_infix(expr, next_precedence)?;
1425        }
1426        Ok(expr)
1427    }
1428
1429    /// Parse `ASSERT` statement.
1430    pub fn parse_assert(&mut self) -> Result<Statement, ParserError> {
1431        let condition = self.parse_expr()?;
1432        let message = if self.parse_keyword(Keyword::AS) {
1433            Some(self.parse_expr()?)
1434        } else {
1435            None
1436        };
1437
1438        Ok(Statement::Assert { condition, message })
1439    }
1440
1441    /// Parse `SAVEPOINT` statement.
1442    pub fn parse_savepoint(&mut self) -> Result<Statement, ParserError> {
1443        let name = self.parse_identifier()?;
1444        Ok(Statement::Savepoint { name })
1445    }
1446
1447    /// Parse `RELEASE` statement.
1448    pub fn parse_release(&mut self) -> Result<Statement, ParserError> {
1449        let _ = self.parse_keyword(Keyword::SAVEPOINT);
1450        let name = self.parse_identifier()?;
1451
1452        Ok(Statement::ReleaseSavepoint { name })
1453    }
1454
1455    /// Parse `LISTEN` statement.
1456    pub fn parse_listen(&mut self) -> Result<Statement, ParserError> {
1457        let channel = self.parse_identifier()?;
1458        Ok(Statement::LISTEN { channel })
1459    }
1460
1461    /// Parse `UNLISTEN` statement.
1462    pub fn parse_unlisten(&mut self) -> Result<Statement, ParserError> {
1463        let channel = if self.consume_token(&Token::Mul) {
1464            Ident::new(Expr::Wildcard(AttachedToken::empty()).to_string())
1465        } else {
1466            match self.parse_identifier() {
1467                Ok(expr) => expr,
1468                _ => {
1469                    self.prev_token();
1470                    return self.expected_ref("wildcard or identifier", self.peek_token_ref());
1471                }
1472            }
1473        };
1474        Ok(Statement::UNLISTEN { channel })
1475    }
1476
1477    /// Parse `NOTIFY` statement.
1478    pub fn parse_notify(&mut self) -> Result<Statement, ParserError> {
1479        let channel = self.parse_identifier()?;
1480        let payload = if self.consume_token(&Token::Comma) {
1481            Some(self.parse_literal_string()?)
1482        } else {
1483            None
1484        };
1485        Ok(Statement::NOTIFY { channel, payload })
1486    }
1487
1488    /// Parses a `RENAME TABLE` statement. See [Statement::RenameTable]
1489    pub fn parse_rename(&mut self) -> Result<Statement, ParserError> {
1490        if self.peek_keyword(Keyword::TABLE) {
1491            self.expect_keyword(Keyword::TABLE)?;
1492            let rename_tables = self.parse_comma_separated(|parser| {
1493                let old_name = parser.parse_object_name(false)?;
1494                parser.expect_keyword(Keyword::TO)?;
1495                let new_name = parser.parse_object_name(false)?;
1496
1497                Ok(RenameTable { old_name, new_name })
1498            })?;
1499            Ok(rename_tables.into())
1500        } else {
1501            self.expected_ref("KEYWORD `TABLE` after RENAME", self.peek_token_ref())
1502        }
1503    }
1504
1505    /// Tries to parse an expression by matching the specified word to known keywords that have a special meaning in the dialect.
1506    /// Returns `None if no match is found.
1507    fn parse_expr_prefix_by_reserved_word(
1508        &mut self,
1509        w: &Word,
1510        w_span: Span,
1511    ) -> Result<Option<Expr>, ParserError> {
1512        match w.keyword {
1513            Keyword::TRUE | Keyword::FALSE if self.dialect.supports_boolean_literals() => {
1514                self.prev_token();
1515                Ok(Some(Expr::Value(self.parse_value()?)))
1516            }
1517            Keyword::NULL => {
1518                self.prev_token();
1519                Ok(Some(Expr::Value(self.parse_value()?)))
1520            }
1521            Keyword::CURRENT_CATALOG
1522            | Keyword::CURRENT_USER
1523            | Keyword::SESSION_USER
1524            | Keyword::USER
1525            if dialect_of!(self is PostgreSqlDialect | GenericDialect) =>
1526                {
1527                    Ok(Some(Expr::Function(Function {
1528                        name: ObjectName::from(vec![w.to_ident(w_span)]),
1529                        uses_odbc_syntax: false,
1530                        parameters: FunctionArguments::None,
1531                        args: FunctionArguments::None,
1532                        null_treatment: None,
1533                        filter: None,
1534                        over: None,
1535                        within_group: vec![],
1536                    })))
1537                }
1538            Keyword::CURRENT_TIMESTAMP
1539            | Keyword::CURRENT_TIME
1540            | Keyword::CURRENT_DATE
1541            | Keyword::LOCALTIME
1542            | Keyword::LOCALTIMESTAMP => {
1543                Ok(Some(self.parse_time_functions(ObjectName::from(vec![w.to_ident(w_span)]))?))
1544            }
1545            Keyword::CASE => Ok(Some(self.parse_case_expr()?)),
1546            Keyword::CONVERT => Ok(Some(self.parse_convert_expr(false)?)),
1547            Keyword::TRY_CONVERT if self.dialect.supports_try_convert() => Ok(Some(self.parse_convert_expr(true)?)),
1548            Keyword::CAST => Ok(Some(self.parse_cast_expr(CastKind::Cast)?)),
1549            Keyword::TRY_CAST => Ok(Some(self.parse_cast_expr(CastKind::TryCast)?)),
1550            Keyword::SAFE_CAST => Ok(Some(self.parse_cast_expr(CastKind::SafeCast)?)),
1551            Keyword::EXISTS
1552            // Support parsing Databricks has a function named `exists`.
1553            if !dialect_of!(self is DatabricksDialect)
1554                || matches!(
1555                        self.peek_nth_token_ref(1).token,
1556                        Token::Word(Word {
1557                            keyword: Keyword::SELECT | Keyword::WITH,
1558                            ..
1559                        })
1560                    ) =>
1561                {
1562                    Ok(Some(self.parse_exists_expr(false)?))
1563                }
1564            Keyword::EXTRACT => Ok(Some(self.parse_extract_expr()?)),
1565            Keyword::CEIL => Ok(Some(self.parse_ceil_floor_expr(true)?)),
1566            Keyword::FLOOR => Ok(Some(self.parse_ceil_floor_expr(false)?)),
1567            Keyword::POSITION if self.peek_token_ref().token == Token::LParen => {
1568                Ok(Some(self.parse_position_expr(w.to_ident(w_span))?))
1569            }
1570            Keyword::SUBSTR | Keyword::SUBSTRING => {
1571                self.prev_token();
1572                Ok(Some(self.parse_substring()?))
1573            }
1574            Keyword::OVERLAY => Ok(Some(self.parse_overlay_expr()?)),
1575            Keyword::TRIM => Ok(Some(self.parse_trim_expr()?)),
1576            Keyword::INTERVAL => Ok(Some(self.parse_interval()?)),
1577            // Treat ARRAY[1,2,3] as an array [1,2,3], otherwise try as subquery or a function call
1578            Keyword::ARRAY if *self.peek_token_ref() == Token::LBracket => {
1579                self.expect_token(&Token::LBracket)?;
1580                Ok(Some(self.parse_array_expr(true)?))
1581            }
1582            Keyword::ARRAY
1583            if self.peek_token_ref().token == Token::LParen
1584                && !dialect_of!(self is ClickHouseDialect | DatabricksDialect) =>
1585                {
1586                    self.expect_token(&Token::LParen)?;
1587                    let query = self.parse_query()?;
1588                    self.expect_token(&Token::RParen)?;
1589                    Ok(Some(Expr::Function(Function {
1590                        name: ObjectName::from(vec![w.to_ident(w_span)]),
1591                        uses_odbc_syntax: false,
1592                        parameters: FunctionArguments::None,
1593                        args: FunctionArguments::Subquery(query),
1594                        filter: None,
1595                        null_treatment: None,
1596                        over: None,
1597                        within_group: vec![],
1598                    })))
1599                }
1600            Keyword::NOT => Ok(Some(self.parse_not()?)),
1601            Keyword::MATCH if self.dialect.supports_match_against() => {
1602                Ok(Some(self.parse_match_against()?))
1603            }
1604            Keyword::STRUCT if self.dialect.supports_struct_literal() => {
1605                let struct_expr = self.parse_struct_literal()?;
1606                Ok(Some(struct_expr))
1607            }
1608            Keyword::PRIOR if matches!(self.state, ParserState::ConnectBy) => {
1609                let expr = self.parse_subexpr(self.dialect.prec_value(Precedence::PlusMinus))?;
1610                Ok(Some(Expr::Prior(Box::new(expr))))
1611            }
1612            Keyword::MAP if *self.peek_token_ref() == Token::LBrace && self.dialect.support_map_literal_syntax() => {
1613                Ok(Some(self.parse_duckdb_map_literal()?))
1614            }
1615            Keyword::LAMBDA if self.dialect.supports_lambda_functions() => {
1616                Ok(Some(self.parse_lambda_expr()?))
1617            }
1618            _ if self.dialect.supports_geometric_types() => match w.keyword {
1619                Keyword::CIRCLE => Ok(Some(self.parse_geometric_type(GeometricTypeKind::Circle)?)),
1620                Keyword::BOX => Ok(Some(self.parse_geometric_type(GeometricTypeKind::GeometricBox)?)),
1621                Keyword::PATH => Ok(Some(self.parse_geometric_type(GeometricTypeKind::GeometricPath)?)),
1622                Keyword::LINE => Ok(Some(self.parse_geometric_type(GeometricTypeKind::Line)?)),
1623                Keyword::LSEG => Ok(Some(self.parse_geometric_type(GeometricTypeKind::LineSegment)?)),
1624                Keyword::POINT => Ok(Some(self.parse_geometric_type(GeometricTypeKind::Point)?)),
1625                Keyword::POLYGON => Ok(Some(self.parse_geometric_type(GeometricTypeKind::Polygon)?)),
1626                _ => Ok(None),
1627            },
1628            _ => Ok(None),
1629        }
1630    }
1631
1632    /// Tries to parse an expression by a word that is not known to have a special meaning in the dialect.
1633    fn parse_expr_prefix_by_unreserved_word(
1634        &mut self,
1635        w: &Word,
1636        w_span: Span,
1637    ) -> Result<Expr, ParserError> {
1638        let is_outer_join = self.peek_outer_join_operator();
1639        match &self.peek_token_ref().token {
1640            Token::LParen if !is_outer_join => {
1641                let id_parts = vec![w.to_ident(w_span)];
1642                self.parse_function(ObjectName::from(id_parts))
1643            }
1644            // string introducer https://dev.mysql.com/doc/refman/8.0/en/charset-introducer.html
1645            Token::SingleQuotedString(_)
1646            | Token::DoubleQuotedString(_)
1647            | Token::HexStringLiteral(_)
1648                if w.value.starts_with('_') =>
1649            {
1650                Ok(Expr::Prefixed {
1651                    prefix: w.to_ident(w_span),
1652                    value: self.parse_introduced_string_expr()?.into(),
1653                })
1654            }
1655            // string introducer https://dev.mysql.com/doc/refman/8.0/en/charset-introducer.html
1656            Token::SingleQuotedString(_)
1657            | Token::DoubleQuotedString(_)
1658            | Token::HexStringLiteral(_)
1659                if w.value.starts_with('_') =>
1660            {
1661                Ok(Expr::Prefixed {
1662                    prefix: w.to_ident(w_span),
1663                    value: self.parse_introduced_string_expr()?.into(),
1664                })
1665            }
1666            // An unreserved word (likely an identifier) is followed by an arrow,
1667            // which indicates a lambda function with a single, untyped parameter.
1668            // For example: `a -> a * 2`.
1669            Token::Arrow if self.dialect.supports_lambda_functions() => {
1670                self.expect_token(&Token::Arrow)?;
1671                Ok(Expr::Lambda(LambdaFunction {
1672                    params: OneOrManyWithParens::One(LambdaFunctionParameter {
1673                        name: w.to_ident(w_span),
1674                        data_type: None,
1675                    }),
1676                    body: Box::new(self.parse_expr()?),
1677                    syntax: LambdaSyntax::Arrow,
1678                }))
1679            }
1680            // An unreserved word (likely an identifier) that is followed by another word (likley a data type)
1681            // which is then followed by an arrow, which indicates a lambda function with a single, typed parameter.
1682            // For example: `a INT -> a * 2`.
1683            Token::Word(_)
1684                if self.dialect.supports_lambda_functions()
1685                    && self.peek_nth_token_ref(1).token == Token::Arrow =>
1686            {
1687                let data_type = self.parse_data_type()?;
1688                self.expect_token(&Token::Arrow)?;
1689                Ok(Expr::Lambda(LambdaFunction {
1690                    params: OneOrManyWithParens::One(LambdaFunctionParameter {
1691                        name: w.to_ident(w_span),
1692                        data_type: Some(data_type),
1693                    }),
1694                    body: Box::new(self.parse_expr()?),
1695                    syntax: LambdaSyntax::Arrow,
1696                }))
1697            }
1698            _ => Ok(Expr::Identifier(w.to_ident(w_span))),
1699        }
1700    }
1701
1702    /// Returns true if the given [ObjectName] is a single unquoted
1703    /// identifier matching `expected` (case-insensitive).
1704    fn is_simple_unquoted_object_name(name: &ObjectName, expected: &str) -> bool {
1705        if let [ObjectNamePart::Identifier(ident)] = name.0.as_slice() {
1706            ident.quote_style.is_none() && ident.value.eq_ignore_ascii_case(expected)
1707        } else {
1708            false
1709        }
1710    }
1711
1712    /// Parse an expression prefix.
1713    pub fn parse_prefix(&mut self) -> Result<Expr, ParserError> {
1714        // allow the dialect to override prefix parsing
1715        if let Some(prefix) = self.dialect.parse_prefix(self) {
1716            return prefix;
1717        }
1718
1719        // PostgreSQL allows any string literal to be preceded by a type name, indicating that the
1720        // string literal represents a literal of that type. Some examples:
1721        //
1722        //      DATE '2020-05-20'
1723        //      TIMESTAMP WITH TIME ZONE '2020-05-20 7:43:54'
1724        //      BOOL 'true'
1725        //
1726        // The first two are standard SQL, while the latter is a PostgreSQL extension. Complicating
1727        // matters is the fact that INTERVAL string literals may optionally be followed by special
1728        // keywords, e.g.:
1729        //
1730        //      INTERVAL '7' DAY
1731        //
1732        // Note also that naively `SELECT date` looks like a syntax error because the `date` type
1733        // name is not followed by a string literal, but in fact in PostgreSQL it is a valid
1734        // expression that should parse as the column name "date".
1735        let loc = self.peek_token_ref().span.start;
1736        let opt_expr = self.maybe_parse(|parser| {
1737            match parser.parse_data_type()? {
1738                DataType::Interval { .. } => parser.parse_interval(),
1739                // PostgreSQL allows almost any identifier to be used as custom data type name,
1740                // and we support that in `parse_data_type()`. But unlike Postgres we don't
1741                // have a list of globally reserved keywords (since they vary across dialects),
1742                // so given `NOT 'a' LIKE 'b'`, we'd accept `NOT` as a possible custom data type
1743                // name, resulting in `NOT 'a'` being recognized as a `TypedString` instead of
1744                // an unary negation `NOT ('a' LIKE 'b')`. To solve this, we don't accept the
1745                // `type 'string'` syntax for the custom data types at all ...
1746                //
1747                // ... with the exception of `xml '...'` on dialects that support XML
1748                // expressions, which is a valid PostgreSQL typed string literal.
1749                DataType::Custom(ref name, ref modifiers)
1750                    if modifiers.is_empty()
1751                        && Self::is_simple_unquoted_object_name(name, "xml")
1752                        && parser.dialect.supports_xml_expressions() =>
1753                {
1754                    Ok(Expr::TypedString(TypedString {
1755                        data_type: DataType::Custom(name.clone(), modifiers.clone()),
1756                        value: parser.parse_value()?,
1757                        uses_odbc_syntax: false,
1758                    }))
1759                }
1760                DataType::Custom(..) => parser_err!("dummy", loc),
1761                // MySQL supports using the `BINARY` keyword as a cast to binary type.
1762                DataType::Binary(..) if self.dialect.supports_binary_kw_as_cast() => {
1763                    Ok(Expr::Cast {
1764                        kind: CastKind::Cast,
1765                        expr: Box::new(parser.parse_expr()?),
1766                        data_type: DataType::Binary(None),
1767                        array: false,
1768                        format: None,
1769                    })
1770                }
1771                data_type => Ok(Expr::TypedString(TypedString {
1772                    data_type,
1773                    value: parser.parse_value()?,
1774                    uses_odbc_syntax: false,
1775                })),
1776            }
1777        })?;
1778
1779        if let Some(expr) = opt_expr {
1780            return Ok(expr);
1781        }
1782
1783        // Cache some dialect properties to avoid lifetime issues with the
1784        // next_token reference.
1785
1786        let dialect = self.dialect;
1787
1788        self.advance_token();
1789        let next_token_index = self.get_current_index();
1790        let next_token = self.get_current_token();
1791        let span = next_token.span;
1792        let expr = match &next_token.token {
1793            Token::Word(w) => {
1794                // The word we consumed may fall into one of two cases: it has a special meaning, or not.
1795                // For example, in Snowflake, the word `interval` may have two meanings depending on the context:
1796                // `SELECT CURRENT_DATE() + INTERVAL '1 DAY', MAX(interval) FROM tbl;`
1797                //                          ^^^^^^^^^^^^^^^^      ^^^^^^^^
1798                //                         interval expression   identifier
1799                //
1800                // We first try to parse the word and following tokens as a special expression, and if that fails,
1801                // we rollback and try to parse it as an identifier.
1802                let w = w.clone();
1803                match self.try_parse(|parser| parser.parse_expr_prefix_by_reserved_word(&w, span)) {
1804                    // This word indicated an expression prefix and parsing was successful
1805                    Ok(Some(expr)) => Ok(expr),
1806
1807                    // No expression prefix associated with this word
1808                    Ok(None) => Ok(self.parse_expr_prefix_by_unreserved_word(&w, span)?),
1809
1810                    // If parsing of the word as a special expression failed, we are facing two options:
1811                    // 1. The statement is malformed, e.g. `SELECT INTERVAL '1 DAI` (`DAI` instead of `DAY`)
1812                    // 2. The word is used as an identifier, e.g. `SELECT MAX(interval) FROM tbl`
1813                    // We first try to parse the word as an identifier and if that fails
1814                    // we rollback and return the parsing error we got from trying to parse a
1815                    // special expression (to maintain backwards compatibility of parsing errors).
1816                    Err(e) => {
1817                        if !self.dialect.is_reserved_for_identifier(w.keyword) {
1818                            if let Ok(Some(expr)) = self.maybe_parse(|parser| {
1819                                parser.parse_expr_prefix_by_unreserved_word(&w, span)
1820                            }) {
1821                                return Ok(expr);
1822                            }
1823                        }
1824                        return Err(e);
1825                    }
1826                }
1827            } // End of Token::Word
1828            // array `[1, 2, 3]`
1829            Token::LBracket => self.parse_array_expr(false),
1830            tok @ Token::Minus | tok @ Token::Plus => {
1831                let op = if *tok == Token::Plus {
1832                    UnaryOperator::Plus
1833                } else {
1834                    UnaryOperator::Minus
1835                };
1836                Ok(Expr::UnaryOp {
1837                    op,
1838                    expr: Box::new(
1839                        self.parse_subexpr(self.dialect.prec_value(Precedence::MulDivModOp))?,
1840                    ),
1841                })
1842            }
1843            Token::ExclamationMark if dialect.supports_bang_not_operator() => Ok(Expr::UnaryOp {
1844                op: UnaryOperator::BangNot,
1845                expr: Box::new(self.parse_subexpr(self.dialect.prec_value(Precedence::UnaryNot))?),
1846            }),
1847            tok @ Token::DoubleExclamationMark
1848            | tok @ Token::PGSquareRoot
1849            | tok @ Token::PGCubeRoot
1850            | tok @ Token::AtSign
1851                if dialect_is!(dialect is PostgreSqlDialect) =>
1852            {
1853                let op = match tok {
1854                    Token::DoubleExclamationMark => UnaryOperator::PGPrefixFactorial,
1855                    Token::PGSquareRoot => UnaryOperator::PGSquareRoot,
1856                    Token::PGCubeRoot => UnaryOperator::PGCubeRoot,
1857                    Token::AtSign => UnaryOperator::PGAbs,
1858                    _ => {
1859                        return Err(ParserError::ParserError(
1860                            "Internal parser error: unexpected unary operator token".to_string(),
1861                        ))
1862                    }
1863                };
1864                Ok(Expr::UnaryOp {
1865                    op,
1866                    expr: Box::new(
1867                        self.parse_subexpr(self.dialect.prec_value(Precedence::PlusMinus))?,
1868                    ),
1869                })
1870            }
1871            Token::Tilde => Ok(Expr::UnaryOp {
1872                op: UnaryOperator::BitwiseNot,
1873                expr: Box::new(self.parse_subexpr(self.dialect.prec_value(Precedence::PlusMinus))?),
1874            }),
1875            tok @ Token::Sharp
1876            | tok @ Token::AtDashAt
1877            | tok @ Token::AtAt
1878            | tok @ Token::QuestionMarkDash
1879            | tok @ Token::QuestionPipe
1880                if self.dialect.supports_geometric_types() =>
1881            {
1882                let op = match tok {
1883                    Token::Sharp => UnaryOperator::Hash,
1884                    Token::AtDashAt => UnaryOperator::AtDashAt,
1885                    Token::AtAt => UnaryOperator::DoubleAt,
1886                    Token::QuestionMarkDash => UnaryOperator::QuestionDash,
1887                    Token::QuestionPipe => UnaryOperator::QuestionPipe,
1888                    _ => {
1889                        return Err(ParserError::ParserError(format!(
1890                            "Unexpected token in unary operator parsing: {tok:?}"
1891                        )))
1892                    }
1893                };
1894                Ok(Expr::UnaryOp {
1895                    op,
1896                    expr: Box::new(
1897                        self.parse_subexpr(self.dialect.prec_value(Precedence::PlusMinus))?,
1898                    ),
1899                })
1900            }
1901            Token::EscapedStringLiteral(_) if dialect_is!(dialect is PostgreSqlDialect | GenericDialect) =>
1902            {
1903                self.prev_token();
1904                Ok(Expr::Value(self.parse_value()?))
1905            }
1906            Token::UnicodeStringLiteral(_) => {
1907                self.prev_token();
1908                Ok(Expr::Value(self.parse_value()?))
1909            }
1910            Token::Number(_, _)
1911            | Token::SingleQuotedString(_)
1912            | Token::DoubleQuotedString(_)
1913            | Token::TripleSingleQuotedString(_)
1914            | Token::TripleDoubleQuotedString(_)
1915            | Token::DollarQuotedString(_)
1916            | Token::SingleQuotedByteStringLiteral(_)
1917            | Token::DoubleQuotedByteStringLiteral(_)
1918            | Token::TripleSingleQuotedByteStringLiteral(_)
1919            | Token::TripleDoubleQuotedByteStringLiteral(_)
1920            | Token::SingleQuotedRawStringLiteral(_)
1921            | Token::DoubleQuotedRawStringLiteral(_)
1922            | Token::TripleSingleQuotedRawStringLiteral(_)
1923            | Token::TripleDoubleQuotedRawStringLiteral(_)
1924            | Token::NationalStringLiteral(_)
1925            | Token::QuoteDelimitedStringLiteral(_)
1926            | Token::NationalQuoteDelimitedStringLiteral(_)
1927            | Token::HexStringLiteral(_) => {
1928                self.prev_token();
1929                Ok(Expr::Value(self.parse_value()?))
1930            }
1931            Token::LParen => {
1932                let expr =
1933                    if let Some(expr) = self.try_parse_expr_sub_query()? {
1934                        expr
1935                    } else if let Some(lambda) = self.try_parse_lambda()? {
1936                        return Ok(lambda);
1937                    } else {
1938                        // Parentheses in expressions switch to "normal" parsing state.
1939                        // This matters for dialects (SQLite, DuckDB) where `NOT NULL` can
1940                        // be an alias for `IS NOT NULL`. In column definitions like:
1941                        //
1942                        //   CREATE TABLE t (c INT DEFAULT (42 NOT NULL) NOT NULL)
1943                        //
1944                        // The `(42 NOT NULL)` is an expression with parens, so it parses
1945                        // as `IsNotNull(42)`. The trailing `NOT NULL` is outside those
1946                        // expression parens (the outer parens are CREATE TABLE syntax),
1947                        // so it remains a column constraint.
1948                        let exprs = self.with_state(ParserState::Normal, |p| {
1949                            p.parse_comma_separated(Parser::parse_expr)
1950                        })?;
1951                        match exprs.len() {
1952                            0 => return Err(ParserError::ParserError(
1953                                "Internal parser error: parse_comma_separated returned empty list"
1954                                    .to_string(),
1955                            )),
1956                            1 => Expr::Nested(Box::new(exprs.into_iter().next().unwrap())),
1957                            _ => Expr::Tuple(exprs),
1958                        }
1959                    };
1960                self.expect_token(&Token::RParen)?;
1961                Ok(expr)
1962            }
1963            Token::Placeholder(_) | Token::Colon | Token::AtSign => {
1964                self.prev_token();
1965                Ok(Expr::Value(self.parse_value()?))
1966            }
1967            Token::LBrace => {
1968                self.prev_token();
1969                self.parse_lbrace_expr()
1970            }
1971            _ => self.expected_at("an expression", next_token_index),
1972        }?;
1973
1974        Ok(expr)
1975    }
1976
1977    fn parse_geometric_type(&mut self, kind: GeometricTypeKind) -> Result<Expr, ParserError> {
1978        Ok(Expr::TypedString(TypedString {
1979            data_type: DataType::GeometricType(kind),
1980            value: self.parse_value()?,
1981            uses_odbc_syntax: false,
1982        }))
1983    }
1984
1985    /// Try to parse an [Expr::CompoundFieldAccess] like `a.b.c` or `a.b[1].c`.
1986    /// If all the fields are `Expr::Identifier`s, return an [Expr::CompoundIdentifier] instead.
1987    /// If only the root exists, return the root.
1988    /// Parses compound expressions which may be delimited by period
1989    /// or bracket notation.
1990    /// For example: `a.b.c`, `a.b[1]`.
1991    pub fn parse_compound_expr(
1992        &mut self,
1993        root: Expr,
1994        mut chain: Vec<AccessExpr>,
1995    ) -> Result<Expr, ParserError> {
1996        let mut ending_wildcard: Option<TokenWithSpan> = None;
1997        loop {
1998            if self.consume_token(&Token::Period) {
1999                let next_token = self.peek_token_ref();
2000                match &next_token.token {
2001                    Token::Mul => {
2002                        // Postgres explicitly allows funcnm(tablenm.*) and the
2003                        // function array_agg traverses this control flow
2004                        if dialect_of!(self is PostgreSqlDialect) {
2005                            ending_wildcard = Some(self.next_token());
2006                        } else {
2007                            // Put back the consumed `.` tokens before exiting.
2008                            // If this expression is being parsed in the
2009                            // context of a projection, then the `.*` could imply
2010                            // a wildcard expansion. For example:
2011                            // `SELECT STRUCT('foo').* FROM T`
2012                            self.prev_token(); // .
2013                        }
2014
2015                        break;
2016                    }
2017                    Token::SingleQuotedString(s) => {
2018                        let expr =
2019                            Expr::Identifier(Ident::with_quote_and_span('\'', next_token.span, s));
2020                        chain.push(AccessExpr::Dot(expr));
2021                        self.advance_token(); // The consumed string
2022                    }
2023                    Token::Placeholder(s) => {
2024                        // Snowflake uses $1, $2, etc. for positional column references
2025                        // in staged data queries like: SELECT t.$1 FROM @stage t
2026                        let expr = Expr::Identifier(Ident::with_span(next_token.span, s));
2027                        chain.push(AccessExpr::Dot(expr));
2028                        self.advance_token(); // The consumed placeholder
2029                    }
2030                    // Fallback to parsing an arbitrary expression, but restrict to expression
2031                    // types that are valid after the dot operator. This ensures that e.g.
2032                    // `T.interval` is parsed as a compound identifier, not as an interval
2033                    // expression.
2034                    _ => {
2035                        let expr = self.maybe_parse(|parser| {
2036                            let expr = parser
2037                                .parse_subexpr(parser.dialect.prec_value(Precedence::Period))?;
2038                            match &expr {
2039                                Expr::CompoundFieldAccess { .. }
2040                                | Expr::CompoundIdentifier(_)
2041                                | Expr::Identifier(_)
2042                                | Expr::Value(_)
2043                                | Expr::Function(_) => Ok(expr),
2044                                _ => parser.expected_ref(
2045                                    "an identifier or value",
2046                                    parser.peek_token_ref(),
2047                                ),
2048                            }
2049                        })?;
2050
2051                        match expr {
2052                            // If we get back a compound field access or identifier,
2053                            // we flatten the nested expression.
2054                            // For example if the current root is `foo`
2055                            // and we get back a compound identifier expression `bar.baz`
2056                            // The full expression should be `foo.bar.baz` (i.e.
2057                            // a root with an access chain with 2 entries) and not
2058                            // `foo.(bar.baz)` (i.e. a root with an access chain with
2059                            // 1 entry`).
2060                            Some(Expr::CompoundFieldAccess { root, access_chain }) => {
2061                                chain.push(AccessExpr::Dot(*root));
2062                                chain.extend(access_chain);
2063                            }
2064                            Some(Expr::CompoundIdentifier(parts)) => chain.extend(
2065                                parts.into_iter().map(Expr::Identifier).map(AccessExpr::Dot),
2066                            ),
2067                            Some(expr) => {
2068                                chain.push(AccessExpr::Dot(expr));
2069                            }
2070                            // If the expression is not a valid suffix, fall back to
2071                            // parsing as an identifier. This handles cases like `T.interval`
2072                            // where `interval` is a keyword but should be treated as an identifier.
2073                            None => {
2074                                chain.push(AccessExpr::Dot(Expr::Identifier(
2075                                    self.parse_identifier()?,
2076                                )));
2077                            }
2078                        }
2079                    }
2080                }
2081            } else if !self.dialect.supports_partiql()
2082                && self.peek_token_ref().token == Token::LBracket
2083            {
2084                self.parse_multi_dim_subscript(&mut chain)?;
2085            } else {
2086                break;
2087            }
2088        }
2089
2090        let tok_index = self.get_current_index();
2091        if let Some(wildcard_token) = ending_wildcard {
2092            if !Self::is_all_ident(&root, &chain) {
2093                return self
2094                    .expected_ref("an identifier or a '*' after '.'", self.peek_token_ref());
2095            };
2096            Ok(Expr::QualifiedWildcard(
2097                ObjectName::from(Self::exprs_to_idents(root, chain)?),
2098                AttachedToken(wildcard_token),
2099            ))
2100        } else if self.maybe_parse_outer_join_operator() {
2101            if !Self::is_all_ident(&root, &chain) {
2102                return self.expected_at("column identifier before (+)", tok_index);
2103            };
2104            let expr = if chain.is_empty() {
2105                root
2106            } else {
2107                Expr::CompoundIdentifier(Self::exprs_to_idents(root, chain)?)
2108            };
2109            Ok(Expr::OuterJoin(expr.into()))
2110        } else {
2111            Self::build_compound_expr(root, chain)
2112        }
2113    }
2114
2115    /// Combines a root expression and access chain to form
2116    /// a compound expression. Which may be a [Expr::CompoundFieldAccess]
2117    /// or other special cased expressions like [Expr::CompoundIdentifier],
2118    /// [Expr::OuterJoin].
2119    fn build_compound_expr(
2120        root: Expr,
2121        mut access_chain: Vec<AccessExpr>,
2122    ) -> Result<Expr, ParserError> {
2123        if access_chain.is_empty() {
2124            return Ok(root);
2125        }
2126
2127        if Self::is_all_ident(&root, &access_chain) {
2128            return Ok(Expr::CompoundIdentifier(Self::exprs_to_idents(
2129                root,
2130                access_chain,
2131            )?));
2132        }
2133
2134        // Flatten qualified function calls.
2135        // For example, the expression `a.b.c.foo(1,2,3)` should
2136        // represent a function called `a.b.c.foo`, rather than
2137        // a composite expression.
2138        if matches!(root, Expr::Identifier(_))
2139            && matches!(
2140                access_chain.last(),
2141                Some(AccessExpr::Dot(Expr::Function(_)))
2142            )
2143            && access_chain
2144                .iter()
2145                .rev()
2146                .skip(1) // All except the Function
2147                .all(|access| matches!(access, AccessExpr::Dot(Expr::Identifier(_))))
2148        {
2149            let Some(AccessExpr::Dot(Expr::Function(mut func))) = access_chain.pop() else {
2150                return parser_err!("expected function expression", root.span().start);
2151            };
2152
2153            let compound_func_name = [root]
2154                .into_iter()
2155                .chain(access_chain.into_iter().flat_map(|access| match access {
2156                    AccessExpr::Dot(expr) => Some(expr),
2157                    _ => None,
2158                }))
2159                .flat_map(|expr| match expr {
2160                    Expr::Identifier(ident) => Some(ident),
2161                    _ => None,
2162                })
2163                .map(ObjectNamePart::Identifier)
2164                .chain(func.name.0)
2165                .collect::<Vec<_>>();
2166            func.name = ObjectName(compound_func_name);
2167
2168            return Ok(Expr::Function(func));
2169        }
2170
2171        // Flatten qualified outer join expressions.
2172        // For example, the expression `T.foo(+)` should
2173        // represent an outer join on the column name `T.foo`
2174        // rather than a composite expression.
2175        if access_chain.len() == 1
2176            && matches!(
2177                access_chain.last(),
2178                Some(AccessExpr::Dot(Expr::OuterJoin(_)))
2179            )
2180        {
2181            let Some(AccessExpr::Dot(Expr::OuterJoin(inner_expr))) = access_chain.pop() else {
2182                return parser_err!("expected (+) expression", root.span().start);
2183            };
2184
2185            if !Self::is_all_ident(&root, &[]) {
2186                return parser_err!("column identifier before (+)", root.span().start);
2187            };
2188
2189            let token_start = root.span().start;
2190            let mut idents = Self::exprs_to_idents(root, vec![])?;
2191            match *inner_expr {
2192                Expr::CompoundIdentifier(suffix) => idents.extend(suffix),
2193                Expr::Identifier(suffix) => idents.push(suffix),
2194                _ => {
2195                    return parser_err!("column identifier before (+)", token_start);
2196                }
2197            }
2198
2199            return Ok(Expr::OuterJoin(Expr::CompoundIdentifier(idents).into()));
2200        }
2201
2202        Ok(Expr::CompoundFieldAccess {
2203            root: Box::new(root),
2204            access_chain,
2205        })
2206    }
2207
2208    fn keyword_to_modifier(k: Keyword) -> Option<ContextModifier> {
2209        match k {
2210            Keyword::LOCAL => Some(ContextModifier::Local),
2211            Keyword::GLOBAL => Some(ContextModifier::Global),
2212            Keyword::SESSION => Some(ContextModifier::Session),
2213            _ => None,
2214        }
2215    }
2216
2217    /// Check if the root is an identifier and all fields are identifiers.
2218    fn is_all_ident(root: &Expr, fields: &[AccessExpr]) -> bool {
2219        if !matches!(root, Expr::Identifier(_)) {
2220            return false;
2221        }
2222        fields
2223            .iter()
2224            .all(|x| matches!(x, AccessExpr::Dot(Expr::Identifier(_))))
2225    }
2226
2227    /// Convert a root and a list of fields to a list of identifiers.
2228    fn exprs_to_idents(root: Expr, fields: Vec<AccessExpr>) -> Result<Vec<Ident>, ParserError> {
2229        let mut idents = vec![];
2230        if let Expr::Identifier(root) = root {
2231            idents.push(root);
2232            for x in fields {
2233                if let AccessExpr::Dot(Expr::Identifier(ident)) = x {
2234                    idents.push(ident);
2235                } else {
2236                    return parser_err!(
2237                        format!("Expected identifier, found: {}", x),
2238                        x.span().start
2239                    );
2240                }
2241            }
2242            Ok(idents)
2243        } else {
2244            parser_err!(
2245                format!("Expected identifier, found: {}", root),
2246                root.span().start
2247            )
2248        }
2249    }
2250
2251    /// Returns true if the next tokens indicate the outer join operator `(+)`.
2252    fn peek_outer_join_operator(&mut self) -> bool {
2253        if !self.dialect.supports_outer_join_operator() {
2254            return false;
2255        }
2256
2257        let [maybe_lparen, maybe_plus, maybe_rparen] = self.peek_tokens_ref();
2258        Token::LParen == maybe_lparen.token
2259            && Token::Plus == maybe_plus.token
2260            && Token::RParen == maybe_rparen.token
2261    }
2262
2263    /// If the next tokens indicates the outer join operator `(+)`, consume
2264    /// the tokens and return true.
2265    fn maybe_parse_outer_join_operator(&mut self) -> bool {
2266        self.dialect.supports_outer_join_operator()
2267            && self.consume_tokens(&[Token::LParen, Token::Plus, Token::RParen])
2268    }
2269
2270    /// Parse utility options in the form of `(option1, option2 arg2, option3 arg3, ...)`
2271    pub fn parse_utility_options(&mut self) -> Result<Vec<UtilityOption>, ParserError> {
2272        self.expect_token(&Token::LParen)?;
2273        let options = self.parse_comma_separated(Self::parse_utility_option)?;
2274        self.expect_token(&Token::RParen)?;
2275
2276        Ok(options)
2277    }
2278
2279    fn parse_utility_option(&mut self) -> Result<UtilityOption, ParserError> {
2280        let name = self.parse_identifier()?;
2281
2282        let next_token = self.peek_token_ref();
2283        if next_token == &Token::Comma || next_token == &Token::RParen {
2284            return Ok(UtilityOption { name, arg: None });
2285        }
2286        let arg = self.parse_expr()?;
2287
2288        Ok(UtilityOption {
2289            name,
2290            arg: Some(arg),
2291        })
2292    }
2293
2294    fn try_parse_expr_sub_query(&mut self) -> Result<Option<Expr>, ParserError> {
2295        if !self.peek_sub_query() {
2296            return Ok(None);
2297        }
2298
2299        Ok(Some(Expr::Subquery(self.parse_query()?)))
2300    }
2301
2302    fn try_parse_lambda(&mut self) -> Result<Option<Expr>, ParserError> {
2303        if !self.dialect.supports_lambda_functions() {
2304            return Ok(None);
2305        }
2306        self.maybe_parse(|p| {
2307            let params = p.parse_comma_separated(|p| p.parse_lambda_function_parameter())?;
2308            p.expect_token(&Token::RParen)?;
2309            p.expect_token(&Token::Arrow)?;
2310            let expr = p.parse_expr()?;
2311            Ok(Expr::Lambda(LambdaFunction {
2312                params: OneOrManyWithParens::Many(params),
2313                body: Box::new(expr),
2314                syntax: LambdaSyntax::Arrow,
2315            }))
2316        })
2317    }
2318
2319    /// Parses a lambda expression following the `LAMBDA` keyword syntax.
2320    ///
2321    /// Syntax: `LAMBDA <params> : <expr>`
2322    ///
2323    /// Examples:
2324    /// - `LAMBDA x : x + 1`
2325    /// - `LAMBDA x, i : x > i`
2326    ///
2327    /// See <https://duckdb.org/docs/stable/sql/functions/lambda>
2328    fn parse_lambda_expr(&mut self) -> Result<Expr, ParserError> {
2329        // Parse the parameters: either a single identifier or comma-separated identifiers
2330        let params = self.parse_lambda_function_parameters()?;
2331        // Expect the colon separator
2332        self.expect_token(&Token::Colon)?;
2333        // Parse the body expression
2334        let body = self.parse_expr()?;
2335        Ok(Expr::Lambda(LambdaFunction {
2336            params,
2337            body: Box::new(body),
2338            syntax: LambdaSyntax::LambdaKeyword,
2339        }))
2340    }
2341
2342    /// Parses the parameters of a lambda function with optional typing.
2343    fn parse_lambda_function_parameters(
2344        &mut self,
2345    ) -> Result<OneOrManyWithParens<LambdaFunctionParameter>, ParserError> {
2346        // Parse the parameters: either a single identifier or comma-separated identifiers
2347        let params = if self.consume_token(&Token::LParen) {
2348            // Parenthesized parameters: (x, y)
2349            let params = self.parse_comma_separated(|p| p.parse_lambda_function_parameter())?;
2350            self.expect_token(&Token::RParen)?;
2351            OneOrManyWithParens::Many(params)
2352        } else {
2353            // Unparenthesized parameters: x or x, y
2354            let params = self.parse_comma_separated(|p| p.parse_lambda_function_parameter())?;
2355            if params.len() == 1 {
2356                OneOrManyWithParens::One(params.into_iter().next().unwrap())
2357            } else {
2358                OneOrManyWithParens::Many(params)
2359            }
2360        };
2361        Ok(params)
2362    }
2363
2364    /// Parses a single parameter of a lambda function, with optional typing.
2365    fn parse_lambda_function_parameter(&mut self) -> Result<LambdaFunctionParameter, ParserError> {
2366        let name = self.parse_identifier()?;
2367        let data_type = match &self.peek_token_ref().token {
2368            Token::Word(_) => self.maybe_parse(|p| p.parse_data_type())?,
2369            _ => None,
2370        };
2371        Ok(LambdaFunctionParameter { name, data_type })
2372    }
2373
2374    /// Tries to parse the body of an [ODBC escaping sequence]
2375    /// i.e. without the enclosing braces
2376    /// Currently implemented:
2377    /// Scalar Function Calls
2378    /// Date, Time, and Timestamp Literals
2379    /// See <https://learn.microsoft.com/en-us/sql/odbc/reference/develop-app/escape-sequences-in-odbc?view=sql-server-2017>
2380    fn maybe_parse_odbc_body(&mut self) -> Result<Option<Expr>, ParserError> {
2381        // Attempt 1: Try to parse it as a function.
2382        if let Some(expr) = self.maybe_parse_odbc_fn_body()? {
2383            return Ok(Some(expr));
2384        }
2385        // Attempt 2: Try to parse it as a Date, Time or Timestamp Literal
2386        self.maybe_parse_odbc_body_datetime()
2387    }
2388
2389    /// Tries to parse the body of an [ODBC Date, Time, and Timestamp Literals] call.
2390    ///
2391    /// ```sql
2392    /// {d '2025-07-17'}
2393    /// {t '14:12:01'}
2394    /// {ts '2025-07-17 14:12:01'}
2395    /// ```
2396    ///
2397    /// [ODBC Date, Time, and Timestamp Literals]:
2398    /// https://learn.microsoft.com/en-us/sql/odbc/reference/develop-app/date-time-and-timestamp-literals?view=sql-server-2017
2399    fn maybe_parse_odbc_body_datetime(&mut self) -> Result<Option<Expr>, ParserError> {
2400        self.maybe_parse(|p| {
2401            let token = p.next_token().clone();
2402            let word_string = token.token.to_string();
2403            let data_type = match word_string.as_str() {
2404                "t" => DataType::Time(None, TimezoneInfo::None),
2405                "d" => DataType::Date,
2406                "ts" => DataType::Timestamp(None, TimezoneInfo::None),
2407                _ => return p.expected("ODBC datetime keyword (t, d, or ts)", token),
2408            };
2409            let value = p.parse_value()?;
2410            Ok(Expr::TypedString(TypedString {
2411                data_type,
2412                value,
2413                uses_odbc_syntax: true,
2414            }))
2415        })
2416    }
2417
2418    /// Tries to parse the body of an [ODBC function] call.
2419    /// i.e. without the enclosing braces
2420    ///
2421    /// ```sql
2422    /// fn myfunc(1,2,3)
2423    /// ```
2424    ///
2425    /// [ODBC function]: https://learn.microsoft.com/en-us/sql/odbc/reference/develop-app/scalar-function-calls?view=sql-server-2017
2426    fn maybe_parse_odbc_fn_body(&mut self) -> Result<Option<Expr>, ParserError> {
2427        self.maybe_parse(|p| {
2428            p.expect_keyword(Keyword::FN)?;
2429            let fn_name = p.parse_object_name(false)?;
2430            let mut fn_call = p.parse_function_call(fn_name)?;
2431            fn_call.uses_odbc_syntax = true;
2432            Ok(Expr::Function(fn_call))
2433        })
2434    }
2435
2436    /// Parse a function call expression named by `name` and return it as an `Expr`.
2437    pub fn parse_function(&mut self, name: ObjectName) -> Result<Expr, ParserError> {
2438        self.parse_function_call(name).map(Expr::Function)
2439    }
2440
2441    fn parse_function_call(&mut self, name: ObjectName) -> Result<Function, ParserError> {
2442        self.expect_token(&Token::LParen)?;
2443
2444        // Snowflake permits a subquery to be passed as an argument without
2445        // an enclosing set of parens if it's the only argument.
2446        if self.dialect.supports_subquery_as_function_arg() && self.peek_sub_query() {
2447            let subquery = self.parse_query()?;
2448            self.expect_token(&Token::RParen)?;
2449            return Ok(Function {
2450                name,
2451                uses_odbc_syntax: false,
2452                parameters: FunctionArguments::None,
2453                args: FunctionArguments::Subquery(subquery),
2454                filter: None,
2455                null_treatment: None,
2456                over: None,
2457                within_group: vec![],
2458            });
2459        }
2460
2461        let mut args = self.parse_function_argument_list()?;
2462        let mut parameters = FunctionArguments::None;
2463        // ClickHouse aggregations support parametric functions like `HISTOGRAM(0.5, 0.6)(x, y)`
2464        // which (0.5, 0.6) is a parameter to the function.
2465        if dialect_of!(self is ClickHouseDialect | GenericDialect)
2466            && self.consume_token(&Token::LParen)
2467        {
2468            parameters = FunctionArguments::List(args);
2469            args = self.parse_function_argument_list()?;
2470        }
2471
2472        let within_group = if self.parse_keywords(&[Keyword::WITHIN, Keyword::GROUP]) {
2473            self.expect_token(&Token::LParen)?;
2474            self.expect_keywords(&[Keyword::ORDER, Keyword::BY])?;
2475            let order_by = self.parse_comma_separated(Parser::parse_order_by_expr)?;
2476            self.expect_token(&Token::RParen)?;
2477            order_by
2478        } else {
2479            vec![]
2480        };
2481
2482        let filter = if self.dialect.supports_filter_during_aggregation()
2483            && self.parse_keyword(Keyword::FILTER)
2484            && self.consume_token(&Token::LParen)
2485            && self.parse_keyword(Keyword::WHERE)
2486        {
2487            let filter = Some(Box::new(self.parse_expr()?));
2488            self.expect_token(&Token::RParen)?;
2489            filter
2490        } else {
2491            None
2492        };
2493
2494        // Syntax for null treatment shows up either in the args list
2495        // or after the function call, but not both.
2496        let null_treatment = if args
2497            .clauses
2498            .iter()
2499            .all(|clause| !matches!(clause, FunctionArgumentClause::IgnoreOrRespectNulls(_)))
2500        {
2501            self.parse_null_treatment()?
2502        } else {
2503            None
2504        };
2505
2506        let over = if self.parse_keyword(Keyword::OVER) {
2507            if self.consume_token(&Token::LParen) {
2508                let window_spec = self.parse_window_spec()?;
2509                Some(WindowType::WindowSpec(window_spec))
2510            } else {
2511                Some(WindowType::NamedWindow(self.parse_identifier()?))
2512            }
2513        } else {
2514            None
2515        };
2516
2517        Ok(Function {
2518            name,
2519            uses_odbc_syntax: false,
2520            parameters,
2521            args: FunctionArguments::List(args),
2522            null_treatment,
2523            filter,
2524            over,
2525            within_group,
2526        })
2527    }
2528
2529    /// Optionally parses a null treatment clause.
2530    fn parse_null_treatment(&mut self) -> Result<Option<NullTreatment>, ParserError> {
2531        match self.parse_one_of_keywords(&[Keyword::RESPECT, Keyword::IGNORE]) {
2532            Some(keyword) => {
2533                self.expect_keyword_is(Keyword::NULLS)?;
2534
2535                Ok(match keyword {
2536                    Keyword::RESPECT => Some(NullTreatment::RespectNulls),
2537                    Keyword::IGNORE => Some(NullTreatment::IgnoreNulls),
2538                    _ => None,
2539                })
2540            }
2541            None => Ok(None),
2542        }
2543    }
2544
2545    /// Parse time-related function `name` possibly followed by `(...)` arguments.
2546    pub fn parse_time_functions(&mut self, name: ObjectName) -> Result<Expr, ParserError> {
2547        let args = if self.consume_token(&Token::LParen) {
2548            FunctionArguments::List(self.parse_function_argument_list()?)
2549        } else {
2550            FunctionArguments::None
2551        };
2552        Ok(Expr::Function(Function {
2553            name,
2554            uses_odbc_syntax: false,
2555            parameters: FunctionArguments::None,
2556            args,
2557            filter: None,
2558            over: None,
2559            null_treatment: None,
2560            within_group: vec![],
2561        }))
2562    }
2563
2564    /// Parse window frame `UNITS` clause: `ROWS`, `RANGE`, or `GROUPS`.
2565    pub fn parse_window_frame_units(&mut self) -> Result<WindowFrameUnits, ParserError> {
2566        let next_token = self.next_token();
2567        match &next_token.token {
2568            Token::Word(w) => match w.keyword {
2569                Keyword::ROWS => Ok(WindowFrameUnits::Rows),
2570                Keyword::RANGE => Ok(WindowFrameUnits::Range),
2571                Keyword::GROUPS => Ok(WindowFrameUnits::Groups),
2572                _ => self.expected("ROWS, RANGE, GROUPS", next_token)?,
2573            },
2574            _ => self.expected("ROWS, RANGE, GROUPS", next_token),
2575        }
2576    }
2577
2578    /// Parse a `WINDOW` frame definition (units and bounds).
2579    pub fn parse_window_frame(&mut self) -> Result<WindowFrame, ParserError> {
2580        let units = self.parse_window_frame_units()?;
2581        let (start_bound, end_bound) = if self.parse_keyword(Keyword::BETWEEN) {
2582            let start_bound = self.parse_window_frame_bound()?;
2583            self.expect_keyword_is(Keyword::AND)?;
2584            let end_bound = Some(self.parse_window_frame_bound()?);
2585            (start_bound, end_bound)
2586        } else {
2587            (self.parse_window_frame_bound()?, None)
2588        };
2589        Ok(WindowFrame {
2590            units,
2591            start_bound,
2592            end_bound,
2593        })
2594    }
2595
2596    /// Parse a window frame bound: `CURRENT ROW` or `<n> PRECEDING|FOLLOWING`.
2597    pub fn parse_window_frame_bound(&mut self) -> Result<WindowFrameBound, ParserError> {
2598        if self.parse_keywords(&[Keyword::CURRENT, Keyword::ROW]) {
2599            Ok(WindowFrameBound::CurrentRow)
2600        } else {
2601            let rows = if self.parse_keyword(Keyword::UNBOUNDED) {
2602                None
2603            } else {
2604                Some(Box::new(match &self.peek_token_ref().token {
2605                    Token::SingleQuotedString(_) => self.parse_interval()?,
2606                    _ => self.parse_expr()?,
2607                }))
2608            };
2609            if self.parse_keyword(Keyword::PRECEDING) {
2610                Ok(WindowFrameBound::Preceding(rows))
2611            } else if self.parse_keyword(Keyword::FOLLOWING) {
2612                Ok(WindowFrameBound::Following(rows))
2613            } else {
2614                self.expected_ref("PRECEDING or FOLLOWING", self.peek_token_ref())
2615            }
2616        }
2617    }
2618
2619    /// Parse a group by expr. Group by expr can be one of group sets, roll up, cube, or simple expr.
2620    fn parse_group_by_expr(&mut self) -> Result<Expr, ParserError> {
2621        if self.dialect.supports_group_by_expr() {
2622            if self.parse_keywords(&[Keyword::GROUPING, Keyword::SETS]) {
2623                self.expect_token(&Token::LParen)?;
2624                let result = self.parse_comma_separated(|p| p.parse_tuple(true, true))?;
2625                self.expect_token(&Token::RParen)?;
2626                Ok(Expr::GroupingSets(result))
2627            } else if self.parse_keyword(Keyword::CUBE) {
2628                self.expect_token(&Token::LParen)?;
2629                let result = self.parse_comma_separated(|p| p.parse_tuple(true, true))?;
2630                self.expect_token(&Token::RParen)?;
2631                Ok(Expr::Cube(result))
2632            } else if self.parse_keyword(Keyword::ROLLUP) {
2633                self.expect_token(&Token::LParen)?;
2634                let result = self.parse_comma_separated(|p| p.parse_tuple(true, true))?;
2635                self.expect_token(&Token::RParen)?;
2636                Ok(Expr::Rollup(result))
2637            } else if self.consume_tokens(&[Token::LParen, Token::RParen]) {
2638                // PostgreSQL allow to use empty tuple as a group by expression,
2639                // e.g. `GROUP BY (), name`. Please refer to GROUP BY Clause section in
2640                // [PostgreSQL](https://www.postgresql.org/docs/16/sql-select.html)
2641                Ok(Expr::Tuple(vec![]))
2642            } else {
2643                self.parse_expr()
2644            }
2645        } else {
2646            // TODO parse rollup for other dialects
2647            self.parse_expr()
2648        }
2649    }
2650
2651    /// Parse a tuple with `(` and `)`.
2652    /// If `lift_singleton` is true, then a singleton tuple is lifted to a tuple of length 1, otherwise it will fail.
2653    /// If `allow_empty` is true, then an empty tuple is allowed.
2654    fn parse_tuple(
2655        &mut self,
2656        lift_singleton: bool,
2657        allow_empty: bool,
2658    ) -> Result<Vec<Expr>, ParserError> {
2659        if lift_singleton {
2660            if self.consume_token(&Token::LParen) {
2661                let result = if allow_empty && self.consume_token(&Token::RParen) {
2662                    vec![]
2663                } else {
2664                    let result = self.parse_comma_separated(Parser::parse_expr)?;
2665                    self.expect_token(&Token::RParen)?;
2666                    result
2667                };
2668                Ok(result)
2669            } else {
2670                Ok(vec![self.parse_expr()?])
2671            }
2672        } else {
2673            self.expect_token(&Token::LParen)?;
2674            let result = if allow_empty && self.consume_token(&Token::RParen) {
2675                vec![]
2676            } else {
2677                let result = self.parse_comma_separated(Parser::parse_expr)?;
2678                self.expect_token(&Token::RParen)?;
2679                result
2680            };
2681            Ok(result)
2682        }
2683    }
2684
2685    /// Parse a `CASE` expression and return an [`Expr::Case`].
2686    pub fn parse_case_expr(&mut self) -> Result<Expr, ParserError> {
2687        let case_token = AttachedToken(self.get_current_token().clone());
2688        let mut operand = None;
2689        if !self.parse_keyword(Keyword::WHEN) {
2690            operand = Some(Box::new(self.parse_expr()?));
2691            self.expect_keyword_is(Keyword::WHEN)?;
2692        }
2693        let mut conditions = vec![];
2694        loop {
2695            let condition = self.parse_expr()?;
2696            self.expect_keyword_is(Keyword::THEN)?;
2697            let result = self.parse_expr()?;
2698            conditions.push(CaseWhen { condition, result });
2699            if !self.parse_keyword(Keyword::WHEN) {
2700                break;
2701            }
2702        }
2703        let else_result = if self.parse_keyword(Keyword::ELSE) {
2704            Some(Box::new(self.parse_expr()?))
2705        } else {
2706            None
2707        };
2708        let end_token = AttachedToken(self.expect_keyword(Keyword::END)?);
2709        Ok(Expr::Case {
2710            case_token,
2711            end_token,
2712            operand,
2713            conditions,
2714            else_result,
2715        })
2716    }
2717
2718    /// Parse an optional `FORMAT` clause for `CAST` expressions.
2719    pub fn parse_optional_cast_format(&mut self) -> Result<Option<CastFormat>, ParserError> {
2720        if self.parse_keyword(Keyword::FORMAT) {
2721            let value = self.parse_value()?;
2722            match self.parse_optional_time_zone()? {
2723                Some(tz) => Ok(Some(CastFormat::ValueAtTimeZone(value, tz))),
2724                None => Ok(Some(CastFormat::Value(value))),
2725            }
2726        } else {
2727            Ok(None)
2728        }
2729    }
2730
2731    /// Parse an optional `AT TIME ZONE` clause.
2732    pub fn parse_optional_time_zone(&mut self) -> Result<Option<ValueWithSpan>, ParserError> {
2733        if self.parse_keywords(&[Keyword::AT, Keyword::TIME, Keyword::ZONE]) {
2734            self.parse_value().map(Some)
2735        } else {
2736            Ok(None)
2737        }
2738    }
2739
2740    /// mssql-like convert function
2741    fn parse_mssql_convert(&mut self, is_try: bool) -> Result<Expr, ParserError> {
2742        self.expect_token(&Token::LParen)?;
2743        let data_type = self.parse_data_type()?;
2744        self.expect_token(&Token::Comma)?;
2745        let expr = self.parse_expr()?;
2746        let styles = if self.consume_token(&Token::Comma) {
2747            self.parse_comma_separated(Parser::parse_expr)?
2748        } else {
2749            Default::default()
2750        };
2751        self.expect_token(&Token::RParen)?;
2752        Ok(Expr::Convert {
2753            is_try,
2754            expr: Box::new(expr),
2755            data_type: Some(data_type),
2756            charset: None,
2757            target_before_value: true,
2758            styles,
2759        })
2760    }
2761
2762    /// Parse a SQL CONVERT function:
2763    ///  - `CONVERT('héhé' USING utf8mb4)` (MySQL)
2764    ///  - `CONVERT('héhé', CHAR CHARACTER SET utf8mb4)` (MySQL)
2765    ///  - `CONVERT(DECIMAL(10, 5), 42)` (MSSQL) - the type comes first
2766    pub fn parse_convert_expr(&mut self, is_try: bool) -> Result<Expr, ParserError> {
2767        if self.dialect.convert_type_before_value() {
2768            return self.parse_mssql_convert(is_try);
2769        }
2770        self.expect_token(&Token::LParen)?;
2771        let expr = self.parse_expr()?;
2772        if self.parse_keyword(Keyword::USING) {
2773            let charset = self.parse_object_name(false)?;
2774            self.expect_token(&Token::RParen)?;
2775            return Ok(Expr::Convert {
2776                is_try,
2777                expr: Box::new(expr),
2778                data_type: None,
2779                charset: Some(charset),
2780                target_before_value: false,
2781                styles: vec![],
2782            });
2783        }
2784        self.expect_token(&Token::Comma)?;
2785        let data_type = self.parse_data_type()?;
2786        let charset = if self.parse_keywords(&[Keyword::CHARACTER, Keyword::SET]) {
2787            Some(self.parse_object_name(false)?)
2788        } else {
2789            None
2790        };
2791        self.expect_token(&Token::RParen)?;
2792        Ok(Expr::Convert {
2793            is_try,
2794            expr: Box::new(expr),
2795            data_type: Some(data_type),
2796            charset,
2797            target_before_value: false,
2798            styles: vec![],
2799        })
2800    }
2801
2802    /// Parse a SQL CAST function e.g. `CAST(expr AS FLOAT)`
2803    pub fn parse_cast_expr(&mut self, kind: CastKind) -> Result<Expr, ParserError> {
2804        self.expect_token(&Token::LParen)?;
2805        let expr = self.parse_expr()?;
2806        self.expect_keyword_is(Keyword::AS)?;
2807        let data_type = self.parse_data_type()?;
2808        let array = self.parse_keyword(Keyword::ARRAY);
2809        let format = self.parse_optional_cast_format()?;
2810        self.expect_token(&Token::RParen)?;
2811        Ok(Expr::Cast {
2812            kind,
2813            expr: Box::new(expr),
2814            data_type,
2815            array,
2816            format,
2817        })
2818    }
2819
2820    /// Parse a SQL EXISTS expression e.g. `WHERE EXISTS(SELECT ...)`.
2821    pub fn parse_exists_expr(&mut self, negated: bool) -> Result<Expr, ParserError> {
2822        self.expect_token(&Token::LParen)?;
2823        let exists_node = Expr::Exists {
2824            negated,
2825            subquery: self.parse_query()?,
2826        };
2827        self.expect_token(&Token::RParen)?;
2828        Ok(exists_node)
2829    }
2830
2831    /// Parse a SQL `EXTRACT` expression e.g. `EXTRACT(YEAR FROM date)`.
2832    pub fn parse_extract_expr(&mut self) -> Result<Expr, ParserError> {
2833        self.expect_token(&Token::LParen)?;
2834        let field = self.parse_date_time_field()?;
2835
2836        let syntax = if self.parse_keyword(Keyword::FROM) {
2837            ExtractSyntax::From
2838        } else if self.dialect.supports_extract_comma_syntax() && self.consume_token(&Token::Comma)
2839        {
2840            ExtractSyntax::Comma
2841        } else {
2842            return Err(ParserError::ParserError(
2843                "Expected 'FROM' or ','".to_string(),
2844            ));
2845        };
2846
2847        let expr = self.parse_expr()?;
2848        self.expect_token(&Token::RParen)?;
2849        Ok(Expr::Extract {
2850            field,
2851            expr: Box::new(expr),
2852            syntax,
2853        })
2854    }
2855
2856    /// Parse a `CEIL` or `FLOOR` expression.
2857    pub fn parse_ceil_floor_expr(&mut self, is_ceil: bool) -> Result<Expr, ParserError> {
2858        self.expect_token(&Token::LParen)?;
2859        let expr = self.parse_expr()?;
2860        // Parse `CEIL/FLOOR(expr)`
2861        let field = if self.parse_keyword(Keyword::TO) {
2862            // Parse `CEIL/FLOOR(expr TO DateTimeField)`
2863            CeilFloorKind::DateTimeField(self.parse_date_time_field()?)
2864        } else if self.consume_token(&Token::Comma) {
2865            // Parse `CEIL/FLOOR(expr, scale)`
2866            let v = self.parse_value()?;
2867            if matches!(v.value, Value::Number(_, _)) {
2868                CeilFloorKind::Scale(v)
2869            } else {
2870                return Err(ParserError::ParserError(
2871                    "Scale field can only be of number type".to_string(),
2872                ));
2873            }
2874        } else {
2875            CeilFloorKind::DateTimeField(DateTimeField::NoDateTime)
2876        };
2877        self.expect_token(&Token::RParen)?;
2878        if is_ceil {
2879            Ok(Expr::Ceil {
2880                expr: Box::new(expr),
2881                field,
2882            })
2883        } else {
2884            Ok(Expr::Floor {
2885                expr: Box::new(expr),
2886                field,
2887            })
2888        }
2889    }
2890
2891    /// Parse a `POSITION` expression.
2892    pub fn parse_position_expr(&mut self, ident: Ident) -> Result<Expr, ParserError> {
2893        let between_prec = self.dialect.prec_value(Precedence::Between);
2894        let position_expr = self.maybe_parse(|p| {
2895            // PARSE SELECT POSITION('@' in field)
2896            p.expect_token(&Token::LParen)?;
2897
2898            // Parse the subexpr till the IN keyword
2899            let expr = p.parse_subexpr(between_prec)?;
2900            p.expect_keyword_is(Keyword::IN)?;
2901            let from = p.parse_expr()?;
2902            p.expect_token(&Token::RParen)?;
2903            Ok(Expr::Position {
2904                expr: Box::new(expr),
2905                r#in: Box::new(from),
2906            })
2907        })?;
2908        match position_expr {
2909            Some(expr) => Ok(expr),
2910            // Snowflake supports `position` as an ordinary function call
2911            // without the special `IN` syntax.
2912            None => self.parse_function(ObjectName::from(vec![ident])),
2913        }
2914    }
2915
2916    /// Parse `SUBSTRING`/`SUBSTR` expressions: `SUBSTRING(expr FROM start FOR length)` or `SUBSTR(expr, start, length)`.
2917    pub fn parse_substring(&mut self) -> Result<Expr, ParserError> {
2918        let shorthand = match self.expect_one_of_keywords(&[Keyword::SUBSTR, Keyword::SUBSTRING])? {
2919            Keyword::SUBSTR => true,
2920            Keyword::SUBSTRING => false,
2921            _ => {
2922                self.prev_token();
2923                return self.expected_ref("SUBSTR or SUBSTRING", self.peek_token_ref());
2924            }
2925        };
2926        self.expect_token(&Token::LParen)?;
2927        let expr = self.parse_expr()?;
2928        let mut from_expr = None;
2929        let special = self.consume_token(&Token::Comma);
2930        if special || self.parse_keyword(Keyword::FROM) {
2931            from_expr = Some(self.parse_expr()?);
2932        }
2933
2934        let mut to_expr = None;
2935        if self.parse_keyword(Keyword::FOR) || self.consume_token(&Token::Comma) {
2936            to_expr = Some(self.parse_expr()?);
2937        }
2938        self.expect_token(&Token::RParen)?;
2939
2940        Ok(Expr::Substring {
2941            expr: Box::new(expr),
2942            substring_from: from_expr.map(Box::new),
2943            substring_for: to_expr.map(Box::new),
2944            special,
2945            shorthand,
2946        })
2947    }
2948
2949    /// Parse an OVERLAY expression.
2950    ///
2951    /// See [Expr::Overlay]
2952    pub fn parse_overlay_expr(&mut self) -> Result<Expr, ParserError> {
2953        // PARSE OVERLAY (EXPR PLACING EXPR FROM 1 [FOR 3])
2954        self.expect_token(&Token::LParen)?;
2955        let expr = self.parse_expr()?;
2956        self.expect_keyword_is(Keyword::PLACING)?;
2957        let what_expr = self.parse_expr()?;
2958        self.expect_keyword_is(Keyword::FROM)?;
2959        let from_expr = self.parse_expr()?;
2960        let mut for_expr = None;
2961        if self.parse_keyword(Keyword::FOR) {
2962            for_expr = Some(self.parse_expr()?);
2963        }
2964        self.expect_token(&Token::RParen)?;
2965
2966        Ok(Expr::Overlay {
2967            expr: Box::new(expr),
2968            overlay_what: Box::new(what_expr),
2969            overlay_from: Box::new(from_expr),
2970            overlay_for: for_expr.map(Box::new),
2971        })
2972    }
2973
2974    /// ```sql
2975    /// TRIM ([WHERE] ['text' FROM] 'text')
2976    /// TRIM ('text')
2977    /// TRIM(<expr>, [, characters]) -- PostgreSQL, DuckDB, Snowflake, BigQuery, Generic
2978    /// ```
2979    pub fn parse_trim_expr(&mut self) -> Result<Expr, ParserError> {
2980        self.expect_token(&Token::LParen)?;
2981        let mut trim_where = None;
2982        if let Token::Word(word) = &self.peek_token_ref().token {
2983            if [Keyword::BOTH, Keyword::LEADING, Keyword::TRAILING].contains(&word.keyword) {
2984                trim_where = Some(self.parse_trim_where()?);
2985            }
2986        }
2987        let expr = self.parse_expr()?;
2988        if self.parse_keyword(Keyword::FROM) {
2989            let trim_what = Box::new(expr);
2990            let expr = self.parse_expr()?;
2991            self.expect_token(&Token::RParen)?;
2992            Ok(Expr::Trim {
2993                expr: Box::new(expr),
2994                trim_where,
2995                trim_what: Some(trim_what),
2996                trim_characters: None,
2997            })
2998        } else if self.dialect.supports_comma_separated_trim() && self.consume_token(&Token::Comma)
2999        {
3000            let characters = self.parse_comma_separated(Parser::parse_expr)?;
3001            self.expect_token(&Token::RParen)?;
3002            Ok(Expr::Trim {
3003                expr: Box::new(expr),
3004                trim_where: None,
3005                trim_what: None,
3006                trim_characters: Some(characters),
3007            })
3008        } else {
3009            self.expect_token(&Token::RParen)?;
3010            Ok(Expr::Trim {
3011                expr: Box::new(expr),
3012                trim_where,
3013                trim_what: None,
3014                trim_characters: None,
3015            })
3016        }
3017    }
3018
3019    /// Parse the `WHERE` field for a `TRIM` expression.
3020    ///
3021    /// See [TrimWhereField]
3022    pub fn parse_trim_where(&mut self) -> Result<TrimWhereField, ParserError> {
3023        let next_token = self.next_token();
3024        match &next_token.token {
3025            Token::Word(w) => match w.keyword {
3026                Keyword::BOTH => Ok(TrimWhereField::Both),
3027                Keyword::LEADING => Ok(TrimWhereField::Leading),
3028                Keyword::TRAILING => Ok(TrimWhereField::Trailing),
3029                _ => self.expected("trim_where field", next_token)?,
3030            },
3031            _ => self.expected("trim_where field", next_token),
3032        }
3033    }
3034
3035    /// Parses an array expression `[ex1, ex2, ..]`
3036    /// if `named` is `true`, came from an expression like  `ARRAY[ex1, ex2]`
3037    pub fn parse_array_expr(&mut self, named: bool) -> Result<Expr, ParserError> {
3038        let exprs = self.parse_comma_separated0(Parser::parse_expr, Token::RBracket)?;
3039        self.expect_token(&Token::RBracket)?;
3040        Ok(Expr::Array(Array { elem: exprs, named }))
3041    }
3042
3043    /// Parse the `ON OVERFLOW` clause for `LISTAGG`.
3044    ///
3045    /// See [`ListAggOnOverflow`]
3046    pub fn parse_listagg_on_overflow(&mut self) -> Result<Option<ListAggOnOverflow>, ParserError> {
3047        if self.parse_keywords(&[Keyword::ON, Keyword::OVERFLOW]) {
3048            if self.parse_keyword(Keyword::ERROR) {
3049                Ok(Some(ListAggOnOverflow::Error))
3050            } else {
3051                self.expect_keyword_is(Keyword::TRUNCATE)?;
3052                let filler = match &self.peek_token_ref().token {
3053                    Token::Word(w)
3054                        if w.keyword == Keyword::WITH || w.keyword == Keyword::WITHOUT =>
3055                    {
3056                        None
3057                    }
3058                    Token::SingleQuotedString(_)
3059                    | Token::EscapedStringLiteral(_)
3060                    | Token::UnicodeStringLiteral(_)
3061                    | Token::NationalStringLiteral(_)
3062                    | Token::QuoteDelimitedStringLiteral(_)
3063                    | Token::NationalQuoteDelimitedStringLiteral(_)
3064                    | Token::HexStringLiteral(_) => Some(Box::new(self.parse_expr()?)),
3065                    _ => self.expected_ref(
3066                        "either filler, WITH, or WITHOUT in LISTAGG",
3067                        self.peek_token_ref(),
3068                    )?,
3069                };
3070                let with_count = self.parse_keyword(Keyword::WITH);
3071                if !with_count && !self.parse_keyword(Keyword::WITHOUT) {
3072                    self.expected_ref("either WITH or WITHOUT in LISTAGG", self.peek_token_ref())?;
3073                }
3074                self.expect_keyword_is(Keyword::COUNT)?;
3075                Ok(Some(ListAggOnOverflow::Truncate { filler, with_count }))
3076            }
3077        } else {
3078            Ok(None)
3079        }
3080    }
3081
3082    /// Parse a date/time field for `EXTRACT`, interval qualifiers, and ceil/floor operations.
3083    ///
3084    /// `EXTRACT` supports a wider set of date/time fields than interval qualifiers,
3085    /// so this function may need to be split in two.
3086    ///
3087    /// See [`DateTimeField`]
3088    pub fn parse_date_time_field(&mut self) -> Result<DateTimeField, ParserError> {
3089        let next_token = self.next_token();
3090        match &next_token.token {
3091            Token::Word(w) => match w.keyword {
3092                Keyword::YEAR => Ok(DateTimeField::Year),
3093                Keyword::YEARS => Ok(DateTimeField::Years),
3094                Keyword::MONTH => Ok(DateTimeField::Month),
3095                Keyword::MONTHS => Ok(DateTimeField::Months),
3096                Keyword::WEEK => {
3097                    let week_day = if dialect_of!(self is BigQueryDialect | GenericDialect)
3098                        && self.consume_token(&Token::LParen)
3099                    {
3100                        let week_day = self.parse_identifier()?;
3101                        self.expect_token(&Token::RParen)?;
3102                        Some(week_day)
3103                    } else {
3104                        None
3105                    };
3106                    Ok(DateTimeField::Week(week_day))
3107                }
3108                Keyword::WEEKS => Ok(DateTimeField::Weeks),
3109                Keyword::DAY => Ok(DateTimeField::Day),
3110                Keyword::DAYOFWEEK => Ok(DateTimeField::DayOfWeek),
3111                Keyword::DAYOFYEAR => Ok(DateTimeField::DayOfYear),
3112                Keyword::DAYS => Ok(DateTimeField::Days),
3113                Keyword::DATE => Ok(DateTimeField::Date),
3114                Keyword::DATETIME => Ok(DateTimeField::Datetime),
3115                Keyword::HOUR => Ok(DateTimeField::Hour),
3116                Keyword::HOURS => Ok(DateTimeField::Hours),
3117                Keyword::MINUTE => Ok(DateTimeField::Minute),
3118                Keyword::MINUTES => Ok(DateTimeField::Minutes),
3119                Keyword::SECOND => Ok(DateTimeField::Second),
3120                Keyword::SECONDS => Ok(DateTimeField::Seconds),
3121                Keyword::CENTURY => Ok(DateTimeField::Century),
3122                Keyword::DECADE => Ok(DateTimeField::Decade),
3123                Keyword::DOY => Ok(DateTimeField::Doy),
3124                Keyword::DOW => Ok(DateTimeField::Dow),
3125                Keyword::EPOCH => Ok(DateTimeField::Epoch),
3126                Keyword::ISODOW => Ok(DateTimeField::Isodow),
3127                Keyword::ISOYEAR => Ok(DateTimeField::Isoyear),
3128                Keyword::ISOWEEK => Ok(DateTimeField::IsoWeek),
3129                Keyword::JULIAN => Ok(DateTimeField::Julian),
3130                Keyword::MICROSECOND => Ok(DateTimeField::Microsecond),
3131                Keyword::MICROSECONDS => Ok(DateTimeField::Microseconds),
3132                Keyword::MILLENIUM => Ok(DateTimeField::Millenium),
3133                Keyword::MILLENNIUM => Ok(DateTimeField::Millennium),
3134                Keyword::MILLISECOND => Ok(DateTimeField::Millisecond),
3135                Keyword::MILLISECONDS => Ok(DateTimeField::Milliseconds),
3136                Keyword::NANOSECOND => Ok(DateTimeField::Nanosecond),
3137                Keyword::NANOSECONDS => Ok(DateTimeField::Nanoseconds),
3138                Keyword::QUARTER => Ok(DateTimeField::Quarter),
3139                Keyword::TIME => Ok(DateTimeField::Time),
3140                Keyword::TIMEZONE => Ok(DateTimeField::Timezone),
3141                Keyword::TIMEZONE_ABBR => Ok(DateTimeField::TimezoneAbbr),
3142                Keyword::TIMEZONE_HOUR => Ok(DateTimeField::TimezoneHour),
3143                Keyword::TIMEZONE_MINUTE => Ok(DateTimeField::TimezoneMinute),
3144                Keyword::TIMEZONE_REGION => Ok(DateTimeField::TimezoneRegion),
3145                _ if self.dialect.allow_extract_custom() => {
3146                    self.prev_token();
3147                    let custom = self.parse_identifier()?;
3148                    Ok(DateTimeField::Custom(custom))
3149                }
3150                _ => self.expected("date/time field", next_token),
3151            },
3152            Token::SingleQuotedString(_) if self.dialect.allow_extract_single_quotes() => {
3153                self.prev_token();
3154                let custom = self.parse_identifier()?;
3155                Ok(DateTimeField::Custom(custom))
3156            }
3157            _ => self.expected("date/time field", next_token),
3158        }
3159    }
3160
3161    /// Parse a `NOT` expression.
3162    ///
3163    /// Represented in the AST as `Expr::UnaryOp` with `UnaryOperator::Not`.
3164    pub fn parse_not(&mut self) -> Result<Expr, ParserError> {
3165        match &self.peek_token_ref().token {
3166            Token::Word(w) => match w.keyword {
3167                Keyword::EXISTS => {
3168                    let negated = true;
3169                    let _ = self.parse_keyword(Keyword::EXISTS);
3170                    self.parse_exists_expr(negated)
3171                }
3172                _ => Ok(Expr::UnaryOp {
3173                    op: UnaryOperator::Not,
3174                    expr: Box::new(
3175                        self.parse_subexpr(self.dialect.prec_value(Precedence::UnaryNot))?,
3176                    ),
3177                }),
3178            },
3179            _ => Ok(Expr::UnaryOp {
3180                op: UnaryOperator::Not,
3181                expr: Box::new(self.parse_subexpr(self.dialect.prec_value(Precedence::UnaryNot))?),
3182            }),
3183        }
3184    }
3185
3186    /// Parse expression types that start with a left brace '{'.
3187    /// Examples:
3188    /// ```sql
3189    /// -- Dictionary expr.
3190    /// {'key1': 'value1', 'key2': 'value2'}
3191    ///
3192    /// -- Function call using the ODBC syntax.
3193    /// { fn CONCAT('foo', 'bar') }
3194    /// ```
3195    fn parse_lbrace_expr(&mut self) -> Result<Expr, ParserError> {
3196        let token = self.expect_token(&Token::LBrace)?;
3197
3198        if let Some(fn_expr) = self.maybe_parse_odbc_body()? {
3199            self.expect_token(&Token::RBrace)?;
3200            return Ok(fn_expr);
3201        }
3202
3203        if self.dialect.supports_dictionary_syntax() {
3204            self.prev_token(); // Put back the '{'
3205            return self.parse_dictionary();
3206        }
3207
3208        self.expected("an expression", token)
3209    }
3210
3211    /// Parses fulltext expressions [`sqlparser::ast::Expr::MatchAgainst`]
3212    ///
3213    /// # Errors
3214    /// This method will raise an error if the column list is empty or with invalid identifiers,
3215    /// the match expression is not a literal string, or if the search modifier is not valid.
3216    pub fn parse_match_against(&mut self) -> Result<Expr, ParserError> {
3217        let columns = self.parse_parenthesized_qualified_column_list(Mandatory, false)?;
3218
3219        self.expect_keyword_is(Keyword::AGAINST)?;
3220
3221        self.expect_token(&Token::LParen)?;
3222
3223        // MySQL is too permissive about the value, IMO we can't validate it perfectly on syntax level.
3224        let match_value = self.parse_value()?;
3225
3226        let in_natural_language_mode_keywords = &[
3227            Keyword::IN,
3228            Keyword::NATURAL,
3229            Keyword::LANGUAGE,
3230            Keyword::MODE,
3231        ];
3232
3233        let with_query_expansion_keywords = &[Keyword::WITH, Keyword::QUERY, Keyword::EXPANSION];
3234
3235        let in_boolean_mode_keywords = &[Keyword::IN, Keyword::BOOLEAN, Keyword::MODE];
3236
3237        let opt_search_modifier = if self.parse_keywords(in_natural_language_mode_keywords) {
3238            if self.parse_keywords(with_query_expansion_keywords) {
3239                Some(SearchModifier::InNaturalLanguageModeWithQueryExpansion)
3240            } else {
3241                Some(SearchModifier::InNaturalLanguageMode)
3242            }
3243        } else if self.parse_keywords(in_boolean_mode_keywords) {
3244            Some(SearchModifier::InBooleanMode)
3245        } else if self.parse_keywords(with_query_expansion_keywords) {
3246            Some(SearchModifier::WithQueryExpansion)
3247        } else {
3248            None
3249        };
3250
3251        self.expect_token(&Token::RParen)?;
3252
3253        Ok(Expr::MatchAgainst {
3254            columns,
3255            match_value,
3256            opt_search_modifier,
3257        })
3258    }
3259
3260    /// Parse an `INTERVAL` expression.
3261    ///
3262    /// Some syntactically valid intervals:
3263    ///
3264    /// ```sql
3265    ///   1. INTERVAL '1' DAY
3266    ///   2. INTERVAL '1-1' YEAR TO MONTH
3267    ///   3. INTERVAL '1' SECOND
3268    ///   4. INTERVAL '1:1:1.1' HOUR (5) TO SECOND (5)
3269    ///   5. INTERVAL '1.1' SECOND (2, 2)
3270    ///   6. INTERVAL '1:1' HOUR (5) TO MINUTE (5)
3271    ///   7. (MySql & BigQuery only): INTERVAL 1 DAY
3272    /// ```
3273    ///
3274    /// Note that we do not currently attempt to parse the quoted value.
3275    pub fn parse_interval(&mut self) -> Result<Expr, ParserError> {
3276        // The SQL standard allows an optional sign before the value string, but
3277        // it is not clear if any implementations support that syntax, so we
3278        // don't currently try to parse it. (The sign can instead be included
3279        // inside the value string.)
3280
3281        // to match the different flavours of INTERVAL syntax, we only allow expressions
3282        // if the dialect requires an interval qualifier,
3283        // see https://github.com/sqlparser-rs/sqlparser-rs/pull/1398 for more details
3284        let value = if self.dialect.require_interval_qualifier() {
3285            // parse a whole expression so `INTERVAL 1 + 1 DAY` is valid
3286            self.parse_expr()?
3287        } else {
3288            // parse a prefix expression so `INTERVAL 1 DAY` is valid, but `INTERVAL 1 + 1 DAY` is not
3289            // this also means that `INTERVAL '5 days' > INTERVAL '1 day'` treated properly
3290            self.parse_prefix()?
3291        };
3292
3293        // Following the string literal is a qualifier which indicates the units
3294        // of the duration specified in the string literal.
3295        //
3296        // Note that PostgreSQL allows omitting the qualifier, so we provide
3297        // this more general implementation.
3298        let leading_field = if self.next_token_is_temporal_unit() {
3299            Some(self.parse_date_time_field()?)
3300        } else if self.dialect.require_interval_qualifier() {
3301            return parser_err!(
3302                "INTERVAL requires a unit after the literal value",
3303                self.peek_token_ref().span.start
3304            );
3305        } else {
3306            None
3307        };
3308
3309        let (leading_precision, last_field, fsec_precision) =
3310            if leading_field == Some(DateTimeField::Second) {
3311                // SQL mandates special syntax for `SECOND TO SECOND` literals.
3312                // Instead of
3313                //     `SECOND [(<leading precision>)] TO SECOND[(<fractional seconds precision>)]`
3314                // one must use the special format:
3315                //     `SECOND [( <leading precision> [ , <fractional seconds precision>] )]`
3316                let last_field = None;
3317                let (leading_precision, fsec_precision) = self.parse_optional_precision_scale()?;
3318                (leading_precision, last_field, fsec_precision)
3319            } else {
3320                let leading_precision = self.parse_optional_precision()?;
3321                if self.parse_keyword(Keyword::TO) {
3322                    let last_field = Some(self.parse_date_time_field()?);
3323                    let fsec_precision = if last_field == Some(DateTimeField::Second) {
3324                        self.parse_optional_precision()?
3325                    } else {
3326                        None
3327                    };
3328                    (leading_precision, last_field, fsec_precision)
3329                } else {
3330                    (leading_precision, None, None)
3331                }
3332            };
3333
3334        Ok(Expr::Interval(Interval {
3335            value: Box::new(value),
3336            leading_field,
3337            leading_precision,
3338            last_field,
3339            fractional_seconds_precision: fsec_precision,
3340        }))
3341    }
3342
3343    /// Peek at the next token and determine if it is a temporal unit
3344    /// like `second`.
3345    pub fn next_token_is_temporal_unit(&mut self) -> bool {
3346        if let Token::Word(word) = &self.peek_token_ref().token {
3347            matches!(
3348                word.keyword,
3349                Keyword::YEAR
3350                    | Keyword::YEARS
3351                    | Keyword::MONTH
3352                    | Keyword::MONTHS
3353                    | Keyword::WEEK
3354                    | Keyword::WEEKS
3355                    | Keyword::DAY
3356                    | Keyword::DAYS
3357                    | Keyword::HOUR
3358                    | Keyword::HOURS
3359                    | Keyword::MINUTE
3360                    | Keyword::MINUTES
3361                    | Keyword::SECOND
3362                    | Keyword::SECONDS
3363                    | Keyword::CENTURY
3364                    | Keyword::DECADE
3365                    | Keyword::DOW
3366                    | Keyword::DOY
3367                    | Keyword::EPOCH
3368                    | Keyword::ISODOW
3369                    | Keyword::ISOYEAR
3370                    | Keyword::JULIAN
3371                    | Keyword::MICROSECOND
3372                    | Keyword::MICROSECONDS
3373                    | Keyword::MILLENIUM
3374                    | Keyword::MILLENNIUM
3375                    | Keyword::MILLISECOND
3376                    | Keyword::MILLISECONDS
3377                    | Keyword::NANOSECOND
3378                    | Keyword::NANOSECONDS
3379                    | Keyword::QUARTER
3380                    | Keyword::TIMEZONE
3381                    | Keyword::TIMEZONE_HOUR
3382                    | Keyword::TIMEZONE_MINUTE
3383            )
3384        } else {
3385            false
3386        }
3387    }
3388
3389    /// Syntax
3390    /// ```sql
3391    /// -- typed
3392    /// STRUCT<[field_name] field_type, ...>( expr1 [, ... ])
3393    /// -- typeless
3394    /// STRUCT( expr1 [AS field_name] [, ... ])
3395    /// ```
3396    fn parse_struct_literal(&mut self) -> Result<Expr, ParserError> {
3397        // Parse the fields definition if exist `<[field_name] field_type, ...>`
3398        self.prev_token();
3399        let (fields, trailing_bracket) =
3400            self.parse_struct_type_def(Self::parse_struct_field_def)?;
3401        if trailing_bracket.0 {
3402            return parser_err!(
3403                "unmatched > in STRUCT literal",
3404                self.peek_token_ref().span.start
3405            );
3406        }
3407
3408        // Parse the struct values `(expr1 [, ... ])`
3409        self.expect_token(&Token::LParen)?;
3410        let values = self
3411            .parse_comma_separated(|parser| parser.parse_struct_field_expr(!fields.is_empty()))?;
3412        self.expect_token(&Token::RParen)?;
3413
3414        Ok(Expr::Struct { values, fields })
3415    }
3416
3417    /// Parse an expression value for a struct literal
3418    /// Syntax
3419    /// ```sql
3420    /// expr [AS name]
3421    /// ```
3422    ///
3423    /// For biquery [1], Parameter typed_syntax is set to true if the expression
3424    /// is to be parsed as a field expression declared using typed
3425    /// struct syntax [2], and false if using typeless struct syntax [3].
3426    ///
3427    /// [1]: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#constructing_a_struct
3428    /// [2]: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#typed_struct_syntax
3429    /// [3]: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#typeless_struct_syntax
3430    fn parse_struct_field_expr(&mut self, typed_syntax: bool) -> Result<Expr, ParserError> {
3431        let expr = self.parse_expr()?;
3432        if self.parse_keyword(Keyword::AS) {
3433            if typed_syntax {
3434                return parser_err!("Typed syntax does not allow AS", {
3435                    self.prev_token();
3436                    self.peek_token_ref().span.start
3437                });
3438            }
3439            let field_name = self.parse_identifier()?;
3440            Ok(Expr::Named {
3441                expr: expr.into(),
3442                name: field_name,
3443            })
3444        } else {
3445            Ok(expr)
3446        }
3447    }
3448
3449    /// Parse a Struct type definition as a sequence of field-value pairs.
3450    /// The syntax of the Struct elem differs by dialect so it is customised
3451    /// by the `elem_parser` argument.
3452    ///
3453    /// Syntax
3454    /// ```sql
3455    /// Hive:
3456    /// STRUCT<field_name: field_type>
3457    ///
3458    /// BigQuery:
3459    /// STRUCT<[field_name] field_type>
3460    /// ```
3461    fn parse_struct_type_def<F>(
3462        &mut self,
3463        mut elem_parser: F,
3464    ) -> Result<(Vec<StructField>, MatchedTrailingBracket), ParserError>
3465    where
3466        F: FnMut(&mut Parser<'a>) -> Result<(StructField, MatchedTrailingBracket), ParserError>,
3467    {
3468        self.expect_keyword_is(Keyword::STRUCT)?;
3469
3470        // Nothing to do if we have no type information.
3471        if self.peek_token_ref().token != Token::Lt {
3472            return Ok((Default::default(), false.into()));
3473        }
3474        self.next_token();
3475
3476        let mut field_defs = vec![];
3477        let trailing_bracket = loop {
3478            let (def, trailing_bracket) = elem_parser(self)?;
3479            field_defs.push(def);
3480            // The struct field definition is finished if it occurs `>>` or comma.
3481            if trailing_bracket.0 || !self.consume_token(&Token::Comma) {
3482                break trailing_bracket;
3483            }
3484        };
3485
3486        Ok((
3487            field_defs,
3488            self.expect_closing_angle_bracket(trailing_bracket)?,
3489        ))
3490    }
3491
3492    /// Duckdb Struct Data Type <https://duckdb.org/docs/sql/data_types/struct.html#retrieving-from-structs>
3493    fn parse_duckdb_struct_type_def(&mut self) -> Result<Vec<StructField>, ParserError> {
3494        self.expect_keyword_is(Keyword::STRUCT)?;
3495        self.expect_token(&Token::LParen)?;
3496        let struct_body = self.parse_comma_separated(|parser| {
3497            let field_name = parser.parse_identifier()?;
3498            let field_type = parser.parse_data_type()?;
3499
3500            Ok(StructField {
3501                field_name: Some(field_name),
3502                field_type,
3503                options: None,
3504            })
3505        });
3506        self.expect_token(&Token::RParen)?;
3507        struct_body
3508    }
3509
3510    /// Parse a field definition in a [struct] or [tuple].
3511    /// Syntax:
3512    ///
3513    /// ```sql
3514    /// [field_name] field_type
3515    /// field_name: field_type
3516    /// ```
3517    ///
3518    /// [struct]: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#declaring_a_struct_type
3519    /// [tuple]: https://clickhouse.com/docs/en/sql-reference/data-types/tuple
3520    /// [databricks]: https://docs.databricks.com/en/sql/language-manual/data-types/struct-type.html
3521    fn parse_struct_field_def(
3522        &mut self,
3523    ) -> Result<(StructField, MatchedTrailingBracket), ParserError> {
3524        // Look beyond the next item to infer whether both field name
3525        // and type are specified.
3526        let is_named_field = matches!(
3527            (self.peek_nth_token(0).token, self.peek_nth_token(1).token),
3528            (Token::Word(_), Token::Word(_)) | (Token::Word(_), Token::Colon)
3529        );
3530
3531        let field_name = if is_named_field {
3532            let name = self.parse_identifier()?;
3533            let _ = self.consume_token(&Token::Colon);
3534            Some(name)
3535        } else {
3536            None
3537        };
3538
3539        let (field_type, trailing_bracket) = self.parse_data_type_helper()?;
3540
3541        let options = self.maybe_parse_options(Keyword::OPTIONS)?;
3542        Ok((
3543            StructField {
3544                field_name,
3545                field_type,
3546                options,
3547            },
3548            trailing_bracket,
3549        ))
3550    }
3551
3552    /// DuckDB specific: Parse a Union type definition as a sequence of field-value pairs.
3553    ///
3554    /// Syntax:
3555    ///
3556    /// ```sql
3557    /// UNION(field_name field_type[,...])
3558    /// ```
3559    ///
3560    /// [1]: https://duckdb.org/docs/sql/data_types/union.html
3561    fn parse_union_type_def(&mut self) -> Result<Vec<UnionField>, ParserError> {
3562        self.expect_keyword_is(Keyword::UNION)?;
3563
3564        self.expect_token(&Token::LParen)?;
3565
3566        let fields = self.parse_comma_separated(|p| {
3567            Ok(UnionField {
3568                field_name: p.parse_identifier()?,
3569                field_type: p.parse_data_type()?,
3570            })
3571        })?;
3572
3573        self.expect_token(&Token::RParen)?;
3574
3575        Ok(fields)
3576    }
3577
3578    /// DuckDB and ClickHouse specific: Parse a duckdb [dictionary] or a clickhouse [map] setting
3579    ///
3580    /// Syntax:
3581    ///
3582    /// ```sql
3583    /// {'field_name': expr1[, ... ]}
3584    /// ```
3585    ///
3586    /// [dictionary]: https://duckdb.org/docs/sql/data_types/struct#creating-structs
3587    /// [map]: https://clickhouse.com/docs/operations/settings/settings#additional_table_filters
3588    fn parse_dictionary(&mut self) -> Result<Expr, ParserError> {
3589        self.expect_token(&Token::LBrace)?;
3590
3591        let fields = self.parse_comma_separated0(Self::parse_dictionary_field, Token::RBrace)?;
3592
3593        self.expect_token(&Token::RBrace)?;
3594
3595        Ok(Expr::Dictionary(fields))
3596    }
3597
3598    /// Parse a field for a duckdb [dictionary] or a clickhouse [map] setting
3599    ///
3600    /// Syntax
3601    ///
3602    /// ```sql
3603    /// 'name': expr
3604    /// ```
3605    ///
3606    /// [dictionary]: https://duckdb.org/docs/sql/data_types/struct#creating-structs
3607    /// [map]: https://clickhouse.com/docs/operations/settings/settings#additional_table_filters
3608    fn parse_dictionary_field(&mut self) -> Result<DictionaryField, ParserError> {
3609        let key = self.parse_identifier()?;
3610
3611        self.expect_token(&Token::Colon)?;
3612
3613        let expr = self.parse_expr()?;
3614
3615        Ok(DictionaryField {
3616            key,
3617            value: Box::new(expr),
3618        })
3619    }
3620
3621    /// DuckDB specific: Parse a duckdb [map]
3622    ///
3623    /// Syntax:
3624    ///
3625    /// ```sql
3626    /// Map {key1: value1[, ... ]}
3627    /// ```
3628    ///
3629    /// [map]: https://duckdb.org/docs/sql/data_types/map.html#creating-maps
3630    fn parse_duckdb_map_literal(&mut self) -> Result<Expr, ParserError> {
3631        self.expect_token(&Token::LBrace)?;
3632        let fields = self.parse_comma_separated0(Self::parse_duckdb_map_field, Token::RBrace)?;
3633        self.expect_token(&Token::RBrace)?;
3634        Ok(Expr::Map(Map { entries: fields }))
3635    }
3636
3637    /// Parse a field for a duckdb [map]
3638    ///
3639    /// Syntax
3640    ///
3641    /// ```sql
3642    /// key: value
3643    /// ```
3644    ///
3645    /// [map]: https://duckdb.org/docs/sql/data_types/map.html#creating-maps
3646    fn parse_duckdb_map_field(&mut self) -> Result<MapEntry, ParserError> {
3647        // Stop before `:` so it can act as a key/value separator
3648        let key = self.parse_subexpr(self.dialect.prec_value(Precedence::Colon))?;
3649
3650        self.expect_token(&Token::Colon)?;
3651
3652        let value = self.parse_expr()?;
3653
3654        Ok(MapEntry {
3655            key: Box::new(key),
3656            value: Box::new(value),
3657        })
3658    }
3659
3660    /// Parse clickhouse [map]
3661    ///
3662    /// Syntax
3663    ///
3664    /// ```sql
3665    /// Map(key_data_type, value_data_type)
3666    /// ```
3667    ///
3668    /// [map]: https://clickhouse.com/docs/en/sql-reference/data-types/map
3669    fn parse_click_house_map_def(&mut self) -> Result<(DataType, DataType), ParserError> {
3670        self.expect_keyword_is(Keyword::MAP)?;
3671        self.expect_token(&Token::LParen)?;
3672        let key_data_type = self.parse_data_type()?;
3673        self.expect_token(&Token::Comma)?;
3674        let value_data_type = self.parse_data_type()?;
3675        self.expect_token(&Token::RParen)?;
3676
3677        Ok((key_data_type, value_data_type))
3678    }
3679
3680    /// Parse clickhouse [tuple]
3681    ///
3682    /// Syntax
3683    ///
3684    /// ```sql
3685    /// Tuple([field_name] field_type, ...)
3686    /// ```
3687    ///
3688    /// [tuple]: https://clickhouse.com/docs/en/sql-reference/data-types/tuple
3689    fn parse_click_house_tuple_def(&mut self) -> Result<Vec<StructField>, ParserError> {
3690        self.expect_keyword_is(Keyword::TUPLE)?;
3691        self.expect_token(&Token::LParen)?;
3692        let mut field_defs = vec![];
3693        loop {
3694            let (def, _) = self.parse_struct_field_def()?;
3695            field_defs.push(def);
3696            if !self.consume_token(&Token::Comma) {
3697                break;
3698            }
3699        }
3700        self.expect_token(&Token::RParen)?;
3701
3702        Ok(field_defs)
3703    }
3704
3705    /// For nested types that use the angle bracket syntax, this matches either
3706    /// `>`, `>>` or nothing depending on which variant is expected (specified by the previously
3707    /// matched `trailing_bracket` argument). It returns whether there is a trailing
3708    /// left to be matched - (i.e. if '>>' was matched).
3709    fn expect_closing_angle_bracket(
3710        &mut self,
3711        trailing_bracket: MatchedTrailingBracket,
3712    ) -> Result<MatchedTrailingBracket, ParserError> {
3713        let trailing_bracket = if !trailing_bracket.0 {
3714            match &self.peek_token_ref().token {
3715                Token::Gt => {
3716                    self.next_token();
3717                    false.into()
3718                }
3719                Token::ShiftRight => {
3720                    self.next_token();
3721                    true.into()
3722                }
3723                _ => return self.expected_ref(">", self.peek_token_ref()),
3724            }
3725        } else {
3726            false.into()
3727        };
3728
3729        Ok(trailing_bracket)
3730    }
3731
3732    /// Parse an operator following an expression
3733    pub fn parse_infix(&mut self, expr: Expr, precedence: u8) -> Result<Expr, ParserError> {
3734        // allow the dialect to override infix parsing
3735        if let Some(infix) = self.dialect.parse_infix(self, &expr, precedence) {
3736            return infix;
3737        }
3738
3739        let dialect = self.dialect;
3740
3741        self.advance_token();
3742        let tok = self.get_current_token();
3743        debug!("infix: {tok:?}");
3744        let tok_index = self.get_current_index();
3745        let span = tok.span;
3746        let regular_binary_operator = match &tok.token {
3747            Token::Spaceship => Some(BinaryOperator::Spaceship),
3748            Token::DoubleEq => Some(BinaryOperator::Eq),
3749            Token::Assignment => Some(BinaryOperator::Assignment),
3750            Token::Eq => Some(BinaryOperator::Eq),
3751            Token::Neq => Some(BinaryOperator::NotEq),
3752            Token::Gt => Some(BinaryOperator::Gt),
3753            Token::GtEq => Some(BinaryOperator::GtEq),
3754            Token::Lt => Some(BinaryOperator::Lt),
3755            Token::LtEq => Some(BinaryOperator::LtEq),
3756            Token::Plus => Some(BinaryOperator::Plus),
3757            Token::Minus => Some(BinaryOperator::Minus),
3758            Token::Mul => Some(BinaryOperator::Multiply),
3759            Token::Mod => Some(BinaryOperator::Modulo),
3760            Token::StringConcat => Some(BinaryOperator::StringConcat),
3761            Token::Pipe => Some(BinaryOperator::BitwiseOr),
3762            Token::Caret => {
3763                // In PostgreSQL, ^ stands for the exponentiation operation,
3764                // and # stands for XOR. See https://www.postgresql.org/docs/current/functions-math.html
3765                if dialect_is!(dialect is PostgreSqlDialect) {
3766                    Some(BinaryOperator::PGExp)
3767                } else {
3768                    Some(BinaryOperator::BitwiseXor)
3769                }
3770            }
3771            Token::Ampersand => Some(BinaryOperator::BitwiseAnd),
3772            Token::Div => Some(BinaryOperator::Divide),
3773            Token::DuckIntDiv if dialect_is!(dialect is DuckDbDialect | GenericDialect) => {
3774                Some(BinaryOperator::DuckIntegerDivide)
3775            }
3776            Token::ShiftLeft if dialect.supports_bitwise_shift_operators() => {
3777                Some(BinaryOperator::PGBitwiseShiftLeft)
3778            }
3779            Token::ShiftRight if dialect.supports_bitwise_shift_operators() => {
3780                Some(BinaryOperator::PGBitwiseShiftRight)
3781            }
3782            Token::Sharp if dialect_is!(dialect is PostgreSqlDialect | RedshiftSqlDialect) => {
3783                Some(BinaryOperator::PGBitwiseXor)
3784            }
3785            Token::Overlap if dialect_is!(dialect is PostgreSqlDialect | RedshiftSqlDialect) => {
3786                Some(BinaryOperator::PGOverlap)
3787            }
3788            Token::Overlap if dialect_is!(dialect is PostgreSqlDialect | GenericDialect) => {
3789                Some(BinaryOperator::PGOverlap)
3790            }
3791            Token::Overlap if dialect.supports_double_ampersand_operator() => {
3792                Some(BinaryOperator::And)
3793            }
3794            Token::CaretAt if dialect_is!(dialect is PostgreSqlDialect | GenericDialect) => {
3795                Some(BinaryOperator::PGStartsWith)
3796            }
3797            Token::Tilde => Some(BinaryOperator::PGRegexMatch),
3798            Token::TildeAsterisk => Some(BinaryOperator::PGRegexIMatch),
3799            Token::ExclamationMarkTilde => Some(BinaryOperator::PGRegexNotMatch),
3800            Token::ExclamationMarkTildeAsterisk => Some(BinaryOperator::PGRegexNotIMatch),
3801            Token::DoubleTilde => Some(BinaryOperator::PGLikeMatch),
3802            Token::DoubleTildeAsterisk => Some(BinaryOperator::PGILikeMatch),
3803            Token::ExclamationMarkDoubleTilde => Some(BinaryOperator::PGNotLikeMatch),
3804            Token::ExclamationMarkDoubleTildeAsterisk => Some(BinaryOperator::PGNotILikeMatch),
3805            Token::Arrow => Some(BinaryOperator::Arrow),
3806            Token::LongArrow => Some(BinaryOperator::LongArrow),
3807            Token::HashArrow => Some(BinaryOperator::HashArrow),
3808            Token::HashLongArrow => Some(BinaryOperator::HashLongArrow),
3809            Token::AtArrow => Some(BinaryOperator::AtArrow),
3810            Token::ArrowAt => Some(BinaryOperator::ArrowAt),
3811            Token::HashMinus => Some(BinaryOperator::HashMinus),
3812            Token::AtQuestion => Some(BinaryOperator::AtQuestion),
3813            Token::AtAt => Some(BinaryOperator::AtAt),
3814            Token::Question => Some(BinaryOperator::Question),
3815            Token::QuestionAnd => Some(BinaryOperator::QuestionAnd),
3816            Token::QuestionPipe => Some(BinaryOperator::QuestionPipe),
3817            Token::CustomBinaryOperator(s) => Some(BinaryOperator::Custom(s.clone())),
3818            Token::DoubleSharp if self.dialect.supports_geometric_types() => {
3819                Some(BinaryOperator::DoubleHash)
3820            }
3821
3822            Token::AmpersandLeftAngleBracket if self.dialect.supports_geometric_types() => {
3823                Some(BinaryOperator::AndLt)
3824            }
3825            Token::AmpersandRightAngleBracket if self.dialect.supports_geometric_types() => {
3826                Some(BinaryOperator::AndGt)
3827            }
3828            Token::QuestionMarkDash if self.dialect.supports_geometric_types() => {
3829                Some(BinaryOperator::QuestionDash)
3830            }
3831            Token::AmpersandLeftAngleBracketVerticalBar
3832                if self.dialect.supports_geometric_types() =>
3833            {
3834                Some(BinaryOperator::AndLtPipe)
3835            }
3836            Token::VerticalBarAmpersandRightAngleBracket
3837                if self.dialect.supports_geometric_types() =>
3838            {
3839                Some(BinaryOperator::PipeAndGt)
3840            }
3841            Token::TwoWayArrow if self.dialect.supports_geometric_types() => {
3842                Some(BinaryOperator::LtDashGt)
3843            }
3844            Token::LeftAngleBracketCaret if self.dialect.supports_geometric_types() => {
3845                Some(BinaryOperator::LtCaret)
3846            }
3847            Token::RightAngleBracketCaret if self.dialect.supports_geometric_types() => {
3848                Some(BinaryOperator::GtCaret)
3849            }
3850            Token::QuestionMarkSharp if self.dialect.supports_geometric_types() => {
3851                Some(BinaryOperator::QuestionHash)
3852            }
3853            Token::QuestionMarkDoubleVerticalBar if self.dialect.supports_geometric_types() => {
3854                Some(BinaryOperator::QuestionDoublePipe)
3855            }
3856            Token::QuestionMarkDashVerticalBar if self.dialect.supports_geometric_types() => {
3857                Some(BinaryOperator::QuestionDashPipe)
3858            }
3859            Token::TildeEqual if self.dialect.supports_geometric_types() => {
3860                Some(BinaryOperator::TildeEq)
3861            }
3862            Token::ShiftLeftVerticalBar if self.dialect.supports_geometric_types() => {
3863                Some(BinaryOperator::LtLtPipe)
3864            }
3865            Token::VerticalBarShiftRight if self.dialect.supports_geometric_types() => {
3866                Some(BinaryOperator::PipeGtGt)
3867            }
3868            Token::AtSign if self.dialect.supports_geometric_types() => Some(BinaryOperator::At),
3869
3870            Token::Word(w) => match w.keyword {
3871                Keyword::AND => Some(BinaryOperator::And),
3872                Keyword::OR => Some(BinaryOperator::Or),
3873                Keyword::XOR => Some(BinaryOperator::Xor),
3874                Keyword::OVERLAPS => Some(BinaryOperator::Overlaps),
3875                Keyword::OPERATOR if dialect_is!(dialect is PostgreSqlDialect | GenericDialect) => {
3876                    self.expect_token(&Token::LParen)?;
3877                    // there are special rules for operator names in
3878                    // postgres so we can not use 'parse_object'
3879                    // or similar.
3880                    // See https://www.postgresql.org/docs/current/sql-createoperator.html
3881                    let mut idents = vec![];
3882                    loop {
3883                        self.advance_token();
3884                        idents.push(self.get_current_token().to_string());
3885                        if !self.consume_token(&Token::Period) {
3886                            break;
3887                        }
3888                    }
3889                    self.expect_token(&Token::RParen)?;
3890                    Some(BinaryOperator::PGCustomBinaryOperator(idents))
3891                }
3892                _ => None,
3893            },
3894            _ => None,
3895        };
3896
3897        let tok = self.token_at(tok_index);
3898        if let Some(op) = regular_binary_operator {
3899            if let Some(keyword) =
3900                self.parse_one_of_keywords(&[Keyword::ANY, Keyword::ALL, Keyword::SOME])
3901            {
3902                self.expect_token(&Token::LParen)?;
3903                let right = if self.peek_sub_query() {
3904                    // We have a subquery ahead (SELECT\WITH ...) need to rewind and
3905                    // use the parenthesis for parsing the subquery as an expression.
3906                    self.prev_token(); // LParen
3907                    self.parse_subexpr(precedence)?
3908                } else {
3909                    // Non-subquery expression
3910                    let right = self.parse_subexpr(precedence)?;
3911                    self.expect_token(&Token::RParen)?;
3912                    right
3913                };
3914
3915                if !matches!(
3916                    op,
3917                    BinaryOperator::Gt
3918                        | BinaryOperator::Lt
3919                        | BinaryOperator::GtEq
3920                        | BinaryOperator::LtEq
3921                        | BinaryOperator::Eq
3922                        | BinaryOperator::NotEq
3923                        | BinaryOperator::PGRegexMatch
3924                        | BinaryOperator::PGRegexIMatch
3925                        | BinaryOperator::PGRegexNotMatch
3926                        | BinaryOperator::PGRegexNotIMatch
3927                        | BinaryOperator::PGLikeMatch
3928                        | BinaryOperator::PGILikeMatch
3929                        | BinaryOperator::PGNotLikeMatch
3930                        | BinaryOperator::PGNotILikeMatch
3931                ) {
3932                    return parser_err!(
3933                        format!(
3934                        "Expected one of [=, >, <, =>, =<, !=, ~, ~*, !~, !~*, ~~, ~~*, !~~, !~~*] as comparison operator, found: {op}"
3935                    ),
3936                        span.start
3937                    );
3938                };
3939
3940                Ok(match keyword {
3941                    Keyword::ALL => Expr::AllOp {
3942                        left: Box::new(expr),
3943                        compare_op: op,
3944                        right: Box::new(right),
3945                    },
3946                    Keyword::ANY | Keyword::SOME => Expr::AnyOp {
3947                        left: Box::new(expr),
3948                        compare_op: op,
3949                        right: Box::new(right),
3950                        is_some: keyword == Keyword::SOME,
3951                    },
3952                    unexpected_keyword => return Err(ParserError::ParserError(
3953                        format!("Internal parser error: expected any of {{ALL, ANY, SOME}}, got {unexpected_keyword:?}"),
3954                    )),
3955                })
3956            } else {
3957                Ok(Expr::BinaryOp {
3958                    left: Box::new(expr),
3959                    op,
3960                    right: Box::new(self.parse_subexpr(precedence)?),
3961                })
3962            }
3963        } else if let Token::Word(w) = &tok.token {
3964            match w.keyword {
3965                Keyword::IS => {
3966                    if self.parse_keyword(Keyword::NULL) {
3967                        Ok(Expr::IsNull(Box::new(expr)))
3968                    } else if self.parse_keywords(&[Keyword::NOT, Keyword::NULL]) {
3969                        Ok(Expr::IsNotNull(Box::new(expr)))
3970                    } else if self.parse_keywords(&[Keyword::TRUE]) {
3971                        Ok(Expr::IsTrue(Box::new(expr)))
3972                    } else if self.parse_keywords(&[Keyword::NOT, Keyword::TRUE]) {
3973                        Ok(Expr::IsNotTrue(Box::new(expr)))
3974                    } else if self.parse_keywords(&[Keyword::FALSE]) {
3975                        Ok(Expr::IsFalse(Box::new(expr)))
3976                    } else if self.parse_keywords(&[Keyword::NOT, Keyword::FALSE]) {
3977                        Ok(Expr::IsNotFalse(Box::new(expr)))
3978                    } else if self.parse_keywords(&[Keyword::UNKNOWN]) {
3979                        Ok(Expr::IsUnknown(Box::new(expr)))
3980                    } else if self.parse_keywords(&[Keyword::NOT, Keyword::UNKNOWN]) {
3981                        Ok(Expr::IsNotUnknown(Box::new(expr)))
3982                    } else if self.parse_keywords(&[Keyword::DISTINCT, Keyword::FROM]) {
3983                        let expr2 = self.parse_expr()?;
3984                        Ok(Expr::IsDistinctFrom(Box::new(expr), Box::new(expr2)))
3985                    } else if self.parse_keywords(&[Keyword::NOT, Keyword::DISTINCT, Keyword::FROM])
3986                    {
3987                        let expr2 = self.parse_expr()?;
3988                        Ok(Expr::IsNotDistinctFrom(Box::new(expr), Box::new(expr2)))
3989                    } else if let Ok(is_normalized) = self.parse_unicode_is_normalized(expr) {
3990                        Ok(is_normalized)
3991                    } else {
3992                        self.expected_ref(
3993                            "[NOT] NULL | TRUE | FALSE | DISTINCT | [form] NORMALIZED FROM after IS",
3994                            self.peek_token_ref(),
3995                        )
3996                    }
3997                }
3998                Keyword::AT => {
3999                    self.expect_keywords(&[Keyword::TIME, Keyword::ZONE])?;
4000                    Ok(Expr::AtTimeZone {
4001                        timestamp: Box::new(expr),
4002                        time_zone: Box::new(self.parse_subexpr(precedence)?),
4003                    })
4004                }
4005                Keyword::NOT
4006                | Keyword::IN
4007                | Keyword::BETWEEN
4008                | Keyword::LIKE
4009                | Keyword::ILIKE
4010                | Keyword::SIMILAR
4011                | Keyword::REGEXP
4012                | Keyword::RLIKE => {
4013                    self.prev_token();
4014                    let negated = self.parse_keyword(Keyword::NOT);
4015                    let regexp = self.parse_keyword(Keyword::REGEXP);
4016                    let rlike = self.parse_keyword(Keyword::RLIKE);
4017                    let null = if !self.in_column_definition_state() {
4018                        self.parse_keyword(Keyword::NULL)
4019                    } else {
4020                        false
4021                    };
4022                    if regexp || rlike {
4023                        Ok(Expr::RLike {
4024                            negated,
4025                            expr: Box::new(expr),
4026                            pattern: Box::new(
4027                                self.parse_subexpr(self.dialect.prec_value(Precedence::Like))?,
4028                            ),
4029                            regexp,
4030                        })
4031                    } else if negated && null {
4032                        Ok(Expr::IsNotNull(Box::new(expr)))
4033                    } else if self.parse_keyword(Keyword::IN) {
4034                        self.parse_in(expr, negated)
4035                    } else if self.parse_keyword(Keyword::BETWEEN) {
4036                        self.parse_between(expr, negated)
4037                    } else if self.parse_keyword(Keyword::LIKE) {
4038                        Ok(Expr::Like {
4039                            negated,
4040                            any: self.parse_keyword(Keyword::ANY),
4041                            expr: Box::new(expr),
4042                            pattern: Box::new(
4043                                self.parse_subexpr(self.dialect.prec_value(Precedence::Like))?,
4044                            ),
4045                            escape_char: self.parse_escape_char()?,
4046                        })
4047                    } else if self.parse_keyword(Keyword::ILIKE) {
4048                        Ok(Expr::ILike {
4049                            negated,
4050                            any: self.parse_keyword(Keyword::ANY),
4051                            expr: Box::new(expr),
4052                            pattern: Box::new(
4053                                self.parse_subexpr(self.dialect.prec_value(Precedence::Like))?,
4054                            ),
4055                            escape_char: self.parse_escape_char()?,
4056                        })
4057                    } else if self.parse_keywords(&[Keyword::SIMILAR, Keyword::TO]) {
4058                        Ok(Expr::SimilarTo {
4059                            negated,
4060                            expr: Box::new(expr),
4061                            pattern: Box::new(
4062                                self.parse_subexpr(self.dialect.prec_value(Precedence::Like))?,
4063                            ),
4064                            escape_char: self.parse_escape_char()?,
4065                        })
4066                    } else {
4067                        self.expected_ref("IN or BETWEEN after NOT", self.peek_token_ref())
4068                    }
4069                }
4070                Keyword::NOTNULL if dialect.supports_notnull_operator() => {
4071                    Ok(Expr::IsNotNull(Box::new(expr)))
4072                }
4073                Keyword::MEMBER => {
4074                    if self.parse_keyword(Keyword::OF) {
4075                        self.expect_token(&Token::LParen)?;
4076                        let array = self.parse_expr()?;
4077                        self.expect_token(&Token::RParen)?;
4078                        Ok(Expr::MemberOf(MemberOf {
4079                            value: Box::new(expr),
4080                            array: Box::new(array),
4081                        }))
4082                    } else {
4083                        self.expected_ref("OF after MEMBER", self.peek_token_ref())
4084                    }
4085                }
4086                // Can only happen if `get_next_precedence` got out of sync with this function
4087                _ => parser_err!(
4088                    format!("No infix parser for token {:?}", tok.token),
4089                    tok.span.start
4090                ),
4091            }
4092        } else if Token::DoubleColon == *tok {
4093            Ok(Expr::Cast {
4094                kind: CastKind::DoubleColon,
4095                expr: Box::new(expr),
4096                data_type: self.parse_data_type()?,
4097                array: false,
4098                format: None,
4099            })
4100        } else if Token::ExclamationMark == *tok && self.dialect.supports_factorial_operator() {
4101            Ok(Expr::UnaryOp {
4102                op: UnaryOperator::PGPostfixFactorial,
4103                expr: Box::new(expr),
4104            })
4105        } else if Token::LBracket == *tok && self.dialect.supports_partiql()
4106            || (Token::Colon == *tok)
4107        {
4108            self.prev_token();
4109            self.parse_json_access(expr)
4110        } else {
4111            // Can only happen if `get_next_precedence` got out of sync with this function
4112            parser_err!(
4113                format!("No infix parser for token {:?}", tok.token),
4114                tok.span.start
4115            )
4116        }
4117    }
4118
4119    /// Parse the `ESCAPE CHAR` portion of `LIKE`, `ILIKE`, and `SIMILAR TO`
4120    pub fn parse_escape_char(&mut self) -> Result<Option<ValueWithSpan>, ParserError> {
4121        if self.parse_keyword(Keyword::ESCAPE) {
4122            Ok(Some(self.parse_value()?))
4123        } else {
4124            Ok(None)
4125        }
4126    }
4127
4128    /// Parses an array subscript like
4129    /// * `[:]`
4130    /// * `[l]`
4131    /// * `[l:]`
4132    /// * `[:u]`
4133    /// * `[l:u]`
4134    /// * `[l:u:s]`
4135    ///
4136    /// Parser is right after `[`
4137    fn parse_subscript_inner(&mut self) -> Result<Subscript, ParserError> {
4138        // at either `<lower>:(rest)` or `:(rest)]`
4139        let lower_bound = if self.consume_token(&Token::Colon) {
4140            None
4141        } else {
4142            // parse expr until we hit a colon (or any token with lower precedence)
4143            Some(self.parse_subexpr(self.dialect.prec_value(Precedence::Colon))?)
4144        };
4145
4146        // check for end
4147        if self.consume_token(&Token::RBracket) {
4148            if let Some(lower_bound) = lower_bound {
4149                return Ok(Subscript::Index { index: lower_bound });
4150            };
4151            return Ok(Subscript::Slice {
4152                lower_bound,
4153                upper_bound: None,
4154                stride: None,
4155            });
4156        }
4157
4158        // consume the `:`
4159        if lower_bound.is_some() {
4160            self.expect_token(&Token::Colon)?;
4161        }
4162
4163        // we are now at either `]`, `<upper>(rest)]`
4164        let upper_bound = if self.consume_token(&Token::RBracket) {
4165            return Ok(Subscript::Slice {
4166                lower_bound,
4167                upper_bound: None,
4168                stride: None,
4169            });
4170        } else {
4171            // parse expr until we hit a colon (or any token with lower precedence)
4172            Some(self.parse_subexpr(self.dialect.prec_value(Precedence::Colon))?)
4173        };
4174
4175        // check for end
4176        if self.consume_token(&Token::RBracket) {
4177            return Ok(Subscript::Slice {
4178                lower_bound,
4179                upper_bound,
4180                stride: None,
4181            });
4182        }
4183
4184        // we are now at `:]` or `:stride]`
4185        self.expect_token(&Token::Colon)?;
4186        let stride = if self.consume_token(&Token::RBracket) {
4187            None
4188        } else {
4189            Some(self.parse_expr()?)
4190        };
4191
4192        if stride.is_some() {
4193            self.expect_token(&Token::RBracket)?;
4194        }
4195
4196        Ok(Subscript::Slice {
4197            lower_bound,
4198            upper_bound,
4199            stride,
4200        })
4201    }
4202
4203    /// Parse a multi-dimension array accessing like `[1:3][1][1]`
4204    pub fn parse_multi_dim_subscript(
4205        &mut self,
4206        chain: &mut Vec<AccessExpr>,
4207    ) -> Result<(), ParserError> {
4208        while self.consume_token(&Token::LBracket) {
4209            self.parse_subscript(chain)?;
4210        }
4211        Ok(())
4212    }
4213
4214    /// Parses an array subscript like `[1:3]`
4215    ///
4216    /// Parser is right after `[`
4217    fn parse_subscript(&mut self, chain: &mut Vec<AccessExpr>) -> Result<(), ParserError> {
4218        let subscript = self.parse_subscript_inner()?;
4219        chain.push(AccessExpr::Subscript(subscript));
4220        Ok(())
4221    }
4222
4223    fn parse_json_path_object_key(&mut self) -> Result<JsonPathElem, ParserError> {
4224        let token = self.next_token();
4225        match token.token {
4226            Token::Word(Word {
4227                value,
4228                // path segments in SF dot notation can be unquoted or double-quoted;
4229                // Databricks also supports backtick-quoted identifiers
4230                quote_style: quote_style @ (Some('"') | Some('`') | None),
4231                // some experimentation suggests that snowflake permits
4232                // any keyword here unquoted.
4233                keyword: _,
4234            }) => Ok(JsonPathElem::Dot {
4235                key: value,
4236                quoted: quote_style.is_some(),
4237            }),
4238
4239            // This token should never be generated on snowflake or generic
4240            // dialects, but we handle it just in case this is used on future
4241            // dialects.
4242            Token::DoubleQuotedString(key) => Ok(JsonPathElem::Dot { key, quoted: true }),
4243
4244            _ => self.expected("variant object key name", token),
4245        }
4246    }
4247
4248    fn parse_json_access(&mut self, expr: Expr) -> Result<Expr, ParserError> {
4249        let path = self.parse_json_path()?;
4250        Ok(Expr::JsonAccess {
4251            value: Box::new(expr),
4252            path,
4253        })
4254    }
4255
4256    fn parse_json_path(&mut self) -> Result<JsonPath, ParserError> {
4257        let mut path = Vec::new();
4258        loop {
4259            match self.next_token().token {
4260                Token::Colon if path.is_empty() && self.peek_token_ref() == &Token::LBracket => {
4261                    self.next_token();
4262                    let key = self.parse_wildcard_expr()?;
4263                    self.expect_token(&Token::RBracket)?;
4264                    path.push(JsonPathElem::ColonBracket { key });
4265                }
4266                Token::Colon if path.is_empty() => {
4267                    path.push(self.parse_json_path_object_key()?);
4268                }
4269                Token::Period if !path.is_empty() => {
4270                    path.push(self.parse_json_path_object_key()?);
4271                }
4272                Token::LBracket => {
4273                    let key = self.parse_wildcard_expr()?;
4274                    self.expect_token(&Token::RBracket)?;
4275
4276                    path.push(JsonPathElem::Bracket { key });
4277                }
4278                _ => {
4279                    self.prev_token();
4280                    break;
4281                }
4282            };
4283        }
4284
4285        debug_assert!(!path.is_empty());
4286        Ok(JsonPath { path })
4287    }
4288
4289    /// Parses the parens following the `[ NOT ] IN` operator.
4290    pub fn parse_in(&mut self, expr: Expr, negated: bool) -> Result<Expr, ParserError> {
4291        // BigQuery allows `IN UNNEST(array_expression)`
4292        // https://cloud.google.com/bigquery/docs/reference/standard-sql/operators#in_operators
4293        if self.parse_keyword(Keyword::UNNEST) {
4294            self.expect_token(&Token::LParen)?;
4295            let array_expr = self.parse_expr()?;
4296            self.expect_token(&Token::RParen)?;
4297            return Ok(Expr::InUnnest {
4298                expr: Box::new(expr),
4299                array_expr: Box::new(array_expr),
4300                negated,
4301            });
4302        }
4303        self.expect_token(&Token::LParen)?;
4304        let in_op = match self.maybe_parse(|p| p.parse_query())? {
4305            Some(subquery) => Expr::InSubquery {
4306                expr: Box::new(expr),
4307                subquery,
4308                negated,
4309            },
4310            None => Expr::InList {
4311                expr: Box::new(expr),
4312                list: if self.dialect.supports_in_empty_list() {
4313                    self.parse_comma_separated0(Parser::parse_expr, Token::RParen)?
4314                } else {
4315                    self.parse_comma_separated(Parser::parse_expr)?
4316                },
4317                negated,
4318            },
4319        };
4320        self.expect_token(&Token::RParen)?;
4321        Ok(in_op)
4322    }
4323
4324    /// Parses `BETWEEN <low> AND <high>`, assuming the `BETWEEN` keyword was already consumed.
4325    pub fn parse_between(&mut self, expr: Expr, negated: bool) -> Result<Expr, ParserError> {
4326        // Stop parsing subexpressions for <low> and <high> on tokens with
4327        // precedence lower than that of `BETWEEN`, such as `AND`, `IS`, etc.
4328        let low = self.parse_subexpr(self.dialect.prec_value(Precedence::Between))?;
4329        self.expect_keyword_is(Keyword::AND)?;
4330        let high = self.parse_subexpr(self.dialect.prec_value(Precedence::Between))?;
4331        Ok(Expr::Between {
4332            expr: Box::new(expr),
4333            negated,
4334            low: Box::new(low),
4335            high: Box::new(high),
4336        })
4337    }
4338
4339    /// Parse a PostgreSQL casting style which is in the form of `expr::datatype`.
4340    pub fn parse_pg_cast(&mut self, expr: Expr) -> Result<Expr, ParserError> {
4341        Ok(Expr::Cast {
4342            kind: CastKind::DoubleColon,
4343            expr: Box::new(expr),
4344            data_type: self.parse_data_type()?,
4345            array: false,
4346            format: None,
4347        })
4348    }
4349
4350    /// Get the precedence of the next token
4351    pub fn get_next_precedence(&self) -> Result<u8, ParserError> {
4352        self.dialect.get_next_precedence_default(self)
4353    }
4354
4355    /// Return the token at the given location, or EOF if the index is beyond
4356    /// the length of the current set of tokens.
4357    pub fn token_at(&self, index: usize) -> &TokenWithSpan {
4358        self.tokens.get(index).unwrap_or(&EOF_TOKEN)
4359    }
4360
4361    /// Return the first non-whitespace token that has not yet been processed
4362    /// or Token::EOF
4363    ///
4364    /// See [`Self::peek_token_ref`] to avoid the copy.
4365    pub fn peek_token(&self) -> TokenWithSpan {
4366        self.peek_nth_token(0)
4367    }
4368
4369    /// Return a reference to the first non-whitespace token that has not yet
4370    /// been processed or Token::EOF
4371    pub fn peek_token_ref(&self) -> &TokenWithSpan {
4372        self.peek_nth_token_ref(0)
4373    }
4374
4375    /// Returns the `N` next non-whitespace tokens that have not yet been
4376    /// processed.
4377    ///
4378    /// Example:
4379    /// ```rust
4380    /// # use sqlparser::dialect::GenericDialect;
4381    /// # use sqlparser::parser::Parser;
4382    /// # use sqlparser::keywords::Keyword;
4383    /// # use sqlparser::tokenizer::{Token, Word};
4384    /// let dialect = GenericDialect {};
4385    /// let mut parser = Parser::new(&dialect).try_with_sql("ORDER BY foo, bar").unwrap();
4386    ///
4387    /// // Note that Rust infers the number of tokens to peek based on the
4388    /// // length of the slice pattern!
4389    /// assert!(matches!(
4390    ///     parser.peek_tokens(),
4391    ///     [
4392    ///         Token::Word(Word { keyword: Keyword::ORDER, .. }),
4393    ///         Token::Word(Word { keyword: Keyword::BY, .. }),
4394    ///     ]
4395    /// ));
4396    /// ```
4397    pub fn peek_tokens<const N: usize>(&self) -> [Token; N] {
4398        self.peek_tokens_with_location()
4399            .map(|with_loc| with_loc.token)
4400    }
4401
4402    /// Returns the `N` next non-whitespace tokens with locations that have not
4403    /// yet been processed.
4404    ///
4405    /// See [`Self::peek_token`] for an example.
4406    pub fn peek_tokens_with_location<const N: usize>(&self) -> [TokenWithSpan; N] {
4407        let mut index = self.index;
4408        core::array::from_fn(|_| loop {
4409            let token = self.tokens.get(index);
4410            index += 1;
4411            if let Some(TokenWithSpan {
4412                token: Token::Whitespace(_),
4413                span: _,
4414            }) = token
4415            {
4416                continue;
4417            }
4418            break token.cloned().unwrap_or(TokenWithSpan {
4419                token: Token::EOF,
4420                span: Span::empty(),
4421            });
4422        })
4423    }
4424
4425    /// Returns references to the `N` next non-whitespace tokens
4426    /// that have not yet been processed.
4427    ///
4428    /// See [`Self::peek_tokens`] for an example.
4429    pub fn peek_tokens_ref<const N: usize>(&self) -> [&TokenWithSpan; N] {
4430        let mut index = self.index;
4431        core::array::from_fn(|_| loop {
4432            let token = self.tokens.get(index);
4433            index += 1;
4434            if let Some(TokenWithSpan {
4435                token: Token::Whitespace(_),
4436                span: _,
4437            }) = token
4438            {
4439                continue;
4440            }
4441            break token.unwrap_or(&EOF_TOKEN);
4442        })
4443    }
4444
4445    /// Return nth non-whitespace token that has not yet been processed
4446    pub fn peek_nth_token(&self, n: usize) -> TokenWithSpan {
4447        self.peek_nth_token_ref(n).clone()
4448    }
4449
4450    /// Return nth non-whitespace token that has not yet been processed
4451    pub fn peek_nth_token_ref(&self, mut n: usize) -> &TokenWithSpan {
4452        let mut index = self.index;
4453        loop {
4454            index += 1;
4455            match self.tokens.get(index - 1) {
4456                Some(TokenWithSpan {
4457                    token: Token::Whitespace(_),
4458                    span: _,
4459                }) => continue,
4460                non_whitespace => {
4461                    if n == 0 {
4462                        return non_whitespace.unwrap_or(&EOF_TOKEN);
4463                    }
4464                    n -= 1;
4465                }
4466            }
4467        }
4468    }
4469
4470    /// Return the first token, possibly whitespace, that has not yet been processed
4471    /// (or None if reached end-of-file).
4472    pub fn peek_token_no_skip(&self) -> TokenWithSpan {
4473        self.peek_nth_token_no_skip(0)
4474    }
4475
4476    /// Return nth token, possibly whitespace, that has not yet been processed.
4477    pub fn peek_nth_token_no_skip(&self, n: usize) -> TokenWithSpan {
4478        self.tokens
4479            .get(self.index + n)
4480            .cloned()
4481            .unwrap_or(TokenWithSpan {
4482                token: Token::EOF,
4483                span: Span::empty(),
4484            })
4485    }
4486
4487    /// Return nth token, possibly whitespace, that has not yet been processed.
4488    fn peek_nth_token_no_skip_ref(&self, n: usize) -> &TokenWithSpan {
4489        self.tokens.get(self.index + n).unwrap_or(&EOF_TOKEN)
4490    }
4491
4492    /// Return true if the next tokens exactly `expected`
4493    ///
4494    /// Does not advance the current token.
4495    fn peek_keywords(&mut self, expected: &[Keyword]) -> bool {
4496        let index = self.index;
4497        let matched = self.parse_keywords(expected);
4498        self.index = index;
4499        matched
4500    }
4501
4502    /// Advances to the next non-whitespace token and returns a copy.
4503    ///
4504    /// Please use [`Self::advance_token`] and [`Self::get_current_token`] to
4505    /// avoid the copy.
4506    pub fn next_token(&mut self) -> TokenWithSpan {
4507        self.advance_token();
4508        self.get_current_token().clone()
4509    }
4510
4511    /// Returns the index of the current token
4512    ///
4513    /// This can be used with APIs that expect an index, such as
4514    /// [`Self::token_at`]
4515    pub fn get_current_index(&self) -> usize {
4516        self.index.saturating_sub(1)
4517    }
4518
4519    /// Return the next unprocessed token, possibly whitespace.
4520    pub fn next_token_no_skip(&mut self) -> Option<&TokenWithSpan> {
4521        self.index += 1;
4522        self.tokens.get(self.index - 1)
4523    }
4524
4525    /// Advances the current token to the next non-whitespace token
4526    ///
4527    /// See [`Self::get_current_token`] to get the current token after advancing
4528    pub fn advance_token(&mut self) {
4529        loop {
4530            self.index += 1;
4531            match self.tokens.get(self.index - 1) {
4532                Some(TokenWithSpan {
4533                    token: Token::Whitespace(_),
4534                    span: _,
4535                }) => continue,
4536                _ => break,
4537            }
4538        }
4539    }
4540
4541    /// Returns a reference to the current token
4542    ///
4543    /// Does not advance the current token.
4544    pub fn get_current_token(&self) -> &TokenWithSpan {
4545        self.token_at(self.index.saturating_sub(1))
4546    }
4547
4548    /// Returns a reference to the previous token
4549    ///
4550    /// Does not advance the current token.
4551    pub fn get_previous_token(&self) -> &TokenWithSpan {
4552        self.token_at(self.index.saturating_sub(2))
4553    }
4554
4555    /// Returns a reference to the next token
4556    ///
4557    /// Does not advance the current token.
4558    pub fn get_next_token(&self) -> &TokenWithSpan {
4559        self.token_at(self.index)
4560    }
4561
4562    /// Seek back the last one non-whitespace token.
4563    ///
4564    /// Must be called after `next_token()`, otherwise might panic. OK to call
4565    /// after `next_token()` indicates an EOF.
4566    ///
4567    // TODO rename to backup_token and deprecate prev_token?
4568    pub fn prev_token(&mut self) {
4569        loop {
4570            assert!(self.index > 0);
4571            self.index -= 1;
4572            if let Some(TokenWithSpan {
4573                token: Token::Whitespace(_),
4574                span: _,
4575            }) = self.tokens.get(self.index)
4576            {
4577                continue;
4578            }
4579            return;
4580        }
4581    }
4582
4583    /// Report `found` was encountered instead of `expected`
4584    pub fn expected<T>(&self, expected: &str, found: TokenWithSpan) -> Result<T, ParserError> {
4585        parser_err!(
4586            format!("Expected: {expected}, found: {found}"),
4587            found.span.start
4588        )
4589    }
4590
4591    /// report `found` was encountered instead of `expected`
4592    pub fn expected_ref<T>(&self, expected: &str, found: &TokenWithSpan) -> Result<T, ParserError> {
4593        parser_err!(
4594            format!("Expected: {expected}, found: {found}"),
4595            found.span.start
4596        )
4597    }
4598
4599    /// Report that the token at `index` was found instead of `expected`.
4600    pub fn expected_at<T>(&self, expected: &str, index: usize) -> Result<T, ParserError> {
4601        let found = self.tokens.get(index).unwrap_or(&EOF_TOKEN);
4602        parser_err!(
4603            format!("Expected: {expected}, found: {found}"),
4604            found.span.start
4605        )
4606    }
4607
4608    /// If the current token is the `expected` keyword, consume it and returns
4609    /// true. Otherwise, no tokens are consumed and returns false.
4610    #[must_use]
4611    pub fn parse_keyword(&mut self, expected: Keyword) -> bool {
4612        if self.peek_keyword(expected) {
4613            self.advance_token();
4614            true
4615        } else {
4616            false
4617        }
4618    }
4619
4620    #[must_use]
4621    /// Check if the current token is the expected keyword without consuming it.
4622    ///
4623    /// Returns true if the current token matches the expected keyword.
4624    pub fn peek_keyword(&self, expected: Keyword) -> bool {
4625        matches!(&self.peek_token_ref().token, Token::Word(w) if expected == w.keyword)
4626    }
4627
4628    /// If the current token is the `expected` keyword followed by
4629    /// specified tokens, consume them and returns true.
4630    /// Otherwise, no tokens are consumed and returns false.
4631    ///
4632    /// Note that if the length of `tokens` is too long, this function will
4633    /// not be efficient as it does a loop on the tokens with `peek_nth_token`
4634    /// each time.
4635    pub fn parse_keyword_with_tokens(&mut self, expected: Keyword, tokens: &[Token]) -> bool {
4636        self.keyword_with_tokens(expected, tokens, true)
4637    }
4638
4639    /// Peeks to see if the current token is the `expected` keyword followed by specified tokens
4640    /// without consuming them.
4641    ///
4642    /// See [Self::parse_keyword_with_tokens] for details.
4643    pub(crate) fn peek_keyword_with_tokens(&mut self, expected: Keyword, tokens: &[Token]) -> bool {
4644        self.keyword_with_tokens(expected, tokens, false)
4645    }
4646
4647    fn keyword_with_tokens(&mut self, expected: Keyword, tokens: &[Token], consume: bool) -> bool {
4648        match &self.peek_token_ref().token {
4649            Token::Word(w) if expected == w.keyword => {
4650                for (idx, token) in tokens.iter().enumerate() {
4651                    if self.peek_nth_token_ref(idx + 1).token != *token {
4652                        return false;
4653                    }
4654                }
4655
4656                if consume {
4657                    for _ in 0..(tokens.len() + 1) {
4658                        self.advance_token();
4659                    }
4660                }
4661
4662                true
4663            }
4664            _ => false,
4665        }
4666    }
4667
4668    /// If the current and subsequent tokens exactly match the `keywords`
4669    /// sequence, consume them and returns true. Otherwise, no tokens are
4670    /// consumed and returns false
4671    #[must_use]
4672    pub fn parse_keywords(&mut self, keywords: &[Keyword]) -> bool {
4673        self.parse_keywords_indexed(keywords).is_some()
4674    }
4675
4676    /// Just like [Self::parse_keywords], but - upon success - returns the
4677    /// token index of the first keyword.
4678    #[must_use]
4679    fn parse_keywords_indexed(&mut self, keywords: &[Keyword]) -> Option<usize> {
4680        let start_index = self.index;
4681        let mut first_keyword_index = None;
4682        for &keyword in keywords {
4683            if !self.parse_keyword(keyword) {
4684                self.index = start_index;
4685                return None;
4686            }
4687            if first_keyword_index.is_none() {
4688                first_keyword_index = Some(self.index.saturating_sub(1));
4689            }
4690        }
4691        first_keyword_index
4692    }
4693
4694    /// If the current token is one of the given `keywords`, returns the keyword
4695    /// that matches, without consuming the token. Otherwise, returns [`None`].
4696    #[must_use]
4697    pub fn peek_one_of_keywords(&self, keywords: &[Keyword]) -> Option<Keyword> {
4698        for keyword in keywords {
4699            if self.peek_keyword(*keyword) {
4700                return Some(*keyword);
4701            }
4702        }
4703        None
4704    }
4705
4706    /// If the current token is one of the given `keywords`, consume the token
4707    /// and return the keyword that matches. Otherwise, no tokens are consumed
4708    /// and returns [`None`].
4709    #[must_use]
4710    pub fn parse_one_of_keywords(&mut self, keywords: &[Keyword]) -> Option<Keyword> {
4711        match &self.peek_token_ref().token {
4712            Token::Word(w) => {
4713                keywords
4714                    .iter()
4715                    .find(|keyword| **keyword == w.keyword)
4716                    .map(|keyword| {
4717                        self.advance_token();
4718                        *keyword
4719                    })
4720            }
4721            _ => None,
4722        }
4723    }
4724
4725    /// If the current token is one of the expected keywords, consume the token
4726    /// and return the keyword that matches. Otherwise, return an error.
4727    pub fn expect_one_of_keywords(&mut self, keywords: &[Keyword]) -> Result<Keyword, ParserError> {
4728        if let Some(keyword) = self.parse_one_of_keywords(keywords) {
4729            Ok(keyword)
4730        } else {
4731            let keywords: Vec<String> = keywords.iter().map(|x| format!("{x:?}")).collect();
4732            self.expected_ref(
4733                &format!("one of {}", keywords.join(" or ")),
4734                self.peek_token_ref(),
4735            )
4736        }
4737    }
4738
4739    /// If the current token is the `expected` keyword, consume the token.
4740    /// Otherwise, return an error.
4741    ///
4742    // todo deprecate in favor of expected_keyword_is
4743    pub fn expect_keyword(&mut self, expected: Keyword) -> Result<TokenWithSpan, ParserError> {
4744        if self.parse_keyword(expected) {
4745            Ok(self.get_current_token().clone())
4746        } else {
4747            self.expected_ref(format!("{:?}", &expected).as_str(), self.peek_token_ref())
4748        }
4749    }
4750
4751    /// If the current token is the `expected` keyword, consume the token.
4752    /// Otherwise, return an error.
4753    ///
4754    /// This differs from expect_keyword only in that the matched keyword
4755    /// token is not returned.
4756    pub fn expect_keyword_is(&mut self, expected: Keyword) -> Result<(), ParserError> {
4757        if self.parse_keyword(expected) {
4758            Ok(())
4759        } else {
4760            self.expected_ref(format!("{:?}", &expected).as_str(), self.peek_token_ref())
4761        }
4762    }
4763
4764    /// If the current and subsequent tokens exactly match the `keywords`
4765    /// sequence, consume them and returns Ok. Otherwise, return an Error.
4766    pub fn expect_keywords(&mut self, expected: &[Keyword]) -> Result<(), ParserError> {
4767        for &kw in expected {
4768            self.expect_keyword_is(kw)?;
4769        }
4770        Ok(())
4771    }
4772
4773    /// Consume the next token if it matches the expected token, otherwise return false
4774    ///
4775    /// See [Self::advance_token] to consume the token unconditionally
4776    #[must_use]
4777    pub fn consume_token(&mut self, expected: &Token) -> bool {
4778        if self.peek_token_ref() == expected {
4779            self.advance_token();
4780            true
4781        } else {
4782            false
4783        }
4784    }
4785
4786    /// If the current and subsequent tokens exactly match the `tokens`
4787    /// sequence, consume them and returns true. Otherwise, no tokens are
4788    /// consumed and returns false
4789    #[must_use]
4790    pub fn consume_tokens(&mut self, tokens: &[Token]) -> bool {
4791        let index = self.index;
4792        for token in tokens {
4793            if !self.consume_token(token) {
4794                self.index = index;
4795                return false;
4796            }
4797        }
4798        true
4799    }
4800
4801    /// Bail out if the current token is not an expected keyword, or consume it if it is
4802    pub fn expect_token(&mut self, expected: &Token) -> Result<TokenWithSpan, ParserError> {
4803        if self.peek_token_ref() == expected {
4804            Ok(self.next_token())
4805        } else {
4806            self.expected_ref(&expected.to_string(), self.peek_token_ref())
4807        }
4808    }
4809
4810    fn parse<T: FromStr>(s: String, loc: Location) -> Result<T, ParserError>
4811    where
4812        <T as FromStr>::Err: Display,
4813    {
4814        s.parse::<T>().map_err(|e| {
4815            ParserError::ParserError(format!(
4816                "Could not parse '{s}' as {}: {e}{loc}",
4817                core::any::type_name::<T>()
4818            ))
4819        })
4820    }
4821
4822    /// Parse a comma-separated list of 1+ SelectItem
4823    pub fn parse_projection(&mut self) -> Result<Vec<SelectItem>, ParserError> {
4824        // BigQuery and Snowflake allow trailing commas, but only in project lists
4825        // e.g. `SELECT 1, 2, FROM t`
4826        // https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#trailing_commas
4827        // https://docs.snowflake.com/en/release-notes/2024/8_11#select-supports-trailing-commas
4828
4829        let trailing_commas =
4830            self.options.trailing_commas | self.dialect.supports_projection_trailing_commas();
4831
4832        self.parse_comma_separated_with_trailing_commas(
4833            |p| p.parse_select_item(),
4834            trailing_commas,
4835            Self::is_reserved_for_column_alias,
4836        )
4837    }
4838
4839    /// Parse a list of actions for `GRANT` statements.
4840    pub fn parse_actions_list(&mut self) -> Result<Vec<Action>, ParserError> {
4841        let mut values = vec![];
4842        loop {
4843            values.push(self.parse_grant_permission()?);
4844            if !self.consume_token(&Token::Comma) {
4845                break;
4846            } else if self.options.trailing_commas {
4847                match &self.peek_token_ref().token {
4848                    Token::Word(kw) if kw.keyword == Keyword::ON => {
4849                        break;
4850                    }
4851                    Token::RParen
4852                    | Token::SemiColon
4853                    | Token::EOF
4854                    | Token::RBracket
4855                    | Token::RBrace => break,
4856                    _ => continue,
4857                }
4858            }
4859        }
4860        Ok(values)
4861    }
4862
4863    /// Parse a list of [TableWithJoins]
4864    fn parse_table_with_joins(&mut self) -> Result<Vec<TableWithJoins>, ParserError> {
4865        let trailing_commas = self.dialect.supports_from_trailing_commas();
4866
4867        self.parse_comma_separated_with_trailing_commas(
4868            Parser::parse_table_and_joins,
4869            trailing_commas,
4870            |kw, parser| !self.dialect.is_table_factor(kw, parser),
4871        )
4872    }
4873
4874    /// Parse the comma of a comma-separated syntax element.
4875    /// `R` is a predicate that should return true if the next
4876    /// keyword is a reserved keyword.
4877    /// Allows for control over trailing commas
4878    ///
4879    /// Returns true if there is a next element
4880    fn is_parse_comma_separated_end_with_trailing_commas<R>(
4881        &mut self,
4882        trailing_commas: bool,
4883        is_reserved_keyword: &R,
4884    ) -> bool
4885    where
4886        R: Fn(&Keyword, &mut Parser) -> bool,
4887    {
4888        if !self.consume_token(&Token::Comma) {
4889            true
4890        } else if trailing_commas {
4891            let token = self.next_token().token;
4892            let is_end = match token {
4893                Token::Word(ref kw) if is_reserved_keyword(&kw.keyword, self) => true,
4894                Token::RParen | Token::SemiColon | Token::EOF | Token::RBracket | Token::RBrace => {
4895                    true
4896                }
4897                _ => false,
4898            };
4899            self.prev_token();
4900
4901            is_end
4902        } else {
4903            false
4904        }
4905    }
4906
4907    /// Parse the comma of a comma-separated syntax element.
4908    /// Returns true if there is a next element
4909    fn is_parse_comma_separated_end(&mut self) -> bool {
4910        self.is_parse_comma_separated_end_with_trailing_commas(
4911            self.options.trailing_commas,
4912            &Self::is_reserved_for_column_alias,
4913        )
4914    }
4915
4916    /// Parse a comma-separated list of 1+ items accepted by `F`
4917    pub fn parse_comma_separated<T, F>(&mut self, f: F) -> Result<Vec<T>, ParserError>
4918    where
4919        F: FnMut(&mut Parser<'a>) -> Result<T, ParserError>,
4920    {
4921        self.parse_comma_separated_with_trailing_commas(
4922            f,
4923            self.options.trailing_commas,
4924            Self::is_reserved_for_column_alias,
4925        )
4926    }
4927
4928    /// Parse a comma-separated list of 1+ items accepted by `F`.
4929    /// `R` is a predicate that should return true if the next
4930    /// keyword is a reserved keyword.
4931    /// Allows for control over trailing commas.
4932    fn parse_comma_separated_with_trailing_commas<T, F, R>(
4933        &mut self,
4934        mut f: F,
4935        trailing_commas: bool,
4936        is_reserved_keyword: R,
4937    ) -> Result<Vec<T>, ParserError>
4938    where
4939        F: FnMut(&mut Parser<'a>) -> Result<T, ParserError>,
4940        R: Fn(&Keyword, &mut Parser) -> bool,
4941    {
4942        let mut values = vec![];
4943        loop {
4944            values.push(f(self)?);
4945            if self.is_parse_comma_separated_end_with_trailing_commas(
4946                trailing_commas,
4947                &is_reserved_keyword,
4948            ) {
4949                break;
4950            }
4951        }
4952        Ok(values)
4953    }
4954
4955    /// Parse a period-separated list of 1+ items accepted by `F`
4956    fn parse_period_separated<T, F>(&mut self, mut f: F) -> Result<Vec<T>, ParserError>
4957    where
4958        F: FnMut(&mut Parser<'a>) -> Result<T, ParserError>,
4959    {
4960        let mut values = vec![];
4961        loop {
4962            values.push(f(self)?);
4963            if !self.consume_token(&Token::Period) {
4964                break;
4965            }
4966        }
4967        Ok(values)
4968    }
4969
4970    /// Parse a keyword-separated list of 1+ items accepted by `F`
4971    pub fn parse_keyword_separated<T, F>(
4972        &mut self,
4973        keyword: Keyword,
4974        mut f: F,
4975    ) -> Result<Vec<T>, ParserError>
4976    where
4977        F: FnMut(&mut Parser<'a>) -> Result<T, ParserError>,
4978    {
4979        let mut values = vec![];
4980        loop {
4981            values.push(f(self)?);
4982            if !self.parse_keyword(keyword) {
4983                break;
4984            }
4985        }
4986        Ok(values)
4987    }
4988
4989    /// Parse an expression enclosed in parentheses.
4990    pub fn parse_parenthesized<T, F>(&mut self, mut f: F) -> Result<T, ParserError>
4991    where
4992        F: FnMut(&mut Parser<'a>) -> Result<T, ParserError>,
4993    {
4994        self.expect_token(&Token::LParen)?;
4995        let res = f(self)?;
4996        self.expect_token(&Token::RParen)?;
4997        Ok(res)
4998    }
4999
5000    /// Parse a comma-separated list of 0+ items accepted by `F`
5001    /// * `end_token` - expected end token for the closure (e.g. [Token::RParen], [Token::RBrace] ...)
5002    pub fn parse_comma_separated0<T, F>(
5003        &mut self,
5004        f: F,
5005        end_token: Token,
5006    ) -> Result<Vec<T>, ParserError>
5007    where
5008        F: FnMut(&mut Parser<'a>) -> Result<T, ParserError>,
5009    {
5010        if self.peek_token_ref().token == end_token {
5011            return Ok(vec![]);
5012        }
5013
5014        if self.options.trailing_commas && self.peek_tokens() == [Token::Comma, end_token] {
5015            let _ = self.consume_token(&Token::Comma);
5016            return Ok(vec![]);
5017        }
5018
5019        self.parse_comma_separated(f)
5020    }
5021
5022    /// Parses 0 or more statements, each followed by a semicolon.
5023    /// If the next token is any of `terminal_keywords` then no more
5024    /// statements will be parsed.
5025    pub(crate) fn parse_statement_list(
5026        &mut self,
5027        terminal_keywords: &[Keyword],
5028    ) -> Result<Vec<Statement>, ParserError> {
5029        let mut values = vec![];
5030        loop {
5031            match &self.peek_nth_token_ref(0).token {
5032                Token::EOF => break,
5033                Token::Word(w)
5034                    if w.quote_style.is_none() && terminal_keywords.contains(&w.keyword) =>
5035                {
5036                    break;
5037                }
5038                _ => {}
5039            }
5040
5041            values.push(self.parse_statement()?);
5042            self.expect_token(&Token::SemiColon)?;
5043        }
5044        Ok(values)
5045    }
5046
5047    /// Default implementation of a predicate that returns true if
5048    /// the specified keyword is reserved for column alias.
5049    /// See [Dialect::is_column_alias]
5050    fn is_reserved_for_column_alias(kw: &Keyword, parser: &mut Parser) -> bool {
5051        !parser.dialect.is_column_alias(kw, parser)
5052    }
5053
5054    /// Run a parser method `f`, reverting back to the current position if unsuccessful.
5055    /// Returns `ParserError::RecursionLimitExceeded` if `f` returns a `RecursionLimitExceeded`.
5056    /// Returns `Ok(None)` if `f` returns any other error.
5057    pub fn maybe_parse<T, F>(&mut self, f: F) -> Result<Option<T>, ParserError>
5058    where
5059        F: FnMut(&mut Parser) -> Result<T, ParserError>,
5060    {
5061        match self.try_parse(f) {
5062            Ok(t) => Ok(Some(t)),
5063            Err(ParserError::RecursionLimitExceeded) => Err(ParserError::RecursionLimitExceeded),
5064            _ => Ok(None),
5065        }
5066    }
5067
5068    /// Run a parser method `f`, reverting back to the current position if unsuccessful.
5069    pub fn try_parse<T, F>(&mut self, mut f: F) -> Result<T, ParserError>
5070    where
5071        F: FnMut(&mut Parser) -> Result<T, ParserError>,
5072    {
5073        let index = self.index;
5074        match f(self) {
5075            Ok(t) => Ok(t),
5076            Err(e) => {
5077                // Unwind stack if limit exceeded
5078                self.index = index;
5079                Err(e)
5080            }
5081        }
5082    }
5083
5084    /// Parse either `ALL`, `DISTINCT` or `DISTINCT ON (...)`. Returns [`None`] if `ALL` is parsed
5085    /// and results in a [`ParserError`] if both `ALL` and `DISTINCT` are found.
5086    pub fn parse_all_or_distinct(&mut self) -> Result<Option<Distinct>, ParserError> {
5087        let loc = self.peek_token_ref().span.start;
5088        let distinct = match self.parse_one_of_keywords(&[Keyword::ALL, Keyword::DISTINCT]) {
5089            Some(Keyword::ALL) => {
5090                if self.peek_keyword(Keyword::DISTINCT) {
5091                    return parser_err!("Cannot specify ALL then DISTINCT".to_string(), loc);
5092                }
5093                Some(Distinct::All)
5094            }
5095            Some(Keyword::DISTINCT) => {
5096                if self.peek_keyword(Keyword::ALL) {
5097                    return parser_err!("Cannot specify DISTINCT then ALL".to_string(), loc);
5098                }
5099                Some(Distinct::Distinct)
5100            }
5101            None => return Ok(None),
5102            _ => return parser_err!("ALL or DISTINCT", loc),
5103        };
5104
5105        let Some(Distinct::Distinct) = distinct else {
5106            return Ok(distinct);
5107        };
5108        if !self.parse_keyword(Keyword::ON) {
5109            return Ok(Some(Distinct::Distinct));
5110        }
5111
5112        self.expect_token(&Token::LParen)?;
5113        let col_names = if self.consume_token(&Token::RParen) {
5114            self.prev_token();
5115            Vec::new()
5116        } else {
5117            self.parse_comma_separated(Parser::parse_expr)?
5118        };
5119        self.expect_token(&Token::RParen)?;
5120        Ok(Some(Distinct::On(col_names)))
5121    }
5122
5123    /// Parse a SQL CREATE statement
5124    pub fn parse_create(&mut self) -> Result<Statement, ParserError> {
5125        let or_replace = self.parse_keywords(&[Keyword::OR, Keyword::REPLACE]);
5126        let or_alter = self.parse_keywords(&[Keyword::OR, Keyword::ALTER]);
5127        let multiset = self.maybe_parse_multiset();
5128        let local = self.parse_one_of_keywords(&[Keyword::LOCAL]).is_some();
5129        let global = self.parse_one_of_keywords(&[Keyword::GLOBAL]).is_some();
5130        let transient = self.parse_one_of_keywords(&[Keyword::TRANSIENT]).is_some();
5131        let global: Option<bool> = if global {
5132            Some(true)
5133        } else if local {
5134            Some(false)
5135        } else {
5136            None
5137        };
5138        let temporary = self
5139            .parse_one_of_keywords(&[Keyword::TEMP, Keyword::TEMPORARY])
5140            .is_some();
5141        let volatile = self.parse_keyword(Keyword::VOLATILE);
5142        let persistent = dialect_of!(self is DuckDbDialect)
5143            && self.parse_one_of_keywords(&[Keyword::PERSISTENT]).is_some();
5144        let create_view_params = self.parse_create_view_params()?;
5145        if self.peek_keywords(&[Keyword::SNAPSHOT, Keyword::TABLE]) {
5146            self.parse_create_snapshot_table().map(Into::into)
5147        } else if self.parse_keyword(Keyword::TABLE) {
5148            self.parse_create_table(or_replace, temporary, global, transient, volatile, multiset)
5149                .map(Into::into)
5150        } else if self.peek_keyword(Keyword::MATERIALIZED)
5151            || self.peek_keyword(Keyword::VIEW)
5152            || self.peek_keywords(&[Keyword::SECURE, Keyword::MATERIALIZED, Keyword::VIEW])
5153            || self.peek_keywords(&[Keyword::SECURE, Keyword::VIEW])
5154        {
5155            self.parse_create_view(or_alter, or_replace, temporary, create_view_params)
5156                .map(Into::into)
5157        } else if self.parse_keyword(Keyword::POLICY) {
5158            self.parse_create_policy().map(Into::into)
5159        } else if self.parse_keyword(Keyword::EXTERNAL) {
5160            self.parse_create_external_table(or_replace).map(Into::into)
5161        } else if self.parse_keyword(Keyword::FUNCTION) {
5162            self.parse_create_function(or_alter, or_replace, temporary)
5163        } else if self.parse_keyword(Keyword::DOMAIN) {
5164            self.parse_create_domain().map(Into::into)
5165        } else if self.parse_keyword(Keyword::TRIGGER) {
5166            self.parse_create_trigger(temporary, or_alter, or_replace, false)
5167                .map(Into::into)
5168        } else if self.parse_keywords(&[Keyword::CONSTRAINT, Keyword::TRIGGER]) {
5169            self.parse_create_trigger(temporary, or_alter, or_replace, true)
5170                .map(Into::into)
5171        } else if self.parse_keyword(Keyword::MACRO) {
5172            self.parse_create_macro(or_replace, temporary)
5173        } else if self.parse_keyword(Keyword::SECRET) {
5174            self.parse_create_secret(or_replace, temporary, persistent)
5175        } else if self.parse_keyword(Keyword::USER) {
5176            self.parse_create_user(or_replace).map(Into::into)
5177        } else if or_replace {
5178            self.expected_ref(
5179                "[EXTERNAL] TABLE or [MATERIALIZED] VIEW or FUNCTION after CREATE OR REPLACE",
5180                self.peek_token_ref(),
5181            )
5182        } else if self.parse_keyword(Keyword::EXTENSION) {
5183            self.parse_create_extension().map(Into::into)
5184        } else if self.parse_keyword(Keyword::INDEX) {
5185            self.parse_create_index(false).map(Into::into)
5186        } else if self.parse_keywords(&[Keyword::UNIQUE, Keyword::INDEX]) {
5187            self.parse_create_index(true).map(Into::into)
5188        } else if self.parse_keyword(Keyword::VIRTUAL) {
5189            self.parse_create_virtual_table()
5190        } else if self.parse_keyword(Keyword::SCHEMA) {
5191            self.parse_create_schema()
5192        } else if self.parse_keyword(Keyword::DATABASE) {
5193            self.parse_create_database()
5194        } else if self.parse_keyword(Keyword::ROLE) {
5195            self.parse_create_role().map(Into::into)
5196        } else if self.parse_keyword(Keyword::SEQUENCE) {
5197            self.parse_create_sequence(temporary)
5198        } else if self.parse_keyword(Keyword::COLLATION) {
5199            self.parse_create_collation().map(Into::into)
5200        } else if self.parse_keyword(Keyword::TYPE) {
5201            self.parse_create_type()
5202        } else if self.parse_keyword(Keyword::PROCEDURE) {
5203            self.parse_create_procedure(or_alter)
5204        } else if self.parse_keyword(Keyword::CONNECTOR) {
5205            self.parse_create_connector().map(Into::into)
5206        } else if self.parse_keyword(Keyword::OPERATOR) {
5207            // Check if this is CREATE OPERATOR FAMILY or CREATE OPERATOR CLASS
5208            if self.parse_keyword(Keyword::FAMILY) {
5209                self.parse_create_operator_family().map(Into::into)
5210            } else if self.parse_keyword(Keyword::CLASS) {
5211                self.parse_create_operator_class().map(Into::into)
5212            } else {
5213                self.parse_create_operator().map(Into::into)
5214            }
5215        } else if self.parse_keyword(Keyword::SERVER) {
5216            self.parse_pg_create_server()
5217        } else {
5218            self.expected_ref("an object type after CREATE", self.peek_token_ref())
5219        }
5220    }
5221
5222    fn parse_create_user(&mut self, or_replace: bool) -> Result<CreateUser, ParserError> {
5223        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
5224        let name = self.parse_identifier()?;
5225        let options = self
5226            .parse_key_value_options(false, &[Keyword::WITH, Keyword::TAG])?
5227            .options;
5228        let with_tags = self.parse_keyword(Keyword::WITH);
5229        let tags = if self.parse_keyword(Keyword::TAG) {
5230            self.parse_key_value_options(true, &[])?.options
5231        } else {
5232            vec![]
5233        };
5234        Ok(CreateUser {
5235            or_replace,
5236            if_not_exists,
5237            name,
5238            options: KeyValueOptions {
5239                options,
5240                delimiter: KeyValueOptionsDelimiter::Space,
5241            },
5242            with_tags,
5243            tags: KeyValueOptions {
5244                options: tags,
5245                delimiter: KeyValueOptionsDelimiter::Comma,
5246            },
5247        })
5248    }
5249
5250    /// See [DuckDB Docs](https://duckdb.org/docs/sql/statements/create_secret.html) for more details.
5251    pub fn parse_create_secret(
5252        &mut self,
5253        or_replace: bool,
5254        temporary: bool,
5255        persistent: bool,
5256    ) -> Result<Statement, ParserError> {
5257        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
5258
5259        let mut storage_specifier = None;
5260        let mut name = None;
5261        if self.peek_token_ref().token != Token::LParen {
5262            if self.parse_keyword(Keyword::IN) {
5263                storage_specifier = self.parse_identifier().ok()
5264            } else {
5265                name = self.parse_identifier().ok();
5266            }
5267
5268            // Storage specifier may follow the name
5269            if storage_specifier.is_none()
5270                && self.peek_token_ref().token != Token::LParen
5271                && self.parse_keyword(Keyword::IN)
5272            {
5273                storage_specifier = self.parse_identifier().ok();
5274            }
5275        }
5276
5277        self.expect_token(&Token::LParen)?;
5278        self.expect_keyword_is(Keyword::TYPE)?;
5279        let secret_type = self.parse_identifier()?;
5280
5281        let mut options = Vec::new();
5282        if self.consume_token(&Token::Comma) {
5283            options.append(&mut self.parse_comma_separated(|p| {
5284                let key = p.parse_identifier()?;
5285                let value = p.parse_identifier()?;
5286                Ok(SecretOption { key, value })
5287            })?);
5288        }
5289        self.expect_token(&Token::RParen)?;
5290
5291        let temp = match (temporary, persistent) {
5292            (true, false) => Some(true),
5293            (false, true) => Some(false),
5294            (false, false) => None,
5295            _ => self.expected_ref("TEMPORARY or PERSISTENT", self.peek_token_ref())?,
5296        };
5297
5298        Ok(Statement::CreateSecret {
5299            or_replace,
5300            temporary: temp,
5301            if_not_exists,
5302            name,
5303            storage_specifier,
5304            secret_type,
5305            options,
5306        })
5307    }
5308
5309    /// Parse a CACHE TABLE statement
5310    pub fn parse_cache_table(&mut self) -> Result<Statement, ParserError> {
5311        let (mut table_flag, mut options, mut has_as, mut query) = (None, vec![], false, None);
5312        if self.parse_keyword(Keyword::TABLE) {
5313            let table_name = self.parse_object_name(false)?;
5314            if self.peek_token_ref().token != Token::EOF {
5315                if let Token::Word(word) = &self.peek_token_ref().token {
5316                    if word.keyword == Keyword::OPTIONS {
5317                        options = self.parse_options(Keyword::OPTIONS)?
5318                    }
5319                };
5320
5321                if self.peek_token_ref().token != Token::EOF {
5322                    let (a, q) = self.parse_as_query()?;
5323                    has_as = a;
5324                    query = Some(q);
5325                }
5326
5327                Ok(Statement::Cache {
5328                    table_flag,
5329                    table_name,
5330                    has_as,
5331                    options,
5332                    query,
5333                })
5334            } else {
5335                Ok(Statement::Cache {
5336                    table_flag,
5337                    table_name,
5338                    has_as,
5339                    options,
5340                    query,
5341                })
5342            }
5343        } else {
5344            table_flag = Some(self.parse_object_name(false)?);
5345            if self.parse_keyword(Keyword::TABLE) {
5346                let table_name = self.parse_object_name(false)?;
5347                if self.peek_token_ref().token != Token::EOF {
5348                    if let Token::Word(word) = &self.peek_token_ref().token {
5349                        if word.keyword == Keyword::OPTIONS {
5350                            options = self.parse_options(Keyword::OPTIONS)?
5351                        }
5352                    };
5353
5354                    if self.peek_token_ref().token != Token::EOF {
5355                        let (a, q) = self.parse_as_query()?;
5356                        has_as = a;
5357                        query = Some(q);
5358                    }
5359
5360                    Ok(Statement::Cache {
5361                        table_flag,
5362                        table_name,
5363                        has_as,
5364                        options,
5365                        query,
5366                    })
5367                } else {
5368                    Ok(Statement::Cache {
5369                        table_flag,
5370                        table_name,
5371                        has_as,
5372                        options,
5373                        query,
5374                    })
5375                }
5376            } else {
5377                if self.peek_token_ref().token == Token::EOF {
5378                    self.prev_token();
5379                }
5380                self.expected_ref("a `TABLE` keyword", self.peek_token_ref())
5381            }
5382        }
5383    }
5384
5385    /// Parse 'AS' before as query,such as `WITH XXX AS SELECT XXX` oer `CACHE TABLE AS SELECT XXX`
5386    pub fn parse_as_query(&mut self) -> Result<(bool, Box<Query>), ParserError> {
5387        match &self.peek_token_ref().token {
5388            Token::Word(word) => match word.keyword {
5389                Keyword::AS => {
5390                    self.next_token();
5391                    Ok((true, self.parse_query()?))
5392                }
5393                _ => Ok((false, self.parse_query()?)),
5394            },
5395            _ => self.expected_ref("a QUERY statement", self.peek_token_ref()),
5396        }
5397    }
5398
5399    /// Parse a UNCACHE TABLE statement
5400    pub fn parse_uncache_table(&mut self) -> Result<Statement, ParserError> {
5401        self.expect_keyword_is(Keyword::TABLE)?;
5402        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
5403        let table_name = self.parse_object_name(false)?;
5404        Ok(Statement::UNCache {
5405            table_name,
5406            if_exists,
5407        })
5408    }
5409
5410    /// SQLite-specific `CREATE VIRTUAL TABLE`
5411    pub fn parse_create_virtual_table(&mut self) -> Result<Statement, ParserError> {
5412        self.expect_keyword_is(Keyword::TABLE)?;
5413        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
5414        let table_name = self.parse_object_name(false)?;
5415        self.expect_keyword_is(Keyword::USING)?;
5416        let module_name = self.parse_identifier()?;
5417        // SQLite docs note that module "arguments syntax is sufficiently
5418        // general that the arguments can be made to appear as column
5419        // definitions in a traditional CREATE TABLE statement", but
5420        // we don't implement that.
5421        let module_args = self.parse_parenthesized_column_list(Optional, false)?;
5422        Ok(Statement::CreateVirtualTable {
5423            name: table_name,
5424            if_not_exists,
5425            module_name,
5426            module_args,
5427        })
5428    }
5429
5430    /// Parse a `CREATE SCHEMA` statement.
5431    pub fn parse_create_schema(&mut self) -> Result<Statement, ParserError> {
5432        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
5433
5434        let schema_name = self.parse_schema_name()?;
5435
5436        let default_collate_spec = if self.parse_keywords(&[Keyword::DEFAULT, Keyword::COLLATE]) {
5437            Some(self.parse_expr()?)
5438        } else {
5439            None
5440        };
5441
5442        let with = if self.peek_keyword(Keyword::WITH) {
5443            Some(self.parse_options(Keyword::WITH)?)
5444        } else {
5445            None
5446        };
5447
5448        let options = if self.peek_keyword(Keyword::OPTIONS) {
5449            Some(self.parse_options(Keyword::OPTIONS)?)
5450        } else {
5451            None
5452        };
5453
5454        let clone = if self.parse_keyword(Keyword::CLONE) {
5455            Some(self.parse_object_name(false)?)
5456        } else {
5457            None
5458        };
5459
5460        Ok(Statement::CreateSchema {
5461            schema_name,
5462            if_not_exists,
5463            with,
5464            options,
5465            default_collate_spec,
5466            clone,
5467        })
5468    }
5469
5470    fn parse_schema_name(&mut self) -> Result<SchemaName, ParserError> {
5471        if self.parse_keyword(Keyword::AUTHORIZATION) {
5472            Ok(SchemaName::UnnamedAuthorization(self.parse_identifier()?))
5473        } else {
5474            let name = self.parse_object_name(false)?;
5475
5476            if self.parse_keyword(Keyword::AUTHORIZATION) {
5477                Ok(SchemaName::NamedAuthorization(
5478                    name,
5479                    self.parse_identifier()?,
5480                ))
5481            } else {
5482                Ok(SchemaName::Simple(name))
5483            }
5484        }
5485    }
5486
5487    /// Parse a `CREATE DATABASE` statement.
5488    pub fn parse_create_database(&mut self) -> Result<Statement, ParserError> {
5489        let ine = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
5490        let db_name = self.parse_object_name(false)?;
5491        let mut location = None;
5492        let mut managed_location = None;
5493        loop {
5494            match self.parse_one_of_keywords(&[Keyword::LOCATION, Keyword::MANAGEDLOCATION]) {
5495                Some(Keyword::LOCATION) => location = Some(self.parse_literal_string()?),
5496                Some(Keyword::MANAGEDLOCATION) => {
5497                    managed_location = Some(self.parse_literal_string()?)
5498                }
5499                _ => break,
5500            }
5501        }
5502        let clone = if self.parse_keyword(Keyword::CLONE) {
5503            Some(self.parse_object_name(false)?)
5504        } else {
5505            None
5506        };
5507
5508        // Parse MySQL-style [DEFAULT] CHARACTER SET and [DEFAULT] COLLATE options
5509        //
5510        // Note: The docs only mention `CHARACTER SET`, but `CHARSET` is also supported.
5511        // Furthermore, MySQL will only accept one character set, raising an error if there is more
5512        // than one, but will accept multiple collations and use the last one.
5513        //
5514        // <https://dev.mysql.com/doc/refman/8.4/en/create-database.html>
5515        let mut default_charset = None;
5516        let mut default_collation = None;
5517        loop {
5518            let has_default = self.parse_keyword(Keyword::DEFAULT);
5519            if default_charset.is_none() && self.parse_keywords(&[Keyword::CHARACTER, Keyword::SET])
5520                || self.parse_keyword(Keyword::CHARSET)
5521            {
5522                let _ = self.consume_token(&Token::Eq);
5523                default_charset = Some(self.parse_identifier()?.value);
5524            } else if self.parse_keyword(Keyword::COLLATE) {
5525                let _ = self.consume_token(&Token::Eq);
5526                default_collation = Some(self.parse_identifier()?.value);
5527            } else if has_default {
5528                // DEFAULT keyword not followed by CHARACTER SET, CHARSET, or COLLATE
5529                self.prev_token();
5530                break;
5531            } else {
5532                break;
5533            }
5534        }
5535
5536        Ok(Statement::CreateDatabase {
5537            db_name,
5538            if_not_exists: ine,
5539            location,
5540            managed_location,
5541            or_replace: false,
5542            transient: false,
5543            clone,
5544            data_retention_time_in_days: None,
5545            max_data_extension_time_in_days: None,
5546            external_volume: None,
5547            catalog: None,
5548            replace_invalid_characters: None,
5549            default_ddl_collation: None,
5550            storage_serialization_policy: None,
5551            comment: None,
5552            default_charset,
5553            default_collation,
5554            catalog_sync: None,
5555            catalog_sync_namespace_mode: None,
5556            catalog_sync_namespace_flatten_delimiter: None,
5557            with_tags: None,
5558            with_contacts: None,
5559        })
5560    }
5561
5562    /// Parse an optional `USING` clause for `CREATE FUNCTION`.
5563    pub fn parse_optional_create_function_using(
5564        &mut self,
5565    ) -> Result<Option<CreateFunctionUsing>, ParserError> {
5566        if !self.parse_keyword(Keyword::USING) {
5567            return Ok(None);
5568        };
5569        let keyword =
5570            self.expect_one_of_keywords(&[Keyword::JAR, Keyword::FILE, Keyword::ARCHIVE])?;
5571
5572        let uri = self.parse_literal_string()?;
5573
5574        match keyword {
5575            Keyword::JAR => Ok(Some(CreateFunctionUsing::Jar(uri))),
5576            Keyword::FILE => Ok(Some(CreateFunctionUsing::File(uri))),
5577            Keyword::ARCHIVE => Ok(Some(CreateFunctionUsing::Archive(uri))),
5578            _ => self.expected(
5579                "JAR, FILE or ARCHIVE, got {:?}",
5580                TokenWithSpan::wrap(Token::make_keyword(format!("{keyword:?}").as_str())),
5581            ),
5582        }
5583    }
5584
5585    /// Parse a `CREATE FUNCTION` statement.
5586    pub fn parse_create_function(
5587        &mut self,
5588        or_alter: bool,
5589        or_replace: bool,
5590        temporary: bool,
5591    ) -> Result<Statement, ParserError> {
5592        if dialect_of!(self is HiveDialect) {
5593            self.parse_hive_create_function(or_replace, temporary)
5594                .map(Into::into)
5595        } else if dialect_of!(self is PostgreSqlDialect | GenericDialect) {
5596            self.parse_postgres_create_function(or_replace, temporary)
5597                .map(Into::into)
5598        } else if dialect_of!(self is DuckDbDialect) {
5599            self.parse_create_macro(or_replace, temporary)
5600        } else if dialect_of!(self is BigQueryDialect) {
5601            self.parse_bigquery_create_function(or_replace, temporary)
5602                .map(Into::into)
5603        } else if dialect_of!(self is MsSqlDialect) {
5604            self.parse_mssql_create_function(or_alter, or_replace, temporary)
5605                .map(Into::into)
5606        } else {
5607            self.prev_token();
5608            self.expected_ref("an object type after CREATE", self.peek_token_ref())
5609        }
5610    }
5611
5612    /// Parse `CREATE FUNCTION` for [PostgreSQL]
5613    ///
5614    /// [PostgreSQL]: https://www.postgresql.org/docs/15/sql-createfunction.html
5615    fn parse_postgres_create_function(
5616        &mut self,
5617        or_replace: bool,
5618        temporary: bool,
5619    ) -> Result<CreateFunction, ParserError> {
5620        let name = self.parse_object_name(false)?;
5621
5622        self.expect_token(&Token::LParen)?;
5623        let args = if Token::RParen != self.peek_token_ref().token {
5624            self.parse_comma_separated(Parser::parse_function_arg)?
5625        } else {
5626            vec![]
5627        };
5628        self.expect_token(&Token::RParen)?;
5629
5630        let return_type = if self.parse_keyword(Keyword::RETURNS) {
5631            Some(self.parse_function_return_type()?)
5632        } else {
5633            None
5634        };
5635
5636        #[derive(Default)]
5637        struct Body {
5638            language: Option<Ident>,
5639            behavior: Option<FunctionBehavior>,
5640            function_body: Option<CreateFunctionBody>,
5641            called_on_null: Option<FunctionCalledOnNull>,
5642            parallel: Option<FunctionParallel>,
5643            security: Option<FunctionSecurity>,
5644        }
5645        let mut body = Body::default();
5646        let mut set_params: Vec<FunctionDefinitionSetParam> = Vec::new();
5647        loop {
5648            fn ensure_not_set<T>(field: &Option<T>, name: &str) -> Result<(), ParserError> {
5649                if field.is_some() {
5650                    return Err(ParserError::ParserError(format!(
5651                        "{name} specified more than once",
5652                    )));
5653                }
5654                Ok(())
5655            }
5656            if self.parse_keyword(Keyword::AS) {
5657                ensure_not_set(&body.function_body, "AS")?;
5658                body.function_body = Some(self.parse_create_function_body_string()?);
5659            } else if self.parse_keyword(Keyword::LANGUAGE) {
5660                ensure_not_set(&body.language, "LANGUAGE")?;
5661                body.language = Some(self.parse_identifier()?);
5662            } else if self.parse_keyword(Keyword::IMMUTABLE) {
5663                ensure_not_set(&body.behavior, "IMMUTABLE | STABLE | VOLATILE")?;
5664                body.behavior = Some(FunctionBehavior::Immutable);
5665            } else if self.parse_keyword(Keyword::STABLE) {
5666                ensure_not_set(&body.behavior, "IMMUTABLE | STABLE | VOLATILE")?;
5667                body.behavior = Some(FunctionBehavior::Stable);
5668            } else if self.parse_keyword(Keyword::VOLATILE) {
5669                ensure_not_set(&body.behavior, "IMMUTABLE | STABLE | VOLATILE")?;
5670                body.behavior = Some(FunctionBehavior::Volatile);
5671            } else if self.parse_keywords(&[
5672                Keyword::CALLED,
5673                Keyword::ON,
5674                Keyword::NULL,
5675                Keyword::INPUT,
5676            ]) {
5677                ensure_not_set(
5678                    &body.called_on_null,
5679                    "CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT",
5680                )?;
5681                body.called_on_null = Some(FunctionCalledOnNull::CalledOnNullInput);
5682            } else if self.parse_keywords(&[
5683                Keyword::RETURNS,
5684                Keyword::NULL,
5685                Keyword::ON,
5686                Keyword::NULL,
5687                Keyword::INPUT,
5688            ]) {
5689                ensure_not_set(
5690                    &body.called_on_null,
5691                    "CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT",
5692                )?;
5693                body.called_on_null = Some(FunctionCalledOnNull::ReturnsNullOnNullInput);
5694            } else if self.parse_keyword(Keyword::STRICT) {
5695                ensure_not_set(
5696                    &body.called_on_null,
5697                    "CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT",
5698                )?;
5699                body.called_on_null = Some(FunctionCalledOnNull::Strict);
5700            } else if self.parse_keyword(Keyword::PARALLEL) {
5701                ensure_not_set(&body.parallel, "PARALLEL { UNSAFE | RESTRICTED | SAFE }")?;
5702                if self.parse_keyword(Keyword::UNSAFE) {
5703                    body.parallel = Some(FunctionParallel::Unsafe);
5704                } else if self.parse_keyword(Keyword::RESTRICTED) {
5705                    body.parallel = Some(FunctionParallel::Restricted);
5706                } else if self.parse_keyword(Keyword::SAFE) {
5707                    body.parallel = Some(FunctionParallel::Safe);
5708                } else {
5709                    return self
5710                        .expected_ref("one of UNSAFE | RESTRICTED | SAFE", self.peek_token_ref());
5711                }
5712            } else if self.parse_keyword(Keyword::SECURITY) {
5713                ensure_not_set(&body.security, "SECURITY { DEFINER | INVOKER }")?;
5714                if self.parse_keyword(Keyword::DEFINER) {
5715                    body.security = Some(FunctionSecurity::Definer);
5716                } else if self.parse_keyword(Keyword::INVOKER) {
5717                    body.security = Some(FunctionSecurity::Invoker);
5718                } else {
5719                    return self.expected_ref("DEFINER or INVOKER", self.peek_token_ref());
5720                }
5721            } else if self.parse_keyword(Keyword::SET) {
5722                let name = self.parse_object_name(false)?;
5723                let value = if self.parse_keywords(&[Keyword::FROM, Keyword::CURRENT]) {
5724                    FunctionSetValue::FromCurrent
5725                } else {
5726                    if !self.consume_token(&Token::Eq) && !self.parse_keyword(Keyword::TO) {
5727                        return self.expected_ref("= or TO", self.peek_token_ref());
5728                    }
5729                    if self.parse_keyword(Keyword::DEFAULT) {
5730                        FunctionSetValue::Default
5731                    } else {
5732                        let values = self.parse_comma_separated(Parser::parse_expr)?;
5733                        FunctionSetValue::Values(values)
5734                    }
5735                };
5736                set_params.push(FunctionDefinitionSetParam { name, value });
5737            } else if self.parse_keyword(Keyword::RETURN) {
5738                ensure_not_set(&body.function_body, "RETURN")?;
5739                body.function_body = Some(CreateFunctionBody::Return(self.parse_expr()?));
5740            } else {
5741                break;
5742            }
5743        }
5744
5745        Ok(CreateFunction {
5746            or_alter: false,
5747            or_replace,
5748            temporary,
5749            name,
5750            args: Some(args),
5751            return_type,
5752            behavior: body.behavior,
5753            called_on_null: body.called_on_null,
5754            parallel: body.parallel,
5755            security: body.security,
5756            set_params,
5757            language: body.language,
5758            function_body: body.function_body,
5759            if_not_exists: false,
5760            using: None,
5761            determinism_specifier: None,
5762            options: None,
5763            remote_connection: None,
5764        })
5765    }
5766
5767    /// Parse `CREATE FUNCTION` for [Hive]
5768    ///
5769    /// [Hive]: https://cwiki.apache.org/confluence/display/hive/languagemanual+ddl#LanguageManualDDL-Create/Drop/ReloadFunction
5770    fn parse_hive_create_function(
5771        &mut self,
5772        or_replace: bool,
5773        temporary: bool,
5774    ) -> Result<CreateFunction, ParserError> {
5775        let name = self.parse_object_name(false)?;
5776        self.expect_keyword_is(Keyword::AS)?;
5777
5778        let body = self.parse_create_function_body_string()?;
5779        let using = self.parse_optional_create_function_using()?;
5780
5781        Ok(CreateFunction {
5782            or_alter: false,
5783            or_replace,
5784            temporary,
5785            name,
5786            function_body: Some(body),
5787            using,
5788            if_not_exists: false,
5789            args: None,
5790            return_type: None,
5791            behavior: None,
5792            called_on_null: None,
5793            parallel: None,
5794            security: None,
5795            set_params: vec![],
5796            language: None,
5797            determinism_specifier: None,
5798            options: None,
5799            remote_connection: None,
5800        })
5801    }
5802
5803    /// Parse `CREATE FUNCTION` for [BigQuery]
5804    ///
5805    /// [BigQuery]: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement
5806    fn parse_bigquery_create_function(
5807        &mut self,
5808        or_replace: bool,
5809        temporary: bool,
5810    ) -> Result<CreateFunction, ParserError> {
5811        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
5812        let (name, args) = self.parse_create_function_name_and_params()?;
5813
5814        let return_type = if self.parse_keyword(Keyword::RETURNS) {
5815            Some(self.parse_function_return_type()?)
5816        } else {
5817            None
5818        };
5819
5820        let determinism_specifier = if self.parse_keyword(Keyword::DETERMINISTIC) {
5821            Some(FunctionDeterminismSpecifier::Deterministic)
5822        } else if self.parse_keywords(&[Keyword::NOT, Keyword::DETERMINISTIC]) {
5823            Some(FunctionDeterminismSpecifier::NotDeterministic)
5824        } else {
5825            None
5826        };
5827
5828        let language = if self.parse_keyword(Keyword::LANGUAGE) {
5829            Some(self.parse_identifier()?)
5830        } else {
5831            None
5832        };
5833
5834        let remote_connection =
5835            if self.parse_keywords(&[Keyword::REMOTE, Keyword::WITH, Keyword::CONNECTION]) {
5836                Some(self.parse_object_name(false)?)
5837            } else {
5838                None
5839            };
5840
5841        // `OPTIONS` may come before of after the function body but
5842        // may be specified at most once.
5843        let mut options = self.maybe_parse_options(Keyword::OPTIONS)?;
5844
5845        let function_body = if remote_connection.is_none() {
5846            self.expect_keyword_is(Keyword::AS)?;
5847            let expr = self.parse_expr()?;
5848            if options.is_none() {
5849                options = self.maybe_parse_options(Keyword::OPTIONS)?;
5850                Some(CreateFunctionBody::AsBeforeOptions {
5851                    body: expr,
5852                    link_symbol: None,
5853                })
5854            } else {
5855                Some(CreateFunctionBody::AsAfterOptions(expr))
5856            }
5857        } else {
5858            None
5859        };
5860
5861        Ok(CreateFunction {
5862            or_alter: false,
5863            or_replace,
5864            temporary,
5865            if_not_exists,
5866            name,
5867            args: Some(args),
5868            return_type,
5869            function_body,
5870            language,
5871            determinism_specifier,
5872            options,
5873            remote_connection,
5874            using: None,
5875            behavior: None,
5876            called_on_null: None,
5877            parallel: None,
5878            security: None,
5879            set_params: vec![],
5880        })
5881    }
5882
5883    /// Parse `CREATE FUNCTION` for [MsSql]
5884    ///
5885    /// [MsSql]: https://learn.microsoft.com/en-us/sql/t-sql/statements/create-function-transact-sql
5886    fn parse_mssql_create_function(
5887        &mut self,
5888        or_alter: bool,
5889        or_replace: bool,
5890        temporary: bool,
5891    ) -> Result<CreateFunction, ParserError> {
5892        let (name, args) = self.parse_create_function_name_and_params()?;
5893
5894        self.expect_keyword(Keyword::RETURNS)?;
5895
5896        let return_table = self.maybe_parse(|p| {
5897            let return_table_name = p.parse_identifier()?;
5898
5899            p.expect_keyword_is(Keyword::TABLE)?;
5900            p.prev_token();
5901
5902            let table_column_defs = match p.parse_data_type()? {
5903                DataType::Table(Some(table_column_defs)) if !table_column_defs.is_empty() => {
5904                    table_column_defs
5905                }
5906                _ => parser_err!(
5907                    "Expected table column definitions after TABLE keyword",
5908                    p.peek_token_ref().span.start
5909                )?,
5910            };
5911
5912            Ok(DataType::NamedTable {
5913                name: ObjectName(vec![ObjectNamePart::Identifier(return_table_name)]),
5914                columns: table_column_defs,
5915            })
5916        })?;
5917
5918        let data_type = match return_table {
5919            Some(table_type) => table_type,
5920            None => self.parse_data_type()?,
5921        };
5922        let return_type = Some(FunctionReturnType::DataType(data_type));
5923
5924        let _ = self.parse_keyword(Keyword::AS);
5925
5926        let function_body = if self.peek_keyword(Keyword::BEGIN) {
5927            let begin_token = self.expect_keyword(Keyword::BEGIN)?;
5928            let statements = self.parse_statement_list(&[Keyword::END])?;
5929            let end_token = self.expect_keyword(Keyword::END)?;
5930
5931            Some(CreateFunctionBody::AsBeginEnd(BeginEndStatements {
5932                begin_token: AttachedToken(begin_token),
5933                statements,
5934                end_token: AttachedToken(end_token),
5935            }))
5936        } else if self.parse_keyword(Keyword::RETURN) {
5937            if self.peek_token_ref().token == Token::LParen {
5938                Some(CreateFunctionBody::AsReturnExpr(self.parse_expr()?))
5939            } else if self.peek_keyword(Keyword::SELECT) {
5940                let select = self.parse_select()?;
5941                Some(CreateFunctionBody::AsReturnSelect(select))
5942            } else {
5943                parser_err!(
5944                    "Expected a subquery (or bare SELECT statement) after RETURN",
5945                    self.peek_token_ref().span.start
5946                )?
5947            }
5948        } else {
5949            parser_err!("Unparsable function body", self.peek_token_ref().span.start)?
5950        };
5951
5952        Ok(CreateFunction {
5953            or_alter,
5954            or_replace,
5955            temporary,
5956            if_not_exists: false,
5957            name,
5958            args: Some(args),
5959            return_type,
5960            function_body,
5961            language: None,
5962            determinism_specifier: None,
5963            options: None,
5964            remote_connection: None,
5965            using: None,
5966            behavior: None,
5967            called_on_null: None,
5968            parallel: None,
5969            security: None,
5970            set_params: vec![],
5971        })
5972    }
5973
5974    fn parse_function_return_type(&mut self) -> Result<FunctionReturnType, ParserError> {
5975        if self.parse_keyword(Keyword::SETOF) {
5976            Ok(FunctionReturnType::SetOf(self.parse_data_type()?))
5977        } else {
5978            Ok(FunctionReturnType::DataType(self.parse_data_type()?))
5979        }
5980    }
5981
5982    fn parse_create_function_name_and_params(
5983        &mut self,
5984    ) -> Result<(ObjectName, Vec<OperateFunctionArg>), ParserError> {
5985        let name = self.parse_object_name(false)?;
5986        let parse_function_param =
5987            |parser: &mut Parser| -> Result<OperateFunctionArg, ParserError> {
5988                let name = parser.parse_identifier()?;
5989                let data_type = parser.parse_data_type()?;
5990                let default_expr = if parser.consume_token(&Token::Eq) {
5991                    Some(parser.parse_expr()?)
5992                } else {
5993                    None
5994                };
5995
5996                Ok(OperateFunctionArg {
5997                    mode: None,
5998                    name: Some(name),
5999                    data_type,
6000                    default_expr,
6001                })
6002            };
6003        self.expect_token(&Token::LParen)?;
6004        let args = self.parse_comma_separated0(parse_function_param, Token::RParen)?;
6005        self.expect_token(&Token::RParen)?;
6006        Ok((name, args))
6007    }
6008
6009    fn parse_function_arg(&mut self) -> Result<OperateFunctionArg, ParserError> {
6010        let mode = if self.parse_keyword(Keyword::IN) {
6011            Some(ArgMode::In)
6012        } else if self.parse_keyword(Keyword::OUT) {
6013            Some(ArgMode::Out)
6014        } else if self.parse_keyword(Keyword::INOUT) {
6015            Some(ArgMode::InOut)
6016        } else if self.parse_keyword(Keyword::VARIADIC) {
6017            Some(ArgMode::Variadic)
6018        } else {
6019            None
6020        };
6021
6022        // parse: [ argname ] argtype
6023        let mut name = None;
6024        let mut data_type = self.parse_data_type()?;
6025
6026        // To check whether the first token is a name or a type, we need to
6027        // peek the next token, which if it is another type keyword, then the
6028        // first token is a name and not a type in itself.
6029        let data_type_idx = self.get_current_index();
6030
6031        // DEFAULT will be parsed as `DataType::Custom`, which is undesirable in this context
6032        fn parse_data_type_no_default(parser: &mut Parser) -> Result<DataType, ParserError> {
6033            if parser.peek_keyword(Keyword::DEFAULT) {
6034                // This dummy error is ignored in `maybe_parse`
6035                parser_err!(
6036                    "The DEFAULT keyword is not a type",
6037                    parser.peek_token_ref().span.start
6038                )
6039            } else {
6040                parser.parse_data_type()
6041            }
6042        }
6043
6044        if let Some(next_data_type) = self.maybe_parse(parse_data_type_no_default)? {
6045            let token = self.token_at(data_type_idx);
6046
6047            // We ensure that the token is a `Word` token, and not other special tokens.
6048            if !matches!(token.token, Token::Word(_)) {
6049                return self.expected("a name or type", token.clone());
6050            }
6051
6052            name = Some(Ident::new(token.to_string()));
6053            data_type = next_data_type;
6054        }
6055
6056        let default_expr = if self.parse_keyword(Keyword::DEFAULT) || self.consume_token(&Token::Eq)
6057        {
6058            Some(self.parse_expr()?)
6059        } else {
6060            None
6061        };
6062        Ok(OperateFunctionArg {
6063            mode,
6064            name,
6065            data_type,
6066            default_expr,
6067        })
6068    }
6069
6070    fn parse_aggregate_function_arg(&mut self) -> Result<OperateFunctionArg, ParserError> {
6071        let mode = if self.parse_keyword(Keyword::IN) {
6072            Some(ArgMode::In)
6073        } else {
6074            if self
6075                .peek_one_of_keywords(&[Keyword::OUT, Keyword::INOUT, Keyword::VARIADIC])
6076                .is_some()
6077            {
6078                return self.expected_ref(
6079                    "IN or argument type in aggregate signature",
6080                    self.peek_token_ref(),
6081                );
6082            }
6083            None
6084        };
6085
6086        // Parse: [ argname ] argtype, but do not consume ORDER from
6087        // `... argtype ORDER BY ...` as a type-name disambiguator.
6088        let mut name = None;
6089        let mut data_type = self.parse_data_type()?;
6090        let data_type_idx = self.get_current_index();
6091
6092        fn parse_data_type_for_aggregate_arg(parser: &mut Parser) -> Result<DataType, ParserError> {
6093            if parser.peek_keyword(Keyword::DEFAULT)
6094                || parser.peek_keyword(Keyword::ORDER)
6095                || parser.peek_token_ref().token == Token::Comma
6096                || parser.peek_token_ref().token == Token::RParen
6097            {
6098                // Dummy error ignored by maybe_parse
6099                parser_err!(
6100                    "The current token cannot start an aggregate argument type",
6101                    parser.peek_token_ref().span.start
6102                )
6103            } else {
6104                parser.parse_data_type()
6105            }
6106        }
6107
6108        if let Some(next_data_type) = self.maybe_parse(parse_data_type_for_aggregate_arg)? {
6109            let token = self.token_at(data_type_idx);
6110            if !matches!(token.token, Token::Word(_)) {
6111                return self.expected("a name or type", token.clone());
6112            }
6113
6114            name = Some(Ident::new(token.to_string()));
6115            data_type = next_data_type;
6116        }
6117
6118        if self.peek_keyword(Keyword::DEFAULT) || self.peek_token_ref().token == Token::Eq {
6119            return self.expected_ref(
6120                "',' or ')' or ORDER BY after aggregate argument type",
6121                self.peek_token_ref(),
6122            );
6123        }
6124
6125        Ok(OperateFunctionArg {
6126            mode,
6127            name,
6128            data_type,
6129            default_expr: None,
6130        })
6131    }
6132
6133    /// Parse statements of the DropTrigger type such as:
6134    ///
6135    /// ```sql
6136    /// DROP TRIGGER [ IF EXISTS ] name ON table_name [ CASCADE | RESTRICT ]
6137    /// ```
6138    pub fn parse_drop_trigger(&mut self) -> Result<DropTrigger, ParserError> {
6139        if !dialect_of!(self is PostgreSqlDialect | SQLiteDialect | GenericDialect | MySqlDialect | MsSqlDialect)
6140        {
6141            self.prev_token();
6142            return self.expected_ref("an object type after DROP", self.peek_token_ref());
6143        }
6144        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
6145        let trigger_name = self.parse_object_name(false)?;
6146        let table_name = if self.parse_keyword(Keyword::ON) {
6147            Some(self.parse_object_name(false)?)
6148        } else {
6149            None
6150        };
6151        let option = match self.parse_one_of_keywords(&[Keyword::CASCADE, Keyword::RESTRICT]) {
6152            Some(Keyword::CASCADE) => Some(ReferentialAction::Cascade),
6153            Some(Keyword::RESTRICT) => Some(ReferentialAction::Restrict),
6154            Some(unexpected_keyword) => return Err(ParserError::ParserError(
6155                format!("Internal parser error: expected any of {{CASCADE, RESTRICT}}, got {unexpected_keyword:?}"),
6156            )),
6157            None => None,
6158        };
6159        Ok(DropTrigger {
6160            if_exists,
6161            trigger_name,
6162            table_name,
6163            option,
6164        })
6165    }
6166
6167    /// Parse a `CREATE TRIGGER` statement.
6168    pub fn parse_create_trigger(
6169        &mut self,
6170        temporary: bool,
6171        or_alter: bool,
6172        or_replace: bool,
6173        is_constraint: bool,
6174    ) -> Result<CreateTrigger, ParserError> {
6175        if !dialect_of!(self is PostgreSqlDialect | SQLiteDialect | GenericDialect | MySqlDialect | MsSqlDialect)
6176        {
6177            self.prev_token();
6178            return self.expected_ref("an object type after CREATE", self.peek_token_ref());
6179        }
6180
6181        let name = self.parse_object_name(false)?;
6182        let period = self.maybe_parse(|parser| parser.parse_trigger_period())?;
6183
6184        let events = self.parse_keyword_separated(Keyword::OR, Parser::parse_trigger_event)?;
6185        self.expect_keyword_is(Keyword::ON)?;
6186        let table_name = self.parse_object_name(false)?;
6187
6188        let referenced_table_name = if self.parse_keyword(Keyword::FROM) {
6189            self.parse_object_name(true).ok()
6190        } else {
6191            None
6192        };
6193
6194        let characteristics = self.parse_constraint_characteristics()?;
6195
6196        let mut referencing = vec![];
6197        if self.parse_keyword(Keyword::REFERENCING) {
6198            while let Some(refer) = self.parse_trigger_referencing()? {
6199                referencing.push(refer);
6200            }
6201        }
6202
6203        let trigger_object = if self.parse_keyword(Keyword::FOR) {
6204            let include_each = self.parse_keyword(Keyword::EACH);
6205            let trigger_object =
6206                match self.expect_one_of_keywords(&[Keyword::ROW, Keyword::STATEMENT])? {
6207                    Keyword::ROW => TriggerObject::Row,
6208                    Keyword::STATEMENT => TriggerObject::Statement,
6209                    unexpected_keyword => return Err(ParserError::ParserError(
6210                        format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in ROW/STATEMENT"),
6211                    )),
6212                };
6213
6214            Some(if include_each {
6215                TriggerObjectKind::ForEach(trigger_object)
6216            } else {
6217                TriggerObjectKind::For(trigger_object)
6218            })
6219        } else {
6220            let _ = self.parse_keyword(Keyword::FOR);
6221
6222            None
6223        };
6224
6225        let condition = self
6226            .parse_keyword(Keyword::WHEN)
6227            .then(|| self.parse_expr())
6228            .transpose()?;
6229
6230        let mut exec_body = None;
6231        let mut statements = None;
6232        if self.parse_keyword(Keyword::EXECUTE) {
6233            exec_body = Some(self.parse_trigger_exec_body()?);
6234        } else {
6235            statements = Some(self.parse_conditional_statements(&[Keyword::END])?);
6236        }
6237
6238        Ok(CreateTrigger {
6239            or_alter,
6240            temporary,
6241            or_replace,
6242            is_constraint,
6243            name,
6244            period,
6245            period_before_table: true,
6246            events,
6247            table_name,
6248            referenced_table_name,
6249            referencing,
6250            trigger_object,
6251            condition,
6252            exec_body,
6253            statements_as: false,
6254            statements,
6255            characteristics,
6256        })
6257    }
6258
6259    /// Parse the period part of a trigger (`BEFORE`, `AFTER`, etc.).
6260    pub fn parse_trigger_period(&mut self) -> Result<TriggerPeriod, ParserError> {
6261        Ok(
6262            match self.expect_one_of_keywords(&[
6263                Keyword::FOR,
6264                Keyword::BEFORE,
6265                Keyword::AFTER,
6266                Keyword::INSTEAD,
6267            ])? {
6268                Keyword::FOR => TriggerPeriod::For,
6269                Keyword::BEFORE => TriggerPeriod::Before,
6270                Keyword::AFTER => TriggerPeriod::After,
6271                Keyword::INSTEAD => self
6272                    .expect_keyword_is(Keyword::OF)
6273                    .map(|_| TriggerPeriod::InsteadOf)?,
6274                unexpected_keyword => return Err(ParserError::ParserError(
6275                    format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in trigger period"),
6276                )),
6277            },
6278        )
6279    }
6280
6281    /// Parse the event part of a trigger (`INSERT`, `UPDATE`, etc.).
6282    pub fn parse_trigger_event(&mut self) -> Result<TriggerEvent, ParserError> {
6283        Ok(
6284            match self.expect_one_of_keywords(&[
6285                Keyword::INSERT,
6286                Keyword::UPDATE,
6287                Keyword::DELETE,
6288                Keyword::TRUNCATE,
6289            ])? {
6290                Keyword::INSERT => TriggerEvent::Insert,
6291                Keyword::UPDATE => {
6292                    if self.parse_keyword(Keyword::OF) {
6293                        let cols = self.parse_comma_separated(Parser::parse_identifier)?;
6294                        TriggerEvent::Update(cols)
6295                    } else {
6296                        TriggerEvent::Update(vec![])
6297                    }
6298                }
6299                Keyword::DELETE => TriggerEvent::Delete,
6300                Keyword::TRUNCATE => TriggerEvent::Truncate,
6301                unexpected_keyword => return Err(ParserError::ParserError(
6302                    format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in trigger event"),
6303                )),
6304            },
6305        )
6306    }
6307
6308    /// Parse the `REFERENCING` clause of a trigger.
6309    pub fn parse_trigger_referencing(&mut self) -> Result<Option<TriggerReferencing>, ParserError> {
6310        let refer_type = match self.parse_one_of_keywords(&[Keyword::OLD, Keyword::NEW]) {
6311            Some(Keyword::OLD) if self.parse_keyword(Keyword::TABLE) => {
6312                TriggerReferencingType::OldTable
6313            }
6314            Some(Keyword::NEW) if self.parse_keyword(Keyword::TABLE) => {
6315                TriggerReferencingType::NewTable
6316            }
6317            _ => {
6318                return Ok(None);
6319            }
6320        };
6321
6322        let is_as = self.parse_keyword(Keyword::AS);
6323        let transition_relation_name = self.parse_object_name(false)?;
6324        Ok(Some(TriggerReferencing {
6325            refer_type,
6326            is_as,
6327            transition_relation_name,
6328        }))
6329    }
6330
6331    /// Parse the execution body of a trigger (`FUNCTION` or `PROCEDURE`).
6332    pub fn parse_trigger_exec_body(&mut self) -> Result<TriggerExecBody, ParserError> {
6333        Ok(TriggerExecBody {
6334            exec_type: match self
6335                .expect_one_of_keywords(&[Keyword::FUNCTION, Keyword::PROCEDURE])?
6336            {
6337                Keyword::FUNCTION => TriggerExecBodyType::Function,
6338                Keyword::PROCEDURE => TriggerExecBodyType::Procedure,
6339                unexpected_keyword => return Err(ParserError::ParserError(
6340                    format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in trigger exec body"),
6341                )),
6342            },
6343            func_desc: self.parse_function_desc()?,
6344        })
6345    }
6346
6347    /// Parse a `CREATE MACRO` statement.
6348    pub fn parse_create_macro(
6349        &mut self,
6350        or_replace: bool,
6351        temporary: bool,
6352    ) -> Result<Statement, ParserError> {
6353        if dialect_of!(self is DuckDbDialect |  GenericDialect) {
6354            let name = self.parse_object_name(false)?;
6355            self.expect_token(&Token::LParen)?;
6356            let args = if self.consume_token(&Token::RParen) {
6357                self.prev_token();
6358                None
6359            } else {
6360                Some(self.parse_comma_separated(Parser::parse_macro_arg)?)
6361            };
6362
6363            self.expect_token(&Token::RParen)?;
6364            self.expect_keyword_is(Keyword::AS)?;
6365
6366            Ok(Statement::CreateMacro {
6367                or_replace,
6368                temporary,
6369                name,
6370                args,
6371                definition: if self.parse_keyword(Keyword::TABLE) {
6372                    MacroDefinition::Table(self.parse_query()?)
6373                } else {
6374                    MacroDefinition::Expr(self.parse_expr()?)
6375                },
6376            })
6377        } else {
6378            self.prev_token();
6379            self.expected_ref("an object type after CREATE", self.peek_token_ref())
6380        }
6381    }
6382
6383    fn parse_macro_arg(&mut self) -> Result<MacroArg, ParserError> {
6384        let name = self.parse_identifier()?;
6385
6386        let default_expr =
6387            if self.consume_token(&Token::Assignment) || self.consume_token(&Token::RArrow) {
6388                Some(self.parse_expr()?)
6389            } else {
6390                None
6391            };
6392        Ok(MacroArg { name, default_expr })
6393    }
6394
6395    /// Parse a `CREATE EXTERNAL TABLE` statement.
6396    pub fn parse_create_external_table(
6397        &mut self,
6398        or_replace: bool,
6399    ) -> Result<CreateTable, ParserError> {
6400        self.expect_keyword_is(Keyword::TABLE)?;
6401        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
6402        let table_name = self.parse_object_name(false)?;
6403        let (columns, constraints) = self.parse_columns()?;
6404
6405        let hive_distribution = self.parse_hive_distribution()?;
6406        let hive_formats = self.parse_hive_formats()?;
6407
6408        let file_format = if let Some(ref hf) = hive_formats {
6409            if let Some(ref ff) = hf.storage {
6410                match ff {
6411                    HiveIOFormat::FileFormat { format } => Some(*format),
6412                    _ => None,
6413                }
6414            } else {
6415                None
6416            }
6417        } else {
6418            None
6419        };
6420        let location = hive_formats.as_ref().and_then(|hf| hf.location.clone());
6421
6422        let with_connection = if self.parse_keywords(&[Keyword::WITH, Keyword::CONNECTION]) {
6423            Some(self.parse_object_name(false)?)
6424        } else {
6425            None
6426        };
6427        let table_properties = self.parse_options(Keyword::TBLPROPERTIES)?;
6428        let table_options = if !table_properties.is_empty() {
6429            CreateTableOptions::TableProperties(table_properties)
6430        } else if let Some(options) = self.maybe_parse_options(Keyword::OPTIONS)? {
6431            CreateTableOptions::Options(options)
6432        } else {
6433            CreateTableOptions::None
6434        };
6435        Ok(CreateTableBuilder::new(table_name)
6436            .columns(columns)
6437            .constraints(constraints)
6438            .hive_distribution(hive_distribution)
6439            .hive_formats(hive_formats)
6440            .table_options(table_options)
6441            .with_connection(with_connection)
6442            .or_replace(or_replace)
6443            .if_not_exists(if_not_exists)
6444            .external(true)
6445            .file_format(file_format)
6446            .location(location)
6447            .build())
6448    }
6449
6450    /// Parse `CREATE SNAPSHOT TABLE` statement.
6451    ///
6452    /// <https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement>
6453    pub fn parse_create_snapshot_table(&mut self) -> Result<CreateTable, ParserError> {
6454        self.expect_keywords(&[Keyword::SNAPSHOT, Keyword::TABLE])?;
6455        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
6456        let table_name = self.parse_object_name(true)?;
6457
6458        self.expect_keyword_is(Keyword::CLONE)?;
6459        let clone = Some(self.parse_object_name(true)?);
6460
6461        let version =
6462            if self.parse_keywords(&[Keyword::FOR, Keyword::SYSTEM_TIME, Keyword::AS, Keyword::OF])
6463            {
6464                Some(TableVersion::ForSystemTimeAsOf(self.parse_expr()?))
6465            } else {
6466                None
6467            };
6468
6469        let table_options = if let Some(options) = self.maybe_parse_options(Keyword::OPTIONS)? {
6470            CreateTableOptions::Options(options)
6471        } else {
6472            CreateTableOptions::None
6473        };
6474
6475        Ok(CreateTableBuilder::new(table_name)
6476            .snapshot(true)
6477            .if_not_exists(if_not_exists)
6478            .clone_clause(clone)
6479            .version(version)
6480            .table_options(table_options)
6481            .build())
6482    }
6483
6484    /// Parse a file format for external tables.
6485    pub fn parse_file_format(&mut self) -> Result<FileFormat, ParserError> {
6486        let next_token = self.next_token();
6487        match &next_token.token {
6488            Token::Word(w) => match w.keyword {
6489                Keyword::AVRO => Ok(FileFormat::AVRO),
6490                Keyword::JSONFILE => Ok(FileFormat::JSONFILE),
6491                Keyword::ORC => Ok(FileFormat::ORC),
6492                Keyword::PARQUET => Ok(FileFormat::PARQUET),
6493                Keyword::RCFILE => Ok(FileFormat::RCFILE),
6494                Keyword::SEQUENCEFILE => Ok(FileFormat::SEQUENCEFILE),
6495                Keyword::TEXTFILE => Ok(FileFormat::TEXTFILE),
6496                _ => self.expected("fileformat", next_token),
6497            },
6498            _ => self.expected("fileformat", next_token),
6499        }
6500    }
6501
6502    fn parse_analyze_format_kind(&mut self) -> Result<AnalyzeFormatKind, ParserError> {
6503        if self.consume_token(&Token::Eq) {
6504            Ok(AnalyzeFormatKind::Assignment(self.parse_analyze_format()?))
6505        } else {
6506            Ok(AnalyzeFormatKind::Keyword(self.parse_analyze_format()?))
6507        }
6508    }
6509
6510    /// Parse an `ANALYZE FORMAT`.
6511    pub fn parse_analyze_format(&mut self) -> Result<AnalyzeFormat, ParserError> {
6512        let next_token = self.next_token();
6513        match &next_token.token {
6514            Token::Word(w) => match w.keyword {
6515                Keyword::TEXT => Ok(AnalyzeFormat::TEXT),
6516                Keyword::GRAPHVIZ => Ok(AnalyzeFormat::GRAPHVIZ),
6517                Keyword::JSON => Ok(AnalyzeFormat::JSON),
6518                Keyword::TREE => Ok(AnalyzeFormat::TREE),
6519                _ => self.expected("fileformat", next_token),
6520            },
6521            _ => self.expected("fileformat", next_token),
6522        }
6523    }
6524
6525    /// Parse a `CREATE VIEW` statement.
6526    pub fn parse_create_view(
6527        &mut self,
6528        or_alter: bool,
6529        or_replace: bool,
6530        temporary: bool,
6531        create_view_params: Option<CreateViewParams>,
6532    ) -> Result<CreateView, ParserError> {
6533        let secure = self.parse_keyword(Keyword::SECURE);
6534        let materialized = self.parse_keyword(Keyword::MATERIALIZED);
6535        self.expect_keyword_is(Keyword::VIEW)?;
6536        let allow_unquoted_hyphen = dialect_of!(self is BigQueryDialect);
6537        // Tries to parse IF NOT EXISTS either before name or after name
6538        // Name before IF NOT EXISTS is supported by snowflake but undocumented
6539        let if_not_exists_first =
6540            self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
6541        let name = self.parse_object_name(allow_unquoted_hyphen)?;
6542        let name_before_not_exists = !if_not_exists_first
6543            && self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
6544        let if_not_exists = if_not_exists_first || name_before_not_exists;
6545        let mut copy_grants = self.parse_keywords(&[Keyword::COPY, Keyword::GRANTS]);
6546        // Many dialects support `OR ALTER` right after `CREATE`, but we don't (yet).
6547        // ANSI SQL and Postgres support RECURSIVE here, but we don't support it either.
6548        let columns = self.parse_view_columns()?;
6549        // Snowflake also documents `COPY GRANTS` *after* the column list; accept
6550        // either position, but not both.
6551        // <https://docs.snowflake.com/en/sql-reference/sql/create-view#syntax>
6552        if !copy_grants {
6553            copy_grants = self.parse_keywords(&[Keyword::COPY, Keyword::GRANTS]);
6554        }
6555        let mut options = CreateTableOptions::None;
6556        let with_options = self.parse_options(Keyword::WITH)?;
6557        if !with_options.is_empty() {
6558            options = CreateTableOptions::With(with_options);
6559        }
6560
6561        let cluster_by = if self.parse_keyword(Keyword::CLUSTER) {
6562            self.expect_keyword_is(Keyword::BY)?;
6563            self.parse_parenthesized_column_list(Optional, false)?
6564        } else {
6565            vec![]
6566        };
6567
6568        if dialect_of!(self is BigQueryDialect | GenericDialect) {
6569            if let Some(opts) = self.maybe_parse_options(Keyword::OPTIONS)? {
6570                if !opts.is_empty() {
6571                    options = CreateTableOptions::Options(opts);
6572                }
6573            };
6574        }
6575
6576        let to = if dialect_of!(self is ClickHouseDialect | GenericDialect)
6577            && self.parse_keyword(Keyword::TO)
6578        {
6579            Some(self.parse_object_name(false)?)
6580        } else {
6581            None
6582        };
6583
6584        let comment = if self.dialect.supports_create_view_comment_syntax()
6585            && self.parse_keyword(Keyword::COMMENT)
6586        {
6587            self.expect_token(&Token::Eq)?;
6588            Some(self.parse_comment_value()?)
6589        } else {
6590            None
6591        };
6592
6593        self.expect_keyword_is(Keyword::AS)?;
6594        let query = self.parse_query()?;
6595        // Optional `WITH [ CASCADED | LOCAL ] CHECK OPTION` is widely supported here.
6596
6597        let with_no_schema_binding = dialect_of!(self is RedshiftSqlDialect | GenericDialect)
6598            && self.parse_keywords(&[
6599                Keyword::WITH,
6600                Keyword::NO,
6601                Keyword::SCHEMA,
6602                Keyword::BINDING,
6603            ]);
6604
6605        Ok(CreateView {
6606            or_alter,
6607            name,
6608            columns,
6609            query,
6610            materialized,
6611            secure,
6612            or_replace,
6613            options,
6614            cluster_by,
6615            comment,
6616            with_no_schema_binding,
6617            if_not_exists,
6618            temporary,
6619            copy_grants,
6620            to,
6621            params: create_view_params,
6622            name_before_not_exists,
6623        })
6624    }
6625
6626    /// Parse optional parameters for the `CREATE VIEW` statement supported by [MySQL].
6627    ///
6628    /// [MySQL]: https://dev.mysql.com/doc/refman/9.1/en/create-view.html
6629    fn parse_create_view_params(&mut self) -> Result<Option<CreateViewParams>, ParserError> {
6630        let algorithm = if self.parse_keyword(Keyword::ALGORITHM) {
6631            self.expect_token(&Token::Eq)?;
6632            Some(
6633                match self.expect_one_of_keywords(&[
6634                    Keyword::UNDEFINED,
6635                    Keyword::MERGE,
6636                    Keyword::TEMPTABLE,
6637                ])? {
6638                    Keyword::UNDEFINED => CreateViewAlgorithm::Undefined,
6639                    Keyword::MERGE => CreateViewAlgorithm::Merge,
6640                    Keyword::TEMPTABLE => CreateViewAlgorithm::TempTable,
6641                    _ => {
6642                        self.prev_token();
6643                        let found = self.next_token();
6644                        return self
6645                            .expected("UNDEFINED or MERGE or TEMPTABLE after ALGORITHM =", found);
6646                    }
6647                },
6648            )
6649        } else {
6650            None
6651        };
6652        let definer = if self.parse_keyword(Keyword::DEFINER) {
6653            self.expect_token(&Token::Eq)?;
6654            Some(self.parse_grantee_name()?)
6655        } else {
6656            None
6657        };
6658        let security = if self.parse_keywords(&[Keyword::SQL, Keyword::SECURITY]) {
6659            Some(
6660                match self.expect_one_of_keywords(&[Keyword::DEFINER, Keyword::INVOKER])? {
6661                    Keyword::DEFINER => CreateViewSecurity::Definer,
6662                    Keyword::INVOKER => CreateViewSecurity::Invoker,
6663                    _ => {
6664                        self.prev_token();
6665                        let found = self.next_token();
6666                        return self.expected("DEFINER or INVOKER after SQL SECURITY", found);
6667                    }
6668                },
6669            )
6670        } else {
6671            None
6672        };
6673        if algorithm.is_some() || definer.is_some() || security.is_some() {
6674            Ok(Some(CreateViewParams {
6675                algorithm,
6676                definer,
6677                security,
6678            }))
6679        } else {
6680            Ok(None)
6681        }
6682    }
6683
6684    /// Parse a `CREATE ROLE` statement.
6685    pub fn parse_create_role(&mut self) -> Result<CreateRole, ParserError> {
6686        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
6687        let names = self.parse_comma_separated(|p| p.parse_object_name(false))?;
6688
6689        let _ = self.parse_keyword(Keyword::WITH); // [ WITH ]
6690
6691        let optional_keywords = if dialect_of!(self is MsSqlDialect) {
6692            vec![Keyword::AUTHORIZATION]
6693        } else if dialect_of!(self is PostgreSqlDialect) {
6694            vec![
6695                Keyword::LOGIN,
6696                Keyword::NOLOGIN,
6697                Keyword::INHERIT,
6698                Keyword::NOINHERIT,
6699                Keyword::BYPASSRLS,
6700                Keyword::NOBYPASSRLS,
6701                Keyword::PASSWORD,
6702                Keyword::CREATEDB,
6703                Keyword::NOCREATEDB,
6704                Keyword::CREATEROLE,
6705                Keyword::NOCREATEROLE,
6706                Keyword::SUPERUSER,
6707                Keyword::NOSUPERUSER,
6708                Keyword::REPLICATION,
6709                Keyword::NOREPLICATION,
6710                Keyword::CONNECTION,
6711                Keyword::VALID,
6712                Keyword::IN,
6713                Keyword::ROLE,
6714                Keyword::ADMIN,
6715                Keyword::USER,
6716            ]
6717        } else {
6718            vec![]
6719        };
6720
6721        // MSSQL
6722        let mut authorization_owner = None;
6723        // Postgres
6724        let mut login = None;
6725        let mut inherit = None;
6726        let mut bypassrls = None;
6727        let mut password = None;
6728        let mut create_db = None;
6729        let mut create_role = None;
6730        let mut superuser = None;
6731        let mut replication = None;
6732        let mut connection_limit = None;
6733        let mut valid_until = None;
6734        let mut in_role = vec![];
6735        let mut in_group = vec![];
6736        let mut role = vec![];
6737        let mut user = vec![];
6738        let mut admin = vec![];
6739
6740        while let Some(keyword) = self.parse_one_of_keywords(&optional_keywords) {
6741            let loc = self
6742                .tokens
6743                .get(self.index - 1)
6744                .map_or(Location { line: 0, column: 0 }, |t| t.span.start);
6745            match keyword {
6746                Keyword::AUTHORIZATION => {
6747                    if authorization_owner.is_some() {
6748                        parser_err!("Found multiple AUTHORIZATION", loc)
6749                    } else {
6750                        authorization_owner = Some(self.parse_object_name(false)?);
6751                        Ok(())
6752                    }
6753                }
6754                Keyword::LOGIN | Keyword::NOLOGIN => {
6755                    if login.is_some() {
6756                        parser_err!("Found multiple LOGIN or NOLOGIN", loc)
6757                    } else {
6758                        login = Some(keyword == Keyword::LOGIN);
6759                        Ok(())
6760                    }
6761                }
6762                Keyword::INHERIT | Keyword::NOINHERIT => {
6763                    if inherit.is_some() {
6764                        parser_err!("Found multiple INHERIT or NOINHERIT", loc)
6765                    } else {
6766                        inherit = Some(keyword == Keyword::INHERIT);
6767                        Ok(())
6768                    }
6769                }
6770                Keyword::BYPASSRLS | Keyword::NOBYPASSRLS => {
6771                    if bypassrls.is_some() {
6772                        parser_err!("Found multiple BYPASSRLS or NOBYPASSRLS", loc)
6773                    } else {
6774                        bypassrls = Some(keyword == Keyword::BYPASSRLS);
6775                        Ok(())
6776                    }
6777                }
6778                Keyword::CREATEDB | Keyword::NOCREATEDB => {
6779                    if create_db.is_some() {
6780                        parser_err!("Found multiple CREATEDB or NOCREATEDB", loc)
6781                    } else {
6782                        create_db = Some(keyword == Keyword::CREATEDB);
6783                        Ok(())
6784                    }
6785                }
6786                Keyword::CREATEROLE | Keyword::NOCREATEROLE => {
6787                    if create_role.is_some() {
6788                        parser_err!("Found multiple CREATEROLE or NOCREATEROLE", loc)
6789                    } else {
6790                        create_role = Some(keyword == Keyword::CREATEROLE);
6791                        Ok(())
6792                    }
6793                }
6794                Keyword::SUPERUSER | Keyword::NOSUPERUSER => {
6795                    if superuser.is_some() {
6796                        parser_err!("Found multiple SUPERUSER or NOSUPERUSER", loc)
6797                    } else {
6798                        superuser = Some(keyword == Keyword::SUPERUSER);
6799                        Ok(())
6800                    }
6801                }
6802                Keyword::REPLICATION | Keyword::NOREPLICATION => {
6803                    if replication.is_some() {
6804                        parser_err!("Found multiple REPLICATION or NOREPLICATION", loc)
6805                    } else {
6806                        replication = Some(keyword == Keyword::REPLICATION);
6807                        Ok(())
6808                    }
6809                }
6810                Keyword::PASSWORD => {
6811                    if password.is_some() {
6812                        parser_err!("Found multiple PASSWORD", loc)
6813                    } else {
6814                        password = if self.parse_keyword(Keyword::NULL) {
6815                            Some(Password::NullPassword)
6816                        } else {
6817                            Some(Password::Password(Expr::Value(self.parse_value()?)))
6818                        };
6819                        Ok(())
6820                    }
6821                }
6822                Keyword::CONNECTION => {
6823                    self.expect_keyword_is(Keyword::LIMIT)?;
6824                    if connection_limit.is_some() {
6825                        parser_err!("Found multiple CONNECTION LIMIT", loc)
6826                    } else {
6827                        connection_limit = Some(Expr::Value(self.parse_number_value()?));
6828                        Ok(())
6829                    }
6830                }
6831                Keyword::VALID => {
6832                    self.expect_keyword_is(Keyword::UNTIL)?;
6833                    if valid_until.is_some() {
6834                        parser_err!("Found multiple VALID UNTIL", loc)
6835                    } else {
6836                        valid_until = Some(Expr::Value(self.parse_value()?));
6837                        Ok(())
6838                    }
6839                }
6840                Keyword::IN => {
6841                    if self.parse_keyword(Keyword::ROLE) {
6842                        if !in_role.is_empty() {
6843                            parser_err!("Found multiple IN ROLE", loc)
6844                        } else {
6845                            in_role = self.parse_comma_separated(|p| p.parse_identifier())?;
6846                            Ok(())
6847                        }
6848                    } else if self.parse_keyword(Keyword::GROUP) {
6849                        if !in_group.is_empty() {
6850                            parser_err!("Found multiple IN GROUP", loc)
6851                        } else {
6852                            in_group = self.parse_comma_separated(|p| p.parse_identifier())?;
6853                            Ok(())
6854                        }
6855                    } else {
6856                        self.expected_ref("ROLE or GROUP after IN", self.peek_token_ref())
6857                    }
6858                }
6859                Keyword::ROLE => {
6860                    if !role.is_empty() {
6861                        parser_err!("Found multiple ROLE", loc)
6862                    } else {
6863                        role = self.parse_comma_separated(|p| p.parse_identifier())?;
6864                        Ok(())
6865                    }
6866                }
6867                Keyword::USER => {
6868                    if !user.is_empty() {
6869                        parser_err!("Found multiple USER", loc)
6870                    } else {
6871                        user = self.parse_comma_separated(|p| p.parse_identifier())?;
6872                        Ok(())
6873                    }
6874                }
6875                Keyword::ADMIN => {
6876                    if !admin.is_empty() {
6877                        parser_err!("Found multiple ADMIN", loc)
6878                    } else {
6879                        admin = self.parse_comma_separated(|p| p.parse_identifier())?;
6880                        Ok(())
6881                    }
6882                }
6883                _ => break,
6884            }?
6885        }
6886
6887        Ok(CreateRole {
6888            names,
6889            if_not_exists,
6890            login,
6891            inherit,
6892            bypassrls,
6893            password,
6894            create_db,
6895            create_role,
6896            replication,
6897            superuser,
6898            connection_limit,
6899            valid_until,
6900            in_role,
6901            in_group,
6902            role,
6903            user,
6904            admin,
6905            authorization_owner,
6906        })
6907    }
6908
6909    /// Parse an `OWNER` clause.
6910    pub fn parse_owner(&mut self) -> Result<Owner, ParserError> {
6911        let owner = match self.parse_one_of_keywords(&[Keyword::CURRENT_USER, Keyword::CURRENT_ROLE, Keyword::SESSION_USER]) {
6912            Some(Keyword::CURRENT_USER) => Owner::CurrentUser,
6913            Some(Keyword::CURRENT_ROLE) => Owner::CurrentRole,
6914            Some(Keyword::SESSION_USER) => Owner::SessionUser,
6915            Some(unexpected_keyword) => return Err(ParserError::ParserError(
6916                format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in owner"),
6917            )),
6918            None => {
6919                match self.parse_identifier() {
6920                    Ok(ident) => Owner::Ident(ident),
6921                    Err(e) => {
6922                        return Err(ParserError::ParserError(format!("Expected: CURRENT_USER, CURRENT_ROLE, SESSION_USER or identifier after OWNER TO. {e}")))
6923                    }
6924                }
6925            }
6926        };
6927        Ok(owner)
6928    }
6929
6930    /// Parses a [Statement::CreateDomain] statement.
6931    fn parse_create_domain(&mut self) -> Result<CreateDomain, ParserError> {
6932        let name = self.parse_object_name(false)?;
6933        self.expect_keyword_is(Keyword::AS)?;
6934        let data_type = self.parse_data_type()?;
6935        let collation = if self.parse_keyword(Keyword::COLLATE) {
6936            Some(self.parse_identifier()?)
6937        } else {
6938            None
6939        };
6940        let default = if self.parse_keyword(Keyword::DEFAULT) {
6941            Some(self.parse_expr()?)
6942        } else {
6943            None
6944        };
6945        let mut constraints = Vec::new();
6946        while let Some(constraint) = self.parse_optional_table_constraint()? {
6947            constraints.push(constraint);
6948        }
6949
6950        Ok(CreateDomain {
6951            name,
6952            data_type,
6953            collation,
6954            default,
6955            constraints,
6956        })
6957    }
6958
6959    /// ```sql
6960    ///     CREATE POLICY name ON table_name [ AS { PERMISSIVE | RESTRICTIVE } ]
6961    ///     [ FOR { ALL | SELECT | INSERT | UPDATE | DELETE } ]
6962    ///     [ TO { role_name | PUBLIC | CURRENT_USER | CURRENT_ROLE | SESSION_USER } [, ...] ]
6963    ///     [ USING ( using_expression ) ]
6964    ///     [ WITH CHECK ( with_check_expression ) ]
6965    /// ```
6966    ///
6967    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-createpolicy.html)
6968    pub fn parse_create_policy(&mut self) -> Result<CreatePolicy, ParserError> {
6969        let name = self.parse_identifier()?;
6970        self.expect_keyword_is(Keyword::ON)?;
6971        let table_name = self.parse_object_name(false)?;
6972
6973        let policy_type = if self.parse_keyword(Keyword::AS) {
6974            let keyword =
6975                self.expect_one_of_keywords(&[Keyword::PERMISSIVE, Keyword::RESTRICTIVE])?;
6976            Some(match keyword {
6977                Keyword::PERMISSIVE => CreatePolicyType::Permissive,
6978                Keyword::RESTRICTIVE => CreatePolicyType::Restrictive,
6979                unexpected_keyword => return Err(ParserError::ParserError(
6980                    format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in policy type"),
6981                )),
6982            })
6983        } else {
6984            None
6985        };
6986
6987        let command = if self.parse_keyword(Keyword::FOR) {
6988            let keyword = self.expect_one_of_keywords(&[
6989                Keyword::ALL,
6990                Keyword::SELECT,
6991                Keyword::INSERT,
6992                Keyword::UPDATE,
6993                Keyword::DELETE,
6994            ])?;
6995            Some(match keyword {
6996                Keyword::ALL => CreatePolicyCommand::All,
6997                Keyword::SELECT => CreatePolicyCommand::Select,
6998                Keyword::INSERT => CreatePolicyCommand::Insert,
6999                Keyword::UPDATE => CreatePolicyCommand::Update,
7000                Keyword::DELETE => CreatePolicyCommand::Delete,
7001                unexpected_keyword => return Err(ParserError::ParserError(
7002                    format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in policy command"),
7003                )),
7004            })
7005        } else {
7006            None
7007        };
7008
7009        let to = if self.parse_keyword(Keyword::TO) {
7010            Some(self.parse_comma_separated(|p| p.parse_owner())?)
7011        } else {
7012            None
7013        };
7014
7015        let using = if self.parse_keyword(Keyword::USING) {
7016            self.expect_token(&Token::LParen)?;
7017            let expr = self.parse_expr()?;
7018            self.expect_token(&Token::RParen)?;
7019            Some(expr)
7020        } else {
7021            None
7022        };
7023
7024        let with_check = if self.parse_keywords(&[Keyword::WITH, Keyword::CHECK]) {
7025            self.expect_token(&Token::LParen)?;
7026            let expr = self.parse_expr()?;
7027            self.expect_token(&Token::RParen)?;
7028            Some(expr)
7029        } else {
7030            None
7031        };
7032
7033        Ok(CreatePolicy {
7034            name,
7035            table_name,
7036            policy_type,
7037            command,
7038            to,
7039            using,
7040            with_check,
7041        })
7042    }
7043
7044    /// ```sql
7045    /// CREATE CONNECTOR [IF NOT EXISTS] connector_name
7046    /// [TYPE datasource_type]
7047    /// [URL datasource_url]
7048    /// [COMMENT connector_comment]
7049    /// [WITH DCPROPERTIES(property_name=property_value, ...)]
7050    /// ```
7051    ///
7052    /// [Hive Documentation](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=27362034#LanguageManualDDL-CreateDataConnectorCreateConnector)
7053    pub fn parse_create_connector(&mut self) -> Result<CreateConnector, ParserError> {
7054        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
7055        let name = self.parse_identifier()?;
7056
7057        let connector_type = if self.parse_keyword(Keyword::TYPE) {
7058            Some(self.parse_literal_string()?)
7059        } else {
7060            None
7061        };
7062
7063        let url = if self.parse_keyword(Keyword::URL) {
7064            Some(self.parse_literal_string()?)
7065        } else {
7066            None
7067        };
7068
7069        let comment = self.parse_optional_inline_comment()?;
7070
7071        let with_dcproperties =
7072            match self.parse_options_with_keywords(&[Keyword::WITH, Keyword::DCPROPERTIES])? {
7073                properties if !properties.is_empty() => Some(properties),
7074                _ => None,
7075            };
7076
7077        Ok(CreateConnector {
7078            name,
7079            if_not_exists,
7080            connector_type,
7081            url,
7082            comment,
7083            with_dcproperties,
7084        })
7085    }
7086
7087    /// Parse an operator name, which can contain special characters like +, -, <, >, =
7088    /// that are tokenized as operator tokens rather than identifiers.
7089    /// This is used for PostgreSQL CREATE OPERATOR statements.
7090    ///
7091    /// Examples: `+`, `myschema.+`, `pg_catalog.<=`
7092    fn parse_operator_name(&mut self) -> Result<ObjectName, ParserError> {
7093        let mut parts = vec![];
7094        loop {
7095            parts.push(ObjectNamePart::Identifier(Ident::new(
7096                self.next_token().to_string(),
7097            )));
7098            if !self.consume_token(&Token::Period) {
7099                break;
7100            }
7101        }
7102        Ok(ObjectName(parts))
7103    }
7104
7105    /// Parse a [Statement::CreateOperator]
7106    ///
7107    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-createoperator.html)
7108    pub fn parse_create_operator(&mut self) -> Result<CreateOperator, ParserError> {
7109        let name = self.parse_operator_name()?;
7110        self.expect_token(&Token::LParen)?;
7111
7112        let mut function: Option<ObjectName> = None;
7113        let mut is_procedure = false;
7114        let mut left_arg: Option<DataType> = None;
7115        let mut right_arg: Option<DataType> = None;
7116        let mut options: Vec<OperatorOption> = Vec::new();
7117
7118        loop {
7119            let keyword = self.expect_one_of_keywords(&[
7120                Keyword::FUNCTION,
7121                Keyword::PROCEDURE,
7122                Keyword::LEFTARG,
7123                Keyword::RIGHTARG,
7124                Keyword::COMMUTATOR,
7125                Keyword::NEGATOR,
7126                Keyword::RESTRICT,
7127                Keyword::JOIN,
7128                Keyword::HASHES,
7129                Keyword::MERGES,
7130            ])?;
7131
7132            match keyword {
7133                Keyword::HASHES if !options.iter().any(|o| matches!(o, OperatorOption::Hashes)) => {
7134                    options.push(OperatorOption::Hashes);
7135                }
7136                Keyword::MERGES if !options.iter().any(|o| matches!(o, OperatorOption::Merges)) => {
7137                    options.push(OperatorOption::Merges);
7138                }
7139                Keyword::FUNCTION | Keyword::PROCEDURE if function.is_none() => {
7140                    self.expect_token(&Token::Eq)?;
7141                    function = Some(self.parse_object_name(false)?);
7142                    is_procedure = keyword == Keyword::PROCEDURE;
7143                }
7144                Keyword::LEFTARG if left_arg.is_none() => {
7145                    self.expect_token(&Token::Eq)?;
7146                    left_arg = Some(self.parse_data_type()?);
7147                }
7148                Keyword::RIGHTARG if right_arg.is_none() => {
7149                    self.expect_token(&Token::Eq)?;
7150                    right_arg = Some(self.parse_data_type()?);
7151                }
7152                Keyword::COMMUTATOR
7153                    if !options
7154                        .iter()
7155                        .any(|o| matches!(o, OperatorOption::Commutator(_))) =>
7156                {
7157                    self.expect_token(&Token::Eq)?;
7158                    if self.parse_keyword(Keyword::OPERATOR) {
7159                        self.expect_token(&Token::LParen)?;
7160                        let op = self.parse_operator_name()?;
7161                        self.expect_token(&Token::RParen)?;
7162                        options.push(OperatorOption::Commutator(op));
7163                    } else {
7164                        options.push(OperatorOption::Commutator(self.parse_operator_name()?));
7165                    }
7166                }
7167                Keyword::NEGATOR
7168                    if !options
7169                        .iter()
7170                        .any(|o| matches!(o, OperatorOption::Negator(_))) =>
7171                {
7172                    self.expect_token(&Token::Eq)?;
7173                    if self.parse_keyword(Keyword::OPERATOR) {
7174                        self.expect_token(&Token::LParen)?;
7175                        let op = self.parse_operator_name()?;
7176                        self.expect_token(&Token::RParen)?;
7177                        options.push(OperatorOption::Negator(op));
7178                    } else {
7179                        options.push(OperatorOption::Negator(self.parse_operator_name()?));
7180                    }
7181                }
7182                Keyword::RESTRICT
7183                    if !options
7184                        .iter()
7185                        .any(|o| matches!(o, OperatorOption::Restrict(_))) =>
7186                {
7187                    self.expect_token(&Token::Eq)?;
7188                    options.push(OperatorOption::Restrict(Some(
7189                        self.parse_object_name(false)?,
7190                    )));
7191                }
7192                Keyword::JOIN if !options.iter().any(|o| matches!(o, OperatorOption::Join(_))) => {
7193                    self.expect_token(&Token::Eq)?;
7194                    options.push(OperatorOption::Join(Some(self.parse_object_name(false)?)));
7195                }
7196                _ => {
7197                    return Err(ParserError::ParserError(format!(
7198                        "Duplicate or unexpected keyword {:?} in CREATE OPERATOR",
7199                        keyword
7200                    )))
7201                }
7202            }
7203
7204            if !self.consume_token(&Token::Comma) {
7205                break;
7206            }
7207        }
7208
7209        // Expect closing parenthesis
7210        self.expect_token(&Token::RParen)?;
7211
7212        // FUNCTION is required
7213        let function = function.ok_or_else(|| {
7214            ParserError::ParserError("CREATE OPERATOR requires FUNCTION parameter".to_string())
7215        })?;
7216
7217        Ok(CreateOperator {
7218            name,
7219            function,
7220            is_procedure,
7221            left_arg,
7222            right_arg,
7223            options,
7224        })
7225    }
7226
7227    /// Parse a [Statement::CreateOperatorFamily]
7228    ///
7229    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-createopfamily.html)
7230    pub fn parse_create_operator_family(&mut self) -> Result<CreateOperatorFamily, ParserError> {
7231        let name = self.parse_object_name(false)?;
7232        self.expect_keyword(Keyword::USING)?;
7233        let using = self.parse_identifier()?;
7234
7235        Ok(CreateOperatorFamily { name, using })
7236    }
7237
7238    /// Parse a [Statement::CreateOperatorClass]
7239    ///
7240    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-createopclass.html)
7241    pub fn parse_create_operator_class(&mut self) -> Result<CreateOperatorClass, ParserError> {
7242        let name = self.parse_object_name(false)?;
7243        let default = self.parse_keyword(Keyword::DEFAULT);
7244        self.expect_keywords(&[Keyword::FOR, Keyword::TYPE])?;
7245        let for_type = self.parse_data_type()?;
7246        self.expect_keyword(Keyword::USING)?;
7247        let using = self.parse_identifier()?;
7248
7249        let family = if self.parse_keyword(Keyword::FAMILY) {
7250            Some(self.parse_object_name(false)?)
7251        } else {
7252            None
7253        };
7254
7255        self.expect_keyword(Keyword::AS)?;
7256
7257        let mut items = vec![];
7258        loop {
7259            if self.parse_keyword(Keyword::OPERATOR) {
7260                let strategy_number = self.parse_literal_uint()?;
7261                let operator_name = self.parse_operator_name()?;
7262
7263                // Optional operator argument types
7264                let op_types = if self.consume_token(&Token::LParen) {
7265                    let left = self.parse_data_type()?;
7266                    self.expect_token(&Token::Comma)?;
7267                    let right = self.parse_data_type()?;
7268                    self.expect_token(&Token::RParen)?;
7269                    Some(OperatorArgTypes { left, right })
7270                } else {
7271                    None
7272                };
7273
7274                // Optional purpose
7275                let purpose = if self.parse_keyword(Keyword::FOR) {
7276                    if self.parse_keyword(Keyword::SEARCH) {
7277                        Some(OperatorPurpose::ForSearch)
7278                    } else if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
7279                        let sort_family = self.parse_object_name(false)?;
7280                        Some(OperatorPurpose::ForOrderBy { sort_family })
7281                    } else {
7282                        return self
7283                            .expected_ref("SEARCH or ORDER BY after FOR", self.peek_token_ref());
7284                    }
7285                } else {
7286                    None
7287                };
7288
7289                items.push(OperatorClassItem::Operator {
7290                    strategy_number,
7291                    operator_name,
7292                    op_types,
7293                    purpose,
7294                });
7295            } else if self.parse_keyword(Keyword::FUNCTION) {
7296                let support_number = self.parse_literal_uint()?;
7297
7298                // Optional operator types
7299                let op_types = if self.consume_token(&Token::LParen)
7300                    && self.peek_token_ref().token != Token::RParen
7301                {
7302                    let mut types = vec![];
7303                    loop {
7304                        types.push(self.parse_data_type()?);
7305                        if !self.consume_token(&Token::Comma) {
7306                            break;
7307                        }
7308                    }
7309                    self.expect_token(&Token::RParen)?;
7310                    Some(types)
7311                } else if self.consume_token(&Token::LParen) {
7312                    self.expect_token(&Token::RParen)?;
7313                    Some(vec![])
7314                } else {
7315                    None
7316                };
7317
7318                let function_name = self.parse_object_name(false)?;
7319
7320                // Function argument types
7321                let argument_types = if self.consume_token(&Token::LParen) {
7322                    let mut types = vec![];
7323                    loop {
7324                        if self.peek_token_ref().token == Token::RParen {
7325                            break;
7326                        }
7327                        types.push(self.parse_data_type()?);
7328                        if !self.consume_token(&Token::Comma) {
7329                            break;
7330                        }
7331                    }
7332                    self.expect_token(&Token::RParen)?;
7333                    types
7334                } else {
7335                    vec![]
7336                };
7337
7338                items.push(OperatorClassItem::Function {
7339                    support_number,
7340                    op_types,
7341                    function_name,
7342                    argument_types,
7343                });
7344            } else if self.parse_keyword(Keyword::STORAGE) {
7345                let storage_type = self.parse_data_type()?;
7346                items.push(OperatorClassItem::Storage { storage_type });
7347            } else {
7348                break;
7349            }
7350
7351            // Check for comma separator
7352            if !self.consume_token(&Token::Comma) {
7353                break;
7354            }
7355        }
7356
7357        Ok(CreateOperatorClass {
7358            name,
7359            default,
7360            for_type,
7361            using,
7362            family,
7363            items,
7364        })
7365    }
7366
7367    /// Parse a `DROP` statement.
7368    pub fn parse_drop(&mut self) -> Result<Statement, ParserError> {
7369        // MySQL dialect supports `TEMPORARY`
7370        let temporary = dialect_of!(self is MySqlDialect | GenericDialect | DuckDbDialect)
7371            && self.parse_keyword(Keyword::TEMPORARY);
7372        let persistent = dialect_of!(self is DuckDbDialect)
7373            && self.parse_one_of_keywords(&[Keyword::PERSISTENT]).is_some();
7374
7375        let object_type = if self.parse_keyword(Keyword::TABLE) {
7376            ObjectType::Table
7377        } else if self.parse_keyword(Keyword::COLLATION) {
7378            ObjectType::Collation
7379        } else if self.parse_keyword(Keyword::VIEW) {
7380            ObjectType::View
7381        } else if self.parse_keywords(&[Keyword::MATERIALIZED, Keyword::VIEW]) {
7382            ObjectType::MaterializedView
7383        } else if self.parse_keyword(Keyword::INDEX) {
7384            ObjectType::Index
7385        } else if self.parse_keyword(Keyword::ROLE) {
7386            ObjectType::Role
7387        } else if self.parse_keyword(Keyword::SCHEMA) {
7388            ObjectType::Schema
7389        } else if self.parse_keyword(Keyword::DATABASE) {
7390            ObjectType::Database
7391        } else if self.parse_keyword(Keyword::SEQUENCE) {
7392            ObjectType::Sequence
7393        } else if self.parse_keyword(Keyword::STAGE) {
7394            ObjectType::Stage
7395        } else if self.parse_keyword(Keyword::TYPE) {
7396            ObjectType::Type
7397        } else if self.parse_keyword(Keyword::USER) {
7398            ObjectType::User
7399        } else if self.parse_keyword(Keyword::STREAM) {
7400            ObjectType::Stream
7401        } else if self.parse_keyword(Keyword::FUNCTION) {
7402            return self.parse_drop_function().map(Into::into);
7403        } else if self.parse_keyword(Keyword::POLICY) {
7404            return self.parse_drop_policy().map(Into::into);
7405        } else if self.parse_keyword(Keyword::CONNECTOR) {
7406            return self.parse_drop_connector();
7407        } else if self.parse_keyword(Keyword::DOMAIN) {
7408            return self.parse_drop_domain().map(Into::into);
7409        } else if self.parse_keyword(Keyword::PROCEDURE) {
7410            return self.parse_drop_procedure();
7411        } else if self.parse_keyword(Keyword::SECRET) {
7412            return self.parse_drop_secret(temporary, persistent);
7413        } else if self.parse_keyword(Keyword::TRIGGER) {
7414            return self.parse_drop_trigger().map(Into::into);
7415        } else if self.parse_keyword(Keyword::EXTENSION) {
7416            return self.parse_drop_extension();
7417        } else if self.parse_keyword(Keyword::OPERATOR) {
7418            // Check if this is DROP OPERATOR FAMILY or DROP OPERATOR CLASS
7419            return if self.parse_keyword(Keyword::FAMILY) {
7420                self.parse_drop_operator_family()
7421            } else if self.parse_keyword(Keyword::CLASS) {
7422                self.parse_drop_operator_class()
7423            } else {
7424                self.parse_drop_operator()
7425            };
7426        } else {
7427            return self.expected_ref(
7428                "COLLATION, CONNECTOR, DATABASE, EXTENSION, FUNCTION, INDEX, OPERATOR, POLICY, PROCEDURE, ROLE, SCHEMA, SECRET, SEQUENCE, STAGE, TABLE, TRIGGER, TYPE, VIEW, MATERIALIZED VIEW or USER after DROP",
7429                self.peek_token_ref(),
7430            );
7431        };
7432        // Many dialects support the non-standard `IF EXISTS` clause and allow
7433        // specifying multiple objects to delete in a single statement
7434        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
7435        let names = self.parse_comma_separated(|p| p.parse_object_name(false))?;
7436
7437        let loc = self.peek_token_ref().span.start;
7438        let cascade = self.parse_keyword(Keyword::CASCADE);
7439        let restrict = self.parse_keyword(Keyword::RESTRICT);
7440        let purge = self.parse_keyword(Keyword::PURGE);
7441        if cascade && restrict {
7442            return parser_err!("Cannot specify both CASCADE and RESTRICT in DROP", loc);
7443        }
7444        if object_type == ObjectType::Role && (cascade || restrict || purge) {
7445            return parser_err!(
7446                "Cannot specify CASCADE, RESTRICT, or PURGE in DROP ROLE",
7447                loc
7448            );
7449        }
7450        let table = if self.parse_keyword(Keyword::ON) {
7451            Some(self.parse_object_name(false)?)
7452        } else {
7453            None
7454        };
7455        Ok(Statement::Drop {
7456            object_type,
7457            if_exists,
7458            names,
7459            cascade,
7460            restrict,
7461            purge,
7462            temporary,
7463            table,
7464        })
7465    }
7466
7467    fn parse_optional_drop_behavior(&mut self) -> Option<DropBehavior> {
7468        match self.parse_one_of_keywords(&[Keyword::CASCADE, Keyword::RESTRICT]) {
7469            Some(Keyword::CASCADE) => Some(DropBehavior::Cascade),
7470            Some(Keyword::RESTRICT) => Some(DropBehavior::Restrict),
7471            _ => None,
7472        }
7473    }
7474
7475    /// ```sql
7476    /// DROP FUNCTION [ IF EXISTS ] name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] [, ...]
7477    /// [ CASCADE | RESTRICT ]
7478    /// ```
7479    fn parse_drop_function(&mut self) -> Result<DropFunction, ParserError> {
7480        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
7481        let func_desc = self.parse_comma_separated(Parser::parse_function_desc)?;
7482        let drop_behavior = self.parse_optional_drop_behavior();
7483        Ok(DropFunction {
7484            if_exists,
7485            func_desc,
7486            drop_behavior,
7487        })
7488    }
7489
7490    /// ```sql
7491    /// DROP POLICY [ IF EXISTS ] name ON table_name [ CASCADE | RESTRICT ]
7492    /// ```
7493    ///
7494    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-droppolicy.html)
7495    fn parse_drop_policy(&mut self) -> Result<DropPolicy, ParserError> {
7496        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
7497        let name = self.parse_identifier()?;
7498        self.expect_keyword_is(Keyword::ON)?;
7499        let table_name = self.parse_object_name(false)?;
7500        let drop_behavior = self.parse_optional_drop_behavior();
7501        Ok(DropPolicy {
7502            if_exists,
7503            name,
7504            table_name,
7505            drop_behavior,
7506        })
7507    }
7508    /// ```sql
7509    /// DROP CONNECTOR [IF EXISTS] name
7510    /// ```
7511    ///
7512    /// See [Hive](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=27362034#LanguageManualDDL-DropConnector)
7513    fn parse_drop_connector(&mut self) -> Result<Statement, ParserError> {
7514        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
7515        let name = self.parse_identifier()?;
7516        Ok(Statement::DropConnector { if_exists, name })
7517    }
7518
7519    /// ```sql
7520    /// DROP DOMAIN [ IF EXISTS ] name [ CASCADE | RESTRICT ]
7521    /// ```
7522    fn parse_drop_domain(&mut self) -> Result<DropDomain, ParserError> {
7523        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
7524        let name = self.parse_object_name(false)?;
7525        let drop_behavior = self.parse_optional_drop_behavior();
7526        Ok(DropDomain {
7527            if_exists,
7528            name,
7529            drop_behavior,
7530        })
7531    }
7532
7533    /// ```sql
7534    /// DROP PROCEDURE [ IF EXISTS ] name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] [, ...]
7535    /// [ CASCADE | RESTRICT ]
7536    /// ```
7537    fn parse_drop_procedure(&mut self) -> Result<Statement, ParserError> {
7538        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
7539        let proc_desc = self.parse_comma_separated(Parser::parse_function_desc)?;
7540        let drop_behavior = self.parse_optional_drop_behavior();
7541        Ok(Statement::DropProcedure {
7542            if_exists,
7543            proc_desc,
7544            drop_behavior,
7545        })
7546    }
7547
7548    fn parse_function_desc(&mut self) -> Result<FunctionDesc, ParserError> {
7549        let name = self.parse_object_name(false)?;
7550
7551        let args = if self.consume_token(&Token::LParen) {
7552            if self.consume_token(&Token::RParen) {
7553                Some(vec![])
7554            } else {
7555                let args = self.parse_comma_separated(Parser::parse_function_arg)?;
7556                self.expect_token(&Token::RParen)?;
7557                Some(args)
7558            }
7559        } else {
7560            None
7561        };
7562
7563        Ok(FunctionDesc { name, args })
7564    }
7565
7566    /// See [DuckDB Docs](https://duckdb.org/docs/sql/statements/create_secret.html) for more details.
7567    fn parse_drop_secret(
7568        &mut self,
7569        temporary: bool,
7570        persistent: bool,
7571    ) -> Result<Statement, ParserError> {
7572        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
7573        let name = self.parse_identifier()?;
7574        let storage_specifier = if self.parse_keyword(Keyword::FROM) {
7575            self.parse_identifier().ok()
7576        } else {
7577            None
7578        };
7579        let temp = match (temporary, persistent) {
7580            (true, false) => Some(true),
7581            (false, true) => Some(false),
7582            (false, false) => None,
7583            _ => self.expected_ref("TEMPORARY or PERSISTENT", self.peek_token_ref())?,
7584        };
7585
7586        Ok(Statement::DropSecret {
7587            if_exists,
7588            temporary: temp,
7589            name,
7590            storage_specifier,
7591        })
7592    }
7593
7594    /// Parse a `DECLARE` statement.
7595    ///
7596    /// ```sql
7597    /// DECLARE name [ BINARY ] [ ASENSITIVE | INSENSITIVE ] [ [ NO ] SCROLL ]
7598    ///     CURSOR [ { WITH | WITHOUT } HOLD ] FOR query
7599    /// ```
7600    ///
7601    /// The syntax can vary significantly between warehouses. See the grammar
7602    /// on the warehouse specific function in such cases.
7603    pub fn parse_declare(&mut self) -> Result<Statement, ParserError> {
7604        if dialect_of!(self is BigQueryDialect) {
7605            return self.parse_big_query_declare();
7606        }
7607        if dialect_of!(self is SnowflakeDialect) {
7608            return self.parse_snowflake_declare();
7609        }
7610        if dialect_of!(self is MsSqlDialect) {
7611            return self.parse_mssql_declare();
7612        }
7613
7614        let name = self.parse_identifier()?;
7615
7616        let binary = Some(self.parse_keyword(Keyword::BINARY));
7617        let sensitive = if self.parse_keyword(Keyword::INSENSITIVE) {
7618            Some(true)
7619        } else if self.parse_keyword(Keyword::ASENSITIVE) {
7620            Some(false)
7621        } else {
7622            None
7623        };
7624        let scroll = if self.parse_keyword(Keyword::SCROLL) {
7625            Some(true)
7626        } else if self.parse_keywords(&[Keyword::NO, Keyword::SCROLL]) {
7627            Some(false)
7628        } else {
7629            None
7630        };
7631
7632        self.expect_keyword_is(Keyword::CURSOR)?;
7633        let declare_type = Some(DeclareType::Cursor);
7634
7635        let hold = match self.parse_one_of_keywords(&[Keyword::WITH, Keyword::WITHOUT]) {
7636            Some(keyword) => {
7637                self.expect_keyword_is(Keyword::HOLD)?;
7638
7639                match keyword {
7640                    Keyword::WITH => Some(true),
7641                    Keyword::WITHOUT => Some(false),
7642                    unexpected_keyword => return Err(ParserError::ParserError(
7643                        format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in cursor hold"),
7644                    )),
7645                }
7646            }
7647            None => None,
7648        };
7649
7650        self.expect_keyword_is(Keyword::FOR)?;
7651
7652        let query = Some(self.parse_query()?);
7653
7654        Ok(Statement::Declare {
7655            stmts: vec![Declare {
7656                names: vec![name],
7657                data_type: None,
7658                assignment: None,
7659                declare_type,
7660                binary,
7661                sensitive,
7662                scroll,
7663                hold,
7664                for_query: query,
7665            }],
7666        })
7667    }
7668
7669    /// Parse a [BigQuery] `DECLARE` statement.
7670    ///
7671    /// Syntax:
7672    /// ```text
7673    /// DECLARE variable_name[, ...] [{ <variable_type> | <DEFAULT expression> }];
7674    /// ```
7675    /// [BigQuery]: https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#declare
7676    pub fn parse_big_query_declare(&mut self) -> Result<Statement, ParserError> {
7677        let names = self.parse_comma_separated(Parser::parse_identifier)?;
7678
7679        let data_type = match &self.peek_token_ref().token {
7680            Token::Word(w) if w.keyword == Keyword::DEFAULT => None,
7681            _ => Some(self.parse_data_type()?),
7682        };
7683
7684        let expr = if data_type.is_some() {
7685            if self.parse_keyword(Keyword::DEFAULT) {
7686                Some(self.parse_expr()?)
7687            } else {
7688                None
7689            }
7690        } else {
7691            // If no variable type - default expression must be specified, per BQ docs.
7692            // i.e `DECLARE foo;` is invalid.
7693            self.expect_keyword_is(Keyword::DEFAULT)?;
7694            Some(self.parse_expr()?)
7695        };
7696
7697        Ok(Statement::Declare {
7698            stmts: vec![Declare {
7699                names,
7700                data_type,
7701                assignment: expr.map(|expr| DeclareAssignment::Default(Box::new(expr))),
7702                declare_type: None,
7703                binary: None,
7704                sensitive: None,
7705                scroll: None,
7706                hold: None,
7707                for_query: None,
7708            }],
7709        })
7710    }
7711
7712    /// Parse a [Snowflake] `DECLARE` statement.
7713    ///
7714    /// Syntax:
7715    /// ```text
7716    /// DECLARE
7717    ///   [{ <variable_declaration>
7718    ///      | <cursor_declaration>
7719    ///      | <resultset_declaration>
7720    ///      | <exception_declaration> }; ... ]
7721    ///
7722    /// <variable_declaration>
7723    /// <variable_name> [<type>] [ { DEFAULT | := } <expression>]
7724    ///
7725    /// <cursor_declaration>
7726    /// <cursor_name> CURSOR FOR <query>
7727    ///
7728    /// <resultset_declaration>
7729    /// <resultset_name> RESULTSET [ { DEFAULT | := } ( <query> ) ] ;
7730    ///
7731    /// <exception_declaration>
7732    /// <exception_name> EXCEPTION [ ( <exception_number> , '<exception_message>' ) ] ;
7733    /// ```
7734    ///
7735    /// [Snowflake]: https://docs.snowflake.com/en/sql-reference/snowflake-scripting/declare
7736    pub fn parse_snowflake_declare(&mut self) -> Result<Statement, ParserError> {
7737        let mut stmts = vec![];
7738        loop {
7739            let name = self.parse_identifier()?;
7740            let (declare_type, for_query, assigned_expr, data_type) =
7741                if self.parse_keyword(Keyword::CURSOR) {
7742                    self.expect_keyword_is(Keyword::FOR)?;
7743                    match &self.peek_token_ref().token {
7744                        Token::Word(w) if w.keyword == Keyword::SELECT => (
7745                            Some(DeclareType::Cursor),
7746                            Some(self.parse_query()?),
7747                            None,
7748                            None,
7749                        ),
7750                        _ => (
7751                            Some(DeclareType::Cursor),
7752                            None,
7753                            Some(DeclareAssignment::For(Box::new(self.parse_expr()?))),
7754                            None,
7755                        ),
7756                    }
7757                } else if self.parse_keyword(Keyword::RESULTSET) {
7758                    let assigned_expr = if self.peek_token_ref().token != Token::SemiColon {
7759                        self.parse_snowflake_variable_declaration_expression()?
7760                    } else {
7761                        // Nothing more to do. The statement has no further parameters.
7762                        None
7763                    };
7764
7765                    (Some(DeclareType::ResultSet), None, assigned_expr, None)
7766                } else if self.parse_keyword(Keyword::EXCEPTION) {
7767                    let assigned_expr = if self.peek_token_ref().token == Token::LParen {
7768                        Some(DeclareAssignment::Expr(Box::new(self.parse_expr()?)))
7769                    } else {
7770                        // Nothing more to do. The statement has no further parameters.
7771                        None
7772                    };
7773
7774                    (Some(DeclareType::Exception), None, assigned_expr, None)
7775                } else {
7776                    // Without an explicit keyword, the only valid option is variable declaration.
7777                    let (assigned_expr, data_type) = if let Some(assigned_expr) =
7778                        self.parse_snowflake_variable_declaration_expression()?
7779                    {
7780                        (Some(assigned_expr), None)
7781                    } else if let Token::Word(_) = &self.peek_token_ref().token {
7782                        let data_type = self.parse_data_type()?;
7783                        (
7784                            self.parse_snowflake_variable_declaration_expression()?,
7785                            Some(data_type),
7786                        )
7787                    } else {
7788                        (None, None)
7789                    };
7790                    (None, None, assigned_expr, data_type)
7791                };
7792            let stmt = Declare {
7793                names: vec![name],
7794                data_type,
7795                assignment: assigned_expr,
7796                declare_type,
7797                binary: None,
7798                sensitive: None,
7799                scroll: None,
7800                hold: None,
7801                for_query,
7802            };
7803
7804            stmts.push(stmt);
7805            if self.consume_token(&Token::SemiColon) {
7806                match &self.peek_token_ref().token {
7807                    Token::Word(w)
7808                        if ALL_KEYWORDS
7809                            .binary_search(&w.value.to_uppercase().as_str())
7810                            .is_err() =>
7811                    {
7812                        // Not a keyword - start of a new declaration.
7813                        continue;
7814                    }
7815                    _ => {
7816                        // Put back the semicolon, this is the end of the DECLARE statement.
7817                        self.prev_token();
7818                    }
7819                }
7820            }
7821
7822            break;
7823        }
7824
7825        Ok(Statement::Declare { stmts })
7826    }
7827
7828    /// Parse a [MsSql] `DECLARE` statement.
7829    ///
7830    /// Syntax:
7831    /// ```text
7832    /// DECLARE
7833    // {
7834    //   { @local_variable [AS] data_type [ = value ] }
7835    //   | { @cursor_variable_name CURSOR [ FOR ] }
7836    // } [ ,...n ]
7837    /// ```
7838    /// [MsSql]: https://learn.microsoft.com/en-us/sql/t-sql/language-elements/declare-local-variable-transact-sql?view=sql-server-ver16
7839    pub fn parse_mssql_declare(&mut self) -> Result<Statement, ParserError> {
7840        let stmts = self.parse_comma_separated(Parser::parse_mssql_declare_stmt)?;
7841
7842        Ok(Statement::Declare { stmts })
7843    }
7844
7845    /// Parse the body of a [MsSql] `DECLARE`statement.
7846    ///
7847    /// Syntax:
7848    /// ```text
7849    // {
7850    //   { @local_variable [AS] data_type [ = value ] }
7851    //   | { @cursor_variable_name CURSOR [ FOR ]}
7852    // } [ ,...n ]
7853    /// ```
7854    /// [MsSql]: https://learn.microsoft.com/en-us/sql/t-sql/language-elements/declare-local-variable-transact-sql?view=sql-server-ver16
7855    pub fn parse_mssql_declare_stmt(&mut self) -> Result<Declare, ParserError> {
7856        let name = {
7857            let ident = self.parse_identifier()?;
7858            if !ident.value.starts_with('@')
7859                && !matches!(
7860                    &self.peek_token_ref().token,
7861                    Token::Word(w) if w.keyword == Keyword::CURSOR
7862                )
7863            {
7864                Err(ParserError::TokenizerError(
7865                    "Invalid MsSql variable declaration.".to_string(),
7866                ))
7867            } else {
7868                Ok(ident)
7869            }
7870        }?;
7871
7872        let (declare_type, data_type) = match &self.peek_token_ref().token {
7873            Token::Word(w) => match w.keyword {
7874                Keyword::CURSOR => {
7875                    self.next_token();
7876                    (Some(DeclareType::Cursor), None)
7877                }
7878                Keyword::AS => {
7879                    self.next_token();
7880                    (None, Some(self.parse_data_type()?))
7881                }
7882                _ => (None, Some(self.parse_data_type()?)),
7883            },
7884            _ => (None, Some(self.parse_data_type()?)),
7885        };
7886
7887        let (for_query, assignment) = if self.peek_keyword(Keyword::FOR) {
7888            self.next_token();
7889            let query = Some(self.parse_query()?);
7890            (query, None)
7891        } else {
7892            let assignment = self.parse_mssql_variable_declaration_expression()?;
7893            (None, assignment)
7894        };
7895
7896        Ok(Declare {
7897            names: vec![name],
7898            data_type,
7899            assignment,
7900            declare_type,
7901            binary: None,
7902            sensitive: None,
7903            scroll: None,
7904            hold: None,
7905            for_query,
7906        })
7907    }
7908
7909    /// Parses the assigned expression in a variable declaration.
7910    ///
7911    /// Syntax:
7912    /// ```text
7913    /// [ { DEFAULT | := } <expression>]
7914    /// ```
7915    /// <https://docs.snowflake.com/en/sql-reference/snowflake-scripting/declare#variable-declaration-syntax>
7916    pub fn parse_snowflake_variable_declaration_expression(
7917        &mut self,
7918    ) -> Result<Option<DeclareAssignment>, ParserError> {
7919        Ok(match &self.peek_token_ref().token {
7920            Token::Word(w) if w.keyword == Keyword::DEFAULT => {
7921                self.next_token(); // Skip `DEFAULT`
7922                Some(DeclareAssignment::Default(Box::new(self.parse_expr()?)))
7923            }
7924            Token::Assignment => {
7925                self.next_token(); // Skip `:=`
7926                Some(DeclareAssignment::DuckAssignment(Box::new(
7927                    self.parse_expr()?,
7928                )))
7929            }
7930            _ => None,
7931        })
7932    }
7933
7934    /// Parses the assigned expression in a variable declaration.
7935    ///
7936    /// Syntax:
7937    /// ```text
7938    /// [ = <expression>]
7939    /// ```
7940    pub fn parse_mssql_variable_declaration_expression(
7941        &mut self,
7942    ) -> Result<Option<DeclareAssignment>, ParserError> {
7943        Ok(match &self.peek_token_ref().token {
7944            Token::Eq => {
7945                self.next_token(); // Skip `=`
7946                Some(DeclareAssignment::MsSqlAssignment(Box::new(
7947                    self.parse_expr()?,
7948                )))
7949            }
7950            _ => None,
7951        })
7952    }
7953
7954    /// Parse `FETCH [direction] { FROM | IN } cursor INTO target;` statement.
7955    pub fn parse_fetch_statement(&mut self) -> Result<Statement, ParserError> {
7956        let direction = if self.parse_keyword(Keyword::NEXT) {
7957            FetchDirection::Next
7958        } else if self.parse_keyword(Keyword::PRIOR) {
7959            FetchDirection::Prior
7960        } else if self.parse_keyword(Keyword::FIRST) {
7961            FetchDirection::First
7962        } else if self.parse_keyword(Keyword::LAST) {
7963            FetchDirection::Last
7964        } else if self.parse_keyword(Keyword::ABSOLUTE) {
7965            FetchDirection::Absolute {
7966                limit: self.parse_number_value()?,
7967            }
7968        } else if self.parse_keyword(Keyword::RELATIVE) {
7969            FetchDirection::Relative {
7970                limit: self.parse_number_value()?,
7971            }
7972        } else if self.parse_keyword(Keyword::FORWARD) {
7973            if self.parse_keyword(Keyword::ALL) {
7974                FetchDirection::ForwardAll
7975            } else {
7976                FetchDirection::Forward {
7977                    // TODO: Support optional
7978                    limit: Some(self.parse_number_value()?),
7979                }
7980            }
7981        } else if self.parse_keyword(Keyword::BACKWARD) {
7982            if self.parse_keyword(Keyword::ALL) {
7983                FetchDirection::BackwardAll
7984            } else {
7985                FetchDirection::Backward {
7986                    // TODO: Support optional
7987                    limit: Some(self.parse_number_value()?),
7988                }
7989            }
7990        } else if self.parse_keyword(Keyword::ALL) {
7991            FetchDirection::All
7992        } else {
7993            FetchDirection::Count {
7994                limit: self.parse_number_value()?,
7995            }
7996        };
7997
7998        let position = if self.peek_keyword(Keyword::FROM) {
7999            self.expect_keyword(Keyword::FROM)?;
8000            FetchPosition::From
8001        } else if self.peek_keyword(Keyword::IN) {
8002            self.expect_keyword(Keyword::IN)?;
8003            FetchPosition::In
8004        } else {
8005            return parser_err!("Expected FROM or IN", self.peek_token_ref().span.start);
8006        };
8007
8008        let name = self.parse_identifier()?;
8009
8010        let into = if self.parse_keyword(Keyword::INTO) {
8011            Some(self.parse_object_name(false)?)
8012        } else {
8013            None
8014        };
8015
8016        Ok(Statement::Fetch {
8017            name,
8018            direction,
8019            position,
8020            into,
8021        })
8022    }
8023
8024    /// Parse a `DISCARD` statement.
8025    pub fn parse_discard(&mut self) -> Result<Statement, ParserError> {
8026        let object_type = if self.parse_keyword(Keyword::ALL) {
8027            DiscardObject::ALL
8028        } else if self.parse_keyword(Keyword::PLANS) {
8029            DiscardObject::PLANS
8030        } else if self.parse_keyword(Keyword::SEQUENCES) {
8031            DiscardObject::SEQUENCES
8032        } else if self.parse_keyword(Keyword::TEMP) || self.parse_keyword(Keyword::TEMPORARY) {
8033            DiscardObject::TEMP
8034        } else {
8035            return self.expected_ref(
8036                "ALL, PLANS, SEQUENCES, TEMP or TEMPORARY after DISCARD",
8037                self.peek_token_ref(),
8038            );
8039        };
8040        Ok(Statement::Discard { object_type })
8041    }
8042
8043    /// Parse a `CREATE INDEX` statement.
8044    pub fn parse_create_index(&mut self, unique: bool) -> Result<CreateIndex, ParserError> {
8045        let concurrently = self.parse_keyword(Keyword::CONCURRENTLY);
8046        let r#async = self.parse_keyword(Keyword::ASYNC);
8047        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
8048
8049        let mut using = None;
8050
8051        let index_name = if if_not_exists || !self.parse_keyword(Keyword::ON) {
8052            let index_name = self.parse_object_name(false)?;
8053            // MySQL allows `USING index_type` either before or after `ON table_name`
8054            using = self.parse_optional_using_then_index_type()?;
8055            self.expect_keyword_is(Keyword::ON)?;
8056            Some(index_name)
8057        } else {
8058            None
8059        };
8060
8061        let table_name = self.parse_object_name(false)?;
8062
8063        // MySQL allows having two `USING` clauses.
8064        // In that case, the second clause overwrites the first.
8065        using = self.parse_optional_using_then_index_type()?.or(using);
8066
8067        let columns = self.parse_parenthesized_index_column_list()?;
8068
8069        let include = if self.parse_keyword(Keyword::INCLUDE) {
8070            self.expect_token(&Token::LParen)?;
8071            let columns = self.parse_comma_separated(|p| p.parse_identifier())?;
8072            self.expect_token(&Token::RParen)?;
8073            columns
8074        } else {
8075            vec![]
8076        };
8077
8078        let nulls_distinct = if self.parse_keyword(Keyword::NULLS) {
8079            let not = self.parse_keyword(Keyword::NOT);
8080            self.expect_keyword_is(Keyword::DISTINCT)?;
8081            Some(!not)
8082        } else {
8083            None
8084        };
8085
8086        let with = if self.dialect.supports_create_index_with_clause()
8087            && self.parse_keyword(Keyword::WITH)
8088        {
8089            self.expect_token(&Token::LParen)?;
8090            let with_params = self.parse_comma_separated(Parser::parse_expr)?;
8091            self.expect_token(&Token::RParen)?;
8092            with_params
8093        } else {
8094            Vec::new()
8095        };
8096
8097        let predicate = if self.parse_keyword(Keyword::WHERE) {
8098            Some(self.parse_expr()?)
8099        } else {
8100            None
8101        };
8102
8103        // MySQL options (including the modern style of `USING` after the column list instead of
8104        // before, which is deprecated) shouldn't conflict with other preceding options (e.g. `WITH
8105        // PARSER` won't be caught by the above `WITH` clause parsing because MySQL doesn't set that
8106        // support flag). This is probably invalid syntax for other dialects, but it is simpler to
8107        // parse it anyway (as we do inside `ALTER TABLE` and `CREATE TABLE` parsing).
8108        let index_options = self.parse_index_options()?;
8109
8110        // MySQL allows `ALGORITHM` and `LOCK` options. Unlike in `ALTER TABLE`, they need not be comma separated.
8111        let mut alter_options = Vec::new();
8112        while self
8113            .peek_one_of_keywords(&[Keyword::ALGORITHM, Keyword::LOCK])
8114            .is_some()
8115        {
8116            alter_options.push(self.parse_alter_table_operation()?)
8117        }
8118
8119        Ok(CreateIndex {
8120            name: index_name,
8121            table_name,
8122            using,
8123            columns,
8124            unique,
8125            concurrently,
8126            r#async,
8127            if_not_exists,
8128            include,
8129            nulls_distinct,
8130            with,
8131            predicate,
8132            index_options,
8133            alter_options,
8134        })
8135    }
8136
8137    /// Parse a `CREATE EXTENSION` statement.
8138    pub fn parse_create_extension(&mut self) -> Result<CreateExtension, ParserError> {
8139        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
8140        let name = self.parse_identifier()?;
8141
8142        let (schema, version, cascade) = if self.parse_keyword(Keyword::WITH) {
8143            let schema = if self.parse_keyword(Keyword::SCHEMA) {
8144                Some(self.parse_identifier()?)
8145            } else {
8146                None
8147            };
8148
8149            let version = if self.parse_keyword(Keyword::VERSION) {
8150                Some(self.parse_identifier()?)
8151            } else {
8152                None
8153            };
8154
8155            let cascade = self.parse_keyword(Keyword::CASCADE);
8156
8157            (schema, version, cascade)
8158        } else {
8159            (None, None, false)
8160        };
8161
8162        Ok(CreateExtension {
8163            name,
8164            if_not_exists,
8165            schema,
8166            version,
8167            cascade,
8168        })
8169    }
8170
8171    /// Parse a PostgreSQL-specific [Statement::CreateCollation] statement.
8172    pub fn parse_create_collation(&mut self) -> Result<CreateCollation, ParserError> {
8173        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
8174        let name = self.parse_object_name(false)?;
8175
8176        let definition = if self.parse_keyword(Keyword::FROM) {
8177            CreateCollationDefinition::From(self.parse_object_name(false)?)
8178        } else if self.consume_token(&Token::LParen) {
8179            let options = self.parse_comma_separated(Parser::parse_sql_option)?;
8180            self.expect_token(&Token::RParen)?;
8181            CreateCollationDefinition::Options(options)
8182        } else {
8183            return self.expected_ref(
8184                "FROM or parenthesized option list after CREATE COLLATION name",
8185                self.peek_token_ref(),
8186            );
8187        };
8188
8189        Ok(CreateCollation {
8190            if_not_exists,
8191            name,
8192            definition,
8193        })
8194    }
8195
8196    /// Parse a PostgreSQL-specific [Statement::DropExtension] statement.
8197    pub fn parse_drop_extension(&mut self) -> Result<Statement, ParserError> {
8198        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
8199        let names = self.parse_comma_separated(|p| p.parse_identifier())?;
8200        let cascade_or_restrict =
8201            self.parse_one_of_keywords(&[Keyword::CASCADE, Keyword::RESTRICT]);
8202        Ok(Statement::DropExtension(DropExtension {
8203            names,
8204            if_exists,
8205            cascade_or_restrict: cascade_or_restrict
8206                .map(|k| match k {
8207                    Keyword::CASCADE => Ok(ReferentialAction::Cascade),
8208                    Keyword::RESTRICT => Ok(ReferentialAction::Restrict),
8209                    _ => self.expected_ref("CASCADE or RESTRICT", self.peek_token_ref()),
8210                })
8211                .transpose()?,
8212        }))
8213    }
8214
8215    /// Parse a[Statement::DropOperator] statement.
8216    ///
8217    pub fn parse_drop_operator(&mut self) -> Result<Statement, ParserError> {
8218        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
8219        let operators = self.parse_comma_separated(|p| p.parse_drop_operator_signature())?;
8220        let drop_behavior = self.parse_optional_drop_behavior();
8221        Ok(Statement::DropOperator(DropOperator {
8222            if_exists,
8223            operators,
8224            drop_behavior,
8225        }))
8226    }
8227
8228    /// Parse an operator signature for a [Statement::DropOperator]
8229    /// Format: `name ( { left_type | NONE } , right_type )`
8230    fn parse_drop_operator_signature(&mut self) -> Result<DropOperatorSignature, ParserError> {
8231        let name = self.parse_operator_name()?;
8232        self.expect_token(&Token::LParen)?;
8233
8234        // Parse left operand type (or NONE for prefix operators)
8235        let left_type = if self.parse_keyword(Keyword::NONE) {
8236            None
8237        } else {
8238            Some(self.parse_data_type()?)
8239        };
8240
8241        self.expect_token(&Token::Comma)?;
8242
8243        // Parse right operand type (always required)
8244        let right_type = self.parse_data_type()?;
8245
8246        self.expect_token(&Token::RParen)?;
8247
8248        Ok(DropOperatorSignature {
8249            name,
8250            left_type,
8251            right_type,
8252        })
8253    }
8254
8255    /// Parse a [Statement::DropOperatorFamily]
8256    ///
8257    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-dropopfamily.html)
8258    pub fn parse_drop_operator_family(&mut self) -> Result<Statement, ParserError> {
8259        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
8260        let names = self.parse_comma_separated(|p| p.parse_object_name(false))?;
8261        self.expect_keyword(Keyword::USING)?;
8262        let using = self.parse_identifier()?;
8263        let drop_behavior = self.parse_optional_drop_behavior();
8264        Ok(Statement::DropOperatorFamily(DropOperatorFamily {
8265            if_exists,
8266            names,
8267            using,
8268            drop_behavior,
8269        }))
8270    }
8271
8272    /// Parse a [Statement::DropOperatorClass]
8273    ///
8274    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-dropopclass.html)
8275    pub fn parse_drop_operator_class(&mut self) -> Result<Statement, ParserError> {
8276        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
8277        let names = self.parse_comma_separated(|p| p.parse_object_name(false))?;
8278        self.expect_keyword(Keyword::USING)?;
8279        let using = self.parse_identifier()?;
8280        let drop_behavior = self.parse_optional_drop_behavior();
8281        Ok(Statement::DropOperatorClass(DropOperatorClass {
8282            if_exists,
8283            names,
8284            using,
8285            drop_behavior,
8286        }))
8287    }
8288
8289    /// Parse Hive distribution style.
8290    ///
8291    /// TODO: Support parsing for `SKEWED` distribution style.
8292    pub fn parse_hive_distribution(&mut self) -> Result<HiveDistributionStyle, ParserError> {
8293        if self.parse_keywords(&[Keyword::PARTITIONED, Keyword::BY]) {
8294            self.expect_token(&Token::LParen)?;
8295            let columns =
8296                self.parse_comma_separated(|parser| parser.parse_column_def_inner(true))?;
8297            self.expect_token(&Token::RParen)?;
8298            Ok(HiveDistributionStyle::PARTITIONED { columns })
8299        } else {
8300            Ok(HiveDistributionStyle::NONE)
8301        }
8302    }
8303
8304    /// Parse Redshift `DISTSTYLE { AUTO | EVEN | KEY | ALL }`.
8305    ///
8306    /// See <https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_TABLE_NEW.html>
8307    fn parse_dist_style(&mut self) -> Result<DistStyle, ParserError> {
8308        let token = self.next_token();
8309        match &token.token {
8310            Token::Word(w) => match w.keyword {
8311                Keyword::AUTO => Ok(DistStyle::Auto),
8312                Keyword::EVEN => Ok(DistStyle::Even),
8313                Keyword::KEY => Ok(DistStyle::Key),
8314                Keyword::ALL => Ok(DistStyle::All),
8315                _ => self.expected("AUTO, EVEN, KEY, or ALL", token),
8316            },
8317            _ => self.expected("AUTO, EVEN, KEY, or ALL", token),
8318        }
8319    }
8320
8321    /// Parse Hive formats.
8322    pub fn parse_hive_formats(&mut self) -> Result<Option<HiveFormat>, ParserError> {
8323        let mut hive_format: Option<HiveFormat> = None;
8324        loop {
8325            match self.parse_one_of_keywords(&[
8326                Keyword::ROW,
8327                Keyword::STORED,
8328                Keyword::LOCATION,
8329                Keyword::WITH,
8330                Keyword::USING,
8331            ]) {
8332                Some(Keyword::ROW) => {
8333                    hive_format
8334                        .get_or_insert_with(HiveFormat::default)
8335                        .row_format = Some(self.parse_row_format()?);
8336                }
8337                Some(Keyword::STORED) => {
8338                    self.expect_keyword_is(Keyword::AS)?;
8339                    if self.parse_keyword(Keyword::INPUTFORMAT) {
8340                        let input_format = self.parse_expr()?;
8341                        self.expect_keyword_is(Keyword::OUTPUTFORMAT)?;
8342                        let output_format = self.parse_expr()?;
8343                        hive_format.get_or_insert_with(HiveFormat::default).storage =
8344                            Some(HiveIOFormat::IOF {
8345                                input_format,
8346                                output_format,
8347                            });
8348                    } else {
8349                        let format = self.parse_file_format()?;
8350                        hive_format.get_or_insert_with(HiveFormat::default).storage =
8351                            Some(HiveIOFormat::FileFormat { format });
8352                    }
8353                }
8354                Some(Keyword::LOCATION) => {
8355                    hive_format.get_or_insert_with(HiveFormat::default).location =
8356                        Some(self.parse_literal_string()?);
8357                }
8358                Some(Keyword::WITH) => {
8359                    self.prev_token();
8360                    let properties = self
8361                        .parse_options_with_keywords(&[Keyword::WITH, Keyword::SERDEPROPERTIES])?;
8362                    if !properties.is_empty() {
8363                        hive_format
8364                            .get_or_insert_with(HiveFormat::default)
8365                            .serde_properties = Some(properties);
8366                    } else {
8367                        break;
8368                    }
8369                }
8370                Some(Keyword::USING) if self.dialect.supports_create_table_using() => {
8371                    let format = self.parse_identifier()?;
8372                    hive_format.get_or_insert_with(HiveFormat::default).storage =
8373                        Some(HiveIOFormat::Using { format });
8374                }
8375                Some(Keyword::USING) => {
8376                    // USING is not a table format keyword in this dialect; put it back
8377                    self.prev_token();
8378                    break;
8379                }
8380                None => break,
8381                _ => break,
8382            }
8383        }
8384
8385        Ok(hive_format)
8386    }
8387
8388    /// Parse Hive row format.
8389    pub fn parse_row_format(&mut self) -> Result<HiveRowFormat, ParserError> {
8390        self.expect_keyword_is(Keyword::FORMAT)?;
8391        match self.parse_one_of_keywords(&[Keyword::SERDE, Keyword::DELIMITED]) {
8392            Some(Keyword::SERDE) => {
8393                let class = self.parse_literal_string()?;
8394                Ok(HiveRowFormat::SERDE { class })
8395            }
8396            _ => {
8397                let mut row_delimiters = vec![];
8398
8399                loop {
8400                    match self.parse_one_of_keywords(&[
8401                        Keyword::FIELDS,
8402                        Keyword::COLLECTION,
8403                        Keyword::MAP,
8404                        Keyword::LINES,
8405                        Keyword::NULL,
8406                    ]) {
8407                        Some(Keyword::FIELDS)
8408                            if self.parse_keywords(&[Keyword::TERMINATED, Keyword::BY]) =>
8409                        {
8410                            row_delimiters.push(HiveRowDelimiter {
8411                                delimiter: HiveDelimiter::FieldsTerminatedBy,
8412                                char: self.parse_identifier()?,
8413                            });
8414
8415                            if self.parse_keywords(&[Keyword::ESCAPED, Keyword::BY]) {
8416                                row_delimiters.push(HiveRowDelimiter {
8417                                    delimiter: HiveDelimiter::FieldsEscapedBy,
8418                                    char: self.parse_identifier()?,
8419                                });
8420                            }
8421                        }
8422                        Some(Keyword::COLLECTION)
8423                            if self.parse_keywords(&[
8424                                Keyword::ITEMS,
8425                                Keyword::TERMINATED,
8426                                Keyword::BY,
8427                            ]) =>
8428                        {
8429                            row_delimiters.push(HiveRowDelimiter {
8430                                delimiter: HiveDelimiter::CollectionItemsTerminatedBy,
8431                                char: self.parse_identifier()?,
8432                            });
8433                        }
8434                        Some(Keyword::MAP)
8435                            if self.parse_keywords(&[
8436                                Keyword::KEYS,
8437                                Keyword::TERMINATED,
8438                                Keyword::BY,
8439                            ]) =>
8440                        {
8441                            row_delimiters.push(HiveRowDelimiter {
8442                                delimiter: HiveDelimiter::MapKeysTerminatedBy,
8443                                char: self.parse_identifier()?,
8444                            });
8445                        }
8446                        Some(Keyword::LINES)
8447                            if self.parse_keywords(&[Keyword::TERMINATED, Keyword::BY]) =>
8448                        {
8449                            row_delimiters.push(HiveRowDelimiter {
8450                                delimiter: HiveDelimiter::LinesTerminatedBy,
8451                                char: self.parse_identifier()?,
8452                            });
8453                        }
8454                        Some(Keyword::NULL)
8455                            if self.parse_keywords(&[Keyword::DEFINED, Keyword::AS]) =>
8456                        {
8457                            row_delimiters.push(HiveRowDelimiter {
8458                                delimiter: HiveDelimiter::NullDefinedAs,
8459                                char: self.parse_identifier()?,
8460                            });
8461                        }
8462                        _ => {
8463                            break;
8464                        }
8465                    }
8466                }
8467
8468                Ok(HiveRowFormat::DELIMITED {
8469                    delimiters: row_delimiters,
8470                })
8471            }
8472        }
8473    }
8474
8475    fn parse_optional_on_cluster(&mut self) -> Result<Option<Ident>, ParserError> {
8476        if self.parse_keywords(&[Keyword::ON, Keyword::CLUSTER]) {
8477            Ok(Some(self.parse_identifier()?))
8478        } else {
8479            Ok(None)
8480        }
8481    }
8482
8483    /// Parse `CREATE TABLE` statement.
8484    pub fn parse_create_table(
8485        &mut self,
8486        or_replace: bool,
8487        temporary: bool,
8488        global: Option<bool>,
8489        transient: bool,
8490        volatile: bool,
8491        multiset: Option<bool>,
8492    ) -> Result<CreateTable, ParserError> {
8493        let allow_unquoted_hyphen = dialect_of!(self is BigQueryDialect);
8494        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
8495        let table_name = self.parse_object_name(allow_unquoted_hyphen)?;
8496
8497        let fallback = if self.dialect.supports_leading_comma_before_table_options()
8498            && self.consume_token(&Token::Comma)
8499        {
8500            let fallback = self.maybe_parse_fallback()?;
8501            if fallback.is_none() {
8502                self.prev_token(); // Put back comma.
8503            }
8504            fallback
8505        } else {
8506            None
8507        };
8508
8509        // PostgreSQL PARTITION OF for child partition tables
8510        // Note: This is a PostgreSQL-specific feature, but the dialect check was intentionally
8511        // removed to allow GenericDialect and other dialects to parse this syntax. This enables
8512        // multi-dialect SQL tools to work with PostgreSQL-specific DDL statements.
8513        //
8514        // PARTITION OF can be combined with other table definition clauses in the AST,
8515        // though PostgreSQL itself prohibits PARTITION OF with AS SELECT or LIKE clauses.
8516        // The parser accepts these combinations for flexibility; semantic validation
8517        // is left to downstream tools.
8518        // Child partitions can have their own constraints and indexes.
8519        let partition_of = if self.parse_keywords(&[Keyword::PARTITION, Keyword::OF]) {
8520            Some(self.parse_object_name(allow_unquoted_hyphen)?)
8521        } else {
8522            None
8523        };
8524
8525        // Clickhouse has `ON CLUSTER 'cluster'` syntax for DDLs
8526        let on_cluster = self.parse_optional_on_cluster()?;
8527
8528        let like = self.maybe_parse_create_table_like(allow_unquoted_hyphen)?;
8529
8530        let clone = if self.parse_keyword(Keyword::CLONE) {
8531            self.parse_object_name(allow_unquoted_hyphen).ok()
8532        } else {
8533            None
8534        };
8535
8536        // parse optional column list (schema)
8537        let (columns, constraints) = self.parse_columns()?;
8538        let comment_after_column_def =
8539            if dialect_of!(self is HiveDialect) && self.parse_keyword(Keyword::COMMENT) {
8540                let next_token = self.next_token();
8541                match next_token.token {
8542                    Token::SingleQuotedString(str) => Some(CommentDef::WithoutEq(str)),
8543                    _ => self.expected("comment", next_token)?,
8544                }
8545            } else {
8546                None
8547            };
8548
8549        // PostgreSQL PARTITION OF: partition bound specification
8550        let for_values = if partition_of.is_some() {
8551            if self.peek_keyword(Keyword::FOR) || self.peek_keyword(Keyword::DEFAULT) {
8552                Some(self.parse_partition_for_values()?)
8553            } else {
8554                return self.expected_ref(
8555                    "FOR VALUES or DEFAULT after PARTITION OF",
8556                    self.peek_token_ref(),
8557                );
8558            }
8559        } else {
8560            None
8561        };
8562
8563        // SQLite supports `WITHOUT ROWID` at the end of `CREATE TABLE`
8564        let without_rowid = self.parse_keywords(&[Keyword::WITHOUT, Keyword::ROWID]);
8565
8566        let hive_distribution = self.parse_hive_distribution()?;
8567        let clustered_by = self.parse_optional_clustered_by()?;
8568        let hive_formats = self.parse_hive_formats()?;
8569
8570        let create_table_config = self.parse_optional_create_table_config()?;
8571
8572        // ClickHouse supports `PRIMARY KEY`, before `ORDER BY`
8573        // https://clickhouse.com/docs/en/sql-reference/statements/create/table#primary-key
8574        let primary_key = if dialect_of!(self is ClickHouseDialect | GenericDialect)
8575            && self.parse_keywords(&[Keyword::PRIMARY, Keyword::KEY])
8576        {
8577            Some(Box::new(self.parse_expr()?))
8578        } else {
8579            None
8580        };
8581
8582        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
8583            if self.consume_token(&Token::LParen) {
8584                let columns = if self.peek_token_ref().token != Token::RParen {
8585                    self.parse_comma_separated(|p| p.parse_expr())?
8586                } else {
8587                    vec![]
8588                };
8589                self.expect_token(&Token::RParen)?;
8590                Some(OneOrManyWithParens::Many(columns))
8591            } else {
8592                Some(OneOrManyWithParens::One(self.parse_expr()?))
8593            }
8594        } else {
8595            None
8596        };
8597
8598        // ClickHouse allows PARTITION BY after ORDER BY
8599        // https://clickhouse.com/docs/en/sql-reference/statements/create/table#partition-by
8600        let partition_by = if create_table_config.partition_by.is_none()
8601            && self.dialect.supports_partition_by_after_order_by()
8602            && self.parse_keywords(&[Keyword::PARTITION, Keyword::BY])
8603        {
8604            Some(Box::new(self.parse_expr()?))
8605        } else {
8606            create_table_config.partition_by
8607        };
8608
8609        let on_commit = if self.parse_keywords(&[Keyword::ON, Keyword::COMMIT]) {
8610            Some(self.parse_create_table_on_commit()?)
8611        } else {
8612            None
8613        };
8614
8615        let strict = self.parse_keyword(Keyword::STRICT);
8616
8617        // Redshift: BACKUP YES|NO
8618        let backup = if self.parse_keyword(Keyword::BACKUP) {
8619            let keyword = self.expect_one_of_keywords(&[Keyword::YES, Keyword::NO])?;
8620            Some(keyword == Keyword::YES)
8621        } else {
8622            None
8623        };
8624
8625        // Redshift: DISTSTYLE, DISTKEY, SORTKEY
8626        let diststyle = if self.parse_keyword(Keyword::DISTSTYLE) {
8627            Some(self.parse_dist_style()?)
8628        } else {
8629            None
8630        };
8631        let distkey = if self.parse_keyword(Keyword::DISTKEY) {
8632            self.expect_token(&Token::LParen)?;
8633            let expr = self.parse_expr()?;
8634            self.expect_token(&Token::RParen)?;
8635            Some(expr)
8636        } else {
8637            None
8638        };
8639        let sortkey = if self.parse_keyword(Keyword::SORTKEY) {
8640            self.expect_token(&Token::LParen)?;
8641            let columns = self.parse_comma_separated(|p| p.parse_expr())?;
8642            self.expect_token(&Token::RParen)?;
8643            Some(columns)
8644        } else {
8645            None
8646        };
8647
8648        // Parse optional `AS ( query )`
8649        let query = if self.parse_keyword(Keyword::AS) {
8650            Some(self.parse_query()?)
8651        } else if self.dialect.supports_create_table_select() && self.parse_keyword(Keyword::SELECT)
8652        {
8653            // rewind the SELECT keyword
8654            self.prev_token();
8655            Some(self.parse_query()?)
8656        } else {
8657            None
8658        };
8659
8660        // `WITH DATA` clause only applies if there is a query body.
8661        let with_data = if query.is_some() {
8662            self.maybe_parse_with_data()?
8663        } else {
8664            None
8665        };
8666
8667        Ok(CreateTableBuilder::new(table_name)
8668            .temporary(temporary)
8669            .columns(columns)
8670            .constraints(constraints)
8671            .or_replace(or_replace)
8672            .if_not_exists(if_not_exists)
8673            .transient(transient)
8674            .volatile(volatile)
8675            .multiset(multiset)
8676            .fallback(fallback)
8677            .hive_distribution(hive_distribution)
8678            .hive_formats(hive_formats)
8679            .global(global)
8680            .query(query)
8681            .without_rowid(without_rowid)
8682            .like(like)
8683            .clone_clause(clone)
8684            .comment_after_column_def(comment_after_column_def)
8685            .order_by(order_by)
8686            .on_commit(on_commit)
8687            .on_cluster(on_cluster)
8688            .clustered_by(clustered_by)
8689            .partition_by(partition_by)
8690            .cluster_by(create_table_config.cluster_by)
8691            .inherits(create_table_config.inherits)
8692            .partition_of(partition_of)
8693            .for_values(for_values)
8694            .table_options(create_table_config.table_options)
8695            .primary_key(primary_key)
8696            .with_data(with_data)
8697            .strict(strict)
8698            .backup(backup)
8699            .diststyle(diststyle)
8700            .distkey(distkey)
8701            .sortkey(sortkey)
8702            .build())
8703    }
8704
8705    /// Parse `MULTISET` table-kind prefix on `CREATE TABLE`.
8706    fn maybe_parse_multiset(&mut self) -> Option<bool> {
8707        match self.parse_one_of_keywords(&[Keyword::SET, Keyword::MULTISET]) {
8708            Some(Keyword::MULTISET) => Some(true),
8709            Some(Keyword::SET) => Some(false),
8710            _ => None,
8711        }
8712    }
8713
8714    /// Parse `FALLBACK` option on a `CREATE TABLE` statement,
8715    fn maybe_parse_fallback(&mut self) -> Result<Option<bool>, ParserError> {
8716        if self.parse_keywords(&[Keyword::NO, Keyword::FALLBACK]) {
8717            Ok(Some(false))
8718        } else if self.parse_keyword(Keyword::FALLBACK) {
8719            Ok(Some(true))
8720        } else {
8721            Ok(None)
8722        }
8723    }
8724
8725    /// Parse [`WithData`] clause on `CREATE TABLE ... AS` statement.
8726    fn maybe_parse_with_data(&mut self) -> Result<Option<WithData>, ParserError> {
8727        let data = if self.parse_keywords(&[Keyword::WITH, Keyword::DATA]) {
8728            true
8729        } else if self.parse_keywords(&[Keyword::WITH, Keyword::NO, Keyword::DATA]) {
8730            false
8731        } else {
8732            return Ok(None);
8733        };
8734
8735        let statistics = if self.parse_keywords(&[Keyword::AND, Keyword::STATISTICS]) {
8736            Some(true)
8737        } else if self.parse_keywords(&[Keyword::AND, Keyword::NO, Keyword::STATISTICS]) {
8738            Some(false)
8739        } else {
8740            None
8741        };
8742
8743        Ok(Some(WithData { data, statistics }))
8744    }
8745
8746    fn maybe_parse_create_table_like(
8747        &mut self,
8748        allow_unquoted_hyphen: bool,
8749    ) -> Result<Option<CreateTableLikeKind>, ParserError> {
8750        let like = if self.dialect.supports_create_table_like_parenthesized()
8751            && self.consume_token(&Token::LParen)
8752        {
8753            if self.parse_keyword(Keyword::LIKE) {
8754                let name = self.parse_object_name(allow_unquoted_hyphen)?;
8755                let defaults = if self.parse_keywords(&[Keyword::INCLUDING, Keyword::DEFAULTS]) {
8756                    Some(CreateTableLikeDefaults::Including)
8757                } else if self.parse_keywords(&[Keyword::EXCLUDING, Keyword::DEFAULTS]) {
8758                    Some(CreateTableLikeDefaults::Excluding)
8759                } else {
8760                    None
8761                };
8762                self.expect_token(&Token::RParen)?;
8763                Some(CreateTableLikeKind::Parenthesized(CreateTableLike {
8764                    name,
8765                    defaults,
8766                }))
8767            } else {
8768                // Rollback the '(' it's probably the columns list
8769                self.prev_token();
8770                None
8771            }
8772        } else if self.parse_keyword(Keyword::LIKE) || self.parse_keyword(Keyword::ILIKE) {
8773            let name = self.parse_object_name(allow_unquoted_hyphen)?;
8774            Some(CreateTableLikeKind::Plain(CreateTableLike {
8775                name,
8776                defaults: None,
8777            }))
8778        } else {
8779            None
8780        };
8781        Ok(like)
8782    }
8783
8784    pub(crate) fn parse_create_table_on_commit(&mut self) -> Result<OnCommit, ParserError> {
8785        if self.parse_keywords(&[Keyword::DELETE, Keyword::ROWS]) {
8786            Ok(OnCommit::DeleteRows)
8787        } else if self.parse_keywords(&[Keyword::PRESERVE, Keyword::ROWS]) {
8788            Ok(OnCommit::PreserveRows)
8789        } else if self.parse_keywords(&[Keyword::DROP]) {
8790            Ok(OnCommit::Drop)
8791        } else {
8792            parser_err!(
8793                "Expecting DELETE ROWS, PRESERVE ROWS or DROP",
8794                self.peek_token_ref()
8795            )
8796        }
8797    }
8798
8799    /// Parse [ForValues] of a `PARTITION OF` clause.
8800    ///
8801    /// Parses: `FOR VALUES partition_bound_spec | DEFAULT`
8802    ///
8803    /// [PostgreSQL](https://www.postgresql.org/docs/current/sql-createtable.html)
8804    fn parse_partition_for_values(&mut self) -> Result<ForValues, ParserError> {
8805        if self.parse_keyword(Keyword::DEFAULT) {
8806            return Ok(ForValues::Default);
8807        }
8808
8809        self.expect_keywords(&[Keyword::FOR, Keyword::VALUES])?;
8810
8811        if self.parse_keyword(Keyword::IN) {
8812            // FOR VALUES IN (expr, ...)
8813            self.expect_token(&Token::LParen)?;
8814            if self.peek_token_ref().token == Token::RParen {
8815                return self.expected_ref("at least one value", self.peek_token_ref());
8816            }
8817            let values = self.parse_comma_separated(Parser::parse_expr)?;
8818            self.expect_token(&Token::RParen)?;
8819            Ok(ForValues::In(values))
8820        } else if self.parse_keyword(Keyword::FROM) {
8821            // FOR VALUES FROM (...) TO (...)
8822            self.expect_token(&Token::LParen)?;
8823            if self.peek_token_ref().token == Token::RParen {
8824                return self.expected_ref("at least one value", self.peek_token_ref());
8825            }
8826            let from = self.parse_comma_separated(Parser::parse_partition_bound_value)?;
8827            self.expect_token(&Token::RParen)?;
8828            self.expect_keyword(Keyword::TO)?;
8829            self.expect_token(&Token::LParen)?;
8830            if self.peek_token_ref().token == Token::RParen {
8831                return self.expected_ref("at least one value", self.peek_token_ref());
8832            }
8833            let to = self.parse_comma_separated(Parser::parse_partition_bound_value)?;
8834            self.expect_token(&Token::RParen)?;
8835            Ok(ForValues::From { from, to })
8836        } else if self.parse_keyword(Keyword::WITH) {
8837            // FOR VALUES WITH (MODULUS n, REMAINDER r)
8838            self.expect_token(&Token::LParen)?;
8839            self.expect_keyword(Keyword::MODULUS)?;
8840            let modulus = self.parse_literal_uint()?;
8841            self.expect_token(&Token::Comma)?;
8842            self.expect_keyword(Keyword::REMAINDER)?;
8843            let remainder = self.parse_literal_uint()?;
8844            self.expect_token(&Token::RParen)?;
8845            Ok(ForValues::With { modulus, remainder })
8846        } else {
8847            self.expected_ref("IN, FROM, or WITH after FOR VALUES", self.peek_token_ref())
8848        }
8849    }
8850
8851    /// Parse a single partition bound value (MINVALUE, MAXVALUE, or expression).
8852    fn parse_partition_bound_value(&mut self) -> Result<PartitionBoundValue, ParserError> {
8853        if self.parse_keyword(Keyword::MINVALUE) {
8854            Ok(PartitionBoundValue::MinValue)
8855        } else if self.parse_keyword(Keyword::MAXVALUE) {
8856            Ok(PartitionBoundValue::MaxValue)
8857        } else {
8858            Ok(PartitionBoundValue::Expr(self.parse_expr()?))
8859        }
8860    }
8861
8862    /// Parse configuration like inheritance, partitioning, clustering information during the table creation.
8863    ///
8864    /// [BigQuery](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#syntax_2)
8865    /// [PostgreSQL](https://www.postgresql.org/docs/current/ddl-partitioning.html)
8866    /// [MySql](https://dev.mysql.com/doc/refman/8.4/en/create-table.html)
8867    fn parse_optional_create_table_config(
8868        &mut self,
8869    ) -> Result<CreateTableConfiguration, ParserError> {
8870        let mut table_options = CreateTableOptions::None;
8871
8872        let inherits = if self.parse_keyword(Keyword::INHERITS) {
8873            Some(self.parse_parenthesized_qualified_column_list(IsOptional::Mandatory, false)?)
8874        } else {
8875            None
8876        };
8877
8878        // PostgreSQL supports `WITH ( options )`, before `AS`
8879        let with_options = self.parse_options(Keyword::WITH)?;
8880        if !with_options.is_empty() {
8881            table_options = CreateTableOptions::With(with_options)
8882        }
8883
8884        let table_properties = self.parse_options(Keyword::TBLPROPERTIES)?;
8885        if !table_properties.is_empty() {
8886            table_options = CreateTableOptions::TableProperties(table_properties);
8887        }
8888        let partition_by = if dialect_of!(self is BigQueryDialect | PostgreSqlDialect | GenericDialect)
8889            && self.parse_keywords(&[Keyword::PARTITION, Keyword::BY])
8890        {
8891            Some(Box::new(self.parse_expr()?))
8892        } else {
8893            None
8894        };
8895
8896        let mut cluster_by = None;
8897        if dialect_of!(self is BigQueryDialect | GenericDialect) {
8898            if self.parse_keywords(&[Keyword::CLUSTER, Keyword::BY]) {
8899                cluster_by = Some(WrappedCollection::NoWrapping(
8900                    self.parse_comma_separated(|p| p.parse_expr())?,
8901                ));
8902            };
8903
8904            if let Token::Word(word) = &self.peek_token_ref().token {
8905                if word.keyword == Keyword::OPTIONS {
8906                    table_options =
8907                        CreateTableOptions::Options(self.parse_options(Keyword::OPTIONS)?)
8908                }
8909            };
8910        }
8911
8912        if !dialect_of!(self is HiveDialect) && table_options == CreateTableOptions::None {
8913            let plain_options = self.parse_plain_options()?;
8914            if !plain_options.is_empty() {
8915                table_options = CreateTableOptions::Plain(plain_options)
8916            }
8917        };
8918
8919        Ok(CreateTableConfiguration {
8920            partition_by,
8921            cluster_by,
8922            inherits,
8923            table_options,
8924        })
8925    }
8926
8927    fn parse_plain_option(&mut self) -> Result<Option<SqlOption>, ParserError> {
8928        // Single parameter option
8929        // <https://dev.mysql.com/doc/refman/8.4/en/create-table.html>
8930        if self.parse_keywords(&[Keyword::START, Keyword::TRANSACTION]) {
8931            return Ok(Some(SqlOption::Ident(Ident::new("START TRANSACTION"))));
8932        }
8933
8934        // Custom option
8935        // <https://dev.mysql.com/doc/refman/8.4/en/create-table.html>
8936        if self.parse_keywords(&[Keyword::COMMENT]) {
8937            let has_eq = self.consume_token(&Token::Eq);
8938            let value = self.next_token();
8939
8940            let comment = match (has_eq, value.token) {
8941                (true, Token::SingleQuotedString(s)) => {
8942                    Ok(Some(SqlOption::Comment(CommentDef::WithEq(s))))
8943                }
8944                (false, Token::SingleQuotedString(s)) => {
8945                    Ok(Some(SqlOption::Comment(CommentDef::WithoutEq(s))))
8946                }
8947                (_, token) => {
8948                    self.expected("Token::SingleQuotedString", TokenWithSpan::wrap(token))
8949                }
8950            };
8951            return comment;
8952        }
8953
8954        // <https://dev.mysql.com/doc/refman/8.4/en/create-table.html>
8955        // <https://clickhouse.com/docs/sql-reference/statements/create/table>
8956        if self.parse_keywords(&[Keyword::ENGINE]) {
8957            let _ = self.consume_token(&Token::Eq);
8958            let value = self.next_token();
8959
8960            let engine = match value.token {
8961                Token::Word(w) => {
8962                    let parameters = if self.peek_token_ref().token == Token::LParen {
8963                        self.parse_parenthesized_identifiers()?
8964                    } else {
8965                        vec![]
8966                    };
8967
8968                    Ok(Some(SqlOption::NamedParenthesizedList(
8969                        NamedParenthesizedList {
8970                            key: Ident::new("ENGINE"),
8971                            name: Some(Ident::new(w.value)),
8972                            values: parameters,
8973                        },
8974                    )))
8975                }
8976                _ => {
8977                    return self.expected("Token::Word", value)?;
8978                }
8979            };
8980
8981            return engine;
8982        }
8983
8984        // <https://dev.mysql.com/doc/refman/8.4/en/create-table.html>
8985        if self.parse_keywords(&[Keyword::TABLESPACE]) {
8986            let _ = self.consume_token(&Token::Eq);
8987            let value = self.next_token();
8988
8989            let tablespace = match value.token {
8990                Token::Word(Word { value: name, .. }) | Token::SingleQuotedString(name) => {
8991                    let storage = match self.parse_keyword(Keyword::STORAGE) {
8992                        true => {
8993                            let _ = self.consume_token(&Token::Eq);
8994                            let storage_token = self.next_token();
8995                            match &storage_token.token {
8996                                Token::Word(w) => match w.value.to_uppercase().as_str() {
8997                                    "DISK" => Some(StorageType::Disk),
8998                                    "MEMORY" => Some(StorageType::Memory),
8999                                    _ => self
9000                                        .expected("Storage type (DISK or MEMORY)", storage_token)?,
9001                                },
9002                                _ => self.expected("Token::Word", storage_token)?,
9003                            }
9004                        }
9005                        false => None,
9006                    };
9007
9008                    Ok(Some(SqlOption::TableSpace(TablespaceOption {
9009                        name,
9010                        storage,
9011                    })))
9012                }
9013                _ => {
9014                    return self.expected("Token::Word", value)?;
9015                }
9016            };
9017
9018            return tablespace;
9019        }
9020
9021        // <https://dev.mysql.com/doc/refman/8.4/en/create-table.html>
9022        if self.parse_keyword(Keyword::UNION) {
9023            let _ = self.consume_token(&Token::Eq);
9024            let value = self.next_token();
9025
9026            match value.token {
9027                Token::LParen => {
9028                    let tables: Vec<Ident> =
9029                        self.parse_comma_separated0(Parser::parse_identifier, Token::RParen)?;
9030                    self.expect_token(&Token::RParen)?;
9031
9032                    return Ok(Some(SqlOption::NamedParenthesizedList(
9033                        NamedParenthesizedList {
9034                            key: Ident::new("UNION"),
9035                            name: None,
9036                            values: tables,
9037                        },
9038                    )));
9039                }
9040                _ => {
9041                    return self.expected("Token::LParen", value)?;
9042                }
9043            }
9044        }
9045
9046        // Key/Value parameter option
9047        let key = if self.parse_keywords(&[Keyword::DEFAULT, Keyword::CHARSET]) {
9048            Ident::new("DEFAULT CHARSET")
9049        } else if self.parse_keyword(Keyword::CHARSET) {
9050            Ident::new("CHARSET")
9051        } else if self.parse_keywords(&[Keyword::DEFAULT, Keyword::CHARACTER, Keyword::SET]) {
9052            Ident::new("DEFAULT CHARACTER SET")
9053        } else if self.parse_keywords(&[Keyword::CHARACTER, Keyword::SET]) {
9054            Ident::new("CHARACTER SET")
9055        } else if self.parse_keywords(&[Keyword::DEFAULT, Keyword::COLLATE]) {
9056            Ident::new("DEFAULT COLLATE")
9057        } else if self.parse_keyword(Keyword::COLLATE) {
9058            Ident::new("COLLATE")
9059        } else if self.parse_keywords(&[Keyword::DATA, Keyword::DIRECTORY]) {
9060            Ident::new("DATA DIRECTORY")
9061        } else if self.parse_keywords(&[Keyword::INDEX, Keyword::DIRECTORY]) {
9062            Ident::new("INDEX DIRECTORY")
9063        } else if self.parse_keyword(Keyword::KEY_BLOCK_SIZE) {
9064            Ident::new("KEY_BLOCK_SIZE")
9065        } else if self.parse_keyword(Keyword::ROW_FORMAT) {
9066            Ident::new("ROW_FORMAT")
9067        } else if self.parse_keyword(Keyword::PACK_KEYS) {
9068            Ident::new("PACK_KEYS")
9069        } else if self.parse_keyword(Keyword::STATS_AUTO_RECALC) {
9070            Ident::new("STATS_AUTO_RECALC")
9071        } else if self.parse_keyword(Keyword::STATS_PERSISTENT) {
9072            Ident::new("STATS_PERSISTENT")
9073        } else if self.parse_keyword(Keyword::STATS_SAMPLE_PAGES) {
9074            Ident::new("STATS_SAMPLE_PAGES")
9075        } else if self.parse_keyword(Keyword::DELAY_KEY_WRITE) {
9076            Ident::new("DELAY_KEY_WRITE")
9077        } else if self.parse_keyword(Keyword::COMPRESSION) {
9078            Ident::new("COMPRESSION")
9079        } else if self.parse_keyword(Keyword::ENCRYPTION) {
9080            Ident::new("ENCRYPTION")
9081        } else if self.parse_keyword(Keyword::MAX_ROWS) {
9082            Ident::new("MAX_ROWS")
9083        } else if self.parse_keyword(Keyword::MIN_ROWS) {
9084            Ident::new("MIN_ROWS")
9085        } else if self.parse_keyword(Keyword::AUTOEXTEND_SIZE) {
9086            Ident::new("AUTOEXTEND_SIZE")
9087        } else if self.parse_keyword(Keyword::AVG_ROW_LENGTH) {
9088            Ident::new("AVG_ROW_LENGTH")
9089        } else if self.parse_keyword(Keyword::CHECKSUM) {
9090            Ident::new("CHECKSUM")
9091        } else if self.parse_keyword(Keyword::CONNECTION) {
9092            Ident::new("CONNECTION")
9093        } else if self.parse_keyword(Keyword::ENGINE_ATTRIBUTE) {
9094            Ident::new("ENGINE_ATTRIBUTE")
9095        } else if self.parse_keyword(Keyword::PASSWORD) {
9096            Ident::new("PASSWORD")
9097        } else if self.parse_keyword(Keyword::SECONDARY_ENGINE_ATTRIBUTE) {
9098            Ident::new("SECONDARY_ENGINE_ATTRIBUTE")
9099        } else if self.parse_keyword(Keyword::INSERT_METHOD) {
9100            Ident::new("INSERT_METHOD")
9101        } else if self.parse_keyword(Keyword::AUTO_INCREMENT) {
9102            Ident::new("AUTO_INCREMENT")
9103        } else {
9104            return Ok(None);
9105        };
9106
9107        let _ = self.consume_token(&Token::Eq);
9108
9109        let value = match self
9110            .maybe_parse(|parser| parser.parse_value())?
9111            .map(Expr::Value)
9112        {
9113            Some(expr) => expr,
9114            None => Expr::Identifier(self.parse_identifier()?),
9115        };
9116
9117        Ok(Some(SqlOption::KeyValue { key, value }))
9118    }
9119
9120    /// Parse plain options.
9121    pub fn parse_plain_options(&mut self) -> Result<Vec<SqlOption>, ParserError> {
9122        let mut options = Vec::new();
9123
9124        while let Some(option) = self.parse_plain_option()? {
9125            options.push(option);
9126            // Some dialects support comma-separated options; it shouldn't introduce ambiguity to
9127            // consume it for all dialects.
9128            let _ = self.consume_token(&Token::Comma);
9129        }
9130
9131        Ok(options)
9132    }
9133
9134    /// Parse optional inline comment.
9135    pub fn parse_optional_inline_comment(&mut self) -> Result<Option<CommentDef>, ParserError> {
9136        let comment = if self.parse_keyword(Keyword::COMMENT) {
9137            let has_eq = self.consume_token(&Token::Eq);
9138            let comment = self.parse_comment_value()?;
9139            Some(if has_eq {
9140                CommentDef::WithEq(comment)
9141            } else {
9142                CommentDef::WithoutEq(comment)
9143            })
9144        } else {
9145            None
9146        };
9147        Ok(comment)
9148    }
9149
9150    /// Parse comment value.
9151    pub fn parse_comment_value(&mut self) -> Result<String, ParserError> {
9152        let next_token = self.next_token();
9153        let value = match next_token.token {
9154            Token::SingleQuotedString(str) => str,
9155            Token::DollarQuotedString(str) => str.value,
9156            _ => self.expected("string literal", next_token)?,
9157        };
9158        Ok(value)
9159    }
9160
9161    /// Parse optional procedure parameters.
9162    pub fn parse_optional_procedure_parameters(
9163        &mut self,
9164    ) -> Result<Option<Vec<ProcedureParam>>, ParserError> {
9165        let mut params = vec![];
9166        if !self.consume_token(&Token::LParen) || self.consume_token(&Token::RParen) {
9167            return Ok(Some(params));
9168        }
9169        loop {
9170            if let Token::Word(_) = &self.peek_token_ref().token {
9171                params.push(self.parse_procedure_param()?)
9172            }
9173            let comma = self.consume_token(&Token::Comma);
9174            if self.consume_token(&Token::RParen) {
9175                // allow a trailing comma, even though it's not in standard
9176                break;
9177            } else if !comma {
9178                return self.expected_ref(
9179                    "',' or ')' after parameter definition",
9180                    self.peek_token_ref(),
9181                );
9182            }
9183        }
9184        Ok(Some(params))
9185    }
9186
9187    /// Parse columns and constraints.
9188    pub fn parse_columns(&mut self) -> Result<(Vec<ColumnDef>, Vec<TableConstraint>), ParserError> {
9189        let mut columns = vec![];
9190        let mut constraints = vec![];
9191        if !self.consume_token(&Token::LParen) || self.consume_token(&Token::RParen) {
9192            return Ok((columns, constraints));
9193        }
9194
9195        loop {
9196            if let Some(constraint) = self.parse_optional_table_constraint()? {
9197                constraints.push(constraint);
9198            } else if let Token::Word(_) = &self.peek_token_ref().token {
9199                columns.push(self.parse_column_def()?);
9200            } else {
9201                return self.expected_ref(
9202                    "column name or constraint definition",
9203                    self.peek_token_ref(),
9204                );
9205            }
9206
9207            let comma = self.consume_token(&Token::Comma);
9208            let rparen = self.peek_token_ref().token == Token::RParen;
9209
9210            if !comma && !rparen {
9211                return self
9212                    .expected_ref("',' or ')' after column definition", self.peek_token_ref());
9213            };
9214
9215            if rparen
9216                && (!comma
9217                    || self.dialect.supports_column_definition_trailing_commas()
9218                    || self.options.trailing_commas)
9219            {
9220                let _ = self.consume_token(&Token::RParen);
9221                break;
9222            }
9223        }
9224
9225        Ok((columns, constraints))
9226    }
9227
9228    /// Parse procedure parameter.
9229    pub fn parse_procedure_param(&mut self) -> Result<ProcedureParam, ParserError> {
9230        let mode = if self.parse_keyword(Keyword::IN) {
9231            Some(ArgMode::In)
9232        } else if self.parse_keyword(Keyword::OUT) {
9233            Some(ArgMode::Out)
9234        } else if self.parse_keyword(Keyword::INOUT) {
9235            Some(ArgMode::InOut)
9236        } else {
9237            None
9238        };
9239        let name = self.parse_identifier()?;
9240        let data_type = self.parse_data_type()?;
9241        let default = if self.consume_token(&Token::Eq) {
9242            Some(self.parse_expr()?)
9243        } else {
9244            None
9245        };
9246
9247        Ok(ProcedureParam {
9248            name,
9249            data_type,
9250            mode,
9251            default,
9252        })
9253    }
9254
9255    /// Parse column definition.
9256    pub fn parse_column_def(&mut self) -> Result<ColumnDef, ParserError> {
9257        self.parse_column_def_inner(false)
9258    }
9259
9260    fn parse_column_def_inner(
9261        &mut self,
9262        optional_data_type: bool,
9263    ) -> Result<ColumnDef, ParserError> {
9264        let col_name = self.parse_identifier()?;
9265        let data_type = if self.is_column_type_sqlite_unspecified() {
9266            DataType::Unspecified
9267        } else if optional_data_type {
9268            self.maybe_parse(|parser| parser.parse_data_type())?
9269                .unwrap_or(DataType::Unspecified)
9270        } else {
9271            self.parse_data_type()?
9272        };
9273        let mut options = vec![];
9274        loop {
9275            if self.parse_keyword(Keyword::CONSTRAINT) {
9276                let name = Some(self.parse_identifier()?);
9277                if let Some(option) = self.parse_optional_column_option()? {
9278                    options.push(ColumnOptionDef { name, option });
9279                } else {
9280                    return self.expected_ref(
9281                        "constraint details after CONSTRAINT <name>",
9282                        self.peek_token_ref(),
9283                    );
9284                }
9285            } else if let Some(option) = self.parse_optional_column_option()? {
9286                options.push(ColumnOptionDef { name: None, option });
9287            } else {
9288                break;
9289            };
9290        }
9291        Ok(ColumnDef {
9292            name: col_name,
9293            data_type,
9294            options,
9295        })
9296    }
9297
9298    fn is_column_type_sqlite_unspecified(&mut self) -> bool {
9299        if dialect_of!(self is SQLiteDialect) {
9300            match &self.peek_token_ref().token {
9301                Token::Word(word) => matches!(
9302                    word.keyword,
9303                    Keyword::CONSTRAINT
9304                        | Keyword::PRIMARY
9305                        | Keyword::NOT
9306                        | Keyword::UNIQUE
9307                        | Keyword::CHECK
9308                        | Keyword::DEFAULT
9309                        | Keyword::COLLATE
9310                        | Keyword::REFERENCES
9311                        | Keyword::GENERATED
9312                        | Keyword::AS
9313                ),
9314                _ => true, // e.g. comma immediately after column name
9315            }
9316        } else {
9317            false
9318        }
9319    }
9320
9321    /// Parse optional column option.
9322    pub fn parse_optional_column_option(&mut self) -> Result<Option<ColumnOption>, ParserError> {
9323        if let Some(option) = self.dialect.parse_column_option(self)? {
9324            return option;
9325        }
9326
9327        self.with_state(
9328            ColumnDefinition,
9329            |parser| -> Result<Option<ColumnOption>, ParserError> {
9330                parser.parse_optional_column_option_inner()
9331            },
9332        )
9333    }
9334
9335    fn parse_optional_column_option_inner(&mut self) -> Result<Option<ColumnOption>, ParserError> {
9336        if self.parse_keywords(&[Keyword::CHARACTER, Keyword::SET]) {
9337            Ok(Some(ColumnOption::CharacterSet(
9338                self.parse_object_name(false)?,
9339            )))
9340        } else if self.parse_keywords(&[Keyword::COLLATE]) {
9341            Ok(Some(ColumnOption::Collation(
9342                self.parse_object_name(false)?,
9343            )))
9344        } else if self.parse_keywords(&[Keyword::NOT, Keyword::NULL]) {
9345            Ok(Some(ColumnOption::NotNull))
9346        } else if self.parse_keywords(&[Keyword::COMMENT]) {
9347            Ok(Some(ColumnOption::Comment(self.parse_comment_value()?)))
9348        } else if self.parse_keyword(Keyword::NULL) {
9349            Ok(Some(ColumnOption::Null))
9350        } else if self.parse_keyword(Keyword::DEFAULT) {
9351            Ok(Some(ColumnOption::Default(self.parse_expr()?)))
9352        } else if dialect_of!(self is ClickHouseDialect| GenericDialect)
9353            && self.parse_keyword(Keyword::MATERIALIZED)
9354        {
9355            Ok(Some(ColumnOption::Materialized(self.parse_expr()?)))
9356        } else if dialect_of!(self is ClickHouseDialect| GenericDialect)
9357            && self.parse_keyword(Keyword::ALIAS)
9358        {
9359            Ok(Some(ColumnOption::Alias(self.parse_expr()?)))
9360        } else if dialect_of!(self is ClickHouseDialect| GenericDialect)
9361            && self.parse_keyword(Keyword::EPHEMERAL)
9362        {
9363            // The expression is optional for the EPHEMERAL syntax, so we need to check
9364            // if the column definition has remaining tokens before parsing the expression.
9365            if matches!(self.peek_token_ref().token, Token::Comma | Token::RParen) {
9366                Ok(Some(ColumnOption::Ephemeral(None)))
9367            } else {
9368                Ok(Some(ColumnOption::Ephemeral(Some(self.parse_expr()?))))
9369            }
9370        } else if self.parse_keywords(&[Keyword::PRIMARY, Keyword::KEY]) {
9371            let characteristics = self.parse_constraint_characteristics()?;
9372            Ok(Some(
9373                PrimaryKeyConstraint {
9374                    name: None,
9375                    index_name: None,
9376                    index_type: None,
9377                    columns: vec![],
9378                    include: vec![],
9379                    index_options: vec![],
9380                    characteristics,
9381                }
9382                .into(),
9383            ))
9384        } else if self.parse_keyword(Keyword::UNIQUE) {
9385            let index_type_display =
9386                if self.dialect.supports_key_column_option() && self.parse_keyword(Keyword::KEY) {
9387                    KeyOrIndexDisplay::Key
9388                } else {
9389                    KeyOrIndexDisplay::None
9390                };
9391            let characteristics = self.parse_constraint_characteristics()?;
9392            Ok(Some(
9393                UniqueConstraint {
9394                    name: None,
9395                    index_name: None,
9396                    index_type_display,
9397                    index_type: None,
9398                    columns: vec![],
9399                    include: vec![],
9400                    index_options: vec![],
9401                    characteristics,
9402                    nulls_distinct: NullsDistinctOption::None,
9403                }
9404                .into(),
9405            ))
9406        } else if self.dialect.supports_key_column_option() && self.parse_keyword(Keyword::KEY) {
9407            // In MySQL, `KEY` in a column definition is shorthand for `PRIMARY KEY`.
9408            // See: https://dev.mysql.com/doc/refman/8.4/en/create-table.html
9409            let characteristics = self.parse_constraint_characteristics()?;
9410            Ok(Some(
9411                PrimaryKeyConstraint {
9412                    name: None,
9413                    index_name: None,
9414                    index_type: None,
9415                    columns: vec![],
9416                    include: vec![],
9417                    index_options: vec![],
9418                    characteristics,
9419                }
9420                .into(),
9421            ))
9422        } else if self.parse_keyword(Keyword::REFERENCES) {
9423            let foreign_table = self.parse_object_name(false)?;
9424            // PostgreSQL allows omitting the column list and
9425            // uses the primary key column of the foreign table by default
9426            let referred_columns = self.parse_parenthesized_column_list(Optional, false)?;
9427            let mut match_kind = None;
9428            let mut on_delete = None;
9429            let mut on_update = None;
9430            loop {
9431                if match_kind.is_none() && self.parse_keyword(Keyword::MATCH) {
9432                    match_kind = Some(self.parse_match_kind()?);
9433                } else if on_delete.is_none()
9434                    && self.parse_keywords(&[Keyword::ON, Keyword::DELETE])
9435                {
9436                    on_delete = Some(self.parse_referential_action()?);
9437                } else if on_update.is_none()
9438                    && self.parse_keywords(&[Keyword::ON, Keyword::UPDATE])
9439                {
9440                    on_update = Some(self.parse_referential_action()?);
9441                } else {
9442                    break;
9443                }
9444            }
9445            let characteristics = self.parse_constraint_characteristics()?;
9446
9447            Ok(Some(
9448                ForeignKeyConstraint {
9449                    name: None,       // Column-level constraints don't have names
9450                    index_name: None, // Not applicable for column-level constraints
9451                    columns: vec![],  // Not applicable for column-level constraints
9452                    foreign_table,
9453                    referred_columns,
9454                    on_delete,
9455                    on_update,
9456                    match_kind,
9457                    characteristics,
9458                }
9459                .into(),
9460            ))
9461        } else if self.parse_keyword(Keyword::CHECK) {
9462            self.expect_token(&Token::LParen)?;
9463            // since `CHECK` requires parentheses, we can parse the inner expression in ParserState::Normal
9464            let expr: Expr = self.with_state(ParserState::Normal, |p| p.parse_expr())?;
9465            self.expect_token(&Token::RParen)?;
9466
9467            let enforced = if self.parse_keyword(Keyword::ENFORCED) {
9468                Some(true)
9469            } else if self.parse_keywords(&[Keyword::NOT, Keyword::ENFORCED]) {
9470                Some(false)
9471            } else {
9472                None
9473            };
9474
9475            Ok(Some(
9476                CheckConstraint {
9477                    name: None, // Column-level check constraints don't have names
9478                    expr: Box::new(expr),
9479                    enforced,
9480                }
9481                .into(),
9482            ))
9483        } else if self.parse_keyword(Keyword::AUTO_INCREMENT)
9484            && dialect_of!(self is MySqlDialect | GenericDialect)
9485        {
9486            // Support AUTO_INCREMENT for MySQL
9487            Ok(Some(ColumnOption::DialectSpecific(vec![
9488                Token::make_keyword("AUTO_INCREMENT"),
9489            ])))
9490        } else if self.parse_keyword(Keyword::AUTOINCREMENT)
9491            && dialect_of!(self is SQLiteDialect |  GenericDialect)
9492        {
9493            // Support AUTOINCREMENT for SQLite
9494            Ok(Some(ColumnOption::DialectSpecific(vec![
9495                Token::make_keyword("AUTOINCREMENT"),
9496            ])))
9497        } else if self.parse_keyword(Keyword::ASC)
9498            && self.dialect.supports_asc_desc_in_column_definition()
9499        {
9500            // Support ASC for SQLite
9501            Ok(Some(ColumnOption::DialectSpecific(vec![
9502                Token::make_keyword("ASC"),
9503            ])))
9504        } else if self.parse_keyword(Keyword::DESC)
9505            && self.dialect.supports_asc_desc_in_column_definition()
9506        {
9507            // Support DESC for SQLite
9508            Ok(Some(ColumnOption::DialectSpecific(vec![
9509                Token::make_keyword("DESC"),
9510            ])))
9511        } else if self.parse_keywords(&[Keyword::ON, Keyword::UPDATE])
9512            && dialect_of!(self is MySqlDialect | GenericDialect)
9513        {
9514            let expr = self.parse_expr()?;
9515            Ok(Some(ColumnOption::OnUpdate(expr)))
9516        } else if self.parse_keyword(Keyword::GENERATED) {
9517            self.parse_optional_column_option_generated()
9518        } else if dialect_of!(self is BigQueryDialect | GenericDialect)
9519            && self.parse_keyword(Keyword::OPTIONS)
9520        {
9521            self.prev_token();
9522            Ok(Some(ColumnOption::Options(
9523                self.parse_options(Keyword::OPTIONS)?,
9524            )))
9525        } else if self.parse_keyword(Keyword::AS)
9526            && dialect_of!(self is MySqlDialect | SQLiteDialect | DuckDbDialect | GenericDialect)
9527        {
9528            self.parse_optional_column_option_as()
9529        } else if self.parse_keyword(Keyword::SRID)
9530            && dialect_of!(self is MySqlDialect | GenericDialect)
9531        {
9532            Ok(Some(ColumnOption::Srid(Box::new(self.parse_expr()?))))
9533        } else if self.parse_keyword(Keyword::IDENTITY)
9534            && dialect_of!(self is MsSqlDialect | GenericDialect)
9535        {
9536            let parameters = if self.consume_token(&Token::LParen) {
9537                let seed = self.parse_number()?;
9538                self.expect_token(&Token::Comma)?;
9539                let increment = self.parse_number()?;
9540                self.expect_token(&Token::RParen)?;
9541
9542                Some(IdentityPropertyFormatKind::FunctionCall(
9543                    IdentityParameters { seed, increment },
9544                ))
9545            } else {
9546                None
9547            };
9548            Ok(Some(ColumnOption::Identity(
9549                IdentityPropertyKind::Identity(IdentityProperty {
9550                    parameters,
9551                    order: None,
9552                }),
9553            )))
9554        } else if dialect_of!(self is SQLiteDialect | GenericDialect)
9555            && self.parse_keywords(&[Keyword::ON, Keyword::CONFLICT])
9556        {
9557            // Support ON CONFLICT for SQLite
9558            Ok(Some(ColumnOption::OnConflict(
9559                self.expect_one_of_keywords(&[
9560                    Keyword::ROLLBACK,
9561                    Keyword::ABORT,
9562                    Keyword::FAIL,
9563                    Keyword::IGNORE,
9564                    Keyword::REPLACE,
9565                ])?,
9566            )))
9567        } else if self.parse_keyword(Keyword::INVISIBLE) {
9568            Ok(Some(ColumnOption::Invisible))
9569        } else {
9570            Ok(None)
9571        }
9572    }
9573
9574    pub(crate) fn parse_tag(&mut self) -> Result<Tag, ParserError> {
9575        let name = self.parse_object_name(false)?;
9576        self.expect_token(&Token::Eq)?;
9577        let value = self.parse_literal_string()?;
9578
9579        Ok(Tag::new(name, value))
9580    }
9581
9582    fn parse_optional_column_option_generated(
9583        &mut self,
9584    ) -> Result<Option<ColumnOption>, ParserError> {
9585        if self.parse_keywords(&[Keyword::ALWAYS, Keyword::AS, Keyword::IDENTITY]) {
9586            let mut sequence_options = vec![];
9587            if self.expect_token(&Token::LParen).is_ok() {
9588                sequence_options = self.parse_create_sequence_options()?;
9589                self.expect_token(&Token::RParen)?;
9590            }
9591            Ok(Some(ColumnOption::Generated {
9592                generated_as: GeneratedAs::Always,
9593                sequence_options: Some(sequence_options),
9594                generation_expr: None,
9595                generation_expr_mode: None,
9596                generated_keyword: true,
9597            }))
9598        } else if self.parse_keywords(&[
9599            Keyword::BY,
9600            Keyword::DEFAULT,
9601            Keyword::AS,
9602            Keyword::IDENTITY,
9603        ]) {
9604            let mut sequence_options = vec![];
9605            if self.expect_token(&Token::LParen).is_ok() {
9606                sequence_options = self.parse_create_sequence_options()?;
9607                self.expect_token(&Token::RParen)?;
9608            }
9609            Ok(Some(ColumnOption::Generated {
9610                generated_as: GeneratedAs::ByDefault,
9611                sequence_options: Some(sequence_options),
9612                generation_expr: None,
9613                generation_expr_mode: None,
9614                generated_keyword: true,
9615            }))
9616        } else if self.parse_keywords(&[Keyword::ALWAYS, Keyword::AS]) {
9617            if self.expect_token(&Token::LParen).is_ok() {
9618                let expr: Expr = self.with_state(ParserState::Normal, |p| p.parse_expr())?;
9619                self.expect_token(&Token::RParen)?;
9620                let (gen_as, expr_mode) = if self.parse_keywords(&[Keyword::STORED]) {
9621                    Ok((
9622                        GeneratedAs::ExpStored,
9623                        Some(GeneratedExpressionMode::Stored),
9624                    ))
9625                } else if dialect_of!(self is PostgreSqlDialect) {
9626                    // Postgres' AS IDENTITY branches are above, this one needs STORED
9627                    self.expected_ref("STORED", self.peek_token_ref())
9628                } else if self.parse_keywords(&[Keyword::VIRTUAL]) {
9629                    Ok((GeneratedAs::Always, Some(GeneratedExpressionMode::Virtual)))
9630                } else {
9631                    Ok((GeneratedAs::Always, None))
9632                }?;
9633
9634                Ok(Some(ColumnOption::Generated {
9635                    generated_as: gen_as,
9636                    sequence_options: None,
9637                    generation_expr: Some(expr),
9638                    generation_expr_mode: expr_mode,
9639                    generated_keyword: true,
9640                }))
9641            } else {
9642                Ok(None)
9643            }
9644        } else {
9645            Ok(None)
9646        }
9647    }
9648
9649    fn parse_optional_column_option_as(&mut self) -> Result<Option<ColumnOption>, ParserError> {
9650        // Some DBs allow 'AS (expr)', shorthand for GENERATED ALWAYS AS
9651        self.expect_token(&Token::LParen)?;
9652        let expr = self.parse_expr()?;
9653        self.expect_token(&Token::RParen)?;
9654
9655        let (gen_as, expr_mode) = if self.parse_keywords(&[Keyword::STORED]) {
9656            (
9657                GeneratedAs::ExpStored,
9658                Some(GeneratedExpressionMode::Stored),
9659            )
9660        } else if self.parse_keywords(&[Keyword::VIRTUAL]) {
9661            (GeneratedAs::Always, Some(GeneratedExpressionMode::Virtual))
9662        } else {
9663            (GeneratedAs::Always, None)
9664        };
9665
9666        Ok(Some(ColumnOption::Generated {
9667            generated_as: gen_as,
9668            sequence_options: None,
9669            generation_expr: Some(expr),
9670            generation_expr_mode: expr_mode,
9671            generated_keyword: false,
9672        }))
9673    }
9674
9675    /// Parse optional `CLUSTERED BY` clause for Hive/Generic dialects.
9676    pub fn parse_optional_clustered_by(&mut self) -> Result<Option<ClusteredBy>, ParserError> {
9677        let clustered_by = if dialect_of!(self is HiveDialect|GenericDialect)
9678            && self.parse_keywords(&[Keyword::CLUSTERED, Keyword::BY])
9679        {
9680            let columns = self.parse_parenthesized_column_list(Mandatory, false)?;
9681
9682            let sorted_by = if self.parse_keywords(&[Keyword::SORTED, Keyword::BY]) {
9683                self.expect_token(&Token::LParen)?;
9684                let sorted_by_columns = self.parse_comma_separated(|p| p.parse_order_by_expr())?;
9685                self.expect_token(&Token::RParen)?;
9686                Some(sorted_by_columns)
9687            } else {
9688                None
9689            };
9690
9691            self.expect_keyword_is(Keyword::INTO)?;
9692            let num_buckets = self.parse_number_value()?.value;
9693            self.expect_keyword_is(Keyword::BUCKETS)?;
9694            Some(ClusteredBy {
9695                columns,
9696                sorted_by,
9697                num_buckets,
9698            })
9699        } else {
9700            None
9701        };
9702        Ok(clustered_by)
9703    }
9704
9705    /// Parse a referential action used in foreign key clauses.
9706    ///
9707    /// Recognized forms: `RESTRICT`, `CASCADE`, `SET NULL`, `NO ACTION`, `SET DEFAULT`.
9708    pub fn parse_referential_action(&mut self) -> Result<ReferentialAction, ParserError> {
9709        if self.parse_keyword(Keyword::RESTRICT) {
9710            Ok(ReferentialAction::Restrict)
9711        } else if self.parse_keyword(Keyword::CASCADE) {
9712            Ok(ReferentialAction::Cascade)
9713        } else if self.parse_keywords(&[Keyword::SET, Keyword::NULL]) {
9714            Ok(ReferentialAction::SetNull)
9715        } else if self.parse_keywords(&[Keyword::NO, Keyword::ACTION]) {
9716            Ok(ReferentialAction::NoAction)
9717        } else if self.parse_keywords(&[Keyword::SET, Keyword::DEFAULT]) {
9718            Ok(ReferentialAction::SetDefault)
9719        } else {
9720            self.expected_ref(
9721                "one of RESTRICT, CASCADE, SET NULL, NO ACTION or SET DEFAULT",
9722                self.peek_token_ref(),
9723            )
9724        }
9725    }
9726
9727    /// Parse a `MATCH` kind for constraint references: `FULL`, `PARTIAL`, or `SIMPLE`.
9728    pub fn parse_match_kind(&mut self) -> Result<ConstraintReferenceMatchKind, ParserError> {
9729        if self.parse_keyword(Keyword::FULL) {
9730            Ok(ConstraintReferenceMatchKind::Full)
9731        } else if self.parse_keyword(Keyword::PARTIAL) {
9732            Ok(ConstraintReferenceMatchKind::Partial)
9733        } else if self.parse_keyword(Keyword::SIMPLE) {
9734            Ok(ConstraintReferenceMatchKind::Simple)
9735        } else {
9736            self.expected_ref("one of FULL, PARTIAL or SIMPLE", self.peek_token_ref())
9737        }
9738    }
9739
9740    /// Parse `index_name [ DEFERRABLE | NOT DEFERRABLE ] [ INITIALLY DEFERRED | INITIALLY IMMEDIATE ]`
9741    /// after `{ PRIMARY KEY | UNIQUE } USING INDEX`.
9742    fn parse_constraint_using_index(
9743        &mut self,
9744        name: Option<Ident>,
9745    ) -> Result<ConstraintUsingIndex, ParserError> {
9746        let index_name = self.parse_identifier()?;
9747        let characteristics = self.parse_constraint_characteristics()?;
9748        Ok(ConstraintUsingIndex {
9749            name,
9750            index_name,
9751            characteristics,
9752        })
9753    }
9754
9755    /// Parse optional constraint characteristics such as `DEFERRABLE`, `INITIALLY` and `ENFORCED`.
9756    pub fn parse_constraint_characteristics(
9757        &mut self,
9758    ) -> Result<Option<ConstraintCharacteristics>, ParserError> {
9759        let mut cc = ConstraintCharacteristics::default();
9760
9761        loop {
9762            if cc.deferrable.is_none() && self.parse_keywords(&[Keyword::NOT, Keyword::DEFERRABLE])
9763            {
9764                cc.deferrable = Some(false);
9765            } else if cc.deferrable.is_none() && self.parse_keyword(Keyword::DEFERRABLE) {
9766                cc.deferrable = Some(true);
9767            } else if cc.initially.is_none() && self.parse_keyword(Keyword::INITIALLY) {
9768                if self.parse_keyword(Keyword::DEFERRED) {
9769                    cc.initially = Some(DeferrableInitial::Deferred);
9770                } else if self.parse_keyword(Keyword::IMMEDIATE) {
9771                    cc.initially = Some(DeferrableInitial::Immediate);
9772                } else {
9773                    self.expected_ref("one of DEFERRED or IMMEDIATE", self.peek_token_ref())?;
9774                }
9775            } else if cc.enforced.is_none() && self.parse_keyword(Keyword::ENFORCED) {
9776                cc.enforced = Some(true);
9777            } else if cc.enforced.is_none()
9778                && self.parse_keywords(&[Keyword::NOT, Keyword::ENFORCED])
9779            {
9780                cc.enforced = Some(false);
9781            } else {
9782                break;
9783            }
9784        }
9785
9786        if cc.deferrable.is_some() || cc.initially.is_some() || cc.enforced.is_some() {
9787            Ok(Some(cc))
9788        } else {
9789            Ok(None)
9790        }
9791    }
9792
9793    /// Parse an optional table constraint (e.g. `PRIMARY KEY`, `UNIQUE`, `FOREIGN KEY`, `CHECK`).
9794    pub fn parse_optional_table_constraint(
9795        &mut self,
9796    ) -> Result<Option<TableConstraint>, ParserError> {
9797        let name = if self.parse_keyword(Keyword::CONSTRAINT) {
9798            if self.dialect.supports_constraint_keyword_without_name()
9799                && self
9800                    .peek_one_of_keywords(&[
9801                        Keyword::CHECK,
9802                        Keyword::PRIMARY,
9803                        Keyword::UNIQUE,
9804                        Keyword::FOREIGN,
9805                    ])
9806                    .is_some()
9807            {
9808                None
9809            } else {
9810                Some(self.parse_identifier()?)
9811            }
9812        } else {
9813            None
9814        };
9815
9816        let next_token = self.next_token();
9817        match next_token.token {
9818            Token::Word(w) if w.keyword == Keyword::UNIQUE => {
9819                // PostgreSQL: UNIQUE USING INDEX index_name
9820                // https://www.postgresql.org/docs/current/sql-altertable.html
9821                if self.parse_keywords(&[Keyword::USING, Keyword::INDEX]) {
9822                    return Ok(Some(TableConstraint::UniqueUsingIndex(
9823                        self.parse_constraint_using_index(name)?,
9824                    )));
9825                }
9826
9827                let index_type_display = self.parse_index_type_display();
9828                if !dialect_of!(self is GenericDialect | MySqlDialect)
9829                    && !index_type_display.is_none()
9830                {
9831                    return self.expected_ref(
9832                        "`index_name` or `(column_name [, ...])`",
9833                        self.peek_token_ref(),
9834                    );
9835                }
9836
9837                let nulls_distinct = self.parse_optional_nulls_distinct()?;
9838
9839                // optional index name
9840                let index_name = self.parse_optional_ident()?;
9841                let index_type = self.parse_optional_using_then_index_type()?;
9842
9843                let columns = self.parse_parenthesized_index_column_list()?;
9844                let include = self.parse_optional_include_columns()?;
9845                let index_options = self.parse_index_options()?;
9846                let characteristics = self.parse_constraint_characteristics()?;
9847                Ok(Some(
9848                    UniqueConstraint {
9849                        name,
9850                        index_name,
9851                        index_type_display,
9852                        index_type,
9853                        columns,
9854                        include,
9855                        index_options,
9856                        characteristics,
9857                        nulls_distinct,
9858                    }
9859                    .into(),
9860                ))
9861            }
9862            Token::Word(w) if w.keyword == Keyword::PRIMARY => {
9863                // after `PRIMARY` always stay `KEY`
9864                self.expect_keyword_is(Keyword::KEY)?;
9865
9866                // PostgreSQL: PRIMARY KEY USING INDEX index_name
9867                // https://www.postgresql.org/docs/current/sql-altertable.html
9868                if self.parse_keywords(&[Keyword::USING, Keyword::INDEX]) {
9869                    return Ok(Some(TableConstraint::PrimaryKeyUsingIndex(
9870                        self.parse_constraint_using_index(name)?,
9871                    )));
9872                }
9873
9874                // optional index name
9875                let index_name = self.parse_optional_ident()?;
9876                let index_type = self.parse_optional_using_then_index_type()?;
9877
9878                let columns = self.parse_parenthesized_index_column_list()?;
9879                let include = self.parse_optional_include_columns()?;
9880                let index_options = self.parse_index_options()?;
9881                let characteristics = self.parse_constraint_characteristics()?;
9882                Ok(Some(
9883                    PrimaryKeyConstraint {
9884                        name,
9885                        index_name,
9886                        index_type,
9887                        columns,
9888                        include,
9889                        index_options,
9890                        characteristics,
9891                    }
9892                    .into(),
9893                ))
9894            }
9895            Token::Word(w) if w.keyword == Keyword::FOREIGN => {
9896                self.expect_keyword_is(Keyword::KEY)?;
9897                let index_name = self.parse_optional_ident()?;
9898                let columns = self.parse_parenthesized_column_list(Mandatory, false)?;
9899                self.expect_keyword_is(Keyword::REFERENCES)?;
9900                let foreign_table = self.parse_object_name(false)?;
9901                let referred_columns = self.parse_parenthesized_column_list(Optional, false)?;
9902                let mut match_kind = None;
9903                let mut on_delete = None;
9904                let mut on_update = None;
9905                loop {
9906                    if match_kind.is_none() && self.parse_keyword(Keyword::MATCH) {
9907                        match_kind = Some(self.parse_match_kind()?);
9908                    } else if on_delete.is_none()
9909                        && self.parse_keywords(&[Keyword::ON, Keyword::DELETE])
9910                    {
9911                        on_delete = Some(self.parse_referential_action()?);
9912                    } else if on_update.is_none()
9913                        && self.parse_keywords(&[Keyword::ON, Keyword::UPDATE])
9914                    {
9915                        on_update = Some(self.parse_referential_action()?);
9916                    } else {
9917                        break;
9918                    }
9919                }
9920
9921                let characteristics = self.parse_constraint_characteristics()?;
9922
9923                Ok(Some(
9924                    ForeignKeyConstraint {
9925                        name,
9926                        index_name,
9927                        columns,
9928                        foreign_table,
9929                        referred_columns,
9930                        on_delete,
9931                        on_update,
9932                        match_kind,
9933                        characteristics,
9934                    }
9935                    .into(),
9936                ))
9937            }
9938            Token::Word(w) if w.keyword == Keyword::CHECK => {
9939                self.expect_token(&Token::LParen)?;
9940                let expr = Box::new(self.parse_expr()?);
9941                self.expect_token(&Token::RParen)?;
9942
9943                let enforced = if self.parse_keyword(Keyword::ENFORCED) {
9944                    Some(true)
9945                } else if self.parse_keywords(&[Keyword::NOT, Keyword::ENFORCED]) {
9946                    Some(false)
9947                } else {
9948                    None
9949                };
9950
9951                Ok(Some(
9952                    CheckConstraint {
9953                        name,
9954                        expr,
9955                        enforced,
9956                    }
9957                    .into(),
9958                ))
9959            }
9960            Token::Word(w)
9961                if (w.keyword == Keyword::INDEX || w.keyword == Keyword::KEY)
9962                    && dialect_of!(self is GenericDialect | MySqlDialect)
9963                    && name.is_none() =>
9964            {
9965                let display_as_key = w.keyword == Keyword::KEY;
9966
9967                let name = match &self.peek_token_ref().token {
9968                    Token::Word(word) if word.keyword == Keyword::USING => None,
9969                    _ => self.parse_optional_ident()?,
9970                };
9971
9972                let index_type = self.parse_optional_using_then_index_type()?;
9973                let columns = self.parse_parenthesized_index_column_list()?;
9974                let index_options = self.parse_index_options()?;
9975
9976                Ok(Some(
9977                    IndexConstraint {
9978                        display_as_key,
9979                        name,
9980                        index_type,
9981                        columns,
9982                        index_options,
9983                    }
9984                    .into(),
9985                ))
9986            }
9987            Token::Word(w)
9988                if (w.keyword == Keyword::FULLTEXT || w.keyword == Keyword::SPATIAL)
9989                    && dialect_of!(self is GenericDialect | MySqlDialect) =>
9990            {
9991                if let Some(name) = name {
9992                    return self.expected(
9993                        "FULLTEXT or SPATIAL option without constraint name",
9994                        TokenWithSpan {
9995                            token: Token::make_keyword(&name.to_string()),
9996                            span: next_token.span,
9997                        },
9998                    );
9999                }
10000
10001                let fulltext = w.keyword == Keyword::FULLTEXT;
10002
10003                let index_type_display = self.parse_index_type_display();
10004
10005                let opt_index_name = self.parse_optional_ident()?;
10006
10007                let columns = self.parse_parenthesized_index_column_list()?;
10008
10009                Ok(Some(
10010                    FullTextOrSpatialConstraint {
10011                        fulltext,
10012                        index_type_display,
10013                        opt_index_name,
10014                        columns,
10015                    }
10016                    .into(),
10017                ))
10018            }
10019            _ => {
10020                if name.is_some() {
10021                    self.expected("PRIMARY, UNIQUE, FOREIGN, or CHECK", next_token)
10022                } else {
10023                    self.prev_token();
10024                    Ok(None)
10025                }
10026            }
10027        }
10028    }
10029
10030    fn parse_optional_nulls_distinct(&mut self) -> Result<NullsDistinctOption, ParserError> {
10031        Ok(if self.parse_keyword(Keyword::NULLS) {
10032            let not = self.parse_keyword(Keyword::NOT);
10033            self.expect_keyword_is(Keyword::DISTINCT)?;
10034            if not {
10035                NullsDistinctOption::NotDistinct
10036            } else {
10037                NullsDistinctOption::Distinct
10038            }
10039        } else {
10040            NullsDistinctOption::None
10041        })
10042    }
10043
10044    /// Optionally parse a parenthesized list of `SqlOption`s introduced by `keyword`.
10045    pub fn maybe_parse_options(
10046        &mut self,
10047        keyword: Keyword,
10048    ) -> Result<Option<Vec<SqlOption>>, ParserError> {
10049        if let Token::Word(word) = &self.peek_token_ref().token {
10050            if word.keyword == keyword {
10051                return Ok(Some(self.parse_options(keyword)?));
10052            }
10053        };
10054        Ok(None)
10055    }
10056
10057    /// Parse a parenthesized list of `SqlOption`s following `keyword`, or return an empty vec.
10058    pub fn parse_options(&mut self, keyword: Keyword) -> Result<Vec<SqlOption>, ParserError> {
10059        if self.parse_keyword(keyword) {
10060            self.expect_token(&Token::LParen)?;
10061            let options = self.parse_comma_separated0(Parser::parse_sql_option, Token::RParen)?;
10062            self.expect_token(&Token::RParen)?;
10063            Ok(options)
10064        } else {
10065            Ok(vec![])
10066        }
10067    }
10068
10069    /// Parse options introduced by one of `keywords` followed by a parenthesized list.
10070    pub fn parse_options_with_keywords(
10071        &mut self,
10072        keywords: &[Keyword],
10073    ) -> Result<Vec<SqlOption>, ParserError> {
10074        if self.parse_keywords(keywords) {
10075            self.expect_token(&Token::LParen)?;
10076            let options = self.parse_comma_separated(Parser::parse_sql_option)?;
10077            self.expect_token(&Token::RParen)?;
10078            Ok(options)
10079        } else {
10080            Ok(vec![])
10081        }
10082    }
10083
10084    /// Parse an index type token (e.g. `BTREE`, `HASH`, or a custom identifier).
10085    pub fn parse_index_type(&mut self) -> Result<IndexType, ParserError> {
10086        Ok(if self.parse_keyword(Keyword::BTREE) {
10087            IndexType::BTree
10088        } else if self.parse_keyword(Keyword::HASH) {
10089            IndexType::Hash
10090        } else if self.parse_keyword(Keyword::GIN) {
10091            IndexType::GIN
10092        } else if self.parse_keyword(Keyword::GIST) {
10093            IndexType::GiST
10094        } else if self.parse_keyword(Keyword::SPGIST) {
10095            IndexType::SPGiST
10096        } else if self.parse_keyword(Keyword::BRIN) {
10097            IndexType::BRIN
10098        } else if self.parse_keyword(Keyword::BLOOM) {
10099            IndexType::Bloom
10100        } else {
10101            IndexType::Custom(self.parse_identifier()?)
10102        })
10103    }
10104
10105    /// Optionally parse the `USING` keyword, followed by an [IndexType]
10106    /// Example:
10107    /// ```sql
10108    //// USING BTREE (name, age DESC)
10109    /// ```
10110    /// Optionally parse `USING <index_type>` and return the parsed `IndexType` if present.
10111    pub fn parse_optional_using_then_index_type(
10112        &mut self,
10113    ) -> Result<Option<IndexType>, ParserError> {
10114        if self.parse_keyword(Keyword::USING) {
10115            Ok(Some(self.parse_index_type()?))
10116        } else {
10117            Ok(None)
10118        }
10119    }
10120
10121    /// Parse `[ident]`, mostly `ident` is name, like:
10122    /// `window_name`, `index_name`, ...
10123    /// Parse an optional identifier, returning `Some(Ident)` if present.
10124    pub fn parse_optional_ident(&mut self) -> Result<Option<Ident>, ParserError> {
10125        self.maybe_parse(|parser| parser.parse_identifier())
10126    }
10127
10128    #[must_use]
10129    /// Parse optional `KEY` or `INDEX` display tokens used in index/constraint declarations.
10130    pub fn parse_index_type_display(&mut self) -> KeyOrIndexDisplay {
10131        if self.parse_keyword(Keyword::KEY) {
10132            KeyOrIndexDisplay::Key
10133        } else if self.parse_keyword(Keyword::INDEX) {
10134            KeyOrIndexDisplay::Index
10135        } else {
10136            KeyOrIndexDisplay::None
10137        }
10138    }
10139
10140    /// Parse an optional index option such as `USING <type>` or `COMMENT <string>`.
10141    pub fn parse_optional_index_option(&mut self) -> Result<Option<IndexOption>, ParserError> {
10142        if let Some(index_type) = self.parse_optional_using_then_index_type()? {
10143            Ok(Some(IndexOption::Using(index_type)))
10144        } else if self.parse_keyword(Keyword::COMMENT) {
10145            let s = self.parse_literal_string()?;
10146            Ok(Some(IndexOption::Comment(s)))
10147        } else {
10148            Ok(None)
10149        }
10150    }
10151
10152    /// Parse zero or more index options and return them as a vector.
10153    pub fn parse_index_options(&mut self) -> Result<Vec<IndexOption>, ParserError> {
10154        let mut options = Vec::new();
10155
10156        loop {
10157            match self.parse_optional_index_option()? {
10158                Some(index_option) => options.push(index_option),
10159                None => return Ok(options),
10160            }
10161        }
10162    }
10163
10164    /// Parse an optional `INCLUDE (col, ...)` clause on a table constraint.
10165    pub fn parse_optional_include_columns(&mut self) -> Result<Vec<Ident>, ParserError> {
10166        if self.parse_keyword(Keyword::INCLUDE) {
10167            self.expect_token(&Token::LParen)?;
10168            let columns = self.parse_comma_separated(|p| p.parse_identifier())?;
10169            self.expect_token(&Token::RParen)?;
10170            Ok(columns)
10171        } else {
10172            Ok(vec![])
10173        }
10174    }
10175
10176    /// Parse a single `SqlOption` used by various dialect-specific DDL statements.
10177    pub fn parse_sql_option(&mut self) -> Result<SqlOption, ParserError> {
10178        let is_mssql = dialect_of!(self is MsSqlDialect|GenericDialect);
10179
10180        match &self.peek_token_ref().token {
10181            Token::Word(w) if w.keyword == Keyword::HEAP && is_mssql => {
10182                Ok(SqlOption::Ident(self.parse_identifier()?))
10183            }
10184            Token::Word(w) if w.keyword == Keyword::PARTITION && is_mssql => {
10185                self.parse_option_partition()
10186            }
10187            Token::Word(w) if w.keyword == Keyword::CLUSTERED && is_mssql => {
10188                self.parse_option_clustered()
10189            }
10190            _ => {
10191                let name = self.parse_identifier()?;
10192                self.expect_token(&Token::Eq)?;
10193                let value = self.parse_expr()?;
10194
10195                Ok(SqlOption::KeyValue { key: name, value })
10196            }
10197        }
10198    }
10199
10200    /// Parse a `CLUSTERED` table option (MSSQL-specific syntaxes supported).
10201    pub fn parse_option_clustered(&mut self) -> Result<SqlOption, ParserError> {
10202        if self.parse_keywords(&[
10203            Keyword::CLUSTERED,
10204            Keyword::COLUMNSTORE,
10205            Keyword::INDEX,
10206            Keyword::ORDER,
10207        ]) {
10208            Ok(SqlOption::Clustered(
10209                TableOptionsClustered::ColumnstoreIndexOrder(
10210                    self.parse_parenthesized_column_list(IsOptional::Mandatory, false)?,
10211                ),
10212            ))
10213        } else if self.parse_keywords(&[Keyword::CLUSTERED, Keyword::COLUMNSTORE, Keyword::INDEX]) {
10214            Ok(SqlOption::Clustered(
10215                TableOptionsClustered::ColumnstoreIndex,
10216            ))
10217        } else if self.parse_keywords(&[Keyword::CLUSTERED, Keyword::INDEX]) {
10218            self.expect_token(&Token::LParen)?;
10219
10220            let columns = self.parse_comma_separated(|p| {
10221                let name = p.parse_identifier()?;
10222                let asc = p.parse_asc_desc();
10223
10224                Ok(ClusteredIndex { name, asc })
10225            })?;
10226
10227            self.expect_token(&Token::RParen)?;
10228
10229            Ok(SqlOption::Clustered(TableOptionsClustered::Index(columns)))
10230        } else {
10231            Err(ParserError::ParserError(
10232                "invalid CLUSTERED sequence".to_string(),
10233            ))
10234        }
10235    }
10236
10237    /// Parse a `PARTITION(...) FOR VALUES(...)` table option.
10238    pub fn parse_option_partition(&mut self) -> Result<SqlOption, ParserError> {
10239        self.expect_keyword_is(Keyword::PARTITION)?;
10240        self.expect_token(&Token::LParen)?;
10241        let column_name = self.parse_identifier()?;
10242
10243        self.expect_keyword_is(Keyword::RANGE)?;
10244        let range_direction = if self.parse_keyword(Keyword::LEFT) {
10245            Some(PartitionRangeDirection::Left)
10246        } else if self.parse_keyword(Keyword::RIGHT) {
10247            Some(PartitionRangeDirection::Right)
10248        } else {
10249            None
10250        };
10251
10252        self.expect_keywords(&[Keyword::FOR, Keyword::VALUES])?;
10253        self.expect_token(&Token::LParen)?;
10254
10255        let for_values = self.parse_comma_separated(Parser::parse_expr)?;
10256
10257        self.expect_token(&Token::RParen)?;
10258        self.expect_token(&Token::RParen)?;
10259
10260        Ok(SqlOption::Partition {
10261            column_name,
10262            range_direction,
10263            for_values,
10264        })
10265    }
10266
10267    /// Parse a parenthesized list of partition expressions and return a `Partition` value.
10268    pub fn parse_partition(&mut self) -> Result<Partition, ParserError> {
10269        self.expect_token(&Token::LParen)?;
10270        let partitions = self.parse_comma_separated(Parser::parse_expr)?;
10271        self.expect_token(&Token::RParen)?;
10272        Ok(Partition::Partitions(partitions))
10273    }
10274
10275    /// Parse a parenthesized `SELECT` projection used for projection-based operations.
10276    pub fn parse_projection_select(&mut self) -> Result<ProjectionSelect, ParserError> {
10277        self.expect_token(&Token::LParen)?;
10278        self.expect_keyword_is(Keyword::SELECT)?;
10279        let projection = self.parse_projection()?;
10280        let group_by = self.parse_optional_group_by()?;
10281        let order_by = self.parse_optional_order_by()?;
10282        self.expect_token(&Token::RParen)?;
10283        Ok(ProjectionSelect {
10284            projection,
10285            group_by,
10286            order_by,
10287        })
10288    }
10289    /// Parse `ALTER TABLE ... ADD PROJECTION ...` operation.
10290    pub fn parse_alter_table_add_projection(&mut self) -> Result<AlterTableOperation, ParserError> {
10291        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
10292        let name = self.parse_identifier()?;
10293        let query = self.parse_projection_select()?;
10294        Ok(AlterTableOperation::AddProjection {
10295            if_not_exists,
10296            name,
10297            select: query,
10298        })
10299    }
10300
10301    /// Parse Redshift `ALTER SORTKEY (column_list)`.
10302    ///
10303    /// See <https://docs.aws.amazon.com/redshift/latest/dg/r_ALTER_TABLE.html>
10304    fn parse_alter_sort_key(&mut self) -> Result<AlterTableOperation, ParserError> {
10305        self.expect_keyword_is(Keyword::ALTER)?;
10306        self.expect_keyword_is(Keyword::SORTKEY)?;
10307        self.expect_token(&Token::LParen)?;
10308        let columns = self.parse_comma_separated(|p| p.parse_expr())?;
10309        self.expect_token(&Token::RParen)?;
10310        Ok(AlterTableOperation::AlterSortKey { columns })
10311    }
10312
10313    /// Parse a single `ALTER TABLE` operation and return an `AlterTableOperation`.
10314    pub fn parse_alter_table_operation(&mut self) -> Result<AlterTableOperation, ParserError> {
10315        let operation = if self.parse_keyword(Keyword::ADD) {
10316            if let Some(constraint) = self.parse_optional_table_constraint()? {
10317                let not_valid = self.parse_keywords(&[Keyword::NOT, Keyword::VALID]);
10318                AlterTableOperation::AddConstraint {
10319                    constraint,
10320                    not_valid,
10321                }
10322            } else if dialect_of!(self is ClickHouseDialect|GenericDialect)
10323                && self.parse_keyword(Keyword::PROJECTION)
10324            {
10325                return self.parse_alter_table_add_projection();
10326            } else {
10327                let if_not_exists =
10328                    self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
10329                let mut new_partitions = vec![];
10330                loop {
10331                    if self.parse_keyword(Keyword::PARTITION) {
10332                        new_partitions.push(self.parse_partition()?);
10333                    } else {
10334                        break;
10335                    }
10336                }
10337                if !new_partitions.is_empty() {
10338                    AlterTableOperation::AddPartitions {
10339                        if_not_exists,
10340                        new_partitions,
10341                    }
10342                } else {
10343                    let column_keyword = self.parse_keyword(Keyword::COLUMN);
10344
10345                    let if_not_exists = if dialect_of!(self is PostgreSqlDialect | BigQueryDialect | DuckDbDialect | GenericDialect)
10346                    {
10347                        self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS])
10348                            || if_not_exists
10349                    } else {
10350                        false
10351                    };
10352
10353                    let column_def = self.parse_column_def()?;
10354
10355                    let column_position = self.parse_column_position()?;
10356
10357                    AlterTableOperation::AddColumn {
10358                        column_keyword,
10359                        if_not_exists,
10360                        column_def,
10361                        column_position,
10362                    }
10363                }
10364            }
10365        } else if self.parse_keyword(Keyword::RENAME) {
10366            if dialect_of!(self is PostgreSqlDialect) && self.parse_keyword(Keyword::CONSTRAINT) {
10367                let old_name = self.parse_identifier()?;
10368                self.expect_keyword_is(Keyword::TO)?;
10369                let new_name = self.parse_identifier()?;
10370                AlterTableOperation::RenameConstraint { old_name, new_name }
10371            } else if self.parse_keyword(Keyword::TO) {
10372                let table_name = self.parse_object_name(false)?;
10373                AlterTableOperation::RenameTable {
10374                    table_name: RenameTableNameKind::To(table_name),
10375                }
10376            } else if self.parse_keyword(Keyword::AS) {
10377                let table_name = self.parse_object_name(false)?;
10378                AlterTableOperation::RenameTable {
10379                    table_name: RenameTableNameKind::As(table_name),
10380                }
10381            } else {
10382                let _ = self.parse_keyword(Keyword::COLUMN); // [ COLUMN ]
10383                let old_column_name = self.parse_identifier()?;
10384                self.expect_keyword_is(Keyword::TO)?;
10385                let new_column_name = self.parse_identifier()?;
10386                AlterTableOperation::RenameColumn {
10387                    old_column_name,
10388                    new_column_name,
10389                }
10390            }
10391        } else if self.parse_keyword(Keyword::DISABLE) {
10392            if self.parse_keywords(&[Keyword::ROW, Keyword::LEVEL, Keyword::SECURITY]) {
10393                AlterTableOperation::DisableRowLevelSecurity {}
10394            } else if self.parse_keyword(Keyword::RULE) {
10395                let name = self.parse_identifier()?;
10396                AlterTableOperation::DisableRule { name }
10397            } else if self.parse_keyword(Keyword::TRIGGER) {
10398                let name = self.parse_identifier()?;
10399                AlterTableOperation::DisableTrigger { name }
10400            } else {
10401                return self.expected_ref(
10402                    "ROW LEVEL SECURITY, RULE, or TRIGGER after DISABLE",
10403                    self.peek_token_ref(),
10404                );
10405            }
10406        } else if self.parse_keyword(Keyword::ENABLE) {
10407            if self.parse_keywords(&[Keyword::ALWAYS, Keyword::RULE]) {
10408                let name = self.parse_identifier()?;
10409                AlterTableOperation::EnableAlwaysRule { name }
10410            } else if self.parse_keywords(&[Keyword::ALWAYS, Keyword::TRIGGER]) {
10411                let name = self.parse_identifier()?;
10412                AlterTableOperation::EnableAlwaysTrigger { name }
10413            } else if self.parse_keywords(&[Keyword::ROW, Keyword::LEVEL, Keyword::SECURITY]) {
10414                AlterTableOperation::EnableRowLevelSecurity {}
10415            } else if self.parse_keywords(&[Keyword::REPLICA, Keyword::RULE]) {
10416                let name = self.parse_identifier()?;
10417                AlterTableOperation::EnableReplicaRule { name }
10418            } else if self.parse_keywords(&[Keyword::REPLICA, Keyword::TRIGGER]) {
10419                let name = self.parse_identifier()?;
10420                AlterTableOperation::EnableReplicaTrigger { name }
10421            } else if self.parse_keyword(Keyword::RULE) {
10422                let name = self.parse_identifier()?;
10423                AlterTableOperation::EnableRule { name }
10424            } else if self.parse_keyword(Keyword::TRIGGER) {
10425                let name = self.parse_identifier()?;
10426                AlterTableOperation::EnableTrigger { name }
10427            } else {
10428                return self.expected_ref(
10429                    "ALWAYS, REPLICA, ROW LEVEL SECURITY, RULE, or TRIGGER after ENABLE",
10430                    self.peek_token_ref(),
10431                );
10432            }
10433        } else if self.parse_keywords(&[
10434            Keyword::FORCE,
10435            Keyword::ROW,
10436            Keyword::LEVEL,
10437            Keyword::SECURITY,
10438        ]) {
10439            AlterTableOperation::ForceRowLevelSecurity
10440        } else if self.parse_keywords(&[
10441            Keyword::NO,
10442            Keyword::FORCE,
10443            Keyword::ROW,
10444            Keyword::LEVEL,
10445            Keyword::SECURITY,
10446        ]) {
10447            AlterTableOperation::NoForceRowLevelSecurity
10448        } else if self.parse_keywords(&[Keyword::CLEAR, Keyword::PROJECTION])
10449            && dialect_of!(self is ClickHouseDialect|GenericDialect)
10450        {
10451            let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
10452            let name = self.parse_identifier()?;
10453            let partition = if self.parse_keywords(&[Keyword::IN, Keyword::PARTITION]) {
10454                Some(self.parse_identifier()?)
10455            } else {
10456                None
10457            };
10458            AlterTableOperation::ClearProjection {
10459                if_exists,
10460                name,
10461                partition,
10462            }
10463        } else if self.parse_keywords(&[Keyword::MATERIALIZE, Keyword::PROJECTION])
10464            && dialect_of!(self is ClickHouseDialect|GenericDialect)
10465        {
10466            let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
10467            let name = self.parse_identifier()?;
10468            let partition = if self.parse_keywords(&[Keyword::IN, Keyword::PARTITION]) {
10469                Some(self.parse_identifier()?)
10470            } else {
10471                None
10472            };
10473            AlterTableOperation::MaterializeProjection {
10474                if_exists,
10475                name,
10476                partition,
10477            }
10478        } else if self.parse_keyword(Keyword::DROP) {
10479            if self.parse_keywords(&[Keyword::IF, Keyword::EXISTS, Keyword::PARTITION]) {
10480                self.expect_token(&Token::LParen)?;
10481                let partitions = self.parse_comma_separated(Parser::parse_expr)?;
10482                self.expect_token(&Token::RParen)?;
10483                AlterTableOperation::DropPartitions {
10484                    partitions,
10485                    if_exists: true,
10486                }
10487            } else if self.parse_keyword(Keyword::PARTITION) {
10488                self.expect_token(&Token::LParen)?;
10489                let partitions = self.parse_comma_separated(Parser::parse_expr)?;
10490                self.expect_token(&Token::RParen)?;
10491                AlterTableOperation::DropPartitions {
10492                    partitions,
10493                    if_exists: false,
10494                }
10495            } else if self.parse_keyword(Keyword::CONSTRAINT) {
10496                let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
10497                let name = self.parse_identifier()?;
10498                let drop_behavior = self.parse_optional_drop_behavior();
10499                AlterTableOperation::DropConstraint {
10500                    if_exists,
10501                    name,
10502                    drop_behavior,
10503                }
10504            } else if self.parse_keywords(&[Keyword::PRIMARY, Keyword::KEY]) {
10505                let drop_behavior = self.parse_optional_drop_behavior();
10506                AlterTableOperation::DropPrimaryKey { drop_behavior }
10507            } else if self.parse_keywords(&[Keyword::FOREIGN, Keyword::KEY]) {
10508                let name = self.parse_identifier()?;
10509                let drop_behavior = self.parse_optional_drop_behavior();
10510                AlterTableOperation::DropForeignKey {
10511                    name,
10512                    drop_behavior,
10513                }
10514            } else if self.parse_keyword(Keyword::INDEX) {
10515                let name = self.parse_identifier()?;
10516                AlterTableOperation::DropIndex { name }
10517            } else if self.parse_keyword(Keyword::PROJECTION)
10518                && dialect_of!(self is ClickHouseDialect|GenericDialect)
10519            {
10520                let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
10521                let name = self.parse_identifier()?;
10522                AlterTableOperation::DropProjection { if_exists, name }
10523            } else if self.parse_keywords(&[Keyword::CLUSTERING, Keyword::KEY]) {
10524                AlterTableOperation::DropClusteringKey
10525            } else {
10526                let has_column_keyword = self.parse_keyword(Keyword::COLUMN); // [ COLUMN ]
10527                let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
10528                let column_names = if self.dialect.supports_comma_separated_drop_column_list() {
10529                    self.parse_comma_separated(Parser::parse_identifier)?
10530                } else {
10531                    vec![self.parse_identifier()?]
10532                };
10533                let drop_behavior = self.parse_optional_drop_behavior();
10534                AlterTableOperation::DropColumn {
10535                    has_column_keyword,
10536                    column_names,
10537                    if_exists,
10538                    drop_behavior,
10539                }
10540            }
10541        } else if self.parse_keyword(Keyword::PARTITION) {
10542            self.expect_token(&Token::LParen)?;
10543            let before = self.parse_comma_separated(Parser::parse_expr)?;
10544            self.expect_token(&Token::RParen)?;
10545            self.expect_keyword_is(Keyword::RENAME)?;
10546            self.expect_keywords(&[Keyword::TO, Keyword::PARTITION])?;
10547            self.expect_token(&Token::LParen)?;
10548            let renames = self.parse_comma_separated(Parser::parse_expr)?;
10549            self.expect_token(&Token::RParen)?;
10550            AlterTableOperation::RenamePartitions {
10551                old_partitions: before,
10552                new_partitions: renames,
10553            }
10554        } else if self.parse_keyword(Keyword::CHANGE) {
10555            let _ = self.parse_keyword(Keyword::COLUMN); // [ COLUMN ]
10556            let old_name = self.parse_identifier()?;
10557            let new_name = self.parse_identifier()?;
10558            let data_type = self.parse_data_type()?;
10559            let mut options = vec![];
10560            while let Some(option) = self.parse_optional_column_option()? {
10561                options.push(option);
10562            }
10563
10564            let column_position = self.parse_column_position()?;
10565
10566            AlterTableOperation::ChangeColumn {
10567                old_name,
10568                new_name,
10569                data_type,
10570                options,
10571                column_position,
10572            }
10573        } else if self.parse_keyword(Keyword::MODIFY) {
10574            let _ = self.parse_keyword(Keyword::COLUMN); // [ COLUMN ]
10575            let col_name = self.parse_identifier()?;
10576            let data_type = self.parse_data_type()?;
10577            let mut options = vec![];
10578            while let Some(option) = self.parse_optional_column_option()? {
10579                options.push(option);
10580            }
10581
10582            let column_position = self.parse_column_position()?;
10583
10584            AlterTableOperation::ModifyColumn {
10585                col_name,
10586                data_type,
10587                options,
10588                column_position,
10589            }
10590        } else if self.parse_keyword(Keyword::ALTER) {
10591            if self.peek_keyword(Keyword::SORTKEY) {
10592                self.prev_token();
10593                return self.parse_alter_sort_key();
10594            }
10595
10596            let _ = self.parse_keyword(Keyword::COLUMN); // [ COLUMN ]
10597            let column_name = self.parse_identifier()?;
10598            let is_postgresql = dialect_of!(self is PostgreSqlDialect);
10599
10600            let op: AlterColumnOperation = if self.parse_keywords(&[
10601                Keyword::SET,
10602                Keyword::NOT,
10603                Keyword::NULL,
10604            ]) {
10605                AlterColumnOperation::SetNotNull {}
10606            } else if self.parse_keywords(&[Keyword::DROP, Keyword::NOT, Keyword::NULL]) {
10607                AlterColumnOperation::DropNotNull {}
10608            } else if self.parse_keywords(&[Keyword::SET, Keyword::DEFAULT]) {
10609                AlterColumnOperation::SetDefault {
10610                    value: self.parse_expr()?,
10611                }
10612            } else if self.parse_keywords(&[Keyword::DROP, Keyword::DEFAULT]) {
10613                AlterColumnOperation::DropDefault {}
10614            } else if self.parse_keywords(&[Keyword::SET, Keyword::DATA, Keyword::TYPE]) {
10615                self.parse_set_data_type(true)?
10616            } else if self.parse_keyword(Keyword::TYPE) {
10617                self.parse_set_data_type(false)?
10618            } else if self.parse_keywords(&[Keyword::ADD, Keyword::GENERATED]) {
10619                let generated_as = if self.parse_keyword(Keyword::ALWAYS) {
10620                    Some(GeneratedAs::Always)
10621                } else if self.parse_keywords(&[Keyword::BY, Keyword::DEFAULT]) {
10622                    Some(GeneratedAs::ByDefault)
10623                } else {
10624                    None
10625                };
10626
10627                self.expect_keywords(&[Keyword::AS, Keyword::IDENTITY])?;
10628
10629                let mut sequence_options: Option<Vec<SequenceOptions>> = None;
10630
10631                if self.peek_token_ref().token == Token::LParen {
10632                    self.expect_token(&Token::LParen)?;
10633                    sequence_options = Some(self.parse_create_sequence_options()?);
10634                    self.expect_token(&Token::RParen)?;
10635                }
10636
10637                AlterColumnOperation::AddGenerated {
10638                    generated_as,
10639                    sequence_options,
10640                }
10641            } else {
10642                let message = if is_postgresql {
10643                    "SET/DROP NOT NULL, SET DEFAULT, SET DATA TYPE, or ADD GENERATED after ALTER COLUMN"
10644                } else {
10645                    "SET/DROP NOT NULL, SET DEFAULT, or SET DATA TYPE after ALTER COLUMN"
10646                };
10647
10648                return self.expected_ref(message, self.peek_token_ref());
10649            };
10650            AlterTableOperation::AlterColumn { column_name, op }
10651        } else if self.parse_keyword(Keyword::SWAP) {
10652            self.expect_keyword_is(Keyword::WITH)?;
10653            let table_name = self.parse_object_name(false)?;
10654            AlterTableOperation::SwapWith { table_name }
10655        } else if dialect_of!(self is PostgreSqlDialect | GenericDialect)
10656            && self.parse_keywords(&[Keyword::OWNER, Keyword::TO])
10657        {
10658            let new_owner = self.parse_owner()?;
10659            AlterTableOperation::OwnerTo { new_owner }
10660        } else if dialect_of!(self is ClickHouseDialect|GenericDialect)
10661            && self.parse_keyword(Keyword::ATTACH)
10662        {
10663            AlterTableOperation::AttachPartition {
10664                partition: self.parse_part_or_partition()?,
10665            }
10666        } else if dialect_of!(self is ClickHouseDialect|GenericDialect)
10667            && self.parse_keyword(Keyword::DETACH)
10668        {
10669            AlterTableOperation::DetachPartition {
10670                partition: self.parse_part_or_partition()?,
10671            }
10672        } else if dialect_of!(self is ClickHouseDialect|GenericDialect)
10673            && self.parse_keyword(Keyword::FREEZE)
10674        {
10675            let partition = self.parse_part_or_partition()?;
10676            let with_name = if self.parse_keyword(Keyword::WITH) {
10677                self.expect_keyword_is(Keyword::NAME)?;
10678                Some(self.parse_identifier()?)
10679            } else {
10680                None
10681            };
10682            AlterTableOperation::FreezePartition {
10683                partition,
10684                with_name,
10685            }
10686        } else if dialect_of!(self is ClickHouseDialect|GenericDialect)
10687            && self.parse_keyword(Keyword::UNFREEZE)
10688        {
10689            let partition = self.parse_part_or_partition()?;
10690            let with_name = if self.parse_keyword(Keyword::WITH) {
10691                self.expect_keyword_is(Keyword::NAME)?;
10692                Some(self.parse_identifier()?)
10693            } else {
10694                None
10695            };
10696            AlterTableOperation::UnfreezePartition {
10697                partition,
10698                with_name,
10699            }
10700        } else if self.parse_keywords(&[Keyword::CLUSTER, Keyword::BY]) {
10701            self.expect_token(&Token::LParen)?;
10702            let exprs = self.parse_comma_separated(|parser| parser.parse_expr())?;
10703            self.expect_token(&Token::RParen)?;
10704            AlterTableOperation::ClusterBy { exprs }
10705        } else if self.parse_keywords(&[Keyword::SUSPEND, Keyword::RECLUSTER]) {
10706            AlterTableOperation::SuspendRecluster
10707        } else if self.parse_keywords(&[Keyword::RESUME, Keyword::RECLUSTER]) {
10708            AlterTableOperation::ResumeRecluster
10709        } else if self.parse_keyword(Keyword::LOCK) {
10710            let equals = self.consume_token(&Token::Eq);
10711            let lock = match self.parse_one_of_keywords(&[
10712                Keyword::DEFAULT,
10713                Keyword::EXCLUSIVE,
10714                Keyword::NONE,
10715                Keyword::SHARED,
10716            ]) {
10717                Some(Keyword::DEFAULT) => AlterTableLock::Default,
10718                Some(Keyword::EXCLUSIVE) => AlterTableLock::Exclusive,
10719                Some(Keyword::NONE) => AlterTableLock::None,
10720                Some(Keyword::SHARED) => AlterTableLock::Shared,
10721                _ => self.expected_ref(
10722                    "DEFAULT, EXCLUSIVE, NONE or SHARED after LOCK [=]",
10723                    self.peek_token_ref(),
10724                )?,
10725            };
10726            AlterTableOperation::Lock { equals, lock }
10727        } else if self.parse_keyword(Keyword::ALGORITHM) {
10728            let equals = self.consume_token(&Token::Eq);
10729            let algorithm = match self.parse_one_of_keywords(&[
10730                Keyword::DEFAULT,
10731                Keyword::INSTANT,
10732                Keyword::INPLACE,
10733                Keyword::COPY,
10734            ]) {
10735                Some(Keyword::DEFAULT) => AlterTableAlgorithm::Default,
10736                Some(Keyword::INSTANT) => AlterTableAlgorithm::Instant,
10737                Some(Keyword::INPLACE) => AlterTableAlgorithm::Inplace,
10738                Some(Keyword::COPY) => AlterTableAlgorithm::Copy,
10739                _ => self.expected_ref(
10740                    "DEFAULT, INSTANT, INPLACE, or COPY after ALGORITHM [=]",
10741                    self.peek_token_ref(),
10742                )?,
10743            };
10744            AlterTableOperation::Algorithm { equals, algorithm }
10745        } else if self.parse_keyword(Keyword::AUTO_INCREMENT) {
10746            let equals = self.consume_token(&Token::Eq);
10747            let value = self.parse_number_value()?;
10748            AlterTableOperation::AutoIncrement { equals, value }
10749        } else if self.parse_keywords(&[Keyword::REPLICA, Keyword::IDENTITY]) {
10750            let identity = if self.parse_keyword(Keyword::NOTHING) {
10751                ReplicaIdentity::Nothing
10752            } else if self.parse_keyword(Keyword::FULL) {
10753                ReplicaIdentity::Full
10754            } else if self.parse_keyword(Keyword::DEFAULT) {
10755                ReplicaIdentity::Default
10756            } else if self.parse_keywords(&[Keyword::USING, Keyword::INDEX]) {
10757                ReplicaIdentity::Index(self.parse_identifier()?)
10758            } else {
10759                return self.expected_ref(
10760                    "NOTHING, FULL, DEFAULT, or USING INDEX index_name after REPLICA IDENTITY",
10761                    self.peek_token_ref(),
10762                );
10763            };
10764
10765            AlterTableOperation::ReplicaIdentity { identity }
10766        } else if self.parse_keywords(&[Keyword::VALIDATE, Keyword::CONSTRAINT]) {
10767            let name = self.parse_identifier()?;
10768            AlterTableOperation::ValidateConstraint { name }
10769        } else {
10770            let mut options =
10771                self.parse_options_with_keywords(&[Keyword::SET, Keyword::TBLPROPERTIES])?;
10772            if !options.is_empty() {
10773                AlterTableOperation::SetTblProperties {
10774                    table_properties: options,
10775                }
10776            } else {
10777                options = self.parse_options(Keyword::SET)?;
10778                if !options.is_empty() {
10779                    AlterTableOperation::SetOptionsParens { options }
10780                } else {
10781                    return self.expected_ref(
10782                    "ADD, RENAME, PARTITION, SWAP, DROP, REPLICA IDENTITY, SET, or SET TBLPROPERTIES after ALTER TABLE",
10783                    self.peek_token_ref(),
10784                  );
10785                }
10786            }
10787        };
10788        Ok(operation)
10789    }
10790
10791    fn parse_set_data_type(&mut self, had_set: bool) -> Result<AlterColumnOperation, ParserError> {
10792        let data_type = self.parse_data_type()?;
10793        let using = if self.dialect.supports_alter_column_type_using()
10794            && self.parse_keyword(Keyword::USING)
10795        {
10796            Some(self.parse_expr()?)
10797        } else {
10798            None
10799        };
10800        Ok(AlterColumnOperation::SetDataType {
10801            data_type,
10802            using,
10803            had_set,
10804        })
10805    }
10806
10807    fn parse_part_or_partition(&mut self) -> Result<Partition, ParserError> {
10808        let keyword = self.expect_one_of_keywords(&[Keyword::PART, Keyword::PARTITION])?;
10809        match keyword {
10810            Keyword::PART => Ok(Partition::Part(self.parse_expr()?)),
10811            Keyword::PARTITION => Ok(Partition::Expr(self.parse_expr()?)),
10812            // unreachable because expect_one_of_keywords used above
10813            unexpected_keyword => Err(ParserError::ParserError(
10814                format!("Internal parser error: expected any of {{PART, PARTITION}}, got {unexpected_keyword:?}"),
10815            )),
10816        }
10817    }
10818
10819    /// Parse an `ALTER <object>` statement and dispatch to the appropriate alter handler.
10820    pub fn parse_alter(&mut self) -> Result<Statement, ParserError> {
10821        let object_type = self.expect_one_of_keywords(&[
10822            Keyword::VIEW,
10823            Keyword::TYPE,
10824            Keyword::COLLATION,
10825            Keyword::TABLE,
10826            Keyword::INDEX,
10827            Keyword::FUNCTION,
10828            Keyword::AGGREGATE,
10829            Keyword::ROLE,
10830            Keyword::POLICY,
10831            Keyword::CONNECTOR,
10832            Keyword::ICEBERG,
10833            Keyword::SCHEMA,
10834            Keyword::USER,
10835            Keyword::OPERATOR,
10836        ])?;
10837        match object_type {
10838            Keyword::SCHEMA => {
10839                self.prev_token();
10840                self.prev_token();
10841                self.parse_alter_schema()
10842            }
10843            Keyword::VIEW => self.parse_alter_view(),
10844            Keyword::TYPE => self.parse_alter_type(),
10845            Keyword::COLLATION => self.parse_alter_collation().map(Into::into),
10846            Keyword::TABLE => self.parse_alter_table(false),
10847            Keyword::ICEBERG => {
10848                self.expect_keyword(Keyword::TABLE)?;
10849                self.parse_alter_table(true)
10850            }
10851            Keyword::INDEX => {
10852                let index_name = self.parse_object_name(false)?;
10853                let operation = if self.parse_keyword(Keyword::RENAME) {
10854                    if self.parse_keyword(Keyword::TO) {
10855                        let index_name = self.parse_object_name(false)?;
10856                        AlterIndexOperation::RenameIndex { index_name }
10857                    } else {
10858                        return self.expected_ref("TO after RENAME", self.peek_token_ref());
10859                    }
10860                } else {
10861                    return self.expected_ref("RENAME after ALTER INDEX", self.peek_token_ref());
10862                };
10863
10864                Ok(Statement::AlterIndex {
10865                    name: index_name,
10866                    operation,
10867                })
10868            }
10869            Keyword::FUNCTION => self.parse_alter_function(AlterFunctionKind::Function),
10870            Keyword::AGGREGATE => self.parse_alter_function(AlterFunctionKind::Aggregate),
10871            Keyword::OPERATOR => {
10872                if self.parse_keyword(Keyword::FAMILY) {
10873                    self.parse_alter_operator_family().map(Into::into)
10874                } else if self.parse_keyword(Keyword::CLASS) {
10875                    self.parse_alter_operator_class().map(Into::into)
10876                } else {
10877                    self.parse_alter_operator().map(Into::into)
10878                }
10879            }
10880            Keyword::ROLE => self.parse_alter_role(),
10881            Keyword::POLICY => self.parse_alter_policy().map(Into::into),
10882            Keyword::CONNECTOR => self.parse_alter_connector(),
10883            Keyword::USER => self.parse_alter_user().map(Into::into),
10884            // unreachable because expect_one_of_keywords used above
10885            unexpected_keyword => Err(ParserError::ParserError(
10886                format!("Internal parser error: expected any of {{VIEW, TYPE, COLLATION, TABLE, INDEX, FUNCTION, AGGREGATE, ROLE, POLICY, CONNECTOR, ICEBERG, SCHEMA, USER, OPERATOR}}, got {unexpected_keyword:?}"),
10887            )),
10888        }
10889    }
10890
10891    fn parse_alter_aggregate_signature(
10892        &mut self,
10893    ) -> Result<(FunctionDesc, bool, Option<Vec<OperateFunctionArg>>), ParserError> {
10894        let name = self.parse_object_name(false)?;
10895        self.expect_token(&Token::LParen)?;
10896
10897        if self.consume_token(&Token::Mul) {
10898            self.expect_token(&Token::RParen)?;
10899            return Ok((
10900                FunctionDesc {
10901                    name,
10902                    args: Some(vec![]),
10903                },
10904                true,
10905                None,
10906            ));
10907        }
10908
10909        let args =
10910            if self.peek_keyword(Keyword::ORDER) || self.peek_token_ref().token == Token::RParen {
10911                vec![]
10912            } else {
10913                self.parse_comma_separated(Parser::parse_aggregate_function_arg)?
10914            };
10915
10916        let aggregate_order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
10917            Some(self.parse_comma_separated(Parser::parse_aggregate_function_arg)?)
10918        } else {
10919            None
10920        };
10921
10922        self.expect_token(&Token::RParen)?;
10923        Ok((
10924            FunctionDesc {
10925                name,
10926                args: Some(args),
10927            },
10928            false,
10929            aggregate_order_by,
10930        ))
10931    }
10932
10933    fn parse_alter_function_action(&mut self) -> Result<Option<AlterFunctionAction>, ParserError> {
10934        let action = if self.parse_keywords(&[
10935            Keyword::CALLED,
10936            Keyword::ON,
10937            Keyword::NULL,
10938            Keyword::INPUT,
10939        ]) {
10940            Some(AlterFunctionAction::CalledOnNull(
10941                FunctionCalledOnNull::CalledOnNullInput,
10942            ))
10943        } else if self.parse_keywords(&[
10944            Keyword::RETURNS,
10945            Keyword::NULL,
10946            Keyword::ON,
10947            Keyword::NULL,
10948            Keyword::INPUT,
10949        ]) {
10950            Some(AlterFunctionAction::CalledOnNull(
10951                FunctionCalledOnNull::ReturnsNullOnNullInput,
10952            ))
10953        } else if self.parse_keyword(Keyword::STRICT) {
10954            Some(AlterFunctionAction::CalledOnNull(
10955                FunctionCalledOnNull::Strict,
10956            ))
10957        } else if self.parse_keyword(Keyword::IMMUTABLE) {
10958            Some(AlterFunctionAction::Behavior(FunctionBehavior::Immutable))
10959        } else if self.parse_keyword(Keyword::STABLE) {
10960            Some(AlterFunctionAction::Behavior(FunctionBehavior::Stable))
10961        } else if self.parse_keyword(Keyword::VOLATILE) {
10962            Some(AlterFunctionAction::Behavior(FunctionBehavior::Volatile))
10963        } else if self.parse_keyword(Keyword::NOT) {
10964            self.expect_keyword(Keyword::LEAKPROOF)?;
10965            Some(AlterFunctionAction::Leakproof(false))
10966        } else if self.parse_keyword(Keyword::LEAKPROOF) {
10967            Some(AlterFunctionAction::Leakproof(true))
10968        } else if self.parse_keyword(Keyword::EXTERNAL) {
10969            self.expect_keyword(Keyword::SECURITY)?;
10970            let security = if self.parse_keyword(Keyword::DEFINER) {
10971                FunctionSecurity::Definer
10972            } else if self.parse_keyword(Keyword::INVOKER) {
10973                FunctionSecurity::Invoker
10974            } else {
10975                return self.expected_ref("DEFINER or INVOKER", self.peek_token_ref());
10976            };
10977            Some(AlterFunctionAction::Security {
10978                external: true,
10979                security,
10980            })
10981        } else if self.parse_keyword(Keyword::SECURITY) {
10982            let security = if self.parse_keyword(Keyword::DEFINER) {
10983                FunctionSecurity::Definer
10984            } else if self.parse_keyword(Keyword::INVOKER) {
10985                FunctionSecurity::Invoker
10986            } else {
10987                return self.expected_ref("DEFINER or INVOKER", self.peek_token_ref());
10988            };
10989            Some(AlterFunctionAction::Security {
10990                external: false,
10991                security,
10992            })
10993        } else if self.parse_keyword(Keyword::PARALLEL) {
10994            let parallel = if self.parse_keyword(Keyword::UNSAFE) {
10995                FunctionParallel::Unsafe
10996            } else if self.parse_keyword(Keyword::RESTRICTED) {
10997                FunctionParallel::Restricted
10998            } else if self.parse_keyword(Keyword::SAFE) {
10999                FunctionParallel::Safe
11000            } else {
11001                return self
11002                    .expected_ref("one of UNSAFE | RESTRICTED | SAFE", self.peek_token_ref());
11003            };
11004            Some(AlterFunctionAction::Parallel(parallel))
11005        } else if self.parse_keyword(Keyword::COST) {
11006            Some(AlterFunctionAction::Cost(self.parse_number()?))
11007        } else if self.parse_keyword(Keyword::ROWS) {
11008            Some(AlterFunctionAction::Rows(self.parse_number()?))
11009        } else if self.parse_keyword(Keyword::SUPPORT) {
11010            Some(AlterFunctionAction::Support(self.parse_object_name(false)?))
11011        } else if self.parse_keyword(Keyword::SET) {
11012            let name = self.parse_object_name(false)?;
11013            let value = if self.parse_keywords(&[Keyword::FROM, Keyword::CURRENT]) {
11014                FunctionSetValue::FromCurrent
11015            } else {
11016                if !self.consume_token(&Token::Eq) && !self.parse_keyword(Keyword::TO) {
11017                    return self.expected_ref("= or TO", self.peek_token_ref());
11018                }
11019                if self.parse_keyword(Keyword::DEFAULT) {
11020                    FunctionSetValue::Default
11021                } else {
11022                    FunctionSetValue::Values(self.parse_comma_separated(Parser::parse_expr)?)
11023                }
11024            };
11025            Some(AlterFunctionAction::Set(FunctionDefinitionSetParam {
11026                name,
11027                value,
11028            }))
11029        } else if self.parse_keyword(Keyword::RESET) {
11030            let reset_config = if self.parse_keyword(Keyword::ALL) {
11031                ResetConfig::ALL
11032            } else {
11033                ResetConfig::ConfigName(self.parse_object_name(false)?)
11034            };
11035            Some(AlterFunctionAction::Reset(reset_config))
11036        } else {
11037            None
11038        };
11039
11040        Ok(action)
11041    }
11042
11043    fn parse_alter_function_actions(
11044        &mut self,
11045    ) -> Result<(Vec<AlterFunctionAction>, bool), ParserError> {
11046        let mut actions = vec![];
11047        while let Some(action) = self.parse_alter_function_action()? {
11048            actions.push(action);
11049        }
11050        if actions.is_empty() {
11051            return self.expected_ref("at least one ALTER FUNCTION action", self.peek_token_ref());
11052        }
11053        let restrict = self.parse_keyword(Keyword::RESTRICT);
11054        Ok((actions, restrict))
11055    }
11056
11057    /// Parse an `ALTER FUNCTION` or `ALTER AGGREGATE` statement.
11058    pub fn parse_alter_function(
11059        &mut self,
11060        kind: AlterFunctionKind,
11061    ) -> Result<Statement, ParserError> {
11062        let (function, aggregate_star, aggregate_order_by) = match kind {
11063            AlterFunctionKind::Function => (self.parse_function_desc()?, false, None),
11064            AlterFunctionKind::Aggregate => self.parse_alter_aggregate_signature()?,
11065        };
11066
11067        let operation = if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11068            let new_name = self.parse_identifier()?;
11069            AlterFunctionOperation::RenameTo { new_name }
11070        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11071            AlterFunctionOperation::OwnerTo(self.parse_owner()?)
11072        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11073            AlterFunctionOperation::SetSchema {
11074                schema_name: self.parse_object_name(false)?,
11075            }
11076        } else if matches!(kind, AlterFunctionKind::Function) && self.parse_keyword(Keyword::NO) {
11077            if !self.parse_keyword(Keyword::DEPENDS) {
11078                return self.expected_ref("DEPENDS after NO", self.peek_token_ref());
11079            }
11080            self.expect_keywords(&[Keyword::ON, Keyword::EXTENSION])?;
11081            AlterFunctionOperation::DependsOnExtension {
11082                no: true,
11083                extension_name: self.parse_object_name(false)?,
11084            }
11085        } else if matches!(kind, AlterFunctionKind::Function)
11086            && self.parse_keyword(Keyword::DEPENDS)
11087        {
11088            self.expect_keywords(&[Keyword::ON, Keyword::EXTENSION])?;
11089            AlterFunctionOperation::DependsOnExtension {
11090                no: false,
11091                extension_name: self.parse_object_name(false)?,
11092            }
11093        } else if matches!(kind, AlterFunctionKind::Function) {
11094            let (actions, restrict) = self.parse_alter_function_actions()?;
11095            AlterFunctionOperation::Actions { actions, restrict }
11096        } else {
11097            return self.expected_ref(
11098                "RENAME TO, OWNER TO, or SET SCHEMA after ALTER AGGREGATE",
11099                self.peek_token_ref(),
11100            );
11101        };
11102
11103        Ok(Statement::AlterFunction(AlterFunction {
11104            kind,
11105            function,
11106            aggregate_order_by,
11107            aggregate_star,
11108            operation,
11109        }))
11110    }
11111
11112    /// Parse a [Statement::AlterTable]
11113    pub fn parse_alter_table(&mut self, iceberg: bool) -> Result<Statement, ParserError> {
11114        let r#async = self.parse_keyword(Keyword::ASYNC); // [ ASYNC ] (DSQL)
11115        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
11116        let only = self.parse_keyword(Keyword::ONLY); // [ ONLY ]
11117        let table_name = self.parse_object_name(false)?;
11118        let on_cluster = self.parse_optional_on_cluster()?;
11119        let operations = self.parse_comma_separated(Parser::parse_alter_table_operation)?;
11120
11121        let mut location = None;
11122        if self.parse_keyword(Keyword::LOCATION) {
11123            location = Some(HiveSetLocation {
11124                has_set: false,
11125                location: self.parse_identifier()?,
11126            });
11127        } else if self.parse_keywords(&[Keyword::SET, Keyword::LOCATION]) {
11128            location = Some(HiveSetLocation {
11129                has_set: true,
11130                location: self.parse_identifier()?,
11131            });
11132        }
11133
11134        let end_token = if self.peek_token_ref().token == Token::SemiColon {
11135            self.peek_token_ref().clone()
11136        } else {
11137            self.get_current_token().clone()
11138        };
11139
11140        Ok(AlterTable {
11141            name: table_name,
11142            r#async,
11143            if_exists,
11144            only,
11145            operations,
11146            location,
11147            on_cluster,
11148            table_type: if iceberg {
11149                Some(AlterTableType::Iceberg)
11150            } else {
11151                None
11152            },
11153            end_token: AttachedToken(end_token),
11154        }
11155        .into())
11156    }
11157
11158    /// Parse an `ALTER VIEW` statement.
11159    pub fn parse_alter_view(&mut self) -> Result<Statement, ParserError> {
11160        let name = self.parse_object_name(false)?;
11161        let columns = self.parse_parenthesized_column_list(Optional, false)?;
11162
11163        let with_options = self.parse_options(Keyword::WITH)?;
11164
11165        self.expect_keyword_is(Keyword::AS)?;
11166        let query = self.parse_query()?;
11167
11168        Ok(Statement::AlterView {
11169            name,
11170            columns,
11171            query,
11172            with_options,
11173        })
11174    }
11175
11176    /// Parse a [Statement::AlterType]
11177    pub fn parse_alter_type(&mut self) -> Result<Statement, ParserError> {
11178        let name = self.parse_object_name(false)?;
11179
11180        if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11181            let new_name = self.parse_identifier()?;
11182            Ok(Statement::AlterType(AlterType {
11183                name,
11184                operation: AlterTypeOperation::Rename(AlterTypeRename { new_name }),
11185            }))
11186        } else if self.parse_keywords(&[Keyword::ADD, Keyword::VALUE]) {
11187            let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
11188            let new_enum_value = self.parse_identifier()?;
11189            let position = if self.parse_keyword(Keyword::BEFORE) {
11190                Some(AlterTypeAddValuePosition::Before(self.parse_identifier()?))
11191            } else if self.parse_keyword(Keyword::AFTER) {
11192                Some(AlterTypeAddValuePosition::After(self.parse_identifier()?))
11193            } else {
11194                None
11195            };
11196
11197            Ok(Statement::AlterType(AlterType {
11198                name,
11199                operation: AlterTypeOperation::AddValue(AlterTypeAddValue {
11200                    if_not_exists,
11201                    value: new_enum_value,
11202                    position,
11203                }),
11204            }))
11205        } else if self.parse_keywords(&[Keyword::RENAME, Keyword::VALUE]) {
11206            let existing_enum_value = self.parse_identifier()?;
11207            self.expect_keyword(Keyword::TO)?;
11208            let new_enum_value = self.parse_identifier()?;
11209
11210            Ok(Statement::AlterType(AlterType {
11211                name,
11212                operation: AlterTypeOperation::RenameValue(AlterTypeRenameValue {
11213                    from: existing_enum_value,
11214                    to: new_enum_value,
11215                }),
11216            }))
11217        } else {
11218            self.expected_ref(
11219                "{RENAME TO | { RENAME | ADD } VALUE}",
11220                self.peek_token_ref(),
11221            )
11222        }
11223    }
11224
11225    /// Parse a [Statement::AlterCollation].
11226    ///
11227    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-altercollation.html)
11228    pub fn parse_alter_collation(&mut self) -> Result<AlterCollation, ParserError> {
11229        let name = self.parse_object_name(false)?;
11230        let operation = if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11231            AlterCollationOperation::RenameTo {
11232                new_name: self.parse_identifier()?,
11233            }
11234        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11235            AlterCollationOperation::OwnerTo(self.parse_owner()?)
11236        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11237            AlterCollationOperation::SetSchema {
11238                schema_name: self.parse_object_name(false)?,
11239            }
11240        } else if self.parse_keywords(&[Keyword::REFRESH, Keyword::VERSION]) {
11241            AlterCollationOperation::RefreshVersion
11242        } else {
11243            return self.expected_ref(
11244                "RENAME TO, OWNER TO, SET SCHEMA, or REFRESH VERSION after ALTER COLLATION",
11245                self.peek_token_ref(),
11246            );
11247        };
11248
11249        Ok(AlterCollation { name, operation })
11250    }
11251
11252    /// Parse a [Statement::AlterOperator]
11253    ///
11254    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-alteroperator.html)
11255    pub fn parse_alter_operator(&mut self) -> Result<AlterOperator, ParserError> {
11256        let name = self.parse_operator_name()?;
11257
11258        // Parse (left_type, right_type)
11259        self.expect_token(&Token::LParen)?;
11260
11261        let left_type = if self.parse_keyword(Keyword::NONE) {
11262            None
11263        } else {
11264            Some(self.parse_data_type()?)
11265        };
11266
11267        self.expect_token(&Token::Comma)?;
11268        let right_type = self.parse_data_type()?;
11269        self.expect_token(&Token::RParen)?;
11270
11271        // Parse the operation
11272        let operation = if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11273            let owner = if self.parse_keyword(Keyword::CURRENT_ROLE) {
11274                Owner::CurrentRole
11275            } else if self.parse_keyword(Keyword::CURRENT_USER) {
11276                Owner::CurrentUser
11277            } else if self.parse_keyword(Keyword::SESSION_USER) {
11278                Owner::SessionUser
11279            } else {
11280                Owner::Ident(self.parse_identifier()?)
11281            };
11282            AlterOperatorOperation::OwnerTo(owner)
11283        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11284            let schema_name = self.parse_object_name(false)?;
11285            AlterOperatorOperation::SetSchema { schema_name }
11286        } else if self.parse_keyword(Keyword::SET) {
11287            self.expect_token(&Token::LParen)?;
11288
11289            let mut options = Vec::new();
11290            loop {
11291                let keyword = self.expect_one_of_keywords(&[
11292                    Keyword::RESTRICT,
11293                    Keyword::JOIN,
11294                    Keyword::COMMUTATOR,
11295                    Keyword::NEGATOR,
11296                    Keyword::HASHES,
11297                    Keyword::MERGES,
11298                ])?;
11299
11300                match keyword {
11301                    Keyword::RESTRICT => {
11302                        self.expect_token(&Token::Eq)?;
11303                        let proc_name = if self.parse_keyword(Keyword::NONE) {
11304                            None
11305                        } else {
11306                            Some(self.parse_object_name(false)?)
11307                        };
11308                        options.push(OperatorOption::Restrict(proc_name));
11309                    }
11310                    Keyword::JOIN => {
11311                        self.expect_token(&Token::Eq)?;
11312                        let proc_name = if self.parse_keyword(Keyword::NONE) {
11313                            None
11314                        } else {
11315                            Some(self.parse_object_name(false)?)
11316                        };
11317                        options.push(OperatorOption::Join(proc_name));
11318                    }
11319                    Keyword::COMMUTATOR => {
11320                        self.expect_token(&Token::Eq)?;
11321                        let op_name = self.parse_operator_name()?;
11322                        options.push(OperatorOption::Commutator(op_name));
11323                    }
11324                    Keyword::NEGATOR => {
11325                        self.expect_token(&Token::Eq)?;
11326                        let op_name = self.parse_operator_name()?;
11327                        options.push(OperatorOption::Negator(op_name));
11328                    }
11329                    Keyword::HASHES => {
11330                        options.push(OperatorOption::Hashes);
11331                    }
11332                    Keyword::MERGES => {
11333                        options.push(OperatorOption::Merges);
11334                    }
11335                    unexpected_keyword => return Err(ParserError::ParserError(
11336                        format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in operator option"),
11337                    )),
11338                }
11339
11340                if !self.consume_token(&Token::Comma) {
11341                    break;
11342                }
11343            }
11344
11345            self.expect_token(&Token::RParen)?;
11346            AlterOperatorOperation::Set { options }
11347        } else {
11348            return self.expected_ref(
11349                "OWNER TO, SET SCHEMA, or SET after ALTER OPERATOR",
11350                self.peek_token_ref(),
11351            );
11352        };
11353
11354        Ok(AlterOperator {
11355            name,
11356            left_type,
11357            right_type,
11358            operation,
11359        })
11360    }
11361
11362    /// Parse an operator item for ALTER OPERATOR FAMILY ADD operations
11363    fn parse_operator_family_add_operator(&mut self) -> Result<OperatorFamilyItem, ParserError> {
11364        let strategy_number = self.parse_literal_uint()?;
11365        let operator_name = self.parse_operator_name()?;
11366
11367        // Operator argument types (required for ALTER OPERATOR FAMILY)
11368        self.expect_token(&Token::LParen)?;
11369        let op_types = self.parse_comma_separated(Parser::parse_data_type)?;
11370        self.expect_token(&Token::RParen)?;
11371
11372        // Optional purpose
11373        let purpose = if self.parse_keyword(Keyword::FOR) {
11374            if self.parse_keyword(Keyword::SEARCH) {
11375                Some(OperatorPurpose::ForSearch)
11376            } else if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
11377                let sort_family = self.parse_object_name(false)?;
11378                Some(OperatorPurpose::ForOrderBy { sort_family })
11379            } else {
11380                return self.expected_ref("SEARCH or ORDER BY after FOR", self.peek_token_ref());
11381            }
11382        } else {
11383            None
11384        };
11385
11386        Ok(OperatorFamilyItem::Operator {
11387            strategy_number,
11388            operator_name,
11389            op_types,
11390            purpose,
11391        })
11392    }
11393
11394    /// Parse a function item for ALTER OPERATOR FAMILY ADD operations
11395    fn parse_operator_family_add_function(&mut self) -> Result<OperatorFamilyItem, ParserError> {
11396        let support_number = self.parse_literal_uint()?;
11397
11398        // Optional operator types
11399        let op_types =
11400            if self.consume_token(&Token::LParen) && self.peek_token_ref().token != Token::RParen {
11401                let types = self.parse_comma_separated(Parser::parse_data_type)?;
11402                self.expect_token(&Token::RParen)?;
11403                Some(types)
11404            } else if self.consume_token(&Token::LParen) {
11405                self.expect_token(&Token::RParen)?;
11406                Some(vec![])
11407            } else {
11408                None
11409            };
11410
11411        let function_name = self.parse_object_name(false)?;
11412
11413        // Function argument types
11414        let argument_types = if self.consume_token(&Token::LParen) {
11415            if self.peek_token_ref().token == Token::RParen {
11416                self.expect_token(&Token::RParen)?;
11417                vec![]
11418            } else {
11419                let types = self.parse_comma_separated(Parser::parse_data_type)?;
11420                self.expect_token(&Token::RParen)?;
11421                types
11422            }
11423        } else {
11424            vec![]
11425        };
11426
11427        Ok(OperatorFamilyItem::Function {
11428            support_number,
11429            op_types,
11430            function_name,
11431            argument_types,
11432        })
11433    }
11434
11435    /// Parse an operator item for ALTER OPERATOR FAMILY DROP operations
11436    fn parse_operator_family_drop_operator(
11437        &mut self,
11438    ) -> Result<OperatorFamilyDropItem, ParserError> {
11439        let strategy_number = self.parse_literal_uint()?;
11440
11441        // Operator argument types (required for DROP)
11442        self.expect_token(&Token::LParen)?;
11443        let op_types = self.parse_comma_separated(Parser::parse_data_type)?;
11444        self.expect_token(&Token::RParen)?;
11445
11446        Ok(OperatorFamilyDropItem::Operator {
11447            strategy_number,
11448            op_types,
11449        })
11450    }
11451
11452    /// Parse a function item for ALTER OPERATOR FAMILY DROP operations
11453    fn parse_operator_family_drop_function(
11454        &mut self,
11455    ) -> Result<OperatorFamilyDropItem, ParserError> {
11456        let support_number = self.parse_literal_uint()?;
11457
11458        // Operator types (required for DROP)
11459        self.expect_token(&Token::LParen)?;
11460        let op_types = self.parse_comma_separated(Parser::parse_data_type)?;
11461        self.expect_token(&Token::RParen)?;
11462
11463        Ok(OperatorFamilyDropItem::Function {
11464            support_number,
11465            op_types,
11466        })
11467    }
11468
11469    /// Parse an operator family item for ADD operations (dispatches to operator or function parsing)
11470    fn parse_operator_family_add_item(&mut self) -> Result<OperatorFamilyItem, ParserError> {
11471        if self.parse_keyword(Keyword::OPERATOR) {
11472            self.parse_operator_family_add_operator()
11473        } else if self.parse_keyword(Keyword::FUNCTION) {
11474            self.parse_operator_family_add_function()
11475        } else {
11476            self.expected_ref("OPERATOR or FUNCTION", self.peek_token_ref())
11477        }
11478    }
11479
11480    /// Parse an operator family item for DROP operations (dispatches to operator or function parsing)
11481    fn parse_operator_family_drop_item(&mut self) -> Result<OperatorFamilyDropItem, ParserError> {
11482        if self.parse_keyword(Keyword::OPERATOR) {
11483            self.parse_operator_family_drop_operator()
11484        } else if self.parse_keyword(Keyword::FUNCTION) {
11485            self.parse_operator_family_drop_function()
11486        } else {
11487            self.expected_ref("OPERATOR or FUNCTION", self.peek_token_ref())
11488        }
11489    }
11490
11491    /// Parse a [Statement::AlterOperatorFamily]
11492    /// See <https://www.postgresql.org/docs/current/sql-alteropfamily.html>
11493    pub fn parse_alter_operator_family(&mut self) -> Result<AlterOperatorFamily, ParserError> {
11494        let name = self.parse_object_name(false)?;
11495        self.expect_keyword(Keyword::USING)?;
11496        let using = self.parse_identifier()?;
11497
11498        let operation = if self.parse_keyword(Keyword::ADD) {
11499            let items = self.parse_comma_separated(Parser::parse_operator_family_add_item)?;
11500            AlterOperatorFamilyOperation::Add { items }
11501        } else if self.parse_keyword(Keyword::DROP) {
11502            let items = self.parse_comma_separated(Parser::parse_operator_family_drop_item)?;
11503            AlterOperatorFamilyOperation::Drop { items }
11504        } else if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11505            let new_name = self.parse_object_name(false)?;
11506            AlterOperatorFamilyOperation::RenameTo { new_name }
11507        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11508            let owner = self.parse_owner()?;
11509            AlterOperatorFamilyOperation::OwnerTo(owner)
11510        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11511            let schema_name = self.parse_object_name(false)?;
11512            AlterOperatorFamilyOperation::SetSchema { schema_name }
11513        } else {
11514            return self.expected_ref(
11515                "ADD, DROP, RENAME TO, OWNER TO, or SET SCHEMA after ALTER OPERATOR FAMILY",
11516                self.peek_token_ref(),
11517            );
11518        };
11519
11520        Ok(AlterOperatorFamily {
11521            name,
11522            using,
11523            operation,
11524        })
11525    }
11526
11527    /// Parse an `ALTER OPERATOR CLASS` statement.
11528    ///
11529    /// Handles operations like `RENAME TO`, `OWNER TO`, and `SET SCHEMA`.
11530    pub fn parse_alter_operator_class(&mut self) -> Result<AlterOperatorClass, ParserError> {
11531        let name = self.parse_object_name(false)?;
11532        self.expect_keyword(Keyword::USING)?;
11533        let using = self.parse_identifier()?;
11534
11535        let operation = if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11536            let new_name = self.parse_object_name(false)?;
11537            AlterOperatorClassOperation::RenameTo { new_name }
11538        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11539            let owner = self.parse_owner()?;
11540            AlterOperatorClassOperation::OwnerTo(owner)
11541        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11542            let schema_name = self.parse_object_name(false)?;
11543            AlterOperatorClassOperation::SetSchema { schema_name }
11544        } else {
11545            return self.expected_ref(
11546                "RENAME TO, OWNER TO, or SET SCHEMA after ALTER OPERATOR CLASS",
11547                self.peek_token_ref(),
11548            );
11549        };
11550
11551        Ok(AlterOperatorClass {
11552            name,
11553            using,
11554            operation,
11555        })
11556    }
11557
11558    /// Parse an `ALTER SCHEMA` statement.
11559    ///
11560    /// Supports operations such as setting options, renaming, adding/dropping replicas, and changing owner.
11561    pub fn parse_alter_schema(&mut self) -> Result<Statement, ParserError> {
11562        self.expect_keywords(&[Keyword::ALTER, Keyword::SCHEMA])?;
11563        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
11564        let name = self.parse_object_name(false)?;
11565        let operation = if self.parse_keywords(&[Keyword::SET, Keyword::OPTIONS]) {
11566            self.prev_token();
11567            let options = self.parse_options(Keyword::OPTIONS)?;
11568            AlterSchemaOperation::SetOptionsParens { options }
11569        } else if self.parse_keywords(&[Keyword::SET, Keyword::DEFAULT, Keyword::COLLATE]) {
11570            let collate = self.parse_expr()?;
11571            AlterSchemaOperation::SetDefaultCollate { collate }
11572        } else if self.parse_keywords(&[Keyword::ADD, Keyword::REPLICA]) {
11573            let replica = self.parse_identifier()?;
11574            let options = if self.peek_keyword(Keyword::OPTIONS) {
11575                Some(self.parse_options(Keyword::OPTIONS)?)
11576            } else {
11577                None
11578            };
11579            AlterSchemaOperation::AddReplica { replica, options }
11580        } else if self.parse_keywords(&[Keyword::DROP, Keyword::REPLICA]) {
11581            let replica = self.parse_identifier()?;
11582            AlterSchemaOperation::DropReplica { replica }
11583        } else if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11584            let new_name = self.parse_object_name(false)?;
11585            AlterSchemaOperation::Rename { name: new_name }
11586        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11587            let owner = self.parse_owner()?;
11588            AlterSchemaOperation::OwnerTo { owner }
11589        } else {
11590            return self.expected_ref("ALTER SCHEMA operation", self.peek_token_ref());
11591        };
11592        Ok(Statement::AlterSchema(AlterSchema {
11593            name,
11594            if_exists,
11595            operations: vec![operation],
11596        }))
11597    }
11598
11599    /// Parse a `CALL procedure_name(arg1, arg2, ...)`
11600    /// or `CALL procedure_name` statement
11601    pub fn parse_call(&mut self) -> Result<Statement, ParserError> {
11602        let object_name = self.parse_object_name(false)?;
11603        if self.peek_token_ref().token == Token::LParen {
11604            match self.parse_function(object_name)? {
11605                Expr::Function(f) => Ok(Statement::Call(f)),
11606                other => parser_err!(
11607                    format!("Expected a simple procedure call but found: {other}"),
11608                    self.peek_token_ref().span.start
11609                ),
11610            }
11611        } else {
11612            Ok(Statement::Call(Function {
11613                name: object_name,
11614                uses_odbc_syntax: false,
11615                parameters: FunctionArguments::None,
11616                args: FunctionArguments::None,
11617                over: None,
11618                filter: None,
11619                null_treatment: None,
11620                within_group: vec![],
11621            }))
11622        }
11623    }
11624
11625    /// Parse a copy statement
11626    pub fn parse_copy(&mut self) -> Result<Statement, ParserError> {
11627        let source;
11628        if self.consume_token(&Token::LParen) {
11629            source = CopySource::Query(self.parse_query()?);
11630            self.expect_token(&Token::RParen)?;
11631        } else {
11632            let table_name = self.parse_object_name(false)?;
11633            let columns = self.parse_parenthesized_column_list(Optional, false)?;
11634            source = CopySource::Table {
11635                table_name,
11636                columns,
11637            };
11638        }
11639        let to = match self.parse_one_of_keywords(&[Keyword::FROM, Keyword::TO]) {
11640            Some(Keyword::FROM) => false,
11641            Some(Keyword::TO) => true,
11642            _ => self.expected_ref("FROM or TO", self.peek_token_ref())?,
11643        };
11644        if !to {
11645            // Use a separate if statement to prevent Rust compiler from complaining about
11646            // "if statement in this position is unstable: https://github.com/rust-lang/rust/issues/53667"
11647            if let CopySource::Query(_) = source {
11648                return Err(ParserError::ParserError(
11649                    "COPY ... FROM does not support query as a source".to_string(),
11650                ));
11651            }
11652        }
11653        let target = if self.parse_keyword(Keyword::STDIN) {
11654            CopyTarget::Stdin
11655        } else if self.parse_keyword(Keyword::STDOUT) {
11656            CopyTarget::Stdout
11657        } else if self.parse_keyword(Keyword::PROGRAM) {
11658            CopyTarget::Program {
11659                command: self.parse_literal_string()?,
11660            }
11661        } else {
11662            CopyTarget::File {
11663                filename: self.parse_literal_string()?,
11664            }
11665        };
11666        let _ = self.parse_keyword(Keyword::WITH); // [ WITH ]
11667        let mut options = vec![];
11668        if self.consume_token(&Token::LParen) {
11669            options = self.parse_comma_separated(Parser::parse_copy_option)?;
11670            self.expect_token(&Token::RParen)?;
11671        }
11672        let mut legacy_options = vec![];
11673        while let Some(opt) = self.maybe_parse(|parser| parser.parse_copy_legacy_option())? {
11674            legacy_options.push(opt);
11675        }
11676        let values =
11677            if matches!(target, CopyTarget::Stdin) && self.peek_token_ref().token != Token::EOF {
11678                self.expect_token(&Token::SemiColon)?;
11679                self.parse_tsv()
11680            } else {
11681                vec![]
11682            };
11683        Ok(Statement::Copy {
11684            source,
11685            to,
11686            target,
11687            options,
11688            legacy_options,
11689            values,
11690        })
11691    }
11692
11693    /// Parse [Statement::Open]
11694    fn parse_open(&mut self) -> Result<Statement, ParserError> {
11695        self.expect_keyword(Keyword::OPEN)?;
11696        Ok(Statement::Open(OpenStatement {
11697            cursor_name: self.parse_identifier()?,
11698        }))
11699    }
11700
11701    /// Parse a `CLOSE` cursor statement.
11702    pub fn parse_close(&mut self) -> Result<Statement, ParserError> {
11703        let cursor = if self.parse_keyword(Keyword::ALL) {
11704            CloseCursor::All
11705        } else {
11706            let name = self.parse_identifier()?;
11707
11708            CloseCursor::Specific { name }
11709        };
11710
11711        Ok(Statement::Close { cursor })
11712    }
11713
11714    fn parse_copy_option(&mut self) -> Result<CopyOption, ParserError> {
11715        let ret = match self.parse_one_of_keywords(&[
11716            Keyword::FORMAT,
11717            Keyword::FREEZE,
11718            Keyword::DELIMITER,
11719            Keyword::NULL,
11720            Keyword::HEADER,
11721            Keyword::QUOTE,
11722            Keyword::ESCAPE,
11723            Keyword::FORCE_QUOTE,
11724            Keyword::FORCE_NOT_NULL,
11725            Keyword::FORCE_NULL,
11726            Keyword::ENCODING,
11727        ]) {
11728            Some(Keyword::FORMAT) => CopyOption::Format(self.parse_identifier()?),
11729            Some(Keyword::FREEZE) => CopyOption::Freeze(!matches!(
11730                self.parse_one_of_keywords(&[Keyword::TRUE, Keyword::FALSE]),
11731                Some(Keyword::FALSE)
11732            )),
11733            Some(Keyword::DELIMITER) => CopyOption::Delimiter(self.parse_literal_char()?),
11734            Some(Keyword::NULL) => CopyOption::Null(self.parse_literal_string()?),
11735            Some(Keyword::HEADER) => CopyOption::Header(!matches!(
11736                self.parse_one_of_keywords(&[Keyword::TRUE, Keyword::FALSE]),
11737                Some(Keyword::FALSE)
11738            )),
11739            Some(Keyword::QUOTE) => CopyOption::Quote(self.parse_literal_char()?),
11740            Some(Keyword::ESCAPE) => CopyOption::Escape(self.parse_literal_char()?),
11741            Some(Keyword::FORCE_QUOTE) => {
11742                CopyOption::ForceQuote(self.parse_parenthesized_column_list(Mandatory, false)?)
11743            }
11744            Some(Keyword::FORCE_NOT_NULL) => {
11745                CopyOption::ForceNotNull(self.parse_parenthesized_column_list(Mandatory, false)?)
11746            }
11747            Some(Keyword::FORCE_NULL) => {
11748                CopyOption::ForceNull(self.parse_parenthesized_column_list(Mandatory, false)?)
11749            }
11750            Some(Keyword::ENCODING) => CopyOption::Encoding(self.parse_literal_string()?),
11751            _ => self.expected_ref("option", self.peek_token_ref())?,
11752        };
11753        Ok(ret)
11754    }
11755
11756    fn parse_copy_legacy_option(&mut self) -> Result<CopyLegacyOption, ParserError> {
11757        // FORMAT \[ AS \] is optional
11758        if self.parse_keyword(Keyword::FORMAT) {
11759            let _ = self.parse_keyword(Keyword::AS);
11760        }
11761
11762        let ret = match self.parse_one_of_keywords(&[
11763            Keyword::ACCEPTANYDATE,
11764            Keyword::ACCEPTINVCHARS,
11765            Keyword::ADDQUOTES,
11766            Keyword::ALLOWOVERWRITE,
11767            Keyword::BINARY,
11768            Keyword::BLANKSASNULL,
11769            Keyword::BZIP2,
11770            Keyword::CLEANPATH,
11771            Keyword::COMPUPDATE,
11772            Keyword::CREDENTIALS,
11773            Keyword::CSV,
11774            Keyword::DATEFORMAT,
11775            Keyword::DELIMITER,
11776            Keyword::EMPTYASNULL,
11777            Keyword::ENCRYPTED,
11778            Keyword::ESCAPE,
11779            Keyword::EXTENSION,
11780            Keyword::FIXEDWIDTH,
11781            Keyword::GZIP,
11782            Keyword::HEADER,
11783            Keyword::IAM_ROLE,
11784            Keyword::IGNOREHEADER,
11785            Keyword::JSON,
11786            Keyword::MANIFEST,
11787            Keyword::MAXFILESIZE,
11788            Keyword::NULL,
11789            Keyword::PARALLEL,
11790            Keyword::PARQUET,
11791            Keyword::PARTITION,
11792            Keyword::REGION,
11793            Keyword::REMOVEQUOTES,
11794            Keyword::ROWGROUPSIZE,
11795            Keyword::STATUPDATE,
11796            Keyword::TIMEFORMAT,
11797            Keyword::TRUNCATECOLUMNS,
11798            Keyword::ZSTD,
11799        ]) {
11800            Some(Keyword::ACCEPTANYDATE) => CopyLegacyOption::AcceptAnyDate,
11801            Some(Keyword::ACCEPTINVCHARS) => {
11802                let _ = self.parse_keyword(Keyword::AS); // [ AS ]
11803                let ch = if matches!(self.peek_token_ref().token, Token::SingleQuotedString(_)) {
11804                    Some(self.parse_literal_string()?)
11805                } else {
11806                    None
11807                };
11808                CopyLegacyOption::AcceptInvChars(ch)
11809            }
11810            Some(Keyword::ADDQUOTES) => CopyLegacyOption::AddQuotes,
11811            Some(Keyword::ALLOWOVERWRITE) => CopyLegacyOption::AllowOverwrite,
11812            Some(Keyword::BINARY) => CopyLegacyOption::Binary,
11813            Some(Keyword::BLANKSASNULL) => CopyLegacyOption::BlankAsNull,
11814            Some(Keyword::BZIP2) => CopyLegacyOption::Bzip2,
11815            Some(Keyword::CLEANPATH) => CopyLegacyOption::CleanPath,
11816            Some(Keyword::COMPUPDATE) => {
11817                let preset = self.parse_keyword(Keyword::PRESET);
11818                let enabled = match self.parse_one_of_keywords(&[
11819                    Keyword::TRUE,
11820                    Keyword::FALSE,
11821                    Keyword::ON,
11822                    Keyword::OFF,
11823                ]) {
11824                    Some(Keyword::TRUE) | Some(Keyword::ON) => Some(true),
11825                    Some(Keyword::FALSE) | Some(Keyword::OFF) => Some(false),
11826                    _ => None,
11827                };
11828                CopyLegacyOption::CompUpdate { preset, enabled }
11829            }
11830            Some(Keyword::CREDENTIALS) => {
11831                CopyLegacyOption::Credentials(self.parse_literal_string()?)
11832            }
11833            Some(Keyword::CSV) => CopyLegacyOption::Csv({
11834                let mut opts = vec![];
11835                while let Some(opt) =
11836                    self.maybe_parse(|parser| parser.parse_copy_legacy_csv_option())?
11837                {
11838                    opts.push(opt);
11839                }
11840                opts
11841            }),
11842            Some(Keyword::DATEFORMAT) => {
11843                let _ = self.parse_keyword(Keyword::AS);
11844                let fmt = if matches!(self.peek_token_ref().token, Token::SingleQuotedString(_)) {
11845                    Some(self.parse_literal_string()?)
11846                } else {
11847                    None
11848                };
11849                CopyLegacyOption::DateFormat(fmt)
11850            }
11851            Some(Keyword::DELIMITER) => {
11852                let _ = self.parse_keyword(Keyword::AS);
11853                CopyLegacyOption::Delimiter(self.parse_literal_char()?)
11854            }
11855            Some(Keyword::EMPTYASNULL) => CopyLegacyOption::EmptyAsNull,
11856            Some(Keyword::ENCRYPTED) => {
11857                let auto = self.parse_keyword(Keyword::AUTO);
11858                CopyLegacyOption::Encrypted { auto }
11859            }
11860            Some(Keyword::ESCAPE) => CopyLegacyOption::Escape,
11861            Some(Keyword::EXTENSION) => {
11862                let ext = self.parse_literal_string()?;
11863                CopyLegacyOption::Extension(ext)
11864            }
11865            Some(Keyword::FIXEDWIDTH) => {
11866                let spec = self.parse_literal_string()?;
11867                CopyLegacyOption::FixedWidth(spec)
11868            }
11869            Some(Keyword::GZIP) => CopyLegacyOption::Gzip,
11870            Some(Keyword::HEADER) => CopyLegacyOption::Header,
11871            Some(Keyword::IAM_ROLE) => CopyLegacyOption::IamRole(self.parse_iam_role_kind()?),
11872            Some(Keyword::IGNOREHEADER) => {
11873                let _ = self.parse_keyword(Keyword::AS);
11874                let num_rows = self.parse_literal_uint()?;
11875                CopyLegacyOption::IgnoreHeader(num_rows)
11876            }
11877            Some(Keyword::JSON) => {
11878                let _ = self.parse_keyword(Keyword::AS);
11879                let fmt = if matches!(self.peek_token_ref().token, Token::SingleQuotedString(_)) {
11880                    Some(self.parse_literal_string()?)
11881                } else {
11882                    None
11883                };
11884                CopyLegacyOption::Json(fmt)
11885            }
11886            Some(Keyword::MANIFEST) => {
11887                let verbose = self.parse_keyword(Keyword::VERBOSE);
11888                CopyLegacyOption::Manifest { verbose }
11889            }
11890            Some(Keyword::MAXFILESIZE) => {
11891                let _ = self.parse_keyword(Keyword::AS);
11892                let size = self.parse_number_value()?;
11893                let unit = match self.parse_one_of_keywords(&[Keyword::MB, Keyword::GB]) {
11894                    Some(Keyword::MB) => Some(FileSizeUnit::MB),
11895                    Some(Keyword::GB) => Some(FileSizeUnit::GB),
11896                    _ => None,
11897                };
11898                CopyLegacyOption::MaxFileSize(FileSize { size, unit })
11899            }
11900            Some(Keyword::NULL) => {
11901                let _ = self.parse_keyword(Keyword::AS);
11902                CopyLegacyOption::Null(self.parse_literal_string()?)
11903            }
11904            Some(Keyword::PARALLEL) => {
11905                let enabled = match self.parse_one_of_keywords(&[
11906                    Keyword::TRUE,
11907                    Keyword::FALSE,
11908                    Keyword::ON,
11909                    Keyword::OFF,
11910                ]) {
11911                    Some(Keyword::TRUE) | Some(Keyword::ON) => Some(true),
11912                    Some(Keyword::FALSE) | Some(Keyword::OFF) => Some(false),
11913                    _ => None,
11914                };
11915                CopyLegacyOption::Parallel(enabled)
11916            }
11917            Some(Keyword::PARQUET) => CopyLegacyOption::Parquet,
11918            Some(Keyword::PARTITION) => {
11919                self.expect_keyword(Keyword::BY)?;
11920                let columns = self.parse_parenthesized_column_list(IsOptional::Mandatory, false)?;
11921                let include = self.parse_keyword(Keyword::INCLUDE);
11922                CopyLegacyOption::PartitionBy(UnloadPartitionBy { columns, include })
11923            }
11924            Some(Keyword::REGION) => {
11925                let _ = self.parse_keyword(Keyword::AS);
11926                let region = self.parse_literal_string()?;
11927                CopyLegacyOption::Region(region)
11928            }
11929            Some(Keyword::REMOVEQUOTES) => CopyLegacyOption::RemoveQuotes,
11930            Some(Keyword::ROWGROUPSIZE) => {
11931                let _ = self.parse_keyword(Keyword::AS);
11932                let file_size = self.parse_file_size()?;
11933                CopyLegacyOption::RowGroupSize(file_size)
11934            }
11935            Some(Keyword::STATUPDATE) => {
11936                let enabled = match self.parse_one_of_keywords(&[
11937                    Keyword::TRUE,
11938                    Keyword::FALSE,
11939                    Keyword::ON,
11940                    Keyword::OFF,
11941                ]) {
11942                    Some(Keyword::TRUE) | Some(Keyword::ON) => Some(true),
11943                    Some(Keyword::FALSE) | Some(Keyword::OFF) => Some(false),
11944                    _ => None,
11945                };
11946                CopyLegacyOption::StatUpdate(enabled)
11947            }
11948            Some(Keyword::TIMEFORMAT) => {
11949                let _ = self.parse_keyword(Keyword::AS);
11950                let fmt = if matches!(self.peek_token_ref().token, Token::SingleQuotedString(_)) {
11951                    Some(self.parse_literal_string()?)
11952                } else {
11953                    None
11954                };
11955                CopyLegacyOption::TimeFormat(fmt)
11956            }
11957            Some(Keyword::TRUNCATECOLUMNS) => CopyLegacyOption::TruncateColumns,
11958            Some(Keyword::ZSTD) => CopyLegacyOption::Zstd,
11959            _ => self.expected_ref("option", self.peek_token_ref())?,
11960        };
11961        Ok(ret)
11962    }
11963
11964    fn parse_file_size(&mut self) -> Result<FileSize, ParserError> {
11965        let size = self.parse_number_value()?;
11966        let unit = self.maybe_parse_file_size_unit();
11967        Ok(FileSize { size, unit })
11968    }
11969
11970    fn maybe_parse_file_size_unit(&mut self) -> Option<FileSizeUnit> {
11971        match self.parse_one_of_keywords(&[Keyword::MB, Keyword::GB]) {
11972            Some(Keyword::MB) => Some(FileSizeUnit::MB),
11973            Some(Keyword::GB) => Some(FileSizeUnit::GB),
11974            _ => None,
11975        }
11976    }
11977
11978    fn parse_iam_role_kind(&mut self) -> Result<IamRoleKind, ParserError> {
11979        if self.parse_keyword(Keyword::DEFAULT) {
11980            Ok(IamRoleKind::Default)
11981        } else {
11982            let arn = self.parse_literal_string()?;
11983            Ok(IamRoleKind::Arn(arn))
11984        }
11985    }
11986
11987    fn parse_copy_legacy_csv_option(&mut self) -> Result<CopyLegacyCsvOption, ParserError> {
11988        let ret = match self.parse_one_of_keywords(&[
11989            Keyword::HEADER,
11990            Keyword::QUOTE,
11991            Keyword::ESCAPE,
11992            Keyword::FORCE,
11993        ]) {
11994            Some(Keyword::HEADER) => CopyLegacyCsvOption::Header,
11995            Some(Keyword::QUOTE) => {
11996                let _ = self.parse_keyword(Keyword::AS); // [ AS ]
11997                CopyLegacyCsvOption::Quote(self.parse_literal_char()?)
11998            }
11999            Some(Keyword::ESCAPE) => {
12000                let _ = self.parse_keyword(Keyword::AS); // [ AS ]
12001                CopyLegacyCsvOption::Escape(self.parse_literal_char()?)
12002            }
12003            Some(Keyword::FORCE) if self.parse_keywords(&[Keyword::NOT, Keyword::NULL]) => {
12004                CopyLegacyCsvOption::ForceNotNull(
12005                    self.parse_comma_separated(|p| p.parse_identifier())?,
12006                )
12007            }
12008            Some(Keyword::FORCE) if self.parse_keywords(&[Keyword::QUOTE]) => {
12009                CopyLegacyCsvOption::ForceQuote(
12010                    self.parse_comma_separated(|p| p.parse_identifier())?,
12011                )
12012            }
12013            _ => self.expected_ref("csv option", self.peek_token_ref())?,
12014        };
12015        Ok(ret)
12016    }
12017
12018    fn parse_literal_char(&mut self) -> Result<char, ParserError> {
12019        let s = self.parse_literal_string()?;
12020        if s.len() != 1 {
12021            let loc = self
12022                .tokens
12023                .get(self.index - 1)
12024                .map_or(Location { line: 0, column: 0 }, |t| t.span.start);
12025            return parser_err!(format!("Expect a char, found {s:?}"), loc);
12026        }
12027        Ok(s.chars().next().unwrap())
12028    }
12029
12030    /// Parse a tab separated values in
12031    /// COPY payload
12032    pub fn parse_tsv(&mut self) -> Vec<Option<String>> {
12033        self.parse_tab_value()
12034    }
12035
12036    /// Parse a single tab-separated value row used by `COPY` payload parsing.
12037    pub fn parse_tab_value(&mut self) -> Vec<Option<String>> {
12038        let mut values = vec![];
12039        let mut content = String::new();
12040        while let Some(t) = self.next_token_no_skip().map(|t| &t.token) {
12041            match t {
12042                Token::Whitespace(Whitespace::Tab) => {
12043                    values.push(Some(core::mem::take(&mut content)));
12044                }
12045                Token::Whitespace(Whitespace::Newline) => {
12046                    values.push(Some(core::mem::take(&mut content)));
12047                }
12048                Token::Backslash => {
12049                    if self.consume_token(&Token::Period) {
12050                        return values;
12051                    }
12052                    if let Token::Word(w) = self.next_token().token {
12053                        if w.value == "N" {
12054                            values.push(None);
12055                        }
12056                    }
12057                }
12058                _ => {
12059                    content.push_str(&t.to_string());
12060                }
12061            }
12062        }
12063        values
12064    }
12065
12066    /// Parse a literal value (numbers, strings, date/time, booleans)
12067    pub fn parse_value(&mut self) -> Result<ValueWithSpan, ParserError> {
12068        let next_token = self.next_token();
12069        let span = next_token.span;
12070        let ok_value = |value: Value| Ok(value.with_span(span));
12071        match next_token.token {
12072            Token::Word(w) => match w.keyword {
12073                Keyword::TRUE if self.dialect.supports_boolean_literals() => {
12074                    ok_value(Value::Boolean(true))
12075                }
12076                Keyword::FALSE if self.dialect.supports_boolean_literals() => {
12077                    ok_value(Value::Boolean(false))
12078                }
12079                Keyword::NULL => ok_value(Value::Null),
12080                Keyword::NoKeyword if w.quote_style.is_some() => match w.quote_style {
12081                    Some('"') => ok_value(Value::DoubleQuotedString(w.value)),
12082                    Some('\'') => ok_value(Value::SingleQuotedString(w.value)),
12083                    _ => self.expected(
12084                        "A value?",
12085                        TokenWithSpan {
12086                            token: Token::Word(w),
12087                            span,
12088                        },
12089                    )?,
12090                },
12091                _ => self.expected(
12092                    "a concrete value",
12093                    TokenWithSpan {
12094                        token: Token::Word(w),
12095                        span,
12096                    },
12097                ),
12098            },
12099            // The call to n.parse() returns a bigdecimal when the
12100            // bigdecimal feature is enabled, and is otherwise a no-op
12101            // (i.e., it returns the input string).
12102            Token::Number(n, l) => ok_value(Value::Number(Self::parse(n, span.start)?, l)),
12103            Token::SingleQuotedString(ref s) => ok_value(Value::SingleQuotedString(
12104                self.maybe_concat_string_literal(s.to_string()),
12105            )),
12106            Token::DoubleQuotedString(ref s) => ok_value(Value::DoubleQuotedString(
12107                self.maybe_concat_string_literal(s.to_string()),
12108            )),
12109            Token::TripleSingleQuotedString(ref s) => {
12110                ok_value(Value::TripleSingleQuotedString(s.to_string()))
12111            }
12112            Token::TripleDoubleQuotedString(ref s) => {
12113                ok_value(Value::TripleDoubleQuotedString(s.to_string()))
12114            }
12115            Token::DollarQuotedString(ref s) => ok_value(Value::DollarQuotedString(s.clone())),
12116            Token::SingleQuotedByteStringLiteral(ref s) => {
12117                ok_value(Value::SingleQuotedByteStringLiteral(s.clone()))
12118            }
12119            Token::DoubleQuotedByteStringLiteral(ref s) => {
12120                ok_value(Value::DoubleQuotedByteStringLiteral(s.clone()))
12121            }
12122            Token::TripleSingleQuotedByteStringLiteral(ref s) => {
12123                ok_value(Value::TripleSingleQuotedByteStringLiteral(s.clone()))
12124            }
12125            Token::TripleDoubleQuotedByteStringLiteral(ref s) => {
12126                ok_value(Value::TripleDoubleQuotedByteStringLiteral(s.clone()))
12127            }
12128            Token::SingleQuotedRawStringLiteral(ref s) => {
12129                ok_value(Value::SingleQuotedRawStringLiteral(s.clone()))
12130            }
12131            Token::DoubleQuotedRawStringLiteral(ref s) => {
12132                ok_value(Value::DoubleQuotedRawStringLiteral(s.clone()))
12133            }
12134            Token::TripleSingleQuotedRawStringLiteral(ref s) => {
12135                ok_value(Value::TripleSingleQuotedRawStringLiteral(s.clone()))
12136            }
12137            Token::TripleDoubleQuotedRawStringLiteral(ref s) => {
12138                ok_value(Value::TripleDoubleQuotedRawStringLiteral(s.clone()))
12139            }
12140            Token::NationalStringLiteral(ref s) => {
12141                ok_value(Value::NationalStringLiteral(s.to_string()))
12142            }
12143            Token::QuoteDelimitedStringLiteral(v) => {
12144                ok_value(Value::QuoteDelimitedStringLiteral(v))
12145            }
12146            Token::NationalQuoteDelimitedStringLiteral(v) => {
12147                ok_value(Value::NationalQuoteDelimitedStringLiteral(v))
12148            }
12149            Token::EscapedStringLiteral(ref s) => {
12150                ok_value(Value::EscapedStringLiteral(s.to_string()))
12151            }
12152            Token::UnicodeStringLiteral(ref s) => {
12153                ok_value(Value::UnicodeStringLiteral(s.to_string()))
12154            }
12155            Token::HexStringLiteral(ref s) => ok_value(Value::HexStringLiteral(s.to_string())),
12156            Token::Placeholder(ref s) => ok_value(Value::Placeholder(s.to_string())),
12157            tok @ Token::Colon | tok @ Token::AtSign => {
12158                // 1. Not calling self.parse_identifier(false)?
12159                //    because only in placeholder we want to check
12160                //    numbers as idfentifies.  This because snowflake
12161                //    allows numbers as placeholders
12162                // 2. Not calling self.next_token() to enforce `tok`
12163                //    be followed immediately by a word/number, ie.
12164                //    without any whitespace in between
12165                let next_token = self.next_token_no_skip().unwrap_or(&EOF_TOKEN).clone();
12166                let ident = match next_token.token {
12167                    Token::Word(w) => Ok(w.into_ident(next_token.span)),
12168                    Token::Number(w, false) => Ok(Ident::with_span(next_token.span, w)),
12169                    _ => self.expected("placeholder", next_token),
12170                }?;
12171                Ok(Value::Placeholder(format!("{tok}{}", ident.value))
12172                    .with_span(Span::new(span.start, ident.span.end)))
12173            }
12174            unexpected => self.expected(
12175                "a value",
12176                TokenWithSpan {
12177                    token: unexpected,
12178                    span,
12179                },
12180            ),
12181        }
12182    }
12183
12184    fn maybe_concat_string_literal(&mut self, mut str: String) -> String {
12185        if self.dialect.supports_string_literal_concatenation() {
12186            while let Token::SingleQuotedString(ref s) | Token::DoubleQuotedString(ref s) =
12187                self.peek_token_ref().token
12188            {
12189                str.push_str(s);
12190                self.advance_token();
12191            }
12192        } else if self
12193            .dialect
12194            .supports_string_literal_concatenation_with_newline()
12195        {
12196            // We are iterating over tokens including whitespaces, to identify
12197            // string literals separated by newlines so we can concatenate them.
12198            let mut after_newline = false;
12199            loop {
12200                match self.peek_token_no_skip().token {
12201                    Token::Whitespace(Whitespace::Newline) => {
12202                        after_newline = true;
12203                        self.next_token_no_skip();
12204                    }
12205                    Token::Whitespace(_) => {
12206                        self.next_token_no_skip();
12207                    }
12208                    Token::SingleQuotedString(ref s) | Token::DoubleQuotedString(ref s)
12209                        if after_newline =>
12210                    {
12211                        str.push_str(s.clone().as_str());
12212                        self.next_token_no_skip();
12213                        after_newline = false;
12214                    }
12215                    _ => break,
12216                }
12217            }
12218        }
12219
12220        str
12221    }
12222
12223    /// Parse an unsigned numeric literal
12224    pub fn parse_number_value(&mut self) -> Result<ValueWithSpan, ParserError> {
12225        let value_wrapper = self.parse_value()?;
12226        match &value_wrapper.value {
12227            Value::Number(_, _) => Ok(value_wrapper),
12228            Value::Placeholder(_) => Ok(value_wrapper),
12229            _ => {
12230                self.prev_token();
12231                self.expected_ref("literal number", self.peek_token_ref())
12232            }
12233        }
12234    }
12235
12236    /// Parse a numeric literal as an expression. Returns a [`Expr::UnaryOp`] if the number is signed,
12237    /// otherwise returns a [`Expr::Value`]
12238    pub fn parse_number(&mut self) -> Result<Expr, ParserError> {
12239        let next_token = self.next_token();
12240        match next_token.token {
12241            Token::Plus => Ok(Expr::UnaryOp {
12242                op: UnaryOperator::Plus,
12243                expr: Box::new(Expr::Value(self.parse_number_value()?)),
12244            }),
12245            Token::Minus => Ok(Expr::UnaryOp {
12246                op: UnaryOperator::Minus,
12247                expr: Box::new(Expr::Value(self.parse_number_value()?)),
12248            }),
12249            _ => {
12250                self.prev_token();
12251                Ok(Expr::Value(self.parse_number_value()?))
12252            }
12253        }
12254    }
12255
12256    fn parse_introduced_string_expr(&mut self) -> Result<Expr, ParserError> {
12257        let next_token = self.next_token();
12258        let span = next_token.span;
12259        match next_token.token {
12260            Token::SingleQuotedString(ref s) => Ok(Expr::Value(
12261                Value::SingleQuotedString(s.to_string()).with_span(span),
12262            )),
12263            Token::DoubleQuotedString(ref s) => Ok(Expr::Value(
12264                Value::DoubleQuotedString(s.to_string()).with_span(span),
12265            )),
12266            Token::HexStringLiteral(ref s) => Ok(Expr::Value(
12267                Value::HexStringLiteral(s.to_string()).with_span(span),
12268            )),
12269            unexpected => self.expected(
12270                "a string value",
12271                TokenWithSpan {
12272                    token: unexpected,
12273                    span,
12274                },
12275            ),
12276        }
12277    }
12278
12279    /// Parse an unsigned literal integer/long
12280    pub fn parse_literal_uint(&mut self) -> Result<u64, ParserError> {
12281        let next_token = self.next_token();
12282        match next_token.token {
12283            Token::Number(s, _) => Self::parse::<u64>(s, next_token.span.start),
12284            _ => self.expected("literal int", next_token),
12285        }
12286    }
12287
12288    /// Parse the body of a `CREATE FUNCTION` specified as a string.
12289    /// e.g. `CREATE FUNCTION ... AS $$ body $$`.
12290    fn parse_create_function_body_string(&mut self) -> Result<CreateFunctionBody, ParserError> {
12291        let parse_string_expr = |parser: &mut Parser| -> Result<Expr, ParserError> {
12292            let peek_token = parser.peek_token();
12293            let span = peek_token.span;
12294            match peek_token.token {
12295                Token::DollarQuotedString(s) if dialect_of!(parser is PostgreSqlDialect | GenericDialect) =>
12296                {
12297                    parser.next_token();
12298                    Ok(Expr::Value(Value::DollarQuotedString(s).with_span(span)))
12299                }
12300                _ => Ok(Expr::Value(
12301                    Value::SingleQuotedString(parser.parse_literal_string()?).with_span(span),
12302                )),
12303            }
12304        };
12305
12306        Ok(CreateFunctionBody::AsBeforeOptions {
12307            body: parse_string_expr(self)?,
12308            link_symbol: if self.consume_token(&Token::Comma) {
12309                Some(parse_string_expr(self)?)
12310            } else {
12311                None
12312            },
12313        })
12314    }
12315
12316    /// Parse a literal string
12317    pub fn parse_literal_string(&mut self) -> Result<String, ParserError> {
12318        let next_token = self.next_token();
12319        match next_token.token {
12320            Token::Word(Word {
12321                value,
12322                keyword: Keyword::NoKeyword,
12323                ..
12324            }) => Ok(value),
12325            Token::SingleQuotedString(s) => Ok(s),
12326            Token::DoubleQuotedString(s) => Ok(s),
12327            Token::EscapedStringLiteral(s) if dialect_of!(self is PostgreSqlDialect | GenericDialect) => {
12328                Ok(s)
12329            }
12330            Token::UnicodeStringLiteral(s) => Ok(s),
12331            _ => self.expected("literal string", next_token),
12332        }
12333    }
12334
12335    /// Parse a boolean string
12336    pub(crate) fn parse_boolean_string(&mut self) -> Result<bool, ParserError> {
12337        match self.parse_one_of_keywords(&[Keyword::TRUE, Keyword::FALSE]) {
12338            Some(Keyword::TRUE) => Ok(true),
12339            Some(Keyword::FALSE) => Ok(false),
12340            _ => self.expected_ref("TRUE or FALSE", self.peek_token_ref()),
12341        }
12342    }
12343
12344    /// Parse a literal unicode normalization clause
12345    pub fn parse_unicode_is_normalized(&mut self, expr: Expr) -> Result<Expr, ParserError> {
12346        let neg = self.parse_keyword(Keyword::NOT);
12347        let normalized_form = self.maybe_parse(|parser| {
12348            match parser.parse_one_of_keywords(&[
12349                Keyword::NFC,
12350                Keyword::NFD,
12351                Keyword::NFKC,
12352                Keyword::NFKD,
12353            ]) {
12354                Some(Keyword::NFC) => Ok(NormalizationForm::NFC),
12355                Some(Keyword::NFD) => Ok(NormalizationForm::NFD),
12356                Some(Keyword::NFKC) => Ok(NormalizationForm::NFKC),
12357                Some(Keyword::NFKD) => Ok(NormalizationForm::NFKD),
12358                _ => parser.expected_ref("unicode normalization form", parser.peek_token_ref()),
12359            }
12360        })?;
12361        if self.parse_keyword(Keyword::NORMALIZED) {
12362            return Ok(Expr::IsNormalized {
12363                expr: Box::new(expr),
12364                form: normalized_form,
12365                negated: neg,
12366            });
12367        }
12368        self.expected_ref("unicode normalization form", self.peek_token_ref())
12369    }
12370
12371    /// Parse parenthesized enum members, used with `ENUM(...)` type definitions.
12372    pub fn parse_enum_values(&mut self) -> Result<Vec<EnumMember>, ParserError> {
12373        self.expect_token(&Token::LParen)?;
12374        let values = self.parse_comma_separated(|parser| {
12375            let name = parser.parse_literal_string()?;
12376            let e = if parser.consume_token(&Token::Eq) {
12377                let value = parser.parse_number()?;
12378                EnumMember::NamedValue(name, value)
12379            } else {
12380                EnumMember::Name(name)
12381            };
12382            Ok(e)
12383        })?;
12384        self.expect_token(&Token::RParen)?;
12385
12386        Ok(values)
12387    }
12388
12389    /// Parse a SQL datatype (in the context of a CREATE TABLE statement for example)
12390    pub fn parse_data_type(&mut self) -> Result<DataType, ParserError> {
12391        let (ty, trailing_bracket) = self.parse_data_type_helper()?;
12392        if trailing_bracket.0 {
12393            return parser_err!(
12394                format!("unmatched > after parsing data type {ty}"),
12395                self.peek_token_ref()
12396            );
12397        }
12398
12399        Ok(ty)
12400    }
12401
12402    fn parse_data_type_helper(
12403        &mut self,
12404    ) -> Result<(DataType, MatchedTrailingBracket), ParserError> {
12405        let dialect = self.dialect;
12406        self.advance_token();
12407        let next_token = self.get_current_token();
12408        let next_token_index = self.get_current_index();
12409
12410        let mut trailing_bracket: MatchedTrailingBracket = false.into();
12411        let mut data = match &next_token.token {
12412            Token::Word(w) => match w.keyword {
12413                Keyword::BOOLEAN => Ok(DataType::Boolean),
12414                Keyword::BOOL => Ok(DataType::Bool),
12415                Keyword::FLOAT => {
12416                    let precision = self.parse_exact_number_optional_precision_scale()?;
12417
12418                    if self.parse_keyword(Keyword::UNSIGNED) {
12419                        Ok(DataType::FloatUnsigned(precision))
12420                    } else {
12421                        Ok(DataType::Float(precision))
12422                    }
12423                }
12424                Keyword::REAL => {
12425                    if self.parse_keyword(Keyword::UNSIGNED) {
12426                        Ok(DataType::RealUnsigned)
12427                    } else {
12428                        Ok(DataType::Real)
12429                    }
12430                }
12431                Keyword::FLOAT4 => Ok(DataType::Float4),
12432                Keyword::FLOAT32 => Ok(DataType::Float32),
12433                Keyword::FLOAT64 => Ok(DataType::Float64),
12434                Keyword::FLOAT8 => Ok(DataType::Float8),
12435                Keyword::DOUBLE => {
12436                    if self.parse_keyword(Keyword::PRECISION) {
12437                        if self.parse_keyword(Keyword::UNSIGNED) {
12438                            Ok(DataType::DoublePrecisionUnsigned)
12439                        } else {
12440                            Ok(DataType::DoublePrecision)
12441                        }
12442                    } else {
12443                        let precision = self.parse_exact_number_optional_precision_scale()?;
12444
12445                        if self.parse_keyword(Keyword::UNSIGNED) {
12446                            Ok(DataType::DoubleUnsigned(precision))
12447                        } else {
12448                            Ok(DataType::Double(precision))
12449                        }
12450                    }
12451                }
12452                Keyword::TINYINT => {
12453                    let optional_precision = self.parse_optional_precision();
12454                    if self.parse_keyword(Keyword::UNSIGNED) {
12455                        Ok(DataType::TinyIntUnsigned(optional_precision?))
12456                    } else {
12457                        if dialect.supports_data_type_signed_suffix() {
12458                            let _ = self.parse_keyword(Keyword::SIGNED);
12459                        }
12460                        Ok(DataType::TinyInt(optional_precision?))
12461                    }
12462                }
12463                Keyword::INT2 => {
12464                    let optional_precision = self.parse_optional_precision();
12465                    if self.parse_keyword(Keyword::UNSIGNED) {
12466                        Ok(DataType::Int2Unsigned(optional_precision?))
12467                    } else {
12468                        Ok(DataType::Int2(optional_precision?))
12469                    }
12470                }
12471                Keyword::SMALLINT => {
12472                    let optional_precision = self.parse_optional_precision();
12473                    if self.parse_keyword(Keyword::UNSIGNED) {
12474                        Ok(DataType::SmallIntUnsigned(optional_precision?))
12475                    } else {
12476                        if dialect.supports_data_type_signed_suffix() {
12477                            let _ = self.parse_keyword(Keyword::SIGNED);
12478                        }
12479                        Ok(DataType::SmallInt(optional_precision?))
12480                    }
12481                }
12482                Keyword::MEDIUMINT => {
12483                    let optional_precision = self.parse_optional_precision();
12484                    if self.parse_keyword(Keyword::UNSIGNED) {
12485                        Ok(DataType::MediumIntUnsigned(optional_precision?))
12486                    } else {
12487                        if dialect.supports_data_type_signed_suffix() {
12488                            let _ = self.parse_keyword(Keyword::SIGNED);
12489                        }
12490                        Ok(DataType::MediumInt(optional_precision?))
12491                    }
12492                }
12493                Keyword::INT => {
12494                    let optional_precision = self.parse_optional_precision();
12495                    if self.parse_keyword(Keyword::UNSIGNED) {
12496                        Ok(DataType::IntUnsigned(optional_precision?))
12497                    } else {
12498                        if dialect.supports_data_type_signed_suffix() {
12499                            let _ = self.parse_keyword(Keyword::SIGNED);
12500                        }
12501                        Ok(DataType::Int(optional_precision?))
12502                    }
12503                }
12504                Keyword::INT4 => {
12505                    let optional_precision = self.parse_optional_precision();
12506                    if self.parse_keyword(Keyword::UNSIGNED) {
12507                        Ok(DataType::Int4Unsigned(optional_precision?))
12508                    } else {
12509                        Ok(DataType::Int4(optional_precision?))
12510                    }
12511                }
12512                Keyword::INT8 => {
12513                    let optional_precision = self.parse_optional_precision();
12514                    if self.parse_keyword(Keyword::UNSIGNED) {
12515                        Ok(DataType::Int8Unsigned(optional_precision?))
12516                    } else {
12517                        Ok(DataType::Int8(optional_precision?))
12518                    }
12519                }
12520                Keyword::INT16 => Ok(DataType::Int16),
12521                Keyword::INT32 => Ok(DataType::Int32),
12522                Keyword::INT64 => Ok(DataType::Int64),
12523                Keyword::INT128 => Ok(DataType::Int128),
12524                Keyword::INT256 => Ok(DataType::Int256),
12525                Keyword::INTEGER => {
12526                    let optional_precision = self.parse_optional_precision();
12527                    if self.parse_keyword(Keyword::UNSIGNED) {
12528                        Ok(DataType::IntegerUnsigned(optional_precision?))
12529                    } else {
12530                        if dialect.supports_data_type_signed_suffix() {
12531                            let _ = self.parse_keyword(Keyword::SIGNED);
12532                        }
12533                        Ok(DataType::Integer(optional_precision?))
12534                    }
12535                }
12536                Keyword::BIGINT => {
12537                    let optional_precision = self.parse_optional_precision();
12538                    if self.parse_keyword(Keyword::UNSIGNED) {
12539                        Ok(DataType::BigIntUnsigned(optional_precision?))
12540                    } else {
12541                        if dialect.supports_data_type_signed_suffix() {
12542                            let _ = self.parse_keyword(Keyword::SIGNED);
12543                        }
12544                        Ok(DataType::BigInt(optional_precision?))
12545                    }
12546                }
12547                Keyword::HUGEINT => Ok(DataType::HugeInt),
12548                Keyword::UBIGINT => Ok(DataType::UBigInt),
12549                Keyword::UHUGEINT => Ok(DataType::UHugeInt),
12550                Keyword::USMALLINT => Ok(DataType::USmallInt),
12551                Keyword::UTINYINT => Ok(DataType::UTinyInt),
12552                Keyword::UINT8 => Ok(DataType::UInt8),
12553                Keyword::UINT16 => Ok(DataType::UInt16),
12554                Keyword::UINT32 => Ok(DataType::UInt32),
12555                Keyword::UINT64 => Ok(DataType::UInt64),
12556                Keyword::UINT128 => Ok(DataType::UInt128),
12557                Keyword::UINT256 => Ok(DataType::UInt256),
12558                Keyword::VARCHAR => Ok(DataType::Varchar(self.parse_optional_character_length()?)),
12559                Keyword::NVARCHAR => {
12560                    Ok(DataType::Nvarchar(self.parse_optional_character_length()?))
12561                }
12562                Keyword::CHARACTER => {
12563                    if self.parse_keyword(Keyword::VARYING) {
12564                        Ok(DataType::CharacterVarying(
12565                            self.parse_optional_character_length()?,
12566                        ))
12567                    } else if self.parse_keywords(&[Keyword::LARGE, Keyword::OBJECT]) {
12568                        Ok(DataType::CharacterLargeObject(
12569                            self.parse_optional_precision()?,
12570                        ))
12571                    } else {
12572                        Ok(DataType::Character(self.parse_optional_character_length()?))
12573                    }
12574                }
12575                Keyword::CHAR => {
12576                    if self.parse_keyword(Keyword::VARYING) {
12577                        Ok(DataType::CharVarying(
12578                            self.parse_optional_character_length()?,
12579                        ))
12580                    } else if self.parse_keywords(&[Keyword::LARGE, Keyword::OBJECT]) {
12581                        Ok(DataType::CharLargeObject(self.parse_optional_precision()?))
12582                    } else {
12583                        Ok(DataType::Char(self.parse_optional_character_length()?))
12584                    }
12585                }
12586                Keyword::CLOB => Ok(DataType::Clob(self.parse_optional_precision()?)),
12587                Keyword::BINARY => Ok(DataType::Binary(self.parse_optional_precision()?)),
12588                Keyword::VARBINARY => Ok(DataType::Varbinary(self.parse_optional_binary_length()?)),
12589                Keyword::BLOB => Ok(DataType::Blob(self.parse_optional_precision()?)),
12590                Keyword::TINYBLOB => Ok(DataType::TinyBlob),
12591                Keyword::MEDIUMBLOB => Ok(DataType::MediumBlob),
12592                Keyword::LONGBLOB => Ok(DataType::LongBlob),
12593                Keyword::LONG if self.dialect.supports_long_type_as_bigint() => {
12594                    Ok(DataType::BigInt(None))
12595                }
12596                Keyword::BYTES => Ok(DataType::Bytes(self.parse_optional_precision()?)),
12597                Keyword::BIT => {
12598                    if self.parse_keyword(Keyword::VARYING) {
12599                        Ok(DataType::BitVarying(self.parse_optional_precision()?))
12600                    } else {
12601                        Ok(DataType::Bit(self.parse_optional_precision()?))
12602                    }
12603                }
12604                Keyword::VARBIT => Ok(DataType::VarBit(self.parse_optional_precision()?)),
12605                Keyword::UUID => Ok(DataType::Uuid),
12606                Keyword::DATE => Ok(DataType::Date),
12607                Keyword::DATE32 => Ok(DataType::Date32),
12608                Keyword::DATETIME => Ok(DataType::Datetime(self.parse_optional_precision()?)),
12609                Keyword::DATETIME64 => {
12610                    self.prev_token();
12611                    let (precision, time_zone) = self.parse_datetime_64()?;
12612                    Ok(DataType::Datetime64(precision, time_zone))
12613                }
12614                Keyword::TIMESTAMP => {
12615                    let precision = self.parse_optional_precision()?;
12616                    let tz = if self.parse_keyword(Keyword::WITH) {
12617                        self.expect_keywords(&[Keyword::TIME, Keyword::ZONE])?;
12618                        TimezoneInfo::WithTimeZone
12619                    } else if self.parse_keyword(Keyword::WITHOUT) {
12620                        self.expect_keywords(&[Keyword::TIME, Keyword::ZONE])?;
12621                        TimezoneInfo::WithoutTimeZone
12622                    } else {
12623                        TimezoneInfo::None
12624                    };
12625                    Ok(DataType::Timestamp(precision, tz))
12626                }
12627                Keyword::TIMESTAMPTZ => Ok(DataType::Timestamp(
12628                    self.parse_optional_precision()?,
12629                    TimezoneInfo::Tz,
12630                )),
12631                Keyword::TIMESTAMP_NTZ => {
12632                    Ok(DataType::TimestampNtz(self.parse_optional_precision()?))
12633                }
12634                Keyword::TIME => {
12635                    let precision = self.parse_optional_precision()?;
12636                    let tz = if self.parse_keyword(Keyword::WITH) {
12637                        self.expect_keywords(&[Keyword::TIME, Keyword::ZONE])?;
12638                        TimezoneInfo::WithTimeZone
12639                    } else if self.parse_keyword(Keyword::WITHOUT) {
12640                        self.expect_keywords(&[Keyword::TIME, Keyword::ZONE])?;
12641                        TimezoneInfo::WithoutTimeZone
12642                    } else {
12643                        TimezoneInfo::None
12644                    };
12645                    Ok(DataType::Time(precision, tz))
12646                }
12647                Keyword::TIMETZ => Ok(DataType::Time(
12648                    self.parse_optional_precision()?,
12649                    TimezoneInfo::Tz,
12650                )),
12651                Keyword::INTERVAL => {
12652                    if self.dialect.supports_interval_options() {
12653                        let fields = self.maybe_parse_optional_interval_fields()?;
12654                        let precision = self.parse_optional_precision()?;
12655                        Ok(DataType::Interval { fields, precision })
12656                    } else {
12657                        Ok(DataType::Interval {
12658                            fields: None,
12659                            precision: None,
12660                        })
12661                    }
12662                }
12663                Keyword::JSON => Ok(DataType::JSON),
12664                Keyword::JSONB => Ok(DataType::JSONB),
12665                Keyword::REGCLASS => Ok(DataType::Regclass),
12666                Keyword::STRING => Ok(DataType::String(self.parse_optional_precision()?)),
12667                Keyword::FIXEDSTRING => {
12668                    self.expect_token(&Token::LParen)?;
12669                    let character_length = self.parse_literal_uint()?;
12670                    self.expect_token(&Token::RParen)?;
12671                    Ok(DataType::FixedString(character_length))
12672                }
12673                Keyword::TEXT => {
12674                    if let Some(modifiers) = self.parse_optional_type_modifiers()? {
12675                        Ok(DataType::Custom(
12676                            ObjectName::from(vec![Ident::new("TEXT")]),
12677                            modifiers,
12678                        ))
12679                    } else {
12680                        Ok(DataType::Text)
12681                    }
12682                }
12683                Keyword::TINYTEXT => Ok(DataType::TinyText),
12684                Keyword::MEDIUMTEXT => Ok(DataType::MediumText),
12685                Keyword::LONGTEXT => Ok(DataType::LongText),
12686                Keyword::BYTEA => Ok(DataType::Bytea),
12687                Keyword::NUMERIC => Ok(DataType::Numeric(
12688                    self.parse_exact_number_optional_precision_scale()?,
12689                )),
12690                Keyword::DECIMAL => {
12691                    let precision = self.parse_exact_number_optional_precision_scale()?;
12692
12693                    if self.parse_keyword(Keyword::UNSIGNED) {
12694                        Ok(DataType::DecimalUnsigned(precision))
12695                    } else {
12696                        Ok(DataType::Decimal(precision))
12697                    }
12698                }
12699                Keyword::DEC => {
12700                    let precision = self.parse_exact_number_optional_precision_scale()?;
12701
12702                    if self.parse_keyword(Keyword::UNSIGNED) {
12703                        Ok(DataType::DecUnsigned(precision))
12704                    } else {
12705                        Ok(DataType::Dec(precision))
12706                    }
12707                }
12708                Keyword::BIGNUMERIC => Ok(DataType::BigNumeric(
12709                    self.parse_exact_number_optional_precision_scale()?,
12710                )),
12711                Keyword::BIGDECIMAL => Ok(DataType::BigDecimal(
12712                    self.parse_exact_number_optional_precision_scale()?,
12713                )),
12714                Keyword::ENUM => Ok(DataType::Enum(self.parse_enum_values()?, None)),
12715                Keyword::ENUM8 => Ok(DataType::Enum(self.parse_enum_values()?, Some(8))),
12716                Keyword::ENUM16 => Ok(DataType::Enum(self.parse_enum_values()?, Some(16))),
12717                Keyword::SET => Ok(DataType::Set(self.parse_string_values()?)),
12718                Keyword::ARRAY => {
12719                    if self.dialect.supports_array_typedef_without_element_type() {
12720                        Ok(DataType::Array(ArrayElemTypeDef::None))
12721                    } else if dialect_of!(self is ClickHouseDialect) {
12722                        Ok(self.parse_sub_type(|internal_type| {
12723                            DataType::Array(ArrayElemTypeDef::Parenthesis(internal_type))
12724                        })?)
12725                    } else {
12726                        self.expect_token(&Token::Lt)?;
12727                        let (inside_type, _trailing_bracket) = self.parse_data_type_helper()?;
12728                        trailing_bracket = self.expect_closing_angle_bracket(_trailing_bracket)?;
12729                        Ok(DataType::Array(ArrayElemTypeDef::AngleBracket(Box::new(
12730                            inside_type,
12731                        ))))
12732                    }
12733                }
12734                Keyword::STRUCT if dialect_is!(dialect is DuckDbDialect) => {
12735                    self.prev_token();
12736                    let field_defs = self.parse_duckdb_struct_type_def()?;
12737                    Ok(DataType::Struct(field_defs, StructBracketKind::Parentheses))
12738                }
12739                Keyword::STRUCT if self.dialect.supports_struct_literal() => {
12740                    self.prev_token();
12741                    let (field_defs, _trailing_bracket) =
12742                        self.parse_struct_type_def(Self::parse_struct_field_def)?;
12743                    trailing_bracket = _trailing_bracket;
12744                    Ok(DataType::Struct(
12745                        field_defs,
12746                        StructBracketKind::AngleBrackets,
12747                    ))
12748                }
12749                Keyword::UNION if dialect_is!(dialect is DuckDbDialect | GenericDialect) => {
12750                    self.prev_token();
12751                    let fields = self.parse_union_type_def()?;
12752                    Ok(DataType::Union(fields))
12753                }
12754                Keyword::NULLABLE if dialect_is!(dialect is ClickHouseDialect | GenericDialect) => {
12755                    Ok(self.parse_sub_type(DataType::Nullable)?)
12756                }
12757                Keyword::LOWCARDINALITY if dialect_is!(dialect is ClickHouseDialect | GenericDialect) => {
12758                    Ok(self.parse_sub_type(DataType::LowCardinality)?)
12759                }
12760                Keyword::MAP if self.dialect.supports_map_literal_with_angle_brackets() => {
12761                    self.expect_token(&Token::Lt)?;
12762                    let key_data_type = self.parse_data_type()?;
12763                    self.expect_token(&Token::Comma)?;
12764                    let (value_data_type, _trailing_bracket) = self.parse_data_type_helper()?;
12765                    trailing_bracket = self.expect_closing_angle_bracket(_trailing_bracket)?;
12766                    Ok(DataType::Map(
12767                        Box::new(key_data_type),
12768                        Box::new(value_data_type),
12769                    ))
12770                }
12771                Keyword::MAP if dialect_is!(dialect is ClickHouseDialect | GenericDialect) => {
12772                    self.prev_token();
12773                    let (key_data_type, value_data_type) = self.parse_click_house_map_def()?;
12774                    Ok(DataType::Map(
12775                        Box::new(key_data_type),
12776                        Box::new(value_data_type),
12777                    ))
12778                }
12779                Keyword::NESTED if dialect_is!(dialect is ClickHouseDialect | GenericDialect) => {
12780                    self.expect_token(&Token::LParen)?;
12781                    let field_defs = self.parse_comma_separated(Parser::parse_column_def)?;
12782                    self.expect_token(&Token::RParen)?;
12783                    Ok(DataType::Nested(field_defs))
12784                }
12785                Keyword::TUPLE if dialect_is!(dialect is ClickHouseDialect | GenericDialect) => {
12786                    self.prev_token();
12787                    let field_defs = self.parse_click_house_tuple_def()?;
12788                    Ok(DataType::Tuple(field_defs))
12789                }
12790                Keyword::TRIGGER => Ok(DataType::Trigger),
12791                Keyword::ANY if self.peek_keyword(Keyword::TYPE) => {
12792                    let _ = self.parse_keyword(Keyword::TYPE);
12793                    Ok(DataType::AnyType)
12794                }
12795                Keyword::TABLE => {
12796                    // an LParen after the TABLE keyword indicates that table columns are being defined
12797                    // whereas no LParen indicates an anonymous table expression will be returned
12798                    if self.peek_token_ref().token == Token::LParen {
12799                        let columns = self.parse_returns_table_columns()?;
12800                        Ok(DataType::Table(Some(columns)))
12801                    } else {
12802                        Ok(DataType::Table(None))
12803                    }
12804                }
12805                Keyword::SIGNED => {
12806                    if self.parse_keyword(Keyword::INTEGER) {
12807                        Ok(DataType::SignedInteger)
12808                    } else {
12809                        Ok(DataType::Signed)
12810                    }
12811                }
12812                Keyword::UNSIGNED => {
12813                    if self.parse_keyword(Keyword::INTEGER) {
12814                        Ok(DataType::UnsignedInteger)
12815                    } else {
12816                        Ok(DataType::Unsigned)
12817                    }
12818                }
12819                Keyword::TSVECTOR if dialect_is!(dialect is PostgreSqlDialect | GenericDialect) => {
12820                    Ok(DataType::TsVector)
12821                }
12822                Keyword::TSQUERY if dialect_is!(dialect is PostgreSqlDialect | GenericDialect) => {
12823                    Ok(DataType::TsQuery)
12824                }
12825                _ => {
12826                    self.prev_token();
12827                    let type_name = self.parse_object_name(false)?;
12828                    if let Some(modifiers) = self.parse_optional_type_modifiers()? {
12829                        Ok(DataType::Custom(type_name, modifiers))
12830                    } else {
12831                        Ok(DataType::Custom(type_name, vec![]))
12832                    }
12833                }
12834            },
12835            _ => self.expected_at("a data type name", next_token_index),
12836        }?;
12837
12838        if self.dialect.supports_array_typedef_with_brackets() {
12839            while self.consume_token(&Token::LBracket) {
12840                // Parse optional array data type size
12841                let size = self.maybe_parse(|p| p.parse_literal_uint())?;
12842                self.expect_token(&Token::RBracket)?;
12843                data = DataType::Array(ArrayElemTypeDef::SquareBracket(Box::new(data), size))
12844            }
12845        }
12846        Ok((data, trailing_bracket))
12847    }
12848
12849    fn parse_returns_table_column(&mut self) -> Result<ColumnDef, ParserError> {
12850        self.parse_column_def()
12851    }
12852
12853    fn parse_returns_table_columns(&mut self) -> Result<Vec<ColumnDef>, ParserError> {
12854        self.expect_token(&Token::LParen)?;
12855        let columns = self.parse_comma_separated(Parser::parse_returns_table_column)?;
12856        self.expect_token(&Token::RParen)?;
12857        Ok(columns)
12858    }
12859
12860    /// Parse a parenthesized, comma-separated list of single-quoted strings.
12861    pub fn parse_string_values(&mut self) -> Result<Vec<String>, ParserError> {
12862        self.expect_token(&Token::LParen)?;
12863        let mut values = Vec::new();
12864        loop {
12865            let next_token = self.next_token();
12866            match next_token.token {
12867                Token::SingleQuotedString(value) => values.push(value),
12868                _ => self.expected("a string", next_token)?,
12869            }
12870            let next_token = self.next_token();
12871            match next_token.token {
12872                Token::Comma => (),
12873                Token::RParen => break,
12874                _ => self.expected(", or }", next_token)?,
12875            }
12876        }
12877        Ok(values)
12878    }
12879
12880    /// Strictly parse `identifier AS identifier`
12881    pub fn parse_identifier_with_alias(&mut self) -> Result<IdentWithAlias, ParserError> {
12882        let ident = self.parse_identifier()?;
12883        self.expect_keyword_is(Keyword::AS)?;
12884        let alias = self.parse_identifier()?;
12885        Ok(IdentWithAlias { ident, alias })
12886    }
12887
12888    /// Parse `identifier [AS] identifier` where the AS keyword is optional
12889    fn parse_identifier_with_optional_alias(&mut self) -> Result<IdentWithAlias, ParserError> {
12890        let ident = self.parse_identifier()?;
12891        let _after_as = self.parse_keyword(Keyword::AS);
12892        let alias = self.parse_identifier()?;
12893        Ok(IdentWithAlias { ident, alias })
12894    }
12895
12896    /// Parse comma-separated list of parenthesized queries for pipe operators
12897    fn parse_pipe_operator_queries(&mut self) -> Result<Vec<Query>, ParserError> {
12898        self.parse_comma_separated(|parser| {
12899            parser.expect_token(&Token::LParen)?;
12900            let query = parser.parse_query()?;
12901            parser.expect_token(&Token::RParen)?;
12902            Ok(*query)
12903        })
12904    }
12905
12906    /// Parse set quantifier for pipe operators that require DISTINCT. E.g. INTERSECT and EXCEPT
12907    fn parse_distinct_required_set_quantifier(
12908        &mut self,
12909        operator_name: &str,
12910    ) -> Result<SetQuantifier, ParserError> {
12911        let quantifier = self.parse_set_quantifier(&Some(SetOperator::Intersect));
12912        match quantifier {
12913            SetQuantifier::Distinct | SetQuantifier::DistinctByName => Ok(quantifier),
12914            _ => Err(ParserError::ParserError(format!(
12915                "{operator_name} pipe operator requires DISTINCT modifier",
12916            ))),
12917        }
12918    }
12919
12920    /// Parse optional identifier alias (with or without AS keyword)
12921    fn parse_identifier_optional_alias(&mut self) -> Result<Option<Ident>, ParserError> {
12922        if self.parse_keyword(Keyword::AS) {
12923            Ok(Some(self.parse_identifier()?))
12924        } else {
12925            // Check if the next token is an identifier (implicit alias)
12926            self.maybe_parse(|parser| parser.parse_identifier())
12927        }
12928    }
12929
12930    /// Optionally parses an alias for a select list item
12931    fn maybe_parse_select_item_alias(&mut self) -> Result<Option<Ident>, ParserError> {
12932        fn validator(explicit: bool, kw: &Keyword, parser: &mut Parser) -> bool {
12933            parser.dialect.is_select_item_alias(explicit, kw, parser)
12934        }
12935        self.parse_optional_alias_inner(None, validator)
12936    }
12937
12938    /// Optionally parses an alias for a table like in `... FROM generate_series(1, 10) AS t (col)`.
12939    /// In this case, the alias is allowed to optionally name the columns in the table, in
12940    /// addition to the table itself.
12941    pub fn maybe_parse_table_alias(&mut self) -> Result<Option<TableAlias>, ParserError> {
12942        fn validator(explicit: bool, kw: &Keyword, parser: &mut Parser) -> bool {
12943            parser.dialect.is_table_factor_alias(explicit, kw, parser)
12944        }
12945        let explicit = self.peek_keyword(Keyword::AS);
12946        match self.parse_optional_alias_inner(None, validator)? {
12947            Some(name) => {
12948                let columns = self.parse_table_alias_column_defs()?;
12949                let at = if self.dialect.supports_partiql() && self.parse_keyword(Keyword::AT) {
12950                    Some(self.parse_identifier()?)
12951                } else {
12952                    None
12953                };
12954                Ok(Some(TableAlias {
12955                    explicit,
12956                    name,
12957                    columns,
12958                    at,
12959                }))
12960            }
12961            None => Ok(None),
12962        }
12963    }
12964
12965    fn parse_table_index_hints(&mut self) -> Result<Vec<TableIndexHints>, ParserError> {
12966        let mut hints = vec![];
12967        while let Some(hint_type) =
12968            self.parse_one_of_keywords(&[Keyword::USE, Keyword::IGNORE, Keyword::FORCE])
12969        {
12970            let hint_type = match hint_type {
12971                Keyword::USE => TableIndexHintType::Use,
12972                Keyword::IGNORE => TableIndexHintType::Ignore,
12973                Keyword::FORCE => TableIndexHintType::Force,
12974                _ => {
12975                    return self.expected_ref(
12976                        "expected to match USE/IGNORE/FORCE keyword",
12977                        self.peek_token_ref(),
12978                    )
12979                }
12980            };
12981            let index_type = match self.parse_one_of_keywords(&[Keyword::INDEX, Keyword::KEY]) {
12982                Some(Keyword::INDEX) => TableIndexType::Index,
12983                Some(Keyword::KEY) => TableIndexType::Key,
12984                _ => {
12985                    return self
12986                        .expected_ref("expected to match INDEX/KEY keyword", self.peek_token_ref())
12987                }
12988            };
12989            let for_clause = if self.parse_keyword(Keyword::FOR) {
12990                let clause = if self.parse_keyword(Keyword::JOIN) {
12991                    TableIndexHintForClause::Join
12992                } else if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
12993                    TableIndexHintForClause::OrderBy
12994                } else if self.parse_keywords(&[Keyword::GROUP, Keyword::BY]) {
12995                    TableIndexHintForClause::GroupBy
12996                } else {
12997                    return self.expected_ref(
12998                        "expected to match FOR/ORDER BY/GROUP BY table hint in for clause",
12999                        self.peek_token_ref(),
13000                    );
13001                };
13002                Some(clause)
13003            } else {
13004                None
13005            };
13006
13007            self.expect_token(&Token::LParen)?;
13008            let index_names = if self.peek_token_ref().token != Token::RParen {
13009                self.parse_comma_separated(Parser::parse_identifier)?
13010            } else {
13011                vec![]
13012            };
13013            self.expect_token(&Token::RParen)?;
13014            hints.push(TableIndexHints {
13015                hint_type,
13016                index_type,
13017                for_clause,
13018                index_names,
13019            });
13020        }
13021        Ok(hints)
13022    }
13023
13024    /// Wrapper for parse_optional_alias_inner, left for backwards-compatibility
13025    /// but new flows should use the context-specific methods such as `maybe_parse_select_item_alias`
13026    /// and `maybe_parse_table_alias`.
13027    pub fn parse_optional_alias(
13028        &mut self,
13029        reserved_kwds: &[Keyword],
13030    ) -> Result<Option<Ident>, ParserError> {
13031        fn validator(_explicit: bool, _kw: &Keyword, _parser: &mut Parser) -> bool {
13032            false
13033        }
13034        self.parse_optional_alias_inner(Some(reserved_kwds), validator)
13035    }
13036
13037    /// Parses an optional alias after a SQL element such as a select list item
13038    /// or a table name.
13039    ///
13040    /// This method accepts an optional list of reserved keywords or a function
13041    /// to call to validate if a keyword should be parsed as an alias, to allow
13042    /// callers to customize the parsing logic based on their context.
13043    fn parse_optional_alias_inner<F>(
13044        &mut self,
13045        reserved_kwds: Option<&[Keyword]>,
13046        validator: F,
13047    ) -> Result<Option<Ident>, ParserError>
13048    where
13049        F: Fn(bool, &Keyword, &mut Parser) -> bool,
13050    {
13051        let after_as = self.parse_keyword(Keyword::AS);
13052
13053        let next_token = self.next_token();
13054        match next_token.token {
13055            // Accepts a keyword as an alias if the AS keyword explicitly indicate an alias or if the
13056            // caller provided a list of reserved keywords and the keyword is not on that list.
13057            Token::Word(w)
13058                if reserved_kwds.is_some()
13059                    && (after_as || reserved_kwds.is_some_and(|x| !x.contains(&w.keyword))) =>
13060            {
13061                Ok(Some(w.into_ident(next_token.span)))
13062            }
13063            // Accepts a keyword as alias based on the caller's context, such as to what SQL element
13064            // this word is a potential alias of using the validator call-back. This allows for
13065            // dialect-specific logic.
13066            Token::Word(w) if validator(after_as, &w.keyword, self) => {
13067                Ok(Some(w.into_ident(next_token.span)))
13068            }
13069            // For backwards-compatibility, we accept quoted strings as aliases regardless of the context.
13070            Token::SingleQuotedString(s) => Ok(Some(Ident::with_quote('\'', s))),
13071            Token::DoubleQuotedString(s) => Ok(Some(Ident::with_quote('\"', s))),
13072            _ => {
13073                if after_as {
13074                    return self.expected("an identifier after AS", next_token);
13075                }
13076                self.prev_token();
13077                Ok(None) // no alias found
13078            }
13079        }
13080    }
13081
13082    /// Parse an optional `GROUP BY` clause, returning `Some(GroupByExpr)` when present.
13083    pub fn parse_optional_group_by(&mut self) -> Result<Option<GroupByExpr>, ParserError> {
13084        if self.parse_keywords(&[Keyword::GROUP, Keyword::BY]) {
13085            let expressions = if self.parse_keyword(Keyword::ALL) {
13086                None
13087            } else {
13088                Some(self.parse_comma_separated(Parser::parse_group_by_expr)?)
13089            };
13090
13091            let mut modifiers = vec![];
13092            if self.dialect.supports_group_by_with_modifier() {
13093                loop {
13094                    if !self.parse_keyword(Keyword::WITH) {
13095                        break;
13096                    }
13097                    let keyword = self.expect_one_of_keywords(&[
13098                        Keyword::ROLLUP,
13099                        Keyword::CUBE,
13100                        Keyword::TOTALS,
13101                    ])?;
13102                    modifiers.push(match keyword {
13103                        Keyword::ROLLUP => GroupByWithModifier::Rollup,
13104                        Keyword::CUBE => GroupByWithModifier::Cube,
13105                        Keyword::TOTALS => GroupByWithModifier::Totals,
13106                        _ => {
13107                            return parser_err!(
13108                                "BUG: expected to match GroupBy modifier keyword",
13109                                self.peek_token_ref().span.start
13110                            )
13111                        }
13112                    });
13113                }
13114            }
13115            if self.parse_keywords(&[Keyword::GROUPING, Keyword::SETS]) {
13116                self.expect_token(&Token::LParen)?;
13117                let result = self.parse_comma_separated(|p| {
13118                    if p.peek_token_ref().token == Token::LParen {
13119                        p.parse_tuple(true, true)
13120                    } else {
13121                        Ok(vec![p.parse_expr()?])
13122                    }
13123                })?;
13124                self.expect_token(&Token::RParen)?;
13125                modifiers.push(GroupByWithModifier::GroupingSets(Expr::GroupingSets(
13126                    result,
13127                )));
13128            };
13129            let group_by = match expressions {
13130                None => GroupByExpr::All(modifiers),
13131                Some(exprs) => GroupByExpr::Expressions(exprs, modifiers),
13132            };
13133            Ok(Some(group_by))
13134        } else {
13135            Ok(None)
13136        }
13137    }
13138
13139    /// Parse an optional `ORDER BY` clause, returning `Some(OrderBy)` when present.
13140    pub fn parse_optional_order_by(&mut self) -> Result<Option<OrderBy>, ParserError> {
13141        if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
13142            let order_by =
13143                if self.dialect.supports_order_by_all() && self.parse_keyword(Keyword::ALL) {
13144                    let order_by_options = self.parse_order_by_options()?;
13145                    OrderBy {
13146                        kind: OrderByKind::All(order_by_options),
13147                        interpolate: None,
13148                    }
13149                } else {
13150                    let exprs = self.parse_comma_separated(Parser::parse_order_by_expr)?;
13151                    let interpolate = if self.dialect.supports_interpolate() {
13152                        self.parse_interpolations()?
13153                    } else {
13154                        None
13155                    };
13156                    OrderBy {
13157                        kind: OrderByKind::Expressions(exprs),
13158                        interpolate,
13159                    }
13160                };
13161            Ok(Some(order_by))
13162        } else {
13163            Ok(None)
13164        }
13165    }
13166
13167    fn parse_optional_limit_clause(&mut self) -> Result<Option<LimitClause>, ParserError> {
13168        let mut offset = if self.parse_keyword(Keyword::OFFSET) {
13169            Some(self.parse_offset()?)
13170        } else {
13171            None
13172        };
13173
13174        let (limit, limit_by) = if self.parse_keyword(Keyword::LIMIT) {
13175            let expr = self.parse_limit()?;
13176
13177            if self.dialect.supports_limit_comma()
13178                && offset.is_none()
13179                && expr.is_some() // ALL not supported with comma
13180                && self.consume_token(&Token::Comma)
13181            {
13182                let offset = expr.ok_or_else(|| {
13183                    ParserError::ParserError(
13184                        "Missing offset for LIMIT <offset>, <limit>".to_string(),
13185                    )
13186                })?;
13187                return Ok(Some(LimitClause::OffsetCommaLimit {
13188                    offset,
13189                    limit: self.parse_expr()?,
13190                }));
13191            }
13192
13193            let limit_by = if self.dialect.supports_limit_by() && self.parse_keyword(Keyword::BY) {
13194                Some(self.parse_comma_separated(Parser::parse_expr)?)
13195            } else {
13196                None
13197            };
13198
13199            (Some(expr), limit_by)
13200        } else {
13201            (None, None)
13202        };
13203
13204        if offset.is_none() && limit.is_some() && self.parse_keyword(Keyword::OFFSET) {
13205            offset = Some(self.parse_offset()?);
13206        }
13207
13208        if offset.is_some() || (limit.is_some() && limit != Some(None)) || limit_by.is_some() {
13209            Ok(Some(LimitClause::LimitOffset {
13210                limit: limit.unwrap_or_default(),
13211                offset,
13212                limit_by: limit_by.unwrap_or_default(),
13213            }))
13214        } else {
13215            Ok(None)
13216        }
13217    }
13218
13219    /// Parse a table object for insertion
13220    /// e.g. `some_database.some_table` or `FUNCTION some_table_func(...)`
13221    pub fn parse_table_object(&mut self) -> Result<TableObject, ParserError> {
13222        if self.dialect.supports_insert_table_function() && self.parse_keyword(Keyword::FUNCTION) {
13223            let fn_name = self.parse_object_name(false)?;
13224            self.parse_function_call(fn_name)
13225                .map(TableObject::TableFunction)
13226        } else if self.dialect.supports_insert_table_query() && self.peek_subquery_or_cte_start() {
13227            self.parse_parenthesized(|p| p.parse_query())
13228                .map(TableObject::TableQuery)
13229        } else {
13230            self.parse_object_name(false).map(TableObject::TableName)
13231        }
13232    }
13233
13234    /// Parse a possibly qualified, possibly quoted identifier, e.g.
13235    /// `foo` or `myschema."table"
13236    ///
13237    /// The `in_table_clause` parameter indicates whether the object name is a table in a FROM, JOIN,
13238    /// or similar table clause. Currently, this is used only to support unquoted hyphenated identifiers
13239    /// in this context on BigQuery.
13240    pub fn parse_object_name(&mut self, in_table_clause: bool) -> Result<ObjectName, ParserError> {
13241        self.parse_object_name_inner(in_table_clause, false)
13242    }
13243
13244    /// Parse a possibly qualified, possibly quoted identifier, e.g.
13245    /// `foo` or `myschema."table"
13246    ///
13247    /// The `in_table_clause` parameter indicates whether the object name is a table in a FROM, JOIN,
13248    /// or similar table clause. Currently, this is used only to support unquoted hyphenated identifiers
13249    /// in this context on BigQuery.
13250    ///
13251    /// The `allow_wildcards` parameter indicates whether to allow for wildcards in the object name
13252    /// e.g. *, *.*, `foo`.*, or "foo"."bar"
13253    fn parse_object_name_inner(
13254        &mut self,
13255        in_table_clause: bool,
13256        allow_wildcards: bool,
13257    ) -> Result<ObjectName, ParserError> {
13258        let mut parts = vec![];
13259        if dialect_of!(self is BigQueryDialect) && in_table_clause {
13260            loop {
13261                let (ident, end_with_period) = self.parse_unquoted_hyphenated_identifier()?;
13262                parts.push(ObjectNamePart::Identifier(ident));
13263                if !self.consume_token(&Token::Period) && !end_with_period {
13264                    break;
13265                }
13266            }
13267        } else {
13268            loop {
13269                if allow_wildcards && self.peek_token_ref().token == Token::Mul {
13270                    let span = self.next_token().span;
13271                    parts.push(ObjectNamePart::Identifier(Ident {
13272                        value: Token::Mul.to_string(),
13273                        quote_style: None,
13274                        span,
13275                    }));
13276                } else if dialect_of!(self is BigQueryDialect) && in_table_clause {
13277                    let (ident, end_with_period) = self.parse_unquoted_hyphenated_identifier()?;
13278                    parts.push(ObjectNamePart::Identifier(ident));
13279                    if !self.consume_token(&Token::Period) && !end_with_period {
13280                        break;
13281                    }
13282                } else if self.dialect.supports_object_name_double_dot_notation()
13283                    && parts.len() == 1
13284                    && matches!(self.peek_token_ref().token, Token::Period)
13285                {
13286                    // Empty string here means default schema
13287                    parts.push(ObjectNamePart::Identifier(Ident::new("")));
13288                } else {
13289                    let ident = self.parse_identifier()?;
13290                    let part = if self
13291                        .dialect
13292                        .is_identifier_generating_function_name(&ident, &parts)
13293                    {
13294                        self.expect_token(&Token::LParen)?;
13295                        let args: Vec<FunctionArg> =
13296                            self.parse_comma_separated0(Self::parse_function_args, Token::RParen)?;
13297                        self.expect_token(&Token::RParen)?;
13298                        ObjectNamePart::Function(ObjectNamePartFunction { name: ident, args })
13299                    } else {
13300                        ObjectNamePart::Identifier(ident)
13301                    };
13302                    parts.push(part);
13303                }
13304
13305                if !self.consume_token(&Token::Period) {
13306                    break;
13307                }
13308            }
13309        }
13310
13311        // BigQuery accepts any number of quoted identifiers of a table name.
13312        // https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#quoted_identifiers
13313        if dialect_of!(self is BigQueryDialect)
13314            && parts.iter().any(|part| {
13315                part.as_ident()
13316                    .is_some_and(|ident| ident.value.contains('.'))
13317            })
13318        {
13319            parts = parts
13320                .into_iter()
13321                .flat_map(|part| match part.as_ident() {
13322                    Some(ident) => ident
13323                        .value
13324                        .split('.')
13325                        .map(|value| {
13326                            ObjectNamePart::Identifier(Ident {
13327                                value: value.into(),
13328                                quote_style: ident.quote_style,
13329                                span: ident.span,
13330                            })
13331                        })
13332                        .collect::<Vec<_>>(),
13333                    None => vec![part],
13334                })
13335                .collect()
13336        }
13337
13338        Ok(ObjectName(parts))
13339    }
13340
13341    /// Parse identifiers
13342    pub fn parse_identifiers(&mut self) -> Result<Vec<Ident>, ParserError> {
13343        let mut idents = vec![];
13344        loop {
13345            let token = self.peek_token_ref();
13346            match &token.token {
13347                Token::Word(w) => {
13348                    idents.push(w.to_ident(token.span));
13349                }
13350                Token::EOF | Token::Eq | Token::SemiColon | Token::VerticalBarRightAngleBracket => {
13351                    break
13352                }
13353                _ => {}
13354            }
13355            self.advance_token();
13356        }
13357        Ok(idents)
13358    }
13359
13360    /// Parse identifiers of form ident1[.identN]*
13361    ///
13362    /// Similar in functionality to [parse_identifiers], with difference
13363    /// being this function is much more strict about parsing a valid multipart identifier, not
13364    /// allowing extraneous tokens to be parsed, otherwise it fails.
13365    ///
13366    /// For example:
13367    ///
13368    /// ```rust
13369    /// use sqlparser::ast::Ident;
13370    /// use sqlparser::dialect::GenericDialect;
13371    /// use sqlparser::parser::Parser;
13372    ///
13373    /// let dialect = GenericDialect {};
13374    /// let expected = vec![Ident::new("one"), Ident::new("two")];
13375    ///
13376    /// // expected usage
13377    /// let sql = "one.two";
13378    /// let mut parser = Parser::new(&dialect).try_with_sql(sql).unwrap();
13379    /// let actual = parser.parse_multipart_identifier().unwrap();
13380    /// assert_eq!(&actual, &expected);
13381    ///
13382    /// // parse_identifiers is more loose on what it allows, parsing successfully
13383    /// let sql = "one + two";
13384    /// let mut parser = Parser::new(&dialect).try_with_sql(sql).unwrap();
13385    /// let actual = parser.parse_identifiers().unwrap();
13386    /// assert_eq!(&actual, &expected);
13387    ///
13388    /// // expected to strictly fail due to + separator
13389    /// let sql = "one + two";
13390    /// let mut parser = Parser::new(&dialect).try_with_sql(sql).unwrap();
13391    /// let actual = parser.parse_multipart_identifier().unwrap_err();
13392    /// assert_eq!(
13393    ///     actual.to_string(),
13394    ///     "sql parser error: Unexpected token in identifier: +"
13395    /// );
13396    /// ```
13397    ///
13398    /// [parse_identifiers]: Parser::parse_identifiers
13399    pub fn parse_multipart_identifier(&mut self) -> Result<Vec<Ident>, ParserError> {
13400        let mut idents = vec![];
13401
13402        // expecting at least one word for identifier
13403        let next_token = self.next_token();
13404        match next_token.token {
13405            Token::Word(w) => idents.push(w.into_ident(next_token.span)),
13406            Token::EOF => {
13407                return Err(ParserError::ParserError(
13408                    "Empty input when parsing identifier".to_string(),
13409                ))?
13410            }
13411            token => {
13412                return Err(ParserError::ParserError(format!(
13413                    "Unexpected token in identifier: {token}"
13414                )))?
13415            }
13416        };
13417
13418        // parse optional next parts if exist
13419        loop {
13420            match self.next_token().token {
13421                // ensure that optional period is succeeded by another identifier
13422                Token::Period => {
13423                    let next_token = self.next_token();
13424                    match next_token.token {
13425                        Token::Word(w) => idents.push(w.into_ident(next_token.span)),
13426                        Token::EOF => {
13427                            return Err(ParserError::ParserError(
13428                                "Trailing period in identifier".to_string(),
13429                            ))?
13430                        }
13431                        token => {
13432                            return Err(ParserError::ParserError(format!(
13433                                "Unexpected token following period in identifier: {token}"
13434                            )))?
13435                        }
13436                    }
13437                }
13438                Token::EOF => break,
13439                token => {
13440                    return Err(ParserError::ParserError(format!(
13441                        "Unexpected token in identifier: {token}"
13442                    )))?;
13443                }
13444            }
13445        }
13446
13447        Ok(idents)
13448    }
13449
13450    /// Parse a simple one-word identifier (possibly quoted, possibly a keyword)
13451    pub fn parse_identifier(&mut self) -> Result<Ident, ParserError> {
13452        let next_token = self.next_token();
13453        match next_token.token {
13454            Token::Word(w) => Ok(w.into_ident(next_token.span)),
13455            Token::SingleQuotedString(s) => Ok(Ident::with_quote('\'', s)),
13456            Token::DoubleQuotedString(s) => Ok(Ident::with_quote('\"', s)),
13457            _ => self.expected("identifier", next_token),
13458        }
13459    }
13460
13461    /// On BigQuery, hyphens are permitted in unquoted identifiers inside of a FROM or
13462    /// TABLE clause.
13463    ///
13464    /// The first segment must be an ordinary unquoted identifier, e.g. it must not start
13465    /// with a digit. Subsequent segments are either must either be valid identifiers or
13466    /// integers, e.g. foo-123 is allowed, but foo-123a is not.
13467    ///
13468    /// [BigQuery-lexical](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical)
13469    ///
13470    /// Return a tuple of the identifier and a boolean indicating it ends with a period.
13471    fn parse_unquoted_hyphenated_identifier(&mut self) -> Result<(Ident, bool), ParserError> {
13472        match self.peek_token().token {
13473            Token::Word(w) => {
13474                let quote_style_is_none = w.quote_style.is_none();
13475                let mut requires_whitespace = false;
13476                let mut ident = w.into_ident(self.next_token().span);
13477                if quote_style_is_none {
13478                    while matches!(self.peek_token_no_skip().token, Token::Minus) {
13479                        self.next_token();
13480                        ident.value.push('-');
13481
13482                        let token = self
13483                            .next_token_no_skip()
13484                            .cloned()
13485                            .unwrap_or(TokenWithSpan::wrap(Token::EOF));
13486                        requires_whitespace = match token.token {
13487                            Token::Word(next_word) if next_word.quote_style.is_none() => {
13488                                ident.value.push_str(&next_word.value);
13489                                false
13490                            }
13491                            Token::Number(s, false) => {
13492                                // A number token can represent a decimal value ending with a period, e.g., `Number('123.')`.
13493                                // However, for an [ObjectName], it is part of a hyphenated identifier, e.g., `foo-123.bar`.
13494                                //
13495                                // If a number token is followed by a period, it is part of an [ObjectName].
13496                                // Return the identifier with `true` if the number token is followed by a period, indicating that
13497                                // parsing should continue for the next part of the hyphenated identifier.
13498                                if s.ends_with('.') {
13499                                    let Some(s) = s.split('.').next().filter(|s| {
13500                                        !s.is_empty() && s.chars().all(|c| c.is_ascii_digit())
13501                                    }) else {
13502                                        return self.expected(
13503                                            "continuation of hyphenated identifier",
13504                                            TokenWithSpan::new(Token::Number(s, false), token.span),
13505                                        );
13506                                    };
13507                                    ident.value.push_str(s);
13508                                    return Ok((ident, true));
13509                                } else {
13510                                    ident.value.push_str(&s);
13511                                }
13512                                // If next token is period, then it is part of an ObjectName and we don't expect whitespace
13513                                // after the number.
13514                                !matches!(self.peek_token_ref().token, Token::Period)
13515                            }
13516                            _ => {
13517                                return self
13518                                    .expected("continuation of hyphenated identifier", token);
13519                            }
13520                        }
13521                    }
13522
13523                    // If the last segment was a number, we must check that it's followed by whitespace,
13524                    // otherwise foo-123a will be parsed as `foo-123` with the alias `a`.
13525                    if requires_whitespace {
13526                        let token = self.next_token();
13527                        if !matches!(token.token, Token::EOF | Token::Whitespace(_)) {
13528                            return self
13529                                .expected("whitespace following hyphenated identifier", token);
13530                        }
13531                    }
13532                }
13533                Ok((ident, false))
13534            }
13535            _ => Ok((self.parse_identifier()?, false)),
13536        }
13537    }
13538
13539    /// Parses a parenthesized, comma-separated list of column definitions within a view.
13540    fn parse_view_columns(&mut self) -> Result<Vec<ViewColumnDef>, ParserError> {
13541        if self.consume_token(&Token::LParen) {
13542            if self.peek_token_ref().token == Token::RParen {
13543                self.next_token();
13544                Ok(vec![])
13545            } else {
13546                let cols = self.parse_comma_separated_with_trailing_commas(
13547                    Parser::parse_view_column,
13548                    self.dialect.supports_column_definition_trailing_commas(),
13549                    Self::is_reserved_for_column_alias,
13550                )?;
13551                self.expect_token(&Token::RParen)?;
13552                Ok(cols)
13553            }
13554        } else {
13555            Ok(vec![])
13556        }
13557    }
13558
13559    /// Parses a column definition within a view.
13560    fn parse_view_column(&mut self) -> Result<ViewColumnDef, ParserError> {
13561        let name = self.parse_identifier()?;
13562        let options = self.parse_view_column_options()?;
13563        let data_type = if dialect_of!(self is ClickHouseDialect) {
13564            Some(self.parse_data_type()?)
13565        } else {
13566            None
13567        };
13568        Ok(ViewColumnDef {
13569            name,
13570            data_type,
13571            options,
13572        })
13573    }
13574
13575    fn parse_view_column_options(&mut self) -> Result<Option<ColumnOptions>, ParserError> {
13576        let mut options = Vec::new();
13577        loop {
13578            let option = self.parse_optional_column_option()?;
13579            if let Some(option) = option {
13580                options.push(option);
13581            } else {
13582                break;
13583            }
13584        }
13585        if options.is_empty() {
13586            Ok(None)
13587        } else if self.dialect.supports_space_separated_column_options() {
13588            Ok(Some(ColumnOptions::SpaceSeparated(options)))
13589        } else {
13590            Ok(Some(ColumnOptions::CommaSeparated(options)))
13591        }
13592    }
13593
13594    /// Parses a parenthesized comma-separated list of unqualified, possibly quoted identifiers.
13595    /// For example: `(col1, "col 2", ...)`
13596    pub fn parse_parenthesized_column_list(
13597        &mut self,
13598        optional: IsOptional,
13599        allow_empty: bool,
13600    ) -> Result<Vec<Ident>, ParserError> {
13601        self.parse_parenthesized_column_list_inner(optional, allow_empty, |p| p.parse_identifier())
13602    }
13603
13604    /// Parse a parenthesized list of compound identifiers as expressions.
13605    pub fn parse_parenthesized_compound_identifier_list(
13606        &mut self,
13607        optional: IsOptional,
13608        allow_empty: bool,
13609    ) -> Result<Vec<Expr>, ParserError> {
13610        self.parse_parenthesized_column_list_inner(optional, allow_empty, |p| {
13611            Ok(Expr::CompoundIdentifier(
13612                p.parse_period_separated(|p| p.parse_identifier())?,
13613            ))
13614        })
13615    }
13616
13617    /// Parses a parenthesized comma-separated list of index columns, which can be arbitrary
13618    /// expressions with ordering information (and an opclass in some dialects).
13619    fn parse_parenthesized_index_column_list(&mut self) -> Result<Vec<IndexColumn>, ParserError> {
13620        self.parse_parenthesized_column_list_inner(Mandatory, false, |p| {
13621            p.parse_create_index_expr()
13622        })
13623    }
13624
13625    /// Parses a parenthesized comma-separated list of qualified, possibly quoted identifiers.
13626    /// For example: `(db1.sc1.tbl1.col1, db1.sc1.tbl1."col 2", ...)`
13627    pub fn parse_parenthesized_qualified_column_list(
13628        &mut self,
13629        optional: IsOptional,
13630        allow_empty: bool,
13631    ) -> Result<Vec<ObjectName>, ParserError> {
13632        self.parse_parenthesized_column_list_inner(optional, allow_empty, |p| {
13633            p.parse_object_name(true)
13634        })
13635    }
13636
13637    /// Parses a parenthesized comma-separated list of columns using
13638    /// the provided function to parse each element.
13639    fn parse_parenthesized_column_list_inner<F, T>(
13640        &mut self,
13641        optional: IsOptional,
13642        allow_empty: bool,
13643        mut f: F,
13644    ) -> Result<Vec<T>, ParserError>
13645    where
13646        F: FnMut(&mut Parser) -> Result<T, ParserError>,
13647    {
13648        if self.consume_token(&Token::LParen) {
13649            if allow_empty && self.peek_token_ref().token == Token::RParen {
13650                self.next_token();
13651                Ok(vec![])
13652            } else {
13653                let cols = self.parse_comma_separated(|p| f(p))?;
13654                self.expect_token(&Token::RParen)?;
13655                Ok(cols)
13656            }
13657        } else if optional == Optional {
13658            Ok(vec![])
13659        } else {
13660            self.expected_ref("a list of columns in parentheses", self.peek_token_ref())
13661        }
13662    }
13663
13664    /// Parses a parenthesized comma-separated list of table alias column definitions.
13665    fn parse_table_alias_column_defs(&mut self) -> Result<Vec<TableAliasColumnDef>, ParserError> {
13666        if self.consume_token(&Token::LParen) {
13667            let cols = self.parse_comma_separated(|p| {
13668                let name = p.parse_identifier()?;
13669                let data_type = p.maybe_parse(|p| p.parse_data_type())?;
13670                Ok(TableAliasColumnDef { name, data_type })
13671            })?;
13672            self.expect_token(&Token::RParen)?;
13673            Ok(cols)
13674        } else {
13675            Ok(vec![])
13676        }
13677    }
13678
13679    /// Parse an unsigned precision value enclosed in parentheses, e.g. `(10)`.
13680    pub fn parse_precision(&mut self) -> Result<u64, ParserError> {
13681        self.expect_token(&Token::LParen)?;
13682        let n = self.parse_literal_uint()?;
13683        self.expect_token(&Token::RParen)?;
13684        Ok(n)
13685    }
13686
13687    /// Parse an optional precision `(n)` and return it as `Some(n)` when present.
13688    pub fn parse_optional_precision(&mut self) -> Result<Option<u64>, ParserError> {
13689        if self.consume_token(&Token::LParen) {
13690            let n = self.parse_literal_uint()?;
13691            self.expect_token(&Token::RParen)?;
13692            Ok(Some(n))
13693        } else {
13694            Ok(None)
13695        }
13696    }
13697
13698    fn maybe_parse_optional_interval_fields(
13699        &mut self,
13700    ) -> Result<Option<IntervalFields>, ParserError> {
13701        match self.parse_one_of_keywords(&[
13702            // Can be followed by `TO` option
13703            Keyword::YEAR,
13704            Keyword::DAY,
13705            Keyword::HOUR,
13706            Keyword::MINUTE,
13707            // No `TO` option
13708            Keyword::MONTH,
13709            Keyword::SECOND,
13710        ]) {
13711            Some(Keyword::YEAR) => {
13712                if self.peek_keyword(Keyword::TO) {
13713                    self.expect_keyword(Keyword::TO)?;
13714                    self.expect_keyword(Keyword::MONTH)?;
13715                    Ok(Some(IntervalFields::YearToMonth))
13716                } else {
13717                    Ok(Some(IntervalFields::Year))
13718                }
13719            }
13720            Some(Keyword::DAY) => {
13721                if self.peek_keyword(Keyword::TO) {
13722                    self.expect_keyword(Keyword::TO)?;
13723                    match self.expect_one_of_keywords(&[
13724                        Keyword::HOUR,
13725                        Keyword::MINUTE,
13726                        Keyword::SECOND,
13727                    ])? {
13728                        Keyword::HOUR => Ok(Some(IntervalFields::DayToHour)),
13729                        Keyword::MINUTE => Ok(Some(IntervalFields::DayToMinute)),
13730                        Keyword::SECOND => Ok(Some(IntervalFields::DayToSecond)),
13731                        _ => {
13732                            self.prev_token();
13733                            self.expected_ref("HOUR, MINUTE, or SECOND", self.peek_token_ref())
13734                        }
13735                    }
13736                } else {
13737                    Ok(Some(IntervalFields::Day))
13738                }
13739            }
13740            Some(Keyword::HOUR) => {
13741                if self.peek_keyword(Keyword::TO) {
13742                    self.expect_keyword(Keyword::TO)?;
13743                    match self.expect_one_of_keywords(&[Keyword::MINUTE, Keyword::SECOND])? {
13744                        Keyword::MINUTE => Ok(Some(IntervalFields::HourToMinute)),
13745                        Keyword::SECOND => Ok(Some(IntervalFields::HourToSecond)),
13746                        _ => {
13747                            self.prev_token();
13748                            self.expected_ref("MINUTE or SECOND", self.peek_token_ref())
13749                        }
13750                    }
13751                } else {
13752                    Ok(Some(IntervalFields::Hour))
13753                }
13754            }
13755            Some(Keyword::MINUTE) => {
13756                if self.peek_keyword(Keyword::TO) {
13757                    self.expect_keyword(Keyword::TO)?;
13758                    self.expect_keyword(Keyword::SECOND)?;
13759                    Ok(Some(IntervalFields::MinuteToSecond))
13760                } else {
13761                    Ok(Some(IntervalFields::Minute))
13762                }
13763            }
13764            Some(Keyword::MONTH) => Ok(Some(IntervalFields::Month)),
13765            Some(Keyword::SECOND) => Ok(Some(IntervalFields::Second)),
13766            Some(_) => {
13767                self.prev_token();
13768                self.expected_ref(
13769                    "YEAR, MONTH, DAY, HOUR, MINUTE, or SECOND",
13770                    self.peek_token_ref(),
13771                )
13772            }
13773            None => Ok(None),
13774        }
13775    }
13776
13777    /// Parse datetime64 [1]
13778    /// Syntax
13779    /// ```sql
13780    /// DateTime64(precision[, timezone])
13781    /// ```
13782    ///
13783    /// [1]: https://clickhouse.com/docs/en/sql-reference/data-types/datetime64
13784    pub fn parse_datetime_64(&mut self) -> Result<(u64, Option<String>), ParserError> {
13785        self.expect_keyword_is(Keyword::DATETIME64)?;
13786        self.expect_token(&Token::LParen)?;
13787        let precision = self.parse_literal_uint()?;
13788        let time_zone = if self.consume_token(&Token::Comma) {
13789            Some(self.parse_literal_string()?)
13790        } else {
13791            None
13792        };
13793        self.expect_token(&Token::RParen)?;
13794        Ok((precision, time_zone))
13795    }
13796
13797    /// Parse an optional character length specification `(n | MAX [CHARACTERS|OCTETS])`.
13798    pub fn parse_optional_character_length(
13799        &mut self,
13800    ) -> Result<Option<CharacterLength>, ParserError> {
13801        if self.consume_token(&Token::LParen) {
13802            let character_length = self.parse_character_length()?;
13803            self.expect_token(&Token::RParen)?;
13804            Ok(Some(character_length))
13805        } else {
13806            Ok(None)
13807        }
13808    }
13809
13810    /// Parse an optional binary length specification like `(n)`.
13811    pub fn parse_optional_binary_length(&mut self) -> Result<Option<BinaryLength>, ParserError> {
13812        if self.consume_token(&Token::LParen) {
13813            let binary_length = self.parse_binary_length()?;
13814            self.expect_token(&Token::RParen)?;
13815            Ok(Some(binary_length))
13816        } else {
13817            Ok(None)
13818        }
13819    }
13820
13821    /// Parse a character length, handling `MAX` or integer lengths with optional units.
13822    pub fn parse_character_length(&mut self) -> Result<CharacterLength, ParserError> {
13823        if self.parse_keyword(Keyword::MAX) {
13824            return Ok(CharacterLength::Max);
13825        }
13826        let length = self.parse_literal_uint()?;
13827        let unit = if self.parse_keyword(Keyword::CHARACTERS) {
13828            Some(CharLengthUnits::Characters)
13829        } else if self.parse_keyword(Keyword::OCTETS) {
13830            Some(CharLengthUnits::Octets)
13831        } else {
13832            None
13833        };
13834        Ok(CharacterLength::IntegerLength { length, unit })
13835    }
13836
13837    /// Parse a binary length specification, returning `BinaryLength`.
13838    pub fn parse_binary_length(&mut self) -> Result<BinaryLength, ParserError> {
13839        if self.parse_keyword(Keyword::MAX) {
13840            return Ok(BinaryLength::Max);
13841        }
13842        let length = self.parse_literal_uint()?;
13843        Ok(BinaryLength::IntegerLength { length })
13844    }
13845
13846    /// Parse an optional `(precision[, scale])` and return `(Option<precision>, Option<scale>)`.
13847    pub fn parse_optional_precision_scale(
13848        &mut self,
13849    ) -> Result<(Option<u64>, Option<u64>), ParserError> {
13850        if self.consume_token(&Token::LParen) {
13851            let n = self.parse_literal_uint()?;
13852            let scale = if self.consume_token(&Token::Comma) {
13853                Some(self.parse_literal_uint()?)
13854            } else {
13855                None
13856            };
13857            self.expect_token(&Token::RParen)?;
13858            Ok((Some(n), scale))
13859        } else {
13860            Ok((None, None))
13861        }
13862    }
13863
13864    /// Parse exact-number precision/scale info like `(precision[, scale])` for decimal types.
13865    pub fn parse_exact_number_optional_precision_scale(
13866        &mut self,
13867    ) -> Result<ExactNumberInfo, ParserError> {
13868        if self.consume_token(&Token::LParen) {
13869            let precision = self.parse_literal_uint()?;
13870            let scale = if self.consume_token(&Token::Comma) {
13871                Some(self.parse_signed_integer()?)
13872            } else {
13873                None
13874            };
13875
13876            self.expect_token(&Token::RParen)?;
13877
13878            match scale {
13879                None => Ok(ExactNumberInfo::Precision(precision)),
13880                Some(scale) => Ok(ExactNumberInfo::PrecisionAndScale(precision, scale)),
13881            }
13882        } else {
13883            Ok(ExactNumberInfo::None)
13884        }
13885    }
13886
13887    /// Parse an optionally signed integer literal.
13888    fn parse_signed_integer(&mut self) -> Result<i64, ParserError> {
13889        let is_negative = self.consume_token(&Token::Minus);
13890
13891        if !is_negative {
13892            let _ = self.consume_token(&Token::Plus);
13893        }
13894
13895        let current_token = self.peek_token_ref();
13896        match &current_token.token {
13897            Token::Number(s, _) => {
13898                let s = s.clone();
13899                let span_start = current_token.span.start;
13900                self.advance_token();
13901                let value = Self::parse::<i64>(s, span_start)?;
13902                Ok(if is_negative { -value } else { value })
13903            }
13904            _ => self.expected_ref("number", current_token),
13905        }
13906    }
13907
13908    /// Parse optional type modifiers appearing in parentheses e.g. `(UNSIGNED, ZEROFILL)`.
13909    pub fn parse_optional_type_modifiers(&mut self) -> Result<Option<Vec<String>>, ParserError> {
13910        if self.consume_token(&Token::LParen) {
13911            let mut modifiers = Vec::new();
13912            loop {
13913                let next_token = self.next_token();
13914                match next_token.token {
13915                    Token::Word(w) => modifiers.push(w.to_string()),
13916                    Token::Number(n, _) => modifiers.push(n),
13917                    Token::SingleQuotedString(s) => modifiers.push(s),
13918
13919                    Token::Comma => {
13920                        continue;
13921                    }
13922                    Token::RParen => {
13923                        break;
13924                    }
13925                    _ => self.expected("type modifiers", next_token)?,
13926                }
13927            }
13928
13929            Ok(Some(modifiers))
13930        } else {
13931            Ok(None)
13932        }
13933    }
13934
13935    /// Parse a parenthesized sub data type
13936    fn parse_sub_type<F>(&mut self, parent_type: F) -> Result<DataType, ParserError>
13937    where
13938        F: FnOnce(Box<DataType>) -> DataType,
13939    {
13940        self.expect_token(&Token::LParen)?;
13941        let inside_type = self.parse_data_type()?;
13942        self.expect_token(&Token::RParen)?;
13943        Ok(parent_type(inside_type.into()))
13944    }
13945
13946    /// Parse a DELETE statement, returning a `Box`ed SetExpr
13947    ///
13948    /// This is used to reduce the size of the stack frames in debug builds
13949    fn parse_delete_setexpr_boxed(
13950        &mut self,
13951        delete_token: TokenWithSpan,
13952    ) -> Result<Box<SetExpr>, ParserError> {
13953        Ok(Box::new(SetExpr::Delete(self.parse_delete(delete_token)?)))
13954    }
13955
13956    /// Parse a `DELETE` statement and return `Statement::Delete`.
13957    pub fn parse_delete(&mut self, delete_token: TokenWithSpan) -> Result<Statement, ParserError> {
13958        let optimizer_hints = self.maybe_parse_optimizer_hints()?;
13959        let (tables, with_from_keyword) = if !self.parse_keyword(Keyword::FROM) {
13960            // `FROM` keyword is optional in BigQuery SQL.
13961            // https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#delete_statement
13962            if dialect_of!(self is BigQueryDialect | OracleDialect | GenericDialect) {
13963                (vec![], false)
13964            } else {
13965                let tables = self.parse_comma_separated(|p| p.parse_object_name(false))?;
13966                self.expect_keyword_is(Keyword::FROM)?;
13967                (tables, true)
13968            }
13969        } else {
13970            (vec![], true)
13971        };
13972
13973        let from = self.parse_comma_separated(Parser::parse_table_and_joins)?;
13974
13975        let output = self.maybe_parse_output_clause()?;
13976
13977        let using = if self.parse_keyword(Keyword::USING) {
13978            Some(self.parse_comma_separated(Parser::parse_table_and_joins)?)
13979        } else {
13980            None
13981        };
13982        let selection = if self.parse_keyword(Keyword::WHERE) {
13983            Some(self.parse_expr()?)
13984        } else {
13985            None
13986        };
13987        let returning = if self.parse_keyword(Keyword::RETURNING) {
13988            Some(self.parse_comma_separated(Parser::parse_select_item)?)
13989        } else {
13990            None
13991        };
13992        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
13993            self.parse_comma_separated(Parser::parse_order_by_expr)?
13994        } else {
13995            vec![]
13996        };
13997        let limit = if self.parse_keyword(Keyword::LIMIT) {
13998            self.parse_limit()?
13999        } else {
14000            None
14001        };
14002
14003        Ok(Statement::Delete(Delete {
14004            delete_token: delete_token.into(),
14005            optimizer_hints,
14006            tables,
14007            from: if with_from_keyword {
14008                FromTable::WithFromKeyword(from)
14009            } else {
14010                FromTable::WithoutKeyword(from)
14011            },
14012            using,
14013            selection,
14014            returning,
14015            output,
14016            order_by,
14017            limit,
14018        }))
14019    }
14020
14021    /// Parse a `KILL` statement, optionally specifying `CONNECTION`, `QUERY`, or `MUTATION`.
14022    /// KILL [CONNECTION | QUERY | MUTATION] processlist_id
14023    pub fn parse_kill(&mut self) -> Result<Statement, ParserError> {
14024        let modifier_keyword =
14025            self.parse_one_of_keywords(&[Keyword::CONNECTION, Keyword::QUERY, Keyword::MUTATION]);
14026
14027        let id = self.parse_literal_uint()?;
14028
14029        let modifier = match modifier_keyword {
14030            Some(Keyword::CONNECTION) => Some(KillType::Connection),
14031            Some(Keyword::QUERY) => Some(KillType::Query),
14032            Some(Keyword::MUTATION) => {
14033                if dialect_of!(self is ClickHouseDialect | GenericDialect) {
14034                    Some(KillType::Mutation)
14035                } else {
14036                    self.expected_ref(
14037                        "Unsupported type for KILL, allowed: CONNECTION | QUERY",
14038                        self.peek_token_ref(),
14039                    )?
14040                }
14041            }
14042            _ => None,
14043        };
14044
14045        Ok(Statement::Kill { modifier, id })
14046    }
14047
14048    /// Parse an `EXPLAIN` statement, handling dialect-specific options and modifiers.
14049    pub fn parse_explain(
14050        &mut self,
14051        describe_alias: DescribeAlias,
14052    ) -> Result<Statement, ParserError> {
14053        let mut analyze = false;
14054        let mut verbose = false;
14055        let mut query_plan = false;
14056        let mut estimate = false;
14057        let mut format = None;
14058        let mut options = None;
14059
14060        // Note: DuckDB is compatible with PostgreSQL syntax for this statement,
14061        // although not all features may be implemented.
14062        if describe_alias == DescribeAlias::Explain
14063            && self.dialect.supports_explain_with_utility_options()
14064            && self.peek_token_ref().token == Token::LParen
14065        {
14066            options = Some(self.parse_utility_options()?)
14067        } else if self.parse_keywords(&[Keyword::QUERY, Keyword::PLAN]) {
14068            query_plan = true;
14069        } else if self.parse_keyword(Keyword::ESTIMATE) {
14070            estimate = true;
14071        } else {
14072            analyze = self.parse_keyword(Keyword::ANALYZE);
14073            verbose = self.parse_keyword(Keyword::VERBOSE);
14074            if self.parse_keyword(Keyword::FORMAT) {
14075                format = Some(self.parse_analyze_format_kind()?);
14076            }
14077        }
14078
14079        match self.maybe_parse(|parser| parser.parse_statement())? {
14080            Some(Statement::Explain { .. }) | Some(Statement::ExplainTable { .. }) => Err(
14081                ParserError::ParserError("Explain must be root of the plan".to_string()),
14082            ),
14083            Some(statement) => Ok(Statement::Explain {
14084                describe_alias,
14085                analyze,
14086                verbose,
14087                query_plan,
14088                estimate,
14089                statement: Box::new(statement),
14090                format,
14091                options,
14092            }),
14093            _ => {
14094                let hive_format =
14095                    match self.parse_one_of_keywords(&[Keyword::EXTENDED, Keyword::FORMATTED]) {
14096                        Some(Keyword::EXTENDED) => Some(HiveDescribeFormat::Extended),
14097                        Some(Keyword::FORMATTED) => Some(HiveDescribeFormat::Formatted),
14098                        _ => None,
14099                    };
14100
14101                let has_table_keyword = if self.dialect.describe_requires_table_keyword() {
14102                    // only allow to use TABLE keyword for DESC|DESCRIBE statement
14103                    self.parse_keyword(Keyword::TABLE)
14104                } else {
14105                    false
14106                };
14107
14108                let table_name = self.parse_object_name(false)?;
14109                Ok(Statement::ExplainTable {
14110                    describe_alias,
14111                    hive_format,
14112                    has_table_keyword,
14113                    table_name,
14114                })
14115            }
14116        }
14117    }
14118
14119    /// Parse a query expression, i.e. a `SELECT` statement optionally
14120    /// preceded with some `WITH` CTE declarations and optionally followed
14121    /// by `ORDER BY`. Unlike some other parse_... methods, this one doesn't
14122    /// expect the initial keyword to be already consumed
14123    #[cfg_attr(feature = "recursive-protection", recursive::recursive)]
14124    pub fn parse_query(&mut self) -> Result<Box<Query>, ParserError> {
14125        let _guard = self.recursion_counter.try_decrease()?;
14126        let with = if self.parse_keyword(Keyword::WITH) {
14127            let with_token = self.get_current_token();
14128            Some(With {
14129                with_token: with_token.clone().into(),
14130                recursive: self.parse_keyword(Keyword::RECURSIVE),
14131                cte_tables: self.parse_comma_separated(Parser::parse_cte)?,
14132            })
14133        } else {
14134            None
14135        };
14136        if self.parse_keyword(Keyword::INSERT) {
14137            Ok(Query {
14138                with,
14139                body: self.parse_insert_setexpr_boxed(self.get_current_token().clone())?,
14140                order_by: None,
14141                limit_clause: None,
14142                fetch: None,
14143                locks: vec![],
14144                for_clause: None,
14145                settings: None,
14146                format_clause: None,
14147                pipe_operators: vec![],
14148            }
14149            .into())
14150        } else if self.parse_keyword(Keyword::UPDATE) {
14151            Ok(Query {
14152                with,
14153                body: self.parse_update_setexpr_boxed(self.get_current_token().clone())?,
14154                order_by: None,
14155                limit_clause: None,
14156                fetch: None,
14157                locks: vec![],
14158                for_clause: None,
14159                settings: None,
14160                format_clause: None,
14161                pipe_operators: vec![],
14162            }
14163            .into())
14164        } else if self.parse_keyword(Keyword::DELETE) {
14165            Ok(Query {
14166                with,
14167                body: self.parse_delete_setexpr_boxed(self.get_current_token().clone())?,
14168                limit_clause: None,
14169                order_by: None,
14170                fetch: None,
14171                locks: vec![],
14172                for_clause: None,
14173                settings: None,
14174                format_clause: None,
14175                pipe_operators: vec![],
14176            }
14177            .into())
14178        } else if self.parse_keyword(Keyword::MERGE) {
14179            Ok(Query {
14180                with,
14181                body: self.parse_merge_setexpr_boxed(self.get_current_token().clone())?,
14182                limit_clause: None,
14183                order_by: None,
14184                fetch: None,
14185                locks: vec![],
14186                for_clause: None,
14187                settings: None,
14188                format_clause: None,
14189                pipe_operators: vec![],
14190            }
14191            .into())
14192        } else {
14193            let body = self.parse_query_body(self.dialect.prec_unknown())?;
14194
14195            let order_by = self.parse_optional_order_by()?;
14196
14197            let limit_clause = self.parse_optional_limit_clause()?;
14198
14199            let settings = self.parse_settings()?;
14200
14201            let fetch = if self.parse_keyword(Keyword::FETCH) {
14202                Some(self.parse_fetch()?)
14203            } else {
14204                None
14205            };
14206
14207            let mut for_clause = None;
14208            let mut locks = Vec::new();
14209            while self.parse_keyword(Keyword::FOR) {
14210                if let Some(parsed_for_clause) = self.parse_for_clause()? {
14211                    for_clause = Some(parsed_for_clause);
14212                    break;
14213                } else {
14214                    locks.push(self.parse_lock()?);
14215                }
14216            }
14217            let format_clause =
14218                if self.dialect.supports_select_format() && self.parse_keyword(Keyword::FORMAT) {
14219                    if self.parse_keyword(Keyword::NULL) {
14220                        Some(FormatClause::Null)
14221                    } else {
14222                        let ident = self.parse_identifier()?;
14223                        Some(FormatClause::Identifier(ident))
14224                    }
14225                } else {
14226                    None
14227                };
14228
14229            let pipe_operators = if self.dialect.supports_pipe_operator() {
14230                self.parse_pipe_operators()?
14231            } else {
14232                Vec::new()
14233            };
14234
14235            Ok(Query {
14236                with,
14237                body,
14238                order_by,
14239                limit_clause,
14240                fetch,
14241                locks,
14242                for_clause,
14243                settings,
14244                format_clause,
14245                pipe_operators,
14246            }
14247            .into())
14248        }
14249    }
14250
14251    fn parse_pipe_operators(&mut self) -> Result<Vec<PipeOperator>, ParserError> {
14252        let mut pipe_operators = Vec::new();
14253
14254        while self.consume_token(&Token::VerticalBarRightAngleBracket) {
14255            let kw = self.expect_one_of_keywords(&[
14256                Keyword::SELECT,
14257                Keyword::EXTEND,
14258                Keyword::SET,
14259                Keyword::DROP,
14260                Keyword::AS,
14261                Keyword::WHERE,
14262                Keyword::LIMIT,
14263                Keyword::AGGREGATE,
14264                Keyword::ORDER,
14265                Keyword::TABLESAMPLE,
14266                Keyword::RENAME,
14267                Keyword::UNION,
14268                Keyword::INTERSECT,
14269                Keyword::EXCEPT,
14270                Keyword::CALL,
14271                Keyword::PIVOT,
14272                Keyword::UNPIVOT,
14273                Keyword::JOIN,
14274                Keyword::INNER,
14275                Keyword::LEFT,
14276                Keyword::RIGHT,
14277                Keyword::FULL,
14278                Keyword::CROSS,
14279            ])?;
14280            match kw {
14281                Keyword::SELECT => {
14282                    let exprs = self.parse_comma_separated(Parser::parse_select_item)?;
14283                    pipe_operators.push(PipeOperator::Select { exprs })
14284                }
14285                Keyword::EXTEND => {
14286                    let exprs = self.parse_comma_separated(Parser::parse_select_item)?;
14287                    pipe_operators.push(PipeOperator::Extend { exprs })
14288                }
14289                Keyword::SET => {
14290                    let assignments = self.parse_comma_separated(Parser::parse_assignment)?;
14291                    pipe_operators.push(PipeOperator::Set { assignments })
14292                }
14293                Keyword::DROP => {
14294                    let columns = self.parse_identifiers()?;
14295                    pipe_operators.push(PipeOperator::Drop { columns })
14296                }
14297                Keyword::AS => {
14298                    let alias = self.parse_identifier()?;
14299                    pipe_operators.push(PipeOperator::As { alias })
14300                }
14301                Keyword::WHERE => {
14302                    let expr = self.parse_expr()?;
14303                    pipe_operators.push(PipeOperator::Where { expr })
14304                }
14305                Keyword::LIMIT => {
14306                    let expr = self.parse_expr()?;
14307                    let offset = if self.parse_keyword(Keyword::OFFSET) {
14308                        Some(self.parse_expr()?)
14309                    } else {
14310                        None
14311                    };
14312                    pipe_operators.push(PipeOperator::Limit { expr, offset })
14313                }
14314                Keyword::AGGREGATE => {
14315                    let full_table_exprs = if self.peek_keyword(Keyword::GROUP) {
14316                        vec![]
14317                    } else {
14318                        self.parse_comma_separated(|parser| {
14319                            parser.parse_expr_with_alias_and_order_by()
14320                        })?
14321                    };
14322
14323                    let group_by_expr = if self.parse_keywords(&[Keyword::GROUP, Keyword::BY]) {
14324                        self.parse_comma_separated(|parser| {
14325                            parser.parse_expr_with_alias_and_order_by()
14326                        })?
14327                    } else {
14328                        vec![]
14329                    };
14330
14331                    pipe_operators.push(PipeOperator::Aggregate {
14332                        full_table_exprs,
14333                        group_by_expr,
14334                    })
14335                }
14336                Keyword::ORDER => {
14337                    self.expect_one_of_keywords(&[Keyword::BY])?;
14338                    let exprs = self.parse_comma_separated(Parser::parse_order_by_expr)?;
14339                    pipe_operators.push(PipeOperator::OrderBy { exprs })
14340                }
14341                Keyword::TABLESAMPLE => {
14342                    let sample = self.parse_table_sample(TableSampleModifier::TableSample)?;
14343                    pipe_operators.push(PipeOperator::TableSample { sample });
14344                }
14345                Keyword::RENAME => {
14346                    let mappings =
14347                        self.parse_comma_separated(Parser::parse_identifier_with_optional_alias)?;
14348                    pipe_operators.push(PipeOperator::Rename { mappings });
14349                }
14350                Keyword::UNION => {
14351                    let set_quantifier = self.parse_set_quantifier(&Some(SetOperator::Union));
14352                    let queries = self.parse_pipe_operator_queries()?;
14353                    pipe_operators.push(PipeOperator::Union {
14354                        set_quantifier,
14355                        queries,
14356                    });
14357                }
14358                Keyword::INTERSECT => {
14359                    let set_quantifier =
14360                        self.parse_distinct_required_set_quantifier("INTERSECT")?;
14361                    let queries = self.parse_pipe_operator_queries()?;
14362                    pipe_operators.push(PipeOperator::Intersect {
14363                        set_quantifier,
14364                        queries,
14365                    });
14366                }
14367                Keyword::EXCEPT => {
14368                    let set_quantifier = self.parse_distinct_required_set_quantifier("EXCEPT")?;
14369                    let queries = self.parse_pipe_operator_queries()?;
14370                    pipe_operators.push(PipeOperator::Except {
14371                        set_quantifier,
14372                        queries,
14373                    });
14374                }
14375                Keyword::CALL => {
14376                    let function_name = self.parse_object_name(false)?;
14377                    let function_expr = self.parse_function(function_name)?;
14378                    if let Expr::Function(function) = function_expr {
14379                        let alias = self.parse_identifier_optional_alias()?;
14380                        pipe_operators.push(PipeOperator::Call { function, alias });
14381                    } else {
14382                        return Err(ParserError::ParserError(
14383                            "Expected function call after CALL".to_string(),
14384                        ));
14385                    }
14386                }
14387                Keyword::PIVOT => {
14388                    self.expect_token(&Token::LParen)?;
14389                    let aggregate_functions =
14390                        self.parse_comma_separated(Self::parse_pivot_aggregate_function)?;
14391                    self.expect_keyword_is(Keyword::FOR)?;
14392                    let value_column = self.parse_period_separated(|p| p.parse_identifier())?;
14393                    self.expect_keyword_is(Keyword::IN)?;
14394
14395                    self.expect_token(&Token::LParen)?;
14396                    let value_source = if self.parse_keyword(Keyword::ANY) {
14397                        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
14398                            self.parse_comma_separated(Parser::parse_order_by_expr)?
14399                        } else {
14400                            vec![]
14401                        };
14402                        PivotValueSource::Any(order_by)
14403                    } else if self.peek_sub_query() {
14404                        PivotValueSource::Subquery(self.parse_query()?)
14405                    } else {
14406                        PivotValueSource::List(
14407                            self.parse_comma_separated(Self::parse_expr_with_alias)?,
14408                        )
14409                    };
14410                    self.expect_token(&Token::RParen)?;
14411                    self.expect_token(&Token::RParen)?;
14412
14413                    let alias = self.parse_identifier_optional_alias()?;
14414
14415                    pipe_operators.push(PipeOperator::Pivot {
14416                        aggregate_functions,
14417                        value_column,
14418                        value_source,
14419                        alias,
14420                    });
14421                }
14422                Keyword::UNPIVOT => {
14423                    self.expect_token(&Token::LParen)?;
14424                    let value_column = self.parse_identifier()?;
14425                    self.expect_keyword(Keyword::FOR)?;
14426                    let name_column = self.parse_identifier()?;
14427                    self.expect_keyword(Keyword::IN)?;
14428
14429                    self.expect_token(&Token::LParen)?;
14430                    let unpivot_columns = self.parse_comma_separated(Parser::parse_identifier)?;
14431                    self.expect_token(&Token::RParen)?;
14432
14433                    self.expect_token(&Token::RParen)?;
14434
14435                    let alias = self.parse_identifier_optional_alias()?;
14436
14437                    pipe_operators.push(PipeOperator::Unpivot {
14438                        value_column,
14439                        name_column,
14440                        unpivot_columns,
14441                        alias,
14442                    });
14443                }
14444                Keyword::JOIN
14445                | Keyword::INNER
14446                | Keyword::LEFT
14447                | Keyword::RIGHT
14448                | Keyword::FULL
14449                | Keyword::CROSS => {
14450                    self.prev_token();
14451                    let mut joins = self.parse_joins()?;
14452                    if joins.len() != 1 {
14453                        return Err(ParserError::ParserError(
14454                            "Join pipe operator must have a single join".to_string(),
14455                        ));
14456                    }
14457                    let join = joins.swap_remove(0);
14458                    pipe_operators.push(PipeOperator::Join(join))
14459                }
14460                unhandled => {
14461                    return Err(ParserError::ParserError(format!(
14462                    "`expect_one_of_keywords` further up allowed unhandled keyword: {unhandled:?}"
14463                )))
14464                }
14465            }
14466        }
14467        Ok(pipe_operators)
14468    }
14469
14470    fn parse_settings(&mut self) -> Result<Option<Vec<Setting>>, ParserError> {
14471        let settings = if self.dialect.supports_settings() && self.parse_keyword(Keyword::SETTINGS)
14472        {
14473            let key_values = self.parse_comma_separated(|p| {
14474                let key = p.parse_identifier()?;
14475                p.expect_token(&Token::Eq)?;
14476                let value = p.parse_expr()?;
14477                Ok(Setting { key, value })
14478            })?;
14479            Some(key_values)
14480        } else {
14481            None
14482        };
14483        Ok(settings)
14484    }
14485
14486    /// Parse a mssql `FOR [XML | JSON | BROWSE]` clause
14487    pub fn parse_for_clause(&mut self) -> Result<Option<ForClause>, ParserError> {
14488        if self.parse_keyword(Keyword::XML) {
14489            Ok(Some(self.parse_for_xml()?))
14490        } else if self.parse_keyword(Keyword::JSON) {
14491            Ok(Some(self.parse_for_json()?))
14492        } else if self.parse_keyword(Keyword::BROWSE) {
14493            Ok(Some(ForClause::Browse))
14494        } else {
14495            Ok(None)
14496        }
14497    }
14498
14499    /// Parse a mssql `FOR XML` clause
14500    pub fn parse_for_xml(&mut self) -> Result<ForClause, ParserError> {
14501        let for_xml = if self.parse_keyword(Keyword::RAW) {
14502            let mut element_name = None;
14503            if self.peek_token_ref().token == Token::LParen {
14504                self.expect_token(&Token::LParen)?;
14505                element_name = Some(self.parse_literal_string()?);
14506                self.expect_token(&Token::RParen)?;
14507            }
14508            ForXml::Raw(element_name)
14509        } else if self.parse_keyword(Keyword::AUTO) {
14510            ForXml::Auto
14511        } else if self.parse_keyword(Keyword::EXPLICIT) {
14512            ForXml::Explicit
14513        } else if self.parse_keyword(Keyword::PATH) {
14514            let mut element_name = None;
14515            if self.peek_token_ref().token == Token::LParen {
14516                self.expect_token(&Token::LParen)?;
14517                element_name = Some(self.parse_literal_string()?);
14518                self.expect_token(&Token::RParen)?;
14519            }
14520            ForXml::Path(element_name)
14521        } else {
14522            return Err(ParserError::ParserError(
14523                "Expected FOR XML [RAW | AUTO | EXPLICIT | PATH ]".to_string(),
14524            ));
14525        };
14526        let mut elements = false;
14527        let mut binary_base64 = false;
14528        let mut root = None;
14529        let mut r#type = false;
14530        while self.peek_token_ref().token == Token::Comma {
14531            self.next_token();
14532            if self.parse_keyword(Keyword::ELEMENTS) {
14533                elements = true;
14534            } else if self.parse_keyword(Keyword::BINARY) {
14535                self.expect_keyword_is(Keyword::BASE64)?;
14536                binary_base64 = true;
14537            } else if self.parse_keyword(Keyword::ROOT) {
14538                self.expect_token(&Token::LParen)?;
14539                root = Some(self.parse_literal_string()?);
14540                self.expect_token(&Token::RParen)?;
14541            } else if self.parse_keyword(Keyword::TYPE) {
14542                r#type = true;
14543            }
14544        }
14545        Ok(ForClause::Xml {
14546            for_xml,
14547            elements,
14548            binary_base64,
14549            root,
14550            r#type,
14551        })
14552    }
14553
14554    /// Parse a mssql `FOR JSON` clause
14555    pub fn parse_for_json(&mut self) -> Result<ForClause, ParserError> {
14556        let for_json = if self.parse_keyword(Keyword::AUTO) {
14557            ForJson::Auto
14558        } else if self.parse_keyword(Keyword::PATH) {
14559            ForJson::Path
14560        } else {
14561            return Err(ParserError::ParserError(
14562                "Expected FOR JSON [AUTO | PATH ]".to_string(),
14563            ));
14564        };
14565        let mut root = None;
14566        let mut include_null_values = false;
14567        let mut without_array_wrapper = false;
14568        while self.peek_token_ref().token == Token::Comma {
14569            self.next_token();
14570            if self.parse_keyword(Keyword::ROOT) {
14571                self.expect_token(&Token::LParen)?;
14572                root = Some(self.parse_literal_string()?);
14573                self.expect_token(&Token::RParen)?;
14574            } else if self.parse_keyword(Keyword::INCLUDE_NULL_VALUES) {
14575                include_null_values = true;
14576            } else if self.parse_keyword(Keyword::WITHOUT_ARRAY_WRAPPER) {
14577                without_array_wrapper = true;
14578            }
14579        }
14580        Ok(ForClause::Json {
14581            for_json,
14582            root,
14583            include_null_values,
14584            without_array_wrapper,
14585        })
14586    }
14587
14588    /// Parse a CTE (`alias [( col1, col2, ... )] [AS] (subquery)`)
14589    pub fn parse_cte(&mut self) -> Result<Cte, ParserError> {
14590        let name = self.parse_identifier()?;
14591
14592        let as_optional = self.dialect.supports_cte_without_as();
14593
14594        // If AS is optional, first try to parse `name (query)` directly
14595        if as_optional && !self.peek_keyword(Keyword::AS) {
14596            if let Some((query, closing_paren_token)) = self.maybe_parse(|p| {
14597                p.expect_token(&Token::LParen)?;
14598                let query = p.parse_query()?;
14599                let closing_paren_token = p.expect_token(&Token::RParen)?;
14600                Ok((query, closing_paren_token))
14601            })? {
14602                let mut cte = Cte {
14603                    alias: TableAlias {
14604                        explicit: false,
14605                        name,
14606                        columns: vec![],
14607                        at: None,
14608                    },
14609                    query,
14610                    from: None,
14611                    materialized: None,
14612                    closing_paren_token: closing_paren_token.into(),
14613                };
14614                if self.parse_keyword(Keyword::FROM) {
14615                    cte.from = Some(self.parse_identifier()?);
14616                }
14617                return Ok(cte);
14618            }
14619        }
14620
14621        // Determine column definitions and consume AS
14622        let columns = if self.parse_keyword(Keyword::AS) {
14623            vec![]
14624        } else {
14625            let columns = self.parse_table_alias_column_defs()?;
14626            if as_optional {
14627                let _ = self.parse_keyword(Keyword::AS);
14628            } else {
14629                self.expect_keyword_is(Keyword::AS)?;
14630            }
14631            columns
14632        };
14633
14634        let mut is_materialized = None;
14635        if dialect_of!(self is PostgreSqlDialect) {
14636            if self.parse_keyword(Keyword::MATERIALIZED) {
14637                is_materialized = Some(CteAsMaterialized::Materialized);
14638            } else if self.parse_keywords(&[Keyword::NOT, Keyword::MATERIALIZED]) {
14639                is_materialized = Some(CteAsMaterialized::NotMaterialized);
14640            }
14641        }
14642
14643        self.expect_token(&Token::LParen)?;
14644        let query = self.parse_query()?;
14645        let closing_paren_token = self.expect_token(&Token::RParen)?;
14646
14647        let mut cte = Cte {
14648            alias: TableAlias {
14649                explicit: false,
14650                name,
14651                columns,
14652                at: None,
14653            },
14654            query,
14655            from: None,
14656            materialized: is_materialized,
14657            closing_paren_token: closing_paren_token.into(),
14658        };
14659        if self.dialect.supports_from_first_insert() && self.parse_keyword(Keyword::FROM) {
14660            cte.from = Some(self.parse_identifier()?);
14661        }
14662        Ok(cte)
14663    }
14664
14665    /// Parse a "query body", which is an expression with roughly the
14666    /// following grammar:
14667    /// ```sql
14668    ///   query_body ::= restricted_select | '(' subquery ')' | set_operation
14669    ///   restricted_select ::= 'SELECT' [expr_list] [ from ] [ where ] [ groupby_having ]
14670    ///   subquery ::= query_body [ order_by_limit ]
14671    ///   set_operation ::= query_body { 'UNION' | 'EXCEPT' | 'INTERSECT' } [ 'ALL' ] query_body
14672    /// ```
14673    pub fn parse_query_body(&mut self, precedence: u8) -> Result<Box<SetExpr>, ParserError> {
14674        // We parse the expression using a Pratt parser, as in `parse_expr()`.
14675        // Start by parsing a restricted SELECT or a `(subquery)`:
14676        let expr = if self.peek_keyword(Keyword::SELECT)
14677            || (self.peek_keyword(Keyword::FROM) && self.dialect.supports_from_first_select())
14678        {
14679            SetExpr::Select(self.parse_select().map(Box::new)?)
14680        } else if self.consume_token(&Token::LParen) {
14681            // CTEs are not allowed here, but the parser currently accepts them
14682            let subquery = self.parse_query()?;
14683            self.expect_token(&Token::RParen)?;
14684            SetExpr::Query(subquery)
14685        } else if self.parse_keyword(Keyword::VALUES) {
14686            let is_mysql = dialect_of!(self is MySqlDialect);
14687            SetExpr::Values(self.parse_values(is_mysql, false)?)
14688        } else if self.parse_keyword(Keyword::VALUE) {
14689            let is_mysql = dialect_of!(self is MySqlDialect);
14690            SetExpr::Values(self.parse_values(is_mysql, true)?)
14691        } else if self.parse_keyword(Keyword::TABLE) {
14692            SetExpr::Table(Box::new(self.parse_as_table()?))
14693        } else {
14694            return self.expected_ref(
14695                "SELECT, VALUES, or a subquery in the query body",
14696                self.peek_token_ref(),
14697            );
14698        };
14699
14700        self.parse_remaining_set_exprs(expr, precedence)
14701    }
14702
14703    /// Parse any extra set expressions that may be present in a query body
14704    ///
14705    /// (this is its own function to reduce required stack size in debug builds)
14706    fn parse_remaining_set_exprs(
14707        &mut self,
14708        mut expr: SetExpr,
14709        precedence: u8,
14710    ) -> Result<Box<SetExpr>, ParserError> {
14711        loop {
14712            // The query can be optionally followed by a set operator:
14713            let op = self.parse_set_operator(&self.peek_token().token);
14714            let next_precedence = match op {
14715                // UNION and EXCEPT have the same binding power and evaluate left-to-right
14716                Some(SetOperator::Union) | Some(SetOperator::Except) | Some(SetOperator::Minus) => {
14717                    10
14718                }
14719                // INTERSECT has higher precedence than UNION/EXCEPT
14720                Some(SetOperator::Intersect) => 20,
14721                // Unexpected token or EOF => stop parsing the query body
14722                None => break,
14723            };
14724            if precedence >= next_precedence {
14725                break;
14726            }
14727            self.next_token(); // skip past the set operator
14728            let set_quantifier = self.parse_set_quantifier(&op);
14729            expr = SetExpr::SetOperation {
14730                left: Box::new(expr),
14731                op: op.unwrap(),
14732                set_quantifier,
14733                right: self.parse_query_body(next_precedence)?,
14734            };
14735        }
14736
14737        Ok(expr.into())
14738    }
14739
14740    /// Parse a set operator token into its `SetOperator` variant.
14741    pub fn parse_set_operator(&mut self, token: &Token) -> Option<SetOperator> {
14742        match token {
14743            Token::Word(w) if w.keyword == Keyword::UNION => Some(SetOperator::Union),
14744            Token::Word(w) if w.keyword == Keyword::EXCEPT => Some(SetOperator::Except),
14745            Token::Word(w) if w.keyword == Keyword::INTERSECT => Some(SetOperator::Intersect),
14746            Token::Word(w) if w.keyword == Keyword::MINUS => Some(SetOperator::Minus),
14747            _ => None,
14748        }
14749    }
14750
14751    /// Parse a set quantifier (e.g., `ALL`, `DISTINCT BY NAME`) for the given set operator.
14752    pub fn parse_set_quantifier(&mut self, op: &Option<SetOperator>) -> SetQuantifier {
14753        match op {
14754            Some(
14755                SetOperator::Except
14756                | SetOperator::Intersect
14757                | SetOperator::Union
14758                | SetOperator::Minus,
14759            ) => {
14760                if self.parse_keywords(&[Keyword::DISTINCT, Keyword::BY, Keyword::NAME]) {
14761                    SetQuantifier::DistinctByName
14762                } else if self.parse_keywords(&[Keyword::BY, Keyword::NAME]) {
14763                    SetQuantifier::ByName
14764                } else if self.parse_keyword(Keyword::ALL) {
14765                    if self.parse_keywords(&[Keyword::BY, Keyword::NAME]) {
14766                        SetQuantifier::AllByName
14767                    } else {
14768                        SetQuantifier::All
14769                    }
14770                } else if self.parse_keyword(Keyword::DISTINCT) {
14771                    SetQuantifier::Distinct
14772                } else {
14773                    SetQuantifier::None
14774                }
14775            }
14776            _ => SetQuantifier::None,
14777        }
14778    }
14779
14780    /// Parse a restricted `SELECT` statement (no CTEs / `UNION` / `ORDER BY`)
14781    pub fn parse_select(&mut self) -> Result<Select, ParserError> {
14782        let mut from_first = None;
14783
14784        if self.dialect.supports_from_first_select() && self.peek_keyword(Keyword::FROM) {
14785            let from_token = self.expect_keyword(Keyword::FROM)?;
14786            let from = self.parse_table_with_joins()?;
14787            if !self.peek_keyword(Keyword::SELECT) {
14788                return Ok(Select {
14789                    select_token: AttachedToken(from_token),
14790                    optimizer_hints: vec![],
14791                    distinct: None,
14792                    select_modifiers: None,
14793                    top: None,
14794                    top_before_distinct: false,
14795                    projection: vec![],
14796                    exclude: None,
14797                    into: None,
14798                    from,
14799                    lateral_views: vec![],
14800                    prewhere: None,
14801                    selection: None,
14802                    group_by: GroupByExpr::Expressions(vec![], vec![]),
14803                    cluster_by: vec![],
14804                    distribute_by: vec![],
14805                    sort_by: vec![],
14806                    having: None,
14807                    named_window: vec![],
14808                    window_before_qualify: false,
14809                    qualify: None,
14810                    value_table_mode: None,
14811                    connect_by: vec![],
14812                    flavor: SelectFlavor::FromFirstNoSelect,
14813                });
14814            }
14815            from_first = Some(from);
14816        }
14817
14818        let select_token = self.expect_keyword(Keyword::SELECT)?;
14819        let optimizer_hints = self.maybe_parse_optimizer_hints()?;
14820        let value_table_mode = self.parse_value_table_mode()?;
14821
14822        let (select_modifiers, distinct_select_modifier) =
14823            if self.dialect.supports_select_modifiers() {
14824                self.parse_select_modifiers()?
14825            } else {
14826                (None, None)
14827            };
14828
14829        let mut top_before_distinct = false;
14830        let mut top = None;
14831        if self.dialect.supports_top_before_distinct() && self.parse_keyword(Keyword::TOP) {
14832            top = Some(self.parse_top()?);
14833            top_before_distinct = true;
14834        }
14835
14836        let distinct = if distinct_select_modifier.is_some() {
14837            distinct_select_modifier
14838        } else {
14839            self.parse_all_or_distinct()?
14840        };
14841
14842        if !self.dialect.supports_top_before_distinct() && self.parse_keyword(Keyword::TOP) {
14843            top = Some(self.parse_top()?);
14844        }
14845
14846        let projection =
14847            if self.dialect.supports_empty_projections() && self.peek_keyword(Keyword::FROM) {
14848                vec![]
14849            } else {
14850                self.parse_projection()?
14851            };
14852
14853        let exclude = if self.dialect.supports_select_exclude() {
14854            self.parse_optional_select_item_exclude()?
14855        } else {
14856            None
14857        };
14858
14859        let into = if self.parse_keyword(Keyword::INTO) {
14860            Some(self.parse_select_into()?)
14861        } else {
14862            None
14863        };
14864
14865        // Note that for keywords to be properly handled here, they need to be
14866        // added to `RESERVED_FOR_COLUMN_ALIAS` / `RESERVED_FOR_TABLE_ALIAS`,
14867        // otherwise they may be parsed as an alias as part of the `projection`
14868        // or `from`.
14869
14870        let (from, from_first) = if let Some(from) = from_first.take() {
14871            (from, true)
14872        } else if self.parse_keyword(Keyword::FROM) {
14873            (self.parse_table_with_joins()?, false)
14874        } else {
14875            (vec![], false)
14876        };
14877
14878        let mut lateral_views = vec![];
14879        loop {
14880            if self.parse_keywords(&[Keyword::LATERAL, Keyword::VIEW]) {
14881                let outer = self.parse_keyword(Keyword::OUTER);
14882                let lateral_view = self.parse_expr()?;
14883                let lateral_view_name = self.parse_object_name(false)?;
14884                let lateral_col_alias = self
14885                    .parse_comma_separated(|parser| {
14886                        parser.parse_optional_alias(&[
14887                            Keyword::WHERE,
14888                            Keyword::GROUP,
14889                            Keyword::CLUSTER,
14890                            Keyword::HAVING,
14891                            Keyword::LATERAL,
14892                        ]) // This couldn't possibly be a bad idea
14893                    })?
14894                    .into_iter()
14895                    .flatten()
14896                    .collect();
14897
14898                lateral_views.push(LateralView {
14899                    lateral_view,
14900                    lateral_view_name,
14901                    lateral_col_alias,
14902                    outer,
14903                });
14904            } else {
14905                break;
14906            }
14907        }
14908
14909        let prewhere = if self.dialect.supports_prewhere() && self.parse_keyword(Keyword::PREWHERE)
14910        {
14911            Some(self.parse_expr()?)
14912        } else {
14913            None
14914        };
14915
14916        let selection = if self.parse_keyword(Keyword::WHERE) {
14917            Some(self.parse_expr()?)
14918        } else {
14919            None
14920        };
14921
14922        let connect_by = self.maybe_parse_connect_by()?;
14923
14924        let group_by = self
14925            .parse_optional_group_by()?
14926            .unwrap_or_else(|| GroupByExpr::Expressions(vec![], vec![]));
14927
14928        let cluster_by = if self.parse_keywords(&[Keyword::CLUSTER, Keyword::BY]) {
14929            self.parse_comma_separated(Parser::parse_expr)?
14930        } else {
14931            vec![]
14932        };
14933
14934        let distribute_by = if self.parse_keywords(&[Keyword::DISTRIBUTE, Keyword::BY]) {
14935            self.parse_comma_separated(Parser::parse_expr)?
14936        } else {
14937            vec![]
14938        };
14939
14940        let sort_by = if self.parse_keywords(&[Keyword::SORT, Keyword::BY]) {
14941            self.parse_comma_separated(Parser::parse_order_by_expr)?
14942        } else {
14943            vec![]
14944        };
14945
14946        let having = if self.parse_keyword(Keyword::HAVING) {
14947            Some(self.parse_expr()?)
14948        } else {
14949            None
14950        };
14951
14952        // Accept QUALIFY and WINDOW in any order and flag accordingly.
14953        let (named_windows, qualify, window_before_qualify) = if self.parse_keyword(Keyword::WINDOW)
14954        {
14955            let named_windows = self.parse_comma_separated(Parser::parse_named_window)?;
14956            if self.parse_keyword(Keyword::QUALIFY) {
14957                (named_windows, Some(self.parse_expr()?), true)
14958            } else {
14959                (named_windows, None, true)
14960            }
14961        } else if self.parse_keyword(Keyword::QUALIFY) {
14962            let qualify = Some(self.parse_expr()?);
14963            if self.parse_keyword(Keyword::WINDOW) {
14964                (
14965                    self.parse_comma_separated(Parser::parse_named_window)?,
14966                    qualify,
14967                    false,
14968                )
14969            } else {
14970                (Default::default(), qualify, false)
14971            }
14972        } else {
14973            Default::default()
14974        };
14975
14976        Ok(Select {
14977            select_token: AttachedToken(select_token),
14978            optimizer_hints,
14979            distinct,
14980            select_modifiers,
14981            top,
14982            top_before_distinct,
14983            projection,
14984            exclude,
14985            into,
14986            from,
14987            lateral_views,
14988            prewhere,
14989            selection,
14990            group_by,
14991            cluster_by,
14992            distribute_by,
14993            sort_by,
14994            having,
14995            named_window: named_windows,
14996            window_before_qualify,
14997            qualify,
14998            value_table_mode,
14999            connect_by,
15000            flavor: if from_first {
15001                SelectFlavor::FromFirst
15002            } else {
15003                SelectFlavor::Standard
15004            },
15005        })
15006    }
15007
15008    /// Parses optimizer hints at the current token position.
15009    ///
15010    /// Collects all `/*prefix+...*/` and `--prefix+...` patterns.
15011    /// The `prefix` is any run of ASCII alphanumeric characters between the
15012    /// comment marker and `+` (e.g. `""` for `/*+...*/`, `"abc"` for `/*abc+...*/`).
15013    ///
15014    /// [MySQL](https://dev.mysql.com/doc/refman/8.4/en/optimizer-hints.html#optimizer-hints-overview)
15015    /// [Oracle](https://docs.oracle.com/en/database/oracle/oracle-database/21/sqlrf/Comments.html#GUID-D316D545-89E2-4D54-977F-FC97815CD62E)
15016    fn maybe_parse_optimizer_hints(&mut self) -> Result<Vec<OptimizerHint>, ParserError> {
15017        let supports_hints = self.dialect.supports_comment_optimizer_hint();
15018        if !supports_hints {
15019            return Ok(vec![]);
15020        }
15021        let mut hints = vec![];
15022        loop {
15023            let t = self.peek_nth_token_no_skip_ref(0);
15024            let Token::Whitespace(ws) = &t.token else {
15025                break;
15026            };
15027            match ws {
15028                Whitespace::SingleLineComment { comment, prefix } => {
15029                    if let Some((hint_prefix, text)) = Self::extract_hint_prefix_and_text(comment) {
15030                        hints.push(OptimizerHint {
15031                            prefix: hint_prefix,
15032                            text,
15033                            style: OptimizerHintStyle::SingleLine {
15034                                prefix: prefix.clone(),
15035                            },
15036                        });
15037                    }
15038                    self.next_token_no_skip();
15039                }
15040                Whitespace::MultiLineComment(comment) => {
15041                    if let Some((hint_prefix, text)) = Self::extract_hint_prefix_and_text(comment) {
15042                        hints.push(OptimizerHint {
15043                            prefix: hint_prefix,
15044                            text,
15045                            style: OptimizerHintStyle::MultiLine,
15046                        });
15047                    }
15048                    self.next_token_no_skip();
15049                }
15050                Whitespace::Space | Whitespace::Tab | Whitespace::Newline => {
15051                    self.next_token_no_skip();
15052                }
15053            }
15054        }
15055        Ok(hints)
15056    }
15057
15058    /// Checks if a comment's content starts with `[ASCII-alphanumeric]*+`
15059    /// and returns `(prefix, text_after_plus)` if so.
15060    fn extract_hint_prefix_and_text(comment: &str) -> Option<(String, String)> {
15061        let (before_plus, text) = comment.split_once('+')?;
15062        if before_plus.chars().all(|c| c.is_ascii_alphanumeric()) {
15063            Some((before_plus.to_string(), text.to_string()))
15064        } else {
15065            None
15066        }
15067    }
15068
15069    /// Parses MySQL SELECT modifiers and DISTINCT/ALL in any order.
15070    ///
15071    /// Manual testing shows odifiers can appear in any order, and modifiers other than DISTINCT/ALL
15072    /// can be repeated.
15073    ///
15074    /// <https://dev.mysql.com/doc/refman/8.4/en/select.html>
15075    fn parse_select_modifiers(
15076        &mut self,
15077    ) -> Result<(Option<SelectModifiers>, Option<Distinct>), ParserError> {
15078        let mut modifiers = SelectModifiers::default();
15079        let mut distinct = None;
15080
15081        let keywords = &[
15082            Keyword::ALL,
15083            Keyword::DISTINCT,
15084            Keyword::DISTINCTROW,
15085            Keyword::HIGH_PRIORITY,
15086            Keyword::STRAIGHT_JOIN,
15087            Keyword::SQL_SMALL_RESULT,
15088            Keyword::SQL_BIG_RESULT,
15089            Keyword::SQL_BUFFER_RESULT,
15090            Keyword::SQL_NO_CACHE,
15091            Keyword::SQL_CALC_FOUND_ROWS,
15092        ];
15093
15094        while let Some(keyword) = self.parse_one_of_keywords(keywords) {
15095            match keyword {
15096                Keyword::ALL | Keyword::DISTINCT if distinct.is_none() => {
15097                    self.prev_token();
15098                    distinct = self.parse_all_or_distinct()?;
15099                }
15100                // DISTINCTROW is a MySQL-specific legacy (but not deprecated) alias for DISTINCT
15101                Keyword::DISTINCTROW if distinct.is_none() => {
15102                    distinct = Some(Distinct::Distinct);
15103                }
15104                Keyword::HIGH_PRIORITY => modifiers.high_priority = true,
15105                Keyword::STRAIGHT_JOIN => modifiers.straight_join = true,
15106                Keyword::SQL_SMALL_RESULT => modifiers.sql_small_result = true,
15107                Keyword::SQL_BIG_RESULT => modifiers.sql_big_result = true,
15108                Keyword::SQL_BUFFER_RESULT => modifiers.sql_buffer_result = true,
15109                Keyword::SQL_NO_CACHE => modifiers.sql_no_cache = true,
15110                Keyword::SQL_CALC_FOUND_ROWS => modifiers.sql_calc_found_rows = true,
15111                _ => {
15112                    self.prev_token();
15113                    return self.expected_ref(
15114                        "HIGH_PRIORITY, STRAIGHT_JOIN, or other MySQL select modifier",
15115                        self.peek_token_ref(),
15116                    );
15117                }
15118            }
15119        }
15120
15121        // Avoid polluting the AST with `Some(SelectModifiers::default())` empty value unless there
15122        // actually were some modifiers set.
15123        let select_modifiers = if modifiers.is_any_set() {
15124            Some(modifiers)
15125        } else {
15126            None
15127        };
15128        Ok((select_modifiers, distinct))
15129    }
15130
15131    fn parse_value_table_mode(&mut self) -> Result<Option<ValueTableMode>, ParserError> {
15132        if !dialect_of!(self is BigQueryDialect) {
15133            return Ok(None);
15134        }
15135
15136        let mode = if self.parse_keywords(&[Keyword::DISTINCT, Keyword::AS, Keyword::VALUE]) {
15137            Some(ValueTableMode::DistinctAsValue)
15138        } else if self.parse_keywords(&[Keyword::DISTINCT, Keyword::AS, Keyword::STRUCT]) {
15139            Some(ValueTableMode::DistinctAsStruct)
15140        } else if self.parse_keywords(&[Keyword::AS, Keyword::VALUE])
15141            || self.parse_keywords(&[Keyword::ALL, Keyword::AS, Keyword::VALUE])
15142        {
15143            Some(ValueTableMode::AsValue)
15144        } else if self.parse_keywords(&[Keyword::AS, Keyword::STRUCT])
15145            || self.parse_keywords(&[Keyword::ALL, Keyword::AS, Keyword::STRUCT])
15146        {
15147            Some(ValueTableMode::AsStruct)
15148        } else if self.parse_keyword(Keyword::AS) {
15149            self.expected_ref("VALUE or STRUCT", self.peek_token_ref())?
15150        } else {
15151            None
15152        };
15153
15154        Ok(mode)
15155    }
15156
15157    /// Invoke `f` after first setting the parser's `ParserState` to `state`.
15158    ///
15159    /// Upon return, restores the parser's state to what it started at.
15160    fn with_state<T, F>(&mut self, state: ParserState, mut f: F) -> Result<T, ParserError>
15161    where
15162        F: FnMut(&mut Parser) -> Result<T, ParserError>,
15163    {
15164        let current_state = self.state;
15165        self.state = state;
15166        let res = f(self);
15167        self.state = current_state;
15168        res
15169    }
15170
15171    /// Parse a `CONNECT BY` clause (Oracle-style hierarchical query support).
15172    pub fn maybe_parse_connect_by(&mut self) -> Result<Vec<ConnectByKind>, ParserError> {
15173        let mut clauses = Vec::with_capacity(2);
15174        loop {
15175            if let Some(idx) = self.parse_keywords_indexed(&[Keyword::START, Keyword::WITH]) {
15176                clauses.push(ConnectByKind::StartWith {
15177                    start_token: self.token_at(idx).clone().into(),
15178                    condition: self.parse_expr()?.into(),
15179                });
15180            } else if let Some(idx) = self.parse_keywords_indexed(&[Keyword::CONNECT, Keyword::BY])
15181            {
15182                clauses.push(ConnectByKind::ConnectBy {
15183                    connect_token: self.token_at(idx).clone().into(),
15184                    nocycle: self.parse_keyword(Keyword::NOCYCLE),
15185                    relationships: self.with_state(ParserState::ConnectBy, |parser| {
15186                        parser.parse_comma_separated(Parser::parse_expr)
15187                    })?,
15188                });
15189            } else {
15190                break;
15191            }
15192        }
15193        Ok(clauses)
15194    }
15195
15196    /// Parse `CREATE TABLE x AS TABLE y`
15197    pub fn parse_as_table(&mut self) -> Result<Table, ParserError> {
15198        let token1 = self.next_token();
15199        let token2 = self.next_token();
15200        let token3 = self.next_token();
15201
15202        let table_name;
15203        let schema_name;
15204        if token2 == Token::Period {
15205            match token1.token {
15206                Token::Word(w) => {
15207                    schema_name = w.value;
15208                }
15209                _ => {
15210                    return self.expected("Schema name", token1);
15211                }
15212            }
15213            match token3.token {
15214                Token::Word(w) => {
15215                    table_name = w.value;
15216                }
15217                _ => {
15218                    return self.expected("Table name", token3);
15219                }
15220            }
15221            Ok(Table {
15222                table_name: Some(table_name),
15223                schema_name: Some(schema_name),
15224            })
15225        } else {
15226            match token1.token {
15227                Token::Word(w) => {
15228                    table_name = w.value;
15229                }
15230                _ => {
15231                    return self.expected("Table name", token1);
15232                }
15233            }
15234            Ok(Table {
15235                table_name: Some(table_name),
15236                schema_name: None,
15237            })
15238        }
15239    }
15240
15241    /// Parse a `SET ROLE` statement. Expects SET to be consumed already.
15242    fn parse_set_role(
15243        &mut self,
15244        modifier: Option<ContextModifier>,
15245    ) -> Result<Statement, ParserError> {
15246        self.expect_keyword_is(Keyword::ROLE)?;
15247
15248        let role_name = if self.parse_keyword(Keyword::NONE) {
15249            None
15250        } else {
15251            Some(self.parse_identifier()?)
15252        };
15253        Ok(Statement::Set(Set::SetRole {
15254            context_modifier: modifier,
15255            role_name,
15256        }))
15257    }
15258
15259    fn parse_set_values(
15260        &mut self,
15261        parenthesized_assignment: bool,
15262    ) -> Result<Vec<Expr>, ParserError> {
15263        let mut values = vec![];
15264
15265        if parenthesized_assignment {
15266            self.expect_token(&Token::LParen)?;
15267        }
15268
15269        loop {
15270            let value = if let Some(expr) = self.try_parse_expr_sub_query()? {
15271                expr
15272            } else if let Ok(expr) = self.parse_expr() {
15273                expr
15274            } else {
15275                self.expected_ref("variable value", self.peek_token_ref())?
15276            };
15277
15278            values.push(value);
15279            if self.consume_token(&Token::Comma) {
15280                continue;
15281            }
15282
15283            if parenthesized_assignment {
15284                self.expect_token(&Token::RParen)?;
15285            }
15286            return Ok(values);
15287        }
15288    }
15289
15290    fn parse_context_modifier(&mut self) -> Option<ContextModifier> {
15291        let modifier =
15292            self.parse_one_of_keywords(&[Keyword::SESSION, Keyword::LOCAL, Keyword::GLOBAL])?;
15293
15294        Self::keyword_to_modifier(modifier)
15295    }
15296
15297    /// Parse a single SET statement assignment `var = expr`.
15298    fn parse_set_assignment(&mut self) -> Result<SetAssignment, ParserError> {
15299        let scope = self.parse_context_modifier();
15300
15301        let name = if self.dialect.supports_parenthesized_set_variables()
15302            && self.consume_token(&Token::LParen)
15303        {
15304            // Parenthesized assignments are handled in the `parse_set` function after
15305            // trying to parse list of assignments using this function.
15306            // If a dialect supports both, and we find a LParen, we early exit from this function.
15307            self.expected_ref("Unparenthesized assignment", self.peek_token_ref())?
15308        } else {
15309            self.parse_object_name(false)?
15310        };
15311
15312        if !(self.consume_token(&Token::Eq) || self.parse_keyword(Keyword::TO)) {
15313            return self.expected_ref("assignment operator", self.peek_token_ref());
15314        }
15315
15316        let value = self.parse_expr()?;
15317
15318        Ok(SetAssignment { scope, name, value })
15319    }
15320
15321    fn parse_set(&mut self) -> Result<Statement, ParserError> {
15322        let hivevar = self.parse_keyword(Keyword::HIVEVAR);
15323
15324        // Modifier is either HIVEVAR: or a ContextModifier (LOCAL, SESSION, etc), not both
15325        let scope = if !hivevar {
15326            self.parse_context_modifier()
15327        } else {
15328            None
15329        };
15330
15331        if hivevar {
15332            self.expect_token(&Token::Colon)?;
15333        }
15334
15335        if let Some(set_role_stmt) = self.maybe_parse(|parser| parser.parse_set_role(scope))? {
15336            return Ok(set_role_stmt);
15337        }
15338
15339        // Handle special cases first
15340        if self.parse_keywords(&[Keyword::TIME, Keyword::ZONE])
15341            || self.parse_keyword(Keyword::TIMEZONE)
15342        {
15343            if self.consume_token(&Token::Eq) || self.parse_keyword(Keyword::TO) {
15344                return Ok(Set::SingleAssignment {
15345                    scope,
15346                    hivevar,
15347                    variable: ObjectName::from(vec!["TIMEZONE".into()]),
15348                    values: self.parse_set_values(false)?,
15349                }
15350                .into());
15351            } else {
15352                // A shorthand alias for SET TIME ZONE that doesn't require
15353                // the assignment operator. It's originally PostgreSQL specific,
15354                // but we allow it for all the dialects
15355                return Ok(Set::SetTimeZone {
15356                    local: scope == Some(ContextModifier::Local),
15357                    value: self.parse_expr()?,
15358                }
15359                .into());
15360            }
15361        } else if self.dialect.supports_set_names() && self.parse_keyword(Keyword::NAMES) {
15362            if self.parse_keyword(Keyword::DEFAULT) {
15363                return Ok(Set::SetNamesDefault {}.into());
15364            }
15365            let charset_name = self.parse_identifier()?;
15366            let collation_name = if self.parse_one_of_keywords(&[Keyword::COLLATE]).is_some() {
15367                Some(self.parse_literal_string()?)
15368            } else {
15369                None
15370            };
15371
15372            return Ok(Set::SetNames {
15373                charset_name,
15374                collation_name,
15375            }
15376            .into());
15377        } else if self.parse_keyword(Keyword::CHARACTERISTICS) {
15378            self.expect_keywords(&[Keyword::AS, Keyword::TRANSACTION])?;
15379            return Ok(Set::SetTransaction {
15380                modes: self.parse_transaction_modes()?,
15381                snapshot: None,
15382                session: true,
15383            }
15384            .into());
15385        } else if self.parse_keyword(Keyword::TRANSACTION) {
15386            if self.parse_keyword(Keyword::SNAPSHOT) {
15387                let snapshot_id = self.parse_value()?;
15388                return Ok(Set::SetTransaction {
15389                    modes: vec![],
15390                    snapshot: Some(snapshot_id),
15391                    session: false,
15392                }
15393                .into());
15394            }
15395            return Ok(Set::SetTransaction {
15396                modes: self.parse_transaction_modes()?,
15397                snapshot: None,
15398                session: false,
15399            }
15400            .into());
15401        } else if self.parse_keyword(Keyword::AUTHORIZATION) {
15402            let scope = match scope {
15403                Some(s) => s,
15404                None => {
15405                    return self.expected_at(
15406                        "SESSION, LOCAL, or other scope modifier before AUTHORIZATION",
15407                        self.get_current_index(),
15408                    )
15409                }
15410            };
15411            let auth_value = if self.parse_keyword(Keyword::DEFAULT) {
15412                SetSessionAuthorizationParamKind::Default
15413            } else {
15414                let value = self.parse_identifier()?;
15415                SetSessionAuthorizationParamKind::User(value)
15416            };
15417            return Ok(Set::SetSessionAuthorization(SetSessionAuthorizationParam {
15418                scope,
15419                kind: auth_value,
15420            })
15421            .into());
15422        }
15423
15424        if self.dialect.supports_comma_separated_set_assignments() {
15425            if scope.is_some() {
15426                self.prev_token();
15427            }
15428
15429            if let Some(assignments) = self
15430                .maybe_parse(|parser| parser.parse_comma_separated(Parser::parse_set_assignment))?
15431            {
15432                return if assignments.len() > 1 {
15433                    Ok(Set::MultipleAssignments { assignments }.into())
15434                } else {
15435                    let SetAssignment { scope, name, value } =
15436                        assignments.into_iter().next().ok_or_else(|| {
15437                            ParserError::ParserError("Expected at least one assignment".to_string())
15438                        })?;
15439
15440                    Ok(Set::SingleAssignment {
15441                        scope,
15442                        hivevar,
15443                        variable: name,
15444                        values: vec![value],
15445                    }
15446                    .into())
15447                };
15448            }
15449        }
15450
15451        let variables = if self.dialect.supports_parenthesized_set_variables()
15452            && self.consume_token(&Token::LParen)
15453        {
15454            let vars = OneOrManyWithParens::Many(
15455                self.parse_comma_separated(|parser: &mut Parser<'a>| parser.parse_identifier())?
15456                    .into_iter()
15457                    .map(|ident| ObjectName::from(vec![ident]))
15458                    .collect(),
15459            );
15460            self.expect_token(&Token::RParen)?;
15461            vars
15462        } else {
15463            OneOrManyWithParens::One(self.parse_object_name(false)?)
15464        };
15465
15466        if self.consume_token(&Token::Eq) || self.parse_keyword(Keyword::TO) {
15467            let stmt = match variables {
15468                OneOrManyWithParens::One(var) => Set::SingleAssignment {
15469                    scope,
15470                    hivevar,
15471                    variable: var,
15472                    values: self.parse_set_values(false)?,
15473                },
15474                OneOrManyWithParens::Many(vars) => Set::ParenthesizedAssignments {
15475                    variables: vars,
15476                    values: self.parse_set_values(true)?,
15477                },
15478            };
15479
15480            return Ok(stmt.into());
15481        }
15482
15483        if self.dialect.supports_set_stmt_without_operator() {
15484            self.prev_token();
15485            return self.parse_set_session_params();
15486        };
15487
15488        self.expected_ref("equals sign or TO", self.peek_token_ref())
15489    }
15490
15491    /// Parse session parameter assignments after `SET` when no `=` or `TO` is present.
15492    pub fn parse_set_session_params(&mut self) -> Result<Statement, ParserError> {
15493        if self.parse_keyword(Keyword::STATISTICS) {
15494            let topic = match self.parse_one_of_keywords(&[
15495                Keyword::IO,
15496                Keyword::PROFILE,
15497                Keyword::TIME,
15498                Keyword::XML,
15499            ]) {
15500                Some(Keyword::IO) => SessionParamStatsTopic::IO,
15501                Some(Keyword::PROFILE) => SessionParamStatsTopic::Profile,
15502                Some(Keyword::TIME) => SessionParamStatsTopic::Time,
15503                Some(Keyword::XML) => SessionParamStatsTopic::Xml,
15504                _ => return self.expected_ref("IO, PROFILE, TIME or XML", self.peek_token_ref()),
15505            };
15506            let value = self.parse_session_param_value()?;
15507            Ok(
15508                Set::SetSessionParam(SetSessionParamKind::Statistics(SetSessionParamStatistics {
15509                    topic,
15510                    value,
15511                }))
15512                .into(),
15513            )
15514        } else if self.parse_keyword(Keyword::IDENTITY_INSERT) {
15515            let obj = self.parse_object_name(false)?;
15516            let value = self.parse_session_param_value()?;
15517            Ok(Set::SetSessionParam(SetSessionParamKind::IdentityInsert(
15518                SetSessionParamIdentityInsert { obj, value },
15519            ))
15520            .into())
15521        } else if self.parse_keyword(Keyword::OFFSETS) {
15522            let keywords = self.parse_comma_separated(|parser| {
15523                let next_token = parser.next_token();
15524                match &next_token.token {
15525                    Token::Word(w) => Ok(w.to_string()),
15526                    _ => parser.expected("SQL keyword", next_token),
15527                }
15528            })?;
15529            let value = self.parse_session_param_value()?;
15530            Ok(
15531                Set::SetSessionParam(SetSessionParamKind::Offsets(SetSessionParamOffsets {
15532                    keywords,
15533                    value,
15534                }))
15535                .into(),
15536            )
15537        } else {
15538            let names = self.parse_comma_separated(|parser| {
15539                let next_token = parser.next_token();
15540                match next_token.token {
15541                    Token::Word(w) => Ok(w.to_string()),
15542                    _ => parser.expected("Session param name", next_token),
15543                }
15544            })?;
15545            let value = self.parse_expr()?.to_string();
15546            Ok(
15547                Set::SetSessionParam(SetSessionParamKind::Generic(SetSessionParamGeneric {
15548                    names,
15549                    value,
15550                }))
15551                .into(),
15552            )
15553        }
15554    }
15555
15556    fn parse_session_param_value(&mut self) -> Result<SessionParamValue, ParserError> {
15557        if self.parse_keyword(Keyword::ON) {
15558            Ok(SessionParamValue::On)
15559        } else if self.parse_keyword(Keyword::OFF) {
15560            Ok(SessionParamValue::Off)
15561        } else {
15562            self.expected_ref("ON or OFF", self.peek_token_ref())
15563        }
15564    }
15565
15566    /// Parse a `SHOW` statement and dispatch to specific SHOW handlers.
15567    pub fn parse_show(&mut self) -> Result<Statement, ParserError> {
15568        let terse = self.parse_keyword(Keyword::TERSE);
15569        let extended = self.parse_keyword(Keyword::EXTENDED);
15570        let full = self.parse_keyword(Keyword::FULL);
15571        let session = self.parse_keyword(Keyword::SESSION);
15572        let global = self.parse_keyword(Keyword::GLOBAL);
15573        let external = self.parse_keyword(Keyword::EXTERNAL);
15574        if self
15575            .parse_one_of_keywords(&[Keyword::COLUMNS, Keyword::FIELDS])
15576            .is_some()
15577        {
15578            Ok(self.parse_show_columns(extended, full)?)
15579        } else if self.parse_keyword(Keyword::TABLES) {
15580            Ok(self.parse_show_tables(terse, extended, full, external)?)
15581        } else if self.parse_keywords(&[Keyword::MATERIALIZED, Keyword::VIEWS]) {
15582            Ok(self.parse_show_views(terse, true)?)
15583        } else if self.parse_keyword(Keyword::VIEWS) {
15584            Ok(self.parse_show_views(terse, false)?)
15585        } else if self.parse_keyword(Keyword::FUNCTIONS) {
15586            Ok(self.parse_show_functions()?)
15587        } else if self.parse_keyword(Keyword::PROCESSLIST) {
15588            Ok(Statement::ShowProcessList { full })
15589        } else if extended || full {
15590            Err(ParserError::ParserError(
15591                "EXTENDED/FULL are not supported with this type of SHOW query".to_string(),
15592            ))
15593        } else if self.parse_one_of_keywords(&[Keyword::CREATE]).is_some() {
15594            Ok(self.parse_show_create()?)
15595        } else if self.parse_keyword(Keyword::COLLATION) {
15596            Ok(self.parse_show_collation()?)
15597        } else if self.parse_keyword(Keyword::VARIABLES)
15598            && dialect_of!(self is MySqlDialect | GenericDialect)
15599        {
15600            Ok(Statement::ShowVariables {
15601                filter: self.parse_show_statement_filter()?,
15602                session,
15603                global,
15604            })
15605        } else if self.parse_keyword(Keyword::STATUS)
15606            && dialect_of!(self is MySqlDialect | GenericDialect)
15607        {
15608            Ok(Statement::ShowStatus {
15609                filter: self.parse_show_statement_filter()?,
15610                session,
15611                global,
15612            })
15613        } else if self.parse_keyword(Keyword::CATALOGS) {
15614            self.parse_show_catalogs(terse)
15615        } else if self.parse_keyword(Keyword::DATABASES) {
15616            self.parse_show_databases(terse)
15617        } else if self.parse_keyword(Keyword::SCHEMAS) {
15618            self.parse_show_schemas(terse)
15619        } else if self.parse_keywords(&[Keyword::CHARACTER, Keyword::SET]) {
15620            self.parse_show_charset(false)
15621        } else if self.parse_keyword(Keyword::CHARSET) {
15622            self.parse_show_charset(true)
15623        } else {
15624            Ok(Statement::ShowVariable {
15625                variable: self.parse_identifiers()?,
15626            })
15627        }
15628    }
15629
15630    fn parse_show_charset(&mut self, is_shorthand: bool) -> Result<Statement, ParserError> {
15631        // parse one of keywords
15632        Ok(Statement::ShowCharset(ShowCharset {
15633            is_shorthand,
15634            filter: self.parse_show_statement_filter()?,
15635        }))
15636    }
15637
15638    fn parse_show_catalogs(&mut self, terse: bool) -> Result<Statement, ParserError> {
15639        let history = self.parse_keyword(Keyword::HISTORY);
15640        let show_options = self.parse_show_stmt_options()?;
15641        Ok(Statement::ShowCatalogs {
15642            terse,
15643            history,
15644            show_options,
15645        })
15646    }
15647
15648    fn parse_show_databases(&mut self, terse: bool) -> Result<Statement, ParserError> {
15649        let history = self.parse_keyword(Keyword::HISTORY);
15650        let show_options = self.parse_show_stmt_options()?;
15651        Ok(Statement::ShowDatabases {
15652            terse,
15653            history,
15654            show_options,
15655        })
15656    }
15657
15658    fn parse_show_schemas(&mut self, terse: bool) -> Result<Statement, ParserError> {
15659        let history = self.parse_keyword(Keyword::HISTORY);
15660        let show_options = self.parse_show_stmt_options()?;
15661        Ok(Statement::ShowSchemas {
15662            terse,
15663            history,
15664            show_options,
15665        })
15666    }
15667
15668    /// Parse `SHOW CREATE <object>` returning the corresponding `ShowCreate` statement.
15669    pub fn parse_show_create(&mut self) -> Result<Statement, ParserError> {
15670        let obj_type = match self.expect_one_of_keywords(&[
15671            Keyword::TABLE,
15672            Keyword::TRIGGER,
15673            Keyword::FUNCTION,
15674            Keyword::PROCEDURE,
15675            Keyword::EVENT,
15676            Keyword::VIEW,
15677        ])? {
15678            Keyword::TABLE => Ok(ShowCreateObject::Table),
15679            Keyword::TRIGGER => Ok(ShowCreateObject::Trigger),
15680            Keyword::FUNCTION => Ok(ShowCreateObject::Function),
15681            Keyword::PROCEDURE => Ok(ShowCreateObject::Procedure),
15682            Keyword::EVENT => Ok(ShowCreateObject::Event),
15683            Keyword::VIEW => Ok(ShowCreateObject::View),
15684            keyword => Err(ParserError::ParserError(format!(
15685                "Unable to map keyword to ShowCreateObject: {keyword:?}"
15686            ))),
15687        }?;
15688
15689        let obj_name = self.parse_object_name(false)?;
15690
15691        Ok(Statement::ShowCreate { obj_type, obj_name })
15692    }
15693
15694    /// Parse `SHOW COLUMNS`/`SHOW FIELDS` and return a `ShowColumns` statement.
15695    pub fn parse_show_columns(
15696        &mut self,
15697        extended: bool,
15698        full: bool,
15699    ) -> Result<Statement, ParserError> {
15700        let show_options = self.parse_show_stmt_options()?;
15701        Ok(Statement::ShowColumns {
15702            extended,
15703            full,
15704            show_options,
15705        })
15706    }
15707
15708    fn parse_show_tables(
15709        &mut self,
15710        terse: bool,
15711        extended: bool,
15712        full: bool,
15713        external: bool,
15714    ) -> Result<Statement, ParserError> {
15715        let history = !external && self.parse_keyword(Keyword::HISTORY);
15716        let show_options = self.parse_show_stmt_options()?;
15717        Ok(Statement::ShowTables {
15718            terse,
15719            history,
15720            extended,
15721            full,
15722            external,
15723            show_options,
15724        })
15725    }
15726
15727    fn parse_show_views(
15728        &mut self,
15729        terse: bool,
15730        materialized: bool,
15731    ) -> Result<Statement, ParserError> {
15732        let show_options = self.parse_show_stmt_options()?;
15733        Ok(Statement::ShowViews {
15734            materialized,
15735            terse,
15736            show_options,
15737        })
15738    }
15739
15740    /// Parse `SHOW FUNCTIONS` and optional filter.
15741    pub fn parse_show_functions(&mut self) -> Result<Statement, ParserError> {
15742        let filter = self.parse_show_statement_filter()?;
15743        Ok(Statement::ShowFunctions { filter })
15744    }
15745
15746    /// Parse `SHOW COLLATION` and optional filter.
15747    pub fn parse_show_collation(&mut self) -> Result<Statement, ParserError> {
15748        let filter = self.parse_show_statement_filter()?;
15749        Ok(Statement::ShowCollation { filter })
15750    }
15751
15752    /// Parse an optional filter used by `SHOW` statements (LIKE, ILIKE, WHERE, or literal).
15753    pub fn parse_show_statement_filter(
15754        &mut self,
15755    ) -> Result<Option<ShowStatementFilter>, ParserError> {
15756        if self.parse_keyword(Keyword::LIKE) {
15757            Ok(Some(ShowStatementFilter::Like(
15758                self.parse_literal_string()?,
15759            )))
15760        } else if self.parse_keyword(Keyword::ILIKE) {
15761            Ok(Some(ShowStatementFilter::ILike(
15762                self.parse_literal_string()?,
15763            )))
15764        } else if self.parse_keyword(Keyword::WHERE) {
15765            Ok(Some(ShowStatementFilter::Where(self.parse_expr()?)))
15766        } else {
15767            self.maybe_parse(|parser| -> Result<String, ParserError> {
15768                parser.parse_literal_string()
15769            })?
15770            .map_or(Ok(None), |filter| {
15771                Ok(Some(ShowStatementFilter::NoKeyword(filter)))
15772            })
15773        }
15774    }
15775
15776    /// Parse a `USE` statement (database/catalog/schema/warehouse/role selection).
15777    pub fn parse_use(&mut self) -> Result<Statement, ParserError> {
15778        // Determine which keywords are recognized by the current dialect
15779        let parsed_keyword = if dialect_of!(self is HiveDialect) {
15780            // HiveDialect accepts USE DEFAULT; statement without any db specified
15781            if self.parse_keyword(Keyword::DEFAULT) {
15782                return Ok(Statement::Use(Use::Default));
15783            }
15784            None // HiveDialect doesn't expect any other specific keyword after `USE`
15785        } else if dialect_of!(self is DatabricksDialect) {
15786            self.parse_one_of_keywords(&[Keyword::CATALOG, Keyword::DATABASE, Keyword::SCHEMA])
15787        } else if dialect_of!(self is SnowflakeDialect) {
15788            self.parse_one_of_keywords(&[
15789                Keyword::DATABASE,
15790                Keyword::SCHEMA,
15791                Keyword::WAREHOUSE,
15792                Keyword::ROLE,
15793                Keyword::SECONDARY,
15794            ])
15795        } else {
15796            None // No specific keywords for other dialects, including GenericDialect
15797        };
15798
15799        let result = if matches!(parsed_keyword, Some(Keyword::SECONDARY)) {
15800            self.parse_secondary_roles()?
15801        } else {
15802            let obj_name = self.parse_object_name(false)?;
15803            match parsed_keyword {
15804                Some(Keyword::CATALOG) => Use::Catalog(obj_name),
15805                Some(Keyword::DATABASE) => Use::Database(obj_name),
15806                Some(Keyword::SCHEMA) => Use::Schema(obj_name),
15807                Some(Keyword::WAREHOUSE) => Use::Warehouse(obj_name),
15808                Some(Keyword::ROLE) => Use::Role(obj_name),
15809                _ => Use::Object(obj_name),
15810            }
15811        };
15812
15813        Ok(Statement::Use(result))
15814    }
15815
15816    fn parse_secondary_roles(&mut self) -> Result<Use, ParserError> {
15817        self.expect_one_of_keywords(&[Keyword::ROLES, Keyword::ROLE])?;
15818        if self.parse_keyword(Keyword::NONE) {
15819            Ok(Use::SecondaryRoles(SecondaryRoles::None))
15820        } else if self.parse_keyword(Keyword::ALL) {
15821            Ok(Use::SecondaryRoles(SecondaryRoles::All))
15822        } else {
15823            let roles = self.parse_comma_separated(|parser| parser.parse_identifier())?;
15824            Ok(Use::SecondaryRoles(SecondaryRoles::List(roles)))
15825        }
15826    }
15827
15828    /// Parse a table factor followed by any join clauses, returning `TableWithJoins`.
15829    pub fn parse_table_and_joins(&mut self) -> Result<TableWithJoins, ParserError> {
15830        let relation = self.parse_table_factor()?;
15831        // Note that for keywords to be properly handled here, they need to be
15832        // added to `RESERVED_FOR_TABLE_ALIAS`, otherwise they may be parsed as
15833        // a table alias.
15834        let joins = self.parse_joins()?;
15835        Ok(TableWithJoins { relation, joins })
15836    }
15837
15838    fn parse_joins(&mut self) -> Result<Vec<Join>, ParserError> {
15839        let mut joins = vec![];
15840        loop {
15841            let global = self.parse_keyword(Keyword::GLOBAL);
15842            let join = if self.parse_keyword(Keyword::CROSS) {
15843                let join_operator = if self.parse_keyword(Keyword::JOIN) {
15844                    JoinOperator::CrossJoin(JoinConstraint::None)
15845                } else if self.parse_keyword(Keyword::APPLY) {
15846                    // MSSQL extension, similar to CROSS JOIN LATERAL
15847                    JoinOperator::CrossApply
15848                } else {
15849                    return self.expected_ref("JOIN or APPLY after CROSS", self.peek_token_ref());
15850                };
15851                let relation = self.parse_table_factor()?;
15852                let join_operator = if matches!(join_operator, JoinOperator::CrossJoin(_))
15853                    && self.dialect.supports_cross_join_constraint()
15854                {
15855                    let constraint = self.parse_join_constraint(false)?;
15856                    JoinOperator::CrossJoin(constraint)
15857                } else {
15858                    join_operator
15859                };
15860                Join {
15861                    relation,
15862                    global,
15863                    join_operator,
15864                }
15865            } else if self.parse_keyword(Keyword::OUTER) {
15866                // MSSQL extension, similar to LEFT JOIN LATERAL .. ON 1=1
15867                self.expect_keyword_is(Keyword::APPLY)?;
15868                Join {
15869                    relation: self.parse_table_factor()?,
15870                    global,
15871                    join_operator: JoinOperator::OuterApply,
15872                }
15873            } else if self.parse_keyword(Keyword::ASOF) {
15874                self.expect_keyword_is(Keyword::JOIN)?;
15875                let relation = self.parse_table_factor()?;
15876                self.expect_keyword_is(Keyword::MATCH_CONDITION)?;
15877                let match_condition = self.parse_parenthesized(Self::parse_expr)?;
15878                Join {
15879                    relation,
15880                    global,
15881                    join_operator: JoinOperator::AsOf {
15882                        match_condition,
15883                        constraint: self.parse_join_constraint(false)?,
15884                    },
15885                }
15886            } else if self.dialect.supports_array_join_syntax()
15887                && self.parse_keywords(&[Keyword::INNER, Keyword::ARRAY, Keyword::JOIN])
15888            {
15889                // ClickHouse: INNER ARRAY JOIN
15890                Join {
15891                    relation: self.parse_table_factor()?,
15892                    global,
15893                    join_operator: JoinOperator::InnerArrayJoin,
15894                }
15895            } else if self.dialect.supports_array_join_syntax()
15896                && self.parse_keywords(&[Keyword::LEFT, Keyword::ARRAY, Keyword::JOIN])
15897            {
15898                // ClickHouse: LEFT ARRAY JOIN
15899                Join {
15900                    relation: self.parse_table_factor()?,
15901                    global,
15902                    join_operator: JoinOperator::LeftArrayJoin,
15903                }
15904            } else if self.dialect.supports_array_join_syntax()
15905                && self.parse_keywords(&[Keyword::ARRAY, Keyword::JOIN])
15906            {
15907                // ClickHouse: ARRAY JOIN
15908                Join {
15909                    relation: self.parse_table_factor()?,
15910                    global,
15911                    join_operator: JoinOperator::ArrayJoin,
15912                }
15913            } else {
15914                let natural = self.parse_keyword(Keyword::NATURAL);
15915                let peek_keyword = if let Token::Word(w) = &self.peek_token_ref().token {
15916                    w.keyword
15917                } else {
15918                    Keyword::NoKeyword
15919                };
15920
15921                let join_operator_type = match peek_keyword {
15922                    Keyword::INNER | Keyword::JOIN => {
15923                        let inner = self.parse_keyword(Keyword::INNER); // [ INNER ]
15924                        self.expect_keyword_is(Keyword::JOIN)?;
15925                        if inner {
15926                            JoinOperator::Inner
15927                        } else {
15928                            JoinOperator::Join
15929                        }
15930                    }
15931                    kw @ Keyword::LEFT | kw @ Keyword::RIGHT => {
15932                        let _ = self.next_token(); // consume LEFT/RIGHT
15933                        let is_left = kw == Keyword::LEFT;
15934                        let join_type = self.parse_one_of_keywords(&[
15935                            Keyword::OUTER,
15936                            Keyword::SEMI,
15937                            Keyword::ANTI,
15938                            Keyword::JOIN,
15939                        ]);
15940                        match join_type {
15941                            Some(Keyword::OUTER) => {
15942                                self.expect_keyword_is(Keyword::JOIN)?;
15943                                if is_left {
15944                                    JoinOperator::LeftOuter
15945                                } else {
15946                                    JoinOperator::RightOuter
15947                                }
15948                            }
15949                            Some(Keyword::SEMI) => {
15950                                self.expect_keyword_is(Keyword::JOIN)?;
15951                                if is_left {
15952                                    JoinOperator::LeftSemi
15953                                } else {
15954                                    JoinOperator::RightSemi
15955                                }
15956                            }
15957                            Some(Keyword::ANTI) => {
15958                                self.expect_keyword_is(Keyword::JOIN)?;
15959                                if is_left {
15960                                    JoinOperator::LeftAnti
15961                                } else {
15962                                    JoinOperator::RightAnti
15963                                }
15964                            }
15965                            Some(Keyword::JOIN) => {
15966                                if is_left {
15967                                    JoinOperator::Left
15968                                } else {
15969                                    JoinOperator::Right
15970                                }
15971                            }
15972                            _ => {
15973                                return Err(ParserError::ParserError(format!(
15974                                    "expected OUTER, SEMI, ANTI or JOIN after {kw:?}"
15975                                )))
15976                            }
15977                        }
15978                    }
15979                    Keyword::ANTI => {
15980                        let _ = self.next_token(); // consume ANTI
15981                        self.expect_keyword_is(Keyword::JOIN)?;
15982                        JoinOperator::Anti
15983                    }
15984                    Keyword::SEMI => {
15985                        let _ = self.next_token(); // consume SEMI
15986                        self.expect_keyword_is(Keyword::JOIN)?;
15987                        JoinOperator::Semi
15988                    }
15989                    Keyword::FULL => {
15990                        let _ = self.next_token(); // consume FULL
15991                        let _ = self.parse_keyword(Keyword::OUTER); // [ OUTER ]
15992                        self.expect_keyword_is(Keyword::JOIN)?;
15993                        JoinOperator::FullOuter
15994                    }
15995                    Keyword::OUTER => {
15996                        return self.expected_ref("LEFT, RIGHT, or FULL", self.peek_token_ref());
15997                    }
15998                    Keyword::STRAIGHT_JOIN => {
15999                        let _ = self.next_token(); // consume STRAIGHT_JOIN
16000                        JoinOperator::StraightJoin
16001                    }
16002                    _ if natural => {
16003                        return self
16004                            .expected_ref("a join type after NATURAL", self.peek_token_ref());
16005                    }
16006                    _ => break,
16007                };
16008                let mut relation = self.parse_table_factor()?;
16009
16010                if !self
16011                    .dialect
16012                    .supports_left_associative_joins_without_parens()
16013                    && self.peek_parens_less_nested_join()
16014                {
16015                    let joins = self.parse_joins()?;
16016                    relation = TableFactor::NestedJoin {
16017                        table_with_joins: Box::new(TableWithJoins { relation, joins }),
16018                        alias: None,
16019                    };
16020                }
16021
16022                let join_constraint = self.parse_join_constraint(natural)?;
16023                Join {
16024                    relation,
16025                    global,
16026                    join_operator: join_operator_type(join_constraint),
16027                }
16028            };
16029            joins.push(join);
16030        }
16031        Ok(joins)
16032    }
16033
16034    fn peek_parens_less_nested_join(&self) -> bool {
16035        matches!(
16036            self.peek_token_ref().token,
16037            Token::Word(Word {
16038                keyword: Keyword::JOIN
16039                    | Keyword::INNER
16040                    | Keyword::LEFT
16041                    | Keyword::RIGHT
16042                    | Keyword::FULL,
16043                ..
16044            })
16045        )
16046    }
16047
16048    /// A table name or a parenthesized subquery, followed by optional `[AS] alias`
16049    #[cfg_attr(feature = "recursive-protection", recursive::recursive)]
16050    pub fn parse_table_factor(&mut self) -> Result<TableFactor, ParserError> {
16051        let _guard = self.recursion_counter.try_decrease()?;
16052        if self.parse_keyword(Keyword::LATERAL) {
16053            // LATERAL must always be followed by a subquery or table function.
16054            if self.consume_token(&Token::LParen) {
16055                self.parse_derived_table_factor(Lateral)
16056            } else {
16057                let name = self.parse_object_name(false)?;
16058                self.expect_token(&Token::LParen)?;
16059                let args = self.parse_optional_args()?;
16060                let with_ordinality = self.parse_keywords(&[Keyword::WITH, Keyword::ORDINALITY]);
16061                let alias = self.maybe_parse_table_alias()?;
16062                Ok(TableFactor::Function {
16063                    lateral: true,
16064                    name,
16065                    args,
16066                    with_ordinality,
16067                    alias,
16068                })
16069            }
16070        } else if self.parse_keyword(Keyword::TABLE) {
16071            // parse table function (SELECT * FROM TABLE (<expr>) [ AS <alias> ])
16072            self.expect_token(&Token::LParen)?;
16073            let expr = self.parse_expr()?;
16074            self.expect_token(&Token::RParen)?;
16075            let alias = self.maybe_parse_table_alias()?;
16076            Ok(TableFactor::TableFunction { expr, alias })
16077        } else if self.consume_token(&Token::LParen) {
16078            // A left paren introduces either a derived table (i.e., a subquery)
16079            // or a nested join. It's nearly impossible to determine ahead of
16080            // time which it is... so we just try to parse both.
16081            //
16082            // Here's an example that demonstrates the complexity:
16083            //                     /-------------------------------------------------------\
16084            //                     | /-----------------------------------\                 |
16085            //     SELECT * FROM ( ( ( (SELECT 1) UNION (SELECT 2) ) AS t1 NATURAL JOIN t2 ) )
16086            //                   ^ ^ ^ ^
16087            //                   | | | |
16088            //                   | | | |
16089            //                   | | | (4) belongs to a SetExpr::Query inside the subquery
16090            //                   | | (3) starts a derived table (subquery)
16091            //                   | (2) starts a nested join
16092            //                   (1) an additional set of parens around a nested join
16093            //
16094
16095            // If the recently consumed '(' starts a derived table, the call to
16096            // `parse_derived_table_factor` below will return success after parsing the
16097            // subquery, followed by the closing ')', and the alias of the derived table.
16098            // In the example above this is case (3).
16099            if let Some(mut table) =
16100                self.maybe_parse(|parser| parser.parse_derived_table_factor(NotLateral))?
16101            {
16102                while let Some(kw) = self.parse_one_of_keywords(&[Keyword::PIVOT, Keyword::UNPIVOT])
16103                {
16104                    table = match kw {
16105                        Keyword::PIVOT => self.parse_pivot_table_factor(table)?,
16106                        Keyword::UNPIVOT => self.parse_unpivot_table_factor(table)?,
16107                        unexpected_keyword => return Err(ParserError::ParserError(
16108                            format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in pivot/unpivot"),
16109                        )),
16110                    }
16111                }
16112                return Ok(table);
16113            }
16114
16115            // A parsing error from `parse_derived_table_factor` indicates that the '(' we've
16116            // recently consumed does not start a derived table (cases 1, 2, or 4).
16117            // `maybe_parse` will ignore such an error and rewind to be after the opening '('.
16118
16119            // Inside the parentheses we expect to find an (A) table factor
16120            // followed by some joins or (B) another level of nesting.
16121            let mut table_and_joins = self.parse_table_and_joins()?;
16122
16123            #[allow(clippy::if_same_then_else)]
16124            if !table_and_joins.joins.is_empty() {
16125                self.expect_token(&Token::RParen)?;
16126                let alias = self.maybe_parse_table_alias()?;
16127                Ok(TableFactor::NestedJoin {
16128                    table_with_joins: Box::new(table_and_joins),
16129                    alias,
16130                }) // (A)
16131            } else if let TableFactor::NestedJoin {
16132                table_with_joins: _,
16133                alias: _,
16134            } = &table_and_joins.relation
16135            {
16136                // (B): `table_and_joins` (what we found inside the parentheses)
16137                // is a nested join `(foo JOIN bar)`, not followed by other joins.
16138                self.expect_token(&Token::RParen)?;
16139                let alias = self.maybe_parse_table_alias()?;
16140                Ok(TableFactor::NestedJoin {
16141                    table_with_joins: Box::new(table_and_joins),
16142                    alias,
16143                })
16144            } else if self.dialect.supports_parens_around_table_factor() {
16145                // Dialect-specific behavior: Snowflake diverges from the
16146                // standard and from most of the other implementations by
16147                // allowing extra parentheses not only around a join (B), but
16148                // around lone table names (e.g. `FROM (mytable [AS alias])`)
16149                // and around derived tables (e.g. `FROM ((SELECT ...)
16150                // [AS alias])`) as well.
16151                self.expect_token(&Token::RParen)?;
16152
16153                if let Some(outer_alias) = self.maybe_parse_table_alias()? {
16154                    // Snowflake also allows specifying an alias *after* parens
16155                    // e.g. `FROM (mytable) AS alias`
16156                    match &mut table_and_joins.relation {
16157                        TableFactor::Derived { alias, .. }
16158                        | TableFactor::Table { alias, .. }
16159                        | TableFactor::Function { alias, .. }
16160                        | TableFactor::UNNEST { alias, .. }
16161                        | TableFactor::JsonTable { alias, .. }
16162                        | TableFactor::XmlTable { alias, .. }
16163                        | TableFactor::OpenJsonTable { alias, .. }
16164                        | TableFactor::TableFunction { alias, .. }
16165                        | TableFactor::Pivot { alias, .. }
16166                        | TableFactor::Unpivot { alias, .. }
16167                        | TableFactor::MatchRecognize { alias, .. }
16168                        | TableFactor::SemanticView { alias, .. }
16169                        | TableFactor::NestedJoin { alias, .. } => {
16170                            // but not `FROM (mytable AS alias1) AS alias2`.
16171                            if let Some(inner_alias) = alias {
16172                                return Err(ParserError::ParserError(format!(
16173                                    "duplicate alias {inner_alias}"
16174                                )));
16175                            }
16176                            // Act as if the alias was specified normally next
16177                            // to the table name: `(mytable) AS alias` ->
16178                            // `(mytable AS alias)`
16179                            alias.replace(outer_alias);
16180                        }
16181                    };
16182                }
16183                // Do not store the extra set of parens in the AST
16184                Ok(table_and_joins.relation)
16185            } else {
16186                // The SQL spec prohibits derived tables and bare tables from
16187                // appearing alone in parentheses (e.g. `FROM (mytable)`)
16188                self.expected_ref("joined table", self.peek_token_ref())
16189            }
16190        } else if self.dialect.supports_values_as_table_factor()
16191            && matches!(
16192                self.peek_tokens(),
16193                [
16194                    Token::Word(Word {
16195                        keyword: Keyword::VALUES,
16196                        ..
16197                    }),
16198                    Token::LParen
16199                ]
16200            )
16201        {
16202            self.expect_keyword_is(Keyword::VALUES)?;
16203
16204            // Snowflake and Databricks allow syntax like below:
16205            // SELECT * FROM VALUES (1, 'a'), (2, 'b') AS t (col1, col2)
16206            // where there are no parentheses around the VALUES clause.
16207            let values = SetExpr::Values(self.parse_values(false, false)?);
16208            let alias = self.maybe_parse_table_alias()?;
16209            Ok(TableFactor::Derived {
16210                lateral: false,
16211                subquery: Box::new(Query {
16212                    with: None,
16213                    body: Box::new(values),
16214                    order_by: None,
16215                    limit_clause: None,
16216                    fetch: None,
16217                    locks: vec![],
16218                    for_clause: None,
16219                    settings: None,
16220                    format_clause: None,
16221                    pipe_operators: vec![],
16222                }),
16223                alias,
16224                sample: None,
16225            })
16226        } else if dialect_of!(self is BigQueryDialect | PostgreSqlDialect | GenericDialect)
16227            && self.parse_keyword(Keyword::UNNEST)
16228        {
16229            self.expect_token(&Token::LParen)?;
16230            let array_exprs = self.parse_comma_separated(Parser::parse_expr)?;
16231            self.expect_token(&Token::RParen)?;
16232
16233            let with_ordinality = self.parse_keywords(&[Keyword::WITH, Keyword::ORDINALITY]);
16234            let alias = match self.maybe_parse_table_alias() {
16235                Ok(Some(alias)) => Some(alias),
16236                Ok(None) => None,
16237                Err(e) => return Err(e),
16238            };
16239
16240            let with_offset = match self.expect_keywords(&[Keyword::WITH, Keyword::OFFSET]) {
16241                Ok(()) => true,
16242                Err(_) => false,
16243            };
16244
16245            let with_offset_alias = if with_offset {
16246                match self.parse_optional_alias(keywords::RESERVED_FOR_COLUMN_ALIAS) {
16247                    Ok(Some(alias)) => Some(alias),
16248                    Ok(None) => None,
16249                    Err(e) => return Err(e),
16250                }
16251            } else {
16252                None
16253            };
16254
16255            Ok(TableFactor::UNNEST {
16256                alias,
16257                array_exprs,
16258                with_offset,
16259                with_offset_alias,
16260                with_ordinality,
16261            })
16262        } else if self.parse_keyword_with_tokens(Keyword::JSON_TABLE, &[Token::LParen]) {
16263            let json_expr = self.parse_expr()?;
16264            self.expect_token(&Token::Comma)?;
16265            let json_path = self.parse_value()?;
16266            self.expect_keyword_is(Keyword::COLUMNS)?;
16267            self.expect_token(&Token::LParen)?;
16268            let columns = self.parse_comma_separated(Parser::parse_json_table_column_def)?;
16269            self.expect_token(&Token::RParen)?;
16270            self.expect_token(&Token::RParen)?;
16271            let alias = self.maybe_parse_table_alias()?;
16272            Ok(TableFactor::JsonTable {
16273                json_expr,
16274                json_path,
16275                columns,
16276                alias,
16277            })
16278        } else if self.parse_keyword_with_tokens(Keyword::OPENJSON, &[Token::LParen]) {
16279            self.prev_token();
16280            self.parse_open_json_table_factor()
16281        } else if self.parse_keyword_with_tokens(Keyword::XMLTABLE, &[Token::LParen]) {
16282            self.prev_token();
16283            self.parse_xml_table_factor()
16284        } else if self.dialect.supports_semantic_view_table_factor()
16285            && self.peek_keyword_with_tokens(Keyword::SEMANTIC_VIEW, &[Token::LParen])
16286        {
16287            self.parse_semantic_view_table_factor()
16288        } else if self.peek_token_ref().token == Token::AtSign {
16289            // Stage reference: @mystage or @namespace.stage (e.g. Snowflake)
16290            self.parse_snowflake_stage_table_factor()
16291        } else {
16292            let name = self.parse_object_name(true)?;
16293
16294            let json_path = match &self.peek_token_ref().token {
16295                Token::LBracket if self.dialect.supports_partiql() => Some(self.parse_json_path()?),
16296                _ => None,
16297            };
16298
16299            let partitions: Vec<Ident> = if dialect_of!(self is MySqlDialect | GenericDialect)
16300                && self.parse_keyword(Keyword::PARTITION)
16301            {
16302                self.parse_parenthesized_identifiers()?
16303            } else {
16304                vec![]
16305            };
16306
16307            // Parse potential version qualifier
16308            let version = self.maybe_parse_table_version()?;
16309
16310            // Postgres, MSSQL, ClickHouse: table-valued functions:
16311            let args = if self.consume_token(&Token::LParen) {
16312                Some(self.parse_table_function_args()?)
16313            } else {
16314                None
16315            };
16316
16317            let with_ordinality = self.parse_keywords(&[Keyword::WITH, Keyword::ORDINALITY]);
16318
16319            let mut sample = None;
16320            if self.dialect.supports_table_sample_before_alias() {
16321                if let Some(parsed_sample) = self.maybe_parse_table_sample()? {
16322                    sample = Some(TableSampleKind::BeforeTableAlias(parsed_sample));
16323                }
16324            }
16325
16326            let alias = self.maybe_parse_table_alias()?;
16327
16328            // MYSQL-specific table hints:
16329            let index_hints = if self.dialect.supports_table_hints() {
16330                self.maybe_parse(|p| p.parse_table_index_hints())?
16331                    .unwrap_or(vec![])
16332            } else {
16333                vec![]
16334            };
16335
16336            // MSSQL-specific table hints:
16337            let mut with_hints = vec![];
16338            if self.parse_keyword(Keyword::WITH) {
16339                if self.consume_token(&Token::LParen) {
16340                    with_hints = self.parse_comma_separated(Parser::parse_expr)?;
16341                    self.expect_token(&Token::RParen)?;
16342                } else {
16343                    // rewind, as WITH may belong to the next statement's CTE
16344                    self.prev_token();
16345                }
16346            };
16347
16348            if !self.dialect.supports_table_sample_before_alias() {
16349                if let Some(parsed_sample) = self.maybe_parse_table_sample()? {
16350                    sample = Some(TableSampleKind::AfterTableAlias(parsed_sample));
16351                }
16352            }
16353
16354            let mut table = TableFactor::Table {
16355                name,
16356                alias,
16357                args,
16358                with_hints,
16359                version,
16360                partitions,
16361                with_ordinality,
16362                json_path,
16363                sample,
16364                index_hints,
16365            };
16366
16367            while let Some(kw) = self.parse_one_of_keywords(&[Keyword::PIVOT, Keyword::UNPIVOT]) {
16368                table = match kw {
16369                    Keyword::PIVOT => self.parse_pivot_table_factor(table)?,
16370                    Keyword::UNPIVOT => self.parse_unpivot_table_factor(table)?,
16371                    unexpected_keyword => return Err(ParserError::ParserError(
16372                        format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in pivot/unpivot"),
16373                    )),
16374                }
16375            }
16376
16377            if self.dialect.supports_match_recognize()
16378                && self.parse_keyword(Keyword::MATCH_RECOGNIZE)
16379            {
16380                table = self.parse_match_recognize(table)?;
16381            }
16382
16383            Ok(table)
16384        }
16385    }
16386
16387    /// Parse a Snowflake stage reference as a table factor.
16388    /// Handles syntax like: `@mystage1 (file_format => 'myformat', pattern => '...')`
16389    ///
16390    /// See: <https://docs.snowflake.com/en/user-guide/querying-stage>
16391    fn parse_snowflake_stage_table_factor(&mut self) -> Result<TableFactor, ParserError> {
16392        // Parse the stage name starting with @
16393        let name = crate::dialect::parse_snowflake_stage_name(self)?;
16394
16395        // Parse optional stage options like (file_format => 'myformat', pattern => '...')
16396        let args = if self.consume_token(&Token::LParen) {
16397            Some(self.parse_table_function_args()?)
16398        } else {
16399            None
16400        };
16401
16402        let alias = self.maybe_parse_table_alias()?;
16403
16404        Ok(TableFactor::Table {
16405            name,
16406            alias,
16407            args,
16408            with_hints: vec![],
16409            version: None,
16410            partitions: vec![],
16411            with_ordinality: false,
16412            json_path: None,
16413            sample: None,
16414            index_hints: vec![],
16415        })
16416    }
16417
16418    fn maybe_parse_table_sample(&mut self) -> Result<Option<Box<TableSample>>, ParserError> {
16419        let modifier = if self.parse_keyword(Keyword::TABLESAMPLE) {
16420            TableSampleModifier::TableSample
16421        } else if self.parse_keyword(Keyword::SAMPLE) {
16422            TableSampleModifier::Sample
16423        } else {
16424            return Ok(None);
16425        };
16426        self.parse_table_sample(modifier).map(Some)
16427    }
16428
16429    fn parse_table_sample(
16430        &mut self,
16431        modifier: TableSampleModifier,
16432    ) -> Result<Box<TableSample>, ParserError> {
16433        let name = match self.parse_one_of_keywords(&[
16434            Keyword::BERNOULLI,
16435            Keyword::ROW,
16436            Keyword::SYSTEM,
16437            Keyword::BLOCK,
16438        ]) {
16439            Some(Keyword::BERNOULLI) => Some(TableSampleMethod::Bernoulli),
16440            Some(Keyword::ROW) => Some(TableSampleMethod::Row),
16441            Some(Keyword::SYSTEM) => Some(TableSampleMethod::System),
16442            Some(Keyword::BLOCK) => Some(TableSampleMethod::Block),
16443            _ => None,
16444        };
16445
16446        let parenthesized = self.consume_token(&Token::LParen);
16447
16448        let (quantity, bucket) = if parenthesized && self.parse_keyword(Keyword::BUCKET) {
16449            let selected_bucket = self.parse_number_value()?;
16450            self.expect_keywords(&[Keyword::OUT, Keyword::OF])?;
16451            let total = self.parse_number_value()?;
16452            let on = if self.parse_keyword(Keyword::ON) {
16453                Some(self.parse_expr()?)
16454            } else {
16455                None
16456            };
16457            (
16458                None,
16459                Some(TableSampleBucket {
16460                    bucket: selected_bucket,
16461                    total,
16462                    on,
16463                }),
16464            )
16465        } else {
16466            let value = match self.maybe_parse(|p| p.parse_expr())? {
16467                Some(num) => num,
16468                None => {
16469                    let next_token = self.next_token();
16470                    if let Token::Word(w) = next_token.token {
16471                        Expr::Value(Value::Placeholder(w.value).with_span(next_token.span))
16472                    } else {
16473                        return parser_err!(
16474                            "Expecting number or byte length e.g. 100M",
16475                            self.peek_token_ref().span.start
16476                        );
16477                    }
16478                }
16479            };
16480            let unit = if self.parse_keyword(Keyword::ROWS) {
16481                Some(TableSampleUnit::Rows)
16482            } else if self.parse_keyword(Keyword::PERCENT) {
16483                Some(TableSampleUnit::Percent)
16484            } else {
16485                None
16486            };
16487            (
16488                Some(TableSampleQuantity {
16489                    parenthesized,
16490                    value,
16491                    unit,
16492                }),
16493                None,
16494            )
16495        };
16496        if parenthesized {
16497            self.expect_token(&Token::RParen)?;
16498        }
16499
16500        let seed = if self.parse_keyword(Keyword::REPEATABLE) {
16501            Some(self.parse_table_sample_seed(TableSampleSeedModifier::Repeatable)?)
16502        } else if self.parse_keyword(Keyword::SEED) {
16503            Some(self.parse_table_sample_seed(TableSampleSeedModifier::Seed)?)
16504        } else {
16505            None
16506        };
16507
16508        let offset = if self.parse_keyword(Keyword::OFFSET) {
16509            Some(self.parse_expr()?)
16510        } else {
16511            None
16512        };
16513
16514        Ok(Box::new(TableSample {
16515            modifier,
16516            name,
16517            quantity,
16518            seed,
16519            bucket,
16520            offset,
16521        }))
16522    }
16523
16524    fn parse_table_sample_seed(
16525        &mut self,
16526        modifier: TableSampleSeedModifier,
16527    ) -> Result<TableSampleSeed, ParserError> {
16528        self.expect_token(&Token::LParen)?;
16529        let value = self.parse_number_value()?;
16530        self.expect_token(&Token::RParen)?;
16531        Ok(TableSampleSeed { modifier, value })
16532    }
16533
16534    /// Parses `OPENJSON( jsonExpression [ , path ] )  [ <with_clause> ]` clause,
16535    /// assuming the `OPENJSON` keyword was already consumed.
16536    fn parse_open_json_table_factor(&mut self) -> Result<TableFactor, ParserError> {
16537        self.expect_token(&Token::LParen)?;
16538        let json_expr = self.parse_expr()?;
16539        let json_path = if self.consume_token(&Token::Comma) {
16540            Some(self.parse_value()?)
16541        } else {
16542            None
16543        };
16544        self.expect_token(&Token::RParen)?;
16545        let columns = if self.parse_keyword(Keyword::WITH) {
16546            self.expect_token(&Token::LParen)?;
16547            let columns = self.parse_comma_separated(Parser::parse_openjson_table_column_def)?;
16548            self.expect_token(&Token::RParen)?;
16549            columns
16550        } else {
16551            Vec::new()
16552        };
16553        let alias = self.maybe_parse_table_alias()?;
16554        Ok(TableFactor::OpenJsonTable {
16555            json_expr,
16556            json_path,
16557            columns,
16558            alias,
16559        })
16560    }
16561
16562    fn parse_xml_table_factor(&mut self) -> Result<TableFactor, ParserError> {
16563        self.expect_token(&Token::LParen)?;
16564        let namespaces = if self.parse_keyword(Keyword::XMLNAMESPACES) {
16565            self.expect_token(&Token::LParen)?;
16566            let namespaces = self.parse_comma_separated(Parser::parse_xml_namespace_definition)?;
16567            self.expect_token(&Token::RParen)?;
16568            self.expect_token(&Token::Comma)?;
16569            namespaces
16570        } else {
16571            vec![]
16572        };
16573        let row_expression = self.parse_expr()?;
16574        let passing = self.parse_xml_passing_clause()?;
16575        self.expect_keyword_is(Keyword::COLUMNS)?;
16576        let columns = self.parse_comma_separated(Parser::parse_xml_table_column)?;
16577        self.expect_token(&Token::RParen)?;
16578        let alias = self.maybe_parse_table_alias()?;
16579        Ok(TableFactor::XmlTable {
16580            namespaces,
16581            row_expression,
16582            passing,
16583            columns,
16584            alias,
16585        })
16586    }
16587
16588    fn parse_xml_namespace_definition(&mut self) -> Result<XmlNamespaceDefinition, ParserError> {
16589        let uri = self.parse_expr()?;
16590        self.expect_keyword_is(Keyword::AS)?;
16591        let name = self.parse_identifier()?;
16592        Ok(XmlNamespaceDefinition { uri, name })
16593    }
16594
16595    fn parse_xml_table_column(&mut self) -> Result<XmlTableColumn, ParserError> {
16596        let name = self.parse_identifier()?;
16597
16598        let option = if self.parse_keyword(Keyword::FOR) {
16599            self.expect_keyword(Keyword::ORDINALITY)?;
16600            XmlTableColumnOption::ForOrdinality
16601        } else {
16602            let r#type = self.parse_data_type()?;
16603            let mut path = None;
16604            let mut default = None;
16605
16606            if self.parse_keyword(Keyword::PATH) {
16607                path = Some(self.parse_expr()?);
16608            }
16609
16610            if self.parse_keyword(Keyword::DEFAULT) {
16611                default = Some(self.parse_expr()?);
16612            }
16613
16614            let not_null = self.parse_keywords(&[Keyword::NOT, Keyword::NULL]);
16615            if !not_null {
16616                // NULL is the default but can be specified explicitly
16617                let _ = self.parse_keyword(Keyword::NULL);
16618            }
16619
16620            XmlTableColumnOption::NamedInfo {
16621                r#type,
16622                path,
16623                default,
16624                nullable: !not_null,
16625            }
16626        };
16627        Ok(XmlTableColumn { name, option })
16628    }
16629
16630    fn parse_xml_passing_clause(&mut self) -> Result<XmlPassingClause, ParserError> {
16631        let mut arguments = vec![];
16632        if self.parse_keyword(Keyword::PASSING) {
16633            loop {
16634                let by_value =
16635                    self.parse_keyword(Keyword::BY) && self.expect_keyword(Keyword::VALUE).is_ok();
16636                let expr = self.parse_expr()?;
16637                let alias = if self.parse_keyword(Keyword::AS) {
16638                    Some(self.parse_identifier()?)
16639                } else {
16640                    None
16641                };
16642                arguments.push(XmlPassingArgument {
16643                    expr,
16644                    alias,
16645                    by_value,
16646                });
16647                if !self.consume_token(&Token::Comma) {
16648                    break;
16649                }
16650            }
16651        }
16652        Ok(XmlPassingClause { arguments })
16653    }
16654
16655    /// Parse a [TableFactor::SemanticView]
16656    fn parse_semantic_view_table_factor(&mut self) -> Result<TableFactor, ParserError> {
16657        self.expect_keyword(Keyword::SEMANTIC_VIEW)?;
16658        self.expect_token(&Token::LParen)?;
16659
16660        let name = self.parse_object_name(true)?;
16661
16662        // Parse DIMENSIONS, METRICS, FACTS and WHERE clauses in flexible order
16663        let mut dimensions = Vec::new();
16664        let mut metrics = Vec::new();
16665        let mut facts = Vec::new();
16666        let mut where_clause = None;
16667
16668        while self.peek_token_ref().token != Token::RParen {
16669            if self.parse_keyword(Keyword::DIMENSIONS) {
16670                if !dimensions.is_empty() {
16671                    return Err(ParserError::ParserError(
16672                        "DIMENSIONS clause can only be specified once".to_string(),
16673                    ));
16674                }
16675                dimensions = self.parse_comma_separated(Parser::parse_wildcard_expr)?;
16676            } else if self.parse_keyword(Keyword::METRICS) {
16677                if !metrics.is_empty() {
16678                    return Err(ParserError::ParserError(
16679                        "METRICS clause can only be specified once".to_string(),
16680                    ));
16681                }
16682                metrics = self.parse_comma_separated(Parser::parse_wildcard_expr)?;
16683            } else if self.parse_keyword(Keyword::FACTS) {
16684                if !facts.is_empty() {
16685                    return Err(ParserError::ParserError(
16686                        "FACTS clause can only be specified once".to_string(),
16687                    ));
16688                }
16689                facts = self.parse_comma_separated(Parser::parse_wildcard_expr)?;
16690            } else if self.parse_keyword(Keyword::WHERE) {
16691                if where_clause.is_some() {
16692                    return Err(ParserError::ParserError(
16693                        "WHERE clause can only be specified once".to_string(),
16694                    ));
16695                }
16696                where_clause = Some(self.parse_expr()?);
16697            } else {
16698                let tok = self.peek_token_ref();
16699                return parser_err!(
16700                    format!(
16701                        "Expected one of DIMENSIONS, METRICS, FACTS or WHERE, got {}",
16702                        tok.token
16703                    ),
16704                    tok.span.start
16705                )?;
16706            }
16707        }
16708
16709        self.expect_token(&Token::RParen)?;
16710
16711        let alias = self.maybe_parse_table_alias()?;
16712
16713        Ok(TableFactor::SemanticView {
16714            name,
16715            dimensions,
16716            metrics,
16717            facts,
16718            where_clause,
16719            alias,
16720        })
16721    }
16722
16723    fn parse_match_recognize(&mut self, table: TableFactor) -> Result<TableFactor, ParserError> {
16724        self.expect_token(&Token::LParen)?;
16725
16726        let partition_by = if self.parse_keywords(&[Keyword::PARTITION, Keyword::BY]) {
16727            self.parse_comma_separated(Parser::parse_expr)?
16728        } else {
16729            vec![]
16730        };
16731
16732        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
16733            self.parse_comma_separated(Parser::parse_order_by_expr)?
16734        } else {
16735            vec![]
16736        };
16737
16738        let measures = if self.parse_keyword(Keyword::MEASURES) {
16739            self.parse_comma_separated(|p| {
16740                let expr = p.parse_expr()?;
16741                let _ = p.parse_keyword(Keyword::AS);
16742                let alias = p.parse_identifier()?;
16743                Ok(Measure { expr, alias })
16744            })?
16745        } else {
16746            vec![]
16747        };
16748
16749        let rows_per_match =
16750            if self.parse_keywords(&[Keyword::ONE, Keyword::ROW, Keyword::PER, Keyword::MATCH]) {
16751                Some(RowsPerMatch::OneRow)
16752            } else if self.parse_keywords(&[
16753                Keyword::ALL,
16754                Keyword::ROWS,
16755                Keyword::PER,
16756                Keyword::MATCH,
16757            ]) {
16758                Some(RowsPerMatch::AllRows(
16759                    if self.parse_keywords(&[Keyword::SHOW, Keyword::EMPTY, Keyword::MATCHES]) {
16760                        Some(EmptyMatchesMode::Show)
16761                    } else if self.parse_keywords(&[
16762                        Keyword::OMIT,
16763                        Keyword::EMPTY,
16764                        Keyword::MATCHES,
16765                    ]) {
16766                        Some(EmptyMatchesMode::Omit)
16767                    } else if self.parse_keywords(&[
16768                        Keyword::WITH,
16769                        Keyword::UNMATCHED,
16770                        Keyword::ROWS,
16771                    ]) {
16772                        Some(EmptyMatchesMode::WithUnmatched)
16773                    } else {
16774                        None
16775                    },
16776                ))
16777            } else {
16778                None
16779            };
16780
16781        let after_match_skip =
16782            if self.parse_keywords(&[Keyword::AFTER, Keyword::MATCH, Keyword::SKIP]) {
16783                if self.parse_keywords(&[Keyword::PAST, Keyword::LAST, Keyword::ROW]) {
16784                    Some(AfterMatchSkip::PastLastRow)
16785                } else if self.parse_keywords(&[Keyword::TO, Keyword::NEXT, Keyword::ROW]) {
16786                    Some(AfterMatchSkip::ToNextRow)
16787                } else if self.parse_keywords(&[Keyword::TO, Keyword::FIRST]) {
16788                    Some(AfterMatchSkip::ToFirst(self.parse_identifier()?))
16789                } else if self.parse_keywords(&[Keyword::TO, Keyword::LAST]) {
16790                    Some(AfterMatchSkip::ToLast(self.parse_identifier()?))
16791                } else {
16792                    let found = self.next_token();
16793                    return self.expected("after match skip option", found);
16794                }
16795            } else {
16796                None
16797            };
16798
16799        self.expect_keyword_is(Keyword::PATTERN)?;
16800        let pattern = self.parse_parenthesized(Self::parse_pattern)?;
16801
16802        self.expect_keyword_is(Keyword::DEFINE)?;
16803
16804        let symbols = self.parse_comma_separated(|p| {
16805            let symbol = p.parse_identifier()?;
16806            p.expect_keyword_is(Keyword::AS)?;
16807            let definition = p.parse_expr()?;
16808            Ok(SymbolDefinition { symbol, definition })
16809        })?;
16810
16811        self.expect_token(&Token::RParen)?;
16812
16813        let alias = self.maybe_parse_table_alias()?;
16814
16815        Ok(TableFactor::MatchRecognize {
16816            table: Box::new(table),
16817            partition_by,
16818            order_by,
16819            measures,
16820            rows_per_match,
16821            after_match_skip,
16822            pattern,
16823            symbols,
16824            alias,
16825        })
16826    }
16827
16828    fn parse_base_pattern(&mut self) -> Result<MatchRecognizePattern, ParserError> {
16829        match self.next_token().token {
16830            Token::Caret => Ok(MatchRecognizePattern::Symbol(MatchRecognizeSymbol::Start)),
16831            Token::Placeholder(s) if s == "$" => {
16832                Ok(MatchRecognizePattern::Symbol(MatchRecognizeSymbol::End))
16833            }
16834            Token::LBrace => {
16835                self.expect_token(&Token::Minus)?;
16836                let symbol = self.parse_identifier().map(MatchRecognizeSymbol::Named)?;
16837                self.expect_token(&Token::Minus)?;
16838                self.expect_token(&Token::RBrace)?;
16839                Ok(MatchRecognizePattern::Exclude(symbol))
16840            }
16841            Token::Word(Word {
16842                value,
16843                quote_style: None,
16844                ..
16845            }) if value == "PERMUTE" => {
16846                self.expect_token(&Token::LParen)?;
16847                let symbols = self.parse_comma_separated(|p| {
16848                    p.parse_identifier().map(MatchRecognizeSymbol::Named)
16849                })?;
16850                self.expect_token(&Token::RParen)?;
16851                Ok(MatchRecognizePattern::Permute(symbols))
16852            }
16853            Token::LParen => {
16854                let pattern = self.parse_pattern()?;
16855                self.expect_token(&Token::RParen)?;
16856                Ok(MatchRecognizePattern::Group(Box::new(pattern)))
16857            }
16858            _ => {
16859                self.prev_token();
16860                self.parse_identifier()
16861                    .map(MatchRecognizeSymbol::Named)
16862                    .map(MatchRecognizePattern::Symbol)
16863            }
16864        }
16865    }
16866
16867    fn parse_repetition_pattern(&mut self) -> Result<MatchRecognizePattern, ParserError> {
16868        let mut pattern = self.parse_base_pattern()?;
16869        loop {
16870            let token = self.next_token();
16871            let quantifier = match token.token {
16872                Token::Mul => RepetitionQuantifier::ZeroOrMore,
16873                Token::Plus => RepetitionQuantifier::OneOrMore,
16874                Token::Placeholder(s) if s == "?" => RepetitionQuantifier::AtMostOne,
16875                Token::LBrace => {
16876                    // quantifier is a range like {n} or {n,} or {,m} or {n,m}
16877                    let token = self.next_token();
16878                    match token.token {
16879                        Token::Comma => {
16880                            let next_token = self.next_token();
16881                            let Token::Number(n, _) = next_token.token else {
16882                                return self.expected("literal number", next_token);
16883                            };
16884                            self.expect_token(&Token::RBrace)?;
16885                            RepetitionQuantifier::AtMost(Self::parse(n, token.span.start)?)
16886                        }
16887                        Token::Number(n, _) if self.consume_token(&Token::Comma) => {
16888                            let next_token = self.next_token();
16889                            match next_token.token {
16890                                Token::Number(m, _) => {
16891                                    self.expect_token(&Token::RBrace)?;
16892                                    RepetitionQuantifier::Range(
16893                                        Self::parse(n, token.span.start)?,
16894                                        Self::parse(m, token.span.start)?,
16895                                    )
16896                                }
16897                                Token::RBrace => {
16898                                    RepetitionQuantifier::AtLeast(Self::parse(n, token.span.start)?)
16899                                }
16900                                _ => {
16901                                    return self.expected("} or upper bound", next_token);
16902                                }
16903                            }
16904                        }
16905                        Token::Number(n, _) => {
16906                            self.expect_token(&Token::RBrace)?;
16907                            RepetitionQuantifier::Exactly(Self::parse(n, token.span.start)?)
16908                        }
16909                        _ => return self.expected("quantifier range", token),
16910                    }
16911                }
16912                _ => {
16913                    self.prev_token();
16914                    break;
16915                }
16916            };
16917            pattern = MatchRecognizePattern::Repetition(Box::new(pattern), quantifier);
16918        }
16919        Ok(pattern)
16920    }
16921
16922    fn parse_concat_pattern(&mut self) -> Result<MatchRecognizePattern, ParserError> {
16923        let mut patterns = vec![self.parse_repetition_pattern()?];
16924        while !matches!(self.peek_token_ref().token, Token::RParen | Token::Pipe) {
16925            patterns.push(self.parse_repetition_pattern()?);
16926        }
16927        match <[MatchRecognizePattern; 1]>::try_from(patterns) {
16928            Ok([pattern]) => Ok(pattern),
16929            Err(patterns) => Ok(MatchRecognizePattern::Concat(patterns)),
16930        }
16931    }
16932
16933    fn parse_pattern(&mut self) -> Result<MatchRecognizePattern, ParserError> {
16934        let pattern = self.parse_concat_pattern()?;
16935        if self.consume_token(&Token::Pipe) {
16936            match self.parse_pattern()? {
16937                // flatten nested alternations
16938                MatchRecognizePattern::Alternation(mut patterns) => {
16939                    patterns.insert(0, pattern);
16940                    Ok(MatchRecognizePattern::Alternation(patterns))
16941                }
16942                next => Ok(MatchRecognizePattern::Alternation(vec![pattern, next])),
16943            }
16944        } else {
16945            Ok(pattern)
16946        }
16947    }
16948
16949    /// Parses a the timestamp version specifier (i.e. query historical data)
16950    pub fn maybe_parse_table_version(&mut self) -> Result<Option<TableVersion>, ParserError> {
16951        if self.dialect.supports_table_versioning() {
16952            if self.parse_keywords(&[Keyword::FOR, Keyword::SYSTEM_TIME, Keyword::AS, Keyword::OF])
16953            {
16954                let expr = self.parse_expr()?;
16955                return Ok(Some(TableVersion::ForSystemTimeAsOf(expr)));
16956            } else if self.peek_keyword(Keyword::CHANGES) {
16957                return self.parse_table_version_changes().map(Some);
16958            } else if self.peek_keyword(Keyword::AT) || self.peek_keyword(Keyword::BEFORE) {
16959                let func_name = self.parse_object_name(true)?;
16960                let func = self.parse_function(func_name)?;
16961                return Ok(Some(TableVersion::Function(func)));
16962            } else if self.parse_keywords(&[Keyword::TIMESTAMP, Keyword::AS, Keyword::OF]) {
16963                let expr = self.parse_expr()?;
16964                return Ok(Some(TableVersion::TimestampAsOf(expr)));
16965            } else if self.parse_keywords(&[Keyword::VERSION, Keyword::AS, Keyword::OF]) {
16966                let expr = Expr::Value(self.parse_number_value()?);
16967                return Ok(Some(TableVersion::VersionAsOf(expr)));
16968            }
16969        }
16970        Ok(None)
16971    }
16972
16973    /// Parses the Snowflake `CHANGES` clause for change tracking queries.
16974    ///
16975    /// Syntax:
16976    /// ```sql
16977    /// CHANGES (INFORMATION => DEFAULT)
16978    ///   AT (TIMESTAMP => <expr>)
16979    ///   [END (TIMESTAMP => <expr>)]
16980    /// ```
16981    ///
16982    /// <https://docs.snowflake.com/en/sql-reference/constructs/changes>
16983    fn parse_table_version_changes(&mut self) -> Result<TableVersion, ParserError> {
16984        let changes_name = self.parse_object_name(true)?;
16985        let changes = self.parse_function(changes_name)?;
16986        let at_name = self.parse_object_name(true)?;
16987        let at = self.parse_function(at_name)?;
16988        let end = if self.peek_keyword(Keyword::END) {
16989            let end_name = self.parse_object_name(true)?;
16990            Some(self.parse_function(end_name)?)
16991        } else {
16992            None
16993        };
16994        Ok(TableVersion::Changes { changes, at, end })
16995    }
16996
16997    /// Parses MySQL's JSON_TABLE column definition.
16998    /// For example: `id INT EXISTS PATH '$' DEFAULT '0' ON EMPTY ERROR ON ERROR`
16999    pub fn parse_json_table_column_def(&mut self) -> Result<JsonTableColumn, ParserError> {
17000        if self.parse_keyword(Keyword::NESTED) {
17001            let _has_path_keyword = self.parse_keyword(Keyword::PATH);
17002            let path = self.parse_value()?;
17003            self.expect_keyword_is(Keyword::COLUMNS)?;
17004            let columns = self.parse_parenthesized(|p| {
17005                p.parse_comma_separated(Self::parse_json_table_column_def)
17006            })?;
17007            return Ok(JsonTableColumn::Nested(JsonTableNestedColumn {
17008                path,
17009                columns,
17010            }));
17011        }
17012        let name = self.parse_identifier()?;
17013        if self.parse_keyword(Keyword::FOR) {
17014            self.expect_keyword_is(Keyword::ORDINALITY)?;
17015            return Ok(JsonTableColumn::ForOrdinality(name));
17016        }
17017        let r#type = self.parse_data_type()?;
17018        let exists = self.parse_keyword(Keyword::EXISTS);
17019        self.expect_keyword_is(Keyword::PATH)?;
17020        let path = self.parse_value()?;
17021        let mut on_empty = None;
17022        let mut on_error = None;
17023        while let Some(error_handling) = self.parse_json_table_column_error_handling()? {
17024            if self.parse_keyword(Keyword::EMPTY) {
17025                on_empty = Some(error_handling);
17026            } else {
17027                self.expect_keyword_is(Keyword::ERROR)?;
17028                on_error = Some(error_handling);
17029            }
17030        }
17031        Ok(JsonTableColumn::Named(JsonTableNamedColumn {
17032            name,
17033            r#type,
17034            path,
17035            exists,
17036            on_empty,
17037            on_error,
17038        }))
17039    }
17040
17041    /// Parses MSSQL's `OPENJSON WITH` column definition.
17042    ///
17043    /// ```sql
17044    /// colName type [ column_path ] [ AS JSON ]
17045    /// ```
17046    ///
17047    /// Reference: <https://learn.microsoft.com/en-us/sql/t-sql/functions/openjson-transact-sql?view=sql-server-ver16#syntax>
17048    pub fn parse_openjson_table_column_def(&mut self) -> Result<OpenJsonTableColumn, ParserError> {
17049        let name = self.parse_identifier()?;
17050        let r#type = self.parse_data_type()?;
17051        let path = if let Token::SingleQuotedString(path) = self.peek_token().token {
17052            self.next_token();
17053            Some(path)
17054        } else {
17055            None
17056        };
17057        let as_json = self.parse_keyword(Keyword::AS);
17058        if as_json {
17059            self.expect_keyword_is(Keyword::JSON)?;
17060        }
17061        Ok(OpenJsonTableColumn {
17062            name,
17063            r#type,
17064            path,
17065            as_json,
17066        })
17067    }
17068
17069    fn parse_json_table_column_error_handling(
17070        &mut self,
17071    ) -> Result<Option<JsonTableColumnErrorHandling>, ParserError> {
17072        let res = if self.parse_keyword(Keyword::NULL) {
17073            JsonTableColumnErrorHandling::Null
17074        } else if self.parse_keyword(Keyword::ERROR) {
17075            JsonTableColumnErrorHandling::Error
17076        } else if self.parse_keyword(Keyword::DEFAULT) {
17077            JsonTableColumnErrorHandling::Default(self.parse_value()?)
17078        } else {
17079            return Ok(None);
17080        };
17081        self.expect_keyword_is(Keyword::ON)?;
17082        Ok(Some(res))
17083    }
17084
17085    /// Parse a derived table factor (a parenthesized subquery), handling optional LATERAL.
17086    pub fn parse_derived_table_factor(
17087        &mut self,
17088        lateral: IsLateral,
17089    ) -> Result<TableFactor, ParserError> {
17090        let subquery = self.parse_query()?;
17091        self.expect_token(&Token::RParen)?;
17092        let alias = self.maybe_parse_table_alias()?;
17093
17094        // Parse optional SAMPLE clause after alias
17095        let sample = self
17096            .maybe_parse_table_sample()?
17097            .map(TableSampleKind::AfterTableAlias);
17098
17099        Ok(TableFactor::Derived {
17100            lateral: match lateral {
17101                Lateral => true,
17102                NotLateral => false,
17103            },
17104            subquery,
17105            alias,
17106            sample,
17107        })
17108    }
17109
17110    /// Parses an expression with an optional alias
17111    ///
17112    /// Examples:
17113    ///
17114    /// ```sql
17115    /// SUM(price) AS total_price
17116    /// ```
17117    /// ```sql
17118    /// SUM(price)
17119    /// ```
17120    ///
17121    /// Example
17122    /// ```
17123    /// # use sqlparser::parser::{Parser, ParserError};
17124    /// # use sqlparser::dialect::GenericDialect;
17125    /// # fn main() ->Result<(), ParserError> {
17126    /// let sql = r#"SUM("a") as "b""#;
17127    /// let mut parser = Parser::new(&GenericDialect).try_with_sql(sql)?;
17128    /// let expr_with_alias = parser.parse_expr_with_alias()?;
17129    /// assert_eq!(Some("b".to_string()), expr_with_alias.alias.map(|x|x.value));
17130    /// # Ok(())
17131    /// # }
17132    pub fn parse_expr_with_alias(&mut self) -> Result<ExprWithAlias, ParserError> {
17133        let expr = self.parse_expr()?;
17134        let alias = if self.parse_keyword(Keyword::AS) {
17135            Some(self.parse_identifier()?)
17136        } else {
17137            None
17138        };
17139
17140        Ok(ExprWithAlias { expr, alias })
17141    }
17142
17143    /// Parse an expression followed by an optional alias; Unlike
17144    /// [Self::parse_expr_with_alias] the "AS" keyword between the expression
17145    /// and the alias is optional.
17146    fn parse_expr_with_alias_optional_as_keyword(&mut self) -> Result<ExprWithAlias, ParserError> {
17147        let expr = self.parse_expr()?;
17148        let alias = self.parse_identifier_optional_alias()?;
17149        Ok(ExprWithAlias { expr, alias })
17150    }
17151
17152    /// Parses a plain function call with an optional alias for the `PIVOT` clause
17153    fn parse_pivot_aggregate_function(&mut self) -> Result<ExprWithAlias, ParserError> {
17154        let function_name = match self.next_token().token {
17155            Token::Word(w) => Ok(w.value),
17156            _ => self.expected_ref("a function identifier", self.peek_token_ref()),
17157        }?;
17158        let expr = self.parse_function(ObjectName::from(vec![Ident::new(function_name)]))?;
17159        let alias = {
17160            fn validator(explicit: bool, kw: &Keyword, parser: &mut Parser) -> bool {
17161                // ~ for a PIVOT aggregate function the alias must not be a "FOR"; in any dialect
17162                kw != &Keyword::FOR && parser.dialect.is_select_item_alias(explicit, kw, parser)
17163            }
17164            self.parse_optional_alias_inner(None, validator)?
17165        };
17166        Ok(ExprWithAlias { expr, alias })
17167    }
17168
17169    /// Parse a PIVOT table factor (ClickHouse/Oracle style pivot), returning a TableFactor.
17170    pub fn parse_pivot_table_factor(
17171        &mut self,
17172        table: TableFactor,
17173    ) -> Result<TableFactor, ParserError> {
17174        self.expect_token(&Token::LParen)?;
17175        let aggregate_functions =
17176            self.parse_comma_separated(Self::parse_pivot_aggregate_function)?;
17177        self.expect_keyword_is(Keyword::FOR)?;
17178        let value_column = if self.peek_token_ref().token == Token::LParen {
17179            self.parse_parenthesized_column_list_inner(Mandatory, false, |p| {
17180                p.parse_subexpr(self.dialect.prec_value(Precedence::Between))
17181            })?
17182        } else {
17183            vec![self.parse_subexpr(self.dialect.prec_value(Precedence::Between))?]
17184        };
17185        self.expect_keyword_is(Keyword::IN)?;
17186
17187        self.expect_token(&Token::LParen)?;
17188        let value_source = if self.parse_keyword(Keyword::ANY) {
17189            let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
17190                self.parse_comma_separated(Parser::parse_order_by_expr)?
17191            } else {
17192                vec![]
17193            };
17194            PivotValueSource::Any(order_by)
17195        } else if self.peek_sub_query() {
17196            PivotValueSource::Subquery(self.parse_query()?)
17197        } else {
17198            PivotValueSource::List(
17199                self.parse_comma_separated(Self::parse_expr_with_alias_optional_as_keyword)?,
17200            )
17201        };
17202        self.expect_token(&Token::RParen)?;
17203
17204        let default_on_null =
17205            if self.parse_keywords(&[Keyword::DEFAULT, Keyword::ON, Keyword::NULL]) {
17206                self.expect_token(&Token::LParen)?;
17207                let expr = self.parse_expr()?;
17208                self.expect_token(&Token::RParen)?;
17209                Some(expr)
17210            } else {
17211                None
17212            };
17213
17214        self.expect_token(&Token::RParen)?;
17215        let alias = self.maybe_parse_table_alias()?;
17216        Ok(TableFactor::Pivot {
17217            table: Box::new(table),
17218            aggregate_functions,
17219            value_column,
17220            value_source,
17221            default_on_null,
17222            alias,
17223        })
17224    }
17225
17226    /// Parse an UNPIVOT table factor, returning a TableFactor.
17227    pub fn parse_unpivot_table_factor(
17228        &mut self,
17229        table: TableFactor,
17230    ) -> Result<TableFactor, ParserError> {
17231        let null_inclusion = if self.parse_keyword(Keyword::INCLUDE) {
17232            self.expect_keyword_is(Keyword::NULLS)?;
17233            Some(NullInclusion::IncludeNulls)
17234        } else if self.parse_keyword(Keyword::EXCLUDE) {
17235            self.expect_keyword_is(Keyword::NULLS)?;
17236            Some(NullInclusion::ExcludeNulls)
17237        } else {
17238            None
17239        };
17240        self.expect_token(&Token::LParen)?;
17241        let value = self.parse_expr()?;
17242        self.expect_keyword_is(Keyword::FOR)?;
17243        let name = self.parse_identifier()?;
17244        self.expect_keyword_is(Keyword::IN)?;
17245        let columns = self.parse_parenthesized_column_list_inner(Mandatory, false, |p| {
17246            p.parse_expr_with_alias()
17247        })?;
17248        self.expect_token(&Token::RParen)?;
17249        let alias = self.maybe_parse_table_alias()?;
17250        Ok(TableFactor::Unpivot {
17251            table: Box::new(table),
17252            value,
17253            null_inclusion,
17254            name,
17255            columns,
17256            alias,
17257        })
17258    }
17259
17260    /// Parse a JOIN constraint (`NATURAL`, `ON <expr>`, `USING (...)`, or no constraint).
17261    pub fn parse_join_constraint(&mut self, natural: bool) -> Result<JoinConstraint, ParserError> {
17262        if natural {
17263            Ok(JoinConstraint::Natural)
17264        } else if self.parse_keyword(Keyword::ON) {
17265            let constraint = self.parse_expr()?;
17266            Ok(JoinConstraint::On(constraint))
17267        } else if self.parse_keyword(Keyword::USING) {
17268            let columns = self.parse_parenthesized_qualified_column_list(Mandatory, false)?;
17269            Ok(JoinConstraint::Using(columns))
17270        } else {
17271            Ok(JoinConstraint::None)
17272            //self.expected_ref("ON, or USING after JOIN", self.peek_token_ref())
17273        }
17274    }
17275
17276    /// Parse a GRANT statement.
17277    pub fn parse_grant(&mut self) -> Result<Grant, ParserError> {
17278        let (privileges, objects) = self.parse_grant_deny_revoke_privileges_objects()?;
17279
17280        self.expect_keyword_is(Keyword::TO)?;
17281        let grantees = self.parse_grantees()?;
17282
17283        let with_grant_option =
17284            self.parse_keywords(&[Keyword::WITH, Keyword::GRANT, Keyword::OPTION]);
17285
17286        let current_grants =
17287            if self.parse_keywords(&[Keyword::COPY, Keyword::CURRENT, Keyword::GRANTS]) {
17288                Some(CurrentGrantsKind::CopyCurrentGrants)
17289            } else if self.parse_keywords(&[Keyword::REVOKE, Keyword::CURRENT, Keyword::GRANTS]) {
17290                Some(CurrentGrantsKind::RevokeCurrentGrants)
17291            } else {
17292                None
17293            };
17294
17295        let as_grantor = if self.parse_keywords(&[Keyword::AS]) {
17296            Some(self.parse_identifier()?)
17297        } else {
17298            None
17299        };
17300
17301        let granted_by = if self.parse_keywords(&[Keyword::GRANTED, Keyword::BY]) {
17302            Some(self.parse_identifier()?)
17303        } else {
17304            None
17305        };
17306
17307        Ok(Grant {
17308            privileges,
17309            objects,
17310            grantees,
17311            with_grant_option,
17312            as_grantor,
17313            granted_by,
17314            current_grants,
17315        })
17316    }
17317
17318    fn parse_grantees(&mut self) -> Result<Vec<Grantee>, ParserError> {
17319        let mut values = vec![];
17320        let mut grantee_type = GranteesType::None;
17321        loop {
17322            let new_grantee_type = if self.parse_keyword(Keyword::ROLE) {
17323                GranteesType::Role
17324            } else if self.parse_keyword(Keyword::USER) {
17325                GranteesType::User
17326            } else if self.parse_keyword(Keyword::SHARE) {
17327                GranteesType::Share
17328            } else if self.parse_keyword(Keyword::GROUP) {
17329                GranteesType::Group
17330            } else if self.parse_keyword(Keyword::PUBLIC) {
17331                GranteesType::Public
17332            } else if self.parse_keywords(&[Keyword::DATABASE, Keyword::ROLE]) {
17333                GranteesType::DatabaseRole
17334            } else if self.parse_keywords(&[Keyword::APPLICATION, Keyword::ROLE]) {
17335                GranteesType::ApplicationRole
17336            } else if self.parse_keyword(Keyword::APPLICATION) {
17337                GranteesType::Application
17338            } else {
17339                grantee_type.clone() // keep from previous iteraton, if not specified
17340            };
17341
17342            if self
17343                .dialect
17344                .get_reserved_grantees_types()
17345                .contains(&new_grantee_type)
17346            {
17347                self.prev_token();
17348            } else {
17349                grantee_type = new_grantee_type;
17350            }
17351
17352            let grantee = if grantee_type == GranteesType::Public {
17353                Grantee {
17354                    grantee_type: grantee_type.clone(),
17355                    name: None,
17356                }
17357            } else {
17358                let mut name = self.parse_grantee_name()?;
17359                if self.consume_token(&Token::Colon) {
17360                    // Redshift supports namespace prefix for external users and groups:
17361                    // <Namespace>:<GroupName> or <Namespace>:<UserName>
17362                    // https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-native-idp.html
17363                    let ident = self.parse_identifier()?;
17364                    if let GranteeName::ObjectName(namespace) = name {
17365                        name = GranteeName::ObjectName(ObjectName::from(vec![Ident::new(
17366                            format!("{namespace}:{ident}"),
17367                        )]));
17368                    };
17369                }
17370                Grantee {
17371                    grantee_type: grantee_type.clone(),
17372                    name: Some(name),
17373                }
17374            };
17375
17376            values.push(grantee);
17377
17378            if !self.consume_token(&Token::Comma) {
17379                break;
17380            }
17381        }
17382
17383        Ok(values)
17384    }
17385
17386    /// Parse privileges and optional target objects for GRANT/DENY/REVOKE statements.
17387    pub fn parse_grant_deny_revoke_privileges_objects(
17388        &mut self,
17389    ) -> Result<(Privileges, Option<GrantObjects>), ParserError> {
17390        let privileges = if self.parse_keyword(Keyword::ALL) {
17391            Privileges::All {
17392                with_privileges_keyword: self.parse_keyword(Keyword::PRIVILEGES),
17393            }
17394        } else {
17395            let actions = self.parse_actions_list()?;
17396            Privileges::Actions(actions)
17397        };
17398
17399        let objects = if self.parse_keyword(Keyword::ON) {
17400            if self.parse_keywords(&[Keyword::ALL, Keyword::TABLES, Keyword::IN, Keyword::SCHEMA]) {
17401                Some(GrantObjects::AllTablesInSchema {
17402                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17403                })
17404            } else if self.parse_keywords(&[
17405                Keyword::ALL,
17406                Keyword::EXTERNAL,
17407                Keyword::TABLES,
17408                Keyword::IN,
17409                Keyword::SCHEMA,
17410            ]) {
17411                Some(GrantObjects::AllExternalTablesInSchema {
17412                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17413                })
17414            } else if self.parse_keywords(&[
17415                Keyword::ALL,
17416                Keyword::VIEWS,
17417                Keyword::IN,
17418                Keyword::SCHEMA,
17419            ]) {
17420                Some(GrantObjects::AllViewsInSchema {
17421                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17422                })
17423            } else if self.parse_keywords(&[
17424                Keyword::ALL,
17425                Keyword::MATERIALIZED,
17426                Keyword::VIEWS,
17427                Keyword::IN,
17428                Keyword::SCHEMA,
17429            ]) {
17430                Some(GrantObjects::AllMaterializedViewsInSchema {
17431                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17432                })
17433            } else if self.parse_keywords(&[
17434                Keyword::ALL,
17435                Keyword::FUNCTIONS,
17436                Keyword::IN,
17437                Keyword::SCHEMA,
17438            ]) {
17439                Some(GrantObjects::AllFunctionsInSchema {
17440                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17441                })
17442            } else if self.parse_keywords(&[
17443                Keyword::FUTURE,
17444                Keyword::SCHEMAS,
17445                Keyword::IN,
17446                Keyword::DATABASE,
17447            ]) {
17448                Some(GrantObjects::FutureSchemasInDatabase {
17449                    databases: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17450                })
17451            } else if self.parse_keywords(&[
17452                Keyword::FUTURE,
17453                Keyword::TABLES,
17454                Keyword::IN,
17455                Keyword::SCHEMA,
17456            ]) {
17457                Some(GrantObjects::FutureTablesInSchema {
17458                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17459                })
17460            } else if self.parse_keywords(&[
17461                Keyword::FUTURE,
17462                Keyword::EXTERNAL,
17463                Keyword::TABLES,
17464                Keyword::IN,
17465                Keyword::SCHEMA,
17466            ]) {
17467                Some(GrantObjects::FutureExternalTablesInSchema {
17468                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17469                })
17470            } else if self.parse_keywords(&[
17471                Keyword::FUTURE,
17472                Keyword::VIEWS,
17473                Keyword::IN,
17474                Keyword::SCHEMA,
17475            ]) {
17476                Some(GrantObjects::FutureViewsInSchema {
17477                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17478                })
17479            } else if self.parse_keywords(&[
17480                Keyword::FUTURE,
17481                Keyword::MATERIALIZED,
17482                Keyword::VIEWS,
17483                Keyword::IN,
17484                Keyword::SCHEMA,
17485            ]) {
17486                Some(GrantObjects::FutureMaterializedViewsInSchema {
17487                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17488                })
17489            } else if self.parse_keywords(&[
17490                Keyword::ALL,
17491                Keyword::SEQUENCES,
17492                Keyword::IN,
17493                Keyword::SCHEMA,
17494            ]) {
17495                Some(GrantObjects::AllSequencesInSchema {
17496                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17497                })
17498            } else if self.parse_keywords(&[
17499                Keyword::FUTURE,
17500                Keyword::SEQUENCES,
17501                Keyword::IN,
17502                Keyword::SCHEMA,
17503            ]) {
17504                Some(GrantObjects::FutureSequencesInSchema {
17505                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17506                })
17507            } else if self.parse_keywords(&[Keyword::RESOURCE, Keyword::MONITOR]) {
17508                Some(GrantObjects::ResourceMonitors(
17509                    self.parse_comma_separated(|p| p.parse_object_name(false))?,
17510                ))
17511            } else if self.parse_keywords(&[Keyword::COMPUTE, Keyword::POOL]) {
17512                Some(GrantObjects::ComputePools(
17513                    self.parse_comma_separated(|p| p.parse_object_name(false))?,
17514                ))
17515            } else if self.parse_keywords(&[Keyword::FAILOVER, Keyword::GROUP]) {
17516                Some(GrantObjects::FailoverGroup(
17517                    self.parse_comma_separated(|p| p.parse_object_name(false))?,
17518                ))
17519            } else if self.parse_keywords(&[Keyword::REPLICATION, Keyword::GROUP]) {
17520                Some(GrantObjects::ReplicationGroup(
17521                    self.parse_comma_separated(|p| p.parse_object_name(false))?,
17522                ))
17523            } else if self.parse_keywords(&[Keyword::EXTERNAL, Keyword::VOLUME]) {
17524                Some(GrantObjects::ExternalVolumes(
17525                    self.parse_comma_separated(|p| p.parse_object_name(false))?,
17526                ))
17527            } else {
17528                let object_type = self.parse_one_of_keywords(&[
17529                    Keyword::SEQUENCE,
17530                    Keyword::DATABASE,
17531                    Keyword::SCHEMA,
17532                    Keyword::TABLE,
17533                    Keyword::VIEW,
17534                    Keyword::WAREHOUSE,
17535                    Keyword::INTEGRATION,
17536                    Keyword::VIEW,
17537                    Keyword::WAREHOUSE,
17538                    Keyword::INTEGRATION,
17539                    Keyword::USER,
17540                    Keyword::CONNECTION,
17541                    Keyword::PROCEDURE,
17542                    Keyword::FUNCTION,
17543                ]);
17544                let objects =
17545                    self.parse_comma_separated(|p| p.parse_object_name_inner(false, true));
17546                match object_type {
17547                    Some(Keyword::DATABASE) => Some(GrantObjects::Databases(objects?)),
17548                    Some(Keyword::SCHEMA) => Some(GrantObjects::Schemas(objects?)),
17549                    Some(Keyword::SEQUENCE) => Some(GrantObjects::Sequences(objects?)),
17550                    Some(Keyword::WAREHOUSE) => Some(GrantObjects::Warehouses(objects?)),
17551                    Some(Keyword::INTEGRATION) => Some(GrantObjects::Integrations(objects?)),
17552                    Some(Keyword::VIEW) => Some(GrantObjects::Views(objects?)),
17553                    Some(Keyword::USER) => Some(GrantObjects::Users(objects?)),
17554                    Some(Keyword::CONNECTION) => Some(GrantObjects::Connections(objects?)),
17555                    kw @ (Some(Keyword::PROCEDURE) | Some(Keyword::FUNCTION)) => {
17556                        if let Some(name) = objects?.first() {
17557                            self.parse_grant_procedure_or_function(name, &kw)?
17558                        } else {
17559                            self.expected_ref("procedure or function name", self.peek_token_ref())?
17560                        }
17561                    }
17562                    Some(Keyword::TABLE) | None => Some(GrantObjects::Tables(objects?)),
17563                    Some(unexpected_keyword) => return Err(ParserError::ParserError(
17564                        format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in grant objects"),
17565                    )),
17566                }
17567            }
17568        } else {
17569            None
17570        };
17571
17572        Ok((privileges, objects))
17573    }
17574
17575    fn parse_grant_procedure_or_function(
17576        &mut self,
17577        name: &ObjectName,
17578        kw: &Option<Keyword>,
17579    ) -> Result<Option<GrantObjects>, ParserError> {
17580        let arg_types = if self.consume_token(&Token::LParen) {
17581            let list = self.parse_comma_separated0(Self::parse_data_type, Token::RParen)?;
17582            self.expect_token(&Token::RParen)?;
17583            list
17584        } else {
17585            vec![]
17586        };
17587        match kw {
17588            Some(Keyword::PROCEDURE) => Ok(Some(GrantObjects::Procedure {
17589                name: name.clone(),
17590                arg_types,
17591            })),
17592            Some(Keyword::FUNCTION) => Ok(Some(GrantObjects::Function {
17593                name: name.clone(),
17594                arg_types,
17595            })),
17596            _ => self.expected_ref("procedure or function keywords", self.peek_token_ref())?,
17597        }
17598    }
17599
17600    /// Parse a single grantable permission/action (used within GRANT statements).
17601    pub fn parse_grant_permission(&mut self) -> Result<Action, ParserError> {
17602        fn parse_columns(parser: &mut Parser) -> Result<Option<Vec<Ident>>, ParserError> {
17603            let columns = parser.parse_parenthesized_column_list(Optional, false)?;
17604            if columns.is_empty() {
17605                Ok(None)
17606            } else {
17607                Ok(Some(columns))
17608            }
17609        }
17610
17611        // Multi-word privileges
17612        if self.parse_keywords(&[Keyword::IMPORTED, Keyword::PRIVILEGES]) {
17613            Ok(Action::ImportedPrivileges)
17614        } else if self.parse_keywords(&[Keyword::ADD, Keyword::SEARCH, Keyword::OPTIMIZATION]) {
17615            Ok(Action::AddSearchOptimization)
17616        } else if self.parse_keywords(&[Keyword::ATTACH, Keyword::LISTING]) {
17617            Ok(Action::AttachListing)
17618        } else if self.parse_keywords(&[Keyword::ATTACH, Keyword::POLICY]) {
17619            Ok(Action::AttachPolicy)
17620        } else if self.parse_keywords(&[Keyword::BIND, Keyword::SERVICE, Keyword::ENDPOINT]) {
17621            Ok(Action::BindServiceEndpoint)
17622        } else if self.parse_keywords(&[Keyword::DATABASE, Keyword::ROLE]) {
17623            let role = self.parse_object_name(false)?;
17624            Ok(Action::DatabaseRole { role })
17625        } else if self.parse_keywords(&[Keyword::EVOLVE, Keyword::SCHEMA]) {
17626            Ok(Action::EvolveSchema)
17627        } else if self.parse_keywords(&[Keyword::IMPORT, Keyword::SHARE]) {
17628            Ok(Action::ImportShare)
17629        } else if self.parse_keywords(&[Keyword::MANAGE, Keyword::VERSIONS]) {
17630            Ok(Action::ManageVersions)
17631        } else if self.parse_keywords(&[Keyword::MANAGE, Keyword::RELEASES]) {
17632            Ok(Action::ManageReleases)
17633        } else if self.parse_keywords(&[Keyword::OVERRIDE, Keyword::SHARE, Keyword::RESTRICTIONS]) {
17634            Ok(Action::OverrideShareRestrictions)
17635        } else if self.parse_keywords(&[
17636            Keyword::PURCHASE,
17637            Keyword::DATA,
17638            Keyword::EXCHANGE,
17639            Keyword::LISTING,
17640        ]) {
17641            Ok(Action::PurchaseDataExchangeListing)
17642        } else if self.parse_keywords(&[Keyword::RESOLVE, Keyword::ALL]) {
17643            Ok(Action::ResolveAll)
17644        } else if self.parse_keywords(&[Keyword::READ, Keyword::SESSION]) {
17645            Ok(Action::ReadSession)
17646
17647        // Single-word privileges
17648        } else if self.parse_keyword(Keyword::APPLY) {
17649            let apply_type = self.parse_action_apply_type()?;
17650            Ok(Action::Apply { apply_type })
17651        } else if self.parse_keyword(Keyword::APPLYBUDGET) {
17652            Ok(Action::ApplyBudget)
17653        } else if self.parse_keyword(Keyword::AUDIT) {
17654            Ok(Action::Audit)
17655        } else if self.parse_keyword(Keyword::CONNECT) {
17656            Ok(Action::Connect)
17657        } else if self.parse_keyword(Keyword::CREATE) {
17658            let obj_type = self.maybe_parse_action_create_object_type();
17659            Ok(Action::Create { obj_type })
17660        } else if self.parse_keyword(Keyword::DELETE) {
17661            Ok(Action::Delete)
17662        } else if self.parse_keyword(Keyword::EXEC) {
17663            let obj_type = self.maybe_parse_action_execute_obj_type();
17664            Ok(Action::Exec { obj_type })
17665        } else if self.parse_keyword(Keyword::EXECUTE) {
17666            let obj_type = self.maybe_parse_action_execute_obj_type();
17667            Ok(Action::Execute { obj_type })
17668        } else if self.parse_keyword(Keyword::FAILOVER) {
17669            Ok(Action::Failover)
17670        } else if self.parse_keyword(Keyword::INSERT) {
17671            Ok(Action::Insert {
17672                columns: parse_columns(self)?,
17673            })
17674        } else if self.parse_keyword(Keyword::MANAGE) {
17675            let manage_type = self.parse_action_manage_type()?;
17676            Ok(Action::Manage { manage_type })
17677        } else if self.parse_keyword(Keyword::MODIFY) {
17678            let modify_type = self.parse_action_modify_type();
17679            Ok(Action::Modify { modify_type })
17680        } else if self.parse_keyword(Keyword::MONITOR) {
17681            let monitor_type = self.parse_action_monitor_type();
17682            Ok(Action::Monitor { monitor_type })
17683        } else if self.parse_keyword(Keyword::OPERATE) {
17684            Ok(Action::Operate)
17685        } else if self.parse_keyword(Keyword::REFERENCES) {
17686            Ok(Action::References {
17687                columns: parse_columns(self)?,
17688            })
17689        } else if self.parse_keyword(Keyword::READ) {
17690            Ok(Action::Read)
17691        } else if self.parse_keyword(Keyword::REPLICATE) {
17692            Ok(Action::Replicate)
17693        } else if self.parse_keyword(Keyword::ROLE) {
17694            let role = self.parse_object_name(false)?;
17695            Ok(Action::Role { role })
17696        } else if self.parse_keyword(Keyword::SELECT) {
17697            Ok(Action::Select {
17698                columns: parse_columns(self)?,
17699            })
17700        } else if self.parse_keyword(Keyword::TEMPORARY) {
17701            Ok(Action::Temporary)
17702        } else if self.parse_keyword(Keyword::TRIGGER) {
17703            Ok(Action::Trigger)
17704        } else if self.parse_keyword(Keyword::TRUNCATE) {
17705            Ok(Action::Truncate)
17706        } else if self.parse_keyword(Keyword::UPDATE) {
17707            Ok(Action::Update {
17708                columns: parse_columns(self)?,
17709            })
17710        } else if self.parse_keyword(Keyword::USAGE) {
17711            Ok(Action::Usage)
17712        } else if self.parse_keyword(Keyword::OWNERSHIP) {
17713            Ok(Action::Ownership)
17714        } else if self.parse_keyword(Keyword::DROP) {
17715            Ok(Action::Drop)
17716        } else {
17717            self.expected_ref("a privilege keyword", self.peek_token_ref())?
17718        }
17719    }
17720
17721    fn maybe_parse_action_create_object_type(&mut self) -> Option<ActionCreateObjectType> {
17722        // Multi-word object types
17723        if self.parse_keywords(&[Keyword::APPLICATION, Keyword::PACKAGE]) {
17724            Some(ActionCreateObjectType::ApplicationPackage)
17725        } else if self.parse_keywords(&[Keyword::COMPUTE, Keyword::POOL]) {
17726            Some(ActionCreateObjectType::ComputePool)
17727        } else if self.parse_keywords(&[Keyword::DATA, Keyword::EXCHANGE, Keyword::LISTING]) {
17728            Some(ActionCreateObjectType::DataExchangeListing)
17729        } else if self.parse_keywords(&[Keyword::EXTERNAL, Keyword::VOLUME]) {
17730            Some(ActionCreateObjectType::ExternalVolume)
17731        } else if self.parse_keywords(&[Keyword::FAILOVER, Keyword::GROUP]) {
17732            Some(ActionCreateObjectType::FailoverGroup)
17733        } else if self.parse_keywords(&[Keyword::NETWORK, Keyword::POLICY]) {
17734            Some(ActionCreateObjectType::NetworkPolicy)
17735        } else if self.parse_keywords(&[Keyword::ORGANIZATION, Keyword::LISTING]) {
17736            Some(ActionCreateObjectType::OrganiationListing)
17737        } else if self.parse_keywords(&[Keyword::REPLICATION, Keyword::GROUP]) {
17738            Some(ActionCreateObjectType::ReplicationGroup)
17739        }
17740        // Single-word object types
17741        else if self.parse_keyword(Keyword::ACCOUNT) {
17742            Some(ActionCreateObjectType::Account)
17743        } else if self.parse_keyword(Keyword::APPLICATION) {
17744            Some(ActionCreateObjectType::Application)
17745        } else if self.parse_keyword(Keyword::DATABASE) {
17746            Some(ActionCreateObjectType::Database)
17747        } else if self.parse_keyword(Keyword::INTEGRATION) {
17748            Some(ActionCreateObjectType::Integration)
17749        } else if self.parse_keyword(Keyword::ROLE) {
17750            Some(ActionCreateObjectType::Role)
17751        } else if self.parse_keyword(Keyword::SCHEMA) {
17752            Some(ActionCreateObjectType::Schema)
17753        } else if self.parse_keyword(Keyword::SHARE) {
17754            Some(ActionCreateObjectType::Share)
17755        } else if self.parse_keyword(Keyword::USER) {
17756            Some(ActionCreateObjectType::User)
17757        } else if self.parse_keyword(Keyword::WAREHOUSE) {
17758            Some(ActionCreateObjectType::Warehouse)
17759        } else {
17760            None
17761        }
17762    }
17763
17764    fn parse_action_apply_type(&mut self) -> Result<ActionApplyType, ParserError> {
17765        if self.parse_keywords(&[Keyword::AGGREGATION, Keyword::POLICY]) {
17766            Ok(ActionApplyType::AggregationPolicy)
17767        } else if self.parse_keywords(&[Keyword::AUTHENTICATION, Keyword::POLICY]) {
17768            Ok(ActionApplyType::AuthenticationPolicy)
17769        } else if self.parse_keywords(&[Keyword::JOIN, Keyword::POLICY]) {
17770            Ok(ActionApplyType::JoinPolicy)
17771        } else if self.parse_keywords(&[Keyword::MASKING, Keyword::POLICY]) {
17772            Ok(ActionApplyType::MaskingPolicy)
17773        } else if self.parse_keywords(&[Keyword::PACKAGES, Keyword::POLICY]) {
17774            Ok(ActionApplyType::PackagesPolicy)
17775        } else if self.parse_keywords(&[Keyword::PASSWORD, Keyword::POLICY]) {
17776            Ok(ActionApplyType::PasswordPolicy)
17777        } else if self.parse_keywords(&[Keyword::PROJECTION, Keyword::POLICY]) {
17778            Ok(ActionApplyType::ProjectionPolicy)
17779        } else if self.parse_keywords(&[Keyword::ROW, Keyword::ACCESS, Keyword::POLICY]) {
17780            Ok(ActionApplyType::RowAccessPolicy)
17781        } else if self.parse_keywords(&[Keyword::SESSION, Keyword::POLICY]) {
17782            Ok(ActionApplyType::SessionPolicy)
17783        } else if self.parse_keyword(Keyword::TAG) {
17784            Ok(ActionApplyType::Tag)
17785        } else {
17786            self.expected_ref("GRANT APPLY type", self.peek_token_ref())
17787        }
17788    }
17789
17790    fn maybe_parse_action_execute_obj_type(&mut self) -> Option<ActionExecuteObjectType> {
17791        if self.parse_keywords(&[Keyword::DATA, Keyword::METRIC, Keyword::FUNCTION]) {
17792            Some(ActionExecuteObjectType::DataMetricFunction)
17793        } else if self.parse_keywords(&[Keyword::MANAGED, Keyword::ALERT]) {
17794            Some(ActionExecuteObjectType::ManagedAlert)
17795        } else if self.parse_keywords(&[Keyword::MANAGED, Keyword::TASK]) {
17796            Some(ActionExecuteObjectType::ManagedTask)
17797        } else if self.parse_keyword(Keyword::ALERT) {
17798            Some(ActionExecuteObjectType::Alert)
17799        } else if self.parse_keyword(Keyword::TASK) {
17800            Some(ActionExecuteObjectType::Task)
17801        } else {
17802            None
17803        }
17804    }
17805
17806    fn parse_action_manage_type(&mut self) -> Result<ActionManageType, ParserError> {
17807        if self.parse_keywords(&[Keyword::ACCOUNT, Keyword::SUPPORT, Keyword::CASES]) {
17808            Ok(ActionManageType::AccountSupportCases)
17809        } else if self.parse_keywords(&[Keyword::EVENT, Keyword::SHARING]) {
17810            Ok(ActionManageType::EventSharing)
17811        } else if self.parse_keywords(&[Keyword::LISTING, Keyword::AUTO, Keyword::FULFILLMENT]) {
17812            Ok(ActionManageType::ListingAutoFulfillment)
17813        } else if self.parse_keywords(&[Keyword::ORGANIZATION, Keyword::SUPPORT, Keyword::CASES]) {
17814            Ok(ActionManageType::OrganizationSupportCases)
17815        } else if self.parse_keywords(&[Keyword::USER, Keyword::SUPPORT, Keyword::CASES]) {
17816            Ok(ActionManageType::UserSupportCases)
17817        } else if self.parse_keyword(Keyword::GRANTS) {
17818            Ok(ActionManageType::Grants)
17819        } else if self.parse_keyword(Keyword::WAREHOUSES) {
17820            Ok(ActionManageType::Warehouses)
17821        } else {
17822            self.expected_ref("GRANT MANAGE type", self.peek_token_ref())
17823        }
17824    }
17825
17826    fn parse_action_modify_type(&mut self) -> Option<ActionModifyType> {
17827        if self.parse_keywords(&[Keyword::LOG, Keyword::LEVEL]) {
17828            Some(ActionModifyType::LogLevel)
17829        } else if self.parse_keywords(&[Keyword::TRACE, Keyword::LEVEL]) {
17830            Some(ActionModifyType::TraceLevel)
17831        } else if self.parse_keywords(&[Keyword::SESSION, Keyword::LOG, Keyword::LEVEL]) {
17832            Some(ActionModifyType::SessionLogLevel)
17833        } else if self.parse_keywords(&[Keyword::SESSION, Keyword::TRACE, Keyword::LEVEL]) {
17834            Some(ActionModifyType::SessionTraceLevel)
17835        } else {
17836            None
17837        }
17838    }
17839
17840    fn parse_action_monitor_type(&mut self) -> Option<ActionMonitorType> {
17841        if self.parse_keyword(Keyword::EXECUTION) {
17842            Some(ActionMonitorType::Execution)
17843        } else if self.parse_keyword(Keyword::SECURITY) {
17844            Some(ActionMonitorType::Security)
17845        } else if self.parse_keyword(Keyword::USAGE) {
17846            Some(ActionMonitorType::Usage)
17847        } else {
17848            None
17849        }
17850    }
17851
17852    /// Parse a grantee name, possibly with a host qualifier (user@host).
17853    pub fn parse_grantee_name(&mut self) -> Result<GranteeName, ParserError> {
17854        let mut name = self.parse_object_name(false)?;
17855        if self.dialect.supports_user_host_grantee()
17856            && name.0.len() == 1
17857            && name.0[0].as_ident().is_some()
17858            && self.consume_token(&Token::AtSign)
17859        {
17860            let user = name.0.pop().unwrap().as_ident().unwrap().clone();
17861            let host = self.parse_identifier()?;
17862            Ok(GranteeName::UserHost { user, host })
17863        } else {
17864            Ok(GranteeName::ObjectName(name))
17865        }
17866    }
17867
17868    /// Parse [`Statement::Deny`]
17869    pub fn parse_deny(&mut self) -> Result<Statement, ParserError> {
17870        self.expect_keyword(Keyword::DENY)?;
17871
17872        let (privileges, objects) = self.parse_grant_deny_revoke_privileges_objects()?;
17873        let objects = match objects {
17874            Some(o) => o,
17875            None => {
17876                return parser_err!(
17877                    "DENY statements must specify an object",
17878                    self.peek_token_ref().span.start
17879                )
17880            }
17881        };
17882
17883        self.expect_keyword_is(Keyword::TO)?;
17884        let grantees = self.parse_grantees()?;
17885        let cascade = self.parse_cascade_option();
17886        let granted_by = if self.parse_keywords(&[Keyword::AS]) {
17887            Some(self.parse_identifier()?)
17888        } else {
17889            None
17890        };
17891
17892        Ok(Statement::Deny(DenyStatement {
17893            privileges,
17894            objects,
17895            grantees,
17896            cascade,
17897            granted_by,
17898        }))
17899    }
17900
17901    /// Parse a REVOKE statement
17902    pub fn parse_revoke(&mut self) -> Result<Revoke, ParserError> {
17903        let (privileges, objects) = self.parse_grant_deny_revoke_privileges_objects()?;
17904
17905        self.expect_keyword_is(Keyword::FROM)?;
17906        let grantees = self.parse_grantees()?;
17907
17908        let granted_by = if self.parse_keywords(&[Keyword::GRANTED, Keyword::BY]) {
17909            Some(self.parse_identifier()?)
17910        } else {
17911            None
17912        };
17913
17914        let cascade = self.parse_cascade_option();
17915
17916        Ok(Revoke {
17917            privileges,
17918            objects,
17919            grantees,
17920            granted_by,
17921            cascade,
17922        })
17923    }
17924
17925    /// Parse an REPLACE statement
17926    pub fn parse_replace(
17927        &mut self,
17928        replace_token: TokenWithSpan,
17929    ) -> Result<Statement, ParserError> {
17930        if !dialect_of!(self is MySqlDialect | GenericDialect) {
17931            return parser_err!(
17932                "Unsupported statement REPLACE",
17933                self.peek_token_ref().span.start
17934            );
17935        }
17936
17937        let mut insert = self.parse_insert(replace_token)?;
17938        if let Statement::Insert(Insert { replace_into, .. }) = &mut insert {
17939            *replace_into = true;
17940        }
17941
17942        Ok(insert)
17943    }
17944
17945    /// Parse an INSERT statement, returning a `Box`ed SetExpr
17946    ///
17947    /// This is used to reduce the size of the stack frames in debug builds
17948    fn parse_insert_setexpr_boxed(
17949        &mut self,
17950        insert_token: TokenWithSpan,
17951    ) -> Result<Box<SetExpr>, ParserError> {
17952        Ok(Box::new(SetExpr::Insert(self.parse_insert(insert_token)?)))
17953    }
17954
17955    /// Parse an INSERT statement
17956    pub fn parse_insert(&mut self, insert_token: TokenWithSpan) -> Result<Statement, ParserError> {
17957        let optimizer_hints = self.maybe_parse_optimizer_hints()?;
17958        let or = self.parse_conflict_clause();
17959        let priority = if !dialect_of!(self is MySqlDialect | GenericDialect) {
17960            None
17961        } else if self.parse_keyword(Keyword::LOW_PRIORITY) {
17962            Some(MysqlInsertPriority::LowPriority)
17963        } else if self.parse_keyword(Keyword::DELAYED) {
17964            Some(MysqlInsertPriority::Delayed)
17965        } else if self.parse_keyword(Keyword::HIGH_PRIORITY) {
17966            Some(MysqlInsertPriority::HighPriority)
17967        } else {
17968            None
17969        };
17970
17971        let ignore = dialect_of!(self is MySqlDialect | GenericDialect)
17972            && self.parse_keyword(Keyword::IGNORE);
17973
17974        let replace_into = false;
17975
17976        let overwrite = self.parse_keyword(Keyword::OVERWRITE);
17977        let into = self.parse_keyword(Keyword::INTO);
17978
17979        let local = self.parse_keyword(Keyword::LOCAL);
17980
17981        if self.parse_keyword(Keyword::DIRECTORY) {
17982            let path = self.parse_literal_string()?;
17983            let file_format = if self.parse_keywords(&[Keyword::STORED, Keyword::AS]) {
17984                Some(self.parse_file_format()?)
17985            } else {
17986                None
17987            };
17988            let source = self.parse_query()?;
17989            Ok(Statement::Directory {
17990                local,
17991                path,
17992                overwrite,
17993                file_format,
17994                source,
17995            })
17996        } else {
17997            // Hive lets you put table here regardless
17998            let table = self.parse_keyword(Keyword::TABLE);
17999            let table_object = self.parse_table_object()?;
18000
18001            let table_alias = if self.dialect.supports_insert_table_alias()
18002                && !self.peek_sub_query()
18003                && self
18004                    .peek_one_of_keywords(&[Keyword::DEFAULT, Keyword::VALUES])
18005                    .is_none()
18006            {
18007                if self.parse_keyword(Keyword::AS) {
18008                    Some(TableAliasWithoutColumns {
18009                        explicit: true,
18010                        alias: self.parse_identifier()?,
18011                    })
18012                } else {
18013                    self.maybe_parse(|parser| parser.parse_identifier())?
18014                        .map(|alias| TableAliasWithoutColumns {
18015                            explicit: false,
18016                            alias,
18017                        })
18018                }
18019            } else {
18020                None
18021            };
18022
18023            let is_mysql = dialect_of!(self is MySqlDialect);
18024
18025            let (columns, partitioned, after_columns, output, source, assignments) = if self
18026                .parse_keywords(&[Keyword::DEFAULT, Keyword::VALUES])
18027            {
18028                (vec![], None, vec![], None, None, vec![])
18029            } else {
18030                let (columns, partitioned, after_columns) = if !self.peek_subquery_start() {
18031                    let columns =
18032                        self.parse_parenthesized_qualified_column_list(Optional, is_mysql)?;
18033
18034                    let partitioned = self.parse_insert_partition()?;
18035                    // Hive allows you to specify columns after partitions as well if you want.
18036                    let after_columns = if dialect_of!(self is HiveDialect) {
18037                        self.parse_parenthesized_column_list(Optional, false)?
18038                    } else {
18039                        vec![]
18040                    };
18041                    (columns, partitioned, after_columns)
18042                } else {
18043                    Default::default()
18044                };
18045
18046                let output = self.maybe_parse_output_clause()?;
18047
18048                let (source, assignments) = if self.peek_keyword(Keyword::FORMAT)
18049                    || self.peek_keyword(Keyword::SETTINGS)
18050                {
18051                    (None, vec![])
18052                } else if self.dialect.supports_insert_set() && self.parse_keyword(Keyword::SET) {
18053                    (None, self.parse_comma_separated(Parser::parse_assignment)?)
18054                } else {
18055                    (Some(self.parse_query()?), vec![])
18056                };
18057
18058                (
18059                    columns,
18060                    partitioned,
18061                    after_columns,
18062                    output,
18063                    source,
18064                    assignments,
18065                )
18066            };
18067
18068            let (format_clause, settings) = if self.dialect.supports_insert_format() {
18069                // Settings always comes before `FORMAT` for ClickHouse:
18070                // <https://clickhouse.com/docs/en/sql-reference/statements/insert-into>
18071                let settings = self.parse_settings()?;
18072
18073                let format = if self.parse_keyword(Keyword::FORMAT) {
18074                    Some(self.parse_input_format_clause()?)
18075                } else {
18076                    None
18077                };
18078
18079                (format, settings)
18080            } else {
18081                Default::default()
18082            };
18083
18084            let insert_alias = if dialect_of!(self is MySqlDialect | GenericDialect)
18085                && self.parse_keyword(Keyword::AS)
18086            {
18087                let row_alias = self.parse_object_name(false)?;
18088                let col_aliases = Some(self.parse_parenthesized_column_list(Optional, false)?);
18089                Some(InsertAliases {
18090                    row_alias,
18091                    col_aliases,
18092                })
18093            } else {
18094                None
18095            };
18096
18097            let on = if self.parse_keyword(Keyword::ON) {
18098                if self.parse_keyword(Keyword::CONFLICT) {
18099                    let conflict_target =
18100                        if self.parse_keywords(&[Keyword::ON, Keyword::CONSTRAINT]) {
18101                            Some(ConflictTarget::OnConstraint(self.parse_object_name(false)?))
18102                        } else if self.peek_token_ref().token == Token::LParen {
18103                            Some(ConflictTarget::Columns(
18104                                self.parse_parenthesized_column_list(IsOptional::Mandatory, false)?,
18105                            ))
18106                        } else {
18107                            None
18108                        };
18109
18110                    self.expect_keyword_is(Keyword::DO)?;
18111                    let action = if self.parse_keyword(Keyword::NOTHING) {
18112                        OnConflictAction::DoNothing
18113                    } else {
18114                        self.expect_keyword_is(Keyword::UPDATE)?;
18115                        self.expect_keyword_is(Keyword::SET)?;
18116                        let assignments = self.parse_comma_separated(Parser::parse_assignment)?;
18117                        let selection = if self.parse_keyword(Keyword::WHERE) {
18118                            Some(self.parse_expr()?)
18119                        } else {
18120                            None
18121                        };
18122                        OnConflictAction::DoUpdate(DoUpdate {
18123                            assignments,
18124                            selection,
18125                        })
18126                    };
18127
18128                    Some(OnInsert::OnConflict(OnConflict {
18129                        conflict_target,
18130                        action,
18131                    }))
18132                } else {
18133                    self.expect_keyword_is(Keyword::DUPLICATE)?;
18134                    self.expect_keyword_is(Keyword::KEY)?;
18135                    self.expect_keyword_is(Keyword::UPDATE)?;
18136                    let l = self.parse_comma_separated(Parser::parse_assignment)?;
18137
18138                    Some(OnInsert::DuplicateKeyUpdate(l))
18139                }
18140            } else {
18141                None
18142            };
18143
18144            let returning = if self.parse_keyword(Keyword::RETURNING) {
18145                Some(self.parse_comma_separated(Parser::parse_select_item)?)
18146            } else {
18147                None
18148            };
18149
18150            Ok(Insert {
18151                insert_token: insert_token.into(),
18152                optimizer_hints,
18153                or,
18154                table: table_object,
18155                table_alias,
18156                ignore,
18157                into,
18158                overwrite,
18159                partitioned,
18160                columns,
18161                after_columns,
18162                source,
18163                assignments,
18164                has_table_keyword: table,
18165                on,
18166                returning,
18167                output,
18168                replace_into,
18169                priority,
18170                insert_alias,
18171                settings,
18172                format_clause,
18173                multi_table_insert_type: None,
18174                multi_table_into_clauses: vec![],
18175                multi_table_when_clauses: vec![],
18176                multi_table_else_clause: None,
18177            }
18178            .into())
18179        }
18180    }
18181
18182    /// Parses input format clause used for ClickHouse.
18183    ///
18184    /// <https://clickhouse.com/docs/en/interfaces/formats>
18185    pub fn parse_input_format_clause(&mut self) -> Result<InputFormatClause, ParserError> {
18186        let ident = self.parse_identifier()?;
18187        let values = self
18188            .maybe_parse(|p| p.parse_comma_separated(|p| p.parse_expr()))?
18189            .unwrap_or_default();
18190
18191        Ok(InputFormatClause { ident, values })
18192    }
18193
18194    /// Returns true if the immediate tokens look like the
18195    /// beginning of a subquery. `(SELECT ...`
18196    fn peek_subquery_start(&mut self) -> bool {
18197        matches!(
18198            self.peek_tokens_ref(),
18199            [
18200                TokenWithSpan {
18201                    token: Token::LParen,
18202                    ..
18203                },
18204                TokenWithSpan {
18205                    token: Token::Word(Word {
18206                        keyword: Keyword::SELECT,
18207                        ..
18208                    }),
18209                    ..
18210                },
18211            ]
18212        )
18213    }
18214
18215    /// Returns true if the immediate tokens look like the
18216    /// beginning of a subquery possibly preceded by CTEs;
18217    /// i.e. `(WITH ...` or `(SELECT ...`.
18218    fn peek_subquery_or_cte_start(&mut self) -> bool {
18219        matches!(
18220            self.peek_tokens_ref(),
18221            [
18222                TokenWithSpan {
18223                    token: Token::LParen,
18224                    ..
18225                },
18226                TokenWithSpan {
18227                    token: Token::Word(Word {
18228                        keyword: Keyword::SELECT | Keyword::WITH,
18229                        ..
18230                    }),
18231                    ..
18232                },
18233            ]
18234        )
18235    }
18236
18237    fn parse_conflict_clause(&mut self) -> Option<SqliteOnConflict> {
18238        if self.parse_keywords(&[Keyword::OR, Keyword::REPLACE]) {
18239            Some(SqliteOnConflict::Replace)
18240        } else if self.parse_keywords(&[Keyword::OR, Keyword::ROLLBACK]) {
18241            Some(SqliteOnConflict::Rollback)
18242        } else if self.parse_keywords(&[Keyword::OR, Keyword::ABORT]) {
18243            Some(SqliteOnConflict::Abort)
18244        } else if self.parse_keywords(&[Keyword::OR, Keyword::FAIL]) {
18245            Some(SqliteOnConflict::Fail)
18246        } else if self.parse_keywords(&[Keyword::OR, Keyword::IGNORE]) {
18247            Some(SqliteOnConflict::Ignore)
18248        } else if self.parse_keyword(Keyword::REPLACE) {
18249            Some(SqliteOnConflict::Replace)
18250        } else {
18251            None
18252        }
18253    }
18254
18255    /// Parse an optional `PARTITION (...)` clause for INSERT statements.
18256    pub fn parse_insert_partition(&mut self) -> Result<Option<Vec<Expr>>, ParserError> {
18257        if self.parse_keyword(Keyword::PARTITION) {
18258            self.expect_token(&Token::LParen)?;
18259            let partition_cols = Some(self.parse_comma_separated(Parser::parse_expr)?);
18260            self.expect_token(&Token::RParen)?;
18261            Ok(partition_cols)
18262        } else {
18263            Ok(None)
18264        }
18265    }
18266
18267    /// Parse optional Hive `INPUTFORMAT ... SERDE ...` clause used by LOAD DATA.
18268    pub fn parse_load_data_table_format(
18269        &mut self,
18270    ) -> Result<Option<HiveLoadDataFormat>, ParserError> {
18271        if self.parse_keyword(Keyword::INPUTFORMAT) {
18272            let input_format = self.parse_expr()?;
18273            self.expect_keyword_is(Keyword::SERDE)?;
18274            let serde = self.parse_expr()?;
18275            Ok(Some(HiveLoadDataFormat {
18276                input_format,
18277                serde,
18278            }))
18279        } else {
18280            Ok(None)
18281        }
18282    }
18283
18284    /// Parse an UPDATE statement, returning a `Box`ed SetExpr
18285    ///
18286    /// This is used to reduce the size of the stack frames in debug builds
18287    fn parse_update_setexpr_boxed(
18288        &mut self,
18289        update_token: TokenWithSpan,
18290    ) -> Result<Box<SetExpr>, ParserError> {
18291        Ok(Box::new(SetExpr::Update(self.parse_update(update_token)?)))
18292    }
18293
18294    /// Parse an `UPDATE` statement and return `Statement::Update`.
18295    pub fn parse_update(&mut self, update_token: TokenWithSpan) -> Result<Statement, ParserError> {
18296        let optimizer_hints = self.maybe_parse_optimizer_hints()?;
18297        let or = self.parse_conflict_clause();
18298        let table = self.parse_table_and_joins()?;
18299        let from_before_set = if self.parse_keyword(Keyword::FROM) {
18300            Some(UpdateTableFromKind::BeforeSet(
18301                self.parse_table_with_joins()?,
18302            ))
18303        } else {
18304            None
18305        };
18306        self.expect_keyword(Keyword::SET)?;
18307        let assignments = self.parse_comma_separated(Parser::parse_assignment)?;
18308
18309        let output = self.maybe_parse_output_clause()?;
18310
18311        let from = if from_before_set.is_none() && self.parse_keyword(Keyword::FROM) {
18312            Some(UpdateTableFromKind::AfterSet(
18313                self.parse_table_with_joins()?,
18314            ))
18315        } else {
18316            from_before_set
18317        };
18318        let selection = if self.parse_keyword(Keyword::WHERE) {
18319            Some(self.parse_expr()?)
18320        } else {
18321            None
18322        };
18323        let returning = if self.parse_keyword(Keyword::RETURNING) {
18324            Some(self.parse_comma_separated(Parser::parse_select_item)?)
18325        } else {
18326            None
18327        };
18328        let order_by = if self.dialect.supports_update_order_by()
18329            && self.parse_keywords(&[Keyword::ORDER, Keyword::BY])
18330        {
18331            self.parse_comma_separated(Parser::parse_order_by_expr)?
18332        } else {
18333            vec![]
18334        };
18335        let limit = if self.parse_keyword(Keyword::LIMIT) {
18336            Some(self.parse_expr()?)
18337        } else {
18338            None
18339        };
18340        Ok(Update {
18341            update_token: update_token.into(),
18342            optimizer_hints,
18343            table,
18344            assignments,
18345            from,
18346            selection,
18347            returning,
18348            output,
18349            or,
18350            order_by,
18351            limit,
18352        }
18353        .into())
18354    }
18355
18356    /// Parse a `var = expr` assignment, used in an UPDATE statement
18357    pub fn parse_assignment(&mut self) -> Result<Assignment, ParserError> {
18358        let target = self.parse_assignment_target()?;
18359        self.expect_token(&Token::Eq)?;
18360        let value = self.parse_expr()?;
18361        Ok(Assignment { target, value })
18362    }
18363
18364    /// Parse the left-hand side of an assignment, used in an UPDATE statement
18365    pub fn parse_assignment_target(&mut self) -> Result<AssignmentTarget, ParserError> {
18366        if self.consume_token(&Token::LParen) {
18367            let columns = self.parse_comma_separated(|p| p.parse_object_name(false))?;
18368            self.expect_token(&Token::RParen)?;
18369            Ok(AssignmentTarget::Tuple(columns))
18370        } else {
18371            let column = self.parse_object_name(false)?;
18372            Ok(AssignmentTarget::ColumnName(column))
18373        }
18374    }
18375
18376    /// Parse a single function argument, handling named and unnamed variants.
18377    pub fn parse_function_args(&mut self) -> Result<FunctionArg, ParserError> {
18378        let arg = if self.dialect.supports_named_fn_args_with_expr_name() {
18379            self.maybe_parse(|p| {
18380                let name = p.parse_expr()?;
18381                let operator = p.parse_function_named_arg_operator()?;
18382                let arg = p.parse_wildcard_expr()?.into();
18383                Ok(FunctionArg::ExprNamed {
18384                    name,
18385                    arg,
18386                    operator,
18387                })
18388            })?
18389        } else {
18390            self.maybe_parse(|p| {
18391                let name = p.parse_identifier()?;
18392                let operator = p.parse_function_named_arg_operator()?;
18393                let arg = p.parse_wildcard_expr()?.into();
18394                Ok(FunctionArg::Named {
18395                    name,
18396                    arg,
18397                    operator,
18398                })
18399            })?
18400        };
18401        if let Some(arg) = arg {
18402            return Ok(arg);
18403        }
18404        let wildcard_expr = self.parse_wildcard_expr()?;
18405        let arg_expr: FunctionArgExpr = match wildcard_expr {
18406            Expr::Wildcard(ref token) if self.dialect.supports_select_wildcard_exclude() => {
18407                // Support `* EXCLUDE(col1, col2, ...)` inside function calls (e.g. Snowflake's
18408                // `HASH(* EXCLUDE(col))`).  Parse the options the same way SELECT items do.
18409                let opts = self.parse_wildcard_additional_options(token.0.clone())?;
18410                if opts.opt_exclude.is_some()
18411                    || opts.opt_except.is_some()
18412                    || opts.opt_replace.is_some()
18413                    || opts.opt_rename.is_some()
18414                    || opts.opt_ilike.is_some()
18415                {
18416                    FunctionArgExpr::WildcardWithOptions(opts)
18417                } else {
18418                    wildcard_expr.into()
18419                }
18420            }
18421            other => other.into(),
18422        };
18423        Ok(FunctionArg::Unnamed(arg_expr))
18424    }
18425
18426    fn parse_function_named_arg_operator(&mut self) -> Result<FunctionArgOperator, ParserError> {
18427        if self.parse_keyword(Keyword::VALUE) {
18428            return Ok(FunctionArgOperator::Value);
18429        }
18430        let tok = self.next_token();
18431        match tok.token {
18432            Token::RArrow if self.dialect.supports_named_fn_args_with_rarrow_operator() => {
18433                Ok(FunctionArgOperator::RightArrow)
18434            }
18435            Token::Eq if self.dialect.supports_named_fn_args_with_eq_operator() => {
18436                Ok(FunctionArgOperator::Equals)
18437            }
18438            Token::Assignment
18439                if self
18440                    .dialect
18441                    .supports_named_fn_args_with_assignment_operator() =>
18442            {
18443                Ok(FunctionArgOperator::Assignment)
18444            }
18445            Token::Colon if self.dialect.supports_named_fn_args_with_colon_operator() => {
18446                Ok(FunctionArgOperator::Colon)
18447            }
18448            _ => {
18449                self.prev_token();
18450                self.expected("argument operator", tok)
18451            }
18452        }
18453    }
18454
18455    /// Parse an optional, comma-separated list of function arguments (consumes closing paren).
18456    pub fn parse_optional_args(&mut self) -> Result<Vec<FunctionArg>, ParserError> {
18457        if self.consume_token(&Token::RParen) {
18458            Ok(vec![])
18459        } else {
18460            let args = self.parse_comma_separated(Parser::parse_function_args)?;
18461            self.expect_token(&Token::RParen)?;
18462            Ok(args)
18463        }
18464    }
18465
18466    fn parse_table_function_args(&mut self) -> Result<TableFunctionArgs, ParserError> {
18467        if self.consume_token(&Token::RParen) {
18468            return Ok(TableFunctionArgs {
18469                args: vec![],
18470                settings: None,
18471            });
18472        }
18473        let mut args = vec![];
18474        let settings = loop {
18475            if let Some(settings) = self.parse_settings()? {
18476                break Some(settings);
18477            }
18478            args.push(self.parse_function_args()?);
18479            if self.is_parse_comma_separated_end() {
18480                break None;
18481            }
18482        };
18483        self.expect_token(&Token::RParen)?;
18484        Ok(TableFunctionArgs { args, settings })
18485    }
18486
18487    /// Parses a potentially empty list of arguments to a function
18488    /// (including the closing parenthesis).
18489    ///
18490    /// Examples:
18491    /// ```sql
18492    /// FIRST_VALUE(x ORDER BY 1,2,3);
18493    /// FIRST_VALUE(x IGNORE NULL);
18494    /// ```
18495    fn parse_function_argument_list(&mut self) -> Result<FunctionArgumentList, ParserError> {
18496        let mut clauses = vec![];
18497
18498        // Handle clauses that may exist with an empty argument list
18499
18500        if let Some(null_clause) = self.parse_json_null_clause() {
18501            clauses.push(FunctionArgumentClause::JsonNullClause(null_clause));
18502        }
18503
18504        if let Some(json_returning_clause) = self.maybe_parse_json_returning_clause()? {
18505            clauses.push(FunctionArgumentClause::JsonReturningClause(
18506                json_returning_clause,
18507            ));
18508        }
18509
18510        if self.consume_token(&Token::RParen) {
18511            return Ok(FunctionArgumentList {
18512                duplicate_treatment: None,
18513                args: vec![],
18514                clauses,
18515            });
18516        }
18517
18518        let duplicate_treatment = self.parse_duplicate_treatment()?;
18519        let args = self.parse_comma_separated(Parser::parse_function_args)?;
18520
18521        if self.dialect.supports_window_function_null_treatment_arg() {
18522            if let Some(null_treatment) = self.parse_null_treatment()? {
18523                clauses.push(FunctionArgumentClause::IgnoreOrRespectNulls(null_treatment));
18524            }
18525        }
18526
18527        if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
18528            clauses.push(FunctionArgumentClause::OrderBy(
18529                self.parse_comma_separated(Parser::parse_order_by_expr)?,
18530            ));
18531        }
18532
18533        if self.parse_keyword(Keyword::LIMIT) {
18534            clauses.push(FunctionArgumentClause::Limit(self.parse_expr()?));
18535        }
18536
18537        if dialect_of!(self is GenericDialect | BigQueryDialect)
18538            && self.parse_keyword(Keyword::HAVING)
18539        {
18540            let kind = match self.expect_one_of_keywords(&[Keyword::MIN, Keyword::MAX])? {
18541                Keyword::MIN => HavingBoundKind::Min,
18542                Keyword::MAX => HavingBoundKind::Max,
18543                unexpected_keyword => return Err(ParserError::ParserError(
18544                    format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in having bound"),
18545                )),
18546            };
18547            clauses.push(FunctionArgumentClause::Having(HavingBound(
18548                kind,
18549                self.parse_expr()?,
18550            )))
18551        }
18552
18553        if dialect_of!(self is GenericDialect | MySqlDialect)
18554            && self.parse_keyword(Keyword::SEPARATOR)
18555        {
18556            clauses.push(FunctionArgumentClause::Separator(self.parse_value()?));
18557        }
18558
18559        if let Some(on_overflow) = self.parse_listagg_on_overflow()? {
18560            clauses.push(FunctionArgumentClause::OnOverflow(on_overflow));
18561        }
18562
18563        if let Some(null_clause) = self.parse_json_null_clause() {
18564            clauses.push(FunctionArgumentClause::JsonNullClause(null_clause));
18565        }
18566
18567        if let Some(json_returning_clause) = self.maybe_parse_json_returning_clause()? {
18568            clauses.push(FunctionArgumentClause::JsonReturningClause(
18569                json_returning_clause,
18570            ));
18571        }
18572
18573        self.expect_token(&Token::RParen)?;
18574        Ok(FunctionArgumentList {
18575            duplicate_treatment,
18576            args,
18577            clauses,
18578        })
18579    }
18580
18581    fn parse_json_null_clause(&mut self) -> Option<JsonNullClause> {
18582        if self.parse_keywords(&[Keyword::ABSENT, Keyword::ON, Keyword::NULL]) {
18583            Some(JsonNullClause::AbsentOnNull)
18584        } else if self.parse_keywords(&[Keyword::NULL, Keyword::ON, Keyword::NULL]) {
18585            Some(JsonNullClause::NullOnNull)
18586        } else {
18587            None
18588        }
18589    }
18590
18591    fn maybe_parse_json_returning_clause(
18592        &mut self,
18593    ) -> Result<Option<JsonReturningClause>, ParserError> {
18594        if self.parse_keyword(Keyword::RETURNING) {
18595            let data_type = self.parse_data_type()?;
18596            Ok(Some(JsonReturningClause { data_type }))
18597        } else {
18598            Ok(None)
18599        }
18600    }
18601
18602    fn parse_duplicate_treatment(&mut self) -> Result<Option<DuplicateTreatment>, ParserError> {
18603        let loc = self.peek_token_ref().span.start;
18604        match (
18605            self.parse_keyword(Keyword::ALL),
18606            self.parse_keyword(Keyword::DISTINCT),
18607        ) {
18608            (true, false) => Ok(Some(DuplicateTreatment::All)),
18609            (false, true) => Ok(Some(DuplicateTreatment::Distinct)),
18610            (false, false) => Ok(None),
18611            (true, true) => parser_err!("Cannot specify both ALL and DISTINCT".to_string(), loc),
18612        }
18613    }
18614
18615    /// Parse a comma-delimited list of projections after SELECT
18616    pub fn parse_select_item(&mut self) -> Result<SelectItem, ParserError> {
18617        let prefix = self
18618            .parse_one_of_keywords(
18619                self.dialect
18620                    .get_reserved_keywords_for_select_item_operator(),
18621            )
18622            .map(|keyword| Ident::new(format!("{keyword:?}")));
18623
18624        match self.parse_wildcard_expr()? {
18625            Expr::QualifiedWildcard(prefix, token) => Ok(SelectItem::QualifiedWildcard(
18626                SelectItemQualifiedWildcardKind::ObjectName(prefix),
18627                self.parse_wildcard_additional_options(token.0)?,
18628            )),
18629            Expr::Wildcard(token) => Ok(SelectItem::Wildcard(
18630                self.parse_wildcard_additional_options(token.0)?,
18631            )),
18632            Expr::Identifier(v) if v.value.to_lowercase() == "from" && v.quote_style.is_none() => {
18633                parser_err!(
18634                    format!("Expected an expression, found: {}", v),
18635                    self.peek_token_ref().span.start
18636                )
18637            }
18638            Expr::BinaryOp {
18639                left,
18640                op: BinaryOperator::Eq,
18641                right,
18642            } if self.dialect.supports_eq_alias_assignment()
18643                && matches!(left.as_ref(), Expr::Identifier(_)) =>
18644            {
18645                let Expr::Identifier(alias) = *left else {
18646                    return parser_err!(
18647                        "BUG: expected identifier expression as alias",
18648                        self.peek_token_ref().span.start
18649                    );
18650                };
18651                Ok(SelectItem::ExprWithAlias {
18652                    expr: *right,
18653                    alias,
18654                })
18655            }
18656            expr if self.dialect.supports_select_expr_star()
18657                && self.consume_tokens(&[Token::Period, Token::Mul]) =>
18658            {
18659                let wildcard_token = self.get_previous_token().clone();
18660                Ok(SelectItem::QualifiedWildcard(
18661                    SelectItemQualifiedWildcardKind::Expr(expr),
18662                    self.parse_wildcard_additional_options(wildcard_token)?,
18663                ))
18664            }
18665            expr if self.dialect.supports_select_item_multi_column_alias()
18666                && self.peek_keyword(Keyword::AS)
18667                && self.peek_nth_token(1).token == Token::LParen =>
18668            {
18669                self.expect_keyword(Keyword::AS)?;
18670                self.expect_token(&Token::LParen)?;
18671                let aliases = self.parse_comma_separated(|p| p.parse_identifier())?;
18672                self.expect_token(&Token::RParen)?;
18673                Ok(SelectItem::ExprWithAliases {
18674                    expr: maybe_prefixed_expr(expr, prefix),
18675                    aliases,
18676                })
18677            }
18678            expr => self
18679                .maybe_parse_select_item_alias()
18680                .map(|alias| match alias {
18681                    Some(alias) => SelectItem::ExprWithAlias {
18682                        expr: maybe_prefixed_expr(expr, prefix),
18683                        alias,
18684                    },
18685                    None => SelectItem::UnnamedExpr(maybe_prefixed_expr(expr, prefix)),
18686                }),
18687        }
18688    }
18689
18690    /// Parse an [`WildcardAdditionalOptions`] information for wildcard select items.
18691    ///
18692    /// If it is not possible to parse it, will return an option.
18693    pub fn parse_wildcard_additional_options(
18694        &mut self,
18695        wildcard_token: TokenWithSpan,
18696    ) -> Result<WildcardAdditionalOptions, ParserError> {
18697        let opt_ilike = if self.dialect.supports_select_wildcard_ilike() {
18698            self.parse_optional_select_item_ilike()?
18699        } else {
18700            None
18701        };
18702        let opt_exclude = if opt_ilike.is_none() && self.dialect.supports_select_wildcard_exclude()
18703        {
18704            self.parse_optional_select_item_exclude()?
18705        } else {
18706            None
18707        };
18708        let opt_except = if self.dialect.supports_select_wildcard_except() {
18709            self.parse_optional_select_item_except()?
18710        } else {
18711            None
18712        };
18713        let opt_replace = if self.dialect.supports_select_wildcard_replace() {
18714            self.parse_optional_select_item_replace()?
18715        } else {
18716            None
18717        };
18718        let opt_rename = if self.dialect.supports_select_wildcard_rename() {
18719            self.parse_optional_select_item_rename()?
18720        } else {
18721            None
18722        };
18723
18724        let opt_alias = if self.dialect.supports_select_wildcard_with_alias() {
18725            self.maybe_parse_select_item_alias()?
18726        } else {
18727            None
18728        };
18729
18730        Ok(WildcardAdditionalOptions {
18731            wildcard_token: wildcard_token.into(),
18732            opt_ilike,
18733            opt_exclude,
18734            opt_except,
18735            opt_rename,
18736            opt_replace,
18737            opt_alias,
18738        })
18739    }
18740
18741    /// Parse an [`Ilike`](IlikeSelectItem) information for wildcard select items.
18742    ///
18743    /// If it is not possible to parse it, will return an option.
18744    pub fn parse_optional_select_item_ilike(
18745        &mut self,
18746    ) -> Result<Option<IlikeSelectItem>, ParserError> {
18747        let opt_ilike = if self.parse_keyword(Keyword::ILIKE) {
18748            let next_token = self.next_token();
18749            let pattern = match next_token.token {
18750                Token::SingleQuotedString(s) => s,
18751                _ => return self.expected("ilike pattern", next_token),
18752            };
18753            Some(IlikeSelectItem { pattern })
18754        } else {
18755            None
18756        };
18757        Ok(opt_ilike)
18758    }
18759
18760    /// Parse an [`Exclude`](ExcludeSelectItem) information for wildcard select items.
18761    ///
18762    /// If it is not possible to parse it, will return an option.
18763    pub fn parse_optional_select_item_exclude(
18764        &mut self,
18765    ) -> Result<Option<ExcludeSelectItem>, ParserError> {
18766        let opt_exclude = if self.parse_keyword(Keyword::EXCLUDE) {
18767            if self.consume_token(&Token::LParen) {
18768                let columns =
18769                    self.parse_comma_separated(|parser| parser.parse_object_name(false))?;
18770                self.expect_token(&Token::RParen)?;
18771                Some(ExcludeSelectItem::Multiple(columns))
18772            } else {
18773                let column = self.parse_object_name(false)?;
18774                Some(ExcludeSelectItem::Single(column))
18775            }
18776        } else {
18777            None
18778        };
18779
18780        Ok(opt_exclude)
18781    }
18782
18783    /// Parse an [`Except`](ExceptSelectItem) information for wildcard select items.
18784    ///
18785    /// If it is not possible to parse it, will return an option.
18786    pub fn parse_optional_select_item_except(
18787        &mut self,
18788    ) -> Result<Option<ExceptSelectItem>, ParserError> {
18789        let opt_except = if self.parse_keyword(Keyword::EXCEPT) {
18790            if self.peek_token_ref().token == Token::LParen {
18791                let idents = self.parse_parenthesized_column_list(Mandatory, false)?;
18792                match &idents[..] {
18793                    [] => {
18794                        return self.expected_ref(
18795                            "at least one column should be parsed by the expect clause",
18796                            self.peek_token_ref(),
18797                        )?;
18798                    }
18799                    [first, idents @ ..] => Some(ExceptSelectItem {
18800                        first_element: first.clone(),
18801                        additional_elements: idents.to_vec(),
18802                    }),
18803                }
18804            } else {
18805                // Clickhouse allows EXCEPT column_name
18806                let ident = self.parse_identifier()?;
18807                Some(ExceptSelectItem {
18808                    first_element: ident,
18809                    additional_elements: vec![],
18810                })
18811            }
18812        } else {
18813            None
18814        };
18815
18816        Ok(opt_except)
18817    }
18818
18819    /// Parse a [`Rename`](RenameSelectItem) information for wildcard select items.
18820    pub fn parse_optional_select_item_rename(
18821        &mut self,
18822    ) -> Result<Option<RenameSelectItem>, ParserError> {
18823        let opt_rename = if self.parse_keyword(Keyword::RENAME) {
18824            if self.consume_token(&Token::LParen) {
18825                let idents =
18826                    self.parse_comma_separated(|parser| parser.parse_identifier_with_alias())?;
18827                self.expect_token(&Token::RParen)?;
18828                Some(RenameSelectItem::Multiple(idents))
18829            } else {
18830                let ident = self.parse_identifier_with_alias()?;
18831                Some(RenameSelectItem::Single(ident))
18832            }
18833        } else {
18834            None
18835        };
18836
18837        Ok(opt_rename)
18838    }
18839
18840    /// Parse a [`Replace`](ReplaceSelectItem) information for wildcard select items.
18841    pub fn parse_optional_select_item_replace(
18842        &mut self,
18843    ) -> Result<Option<ReplaceSelectItem>, ParserError> {
18844        let opt_replace = if self.parse_keyword(Keyword::REPLACE) {
18845            if self.consume_token(&Token::LParen) {
18846                let items = self.parse_comma_separated(|parser| {
18847                    Ok(Box::new(parser.parse_replace_elements()?))
18848                })?;
18849                self.expect_token(&Token::RParen)?;
18850                Some(ReplaceSelectItem { items })
18851            } else {
18852                let tok = self.next_token();
18853                return self.expected("( after REPLACE but", tok);
18854            }
18855        } else {
18856            None
18857        };
18858
18859        Ok(opt_replace)
18860    }
18861    /// Parse a single element of a `REPLACE (...)` select-item clause.
18862    pub fn parse_replace_elements(&mut self) -> Result<ReplaceSelectElement, ParserError> {
18863        let expr = self.parse_expr()?;
18864        let as_keyword = self.parse_keyword(Keyword::AS);
18865        let ident = self.parse_identifier()?;
18866        Ok(ReplaceSelectElement {
18867            expr,
18868            column_name: ident,
18869            as_keyword,
18870        })
18871    }
18872
18873    /// Parse ASC or DESC, returns an Option with true if ASC, false of DESC or `None` if none of
18874    /// them.
18875    pub fn parse_asc_desc(&mut self) -> Option<bool> {
18876        if self.parse_keyword(Keyword::ASC) {
18877            Some(true)
18878        } else if self.parse_keyword(Keyword::DESC) {
18879            Some(false)
18880        } else {
18881            None
18882        }
18883    }
18884
18885    /// Parse ASC or DESC and map to [OrderBySort].
18886    fn parse_optional_order_by_sort(&mut self) -> Option<OrderBySort> {
18887        match self.parse_asc_desc() {
18888            Some(true) => Some(OrderBySort::Asc),
18889            Some(false) => Some(OrderBySort::Desc),
18890            None => None,
18891        }
18892    }
18893
18894    /// Parse an [OrderByExpr] expression.
18895    pub fn parse_order_by_expr(&mut self) -> Result<OrderByExpr, ParserError> {
18896        self.parse_order_by_expr_inner(false)
18897            .map(|(order_by, _)| order_by)
18898    }
18899
18900    /// Parse an [IndexColumn].
18901    pub fn parse_create_index_expr(&mut self) -> Result<IndexColumn, ParserError> {
18902        self.parse_order_by_expr_inner(true)
18903            .map(|(column, operator_class)| IndexColumn {
18904                column,
18905                operator_class,
18906            })
18907    }
18908
18909    fn parse_order_by_expr_inner(
18910        &mut self,
18911        with_operator_class: bool,
18912    ) -> Result<(OrderByExpr, Option<ObjectName>), ParserError> {
18913        let expr = self.parse_expr()?;
18914
18915        let operator_class: Option<ObjectName> = if with_operator_class {
18916            // We check that if non of the following keywords are present, then we parse an
18917            // identifier as operator class.
18918            if self
18919                .peek_one_of_keywords(&[Keyword::ASC, Keyword::DESC, Keyword::NULLS, Keyword::WITH])
18920                .is_some()
18921            {
18922                None
18923            } else {
18924                self.maybe_parse(|parser| parser.parse_object_name(false))?
18925            }
18926        } else {
18927            None
18928        };
18929
18930        let options = if !with_operator_class
18931            && self.dialect.supports_order_by_using_operator()
18932            && self.parse_keyword(Keyword::USING)
18933        {
18934            let op = self.parse_order_by_using_operator()?;
18935            OrderByOptions {
18936                sort: Some(OrderBySort::Using(op)),
18937                nulls_first: self.parse_null_ordering_modifier(),
18938            }
18939        } else {
18940            self.parse_order_by_options()?
18941        };
18942
18943        let with_fill = if self.dialect.supports_with_fill()
18944            && self.parse_keywords(&[Keyword::WITH, Keyword::FILL])
18945        {
18946            Some(self.parse_with_fill()?)
18947        } else {
18948            None
18949        };
18950
18951        Ok((
18952            OrderByExpr {
18953                expr,
18954                options,
18955                with_fill,
18956            },
18957            operator_class,
18958        ))
18959    }
18960
18961    fn parse_order_by_using_operator(&mut self) -> Result<ObjectName, ParserError> {
18962        if self.parse_keyword(Keyword::OPERATOR) {
18963            self.expect_token(&Token::LParen)?;
18964            let operator_name = self.parse_operator_name()?;
18965            self.expect_token(&Token::RParen)?;
18966            return Ok(operator_name);
18967        }
18968
18969        let token = self.next_token();
18970        Ok(ObjectName::from(vec![Ident::new(token.token.to_string())]))
18971    }
18972
18973    fn parse_null_ordering_modifier(&mut self) -> Option<bool> {
18974        if self.parse_keywords(&[Keyword::NULLS, Keyword::FIRST]) {
18975            Some(true)
18976        } else if self.parse_keywords(&[Keyword::NULLS, Keyword::LAST]) {
18977            Some(false)
18978        } else {
18979            None
18980        }
18981    }
18982
18983    fn parse_order_by_options(&mut self) -> Result<OrderByOptions, ParserError> {
18984        let sort = self.parse_optional_order_by_sort();
18985        let nulls_first = self.parse_null_ordering_modifier();
18986
18987        Ok(OrderByOptions { sort, nulls_first })
18988    }
18989
18990    // Parse a WITH FILL clause (ClickHouse dialect)
18991    // that follow the WITH FILL keywords in a ORDER BY clause
18992    /// Parse a `WITH FILL` clause used in ORDER BY (ClickHouse dialect).
18993    pub fn parse_with_fill(&mut self) -> Result<WithFill, ParserError> {
18994        let from = if self.parse_keyword(Keyword::FROM) {
18995            Some(self.parse_expr()?)
18996        } else {
18997            None
18998        };
18999
19000        let to = if self.parse_keyword(Keyword::TO) {
19001            Some(self.parse_expr()?)
19002        } else {
19003            None
19004        };
19005
19006        let step = if self.parse_keyword(Keyword::STEP) {
19007            Some(self.parse_expr()?)
19008        } else {
19009            None
19010        };
19011
19012        Ok(WithFill { from, to, step })
19013    }
19014
19015    /// Parse a set of comma separated INTERPOLATE expressions (ClickHouse dialect)
19016    /// that follow the INTERPOLATE keyword in an ORDER BY clause with the WITH FILL modifier
19017    pub fn parse_interpolations(&mut self) -> Result<Option<Interpolate>, ParserError> {
19018        if !self.parse_keyword(Keyword::INTERPOLATE) {
19019            return Ok(None);
19020        }
19021
19022        if self.consume_token(&Token::LParen) {
19023            let interpolations =
19024                self.parse_comma_separated0(|p| p.parse_interpolation(), Token::RParen)?;
19025            self.expect_token(&Token::RParen)?;
19026            // INTERPOLATE () and INTERPOLATE ( ... ) variants
19027            return Ok(Some(Interpolate {
19028                exprs: Some(interpolations),
19029            }));
19030        }
19031
19032        // INTERPOLATE
19033        Ok(Some(Interpolate { exprs: None }))
19034    }
19035
19036    /// Parse a INTERPOLATE expression (ClickHouse dialect)
19037    pub fn parse_interpolation(&mut self) -> Result<InterpolateExpr, ParserError> {
19038        let column = self.parse_identifier()?;
19039        let expr = if self.parse_keyword(Keyword::AS) {
19040            Some(self.parse_expr()?)
19041        } else {
19042            None
19043        };
19044        Ok(InterpolateExpr { column, expr })
19045    }
19046
19047    /// Parse a TOP clause, MSSQL equivalent of LIMIT,
19048    /// that follows after `SELECT [DISTINCT]`.
19049    pub fn parse_top(&mut self) -> Result<Top, ParserError> {
19050        let quantity = if self.consume_token(&Token::LParen) {
19051            let quantity = self.parse_expr()?;
19052            self.expect_token(&Token::RParen)?;
19053            Some(TopQuantity::Expr(quantity))
19054        } else {
19055            let next_token = self.next_token();
19056            let quantity = match next_token.token {
19057                Token::Number(s, _) => Self::parse::<u64>(s, next_token.span.start)?,
19058                _ => self.expected("literal int", next_token)?,
19059            };
19060            Some(TopQuantity::Constant(quantity))
19061        };
19062
19063        let percent = self.parse_keyword(Keyword::PERCENT);
19064
19065        let with_ties = self.parse_keywords(&[Keyword::WITH, Keyword::TIES]);
19066
19067        Ok(Top {
19068            with_ties,
19069            percent,
19070            quantity,
19071        })
19072    }
19073
19074    /// Parse a LIMIT clause
19075    pub fn parse_limit(&mut self) -> Result<Option<Expr>, ParserError> {
19076        if self.parse_keyword(Keyword::ALL) {
19077            Ok(None)
19078        } else {
19079            Ok(Some(self.parse_expr()?))
19080        }
19081    }
19082
19083    /// Parse an OFFSET clause
19084    pub fn parse_offset(&mut self) -> Result<Offset, ParserError> {
19085        let value = self.parse_expr()?;
19086        let rows = if self.parse_keyword(Keyword::ROW) {
19087            OffsetRows::Row
19088        } else if self.parse_keyword(Keyword::ROWS) {
19089            OffsetRows::Rows
19090        } else {
19091            OffsetRows::None
19092        };
19093        Ok(Offset { value, rows })
19094    }
19095
19096    /// Parse a FETCH clause
19097    pub fn parse_fetch(&mut self) -> Result<Fetch, ParserError> {
19098        let _ = self.parse_one_of_keywords(&[Keyword::FIRST, Keyword::NEXT]);
19099
19100        let (quantity, percent) = if self
19101            .parse_one_of_keywords(&[Keyword::ROW, Keyword::ROWS])
19102            .is_some()
19103        {
19104            (None, false)
19105        } else {
19106            let quantity = Expr::Value(self.parse_value()?);
19107            let percent = self.parse_keyword(Keyword::PERCENT);
19108            let _ = self.parse_one_of_keywords(&[Keyword::ROW, Keyword::ROWS]);
19109            (Some(quantity), percent)
19110        };
19111
19112        let with_ties = if self.parse_keyword(Keyword::ONLY) {
19113            false
19114        } else {
19115            self.parse_keywords(&[Keyword::WITH, Keyword::TIES])
19116        };
19117
19118        Ok(Fetch {
19119            with_ties,
19120            percent,
19121            quantity,
19122        })
19123    }
19124
19125    /// Parse a FOR UPDATE/FOR SHARE clause
19126    pub fn parse_lock(&mut self) -> Result<LockClause, ParserError> {
19127        let lock_type = match self.expect_one_of_keywords(&[Keyword::UPDATE, Keyword::SHARE])? {
19128            Keyword::UPDATE => LockType::Update,
19129            Keyword::SHARE => LockType::Share,
19130            unexpected_keyword => return Err(ParserError::ParserError(
19131                format!("Internal parser error: expected any of {{UPDATE, SHARE}}, got {unexpected_keyword:?}"),
19132            )),
19133        };
19134        let of = if self.parse_keyword(Keyword::OF) {
19135            Some(self.parse_object_name(false)?)
19136        } else {
19137            None
19138        };
19139        let nonblock = if self.parse_keyword(Keyword::NOWAIT) {
19140            Some(NonBlock::Nowait)
19141        } else if self.parse_keywords(&[Keyword::SKIP, Keyword::LOCKED]) {
19142            Some(NonBlock::SkipLocked)
19143        } else {
19144            None
19145        };
19146        Ok(LockClause {
19147            lock_type,
19148            of,
19149            nonblock,
19150        })
19151    }
19152
19153    /// Parse a PostgreSQL `LOCK` statement.
19154    pub fn parse_lock_statement(&mut self) -> Result<Lock, ParserError> {
19155        self.expect_keyword(Keyword::LOCK)?;
19156
19157        if self.peek_keyword(Keyword::TABLES) {
19158            return self.expected_ref("TABLE or a table name", self.peek_token_ref());
19159        }
19160
19161        let _ = self.parse_keyword(Keyword::TABLE);
19162        let tables = self.parse_comma_separated(Parser::parse_lock_table_target)?;
19163        let lock_mode = if self.parse_keyword(Keyword::IN) {
19164            let lock_mode = self.parse_lock_table_mode()?;
19165            self.expect_keyword(Keyword::MODE)?;
19166            Some(lock_mode)
19167        } else {
19168            None
19169        };
19170        let nowait = self.parse_keyword(Keyword::NOWAIT);
19171
19172        Ok(Lock {
19173            tables,
19174            lock_mode,
19175            nowait,
19176        })
19177    }
19178
19179    fn parse_lock_table_target(&mut self) -> Result<LockTableTarget, ParserError> {
19180        let only = self.parse_keyword(Keyword::ONLY);
19181        let name = self.parse_object_name(false)?;
19182        let has_asterisk = self.consume_token(&Token::Mul);
19183
19184        Ok(LockTableTarget {
19185            name,
19186            only,
19187            has_asterisk,
19188        })
19189    }
19190
19191    fn parse_lock_table_mode(&mut self) -> Result<LockTableMode, ParserError> {
19192        if self.parse_keywords(&[Keyword::ACCESS, Keyword::SHARE]) {
19193            Ok(LockTableMode::AccessShare)
19194        } else if self.parse_keywords(&[Keyword::ACCESS, Keyword::EXCLUSIVE]) {
19195            Ok(LockTableMode::AccessExclusive)
19196        } else if self.parse_keywords(&[Keyword::ROW, Keyword::SHARE]) {
19197            Ok(LockTableMode::RowShare)
19198        } else if self.parse_keywords(&[Keyword::ROW, Keyword::EXCLUSIVE]) {
19199            Ok(LockTableMode::RowExclusive)
19200        } else if self.parse_keywords(&[Keyword::SHARE, Keyword::UPDATE, Keyword::EXCLUSIVE]) {
19201            Ok(LockTableMode::ShareUpdateExclusive)
19202        } else if self.parse_keywords(&[Keyword::SHARE, Keyword::ROW, Keyword::EXCLUSIVE]) {
19203            Ok(LockTableMode::ShareRowExclusive)
19204        } else if self.parse_keyword(Keyword::SHARE) {
19205            Ok(LockTableMode::Share)
19206        } else if self.parse_keyword(Keyword::EXCLUSIVE) {
19207            Ok(LockTableMode::Exclusive)
19208        } else {
19209            self.expected_ref("a PostgreSQL LOCK TABLE mode", self.peek_token_ref())
19210        }
19211    }
19212
19213    /// Parse a VALUES clause
19214    pub fn parse_values(
19215        &mut self,
19216        allow_empty: bool,
19217        value_keyword: bool,
19218    ) -> Result<Values, ParserError> {
19219        let mut explicit_row = false;
19220
19221        let rows = self.parse_comma_separated(|parser| {
19222            if parser.parse_keyword(Keyword::ROW) {
19223                explicit_row = true;
19224            }
19225            Ok(Parens {
19226                opening_token: parser.expect_token(&Token::LParen)?.into(),
19227                content: if allow_empty && parser.peek_token_ref().token == Token::RParen {
19228                    vec![]
19229                } else {
19230                    parser.parse_comma_separated(Parser::parse_expr)?
19231                },
19232                closing_token: parser.expect_token(&Token::RParen)?.into(),
19233            })
19234        })?;
19235        Ok(Values {
19236            explicit_row,
19237            rows,
19238            value_keyword,
19239        })
19240    }
19241
19242    /// Parse a 'START TRANSACTION' statement
19243    pub fn parse_start_transaction(&mut self) -> Result<Statement, ParserError> {
19244        self.expect_keyword_is(Keyword::TRANSACTION)?;
19245        Ok(Statement::StartTransaction {
19246            modes: self.parse_transaction_modes()?,
19247            begin: false,
19248            transaction: Some(BeginTransactionKind::Transaction),
19249            modifier: None,
19250            statements: vec![],
19251            exception: None,
19252            has_end_keyword: false,
19253        })
19254    }
19255
19256    /// Parse a transaction modifier keyword that can follow a `BEGIN` statement.
19257    pub(crate) fn parse_transaction_modifier(&mut self) -> Option<TransactionModifier> {
19258        if !self.dialect.supports_start_transaction_modifier() {
19259            None
19260        } else if self.parse_keyword(Keyword::DEFERRED) {
19261            Some(TransactionModifier::Deferred)
19262        } else if self.parse_keyword(Keyword::IMMEDIATE) {
19263            Some(TransactionModifier::Immediate)
19264        } else if self.parse_keyword(Keyword::EXCLUSIVE) {
19265            Some(TransactionModifier::Exclusive)
19266        } else if self.parse_keyword(Keyword::TRY) {
19267            Some(TransactionModifier::Try)
19268        } else if self.parse_keyword(Keyword::CATCH) {
19269            Some(TransactionModifier::Catch)
19270        } else {
19271            None
19272        }
19273    }
19274
19275    /// Parse a 'BEGIN' statement
19276    pub fn parse_begin(&mut self) -> Result<Statement, ParserError> {
19277        let modifier = self.parse_transaction_modifier();
19278        let transaction =
19279            match self.parse_one_of_keywords(&[Keyword::TRANSACTION, Keyword::WORK, Keyword::TRAN])
19280            {
19281                Some(Keyword::TRANSACTION) => Some(BeginTransactionKind::Transaction),
19282                Some(Keyword::WORK) => Some(BeginTransactionKind::Work),
19283                Some(Keyword::TRAN) => Some(BeginTransactionKind::Tran),
19284                _ => None,
19285            };
19286        Ok(Statement::StartTransaction {
19287            modes: self.parse_transaction_modes()?,
19288            begin: true,
19289            transaction,
19290            modifier,
19291            statements: vec![],
19292            exception: None,
19293            has_end_keyword: false,
19294        })
19295    }
19296
19297    /// Parse a 'BEGIN ... EXCEPTION ... END' block
19298    pub fn parse_begin_exception_end(&mut self) -> Result<Statement, ParserError> {
19299        let statements = self.parse_statement_list(&[Keyword::EXCEPTION, Keyword::END])?;
19300
19301        let exception = if self.parse_keyword(Keyword::EXCEPTION) {
19302            let mut when = Vec::new();
19303
19304            // We can have multiple `WHEN` arms so we consume all cases until `END`
19305            while !self.peek_keyword(Keyword::END) {
19306                self.expect_keyword(Keyword::WHEN)?;
19307
19308                // Each `WHEN` case can have one or more conditions, e.g.
19309                // WHEN EXCEPTION_1 [OR EXCEPTION_2] THEN
19310                // So we parse identifiers until the `THEN` keyword.
19311                let mut idents = Vec::new();
19312
19313                while !self.parse_keyword(Keyword::THEN) {
19314                    let ident = self.parse_identifier()?;
19315                    idents.push(ident);
19316
19317                    self.maybe_parse(|p| p.expect_keyword(Keyword::OR))?;
19318                }
19319
19320                let statements = self.parse_statement_list(&[Keyword::WHEN, Keyword::END])?;
19321
19322                when.push(ExceptionWhen { idents, statements });
19323            }
19324
19325            Some(when)
19326        } else {
19327            None
19328        };
19329
19330        self.expect_keyword(Keyword::END)?;
19331
19332        Ok(Statement::StartTransaction {
19333            begin: true,
19334            statements,
19335            exception,
19336            has_end_keyword: true,
19337            transaction: None,
19338            modifier: None,
19339            modes: Default::default(),
19340        })
19341    }
19342
19343    /// Parse an 'END' statement
19344    pub fn parse_end(&mut self) -> Result<Statement, ParserError> {
19345        let modifier = if !self.dialect.supports_end_transaction_modifier() {
19346            None
19347        } else if self.parse_keyword(Keyword::TRY) {
19348            Some(TransactionModifier::Try)
19349        } else if self.parse_keyword(Keyword::CATCH) {
19350            Some(TransactionModifier::Catch)
19351        } else {
19352            None
19353        };
19354        Ok(Statement::Commit {
19355            chain: self.parse_commit_rollback_chain()?,
19356            end: true,
19357            modifier,
19358        })
19359    }
19360
19361    /// Parse a list of transaction modes
19362    pub fn parse_transaction_modes(&mut self) -> Result<Vec<TransactionMode>, ParserError> {
19363        let mut modes = vec![];
19364        let mut required = false;
19365        loop {
19366            let mode = if self.parse_keywords(&[Keyword::ISOLATION, Keyword::LEVEL]) {
19367                let iso_level = if self.parse_keywords(&[Keyword::READ, Keyword::UNCOMMITTED]) {
19368                    TransactionIsolationLevel::ReadUncommitted
19369                } else if self.parse_keywords(&[Keyword::READ, Keyword::COMMITTED]) {
19370                    TransactionIsolationLevel::ReadCommitted
19371                } else if self.parse_keywords(&[Keyword::REPEATABLE, Keyword::READ]) {
19372                    TransactionIsolationLevel::RepeatableRead
19373                } else if self.parse_keyword(Keyword::SERIALIZABLE) {
19374                    TransactionIsolationLevel::Serializable
19375                } else if self.parse_keyword(Keyword::SNAPSHOT) {
19376                    TransactionIsolationLevel::Snapshot
19377                } else {
19378                    self.expected_ref("isolation level", self.peek_token_ref())?
19379                };
19380                TransactionMode::IsolationLevel(iso_level)
19381            } else if self.parse_keywords(&[Keyword::READ, Keyword::ONLY]) {
19382                TransactionMode::AccessMode(TransactionAccessMode::ReadOnly)
19383            } else if self.parse_keywords(&[Keyword::READ, Keyword::WRITE]) {
19384                TransactionMode::AccessMode(TransactionAccessMode::ReadWrite)
19385            } else if required {
19386                self.expected_ref("transaction mode", self.peek_token_ref())?
19387            } else {
19388                break;
19389            };
19390            modes.push(mode);
19391            // ANSI requires a comma after each transaction mode, but
19392            // PostgreSQL, for historical reasons, does not. We follow
19393            // PostgreSQL in making the comma optional, since that is strictly
19394            // more general.
19395            required = self.consume_token(&Token::Comma);
19396        }
19397        Ok(modes)
19398    }
19399
19400    /// Parse a 'COMMIT' statement
19401    pub fn parse_commit(&mut self) -> Result<Statement, ParserError> {
19402        Ok(Statement::Commit {
19403            chain: self.parse_commit_rollback_chain()?,
19404            end: false,
19405            modifier: None,
19406        })
19407    }
19408
19409    /// Parse a 'ROLLBACK' statement
19410    pub fn parse_rollback(&mut self) -> Result<Statement, ParserError> {
19411        let chain = self.parse_commit_rollback_chain()?;
19412        let savepoint = self.parse_rollback_savepoint()?;
19413
19414        Ok(Statement::Rollback { chain, savepoint })
19415    }
19416
19417    /// Parse an optional `AND [NO] CHAIN` clause for `COMMIT` and `ROLLBACK` statements
19418    pub fn parse_commit_rollback_chain(&mut self) -> Result<bool, ParserError> {
19419        let _ = self.parse_one_of_keywords(&[Keyword::TRANSACTION, Keyword::WORK, Keyword::TRAN]);
19420        if self.parse_keyword(Keyword::AND) {
19421            let chain = !self.parse_keyword(Keyword::NO);
19422            self.expect_keyword_is(Keyword::CHAIN)?;
19423            Ok(chain)
19424        } else {
19425            Ok(false)
19426        }
19427    }
19428
19429    /// Parse an optional 'TO SAVEPOINT savepoint_name' clause for ROLLBACK statements
19430    pub fn parse_rollback_savepoint(&mut self) -> Result<Option<Ident>, ParserError> {
19431        if self.parse_keyword(Keyword::TO) {
19432            let _ = self.parse_keyword(Keyword::SAVEPOINT);
19433            let savepoint = self.parse_identifier()?;
19434
19435            Ok(Some(savepoint))
19436        } else {
19437            Ok(None)
19438        }
19439    }
19440
19441    /// Parse a 'RAISERROR' statement
19442    pub fn parse_raiserror(&mut self) -> Result<Statement, ParserError> {
19443        self.expect_token(&Token::LParen)?;
19444        let message = Box::new(self.parse_expr()?);
19445        self.expect_token(&Token::Comma)?;
19446        let severity = Box::new(self.parse_expr()?);
19447        self.expect_token(&Token::Comma)?;
19448        let state = Box::new(self.parse_expr()?);
19449        let arguments = if self.consume_token(&Token::Comma) {
19450            self.parse_comma_separated(Parser::parse_expr)?
19451        } else {
19452            vec![]
19453        };
19454        self.expect_token(&Token::RParen)?;
19455        let options = if self.parse_keyword(Keyword::WITH) {
19456            self.parse_comma_separated(Parser::parse_raiserror_option)?
19457        } else {
19458            vec![]
19459        };
19460        Ok(Statement::RaisError {
19461            message,
19462            severity,
19463            state,
19464            arguments,
19465            options,
19466        })
19467    }
19468
19469    /// Parse a single `RAISERROR` option
19470    pub fn parse_raiserror_option(&mut self) -> Result<RaisErrorOption, ParserError> {
19471        match self.expect_one_of_keywords(&[Keyword::LOG, Keyword::NOWAIT, Keyword::SETERROR])? {
19472            Keyword::LOG => Ok(RaisErrorOption::Log),
19473            Keyword::NOWAIT => Ok(RaisErrorOption::NoWait),
19474            Keyword::SETERROR => Ok(RaisErrorOption::SetError),
19475            _ => self.expected_ref(
19476                "LOG, NOWAIT OR SETERROR raiserror option",
19477                self.peek_token_ref(),
19478            ),
19479        }
19480    }
19481
19482    /// Parse a MSSQL `THROW` statement.
19483    ///
19484    /// See [Statement::Throw]
19485    pub fn parse_throw(&mut self) -> Result<ThrowStatement, ParserError> {
19486        self.expect_keyword_is(Keyword::THROW)?;
19487
19488        let error_number = self.maybe_parse(|p| p.parse_expr().map(Box::new))?;
19489        let (message, state) = if error_number.is_some() {
19490            self.expect_token(&Token::Comma)?;
19491            let message = Box::new(self.parse_expr()?);
19492            self.expect_token(&Token::Comma)?;
19493            let state = Box::new(self.parse_expr()?);
19494            (Some(message), Some(state))
19495        } else {
19496            (None, None)
19497        };
19498
19499        Ok(ThrowStatement {
19500            error_number,
19501            message,
19502            state,
19503        })
19504    }
19505
19506    /// Parse a SQL `DEALLOCATE` statement
19507    pub fn parse_deallocate(&mut self) -> Result<Statement, ParserError> {
19508        let prepare = self.parse_keyword(Keyword::PREPARE);
19509        let name = self.parse_identifier()?;
19510        Ok(Statement::Deallocate { name, prepare })
19511    }
19512
19513    /// Parse a SQL `EXECUTE` statement
19514    pub fn parse_execute(&mut self) -> Result<Statement, ParserError> {
19515        let immediate =
19516            self.dialect.supports_execute_immediate() && self.parse_keyword(Keyword::IMMEDIATE);
19517
19518        // When `EXEC` is immediately followed by `(`, the content is a dynamic-SQL
19519        // expression — e.g. `EXEC (@sql)`, `EXEC ('SELECT ...')`, or
19520        // `EXEC ('SELECT ... FROM ' + @tbl + ' WHERE ...')`.
19521        // Skip name parsing; the expression ends up in `parameters` via the
19522        // `has_parentheses` path below, consistent with `EXECUTE IMMEDIATE <expr>`.
19523        let name = if immediate || matches!(self.peek_token_ref().token, Token::LParen) {
19524            None
19525        } else {
19526            Some(self.parse_object_name(false)?)
19527        };
19528
19529        let has_parentheses = self.consume_token(&Token::LParen);
19530
19531        let end_kws = &[Keyword::USING, Keyword::OUTPUT, Keyword::DEFAULT];
19532        let end_token = match (has_parentheses, self.peek_token().token) {
19533            (true, _) => Token::RParen,
19534            (false, Token::EOF) => Token::EOF,
19535            (false, Token::Word(w)) if end_kws.contains(&w.keyword) => Token::Word(w),
19536            (false, _) => Token::SemiColon,
19537        };
19538
19539        let parameters = self.parse_comma_separated0(Parser::parse_expr, end_token)?;
19540
19541        if has_parentheses {
19542            self.expect_token(&Token::RParen)?;
19543        }
19544
19545        let into = if self.parse_keyword(Keyword::INTO) {
19546            self.parse_comma_separated(Self::parse_identifier)?
19547        } else {
19548            vec![]
19549        };
19550
19551        let using = if self.parse_keyword(Keyword::USING) {
19552            self.parse_comma_separated(Self::parse_expr_with_alias)?
19553        } else {
19554            vec![]
19555        };
19556
19557        let output = self.parse_keyword(Keyword::OUTPUT);
19558
19559        let default = self.parse_keyword(Keyword::DEFAULT);
19560
19561        Ok(Statement::Execute {
19562            immediate,
19563            name,
19564            parameters,
19565            has_parentheses,
19566            into,
19567            using,
19568            output,
19569            default,
19570        })
19571    }
19572
19573    /// Parse a SQL `PREPARE` statement
19574    pub fn parse_prepare(&mut self) -> Result<Statement, ParserError> {
19575        let name = self.parse_identifier()?;
19576
19577        let mut data_types = vec![];
19578        if self.consume_token(&Token::LParen) {
19579            data_types = self.parse_comma_separated(Parser::parse_data_type)?;
19580            self.expect_token(&Token::RParen)?;
19581        }
19582
19583        self.expect_keyword_is(Keyword::AS)?;
19584        let statement = Box::new(self.parse_statement()?);
19585        Ok(Statement::Prepare {
19586            name,
19587            data_types,
19588            statement,
19589        })
19590    }
19591
19592    /// Parse a SQL `UNLOAD` statement
19593    pub fn parse_unload(&mut self) -> Result<Statement, ParserError> {
19594        self.expect_keyword(Keyword::UNLOAD)?;
19595        self.expect_token(&Token::LParen)?;
19596        let (query, query_text) =
19597            if matches!(self.peek_token_ref().token, Token::SingleQuotedString(_)) {
19598                (None, Some(self.parse_literal_string()?))
19599            } else {
19600                (Some(self.parse_query()?), None)
19601            };
19602        self.expect_token(&Token::RParen)?;
19603
19604        self.expect_keyword_is(Keyword::TO)?;
19605        let to = self.parse_identifier()?;
19606        let auth = if self.parse_keyword(Keyword::IAM_ROLE) {
19607            Some(self.parse_iam_role_kind()?)
19608        } else {
19609            None
19610        };
19611        let with = self.parse_options(Keyword::WITH)?;
19612        let mut options = vec![];
19613        while let Some(opt) = self.maybe_parse(|parser| parser.parse_copy_legacy_option())? {
19614            options.push(opt);
19615        }
19616        Ok(Statement::Unload {
19617            query,
19618            query_text,
19619            to,
19620            auth,
19621            with,
19622            options,
19623        })
19624    }
19625
19626    fn parse_select_into(&mut self) -> Result<SelectInto, ParserError> {
19627        let temporary = self
19628            .parse_one_of_keywords(&[Keyword::TEMP, Keyword::TEMPORARY])
19629            .is_some();
19630        let unlogged = self.parse_keyword(Keyword::UNLOGGED);
19631        let table = self.parse_keyword(Keyword::TABLE);
19632        let name = self.parse_object_name(false)?;
19633
19634        Ok(SelectInto {
19635            temporary,
19636            unlogged,
19637            table,
19638            name,
19639        })
19640    }
19641
19642    fn parse_pragma_value(&mut self) -> Result<ValueWithSpan, ParserError> {
19643        let v = self.parse_value()?;
19644        match &v.value {
19645            Value::SingleQuotedString(_) => Ok(v),
19646            Value::DoubleQuotedString(_) => Ok(v),
19647            Value::Number(_, _) => Ok(v),
19648            Value::Placeholder(_) => Ok(v),
19649            _ => {
19650                self.prev_token();
19651                self.expected_ref("number or string or ? placeholder", self.peek_token_ref())
19652            }
19653        }
19654    }
19655
19656    /// PRAGMA [schema-name '.'] pragma-name [('=' pragma-value) | '(' pragma-value ')']
19657    pub fn parse_pragma(&mut self) -> Result<Statement, ParserError> {
19658        let name = self.parse_object_name(false)?;
19659        if self.consume_token(&Token::LParen) {
19660            let value = self.parse_pragma_value()?;
19661            self.expect_token(&Token::RParen)?;
19662            Ok(Statement::Pragma {
19663                name,
19664                value: Some(value),
19665                is_eq: false,
19666            })
19667        } else if self.consume_token(&Token::Eq) {
19668            Ok(Statement::Pragma {
19669                name,
19670                value: Some(self.parse_pragma_value()?),
19671                is_eq: true,
19672            })
19673        } else {
19674            Ok(Statement::Pragma {
19675                name,
19676                value: None,
19677                is_eq: false,
19678            })
19679        }
19680    }
19681
19682    /// `INSTALL [extension_name]`
19683    pub fn parse_install(&mut self) -> Result<Statement, ParserError> {
19684        let extension_name = self.parse_identifier()?;
19685
19686        Ok(Statement::Install { extension_name })
19687    }
19688
19689    /// Parse a SQL LOAD statement
19690    pub fn parse_load(&mut self) -> Result<Statement, ParserError> {
19691        if self.dialect.supports_load_extension() {
19692            let extension_name = self.parse_identifier()?;
19693            Ok(Statement::Load { extension_name })
19694        } else if self.parse_keyword(Keyword::DATA) && self.dialect.supports_load_data() {
19695            let local = self.parse_one_of_keywords(&[Keyword::LOCAL]).is_some();
19696            self.expect_keyword_is(Keyword::INPATH)?;
19697            let inpath = self.parse_literal_string()?;
19698            let overwrite = self.parse_one_of_keywords(&[Keyword::OVERWRITE]).is_some();
19699            self.expect_keyword_is(Keyword::INTO)?;
19700            self.expect_keyword_is(Keyword::TABLE)?;
19701            let table_name = self.parse_object_name(false)?;
19702            let partitioned = self.parse_insert_partition()?;
19703            let table_format = self.parse_load_data_table_format()?;
19704            Ok(Statement::LoadData {
19705                local,
19706                inpath,
19707                overwrite,
19708                table_name,
19709                partitioned,
19710                table_format,
19711            })
19712        } else {
19713            self.expected_ref(
19714                "`DATA` or an extension name after `LOAD`",
19715                self.peek_token_ref(),
19716            )
19717        }
19718    }
19719
19720    /// ClickHouse:
19721    /// ```sql
19722    /// OPTIMIZE TABLE [db.]name [ON CLUSTER cluster] [PARTITION partition | PARTITION ID 'partition_id'] [FINAL] [DEDUPLICATE [BY expression]]
19723    /// ```
19724    /// [ClickHouse](https://clickhouse.com/docs/en/sql-reference/statements/optimize)
19725    ///
19726    /// Databricks:
19727    /// ```sql
19728    /// OPTIMIZE table_name [WHERE predicate] [ZORDER BY (col_name1 [, ...])]
19729    /// ```
19730    /// [Databricks](https://docs.databricks.com/en/sql/language-manual/delta-optimize.html)
19731    pub fn parse_optimize_table(&mut self) -> Result<Statement, ParserError> {
19732        let has_table_keyword = self.parse_keyword(Keyword::TABLE);
19733
19734        let name = self.parse_object_name(false)?;
19735
19736        // ClickHouse-specific options
19737        let on_cluster = self.parse_optional_on_cluster()?;
19738
19739        let partition = if self.parse_keyword(Keyword::PARTITION) {
19740            if self.parse_keyword(Keyword::ID) {
19741                Some(Partition::Identifier(self.parse_identifier()?))
19742            } else {
19743                Some(Partition::Expr(self.parse_expr()?))
19744            }
19745        } else {
19746            None
19747        };
19748
19749        let include_final = self.parse_keyword(Keyword::FINAL);
19750
19751        let deduplicate = if self.parse_keyword(Keyword::DEDUPLICATE) {
19752            if self.parse_keyword(Keyword::BY) {
19753                Some(Deduplicate::ByExpression(self.parse_expr()?))
19754            } else {
19755                Some(Deduplicate::All)
19756            }
19757        } else {
19758            None
19759        };
19760
19761        // Databricks-specific options
19762        let predicate = if self.parse_keyword(Keyword::WHERE) {
19763            Some(self.parse_expr()?)
19764        } else {
19765            None
19766        };
19767
19768        let zorder = if self.parse_keywords(&[Keyword::ZORDER, Keyword::BY]) {
19769            self.expect_token(&Token::LParen)?;
19770            let columns = self.parse_comma_separated(|p| p.parse_expr())?;
19771            self.expect_token(&Token::RParen)?;
19772            Some(columns)
19773        } else {
19774            None
19775        };
19776
19777        Ok(Statement::OptimizeTable {
19778            name,
19779            has_table_keyword,
19780            on_cluster,
19781            partition,
19782            include_final,
19783            deduplicate,
19784            predicate,
19785            zorder,
19786        })
19787    }
19788
19789    /// ```sql
19790    /// CREATE [ { TEMPORARY | TEMP } ] SEQUENCE [ IF NOT EXISTS ] <sequence_name>
19791    /// ```
19792    ///
19793    /// See [Postgres docs](https://www.postgresql.org/docs/current/sql-createsequence.html) for more details.
19794    pub fn parse_create_sequence(&mut self, temporary: bool) -> Result<Statement, ParserError> {
19795        //[ IF NOT EXISTS ]
19796        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
19797        //name
19798        let name = self.parse_object_name(false)?;
19799        //[ AS data_type ]
19800        let mut data_type: Option<DataType> = None;
19801        if self.parse_keywords(&[Keyword::AS]) {
19802            data_type = Some(self.parse_data_type()?)
19803        }
19804        let sequence_options = self.parse_create_sequence_options()?;
19805        // [ OWNED BY { table_name.column_name | NONE } ]
19806        let owned_by = if self.parse_keywords(&[Keyword::OWNED, Keyword::BY]) {
19807            if self.parse_keywords(&[Keyword::NONE]) {
19808                Some(ObjectName::from(vec![Ident::new("NONE")]))
19809            } else {
19810                Some(self.parse_object_name(false)?)
19811            }
19812        } else {
19813            None
19814        };
19815        Ok(Statement::CreateSequence {
19816            temporary,
19817            if_not_exists,
19818            name,
19819            data_type,
19820            sequence_options,
19821            owned_by,
19822        })
19823    }
19824
19825    fn parse_create_sequence_options(&mut self) -> Result<Vec<SequenceOptions>, ParserError> {
19826        let mut sequence_options = vec![];
19827        // PostgreSQL allows these clauses in any order (e.g. pg_dump emits
19828        // `START` before `INCREMENT`), so loop until no clause matches.
19829        // https://www.postgresql.org/docs/current/sql-createsequence.html
19830        loop {
19831            //[ INCREMENT [ BY ] increment ]
19832            if self.parse_keywords(&[Keyword::INCREMENT]) {
19833                if self.parse_keywords(&[Keyword::BY]) {
19834                    sequence_options.push(SequenceOptions::IncrementBy(self.parse_number()?, true));
19835                } else {
19836                    sequence_options
19837                        .push(SequenceOptions::IncrementBy(self.parse_number()?, false));
19838                }
19839            }
19840            //[ MINVALUE minvalue | NO MINVALUE ]
19841            else if self.parse_keyword(Keyword::MINVALUE) {
19842                sequence_options.push(SequenceOptions::MinValue(Some(self.parse_number()?)));
19843            } else if self.parse_keywords(&[Keyword::NO, Keyword::MINVALUE]) {
19844                sequence_options.push(SequenceOptions::MinValue(None));
19845            }
19846            //[ MAXVALUE maxvalue | NO MAXVALUE ]
19847            else if self.parse_keywords(&[Keyword::MAXVALUE]) {
19848                sequence_options.push(SequenceOptions::MaxValue(Some(self.parse_number()?)));
19849            } else if self.parse_keywords(&[Keyword::NO, Keyword::MAXVALUE]) {
19850                sequence_options.push(SequenceOptions::MaxValue(None));
19851            }
19852            //[ START [ WITH ] start ]
19853            else if self.parse_keywords(&[Keyword::START]) {
19854                if self.parse_keywords(&[Keyword::WITH]) {
19855                    sequence_options.push(SequenceOptions::StartWith(self.parse_number()?, true));
19856                } else {
19857                    sequence_options.push(SequenceOptions::StartWith(self.parse_number()?, false));
19858                }
19859            }
19860            //[ CACHE cache ]
19861            else if self.parse_keywords(&[Keyword::CACHE]) {
19862                sequence_options.push(SequenceOptions::Cache(self.parse_number()?));
19863            }
19864            // [ [ NO ] CYCLE ]
19865            else if self.parse_keywords(&[Keyword::NO, Keyword::CYCLE]) {
19866                sequence_options.push(SequenceOptions::Cycle(true));
19867            } else if self.parse_keywords(&[Keyword::CYCLE]) {
19868                sequence_options.push(SequenceOptions::Cycle(false));
19869            } else {
19870                break;
19871            }
19872        }
19873
19874        Ok(sequence_options)
19875    }
19876
19877    ///   Parse a `CREATE SERVER` statement.
19878    ///
19879    ///  See [Statement::CreateServer]
19880    pub fn parse_pg_create_server(&mut self) -> Result<Statement, ParserError> {
19881        let ine = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
19882        let name = self.parse_object_name(false)?;
19883
19884        let server_type = if self.parse_keyword(Keyword::TYPE) {
19885            Some(self.parse_identifier()?)
19886        } else {
19887            None
19888        };
19889
19890        let version = if self.parse_keyword(Keyword::VERSION) {
19891            Some(self.parse_identifier()?)
19892        } else {
19893            None
19894        };
19895
19896        self.expect_keywords(&[Keyword::FOREIGN, Keyword::DATA, Keyword::WRAPPER])?;
19897        let foreign_data_wrapper = self.parse_object_name(false)?;
19898
19899        let mut options = None;
19900        if self.parse_keyword(Keyword::OPTIONS) {
19901            self.expect_token(&Token::LParen)?;
19902            options = Some(self.parse_comma_separated(|p| {
19903                let key = p.parse_identifier()?;
19904                let value = p.parse_identifier()?;
19905                Ok(CreateServerOption { key, value })
19906            })?);
19907            self.expect_token(&Token::RParen)?;
19908        }
19909
19910        Ok(Statement::CreateServer(CreateServerStatement {
19911            name,
19912            if_not_exists: ine,
19913            server_type,
19914            version,
19915            foreign_data_wrapper,
19916            options,
19917        }))
19918    }
19919
19920    /// The index of the first unprocessed token.
19921    pub fn index(&self) -> usize {
19922        self.index
19923    }
19924
19925    /// Parse a named window definition.
19926    pub fn parse_named_window(&mut self) -> Result<NamedWindowDefinition, ParserError> {
19927        let ident = self.parse_identifier()?;
19928        self.expect_keyword_is(Keyword::AS)?;
19929
19930        let window_expr = if self.consume_token(&Token::LParen) {
19931            NamedWindowExpr::WindowSpec(self.parse_window_spec()?)
19932        } else if self.dialect.supports_window_clause_named_window_reference() {
19933            NamedWindowExpr::NamedWindow(self.parse_identifier()?)
19934        } else {
19935            return self.expected_ref("(", self.peek_token_ref());
19936        };
19937
19938        Ok(NamedWindowDefinition(ident, window_expr))
19939    }
19940
19941    /// Parse `CREATE PROCEDURE` statement.
19942    pub fn parse_create_procedure(&mut self, or_alter: bool) -> Result<Statement, ParserError> {
19943        let name = self.parse_object_name(false)?;
19944        let params = self.parse_optional_procedure_parameters()?;
19945
19946        let language = if self.parse_keyword(Keyword::LANGUAGE) {
19947            Some(self.parse_identifier()?)
19948        } else {
19949            None
19950        };
19951
19952        self.expect_keyword_is(Keyword::AS)?;
19953
19954        let body = self.parse_conditional_statements(&[Keyword::END])?;
19955
19956        Ok(Statement::CreateProcedure {
19957            name,
19958            or_alter,
19959            params,
19960            language,
19961            body,
19962        })
19963    }
19964
19965    /// Parse a window specification.
19966    pub fn parse_window_spec(&mut self) -> Result<WindowSpec, ParserError> {
19967        let window_name = match &self.peek_token_ref().token {
19968            Token::Word(word) if word.keyword == Keyword::NoKeyword => {
19969                self.parse_optional_ident()?
19970            }
19971            _ => None,
19972        };
19973
19974        let partition_by = if self.parse_keywords(&[Keyword::PARTITION, Keyword::BY]) {
19975            self.parse_comma_separated(Parser::parse_expr)?
19976        } else {
19977            vec![]
19978        };
19979        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
19980            self.parse_comma_separated(Parser::parse_order_by_expr)?
19981        } else {
19982            vec![]
19983        };
19984
19985        let window_frame = if !self.consume_token(&Token::RParen) {
19986            let window_frame = self.parse_window_frame()?;
19987            self.expect_token(&Token::RParen)?;
19988            Some(window_frame)
19989        } else {
19990            None
19991        };
19992        Ok(WindowSpec {
19993            window_name,
19994            partition_by,
19995            order_by,
19996            window_frame,
19997        })
19998    }
19999
20000    /// Parse `CREATE TYPE` statement.
20001    pub fn parse_create_type(&mut self) -> Result<Statement, ParserError> {
20002        let name = self.parse_object_name(false)?;
20003
20004        // Check if we have AS keyword
20005        let has_as = self.parse_keyword(Keyword::AS);
20006
20007        if !has_as {
20008            // Two cases: CREATE TYPE name; or CREATE TYPE name (options);
20009            if self.consume_token(&Token::LParen) {
20010                // CREATE TYPE name (options) - SQL definition without AS
20011                let options = self.parse_create_type_sql_definition_options()?;
20012                self.expect_token(&Token::RParen)?;
20013                return Ok(Statement::CreateType {
20014                    name,
20015                    representation: Some(UserDefinedTypeRepresentation::SqlDefinition { options }),
20016                });
20017            }
20018
20019            // CREATE TYPE name; - no representation
20020            return Ok(Statement::CreateType {
20021                name,
20022                representation: None,
20023            });
20024        }
20025
20026        // We have AS keyword
20027        if self.parse_keyword(Keyword::ENUM) {
20028            // CREATE TYPE name AS ENUM (labels)
20029            self.parse_create_type_enum(name)
20030        } else if self.parse_keyword(Keyword::RANGE) {
20031            // CREATE TYPE name AS RANGE (options)
20032            self.parse_create_type_range(name)
20033        } else if self.consume_token(&Token::LParen) {
20034            // CREATE TYPE name AS (attributes) - Composite
20035            self.parse_create_type_composite(name)
20036        } else {
20037            self.expected_ref("ENUM, RANGE, or '(' after AS", self.peek_token_ref())
20038        }
20039    }
20040
20041    /// Parse remainder of `CREATE TYPE AS (attributes)` statement (composite type)
20042    ///
20043    /// See [PostgreSQL](https://www.postgresql.org/docs/current/sql-createtype.html)
20044    fn parse_create_type_composite(&mut self, name: ObjectName) -> Result<Statement, ParserError> {
20045        if self.consume_token(&Token::RParen) {
20046            // Empty composite type
20047            return Ok(Statement::CreateType {
20048                name,
20049                representation: Some(UserDefinedTypeRepresentation::Composite {
20050                    attributes: vec![],
20051                }),
20052            });
20053        }
20054
20055        let mut attributes = vec![];
20056        loop {
20057            let attr_name = self.parse_identifier()?;
20058            let attr_data_type = self.parse_data_type()?;
20059            let attr_collation = if self.parse_keyword(Keyword::COLLATE) {
20060                Some(self.parse_object_name(false)?)
20061            } else {
20062                None
20063            };
20064            attributes.push(UserDefinedTypeCompositeAttributeDef {
20065                name: attr_name,
20066                data_type: attr_data_type,
20067                collation: attr_collation,
20068            });
20069
20070            if !self.consume_token(&Token::Comma) {
20071                break;
20072            }
20073        }
20074        self.expect_token(&Token::RParen)?;
20075
20076        Ok(Statement::CreateType {
20077            name,
20078            representation: Some(UserDefinedTypeRepresentation::Composite { attributes }),
20079        })
20080    }
20081
20082    /// Parse remainder of `CREATE TYPE AS ENUM` statement (see [Statement::CreateType] and [Self::parse_create_type])
20083    ///
20084    /// See [PostgreSQL](https://www.postgresql.org/docs/current/sql-createtype.html)
20085    pub fn parse_create_type_enum(&mut self, name: ObjectName) -> Result<Statement, ParserError> {
20086        self.expect_token(&Token::LParen)?;
20087        let labels = self.parse_comma_separated0(|p| p.parse_identifier(), Token::RParen)?;
20088        self.expect_token(&Token::RParen)?;
20089
20090        Ok(Statement::CreateType {
20091            name,
20092            representation: Some(UserDefinedTypeRepresentation::Enum { labels }),
20093        })
20094    }
20095
20096    /// Parse remainder of `CREATE TYPE AS RANGE` statement
20097    ///
20098    /// See [PostgreSQL](https://www.postgresql.org/docs/current/sql-createtype.html)
20099    fn parse_create_type_range(&mut self, name: ObjectName) -> Result<Statement, ParserError> {
20100        self.expect_token(&Token::LParen)?;
20101        let options = self.parse_comma_separated0(|p| p.parse_range_option(), Token::RParen)?;
20102        self.expect_token(&Token::RParen)?;
20103
20104        Ok(Statement::CreateType {
20105            name,
20106            representation: Some(UserDefinedTypeRepresentation::Range { options }),
20107        })
20108    }
20109
20110    /// Parse a single range option for a `CREATE TYPE AS RANGE` statement
20111    fn parse_range_option(&mut self) -> Result<UserDefinedTypeRangeOption, ParserError> {
20112        let keyword = self.parse_one_of_keywords(&[
20113            Keyword::SUBTYPE,
20114            Keyword::SUBTYPE_OPCLASS,
20115            Keyword::COLLATION,
20116            Keyword::CANONICAL,
20117            Keyword::SUBTYPE_DIFF,
20118            Keyword::MULTIRANGE_TYPE_NAME,
20119        ]);
20120
20121        match keyword {
20122            Some(Keyword::SUBTYPE) => {
20123                self.expect_token(&Token::Eq)?;
20124                let data_type = self.parse_data_type()?;
20125                Ok(UserDefinedTypeRangeOption::Subtype(data_type))
20126            }
20127            Some(Keyword::SUBTYPE_OPCLASS) => {
20128                self.expect_token(&Token::Eq)?;
20129                let name = self.parse_object_name(false)?;
20130                Ok(UserDefinedTypeRangeOption::SubtypeOpClass(name))
20131            }
20132            Some(Keyword::COLLATION) => {
20133                self.expect_token(&Token::Eq)?;
20134                let name = self.parse_object_name(false)?;
20135                Ok(UserDefinedTypeRangeOption::Collation(name))
20136            }
20137            Some(Keyword::CANONICAL) => {
20138                self.expect_token(&Token::Eq)?;
20139                let name = self.parse_object_name(false)?;
20140                Ok(UserDefinedTypeRangeOption::Canonical(name))
20141            }
20142            Some(Keyword::SUBTYPE_DIFF) => {
20143                self.expect_token(&Token::Eq)?;
20144                let name = self.parse_object_name(false)?;
20145                Ok(UserDefinedTypeRangeOption::SubtypeDiff(name))
20146            }
20147            Some(Keyword::MULTIRANGE_TYPE_NAME) => {
20148                self.expect_token(&Token::Eq)?;
20149                let name = self.parse_object_name(false)?;
20150                Ok(UserDefinedTypeRangeOption::MultirangeTypeName(name))
20151            }
20152            _ => self.expected_ref("range option keyword", self.peek_token_ref()),
20153        }
20154    }
20155
20156    /// Parse SQL definition options for CREATE TYPE (options)
20157    fn parse_create_type_sql_definition_options(
20158        &mut self,
20159    ) -> Result<Vec<UserDefinedTypeSqlDefinitionOption>, ParserError> {
20160        self.parse_comma_separated0(|p| p.parse_sql_definition_option(), Token::RParen)
20161    }
20162
20163    /// Parse a single SQL definition option for CREATE TYPE (options)
20164    fn parse_sql_definition_option(
20165        &mut self,
20166    ) -> Result<UserDefinedTypeSqlDefinitionOption, ParserError> {
20167        let keyword = self.parse_one_of_keywords(&[
20168            Keyword::INPUT,
20169            Keyword::OUTPUT,
20170            Keyword::RECEIVE,
20171            Keyword::SEND,
20172            Keyword::TYPMOD_IN,
20173            Keyword::TYPMOD_OUT,
20174            Keyword::ANALYZE,
20175            Keyword::SUBSCRIPT,
20176            Keyword::INTERNALLENGTH,
20177            Keyword::PASSEDBYVALUE,
20178            Keyword::ALIGNMENT,
20179            Keyword::STORAGE,
20180            Keyword::LIKE,
20181            Keyword::CATEGORY,
20182            Keyword::PREFERRED,
20183            Keyword::DEFAULT,
20184            Keyword::ELEMENT,
20185            Keyword::DELIMITER,
20186            Keyword::COLLATABLE,
20187        ]);
20188
20189        match keyword {
20190            Some(Keyword::INPUT) => {
20191                self.expect_token(&Token::Eq)?;
20192                let name = self.parse_object_name(false)?;
20193                Ok(UserDefinedTypeSqlDefinitionOption::Input(name))
20194            }
20195            Some(Keyword::OUTPUT) => {
20196                self.expect_token(&Token::Eq)?;
20197                let name = self.parse_object_name(false)?;
20198                Ok(UserDefinedTypeSqlDefinitionOption::Output(name))
20199            }
20200            Some(Keyword::RECEIVE) => {
20201                self.expect_token(&Token::Eq)?;
20202                let name = self.parse_object_name(false)?;
20203                Ok(UserDefinedTypeSqlDefinitionOption::Receive(name))
20204            }
20205            Some(Keyword::SEND) => {
20206                self.expect_token(&Token::Eq)?;
20207                let name = self.parse_object_name(false)?;
20208                Ok(UserDefinedTypeSqlDefinitionOption::Send(name))
20209            }
20210            Some(Keyword::TYPMOD_IN) => {
20211                self.expect_token(&Token::Eq)?;
20212                let name = self.parse_object_name(false)?;
20213                Ok(UserDefinedTypeSqlDefinitionOption::TypmodIn(name))
20214            }
20215            Some(Keyword::TYPMOD_OUT) => {
20216                self.expect_token(&Token::Eq)?;
20217                let name = self.parse_object_name(false)?;
20218                Ok(UserDefinedTypeSqlDefinitionOption::TypmodOut(name))
20219            }
20220            Some(Keyword::ANALYZE) => {
20221                self.expect_token(&Token::Eq)?;
20222                let name = self.parse_object_name(false)?;
20223                Ok(UserDefinedTypeSqlDefinitionOption::Analyze(name))
20224            }
20225            Some(Keyword::SUBSCRIPT) => {
20226                self.expect_token(&Token::Eq)?;
20227                let name = self.parse_object_name(false)?;
20228                Ok(UserDefinedTypeSqlDefinitionOption::Subscript(name))
20229            }
20230            Some(Keyword::INTERNALLENGTH) => {
20231                self.expect_token(&Token::Eq)?;
20232                if self.parse_keyword(Keyword::VARIABLE) {
20233                    Ok(UserDefinedTypeSqlDefinitionOption::InternalLength(
20234                        UserDefinedTypeInternalLength::Variable,
20235                    ))
20236                } else {
20237                    let value = self.parse_literal_uint()?;
20238                    Ok(UserDefinedTypeSqlDefinitionOption::InternalLength(
20239                        UserDefinedTypeInternalLength::Fixed(value),
20240                    ))
20241                }
20242            }
20243            Some(Keyword::PASSEDBYVALUE) => Ok(UserDefinedTypeSqlDefinitionOption::PassedByValue),
20244            Some(Keyword::ALIGNMENT) => {
20245                self.expect_token(&Token::Eq)?;
20246                let align_keyword = self.parse_one_of_keywords(&[
20247                    Keyword::CHAR,
20248                    Keyword::INT2,
20249                    Keyword::INT4,
20250                    Keyword::DOUBLE,
20251                ]);
20252                match align_keyword {
20253                    Some(Keyword::CHAR) => Ok(UserDefinedTypeSqlDefinitionOption::Alignment(
20254                        Alignment::Char,
20255                    )),
20256                    Some(Keyword::INT2) => Ok(UserDefinedTypeSqlDefinitionOption::Alignment(
20257                        Alignment::Int2,
20258                    )),
20259                    Some(Keyword::INT4) => Ok(UserDefinedTypeSqlDefinitionOption::Alignment(
20260                        Alignment::Int4,
20261                    )),
20262                    Some(Keyword::DOUBLE) => Ok(UserDefinedTypeSqlDefinitionOption::Alignment(
20263                        Alignment::Double,
20264                    )),
20265                    _ => self.expected_ref(
20266                        "alignment value (char, int2, int4, or double)",
20267                        self.peek_token_ref(),
20268                    ),
20269                }
20270            }
20271            Some(Keyword::STORAGE) => {
20272                self.expect_token(&Token::Eq)?;
20273                let storage_keyword = self.parse_one_of_keywords(&[
20274                    Keyword::PLAIN,
20275                    Keyword::EXTERNAL,
20276                    Keyword::EXTENDED,
20277                    Keyword::MAIN,
20278                ]);
20279                match storage_keyword {
20280                    Some(Keyword::PLAIN) => Ok(UserDefinedTypeSqlDefinitionOption::Storage(
20281                        UserDefinedTypeStorage::Plain,
20282                    )),
20283                    Some(Keyword::EXTERNAL) => Ok(UserDefinedTypeSqlDefinitionOption::Storage(
20284                        UserDefinedTypeStorage::External,
20285                    )),
20286                    Some(Keyword::EXTENDED) => Ok(UserDefinedTypeSqlDefinitionOption::Storage(
20287                        UserDefinedTypeStorage::Extended,
20288                    )),
20289                    Some(Keyword::MAIN) => Ok(UserDefinedTypeSqlDefinitionOption::Storage(
20290                        UserDefinedTypeStorage::Main,
20291                    )),
20292                    _ => self.expected_ref(
20293                        "storage value (plain, external, extended, or main)",
20294                        self.peek_token_ref(),
20295                    ),
20296                }
20297            }
20298            Some(Keyword::LIKE) => {
20299                self.expect_token(&Token::Eq)?;
20300                let name = self.parse_object_name(false)?;
20301                Ok(UserDefinedTypeSqlDefinitionOption::Like(name))
20302            }
20303            Some(Keyword::CATEGORY) => {
20304                self.expect_token(&Token::Eq)?;
20305                let category_str = self.parse_literal_string()?;
20306                let category_char = category_str.chars().next().ok_or_else(|| {
20307                    ParserError::ParserError(
20308                        "CATEGORY value must be a single character".to_string(),
20309                    )
20310                })?;
20311                Ok(UserDefinedTypeSqlDefinitionOption::Category(category_char))
20312            }
20313            Some(Keyword::PREFERRED) => {
20314                self.expect_token(&Token::Eq)?;
20315                let value =
20316                    self.parse_keyword(Keyword::TRUE) || !self.parse_keyword(Keyword::FALSE);
20317                Ok(UserDefinedTypeSqlDefinitionOption::Preferred(value))
20318            }
20319            Some(Keyword::DEFAULT) => {
20320                self.expect_token(&Token::Eq)?;
20321                let expr = self.parse_expr()?;
20322                Ok(UserDefinedTypeSqlDefinitionOption::Default(expr))
20323            }
20324            Some(Keyword::ELEMENT) => {
20325                self.expect_token(&Token::Eq)?;
20326                let data_type = self.parse_data_type()?;
20327                Ok(UserDefinedTypeSqlDefinitionOption::Element(data_type))
20328            }
20329            Some(Keyword::DELIMITER) => {
20330                self.expect_token(&Token::Eq)?;
20331                let delimiter = self.parse_literal_string()?;
20332                Ok(UserDefinedTypeSqlDefinitionOption::Delimiter(delimiter))
20333            }
20334            Some(Keyword::COLLATABLE) => {
20335                self.expect_token(&Token::Eq)?;
20336                let value =
20337                    self.parse_keyword(Keyword::TRUE) || !self.parse_keyword(Keyword::FALSE);
20338                Ok(UserDefinedTypeSqlDefinitionOption::Collatable(value))
20339            }
20340            _ => self.expected_ref("SQL definition option keyword", self.peek_token_ref()),
20341        }
20342    }
20343
20344    fn parse_parenthesized_identifiers(&mut self) -> Result<Vec<Ident>, ParserError> {
20345        self.expect_token(&Token::LParen)?;
20346        let idents = self.parse_comma_separated0(|p| p.parse_identifier(), Token::RParen)?;
20347        self.expect_token(&Token::RParen)?;
20348        Ok(idents)
20349    }
20350
20351    fn parse_column_position(&mut self) -> Result<Option<MySQLColumnPosition>, ParserError> {
20352        if dialect_of!(self is MySqlDialect | GenericDialect) {
20353            if self.parse_keyword(Keyword::FIRST) {
20354                Ok(Some(MySQLColumnPosition::First))
20355            } else if self.parse_keyword(Keyword::AFTER) {
20356                let ident = self.parse_identifier()?;
20357                Ok(Some(MySQLColumnPosition::After(ident)))
20358            } else {
20359                Ok(None)
20360            }
20361        } else {
20362            Ok(None)
20363        }
20364    }
20365
20366    /// Parse [Statement::Print]
20367    fn parse_print(&mut self) -> Result<Statement, ParserError> {
20368        Ok(Statement::Print(PrintStatement {
20369            message: Box::new(self.parse_expr()?),
20370        }))
20371    }
20372
20373    /// Parse [Statement::WaitFor]
20374    ///
20375    /// See: <https://learn.microsoft.com/en-us/sql/t-sql/language-elements/waitfor-transact-sql>
20376    fn parse_waitfor(&mut self) -> Result<Statement, ParserError> {
20377        let wait_type = if self.parse_keyword(Keyword::DELAY) {
20378            WaitForType::Delay
20379        } else if self.parse_keyword(Keyword::TIME) {
20380            WaitForType::Time
20381        } else {
20382            return self.expected_ref("DELAY or TIME", self.peek_token_ref());
20383        };
20384        let expr = self.parse_expr()?;
20385        Ok(Statement::WaitFor(WaitForStatement { wait_type, expr }))
20386    }
20387
20388    /// Parse [Statement::Return]
20389    fn parse_return(&mut self) -> Result<Statement, ParserError> {
20390        match self.maybe_parse(|p| p.parse_expr())? {
20391            Some(expr) => Ok(Statement::Return(ReturnStatement {
20392                value: Some(ReturnStatementValue::Expr(expr)),
20393            })),
20394            None => Ok(Statement::Return(ReturnStatement { value: None })),
20395        }
20396    }
20397
20398    /// /// Parse a `EXPORT DATA` statement.
20399    ///
20400    /// See [Statement::ExportData]
20401    fn parse_export_data(&mut self) -> Result<Statement, ParserError> {
20402        self.expect_keywords(&[Keyword::EXPORT, Keyword::DATA])?;
20403
20404        let connection = if self.parse_keywords(&[Keyword::WITH, Keyword::CONNECTION]) {
20405            Some(self.parse_object_name(false)?)
20406        } else {
20407            None
20408        };
20409        self.expect_keyword(Keyword::OPTIONS)?;
20410        self.expect_token(&Token::LParen)?;
20411        let options = self.parse_comma_separated(|p| p.parse_sql_option())?;
20412        self.expect_token(&Token::RParen)?;
20413        self.expect_keyword(Keyword::AS)?;
20414        let query = self.parse_query()?;
20415        Ok(Statement::ExportData(ExportData {
20416            options,
20417            query,
20418            connection,
20419        }))
20420    }
20421
20422    fn parse_vacuum(&mut self) -> Result<Statement, ParserError> {
20423        self.expect_keyword(Keyword::VACUUM)?;
20424        let full = self.parse_keyword(Keyword::FULL);
20425        let sort_only = self.parse_keywords(&[Keyword::SORT, Keyword::ONLY]);
20426        let delete_only = self.parse_keywords(&[Keyword::DELETE, Keyword::ONLY]);
20427        let reindex = self.parse_keyword(Keyword::REINDEX);
20428        let recluster = self.parse_keyword(Keyword::RECLUSTER);
20429        let (table_name, threshold, boost) =
20430            match self.maybe_parse(|p| p.parse_object_name(false))? {
20431                Some(table_name) => {
20432                    let threshold = if self.parse_keyword(Keyword::TO) {
20433                        let value = self.parse_value()?;
20434                        self.expect_keyword(Keyword::PERCENT)?;
20435                        Some(value)
20436                    } else {
20437                        None
20438                    };
20439                    let boost = self.parse_keyword(Keyword::BOOST);
20440                    (Some(table_name), threshold, boost)
20441                }
20442                _ => (None, None, false),
20443            };
20444        Ok(Statement::Vacuum(VacuumStatement {
20445            full,
20446            sort_only,
20447            delete_only,
20448            reindex,
20449            recluster,
20450            table_name,
20451            threshold,
20452            boost,
20453        }))
20454    }
20455
20456    /// Consume the parser and return its underlying token buffer
20457    pub fn into_tokens(self) -> Vec<TokenWithSpan> {
20458        self.tokens
20459    }
20460
20461    /// Returns true if the next keyword indicates a sub query, i.e. SELECT or WITH
20462    fn peek_sub_query(&mut self) -> bool {
20463        self.peek_one_of_keywords(&[Keyword::SELECT, Keyword::WITH])
20464            .is_some()
20465    }
20466
20467    pub(crate) fn parse_show_stmt_options(&mut self) -> Result<ShowStatementOptions, ParserError> {
20468        let show_in;
20469        let mut filter_position = None;
20470        if self.dialect.supports_show_like_before_in() {
20471            if let Some(filter) = self.parse_show_statement_filter()? {
20472                filter_position = Some(ShowStatementFilterPosition::Infix(filter));
20473            }
20474            show_in = self.maybe_parse_show_stmt_in()?;
20475        } else {
20476            show_in = self.maybe_parse_show_stmt_in()?;
20477            if let Some(filter) = self.parse_show_statement_filter()? {
20478                filter_position = Some(ShowStatementFilterPosition::Suffix(filter));
20479            }
20480        }
20481        let starts_with = self.maybe_parse_show_stmt_starts_with()?;
20482        let limit = self.maybe_parse_show_stmt_limit()?;
20483        let from = self.maybe_parse_show_stmt_from()?;
20484        Ok(ShowStatementOptions {
20485            filter_position,
20486            show_in,
20487            starts_with,
20488            limit,
20489            limit_from: from,
20490        })
20491    }
20492
20493    fn maybe_parse_show_stmt_in(&mut self) -> Result<Option<ShowStatementIn>, ParserError> {
20494        let clause = match self.parse_one_of_keywords(&[Keyword::FROM, Keyword::IN]) {
20495            Some(Keyword::FROM) => ShowStatementInClause::FROM,
20496            Some(Keyword::IN) => ShowStatementInClause::IN,
20497            None => return Ok(None),
20498            _ => return self.expected_ref("FROM or IN", self.peek_token_ref()),
20499        };
20500
20501        let (parent_type, parent_name) = match self.parse_one_of_keywords(&[
20502            Keyword::ACCOUNT,
20503            Keyword::DATABASE,
20504            Keyword::SCHEMA,
20505            Keyword::TABLE,
20506            Keyword::VIEW,
20507        ]) {
20508            // If we see these next keywords it means we don't have a parent name
20509            Some(Keyword::DATABASE)
20510                if self.peek_keywords(&[Keyword::STARTS, Keyword::WITH])
20511                    | self.peek_keyword(Keyword::LIMIT) =>
20512            {
20513                (Some(ShowStatementInParentType::Database), None)
20514            }
20515            Some(Keyword::SCHEMA)
20516                if self.peek_keywords(&[Keyword::STARTS, Keyword::WITH])
20517                    | self.peek_keyword(Keyword::LIMIT) =>
20518            {
20519                (Some(ShowStatementInParentType::Schema), None)
20520            }
20521            Some(parent_kw) => {
20522                // The parent name here is still optional, for example:
20523                // SHOW TABLES IN ACCOUNT, so parsing the object name
20524                // may fail because the statement ends.
20525                let parent_name = self.maybe_parse(|p| p.parse_object_name(false))?;
20526                match parent_kw {
20527                    Keyword::ACCOUNT => (Some(ShowStatementInParentType::Account), parent_name),
20528                    Keyword::DATABASE => (Some(ShowStatementInParentType::Database), parent_name),
20529                    Keyword::SCHEMA => (Some(ShowStatementInParentType::Schema), parent_name),
20530                    Keyword::TABLE => (Some(ShowStatementInParentType::Table), parent_name),
20531                    Keyword::VIEW => (Some(ShowStatementInParentType::View), parent_name),
20532                    _ => {
20533                        return self.expected_ref(
20534                            "one of ACCOUNT, DATABASE, SCHEMA, TABLE or VIEW",
20535                            self.peek_token_ref(),
20536                        )
20537                    }
20538                }
20539            }
20540            None => {
20541                // Parsing MySQL style FROM tbl_name FROM db_name
20542                // which is equivalent to FROM tbl_name.db_name
20543                let mut parent_name = self.parse_object_name(false)?;
20544                if self
20545                    .parse_one_of_keywords(&[Keyword::FROM, Keyword::IN])
20546                    .is_some()
20547                {
20548                    parent_name
20549                        .0
20550                        .insert(0, ObjectNamePart::Identifier(self.parse_identifier()?));
20551                }
20552                (None, Some(parent_name))
20553            }
20554        };
20555
20556        Ok(Some(ShowStatementIn {
20557            clause,
20558            parent_type,
20559            parent_name,
20560        }))
20561    }
20562
20563    fn maybe_parse_show_stmt_starts_with(&mut self) -> Result<Option<ValueWithSpan>, ParserError> {
20564        if self.parse_keywords(&[Keyword::STARTS, Keyword::WITH]) {
20565            Ok(Some(self.parse_value()?))
20566        } else {
20567            Ok(None)
20568        }
20569    }
20570
20571    fn maybe_parse_show_stmt_limit(&mut self) -> Result<Option<Expr>, ParserError> {
20572        if self.parse_keyword(Keyword::LIMIT) {
20573            Ok(self.parse_limit()?)
20574        } else {
20575            Ok(None)
20576        }
20577    }
20578
20579    fn maybe_parse_show_stmt_from(&mut self) -> Result<Option<ValueWithSpan>, ParserError> {
20580        if self.parse_keyword(Keyword::FROM) {
20581            Ok(Some(self.parse_value()?))
20582        } else {
20583            Ok(None)
20584        }
20585    }
20586
20587    pub(crate) fn in_column_definition_state(&self) -> bool {
20588        matches!(self.state, ColumnDefinition)
20589    }
20590
20591    /// Parses options provided in key-value format.
20592    ///
20593    /// * `parenthesized` - true if the options are enclosed in parenthesis
20594    /// * `end_words` - a list of keywords that any of them indicates the end of the options section
20595    pub(crate) fn parse_key_value_options(
20596        &mut self,
20597        parenthesized: bool,
20598        end_words: &[Keyword],
20599    ) -> Result<KeyValueOptions, ParserError> {
20600        let mut options: Vec<KeyValueOption> = Vec::new();
20601        let mut delimiter = KeyValueOptionsDelimiter::Space;
20602        if parenthesized {
20603            self.expect_token(&Token::LParen)?;
20604        }
20605        loop {
20606            match self.next_token().token {
20607                Token::RParen => {
20608                    if parenthesized {
20609                        break;
20610                    } else {
20611                        return self.expected_ref(" another option or EOF", self.peek_token_ref());
20612                    }
20613                }
20614                Token::EOF | Token::SemiColon => break,
20615                Token::Comma => {
20616                    delimiter = KeyValueOptionsDelimiter::Comma;
20617                    continue;
20618                }
20619                Token::Word(w) if !end_words.contains(&w.keyword) => {
20620                    options.push(self.parse_key_value_option(&w)?)
20621                }
20622                Token::Word(w) if end_words.contains(&w.keyword) => {
20623                    self.prev_token();
20624                    break;
20625                }
20626                _ => {
20627                    return self.expected_ref(
20628                        "another option, EOF, SemiColon, Comma or ')'",
20629                        self.peek_token_ref(),
20630                    )
20631                }
20632            };
20633        }
20634
20635        Ok(KeyValueOptions { delimiter, options })
20636    }
20637
20638    /// Parses a `KEY = VALUE` construct based on the specified key
20639    pub(crate) fn parse_key_value_option(
20640        &mut self,
20641        key: &Word,
20642    ) -> Result<KeyValueOption, ParserError> {
20643        self.expect_token(&Token::Eq)?;
20644        let peeked_token = self.peek_token();
20645        match peeked_token.token {
20646            Token::SingleQuotedString(_) => Ok(KeyValueOption {
20647                option_name: key.value.clone(),
20648                option_value: KeyValueOptionKind::Single(self.parse_value()?),
20649            }),
20650            Token::Word(word)
20651                if word.keyword == Keyword::TRUE || word.keyword == Keyword::FALSE =>
20652            {
20653                Ok(KeyValueOption {
20654                    option_name: key.value.clone(),
20655                    option_value: KeyValueOptionKind::Single(self.parse_value()?),
20656                })
20657            }
20658            Token::Number(..) => Ok(KeyValueOption {
20659                option_name: key.value.clone(),
20660                option_value: KeyValueOptionKind::Single(self.parse_value()?),
20661            }),
20662            Token::Word(word) => {
20663                self.next_token();
20664                Ok(KeyValueOption {
20665                    option_name: key.value.clone(),
20666                    option_value: KeyValueOptionKind::Single(
20667                        Value::Placeholder(word.value.clone()).with_span(peeked_token.span),
20668                    ),
20669                })
20670            }
20671            Token::LParen => {
20672                // Can be a list of values or a list of key value properties.
20673                // Try to parse a list of values and if that fails, try to parse
20674                // a list of key-value properties.
20675                match self.maybe_parse(|parser| {
20676                    parser.expect_token(&Token::LParen)?;
20677                    let values = parser.parse_comma_separated0(|p| p.parse_value(), Token::RParen);
20678                    parser.expect_token(&Token::RParen)?;
20679                    values
20680                })? {
20681                    Some(values) => Ok(KeyValueOption {
20682                        option_name: key.value.clone(),
20683                        option_value: KeyValueOptionKind::Multi(values),
20684                    }),
20685                    None => Ok(KeyValueOption {
20686                        option_name: key.value.clone(),
20687                        option_value: KeyValueOptionKind::KeyValueOptions(Box::new(
20688                            self.parse_key_value_options(true, &[])?,
20689                        )),
20690                    }),
20691                }
20692            }
20693            _ => self.expected_ref("expected option value", self.peek_token_ref()),
20694        }
20695    }
20696
20697    /// Parses a RESET statement
20698    fn parse_reset(&mut self) -> Result<ResetStatement, ParserError> {
20699        if self.parse_keyword(Keyword::ALL) {
20700            return Ok(ResetStatement { reset: Reset::ALL });
20701        }
20702
20703        let obj = self.parse_object_name(false)?;
20704        Ok(ResetStatement {
20705            reset: Reset::ConfigurationParameter(obj),
20706        })
20707    }
20708}
20709
20710fn maybe_prefixed_expr(expr: Expr, prefix: Option<Ident>) -> Expr {
20711    if let Some(prefix) = prefix {
20712        Expr::Prefixed {
20713            prefix,
20714            value: Box::new(expr),
20715        }
20716    } else {
20717        expr
20718    }
20719}
20720
20721impl Word {
20722    /// Convert a reference to this word into an [`Ident`] by cloning the value.
20723    ///
20724    /// Use this method when you need to keep the original `Word` around.
20725    /// If you can consume the `Word`, prefer [`into_ident`](Self::into_ident) instead
20726    /// to avoid cloning.
20727    pub fn to_ident(&self, span: Span) -> Ident {
20728        Ident {
20729            value: self.value.clone(),
20730            quote_style: self.quote_style,
20731            span,
20732        }
20733    }
20734
20735    /// Convert this word into an [`Ident`] identifier, consuming the `Word`.
20736    ///
20737    /// This avoids cloning the string value. If you need to keep the original
20738    /// `Word`, use [`to_ident`](Self::to_ident) instead.
20739    pub fn into_ident(self, span: Span) -> Ident {
20740        Ident {
20741            value: self.value,
20742            quote_style: self.quote_style,
20743            span,
20744        }
20745    }
20746}
20747
20748#[cfg(test)]
20749mod tests {
20750    use crate::test_utils::{all_dialects, TestedDialects};
20751
20752    use super::*;
20753
20754    #[test]
20755    fn test_prev_index() {
20756        let sql = "SELECT version";
20757        all_dialects().run_parser_method(sql, |parser| {
20758            assert_eq!(parser.peek_token(), Token::make_keyword("SELECT"));
20759            assert_eq!(parser.next_token(), Token::make_keyword("SELECT"));
20760            parser.prev_token();
20761            assert_eq!(parser.next_token(), Token::make_keyword("SELECT"));
20762            assert_eq!(parser.next_token(), Token::make_word("version", None));
20763            parser.prev_token();
20764            assert_eq!(parser.peek_token(), Token::make_word("version", None));
20765            assert_eq!(parser.next_token(), Token::make_word("version", None));
20766            assert_eq!(parser.peek_token(), Token::EOF);
20767            parser.prev_token();
20768            assert_eq!(parser.next_token(), Token::make_word("version", None));
20769            assert_eq!(parser.next_token(), Token::EOF);
20770            assert_eq!(parser.next_token(), Token::EOF);
20771            parser.prev_token();
20772        });
20773    }
20774
20775    #[test]
20776    fn test_peek_tokens() {
20777        all_dialects().run_parser_method("SELECT foo AS bar FROM baz", |parser| {
20778            assert!(matches!(
20779                parser.peek_tokens(),
20780                [Token::Word(Word {
20781                    keyword: Keyword::SELECT,
20782                    ..
20783                })]
20784            ));
20785
20786            assert!(matches!(
20787                parser.peek_tokens(),
20788                [
20789                    Token::Word(Word {
20790                        keyword: Keyword::SELECT,
20791                        ..
20792                    }),
20793                    Token::Word(_),
20794                    Token::Word(Word {
20795                        keyword: Keyword::AS,
20796                        ..
20797                    }),
20798                ]
20799            ));
20800
20801            for _ in 0..4 {
20802                parser.next_token();
20803            }
20804
20805            assert!(matches!(
20806                parser.peek_tokens(),
20807                [
20808                    Token::Word(Word {
20809                        keyword: Keyword::FROM,
20810                        ..
20811                    }),
20812                    Token::Word(_),
20813                    Token::EOF,
20814                    Token::EOF,
20815                ]
20816            ))
20817        })
20818    }
20819
20820    #[cfg(test)]
20821    mod test_parse_data_type {
20822        use crate::ast::{
20823            CharLengthUnits, CharacterLength, DataType, ExactNumberInfo, ObjectName, TimezoneInfo,
20824        };
20825        use crate::dialect::{AnsiDialect, GenericDialect, PostgreSqlDialect};
20826        use crate::test_utils::TestedDialects;
20827
20828        macro_rules! test_parse_data_type {
20829            ($dialect:expr, $input:expr, $expected_type:expr $(,)?) => {{
20830                $dialect.run_parser_method(&*$input, |parser| {
20831                    let data_type = parser.parse_data_type().unwrap();
20832                    assert_eq!($expected_type, data_type);
20833                    assert_eq!($input.to_string(), data_type.to_string());
20834                });
20835            }};
20836        }
20837
20838        #[test]
20839        fn test_ansii_character_string_types() {
20840            // Character string types: <https://jakewheat.github.io/sql-overview/sql-2016-foundation-grammar.html#character-string-type>
20841            let dialect =
20842                TestedDialects::new(vec![Box::new(GenericDialect {}), Box::new(AnsiDialect {})]);
20843
20844            test_parse_data_type!(dialect, "CHARACTER", DataType::Character(None));
20845
20846            test_parse_data_type!(
20847                dialect,
20848                "CHARACTER(20)",
20849                DataType::Character(Some(CharacterLength::IntegerLength {
20850                    length: 20,
20851                    unit: None
20852                }))
20853            );
20854
20855            test_parse_data_type!(
20856                dialect,
20857                "CHARACTER(20 CHARACTERS)",
20858                DataType::Character(Some(CharacterLength::IntegerLength {
20859                    length: 20,
20860                    unit: Some(CharLengthUnits::Characters)
20861                }))
20862            );
20863
20864            test_parse_data_type!(
20865                dialect,
20866                "CHARACTER(20 OCTETS)",
20867                DataType::Character(Some(CharacterLength::IntegerLength {
20868                    length: 20,
20869                    unit: Some(CharLengthUnits::Octets)
20870                }))
20871            );
20872
20873            test_parse_data_type!(dialect, "CHAR", DataType::Char(None));
20874
20875            test_parse_data_type!(
20876                dialect,
20877                "CHAR(20)",
20878                DataType::Char(Some(CharacterLength::IntegerLength {
20879                    length: 20,
20880                    unit: None
20881                }))
20882            );
20883
20884            test_parse_data_type!(
20885                dialect,
20886                "CHAR(20 CHARACTERS)",
20887                DataType::Char(Some(CharacterLength::IntegerLength {
20888                    length: 20,
20889                    unit: Some(CharLengthUnits::Characters)
20890                }))
20891            );
20892
20893            test_parse_data_type!(
20894                dialect,
20895                "CHAR(20 OCTETS)",
20896                DataType::Char(Some(CharacterLength::IntegerLength {
20897                    length: 20,
20898                    unit: Some(CharLengthUnits::Octets)
20899                }))
20900            );
20901
20902            test_parse_data_type!(
20903                dialect,
20904                "CHARACTER VARYING(20)",
20905                DataType::CharacterVarying(Some(CharacterLength::IntegerLength {
20906                    length: 20,
20907                    unit: None
20908                }))
20909            );
20910
20911            test_parse_data_type!(
20912                dialect,
20913                "CHARACTER VARYING(20 CHARACTERS)",
20914                DataType::CharacterVarying(Some(CharacterLength::IntegerLength {
20915                    length: 20,
20916                    unit: Some(CharLengthUnits::Characters)
20917                }))
20918            );
20919
20920            test_parse_data_type!(
20921                dialect,
20922                "CHARACTER VARYING(20 OCTETS)",
20923                DataType::CharacterVarying(Some(CharacterLength::IntegerLength {
20924                    length: 20,
20925                    unit: Some(CharLengthUnits::Octets)
20926                }))
20927            );
20928
20929            test_parse_data_type!(
20930                dialect,
20931                "CHAR VARYING(20)",
20932                DataType::CharVarying(Some(CharacterLength::IntegerLength {
20933                    length: 20,
20934                    unit: None
20935                }))
20936            );
20937
20938            test_parse_data_type!(
20939                dialect,
20940                "CHAR VARYING(20 CHARACTERS)",
20941                DataType::CharVarying(Some(CharacterLength::IntegerLength {
20942                    length: 20,
20943                    unit: Some(CharLengthUnits::Characters)
20944                }))
20945            );
20946
20947            test_parse_data_type!(
20948                dialect,
20949                "CHAR VARYING(20 OCTETS)",
20950                DataType::CharVarying(Some(CharacterLength::IntegerLength {
20951                    length: 20,
20952                    unit: Some(CharLengthUnits::Octets)
20953                }))
20954            );
20955
20956            test_parse_data_type!(
20957                dialect,
20958                "VARCHAR(20)",
20959                DataType::Varchar(Some(CharacterLength::IntegerLength {
20960                    length: 20,
20961                    unit: None
20962                }))
20963            );
20964        }
20965
20966        #[test]
20967        fn test_ansii_character_large_object_types() {
20968            // Character large object types: <https://jakewheat.github.io/sql-overview/sql-2016-foundation-grammar.html#character-large-object-length>
20969            let dialect =
20970                TestedDialects::new(vec![Box::new(GenericDialect {}), Box::new(AnsiDialect {})]);
20971
20972            test_parse_data_type!(
20973                dialect,
20974                "CHARACTER LARGE OBJECT",
20975                DataType::CharacterLargeObject(None)
20976            );
20977            test_parse_data_type!(
20978                dialect,
20979                "CHARACTER LARGE OBJECT(20)",
20980                DataType::CharacterLargeObject(Some(20))
20981            );
20982
20983            test_parse_data_type!(
20984                dialect,
20985                "CHAR LARGE OBJECT",
20986                DataType::CharLargeObject(None)
20987            );
20988            test_parse_data_type!(
20989                dialect,
20990                "CHAR LARGE OBJECT(20)",
20991                DataType::CharLargeObject(Some(20))
20992            );
20993
20994            test_parse_data_type!(dialect, "CLOB", DataType::Clob(None));
20995            test_parse_data_type!(dialect, "CLOB(20)", DataType::Clob(Some(20)));
20996        }
20997
20998        #[test]
20999        fn test_parse_custom_types() {
21000            let dialect =
21001                TestedDialects::new(vec![Box::new(GenericDialect {}), Box::new(AnsiDialect {})]);
21002
21003            test_parse_data_type!(
21004                dialect,
21005                "GEOMETRY",
21006                DataType::Custom(ObjectName::from(vec!["GEOMETRY".into()]), vec![])
21007            );
21008
21009            test_parse_data_type!(
21010                dialect,
21011                "GEOMETRY(POINT)",
21012                DataType::Custom(
21013                    ObjectName::from(vec!["GEOMETRY".into()]),
21014                    vec!["POINT".to_string()]
21015                )
21016            );
21017
21018            test_parse_data_type!(
21019                dialect,
21020                "GEOMETRY(POINT, 4326)",
21021                DataType::Custom(
21022                    ObjectName::from(vec!["GEOMETRY".into()]),
21023                    vec!["POINT".to_string(), "4326".to_string()]
21024                )
21025            );
21026        }
21027
21028        #[test]
21029        fn test_ansii_exact_numeric_types() {
21030            // Exact numeric types: <https://jakewheat.github.io/sql-overview/sql-2016-foundation-grammar.html#exact-numeric-type>
21031            let dialect = TestedDialects::new(vec![
21032                Box::new(GenericDialect {}),
21033                Box::new(AnsiDialect {}),
21034                Box::new(PostgreSqlDialect {}),
21035            ]);
21036
21037            test_parse_data_type!(dialect, "NUMERIC", DataType::Numeric(ExactNumberInfo::None));
21038
21039            test_parse_data_type!(
21040                dialect,
21041                "NUMERIC(2)",
21042                DataType::Numeric(ExactNumberInfo::Precision(2))
21043            );
21044
21045            test_parse_data_type!(
21046                dialect,
21047                "NUMERIC(2,10)",
21048                DataType::Numeric(ExactNumberInfo::PrecisionAndScale(2, 10))
21049            );
21050
21051            test_parse_data_type!(dialect, "DECIMAL", DataType::Decimal(ExactNumberInfo::None));
21052
21053            test_parse_data_type!(
21054                dialect,
21055                "DECIMAL(2)",
21056                DataType::Decimal(ExactNumberInfo::Precision(2))
21057            );
21058
21059            test_parse_data_type!(
21060                dialect,
21061                "DECIMAL(2,10)",
21062                DataType::Decimal(ExactNumberInfo::PrecisionAndScale(2, 10))
21063            );
21064
21065            test_parse_data_type!(dialect, "DEC", DataType::Dec(ExactNumberInfo::None));
21066
21067            test_parse_data_type!(
21068                dialect,
21069                "DEC(2)",
21070                DataType::Dec(ExactNumberInfo::Precision(2))
21071            );
21072
21073            test_parse_data_type!(
21074                dialect,
21075                "DEC(2,10)",
21076                DataType::Dec(ExactNumberInfo::PrecisionAndScale(2, 10))
21077            );
21078
21079            // Test negative scale values.
21080            test_parse_data_type!(
21081                dialect,
21082                "NUMERIC(10,-2)",
21083                DataType::Numeric(ExactNumberInfo::PrecisionAndScale(10, -2))
21084            );
21085
21086            test_parse_data_type!(
21087                dialect,
21088                "DECIMAL(1000,-10)",
21089                DataType::Decimal(ExactNumberInfo::PrecisionAndScale(1000, -10))
21090            );
21091
21092            test_parse_data_type!(
21093                dialect,
21094                "DEC(5,-1000)",
21095                DataType::Dec(ExactNumberInfo::PrecisionAndScale(5, -1000))
21096            );
21097
21098            test_parse_data_type!(
21099                dialect,
21100                "NUMERIC(10,-5)",
21101                DataType::Numeric(ExactNumberInfo::PrecisionAndScale(10, -5))
21102            );
21103
21104            test_parse_data_type!(
21105                dialect,
21106                "DECIMAL(20,-10)",
21107                DataType::Decimal(ExactNumberInfo::PrecisionAndScale(20, -10))
21108            );
21109
21110            test_parse_data_type!(
21111                dialect,
21112                "DEC(5,-2)",
21113                DataType::Dec(ExactNumberInfo::PrecisionAndScale(5, -2))
21114            );
21115
21116            dialect.run_parser_method("NUMERIC(10,+5)", |parser| {
21117                let data_type = parser.parse_data_type().unwrap();
21118                assert_eq!(
21119                    DataType::Numeric(ExactNumberInfo::PrecisionAndScale(10, 5)),
21120                    data_type
21121                );
21122                // Note: Explicit '+' sign is not preserved in output, which is correct
21123                assert_eq!("NUMERIC(10,5)", data_type.to_string());
21124            });
21125        }
21126
21127        #[test]
21128        fn test_ansii_date_type() {
21129            // Datetime types: <https://jakewheat.github.io/sql-overview/sql-2016-foundation-grammar.html#datetime-type>
21130            let dialect =
21131                TestedDialects::new(vec![Box::new(GenericDialect {}), Box::new(AnsiDialect {})]);
21132
21133            test_parse_data_type!(dialect, "DATE", DataType::Date);
21134
21135            test_parse_data_type!(dialect, "TIME", DataType::Time(None, TimezoneInfo::None));
21136
21137            test_parse_data_type!(
21138                dialect,
21139                "TIME(6)",
21140                DataType::Time(Some(6), TimezoneInfo::None)
21141            );
21142
21143            test_parse_data_type!(
21144                dialect,
21145                "TIME WITH TIME ZONE",
21146                DataType::Time(None, TimezoneInfo::WithTimeZone)
21147            );
21148
21149            test_parse_data_type!(
21150                dialect,
21151                "TIME(6) WITH TIME ZONE",
21152                DataType::Time(Some(6), TimezoneInfo::WithTimeZone)
21153            );
21154
21155            test_parse_data_type!(
21156                dialect,
21157                "TIME WITHOUT TIME ZONE",
21158                DataType::Time(None, TimezoneInfo::WithoutTimeZone)
21159            );
21160
21161            test_parse_data_type!(
21162                dialect,
21163                "TIME(6) WITHOUT TIME ZONE",
21164                DataType::Time(Some(6), TimezoneInfo::WithoutTimeZone)
21165            );
21166
21167            test_parse_data_type!(
21168                dialect,
21169                "TIMESTAMP",
21170                DataType::Timestamp(None, TimezoneInfo::None)
21171            );
21172
21173            test_parse_data_type!(
21174                dialect,
21175                "TIMESTAMP(22)",
21176                DataType::Timestamp(Some(22), TimezoneInfo::None)
21177            );
21178
21179            test_parse_data_type!(
21180                dialect,
21181                "TIMESTAMP(22) WITH TIME ZONE",
21182                DataType::Timestamp(Some(22), TimezoneInfo::WithTimeZone)
21183            );
21184
21185            test_parse_data_type!(
21186                dialect,
21187                "TIMESTAMP(33) WITHOUT TIME ZONE",
21188                DataType::Timestamp(Some(33), TimezoneInfo::WithoutTimeZone)
21189            );
21190        }
21191    }
21192
21193    #[test]
21194    fn test_parse_schema_name() {
21195        // The expected name should be identical as the input name, that's why I don't receive both
21196        macro_rules! test_parse_schema_name {
21197            ($input:expr, $expected_name:expr $(,)?) => {{
21198                all_dialects().run_parser_method(&*$input, |parser| {
21199                    let schema_name = parser.parse_schema_name().unwrap();
21200                    // Validate that the structure is the same as expected
21201                    assert_eq!(schema_name, $expected_name);
21202                    // Validate that the input and the expected structure serialization are the same
21203                    assert_eq!(schema_name.to_string(), $input.to_string());
21204                });
21205            }};
21206        }
21207
21208        let dummy_name = ObjectName::from(vec![Ident::new("dummy_name")]);
21209        let dummy_authorization = Ident::new("dummy_authorization");
21210
21211        test_parse_schema_name!(
21212            format!("{dummy_name}"),
21213            SchemaName::Simple(dummy_name.clone())
21214        );
21215
21216        test_parse_schema_name!(
21217            format!("AUTHORIZATION {dummy_authorization}"),
21218            SchemaName::UnnamedAuthorization(dummy_authorization.clone()),
21219        );
21220        test_parse_schema_name!(
21221            format!("{dummy_name} AUTHORIZATION {dummy_authorization}"),
21222            SchemaName::NamedAuthorization(dummy_name.clone(), dummy_authorization.clone()),
21223        );
21224    }
21225
21226    #[test]
21227    fn mysql_parse_index_table_constraint() {
21228        macro_rules! test_parse_table_constraint {
21229            ($dialect:expr, $input:expr, $expected:expr $(,)?) => {{
21230                $dialect.run_parser_method(&*$input, |parser| {
21231                    let constraint = parser.parse_optional_table_constraint().unwrap().unwrap();
21232                    // Validate that the structure is the same as expected
21233                    assert_eq!(constraint, $expected);
21234                    // Validate that the input and the expected structure serialization are the same
21235                    assert_eq!(constraint.to_string(), $input.to_string());
21236                });
21237            }};
21238        }
21239
21240        fn mk_expected_col(name: &str) -> IndexColumn {
21241            IndexColumn {
21242                column: OrderByExpr {
21243                    expr: Expr::Identifier(name.into()),
21244                    options: OrderByOptions {
21245                        sort: None,
21246                        nulls_first: None,
21247                    },
21248                    with_fill: None,
21249                },
21250                operator_class: None,
21251            }
21252        }
21253
21254        let dialect =
21255            TestedDialects::new(vec![Box::new(GenericDialect {}), Box::new(MySqlDialect {})]);
21256
21257        test_parse_table_constraint!(
21258            dialect,
21259            "INDEX (c1)",
21260            IndexConstraint {
21261                display_as_key: false,
21262                name: None,
21263                index_type: None,
21264                columns: vec![mk_expected_col("c1")],
21265                index_options: vec![],
21266            }
21267            .into()
21268        );
21269
21270        test_parse_table_constraint!(
21271            dialect,
21272            "KEY (c1)",
21273            IndexConstraint {
21274                display_as_key: true,
21275                name: None,
21276                index_type: None,
21277                columns: vec![mk_expected_col("c1")],
21278                index_options: vec![],
21279            }
21280            .into()
21281        );
21282
21283        test_parse_table_constraint!(
21284            dialect,
21285            "INDEX 'index' (c1, c2)",
21286            TableConstraint::Index(IndexConstraint {
21287                display_as_key: false,
21288                name: Some(Ident::with_quote('\'', "index")),
21289                index_type: None,
21290                columns: vec![mk_expected_col("c1"), mk_expected_col("c2")],
21291                index_options: vec![],
21292            })
21293        );
21294
21295        test_parse_table_constraint!(
21296            dialect,
21297            "INDEX USING BTREE (c1)",
21298            IndexConstraint {
21299                display_as_key: false,
21300                name: None,
21301                index_type: Some(IndexType::BTree),
21302                columns: vec![mk_expected_col("c1")],
21303                index_options: vec![],
21304            }
21305            .into()
21306        );
21307
21308        test_parse_table_constraint!(
21309            dialect,
21310            "INDEX USING HASH (c1)",
21311            IndexConstraint {
21312                display_as_key: false,
21313                name: None,
21314                index_type: Some(IndexType::Hash),
21315                columns: vec![mk_expected_col("c1")],
21316                index_options: vec![],
21317            }
21318            .into()
21319        );
21320
21321        test_parse_table_constraint!(
21322            dialect,
21323            "INDEX idx_name USING BTREE (c1)",
21324            IndexConstraint {
21325                display_as_key: false,
21326                name: Some(Ident::new("idx_name")),
21327                index_type: Some(IndexType::BTree),
21328                columns: vec![mk_expected_col("c1")],
21329                index_options: vec![],
21330            }
21331            .into()
21332        );
21333
21334        test_parse_table_constraint!(
21335            dialect,
21336            "INDEX idx_name USING HASH (c1)",
21337            IndexConstraint {
21338                display_as_key: false,
21339                name: Some(Ident::new("idx_name")),
21340                index_type: Some(IndexType::Hash),
21341                columns: vec![mk_expected_col("c1")],
21342                index_options: vec![],
21343            }
21344            .into()
21345        );
21346    }
21347
21348    #[test]
21349    fn test_tokenizer_error_loc() {
21350        let sql = "foo '";
21351        let ast = Parser::parse_sql(&GenericDialect, sql);
21352        assert_eq!(
21353            ast,
21354            Err(ParserError::TokenizerError(
21355                "Unterminated string literal at Line: 1, Column: 5".to_string()
21356            ))
21357        );
21358    }
21359
21360    #[test]
21361    fn test_parser_error_loc() {
21362        let sql = "SELECT this is a syntax error";
21363        let ast = Parser::parse_sql(&GenericDialect, sql);
21364        assert_eq!(
21365            ast,
21366            Err(ParserError::ParserError(
21367                "Expected: [NOT] NULL | TRUE | FALSE | DISTINCT | [form] NORMALIZED FROM after IS, found: a at Line: 1, Column: 16"
21368                    .to_string()
21369            ))
21370        );
21371    }
21372
21373    #[test]
21374    fn test_nested_explain_error() {
21375        let sql = "EXPLAIN EXPLAIN SELECT 1";
21376        let ast = Parser::parse_sql(&GenericDialect, sql);
21377        assert_eq!(
21378            ast,
21379            Err(ParserError::ParserError(
21380                "Explain must be root of the plan".to_string()
21381            ))
21382        );
21383    }
21384
21385    #[test]
21386    fn test_parse_multipart_identifier_positive() {
21387        let dialect = TestedDialects::new(vec![Box::new(GenericDialect {})]);
21388
21389        // parse multipart with quotes
21390        let expected = vec![
21391            Ident {
21392                value: "CATALOG".to_string(),
21393                quote_style: None,
21394                span: Span::empty(),
21395            },
21396            Ident {
21397                value: "F(o)o. \"bar".to_string(),
21398                quote_style: Some('"'),
21399                span: Span::empty(),
21400            },
21401            Ident {
21402                value: "table".to_string(),
21403                quote_style: None,
21404                span: Span::empty(),
21405            },
21406        ];
21407        dialect.run_parser_method(r#"CATALOG."F(o)o. ""bar".table"#, |parser| {
21408            let actual = parser.parse_multipart_identifier().unwrap();
21409            assert_eq!(expected, actual);
21410        });
21411
21412        // allow whitespace between ident parts
21413        let expected = vec![
21414            Ident {
21415                value: "CATALOG".to_string(),
21416                quote_style: None,
21417                span: Span::empty(),
21418            },
21419            Ident {
21420                value: "table".to_string(),
21421                quote_style: None,
21422                span: Span::empty(),
21423            },
21424        ];
21425        dialect.run_parser_method("CATALOG . table", |parser| {
21426            let actual = parser.parse_multipart_identifier().unwrap();
21427            assert_eq!(expected, actual);
21428        });
21429    }
21430
21431    #[test]
21432    fn test_parse_multipart_identifier_negative() {
21433        macro_rules! test_parse_multipart_identifier_error {
21434            ($input:expr, $expected_err:expr $(,)?) => {{
21435                all_dialects().run_parser_method(&*$input, |parser| {
21436                    let actual_err = parser.parse_multipart_identifier().unwrap_err();
21437                    assert_eq!(actual_err.to_string(), $expected_err);
21438                });
21439            }};
21440        }
21441
21442        test_parse_multipart_identifier_error!(
21443            "",
21444            "sql parser error: Empty input when parsing identifier",
21445        );
21446
21447        test_parse_multipart_identifier_error!(
21448            "*schema.table",
21449            "sql parser error: Unexpected token in identifier: *",
21450        );
21451
21452        test_parse_multipart_identifier_error!(
21453            "schema.table*",
21454            "sql parser error: Unexpected token in identifier: *",
21455        );
21456
21457        test_parse_multipart_identifier_error!(
21458            "schema.table.",
21459            "sql parser error: Trailing period in identifier",
21460        );
21461
21462        test_parse_multipart_identifier_error!(
21463            "schema.*",
21464            "sql parser error: Unexpected token following period in identifier: *",
21465        );
21466    }
21467
21468    #[test]
21469    fn test_mysql_partition_selection() {
21470        let sql = "SELECT * FROM employees PARTITION (p0, p2)";
21471        let expected = vec!["p0", "p2"];
21472
21473        let ast: Vec<Statement> = Parser::parse_sql(&MySqlDialect {}, sql).unwrap();
21474        assert_eq!(ast.len(), 1);
21475        if let Statement::Query(v) = &ast[0] {
21476            if let SetExpr::Select(select) = &*v.body {
21477                assert_eq!(select.from.len(), 1);
21478                let from: &TableWithJoins = &select.from[0];
21479                let table_factor = &from.relation;
21480                if let TableFactor::Table { partitions, .. } = table_factor {
21481                    let actual: Vec<&str> = partitions
21482                        .iter()
21483                        .map(|ident| ident.value.as_str())
21484                        .collect();
21485                    assert_eq!(expected, actual);
21486                }
21487            }
21488        } else {
21489            panic!("fail to parse mysql partition selection");
21490        }
21491    }
21492
21493    #[test]
21494    fn test_replace_into_placeholders() {
21495        let sql = "REPLACE INTO t (a) VALUES (&a)";
21496
21497        assert!(Parser::parse_sql(&GenericDialect {}, sql).is_err());
21498    }
21499
21500    #[test]
21501    fn test_replace_into_set_placeholder() {
21502        let sql = "REPLACE INTO t SET ?";
21503
21504        assert!(Parser::parse_sql(&GenericDialect {}, sql).is_err());
21505    }
21506
21507    #[test]
21508    fn test_replace_incomplete() {
21509        let sql = r#"REPLACE"#;
21510
21511        assert!(Parser::parse_sql(&MySqlDialect {}, sql).is_err());
21512    }
21513
21514    #[test]
21515    fn test_placeholder_invalid_whitespace() {
21516        for w in ["  ", "/*invalid*/"] {
21517            let sql = format!("\nSELECT\n  :{w}fooBar");
21518            assert!(Parser::parse_sql(&GenericDialect, &sql).is_err());
21519        }
21520    }
21521}