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                        break;
514                    }
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                Keyword::SECURITY => self.parse_security_label().map(Into::into),
723                _ => self.expected("an SQL statement", next_token),
724            },
725            Token::LParen => {
726                self.prev_token();
727                self.parse_query().map(Into::into)
728            }
729            _ => self.expected("an SQL statement", next_token),
730        }
731    }
732
733    /// Parse a `CASE` statement.
734    ///
735    /// See [Statement::Case]
736    pub fn parse_case_stmt(&mut self) -> Result<CaseStatement, ParserError> {
737        let case_token = self.expect_keyword(Keyword::CASE)?;
738
739        let match_expr = if self.peek_keyword(Keyword::WHEN) {
740            None
741        } else {
742            Some(self.parse_expr()?)
743        };
744
745        self.expect_keyword_is(Keyword::WHEN)?;
746        let when_blocks = self.parse_keyword_separated(Keyword::WHEN, |parser| {
747            parser.parse_conditional_statement_block(&[Keyword::WHEN, Keyword::ELSE, Keyword::END])
748        })?;
749
750        let else_block = if self.parse_keyword(Keyword::ELSE) {
751            Some(self.parse_conditional_statement_block(&[Keyword::END])?)
752        } else {
753            None
754        };
755
756        let mut end_case_token = self.expect_keyword(Keyword::END)?;
757        if self.peek_keyword(Keyword::CASE) {
758            end_case_token = self.expect_keyword(Keyword::CASE)?;
759        }
760
761        Ok(CaseStatement {
762            case_token: AttachedToken(case_token),
763            match_expr,
764            when_blocks,
765            else_block,
766            end_case_token: AttachedToken(end_case_token),
767        })
768    }
769
770    /// Parse an `IF` statement.
771    ///
772    /// See [Statement::If]
773    pub fn parse_if_stmt(&mut self) -> Result<IfStatement, ParserError> {
774        self.expect_keyword_is(Keyword::IF)?;
775        let if_block = self.parse_conditional_statement_block(&[
776            Keyword::ELSE,
777            Keyword::ELSEIF,
778            Keyword::END,
779        ])?;
780
781        let elseif_blocks = if self.parse_keyword(Keyword::ELSEIF) {
782            self.parse_keyword_separated(Keyword::ELSEIF, |parser| {
783                parser.parse_conditional_statement_block(&[
784                    Keyword::ELSEIF,
785                    Keyword::ELSE,
786                    Keyword::END,
787                ])
788            })?
789        } else {
790            vec![]
791        };
792
793        let else_block = if self.parse_keyword(Keyword::ELSE) {
794            Some(self.parse_conditional_statement_block(&[Keyword::END])?)
795        } else {
796            None
797        };
798
799        self.expect_keyword_is(Keyword::END)?;
800        let end_token = self.expect_keyword(Keyword::IF)?;
801
802        Ok(IfStatement {
803            if_block,
804            elseif_blocks,
805            else_block,
806            end_token: Some(AttachedToken(end_token)),
807        })
808    }
809
810    /// Parse a `WHILE` statement.
811    ///
812    /// See [Statement::While]
813    fn parse_while(&mut self) -> Result<WhileStatement, ParserError> {
814        self.expect_keyword_is(Keyword::WHILE)?;
815        let while_block = self.parse_conditional_statement_block(&[Keyword::END])?;
816
817        Ok(WhileStatement { while_block })
818    }
819
820    /// Parses an expression and associated list of statements
821    /// belonging to a conditional statement like `IF` or `WHEN` or `WHILE`.
822    ///
823    /// Example:
824    /// ```sql
825    /// IF condition THEN statement1; statement2;
826    /// ```
827    fn parse_conditional_statement_block(
828        &mut self,
829        terminal_keywords: &[Keyword],
830    ) -> Result<ConditionalStatementBlock, ParserError> {
831        let start_token = self.get_current_token().clone(); // self.expect_keyword(keyword)?;
832        let mut then_token = None;
833
834        let condition = match &start_token.token {
835            Token::Word(w) if w.keyword == Keyword::ELSE => None,
836            Token::Word(w) if w.keyword == Keyword::WHILE => {
837                let expr = self.parse_expr()?;
838                Some(expr)
839            }
840            _ => {
841                let expr = self.parse_expr()?;
842                then_token = Some(AttachedToken(self.expect_keyword(Keyword::THEN)?));
843                Some(expr)
844            }
845        };
846
847        let conditional_statements = self.parse_conditional_statements(terminal_keywords)?;
848
849        Ok(ConditionalStatementBlock {
850            start_token: AttachedToken(start_token),
851            condition,
852            then_token,
853            conditional_statements,
854        })
855    }
856
857    /// Parse a BEGIN/END block or a sequence of statements
858    /// This could be inside of a conditional (IF, CASE, WHILE etc.) or an object body defined optionally BEGIN/END and one or more statements.
859    pub(crate) fn parse_conditional_statements(
860        &mut self,
861        terminal_keywords: &[Keyword],
862    ) -> Result<ConditionalStatements, ParserError> {
863        let conditional_statements = if self.peek_keyword(Keyword::BEGIN) {
864            let begin_token = self.expect_keyword(Keyword::BEGIN)?;
865            let statements = self.parse_statement_list(terminal_keywords)?;
866            let end_token = self.expect_keyword(Keyword::END)?;
867
868            ConditionalStatements::BeginEnd(BeginEndStatements {
869                begin_token: AttachedToken(begin_token),
870                statements,
871                end_token: AttachedToken(end_token),
872            })
873        } else {
874            ConditionalStatements::Sequence {
875                statements: self.parse_statement_list(terminal_keywords)?,
876            }
877        };
878        Ok(conditional_statements)
879    }
880
881    /// Parse a `RAISE` statement.
882    ///
883    /// See [Statement::Raise]
884    pub fn parse_raise_stmt(&mut self) -> Result<RaiseStatement, ParserError> {
885        self.expect_keyword_is(Keyword::RAISE)?;
886
887        let value = if self.parse_keywords(&[Keyword::USING, Keyword::MESSAGE]) {
888            self.expect_token(&Token::Eq)?;
889            Some(RaiseStatementValue::UsingMessage(self.parse_expr()?))
890        } else {
891            self.maybe_parse(|parser| parser.parse_expr().map(RaiseStatementValue::Expr))?
892        };
893
894        Ok(RaiseStatement { value })
895    }
896    /// Parse a COMMENT statement.
897    ///
898    /// See [Statement::Comment]
899    pub fn parse_comment(&mut self) -> Result<Statement, ParserError> {
900        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
901
902        self.expect_keyword_is(Keyword::ON)?;
903        let token = self.next_token();
904
905        let (object_type, object_name) = match token.token {
906            Token::Word(w) if w.keyword == Keyword::COLLATION => {
907                (CommentObject::Collation, self.parse_object_name(false)?)
908            }
909            Token::Word(w) if w.keyword == Keyword::COLUMN => {
910                (CommentObject::Column, self.parse_object_name(false)?)
911            }
912            Token::Word(w) if w.keyword == Keyword::DATABASE => {
913                (CommentObject::Database, self.parse_object_name(false)?)
914            }
915            Token::Word(w) if w.keyword == Keyword::DOMAIN => {
916                (CommentObject::Domain, self.parse_object_name(false)?)
917            }
918            Token::Word(w) if w.keyword == Keyword::EXTENSION => {
919                (CommentObject::Extension, self.parse_object_name(false)?)
920            }
921            Token::Word(w) if w.keyword == Keyword::FUNCTION => {
922                (CommentObject::Function, self.parse_object_name(false)?)
923            }
924            Token::Word(w) if w.keyword == Keyword::INDEX => {
925                (CommentObject::Index, self.parse_object_name(false)?)
926            }
927            Token::Word(w) if w.keyword == Keyword::MATERIALIZED => {
928                self.expect_keyword_is(Keyword::VIEW)?;
929                (
930                    CommentObject::MaterializedView,
931                    self.parse_object_name(false)?,
932                )
933            }
934            Token::Word(w) if w.keyword == Keyword::PROCEDURE => {
935                (CommentObject::Procedure, self.parse_object_name(false)?)
936            }
937            Token::Word(w) if w.keyword == Keyword::ROLE => {
938                (CommentObject::Role, self.parse_object_name(false)?)
939            }
940            Token::Word(w) if w.keyword == Keyword::SCHEMA => {
941                (CommentObject::Schema, self.parse_object_name(false)?)
942            }
943            Token::Word(w) if w.keyword == Keyword::SEQUENCE => {
944                (CommentObject::Sequence, self.parse_object_name(false)?)
945            }
946            Token::Word(w) if w.keyword == Keyword::TABLE => {
947                (CommentObject::Table, self.parse_object_name(false)?)
948            }
949            Token::Word(w) if w.keyword == Keyword::TYPE => {
950                (CommentObject::Type, self.parse_object_name(false)?)
951            }
952            Token::Word(w) if w.keyword == Keyword::USER => {
953                (CommentObject::User, self.parse_object_name(false)?)
954            }
955            Token::Word(w) if w.keyword == Keyword::VIEW => {
956                (CommentObject::View, self.parse_object_name(false)?)
957            }
958            _ => self.expected("comment object_type", token)?,
959        };
960
961        self.expect_keyword_is(Keyword::IS)?;
962        let comment = if self.parse_keyword(Keyword::NULL) {
963            None
964        } else {
965            Some(self.parse_literal_string()?)
966        };
967        Ok(Statement::Comment {
968            object_type,
969            object_name,
970            comment,
971            if_exists,
972        })
973    }
974
975    /// Parse `FLUSH` statement.
976    pub fn parse_flush(&mut self) -> Result<Statement, ParserError> {
977        let mut channel = None;
978        let mut tables: Vec<ObjectName> = vec![];
979        let mut read_lock = false;
980        let mut export = false;
981
982        if !dialect_of!(self is MySqlDialect | GenericDialect) {
983            return parser_err!(
984                "Unsupported statement FLUSH",
985                self.peek_token_ref().span.start
986            );
987        }
988
989        let location = if self.parse_keyword(Keyword::NO_WRITE_TO_BINLOG) {
990            Some(FlushLocation::NoWriteToBinlog)
991        } else if self.parse_keyword(Keyword::LOCAL) {
992            Some(FlushLocation::Local)
993        } else {
994            None
995        };
996
997        let object_type = if self.parse_keywords(&[Keyword::BINARY, Keyword::LOGS]) {
998            FlushType::BinaryLogs
999        } else if self.parse_keywords(&[Keyword::ENGINE, Keyword::LOGS]) {
1000            FlushType::EngineLogs
1001        } else if self.parse_keywords(&[Keyword::ERROR, Keyword::LOGS]) {
1002            FlushType::ErrorLogs
1003        } else if self.parse_keywords(&[Keyword::GENERAL, Keyword::LOGS]) {
1004            FlushType::GeneralLogs
1005        } else if self.parse_keywords(&[Keyword::HOSTS]) {
1006            FlushType::Hosts
1007        } else if self.parse_keyword(Keyword::PRIVILEGES) {
1008            FlushType::Privileges
1009        } else if self.parse_keyword(Keyword::OPTIMIZER_COSTS) {
1010            FlushType::OptimizerCosts
1011        } else if self.parse_keywords(&[Keyword::RELAY, Keyword::LOGS]) {
1012            if self.parse_keywords(&[Keyword::FOR, Keyword::CHANNEL]) {
1013                channel = Some(self.parse_object_name(false).unwrap().to_string());
1014            }
1015            FlushType::RelayLogs
1016        } else if self.parse_keywords(&[Keyword::SLOW, Keyword::LOGS]) {
1017            FlushType::SlowLogs
1018        } else if self.parse_keyword(Keyword::STATUS) {
1019            FlushType::Status
1020        } else if self.parse_keyword(Keyword::USER_RESOURCES) {
1021            FlushType::UserResources
1022        } else if self.parse_keywords(&[Keyword::LOGS]) {
1023            FlushType::Logs
1024        } else if self.parse_keywords(&[Keyword::TABLES]) {
1025            loop {
1026                let next_token = self.next_token();
1027                match &next_token.token {
1028                    Token::Word(w) => match w.keyword {
1029                        Keyword::WITH => {
1030                            read_lock = self.parse_keywords(&[Keyword::READ, Keyword::LOCK]);
1031                        }
1032                        Keyword::FOR => {
1033                            export = self.parse_keyword(Keyword::EXPORT);
1034                        }
1035                        Keyword::NoKeyword => {
1036                            self.prev_token();
1037                            tables = self.parse_comma_separated(|p| p.parse_object_name(false))?;
1038                        }
1039                        _ => {}
1040                    },
1041                    _ => {
1042                        break;
1043                    }
1044                }
1045            }
1046
1047            FlushType::Tables
1048        } else {
1049            return self.expected_ref(
1050                "BINARY LOGS, ENGINE LOGS, ERROR LOGS, GENERAL LOGS, HOSTS, LOGS, PRIVILEGES, OPTIMIZER_COSTS,\
1051                 RELAY LOGS [FOR CHANNEL channel], SLOW LOGS, STATUS, USER_RESOURCES",
1052                self.peek_token_ref(),
1053            );
1054        };
1055
1056        Ok(Statement::Flush {
1057            object_type,
1058            location,
1059            channel,
1060            read_lock,
1061            export,
1062            tables,
1063        })
1064    }
1065
1066    /// Parse `MSCK` statement.
1067    pub fn parse_msck(&mut self) -> Result<Msck, ParserError> {
1068        let repair = self.parse_keyword(Keyword::REPAIR);
1069        self.expect_keyword_is(Keyword::TABLE)?;
1070        let table_name = self.parse_object_name(false)?;
1071        let partition_action = self
1072            .maybe_parse(|parser| {
1073                let pa = match parser.parse_one_of_keywords(&[
1074                    Keyword::ADD,
1075                    Keyword::DROP,
1076                    Keyword::SYNC,
1077                ]) {
1078                    Some(Keyword::ADD) => Some(AddDropSync::ADD),
1079                    Some(Keyword::DROP) => Some(AddDropSync::DROP),
1080                    Some(Keyword::SYNC) => Some(AddDropSync::SYNC),
1081                    _ => None,
1082                };
1083                parser.expect_keyword_is(Keyword::PARTITIONS)?;
1084                Ok(pa)
1085            })?
1086            .unwrap_or_default();
1087        Ok(Msck {
1088            repair,
1089            table_name,
1090            partition_action,
1091        })
1092    }
1093
1094    /// Parse `TRUNCATE` statement.
1095    pub fn parse_truncate(&mut self) -> Result<Truncate, ParserError> {
1096        let table = self.parse_keyword(Keyword::TABLE);
1097        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
1098
1099        let table_names = self.parse_comma_separated(|p| {
1100            let only = p.parse_keyword(Keyword::ONLY);
1101            let name = p.parse_object_name(false)?;
1102            let has_asterisk = p.consume_token(&Token::Mul);
1103            Ok(TruncateTableTarget {
1104                name,
1105                only,
1106                has_asterisk,
1107            })
1108        })?;
1109
1110        let mut partitions = None;
1111        if self.parse_keyword(Keyword::PARTITION) {
1112            self.expect_token(&Token::LParen)?;
1113            partitions = Some(self.parse_comma_separated(Parser::parse_expr)?);
1114            self.expect_token(&Token::RParen)?;
1115        }
1116
1117        let mut identity = None;
1118        let mut cascade = None;
1119
1120        if dialect_of!(self is PostgreSqlDialect | GenericDialect) {
1121            identity = if self.parse_keywords(&[Keyword::RESTART, Keyword::IDENTITY]) {
1122                Some(TruncateIdentityOption::Restart)
1123            } else if self.parse_keywords(&[Keyword::CONTINUE, Keyword::IDENTITY]) {
1124                Some(TruncateIdentityOption::Continue)
1125            } else {
1126                None
1127            };
1128
1129            cascade = self.parse_cascade_option();
1130        };
1131
1132        let on_cluster = self.parse_optional_on_cluster()?;
1133
1134        Ok(Truncate {
1135            table_names,
1136            partitions,
1137            table,
1138            if_exists,
1139            identity,
1140            cascade,
1141            on_cluster,
1142        })
1143    }
1144
1145    fn parse_cascade_option(&mut self) -> Option<CascadeOption> {
1146        if self.parse_keyword(Keyword::CASCADE) {
1147            Some(CascadeOption::Cascade)
1148        } else if self.parse_keyword(Keyword::RESTRICT) {
1149            Some(CascadeOption::Restrict)
1150        } else {
1151            None
1152        }
1153    }
1154
1155    /// Parse options for `ATTACH DUCKDB DATABASE` statement.
1156    pub fn parse_attach_duckdb_database_options(
1157        &mut self,
1158    ) -> Result<Vec<AttachDuckDBDatabaseOption>, ParserError> {
1159        if !self.consume_token(&Token::LParen) {
1160            return Ok(vec![]);
1161        }
1162
1163        let mut options = vec![];
1164        loop {
1165            if self.parse_keyword(Keyword::READ_ONLY) {
1166                let boolean = if self.parse_keyword(Keyword::TRUE) {
1167                    Some(true)
1168                } else if self.parse_keyword(Keyword::FALSE) {
1169                    Some(false)
1170                } else {
1171                    None
1172                };
1173                options.push(AttachDuckDBDatabaseOption::ReadOnly(boolean));
1174            } else if self.parse_keyword(Keyword::TYPE) {
1175                let ident = self.parse_identifier()?;
1176                options.push(AttachDuckDBDatabaseOption::Type(ident));
1177            } else {
1178                return self
1179                    .expected_ref("expected one of: ), READ_ONLY, TYPE", self.peek_token_ref());
1180            };
1181
1182            if self.consume_token(&Token::RParen) {
1183                return Ok(options);
1184            } else if self.consume_token(&Token::Comma) {
1185                continue;
1186            } else {
1187                return self.expected_ref("expected one of: ')', ','", self.peek_token_ref());
1188            }
1189        }
1190    }
1191
1192    /// Parse `ATTACH DUCKDB DATABASE` statement.
1193    pub fn parse_attach_duckdb_database(&mut self) -> Result<Statement, ParserError> {
1194        let database = self.parse_keyword(Keyword::DATABASE);
1195        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
1196        let database_path = self.parse_identifier()?;
1197        let database_alias = if self.parse_keyword(Keyword::AS) {
1198            Some(self.parse_identifier()?)
1199        } else {
1200            None
1201        };
1202
1203        let attach_options = self.parse_attach_duckdb_database_options()?;
1204        Ok(Statement::AttachDuckDBDatabase {
1205            if_not_exists,
1206            database,
1207            database_path,
1208            database_alias,
1209            attach_options,
1210        })
1211    }
1212
1213    /// Parse `DETACH DUCKDB DATABASE` statement.
1214    pub fn parse_detach_duckdb_database(&mut self) -> Result<Statement, ParserError> {
1215        let database = self.parse_keyword(Keyword::DATABASE);
1216        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
1217        let database_alias = self.parse_identifier()?;
1218        Ok(Statement::DetachDuckDBDatabase {
1219            if_exists,
1220            database,
1221            database_alias,
1222        })
1223    }
1224
1225    /// Parse `ATTACH DATABASE` statement.
1226    pub fn parse_attach_database(&mut self) -> Result<Statement, ParserError> {
1227        let database = self.parse_keyword(Keyword::DATABASE);
1228        let database_file_name = self.parse_expr()?;
1229        self.expect_keyword_is(Keyword::AS)?;
1230        let schema_name = self.parse_identifier()?;
1231        Ok(Statement::AttachDatabase {
1232            database,
1233            schema_name,
1234            database_file_name,
1235        })
1236    }
1237
1238    /// Parse `ANALYZE` statement.
1239    pub fn parse_analyze(&mut self) -> Result<Analyze, ParserError> {
1240        let has_table_keyword = self.parse_keyword(Keyword::TABLE);
1241        let table_name = self.maybe_parse(|parser| parser.parse_object_name(false))?;
1242        let mut for_columns = false;
1243        let mut cache_metadata = false;
1244        let mut noscan = false;
1245        let mut partitions = None;
1246        let mut compute_statistics = false;
1247        let mut columns = vec![];
1248
1249        // PostgreSQL syntax: ANALYZE t (col1, col2)
1250        if table_name.is_some() && self.consume_token(&Token::LParen) {
1251            columns = self.parse_comma_separated(|p| p.parse_identifier())?;
1252            self.expect_token(&Token::RParen)?;
1253        }
1254
1255        loop {
1256            match self.parse_one_of_keywords(&[
1257                Keyword::PARTITION,
1258                Keyword::FOR,
1259                Keyword::CACHE,
1260                Keyword::NOSCAN,
1261                Keyword::COMPUTE,
1262            ]) {
1263                Some(Keyword::PARTITION) => {
1264                    self.expect_token(&Token::LParen)?;
1265                    partitions = Some(self.parse_comma_separated(Parser::parse_expr)?);
1266                    self.expect_token(&Token::RParen)?;
1267                }
1268                Some(Keyword::NOSCAN) => noscan = true,
1269                Some(Keyword::FOR) => {
1270                    self.expect_keyword_is(Keyword::COLUMNS)?;
1271
1272                    columns = self
1273                        .maybe_parse(|parser| {
1274                            parser.parse_comma_separated(|p| p.parse_identifier())
1275                        })?
1276                        .unwrap_or_default();
1277                    for_columns = true
1278                }
1279                Some(Keyword::CACHE) => {
1280                    self.expect_keyword_is(Keyword::METADATA)?;
1281                    cache_metadata = true
1282                }
1283                Some(Keyword::COMPUTE) => {
1284                    self.expect_keyword_is(Keyword::STATISTICS)?;
1285                    compute_statistics = true
1286                }
1287                _ => break,
1288            }
1289        }
1290
1291        Ok(Analyze {
1292            has_table_keyword,
1293            table_name,
1294            for_columns,
1295            columns,
1296            partitions,
1297            cache_metadata,
1298            noscan,
1299            compute_statistics,
1300        })
1301    }
1302
1303    /// Parse a new expression including wildcard & qualified wildcard.
1304    pub fn parse_wildcard_expr(&mut self) -> Result<Expr, ParserError> {
1305        let index = self.index;
1306
1307        let next_token = self.next_token();
1308        match next_token.token {
1309            t @ (Token::Word(_) | Token::SingleQuotedString(_)) => {
1310                if self.peek_token_ref().token == Token::Period {
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
1342                                    .expected("an identifier or a '*' after '.'", next_token);
1343                            }
1344                        }
1345                    }
1346                }
1347            }
1348            Token::Mul => {
1349                return Ok(Expr::Wildcard(AttachedToken(next_token)));
1350            }
1351            // Handle parenthesized wildcard: (*)
1352            Token::LParen => {
1353                let [maybe_mul, maybe_rparen] = self.peek_tokens_ref();
1354                if maybe_mul.token == Token::Mul && maybe_rparen.token == Token::RParen {
1355                    let mul_token = self.next_token(); // consume Mul
1356                    self.next_token(); // consume RParen
1357                    return Ok(Expr::Wildcard(AttachedToken(mul_token)));
1358                }
1359            }
1360            _ => (),
1361        };
1362
1363        self.index = index;
1364        self.parse_expr()
1365    }
1366
1367    /// Parse a new expression.
1368    pub fn parse_expr(&mut self) -> Result<Expr, ParserError> {
1369        self.parse_subexpr(self.dialect.prec_unknown())
1370    }
1371
1372    /// Parse expression with optional alias and order by.
1373    pub fn parse_expr_with_alias_and_order_by(
1374        &mut self,
1375    ) -> Result<ExprWithAliasAndOrderBy, ParserError> {
1376        let expr = self.parse_expr()?;
1377
1378        fn validator(explicit: bool, kw: &Keyword, _parser: &mut Parser) -> bool {
1379            explicit || !&[Keyword::ASC, Keyword::DESC, Keyword::GROUP].contains(kw)
1380        }
1381        let alias = self.parse_optional_alias_inner(None, validator)?;
1382        let order_by = OrderByOptions {
1383            asc: self.parse_asc_desc(),
1384            nulls_first: None,
1385        };
1386        Ok(ExprWithAliasAndOrderBy {
1387            expr: ExprWithAlias { expr, alias },
1388            order_by,
1389        })
1390    }
1391
1392    /// Parse tokens until the precedence changes.
1393    #[cfg_attr(feature = "recursive-protection", recursive::recursive)]
1394    pub fn parse_subexpr(&mut self, precedence: u8) -> Result<Expr, ParserError> {
1395        let _guard = self.recursion_counter.try_decrease()?;
1396        debug!("parsing expr");
1397        let mut expr = self.parse_prefix()?;
1398
1399        expr = self.parse_compound_expr(expr, vec![])?;
1400
1401        // Parse an optional collation cast operator following `expr`.
1402        //
1403        // For example (MSSQL): t1.a COLLATE Latin1_General_CI_AS
1404        if !self.in_column_definition_state() && self.parse_keyword(Keyword::COLLATE) {
1405            expr = Expr::Collate {
1406                expr: Box::new(expr),
1407                collation: self.parse_object_name(false)?,
1408            };
1409        }
1410
1411        debug!("prefix: {expr:?}");
1412        loop {
1413            let next_precedence = self.get_next_precedence()?;
1414            debug!("next precedence: {next_precedence:?}");
1415
1416            if precedence >= next_precedence {
1417                break;
1418            }
1419
1420            // The period operator is handled exclusively by the
1421            // compound field access parsing.
1422            if Token::Period == self.peek_token_ref().token {
1423                break;
1424            }
1425
1426            expr = self.parse_infix(expr, next_precedence)?;
1427        }
1428        Ok(expr)
1429    }
1430
1431    /// Parse `ASSERT` statement.
1432    pub fn parse_assert(&mut self) -> Result<Statement, ParserError> {
1433        let condition = self.parse_expr()?;
1434        let message = if self.parse_keyword(Keyword::AS) {
1435            Some(self.parse_expr()?)
1436        } else {
1437            None
1438        };
1439
1440        Ok(Statement::Assert { condition, message })
1441    }
1442
1443    /// Parse `SAVEPOINT` statement.
1444    pub fn parse_savepoint(&mut self) -> Result<Statement, ParserError> {
1445        let name = self.parse_identifier()?;
1446        Ok(Statement::Savepoint { name })
1447    }
1448
1449    /// Parse `RELEASE` statement.
1450    pub fn parse_release(&mut self) -> Result<Statement, ParserError> {
1451        let _ = self.parse_keyword(Keyword::SAVEPOINT);
1452        let name = self.parse_identifier()?;
1453
1454        Ok(Statement::ReleaseSavepoint { name })
1455    }
1456
1457    /// Parse `LISTEN` statement.
1458    pub fn parse_listen(&mut self) -> Result<Statement, ParserError> {
1459        let channel = self.parse_identifier()?;
1460        Ok(Statement::LISTEN { channel })
1461    }
1462
1463    /// Parse `UNLISTEN` statement.
1464    pub fn parse_unlisten(&mut self) -> Result<Statement, ParserError> {
1465        let channel = if self.consume_token(&Token::Mul) {
1466            Ident::new(Expr::Wildcard(AttachedToken::empty()).to_string())
1467        } else {
1468            match self.parse_identifier() {
1469                Ok(expr) => expr,
1470                _ => {
1471                    self.prev_token();
1472                    return self.expected_ref("wildcard or identifier", self.peek_token_ref());
1473                }
1474            }
1475        };
1476        Ok(Statement::UNLISTEN { channel })
1477    }
1478
1479    /// Parse `NOTIFY` statement.
1480    pub fn parse_notify(&mut self) -> Result<Statement, ParserError> {
1481        let channel = self.parse_identifier()?;
1482        let payload = if self.consume_token(&Token::Comma) {
1483            Some(self.parse_literal_string()?)
1484        } else {
1485            None
1486        };
1487        Ok(Statement::NOTIFY { channel, payload })
1488    }
1489
1490    /// Parses a `RENAME TABLE` statement. See [Statement::RenameTable]
1491    pub fn parse_rename(&mut self) -> Result<Statement, ParserError> {
1492        if self.peek_keyword(Keyword::TABLE) {
1493            self.expect_keyword(Keyword::TABLE)?;
1494            let rename_tables = self.parse_comma_separated(|parser| {
1495                let old_name = parser.parse_object_name(false)?;
1496                parser.expect_keyword(Keyword::TO)?;
1497                let new_name = parser.parse_object_name(false)?;
1498
1499                Ok(RenameTable { old_name, new_name })
1500            })?;
1501            Ok(rename_tables.into())
1502        } else {
1503            self.expected_ref("KEYWORD `TABLE` after RENAME", self.peek_token_ref())
1504        }
1505    }
1506
1507    /// Tries to parse an expression by matching the specified word to known keywords that have a special meaning in the dialect.
1508    /// Returns `None if no match is found.
1509    fn parse_expr_prefix_by_reserved_word(
1510        &mut self,
1511        w: &Word,
1512        w_span: Span,
1513    ) -> Result<Option<Expr>, ParserError> {
1514        match w.keyword {
1515            Keyword::TRUE | Keyword::FALSE if self.dialect.supports_boolean_literals() => {
1516                self.prev_token();
1517                Ok(Some(Expr::Value(self.parse_value()?)))
1518            }
1519            Keyword::NULL => {
1520                self.prev_token();
1521                Ok(Some(Expr::Value(self.parse_value()?)))
1522            }
1523            Keyword::CURRENT_CATALOG
1524            | Keyword::CURRENT_USER
1525            | Keyword::SESSION_USER
1526            | Keyword::USER
1527            if dialect_of!(self is PostgreSqlDialect | GenericDialect) =>
1528                {
1529                    Ok(Some(Expr::Function(Function {
1530                        name: ObjectName::from(vec![w.to_ident(w_span)]),
1531                        uses_odbc_syntax: false,
1532                        parameters: FunctionArguments::None,
1533                        args: FunctionArguments::None,
1534                        null_treatment: None,
1535                        filter: None,
1536                        over: None,
1537                        within_group: vec![],
1538                    })))
1539                }
1540            Keyword::CURRENT_TIMESTAMP
1541            | Keyword::CURRENT_TIME
1542            | Keyword::CURRENT_DATE
1543            | Keyword::LOCALTIME
1544            | Keyword::LOCALTIMESTAMP => {
1545                Ok(Some(self.parse_time_functions(ObjectName::from(vec![w.to_ident(w_span)]))?))
1546            }
1547            Keyword::CASE => Ok(Some(self.parse_case_expr()?)),
1548            Keyword::CONVERT => Ok(Some(self.parse_convert_expr(false)?)),
1549            Keyword::TRY_CONVERT if self.dialect.supports_try_convert() => Ok(Some(self.parse_convert_expr(true)?)),
1550            Keyword::CAST => Ok(Some(self.parse_cast_expr(CastKind::Cast)?)),
1551            Keyword::TRY_CAST => Ok(Some(self.parse_cast_expr(CastKind::TryCast)?)),
1552            Keyword::SAFE_CAST => Ok(Some(self.parse_cast_expr(CastKind::SafeCast)?)),
1553            Keyword::EXISTS
1554            // Support parsing Databricks has a function named `exists`.
1555            if !dialect_of!(self is DatabricksDialect)
1556                || matches!(
1557                        self.peek_nth_token_ref(1).token,
1558                        Token::Word(Word {
1559                            keyword: Keyword::SELECT | Keyword::WITH,
1560                            ..
1561                        })
1562                    ) =>
1563                {
1564                    Ok(Some(self.parse_exists_expr(false)?))
1565                }
1566            Keyword::EXTRACT => Ok(Some(self.parse_extract_expr()?)),
1567            Keyword::CEIL => Ok(Some(self.parse_ceil_floor_expr(true)?)),
1568            Keyword::FLOOR => Ok(Some(self.parse_ceil_floor_expr(false)?)),
1569            Keyword::POSITION if self.peek_token_ref().token == Token::LParen => {
1570                Ok(Some(self.parse_position_expr(w.to_ident(w_span))?))
1571            }
1572            Keyword::SUBSTR | Keyword::SUBSTRING => {
1573                self.prev_token();
1574                Ok(Some(self.parse_substring()?))
1575            }
1576            Keyword::OVERLAY => Ok(Some(self.parse_overlay_expr()?)),
1577            Keyword::TRIM => Ok(Some(self.parse_trim_expr()?)),
1578            Keyword::INTERVAL => Ok(Some(self.parse_interval()?)),
1579            // Treat ARRAY[1,2,3] as an array [1,2,3], otherwise try as subquery or a function call
1580            Keyword::ARRAY if *self.peek_token_ref() == Token::LBracket => {
1581                self.expect_token(&Token::LBracket)?;
1582                Ok(Some(self.parse_array_expr(true)?))
1583            }
1584            Keyword::ARRAY
1585            if self.peek_token_ref().token == Token::LParen
1586                && !dialect_of!(self is ClickHouseDialect | DatabricksDialect) =>
1587                {
1588                    self.expect_token(&Token::LParen)?;
1589                    let query = self.parse_query()?;
1590                    self.expect_token(&Token::RParen)?;
1591                    Ok(Some(Expr::Function(Function {
1592                        name: ObjectName::from(vec![w.to_ident(w_span)]),
1593                        uses_odbc_syntax: false,
1594                        parameters: FunctionArguments::None,
1595                        args: FunctionArguments::Subquery(query),
1596                        filter: None,
1597                        null_treatment: None,
1598                        over: None,
1599                        within_group: vec![],
1600                    })))
1601                }
1602            Keyword::NOT => Ok(Some(self.parse_not()?)),
1603            Keyword::MATCH if self.dialect.supports_match_against() => {
1604                Ok(Some(self.parse_match_against()?))
1605            }
1606            Keyword::STRUCT if self.dialect.supports_struct_literal() => {
1607                let struct_expr = self.parse_struct_literal()?;
1608                Ok(Some(struct_expr))
1609            }
1610            Keyword::PRIOR if matches!(self.state, ParserState::ConnectBy) => {
1611                let expr = self.parse_subexpr(self.dialect.prec_value(Precedence::PlusMinus))?;
1612                Ok(Some(Expr::Prior(Box::new(expr))))
1613            }
1614            Keyword::MAP if *self.peek_token_ref() == Token::LBrace && self.dialect.support_map_literal_syntax() => {
1615                Ok(Some(self.parse_duckdb_map_literal()?))
1616            }
1617            Keyword::LAMBDA if self.dialect.supports_lambda_functions() => {
1618                Ok(Some(self.parse_lambda_expr()?))
1619            }
1620            _ if self.dialect.supports_geometric_types() => match w.keyword {
1621                Keyword::CIRCLE => Ok(Some(self.parse_geometric_type(GeometricTypeKind::Circle)?)),
1622                Keyword::BOX => Ok(Some(self.parse_geometric_type(GeometricTypeKind::GeometricBox)?)),
1623                Keyword::PATH => Ok(Some(self.parse_geometric_type(GeometricTypeKind::GeometricPath)?)),
1624                Keyword::LINE => Ok(Some(self.parse_geometric_type(GeometricTypeKind::Line)?)),
1625                Keyword::LSEG => Ok(Some(self.parse_geometric_type(GeometricTypeKind::LineSegment)?)),
1626                Keyword::POINT => Ok(Some(self.parse_geometric_type(GeometricTypeKind::Point)?)),
1627                Keyword::POLYGON => Ok(Some(self.parse_geometric_type(GeometricTypeKind::Polygon)?)),
1628                _ => Ok(None),
1629            },
1630            _ => Ok(None),
1631        }
1632    }
1633
1634    /// Tries to parse an expression by a word that is not known to have a special meaning in the dialect.
1635    fn parse_expr_prefix_by_unreserved_word(
1636        &mut self,
1637        w: &Word,
1638        w_span: Span,
1639    ) -> Result<Expr, ParserError> {
1640        let is_outer_join = self.peek_outer_join_operator();
1641        match &self.peek_token_ref().token {
1642            Token::LParen if !is_outer_join => {
1643                let id_parts = vec![w.to_ident(w_span)];
1644                self.parse_function(ObjectName::from(id_parts))
1645            }
1646            // string introducer https://dev.mysql.com/doc/refman/8.0/en/charset-introducer.html
1647            Token::SingleQuotedString(_)
1648            | Token::DoubleQuotedString(_)
1649            | Token::HexStringLiteral(_)
1650                if w.value.starts_with('_') =>
1651            {
1652                Ok(Expr::Prefixed {
1653                    prefix: w.to_ident(w_span),
1654                    value: self.parse_introduced_string_expr()?.into(),
1655                })
1656            }
1657            // string introducer https://dev.mysql.com/doc/refman/8.0/en/charset-introducer.html
1658            Token::SingleQuotedString(_)
1659            | Token::DoubleQuotedString(_)
1660            | Token::HexStringLiteral(_)
1661                if w.value.starts_with('_') =>
1662            {
1663                Ok(Expr::Prefixed {
1664                    prefix: w.to_ident(w_span),
1665                    value: self.parse_introduced_string_expr()?.into(),
1666                })
1667            }
1668            // An unreserved word (likely an identifier) is followed by an arrow,
1669            // which indicates a lambda function with a single, untyped parameter.
1670            // For example: `a -> a * 2`.
1671            Token::Arrow if self.dialect.supports_lambda_functions() => {
1672                self.expect_token(&Token::Arrow)?;
1673                Ok(Expr::Lambda(LambdaFunction {
1674                    params: OneOrManyWithParens::One(LambdaFunctionParameter {
1675                        name: w.to_ident(w_span),
1676                        data_type: None,
1677                    }),
1678                    body: Box::new(self.parse_expr()?),
1679                    syntax: LambdaSyntax::Arrow,
1680                }))
1681            }
1682            // An unreserved word (likely an identifier) that is followed by another word (likley a data type)
1683            // which is then followed by an arrow, which indicates a lambda function with a single, typed parameter.
1684            // For example: `a INT -> a * 2`.
1685            Token::Word(_)
1686                if self.dialect.supports_lambda_functions()
1687                    && self.peek_nth_token_ref(1).token == Token::Arrow =>
1688            {
1689                let data_type = self.parse_data_type()?;
1690                self.expect_token(&Token::Arrow)?;
1691                Ok(Expr::Lambda(LambdaFunction {
1692                    params: OneOrManyWithParens::One(LambdaFunctionParameter {
1693                        name: w.to_ident(w_span),
1694                        data_type: Some(data_type),
1695                    }),
1696                    body: Box::new(self.parse_expr()?),
1697                    syntax: LambdaSyntax::Arrow,
1698                }))
1699            }
1700            _ => Ok(Expr::Identifier(w.to_ident(w_span))),
1701        }
1702    }
1703
1704    /// Returns true if the given [ObjectName] is a single unquoted
1705    /// identifier matching `expected` (case-insensitive).
1706    fn is_simple_unquoted_object_name(name: &ObjectName, expected: &str) -> bool {
1707        if let [ObjectNamePart::Identifier(ident)] = name.0.as_slice() {
1708            ident.quote_style.is_none() && ident.value.eq_ignore_ascii_case(expected)
1709        } else {
1710            false
1711        }
1712    }
1713
1714    /// Parse an expression prefix.
1715    pub fn parse_prefix(&mut self) -> Result<Expr, ParserError> {
1716        // allow the dialect to override prefix parsing
1717        if let Some(prefix) = self.dialect.parse_prefix(self) {
1718            return prefix;
1719        }
1720
1721        // PostgreSQL allows any string literal to be preceded by a type name, indicating that the
1722        // string literal represents a literal of that type. Some examples:
1723        //
1724        //      DATE '2020-05-20'
1725        //      TIMESTAMP WITH TIME ZONE '2020-05-20 7:43:54'
1726        //      BOOL 'true'
1727        //
1728        // The first two are standard SQL, while the latter is a PostgreSQL extension. Complicating
1729        // matters is the fact that INTERVAL string literals may optionally be followed by special
1730        // keywords, e.g.:
1731        //
1732        //      INTERVAL '7' DAY
1733        //
1734        // Note also that naively `SELECT date` looks like a syntax error because the `date` type
1735        // name is not followed by a string literal, but in fact in PostgreSQL it is a valid
1736        // expression that should parse as the column name "date".
1737        let loc = self.peek_token_ref().span.start;
1738        let opt_expr = self.maybe_parse(|parser| {
1739            match parser.parse_data_type()? {
1740                DataType::Interval { .. } => parser.parse_interval(),
1741                // PostgreSQL allows almost any identifier to be used as custom data type name,
1742                // and we support that in `parse_data_type()`. But unlike Postgres we don't
1743                // have a list of globally reserved keywords (since they vary across dialects),
1744                // so given `NOT 'a' LIKE 'b'`, we'd accept `NOT` as a possible custom data type
1745                // name, resulting in `NOT 'a'` being recognized as a `TypedString` instead of
1746                // an unary negation `NOT ('a' LIKE 'b')`. To solve this, we don't accept the
1747                // `type 'string'` syntax for the custom data types at all ...
1748                //
1749                // ... with the exception of `xml '...'` on dialects that support XML
1750                // expressions, which is a valid PostgreSQL typed string literal.
1751                DataType::Custom(ref name, ref modifiers)
1752                    if modifiers.is_empty()
1753                        && Self::is_simple_unquoted_object_name(name, "xml")
1754                        && parser.dialect.supports_xml_expressions() =>
1755                {
1756                    Ok(Expr::TypedString(TypedString {
1757                        data_type: DataType::Custom(name.clone(), modifiers.clone()),
1758                        value: parser.parse_value()?,
1759                        uses_odbc_syntax: false,
1760                    }))
1761                }
1762                DataType::Custom(..) => parser_err!("dummy", loc),
1763                // MySQL supports using the `BINARY` keyword as a cast to binary type.
1764                DataType::Binary(..) if self.dialect.supports_binary_kw_as_cast() => {
1765                    Ok(Expr::Cast {
1766                        kind: CastKind::Cast,
1767                        expr: Box::new(parser.parse_expr()?),
1768                        data_type: DataType::Binary(None),
1769                        array: false,
1770                        format: None,
1771                    })
1772                }
1773                data_type => Ok(Expr::TypedString(TypedString {
1774                    data_type,
1775                    value: parser.parse_value()?,
1776                    uses_odbc_syntax: false,
1777                })),
1778            }
1779        })?;
1780
1781        if let Some(expr) = opt_expr {
1782            return Ok(expr);
1783        }
1784
1785        // Cache some dialect properties to avoid lifetime issues with the
1786        // next_token reference.
1787
1788        let dialect = self.dialect;
1789
1790        self.advance_token();
1791        let next_token_index = self.get_current_index();
1792        let next_token = self.get_current_token();
1793        let span = next_token.span;
1794        let expr = match &next_token.token {
1795            Token::Word(w) => {
1796                // The word we consumed may fall into one of two cases: it has a special meaning, or not.
1797                // For example, in Snowflake, the word `interval` may have two meanings depending on the context:
1798                // `SELECT CURRENT_DATE() + INTERVAL '1 DAY', MAX(interval) FROM tbl;`
1799                //                          ^^^^^^^^^^^^^^^^      ^^^^^^^^
1800                //                         interval expression   identifier
1801                //
1802                // We first try to parse the word and following tokens as a special expression, and if that fails,
1803                // we rollback and try to parse it as an identifier.
1804                let w = w.clone();
1805                match self.try_parse(|parser| parser.parse_expr_prefix_by_reserved_word(&w, span)) {
1806                    // This word indicated an expression prefix and parsing was successful
1807                    Ok(Some(expr)) => Ok(expr),
1808
1809                    // No expression prefix associated with this word
1810                    Ok(None) => Ok(self.parse_expr_prefix_by_unreserved_word(&w, span)?),
1811
1812                    // If parsing of the word as a special expression failed, we are facing two options:
1813                    // 1. The statement is malformed, e.g. `SELECT INTERVAL '1 DAI` (`DAI` instead of `DAY`)
1814                    // 2. The word is used as an identifier, e.g. `SELECT MAX(interval) FROM tbl`
1815                    // We first try to parse the word as an identifier and if that fails
1816                    // we rollback and return the parsing error we got from trying to parse a
1817                    // special expression (to maintain backwards compatibility of parsing errors).
1818                    Err(e) => {
1819                        if !self.dialect.is_reserved_for_identifier(w.keyword) {
1820                            if let Ok(Some(expr)) = self.maybe_parse(|parser| {
1821                                parser.parse_expr_prefix_by_unreserved_word(&w, span)
1822                            }) {
1823                                return Ok(expr);
1824                            }
1825                        }
1826                        return Err(e);
1827                    }
1828                }
1829            } // End of Token::Word
1830            // array `[1, 2, 3]`
1831            Token::LBracket => self.parse_array_expr(false),
1832            tok @ Token::Minus | tok @ Token::Plus => {
1833                let op = if *tok == Token::Plus {
1834                    UnaryOperator::Plus
1835                } else {
1836                    UnaryOperator::Minus
1837                };
1838                Ok(Expr::UnaryOp {
1839                    op,
1840                    expr: Box::new(
1841                        self.parse_subexpr(self.dialect.prec_value(Precedence::MulDivModOp))?,
1842                    ),
1843                })
1844            }
1845            Token::ExclamationMark if dialect.supports_bang_not_operator() => Ok(Expr::UnaryOp {
1846                op: UnaryOperator::BangNot,
1847                expr: Box::new(self.parse_subexpr(self.dialect.prec_value(Precedence::UnaryNot))?),
1848            }),
1849            tok @ Token::DoubleExclamationMark
1850            | tok @ Token::PGSquareRoot
1851            | tok @ Token::PGCubeRoot
1852            | tok @ Token::AtSign
1853                if dialect_is!(dialect is PostgreSqlDialect) =>
1854            {
1855                let op = match tok {
1856                    Token::DoubleExclamationMark => UnaryOperator::PGPrefixFactorial,
1857                    Token::PGSquareRoot => UnaryOperator::PGSquareRoot,
1858                    Token::PGCubeRoot => UnaryOperator::PGCubeRoot,
1859                    Token::AtSign => UnaryOperator::PGAbs,
1860                    _ => {
1861                        return Err(ParserError::ParserError(
1862                            "Internal parser error: unexpected unary operator token".to_string(),
1863                        ))
1864                    }
1865                };
1866                Ok(Expr::UnaryOp {
1867                    op,
1868                    expr: Box::new(
1869                        self.parse_subexpr(self.dialect.prec_value(Precedence::PlusMinus))?,
1870                    ),
1871                })
1872            }
1873            Token::Tilde => Ok(Expr::UnaryOp {
1874                op: UnaryOperator::BitwiseNot,
1875                expr: Box::new(self.parse_subexpr(self.dialect.prec_value(Precedence::PlusMinus))?),
1876            }),
1877            tok @ Token::Sharp
1878            | tok @ Token::AtDashAt
1879            | tok @ Token::AtAt
1880            | tok @ Token::QuestionMarkDash
1881            | tok @ Token::QuestionPipe
1882                if self.dialect.supports_geometric_types() =>
1883            {
1884                let op = match tok {
1885                    Token::Sharp => UnaryOperator::Hash,
1886                    Token::AtDashAt => UnaryOperator::AtDashAt,
1887                    Token::AtAt => UnaryOperator::DoubleAt,
1888                    Token::QuestionMarkDash => UnaryOperator::QuestionDash,
1889                    Token::QuestionPipe => UnaryOperator::QuestionPipe,
1890                    _ => {
1891                        return Err(ParserError::ParserError(format!(
1892                            "Unexpected token in unary operator parsing: {tok:?}"
1893                        )))
1894                    }
1895                };
1896                Ok(Expr::UnaryOp {
1897                    op,
1898                    expr: Box::new(
1899                        self.parse_subexpr(self.dialect.prec_value(Precedence::PlusMinus))?,
1900                    ),
1901                })
1902            }
1903            Token::EscapedStringLiteral(_) if dialect_is!(dialect is PostgreSqlDialect | GenericDialect) =>
1904            {
1905                self.prev_token();
1906                Ok(Expr::Value(self.parse_value()?))
1907            }
1908            Token::UnicodeStringLiteral(_) => {
1909                self.prev_token();
1910                Ok(Expr::Value(self.parse_value()?))
1911            }
1912            Token::Number(_, _)
1913            | Token::SingleQuotedString(_)
1914            | Token::DoubleQuotedString(_)
1915            | Token::TripleSingleQuotedString(_)
1916            | Token::TripleDoubleQuotedString(_)
1917            | Token::DollarQuotedString(_)
1918            | Token::SingleQuotedByteStringLiteral(_)
1919            | Token::DoubleQuotedByteStringLiteral(_)
1920            | Token::TripleSingleQuotedByteStringLiteral(_)
1921            | Token::TripleDoubleQuotedByteStringLiteral(_)
1922            | Token::SingleQuotedRawStringLiteral(_)
1923            | Token::DoubleQuotedRawStringLiteral(_)
1924            | Token::TripleSingleQuotedRawStringLiteral(_)
1925            | Token::TripleDoubleQuotedRawStringLiteral(_)
1926            | Token::NationalStringLiteral(_)
1927            | Token::QuoteDelimitedStringLiteral(_)
1928            | Token::NationalQuoteDelimitedStringLiteral(_)
1929            | Token::HexStringLiteral(_) => {
1930                self.prev_token();
1931                Ok(Expr::Value(self.parse_value()?))
1932            }
1933            Token::LParen => {
1934                let expr =
1935                    if let Some(expr) = self.try_parse_expr_sub_query()? {
1936                        expr
1937                    } else if let Some(lambda) = self.try_parse_lambda()? {
1938                        return Ok(lambda);
1939                    } else {
1940                        // Parentheses in expressions switch to "normal" parsing state.
1941                        // This matters for dialects (SQLite, DuckDB) where `NOT NULL` can
1942                        // be an alias for `IS NOT NULL`. In column definitions like:
1943                        //
1944                        //   CREATE TABLE t (c INT DEFAULT (42 NOT NULL) NOT NULL)
1945                        //
1946                        // The `(42 NOT NULL)` is an expression with parens, so it parses
1947                        // as `IsNotNull(42)`. The trailing `NOT NULL` is outside those
1948                        // expression parens (the outer parens are CREATE TABLE syntax),
1949                        // so it remains a column constraint.
1950                        let exprs = self.with_state(ParserState::Normal, |p| {
1951                            p.parse_comma_separated(Parser::parse_expr)
1952                        })?;
1953                        match exprs.len() {
1954                            0 => return Err(ParserError::ParserError(
1955                                "Internal parser error: parse_comma_separated returned empty list"
1956                                    .to_string(),
1957                            )),
1958                            1 => Expr::Nested(Box::new(exprs.into_iter().next().unwrap())),
1959                            _ => Expr::Tuple(exprs),
1960                        }
1961                    };
1962                self.expect_token(&Token::RParen)?;
1963                Ok(expr)
1964            }
1965            Token::Placeholder(_) | Token::Colon | Token::AtSign => {
1966                self.prev_token();
1967                Ok(Expr::Value(self.parse_value()?))
1968            }
1969            Token::LBrace => {
1970                self.prev_token();
1971                self.parse_lbrace_expr()
1972            }
1973            _ => self.expected_at("an expression", next_token_index),
1974        }?;
1975
1976        Ok(expr)
1977    }
1978
1979    fn parse_geometric_type(&mut self, kind: GeometricTypeKind) -> Result<Expr, ParserError> {
1980        Ok(Expr::TypedString(TypedString {
1981            data_type: DataType::GeometricType(kind),
1982            value: self.parse_value()?,
1983            uses_odbc_syntax: false,
1984        }))
1985    }
1986
1987    /// Try to parse an [Expr::CompoundFieldAccess] like `a.b.c` or `a.b[1].c`.
1988    /// If all the fields are `Expr::Identifier`s, return an [Expr::CompoundIdentifier] instead.
1989    /// If only the root exists, return the root.
1990    /// Parses compound expressions which may be delimited by period
1991    /// or bracket notation.
1992    /// For example: `a.b.c`, `a.b[1]`.
1993    pub fn parse_compound_expr(
1994        &mut self,
1995        root: Expr,
1996        mut chain: Vec<AccessExpr>,
1997    ) -> Result<Expr, ParserError> {
1998        let mut ending_wildcard: Option<TokenWithSpan> = None;
1999        loop {
2000            if self.consume_token(&Token::Period) {
2001                let next_token = self.peek_token_ref();
2002                match &next_token.token {
2003                    Token::Mul => {
2004                        // Postgres explicitly allows funcnm(tablenm.*) and the
2005                        // function array_agg traverses this control flow
2006                        if dialect_of!(self is PostgreSqlDialect) {
2007                            ending_wildcard = Some(self.next_token());
2008                        } else {
2009                            // Put back the consumed `.` tokens before exiting.
2010                            // If this expression is being parsed in the
2011                            // context of a projection, then the `.*` could imply
2012                            // a wildcard expansion. For example:
2013                            // `SELECT STRUCT('foo').* FROM T`
2014                            self.prev_token(); // .
2015                        }
2016
2017                        break;
2018                    }
2019                    Token::SingleQuotedString(s) => {
2020                        let expr =
2021                            Expr::Identifier(Ident::with_quote_and_span('\'', next_token.span, s));
2022                        chain.push(AccessExpr::Dot(expr));
2023                        self.advance_token(); // The consumed string
2024                    }
2025                    Token::Placeholder(s) => {
2026                        // Snowflake uses $1, $2, etc. for positional column references
2027                        // in staged data queries like: SELECT t.$1 FROM @stage t
2028                        let expr = Expr::Identifier(Ident::with_span(next_token.span, s));
2029                        chain.push(AccessExpr::Dot(expr));
2030                        self.advance_token(); // The consumed placeholder
2031                    }
2032                    // Fallback to parsing an arbitrary expression, but restrict to expression
2033                    // types that are valid after the dot operator. This ensures that e.g.
2034                    // `T.interval` is parsed as a compound identifier, not as an interval
2035                    // expression.
2036                    _ => {
2037                        let expr = self.maybe_parse(|parser| {
2038                            let expr = parser
2039                                .parse_subexpr(parser.dialect.prec_value(Precedence::Period))?;
2040                            match &expr {
2041                                Expr::CompoundFieldAccess { .. }
2042                                | Expr::CompoundIdentifier(_)
2043                                | Expr::Identifier(_)
2044                                | Expr::Value(_)
2045                                | Expr::Function(_) => Ok(expr),
2046                                _ => parser.expected_ref(
2047                                    "an identifier or value",
2048                                    parser.peek_token_ref(),
2049                                ),
2050                            }
2051                        })?;
2052
2053                        match expr {
2054                            // If we get back a compound field access or identifier,
2055                            // we flatten the nested expression.
2056                            // For example if the current root is `foo`
2057                            // and we get back a compound identifier expression `bar.baz`
2058                            // The full expression should be `foo.bar.baz` (i.e.
2059                            // a root with an access chain with 2 entries) and not
2060                            // `foo.(bar.baz)` (i.e. a root with an access chain with
2061                            // 1 entry`).
2062                            Some(Expr::CompoundFieldAccess { root, access_chain }) => {
2063                                chain.push(AccessExpr::Dot(*root));
2064                                chain.extend(access_chain);
2065                            }
2066                            Some(Expr::CompoundIdentifier(parts)) => chain.extend(
2067                                parts.into_iter().map(Expr::Identifier).map(AccessExpr::Dot),
2068                            ),
2069                            Some(expr) => {
2070                                chain.push(AccessExpr::Dot(expr));
2071                            }
2072                            // If the expression is not a valid suffix, fall back to
2073                            // parsing as an identifier. This handles cases like `T.interval`
2074                            // where `interval` is a keyword but should be treated as an identifier.
2075                            None => {
2076                                chain.push(AccessExpr::Dot(Expr::Identifier(
2077                                    self.parse_identifier()?,
2078                                )));
2079                            }
2080                        }
2081                    }
2082                }
2083            } else if !self.dialect.supports_partiql()
2084                && self.peek_token_ref().token == Token::LBracket
2085            {
2086                self.parse_multi_dim_subscript(&mut chain)?;
2087            } else {
2088                break;
2089            }
2090        }
2091
2092        let tok_index = self.get_current_index();
2093        if let Some(wildcard_token) = ending_wildcard {
2094            if !Self::is_all_ident(&root, &chain) {
2095                return self
2096                    .expected_ref("an identifier or a '*' after '.'", self.peek_token_ref());
2097            };
2098            Ok(Expr::QualifiedWildcard(
2099                ObjectName::from(Self::exprs_to_idents(root, chain)?),
2100                AttachedToken(wildcard_token),
2101            ))
2102        } else if self.maybe_parse_outer_join_operator() {
2103            if !Self::is_all_ident(&root, &chain) {
2104                return self.expected_at("column identifier before (+)", tok_index);
2105            };
2106            let expr = if chain.is_empty() {
2107                root
2108            } else {
2109                Expr::CompoundIdentifier(Self::exprs_to_idents(root, chain)?)
2110            };
2111            Ok(Expr::OuterJoin(expr.into()))
2112        } else {
2113            Self::build_compound_expr(root, chain)
2114        }
2115    }
2116
2117    /// Combines a root expression and access chain to form
2118    /// a compound expression. Which may be a [Expr::CompoundFieldAccess]
2119    /// or other special cased expressions like [Expr::CompoundIdentifier],
2120    /// [Expr::OuterJoin].
2121    fn build_compound_expr(
2122        root: Expr,
2123        mut access_chain: Vec<AccessExpr>,
2124    ) -> Result<Expr, ParserError> {
2125        if access_chain.is_empty() {
2126            return Ok(root);
2127        }
2128
2129        if Self::is_all_ident(&root, &access_chain) {
2130            return Ok(Expr::CompoundIdentifier(Self::exprs_to_idents(
2131                root,
2132                access_chain,
2133            )?));
2134        }
2135
2136        // Flatten qualified function calls.
2137        // For example, the expression `a.b.c.foo(1,2,3)` should
2138        // represent a function called `a.b.c.foo`, rather than
2139        // a composite expression.
2140        if matches!(root, Expr::Identifier(_))
2141            && matches!(
2142                access_chain.last(),
2143                Some(AccessExpr::Dot(Expr::Function(_)))
2144            )
2145            && access_chain
2146                .iter()
2147                .rev()
2148                .skip(1) // All except the Function
2149                .all(|access| matches!(access, AccessExpr::Dot(Expr::Identifier(_))))
2150        {
2151            let Some(AccessExpr::Dot(Expr::Function(mut func))) = access_chain.pop() else {
2152                return parser_err!("expected function expression", root.span().start);
2153            };
2154
2155            let compound_func_name = [root]
2156                .into_iter()
2157                .chain(access_chain.into_iter().flat_map(|access| match access {
2158                    AccessExpr::Dot(expr) => Some(expr),
2159                    _ => None,
2160                }))
2161                .flat_map(|expr| match expr {
2162                    Expr::Identifier(ident) => Some(ident),
2163                    _ => None,
2164                })
2165                .map(ObjectNamePart::Identifier)
2166                .chain(func.name.0)
2167                .collect::<Vec<_>>();
2168            func.name = ObjectName(compound_func_name);
2169
2170            return Ok(Expr::Function(func));
2171        }
2172
2173        // Flatten qualified outer join expressions.
2174        // For example, the expression `T.foo(+)` should
2175        // represent an outer join on the column name `T.foo`
2176        // rather than a composite expression.
2177        if access_chain.len() == 1
2178            && matches!(
2179                access_chain.last(),
2180                Some(AccessExpr::Dot(Expr::OuterJoin(_)))
2181            )
2182        {
2183            let Some(AccessExpr::Dot(Expr::OuterJoin(inner_expr))) = access_chain.pop() else {
2184                return parser_err!("expected (+) expression", root.span().start);
2185            };
2186
2187            if !Self::is_all_ident(&root, &[]) {
2188                return parser_err!("column identifier before (+)", root.span().start);
2189            };
2190
2191            let token_start = root.span().start;
2192            let mut idents = Self::exprs_to_idents(root, vec![])?;
2193            match *inner_expr {
2194                Expr::CompoundIdentifier(suffix) => idents.extend(suffix),
2195                Expr::Identifier(suffix) => idents.push(suffix),
2196                _ => {
2197                    return parser_err!("column identifier before (+)", token_start);
2198                }
2199            }
2200
2201            return Ok(Expr::OuterJoin(Expr::CompoundIdentifier(idents).into()));
2202        }
2203
2204        Ok(Expr::CompoundFieldAccess {
2205            root: Box::new(root),
2206            access_chain,
2207        })
2208    }
2209
2210    fn keyword_to_modifier(k: Keyword) -> Option<ContextModifier> {
2211        match k {
2212            Keyword::LOCAL => Some(ContextModifier::Local),
2213            Keyword::GLOBAL => Some(ContextModifier::Global),
2214            Keyword::SESSION => Some(ContextModifier::Session),
2215            _ => None,
2216        }
2217    }
2218
2219    /// Check if the root is an identifier and all fields are identifiers.
2220    fn is_all_ident(root: &Expr, fields: &[AccessExpr]) -> bool {
2221        if !matches!(root, Expr::Identifier(_)) {
2222            return false;
2223        }
2224        fields
2225            .iter()
2226            .all(|x| matches!(x, AccessExpr::Dot(Expr::Identifier(_))))
2227    }
2228
2229    /// Convert a root and a list of fields to a list of identifiers.
2230    fn exprs_to_idents(root: Expr, fields: Vec<AccessExpr>) -> Result<Vec<Ident>, ParserError> {
2231        let mut idents = vec![];
2232        if let Expr::Identifier(root) = root {
2233            idents.push(root);
2234            for x in fields {
2235                if let AccessExpr::Dot(Expr::Identifier(ident)) = x {
2236                    idents.push(ident);
2237                } else {
2238                    return parser_err!(
2239                        format!("Expected identifier, found: {}", x),
2240                        x.span().start
2241                    );
2242                }
2243            }
2244            Ok(idents)
2245        } else {
2246            parser_err!(
2247                format!("Expected identifier, found: {}", root),
2248                root.span().start
2249            )
2250        }
2251    }
2252
2253    /// Returns true if the next tokens indicate the outer join operator `(+)`.
2254    fn peek_outer_join_operator(&mut self) -> bool {
2255        if !self.dialect.supports_outer_join_operator() {
2256            return false;
2257        }
2258
2259        let [maybe_lparen, maybe_plus, maybe_rparen] = self.peek_tokens_ref();
2260        Token::LParen == maybe_lparen.token
2261            && Token::Plus == maybe_plus.token
2262            && Token::RParen == maybe_rparen.token
2263    }
2264
2265    /// If the next tokens indicates the outer join operator `(+)`, consume
2266    /// the tokens and return true.
2267    fn maybe_parse_outer_join_operator(&mut self) -> bool {
2268        self.dialect.supports_outer_join_operator()
2269            && self.consume_tokens(&[Token::LParen, Token::Plus, Token::RParen])
2270    }
2271
2272    /// Parse utility options in the form of `(option1, option2 arg2, option3 arg3, ...)`
2273    pub fn parse_utility_options(&mut self) -> Result<Vec<UtilityOption>, ParserError> {
2274        self.expect_token(&Token::LParen)?;
2275        let options = self.parse_comma_separated(Self::parse_utility_option)?;
2276        self.expect_token(&Token::RParen)?;
2277
2278        Ok(options)
2279    }
2280
2281    fn parse_utility_option(&mut self) -> Result<UtilityOption, ParserError> {
2282        let name = self.parse_identifier()?;
2283
2284        let next_token = self.peek_token_ref();
2285        if next_token == &Token::Comma || next_token == &Token::RParen {
2286            return Ok(UtilityOption { name, arg: None });
2287        }
2288        let arg = self.parse_expr()?;
2289
2290        Ok(UtilityOption {
2291            name,
2292            arg: Some(arg),
2293        })
2294    }
2295
2296    fn try_parse_expr_sub_query(&mut self) -> Result<Option<Expr>, ParserError> {
2297        if !self.peek_sub_query() {
2298            return Ok(None);
2299        }
2300
2301        Ok(Some(Expr::Subquery(self.parse_query()?)))
2302    }
2303
2304    fn try_parse_lambda(&mut self) -> Result<Option<Expr>, ParserError> {
2305        if !self.dialect.supports_lambda_functions() {
2306            return Ok(None);
2307        }
2308        self.maybe_parse(|p| {
2309            let params = p.parse_comma_separated(|p| p.parse_lambda_function_parameter())?;
2310            p.expect_token(&Token::RParen)?;
2311            p.expect_token(&Token::Arrow)?;
2312            let expr = p.parse_expr()?;
2313            Ok(Expr::Lambda(LambdaFunction {
2314                params: OneOrManyWithParens::Many(params),
2315                body: Box::new(expr),
2316                syntax: LambdaSyntax::Arrow,
2317            }))
2318        })
2319    }
2320
2321    /// Parses a lambda expression following the `LAMBDA` keyword syntax.
2322    ///
2323    /// Syntax: `LAMBDA <params> : <expr>`
2324    ///
2325    /// Examples:
2326    /// - `LAMBDA x : x + 1`
2327    /// - `LAMBDA x, i : x > i`
2328    ///
2329    /// See <https://duckdb.org/docs/stable/sql/functions/lambda>
2330    fn parse_lambda_expr(&mut self) -> Result<Expr, ParserError> {
2331        // Parse the parameters: either a single identifier or comma-separated identifiers
2332        let params = self.parse_lambda_function_parameters()?;
2333        // Expect the colon separator
2334        self.expect_token(&Token::Colon)?;
2335        // Parse the body expression
2336        let body = self.parse_expr()?;
2337        Ok(Expr::Lambda(LambdaFunction {
2338            params,
2339            body: Box::new(body),
2340            syntax: LambdaSyntax::LambdaKeyword,
2341        }))
2342    }
2343
2344    /// Parses the parameters of a lambda function with optional typing.
2345    fn parse_lambda_function_parameters(
2346        &mut self,
2347    ) -> Result<OneOrManyWithParens<LambdaFunctionParameter>, ParserError> {
2348        // Parse the parameters: either a single identifier or comma-separated identifiers
2349        let params = if self.consume_token(&Token::LParen) {
2350            // Parenthesized parameters: (x, y)
2351            let params = self.parse_comma_separated(|p| p.parse_lambda_function_parameter())?;
2352            self.expect_token(&Token::RParen)?;
2353            OneOrManyWithParens::Many(params)
2354        } else {
2355            // Unparenthesized parameters: x or x, y
2356            let params = self.parse_comma_separated(|p| p.parse_lambda_function_parameter())?;
2357            if params.len() == 1 {
2358                OneOrManyWithParens::One(params.into_iter().next().unwrap())
2359            } else {
2360                OneOrManyWithParens::Many(params)
2361            }
2362        };
2363        Ok(params)
2364    }
2365
2366    /// Parses a single parameter of a lambda function, with optional typing.
2367    fn parse_lambda_function_parameter(&mut self) -> Result<LambdaFunctionParameter, ParserError> {
2368        let name = self.parse_identifier()?;
2369        let data_type = match &self.peek_token_ref().token {
2370            Token::Word(_) => self.maybe_parse(|p| p.parse_data_type())?,
2371            _ => None,
2372        };
2373        Ok(LambdaFunctionParameter { name, data_type })
2374    }
2375
2376    /// Tries to parse the body of an [ODBC escaping sequence]
2377    /// i.e. without the enclosing braces
2378    /// Currently implemented:
2379    /// Scalar Function Calls
2380    /// Date, Time, and Timestamp Literals
2381    /// See <https://learn.microsoft.com/en-us/sql/odbc/reference/develop-app/escape-sequences-in-odbc?view=sql-server-2017>
2382    fn maybe_parse_odbc_body(&mut self) -> Result<Option<Expr>, ParserError> {
2383        // Attempt 1: Try to parse it as a function.
2384        if let Some(expr) = self.maybe_parse_odbc_fn_body()? {
2385            return Ok(Some(expr));
2386        }
2387        // Attempt 2: Try to parse it as a Date, Time or Timestamp Literal
2388        self.maybe_parse_odbc_body_datetime()
2389    }
2390
2391    /// Tries to parse the body of an [ODBC Date, Time, and Timestamp Literals] call.
2392    ///
2393    /// ```sql
2394    /// {d '2025-07-17'}
2395    /// {t '14:12:01'}
2396    /// {ts '2025-07-17 14:12:01'}
2397    /// ```
2398    ///
2399    /// [ODBC Date, Time, and Timestamp Literals]:
2400    /// https://learn.microsoft.com/en-us/sql/odbc/reference/develop-app/date-time-and-timestamp-literals?view=sql-server-2017
2401    fn maybe_parse_odbc_body_datetime(&mut self) -> Result<Option<Expr>, ParserError> {
2402        self.maybe_parse(|p| {
2403            let token = p.next_token().clone();
2404            let word_string = token.token.to_string();
2405            let data_type = match word_string.as_str() {
2406                "t" => DataType::Time(None, TimezoneInfo::None),
2407                "d" => DataType::Date,
2408                "ts" => DataType::Timestamp(None, TimezoneInfo::None),
2409                _ => return p.expected("ODBC datetime keyword (t, d, or ts)", token),
2410            };
2411            let value = p.parse_value()?;
2412            Ok(Expr::TypedString(TypedString {
2413                data_type,
2414                value,
2415                uses_odbc_syntax: true,
2416            }))
2417        })
2418    }
2419
2420    /// Tries to parse the body of an [ODBC function] call.
2421    /// i.e. without the enclosing braces
2422    ///
2423    /// ```sql
2424    /// fn myfunc(1,2,3)
2425    /// ```
2426    ///
2427    /// [ODBC function]: https://learn.microsoft.com/en-us/sql/odbc/reference/develop-app/scalar-function-calls?view=sql-server-2017
2428    fn maybe_parse_odbc_fn_body(&mut self) -> Result<Option<Expr>, ParserError> {
2429        self.maybe_parse(|p| {
2430            p.expect_keyword(Keyword::FN)?;
2431            let fn_name = p.parse_object_name(false)?;
2432            let mut fn_call = p.parse_function_call(fn_name)?;
2433            fn_call.uses_odbc_syntax = true;
2434            Ok(Expr::Function(fn_call))
2435        })
2436    }
2437
2438    /// Parse a function call expression named by `name` and return it as an `Expr`.
2439    pub fn parse_function(&mut self, name: ObjectName) -> Result<Expr, ParserError> {
2440        self.parse_function_call(name).map(Expr::Function)
2441    }
2442
2443    fn parse_function_call(&mut self, name: ObjectName) -> Result<Function, ParserError> {
2444        self.expect_token(&Token::LParen)?;
2445
2446        // Snowflake permits a subquery to be passed as an argument without
2447        // an enclosing set of parens if it's the only argument.
2448        if self.dialect.supports_subquery_as_function_arg() && self.peek_sub_query() {
2449            let subquery = self.parse_query()?;
2450            self.expect_token(&Token::RParen)?;
2451            return Ok(Function {
2452                name,
2453                uses_odbc_syntax: false,
2454                parameters: FunctionArguments::None,
2455                args: FunctionArguments::Subquery(subquery),
2456                filter: None,
2457                null_treatment: None,
2458                over: None,
2459                within_group: vec![],
2460            });
2461        }
2462
2463        let mut args = self.parse_function_argument_list()?;
2464        let mut parameters = FunctionArguments::None;
2465        // ClickHouse aggregations support parametric functions like `HISTOGRAM(0.5, 0.6)(x, y)`
2466        // which (0.5, 0.6) is a parameter to the function.
2467        if dialect_of!(self is ClickHouseDialect | GenericDialect)
2468            && self.consume_token(&Token::LParen)
2469        {
2470            parameters = FunctionArguments::List(args);
2471            args = self.parse_function_argument_list()?;
2472        }
2473
2474        let within_group = if self.parse_keywords(&[Keyword::WITHIN, Keyword::GROUP]) {
2475            self.expect_token(&Token::LParen)?;
2476            self.expect_keywords(&[Keyword::ORDER, Keyword::BY])?;
2477            let order_by = self.parse_comma_separated(Parser::parse_order_by_expr)?;
2478            self.expect_token(&Token::RParen)?;
2479            order_by
2480        } else {
2481            vec![]
2482        };
2483
2484        let filter = if self.dialect.supports_filter_during_aggregation()
2485            && self.parse_keyword(Keyword::FILTER)
2486            && self.consume_token(&Token::LParen)
2487            && self.parse_keyword(Keyword::WHERE)
2488        {
2489            let filter = Some(Box::new(self.parse_expr()?));
2490            self.expect_token(&Token::RParen)?;
2491            filter
2492        } else {
2493            None
2494        };
2495
2496        // Syntax for null treatment shows up either in the args list
2497        // or after the function call, but not both.
2498        let null_treatment = if args
2499            .clauses
2500            .iter()
2501            .all(|clause| !matches!(clause, FunctionArgumentClause::IgnoreOrRespectNulls(_)))
2502        {
2503            self.parse_null_treatment()?
2504        } else {
2505            None
2506        };
2507
2508        let over = if self.parse_keyword(Keyword::OVER) {
2509            if self.consume_token(&Token::LParen) {
2510                let window_spec = self.parse_window_spec()?;
2511                Some(WindowType::WindowSpec(window_spec))
2512            } else {
2513                Some(WindowType::NamedWindow(self.parse_identifier()?))
2514            }
2515        } else {
2516            None
2517        };
2518
2519        Ok(Function {
2520            name,
2521            uses_odbc_syntax: false,
2522            parameters,
2523            args: FunctionArguments::List(args),
2524            null_treatment,
2525            filter,
2526            over,
2527            within_group,
2528        })
2529    }
2530
2531    /// Optionally parses a null treatment clause.
2532    fn parse_null_treatment(&mut self) -> Result<Option<NullTreatment>, ParserError> {
2533        match self.parse_one_of_keywords(&[Keyword::RESPECT, Keyword::IGNORE]) {
2534            Some(keyword) => {
2535                self.expect_keyword_is(Keyword::NULLS)?;
2536
2537                Ok(match keyword {
2538                    Keyword::RESPECT => Some(NullTreatment::RespectNulls),
2539                    Keyword::IGNORE => Some(NullTreatment::IgnoreNulls),
2540                    _ => None,
2541                })
2542            }
2543            None => Ok(None),
2544        }
2545    }
2546
2547    /// Parse time-related function `name` possibly followed by `(...)` arguments.
2548    pub fn parse_time_functions(&mut self, name: ObjectName) -> Result<Expr, ParserError> {
2549        let args = if self.consume_token(&Token::LParen) {
2550            FunctionArguments::List(self.parse_function_argument_list()?)
2551        } else {
2552            FunctionArguments::None
2553        };
2554        Ok(Expr::Function(Function {
2555            name,
2556            uses_odbc_syntax: false,
2557            parameters: FunctionArguments::None,
2558            args,
2559            filter: None,
2560            over: None,
2561            null_treatment: None,
2562            within_group: vec![],
2563        }))
2564    }
2565
2566    /// Parse window frame `UNITS` clause: `ROWS`, `RANGE`, or `GROUPS`.
2567    pub fn parse_window_frame_units(&mut self) -> Result<WindowFrameUnits, ParserError> {
2568        let next_token = self.next_token();
2569        match &next_token.token {
2570            Token::Word(w) => match w.keyword {
2571                Keyword::ROWS => Ok(WindowFrameUnits::Rows),
2572                Keyword::RANGE => Ok(WindowFrameUnits::Range),
2573                Keyword::GROUPS => Ok(WindowFrameUnits::Groups),
2574                _ => self.expected("ROWS, RANGE, GROUPS", next_token)?,
2575            },
2576            _ => self.expected("ROWS, RANGE, GROUPS", next_token),
2577        }
2578    }
2579
2580    /// Parse a `WINDOW` frame definition (units and bounds).
2581    pub fn parse_window_frame(&mut self) -> Result<WindowFrame, ParserError> {
2582        let units = self.parse_window_frame_units()?;
2583        let (start_bound, end_bound) = if self.parse_keyword(Keyword::BETWEEN) {
2584            let start_bound = self.parse_window_frame_bound()?;
2585            self.expect_keyword_is(Keyword::AND)?;
2586            let end_bound = Some(self.parse_window_frame_bound()?);
2587            (start_bound, end_bound)
2588        } else {
2589            (self.parse_window_frame_bound()?, None)
2590        };
2591        Ok(WindowFrame {
2592            units,
2593            start_bound,
2594            end_bound,
2595        })
2596    }
2597
2598    /// Parse a window frame bound: `CURRENT ROW` or `<n> PRECEDING|FOLLOWING`.
2599    pub fn parse_window_frame_bound(&mut self) -> Result<WindowFrameBound, ParserError> {
2600        if self.parse_keywords(&[Keyword::CURRENT, Keyword::ROW]) {
2601            Ok(WindowFrameBound::CurrentRow)
2602        } else {
2603            let rows = if self.parse_keyword(Keyword::UNBOUNDED) {
2604                None
2605            } else {
2606                Some(Box::new(match &self.peek_token_ref().token {
2607                    Token::SingleQuotedString(_) => self.parse_interval()?,
2608                    _ => self.parse_expr()?,
2609                }))
2610            };
2611            if self.parse_keyword(Keyword::PRECEDING) {
2612                Ok(WindowFrameBound::Preceding(rows))
2613            } else if self.parse_keyword(Keyword::FOLLOWING) {
2614                Ok(WindowFrameBound::Following(rows))
2615            } else {
2616                self.expected_ref("PRECEDING or FOLLOWING", self.peek_token_ref())
2617            }
2618        }
2619    }
2620
2621    /// Parse a group by expr. Group by expr can be one of group sets, roll up, cube, or simple expr.
2622    fn parse_group_by_expr(&mut self) -> Result<Expr, ParserError> {
2623        if self.dialect.supports_group_by_expr() {
2624            if self.parse_keywords(&[Keyword::GROUPING, Keyword::SETS]) {
2625                self.expect_token(&Token::LParen)?;
2626                let result = self.parse_comma_separated(|p| p.parse_tuple(true, true))?;
2627                self.expect_token(&Token::RParen)?;
2628                Ok(Expr::GroupingSets(result))
2629            } else if self.parse_keyword(Keyword::CUBE) {
2630                self.expect_token(&Token::LParen)?;
2631                let result = self.parse_comma_separated(|p| p.parse_tuple(true, true))?;
2632                self.expect_token(&Token::RParen)?;
2633                Ok(Expr::Cube(result))
2634            } else if self.parse_keyword(Keyword::ROLLUP) {
2635                self.expect_token(&Token::LParen)?;
2636                let result = self.parse_comma_separated(|p| p.parse_tuple(true, true))?;
2637                self.expect_token(&Token::RParen)?;
2638                Ok(Expr::Rollup(result))
2639            } else if self.consume_tokens(&[Token::LParen, Token::RParen]) {
2640                // PostgreSQL allow to use empty tuple as a group by expression,
2641                // e.g. `GROUP BY (), name`. Please refer to GROUP BY Clause section in
2642                // [PostgreSQL](https://www.postgresql.org/docs/16/sql-select.html)
2643                Ok(Expr::Tuple(vec![]))
2644            } else {
2645                self.parse_expr()
2646            }
2647        } else {
2648            // TODO parse rollup for other dialects
2649            self.parse_expr()
2650        }
2651    }
2652
2653    /// Parse a tuple with `(` and `)`.
2654    /// If `lift_singleton` is true, then a singleton tuple is lifted to a tuple of length 1, otherwise it will fail.
2655    /// If `allow_empty` is true, then an empty tuple is allowed.
2656    fn parse_tuple(
2657        &mut self,
2658        lift_singleton: bool,
2659        allow_empty: bool,
2660    ) -> Result<Vec<Expr>, ParserError> {
2661        if lift_singleton {
2662            if self.consume_token(&Token::LParen) {
2663                let result = if allow_empty && self.consume_token(&Token::RParen) {
2664                    vec![]
2665                } else {
2666                    let result = self.parse_comma_separated(Parser::parse_expr)?;
2667                    self.expect_token(&Token::RParen)?;
2668                    result
2669                };
2670                Ok(result)
2671            } else {
2672                Ok(vec![self.parse_expr()?])
2673            }
2674        } else {
2675            self.expect_token(&Token::LParen)?;
2676            let result = if allow_empty && self.consume_token(&Token::RParen) {
2677                vec![]
2678            } else {
2679                let result = self.parse_comma_separated(Parser::parse_expr)?;
2680                self.expect_token(&Token::RParen)?;
2681                result
2682            };
2683            Ok(result)
2684        }
2685    }
2686
2687    /// Parse a `CASE` expression and return an [`Expr::Case`].
2688    pub fn parse_case_expr(&mut self) -> Result<Expr, ParserError> {
2689        let case_token = AttachedToken(self.get_current_token().clone());
2690        let mut operand = None;
2691        if !self.parse_keyword(Keyword::WHEN) {
2692            operand = Some(Box::new(self.parse_expr()?));
2693            self.expect_keyword_is(Keyword::WHEN)?;
2694        }
2695        let mut conditions = vec![];
2696        loop {
2697            let condition = self.parse_expr()?;
2698            self.expect_keyword_is(Keyword::THEN)?;
2699            let result = self.parse_expr()?;
2700            conditions.push(CaseWhen { condition, result });
2701            if !self.parse_keyword(Keyword::WHEN) {
2702                break;
2703            }
2704        }
2705        let else_result = if self.parse_keyword(Keyword::ELSE) {
2706            Some(Box::new(self.parse_expr()?))
2707        } else {
2708            None
2709        };
2710        let end_token = AttachedToken(self.expect_keyword(Keyword::END)?);
2711        Ok(Expr::Case {
2712            case_token,
2713            end_token,
2714            operand,
2715            conditions,
2716            else_result,
2717        })
2718    }
2719
2720    /// Parse an optional `FORMAT` clause for `CAST` expressions.
2721    pub fn parse_optional_cast_format(&mut self) -> Result<Option<CastFormat>, ParserError> {
2722        if self.parse_keyword(Keyword::FORMAT) {
2723            let value = self.parse_value()?;
2724            match self.parse_optional_time_zone()? {
2725                Some(tz) => Ok(Some(CastFormat::ValueAtTimeZone(value, tz))),
2726                None => Ok(Some(CastFormat::Value(value))),
2727            }
2728        } else {
2729            Ok(None)
2730        }
2731    }
2732
2733    /// Parse an optional `AT TIME ZONE` clause.
2734    pub fn parse_optional_time_zone(&mut self) -> Result<Option<ValueWithSpan>, ParserError> {
2735        if self.parse_keywords(&[Keyword::AT, Keyword::TIME, Keyword::ZONE]) {
2736            self.parse_value().map(Some)
2737        } else {
2738            Ok(None)
2739        }
2740    }
2741
2742    /// mssql-like convert function
2743    fn parse_mssql_convert(&mut self, is_try: bool) -> Result<Expr, ParserError> {
2744        self.expect_token(&Token::LParen)?;
2745        let data_type = self.parse_data_type()?;
2746        self.expect_token(&Token::Comma)?;
2747        let expr = self.parse_expr()?;
2748        let styles = if self.consume_token(&Token::Comma) {
2749            self.parse_comma_separated(Parser::parse_expr)?
2750        } else {
2751            Default::default()
2752        };
2753        self.expect_token(&Token::RParen)?;
2754        Ok(Expr::Convert {
2755            is_try,
2756            expr: Box::new(expr),
2757            data_type: Some(data_type),
2758            charset: None,
2759            target_before_value: true,
2760            styles,
2761        })
2762    }
2763
2764    /// Parse a SQL CONVERT function:
2765    ///  - `CONVERT('héhé' USING utf8mb4)` (MySQL)
2766    ///  - `CONVERT('héhé', CHAR CHARACTER SET utf8mb4)` (MySQL)
2767    ///  - `CONVERT(DECIMAL(10, 5), 42)` (MSSQL) - the type comes first
2768    pub fn parse_convert_expr(&mut self, is_try: bool) -> Result<Expr, ParserError> {
2769        if self.dialect.convert_type_before_value() {
2770            return self.parse_mssql_convert(is_try);
2771        }
2772        self.expect_token(&Token::LParen)?;
2773        let expr = self.parse_expr()?;
2774        if self.parse_keyword(Keyword::USING) {
2775            let charset = self.parse_object_name(false)?;
2776            self.expect_token(&Token::RParen)?;
2777            return Ok(Expr::Convert {
2778                is_try,
2779                expr: Box::new(expr),
2780                data_type: None,
2781                charset: Some(charset),
2782                target_before_value: false,
2783                styles: vec![],
2784            });
2785        }
2786        self.expect_token(&Token::Comma)?;
2787        let data_type = self.parse_data_type()?;
2788        let charset = if self.parse_keywords(&[Keyword::CHARACTER, Keyword::SET]) {
2789            Some(self.parse_object_name(false)?)
2790        } else {
2791            None
2792        };
2793        self.expect_token(&Token::RParen)?;
2794        Ok(Expr::Convert {
2795            is_try,
2796            expr: Box::new(expr),
2797            data_type: Some(data_type),
2798            charset,
2799            target_before_value: false,
2800            styles: vec![],
2801        })
2802    }
2803
2804    /// Parse a SQL CAST function e.g. `CAST(expr AS FLOAT)`
2805    pub fn parse_cast_expr(&mut self, kind: CastKind) -> Result<Expr, ParserError> {
2806        self.expect_token(&Token::LParen)?;
2807        let expr = self.parse_expr()?;
2808        self.expect_keyword_is(Keyword::AS)?;
2809        let data_type = self.parse_data_type()?;
2810        let array = self.parse_keyword(Keyword::ARRAY);
2811        let format = self.parse_optional_cast_format()?;
2812        self.expect_token(&Token::RParen)?;
2813        Ok(Expr::Cast {
2814            kind,
2815            expr: Box::new(expr),
2816            data_type,
2817            array,
2818            format,
2819        })
2820    }
2821
2822    /// Parse a SQL EXISTS expression e.g. `WHERE EXISTS(SELECT ...)`.
2823    pub fn parse_exists_expr(&mut self, negated: bool) -> Result<Expr, ParserError> {
2824        self.expect_token(&Token::LParen)?;
2825        let exists_node = Expr::Exists {
2826            negated,
2827            subquery: self.parse_query()?,
2828        };
2829        self.expect_token(&Token::RParen)?;
2830        Ok(exists_node)
2831    }
2832
2833    /// Parse a SQL `EXTRACT` expression e.g. `EXTRACT(YEAR FROM date)`.
2834    pub fn parse_extract_expr(&mut self) -> Result<Expr, ParserError> {
2835        self.expect_token(&Token::LParen)?;
2836        let field = self.parse_date_time_field()?;
2837
2838        let syntax = if self.parse_keyword(Keyword::FROM) {
2839            ExtractSyntax::From
2840        } else if self.dialect.supports_extract_comma_syntax() && self.consume_token(&Token::Comma)
2841        {
2842            ExtractSyntax::Comma
2843        } else {
2844            return Err(ParserError::ParserError(
2845                "Expected 'FROM' or ','".to_string(),
2846            ));
2847        };
2848
2849        let expr = self.parse_expr()?;
2850        self.expect_token(&Token::RParen)?;
2851        Ok(Expr::Extract {
2852            field,
2853            expr: Box::new(expr),
2854            syntax,
2855        })
2856    }
2857
2858    /// Parse a `CEIL` or `FLOOR` expression.
2859    pub fn parse_ceil_floor_expr(&mut self, is_ceil: bool) -> Result<Expr, ParserError> {
2860        self.expect_token(&Token::LParen)?;
2861        let expr = self.parse_expr()?;
2862        // Parse `CEIL/FLOOR(expr)`
2863        let field = if self.parse_keyword(Keyword::TO) {
2864            // Parse `CEIL/FLOOR(expr TO DateTimeField)`
2865            CeilFloorKind::DateTimeField(self.parse_date_time_field()?)
2866        } else if self.consume_token(&Token::Comma) {
2867            // Parse `CEIL/FLOOR(expr, scale)`
2868            let v = self.parse_value()?;
2869            if matches!(v.value, Value::Number(_, _)) {
2870                CeilFloorKind::Scale(v)
2871            } else {
2872                return Err(ParserError::ParserError(
2873                    "Scale field can only be of number type".to_string(),
2874                ));
2875            }
2876        } else {
2877            CeilFloorKind::DateTimeField(DateTimeField::NoDateTime)
2878        };
2879        self.expect_token(&Token::RParen)?;
2880        if is_ceil {
2881            Ok(Expr::Ceil {
2882                expr: Box::new(expr),
2883                field,
2884            })
2885        } else {
2886            Ok(Expr::Floor {
2887                expr: Box::new(expr),
2888                field,
2889            })
2890        }
2891    }
2892
2893    /// Parse a `POSITION` expression.
2894    pub fn parse_position_expr(&mut self, ident: Ident) -> Result<Expr, ParserError> {
2895        let between_prec = self.dialect.prec_value(Precedence::Between);
2896        let position_expr = self.maybe_parse(|p| {
2897            // PARSE SELECT POSITION('@' in field)
2898            p.expect_token(&Token::LParen)?;
2899
2900            // Parse the subexpr till the IN keyword
2901            let expr = p.parse_subexpr(between_prec)?;
2902            p.expect_keyword_is(Keyword::IN)?;
2903            let from = p.parse_expr()?;
2904            p.expect_token(&Token::RParen)?;
2905            Ok(Expr::Position {
2906                expr: Box::new(expr),
2907                r#in: Box::new(from),
2908            })
2909        })?;
2910        match position_expr {
2911            Some(expr) => Ok(expr),
2912            // Snowflake supports `position` as an ordinary function call
2913            // without the special `IN` syntax.
2914            None => self.parse_function(ObjectName::from(vec![ident])),
2915        }
2916    }
2917
2918    /// Parse `SUBSTRING`/`SUBSTR` expressions: `SUBSTRING(expr FROM start FOR length)` or `SUBSTR(expr, start, length)`.
2919    pub fn parse_substring(&mut self) -> Result<Expr, ParserError> {
2920        let shorthand = match self.expect_one_of_keywords(&[Keyword::SUBSTR, Keyword::SUBSTRING])? {
2921            Keyword::SUBSTR => true,
2922            Keyword::SUBSTRING => false,
2923            _ => {
2924                self.prev_token();
2925                return self.expected_ref("SUBSTR or SUBSTRING", self.peek_token_ref());
2926            }
2927        };
2928        self.expect_token(&Token::LParen)?;
2929        let expr = self.parse_expr()?;
2930        let mut from_expr = None;
2931        let special = self.consume_token(&Token::Comma);
2932        if special || self.parse_keyword(Keyword::FROM) {
2933            from_expr = Some(self.parse_expr()?);
2934        }
2935
2936        let mut to_expr = None;
2937        if self.parse_keyword(Keyword::FOR) || self.consume_token(&Token::Comma) {
2938            to_expr = Some(self.parse_expr()?);
2939        }
2940        self.expect_token(&Token::RParen)?;
2941
2942        Ok(Expr::Substring {
2943            expr: Box::new(expr),
2944            substring_from: from_expr.map(Box::new),
2945            substring_for: to_expr.map(Box::new),
2946            special,
2947            shorthand,
2948        })
2949    }
2950
2951    /// Parse an OVERLAY expression.
2952    ///
2953    /// See [Expr::Overlay]
2954    pub fn parse_overlay_expr(&mut self) -> Result<Expr, ParserError> {
2955        // PARSE OVERLAY (EXPR PLACING EXPR FROM 1 [FOR 3])
2956        self.expect_token(&Token::LParen)?;
2957        let expr = self.parse_expr()?;
2958        self.expect_keyword_is(Keyword::PLACING)?;
2959        let what_expr = self.parse_expr()?;
2960        self.expect_keyword_is(Keyword::FROM)?;
2961        let from_expr = self.parse_expr()?;
2962        let mut for_expr = None;
2963        if self.parse_keyword(Keyword::FOR) {
2964            for_expr = Some(self.parse_expr()?);
2965        }
2966        self.expect_token(&Token::RParen)?;
2967
2968        Ok(Expr::Overlay {
2969            expr: Box::new(expr),
2970            overlay_what: Box::new(what_expr),
2971            overlay_from: Box::new(from_expr),
2972            overlay_for: for_expr.map(Box::new),
2973        })
2974    }
2975
2976    /// ```sql
2977    /// TRIM ([WHERE] ['text' FROM] 'text')
2978    /// TRIM ('text')
2979    /// TRIM(<expr>, [, characters]) -- PostgreSQL, DuckDB, Snowflake, BigQuery, Generic
2980    /// ```
2981    pub fn parse_trim_expr(&mut self) -> Result<Expr, ParserError> {
2982        self.expect_token(&Token::LParen)?;
2983        let mut trim_where = None;
2984        if let Token::Word(word) = &self.peek_token_ref().token {
2985            if [Keyword::BOTH, Keyword::LEADING, Keyword::TRAILING].contains(&word.keyword) {
2986                trim_where = Some(self.parse_trim_where()?);
2987            }
2988        }
2989        let expr = self.parse_expr()?;
2990        if self.parse_keyword(Keyword::FROM) {
2991            let trim_what = Box::new(expr);
2992            let expr = self.parse_expr()?;
2993            self.expect_token(&Token::RParen)?;
2994            Ok(Expr::Trim {
2995                expr: Box::new(expr),
2996                trim_where,
2997                trim_what: Some(trim_what),
2998                trim_characters: None,
2999            })
3000        } else if self.dialect.supports_comma_separated_trim() && self.consume_token(&Token::Comma)
3001        {
3002            let characters = self.parse_comma_separated(Parser::parse_expr)?;
3003            self.expect_token(&Token::RParen)?;
3004            Ok(Expr::Trim {
3005                expr: Box::new(expr),
3006                trim_where: None,
3007                trim_what: None,
3008                trim_characters: Some(characters),
3009            })
3010        } else {
3011            self.expect_token(&Token::RParen)?;
3012            Ok(Expr::Trim {
3013                expr: Box::new(expr),
3014                trim_where,
3015                trim_what: None,
3016                trim_characters: None,
3017            })
3018        }
3019    }
3020
3021    /// Parse the `WHERE` field for a `TRIM` expression.
3022    ///
3023    /// See [TrimWhereField]
3024    pub fn parse_trim_where(&mut self) -> Result<TrimWhereField, ParserError> {
3025        let next_token = self.next_token();
3026        match &next_token.token {
3027            Token::Word(w) => match w.keyword {
3028                Keyword::BOTH => Ok(TrimWhereField::Both),
3029                Keyword::LEADING => Ok(TrimWhereField::Leading),
3030                Keyword::TRAILING => Ok(TrimWhereField::Trailing),
3031                _ => self.expected("trim_where field", next_token)?,
3032            },
3033            _ => self.expected("trim_where field", next_token),
3034        }
3035    }
3036
3037    /// Parses an array expression `[ex1, ex2, ..]`
3038    /// if `named` is `true`, came from an expression like  `ARRAY[ex1, ex2]`
3039    pub fn parse_array_expr(&mut self, named: bool) -> Result<Expr, ParserError> {
3040        let exprs = self.parse_comma_separated0(Parser::parse_expr, Token::RBracket)?;
3041        self.expect_token(&Token::RBracket)?;
3042        Ok(Expr::Array(Array { elem: exprs, named }))
3043    }
3044
3045    /// Parse the `ON OVERFLOW` clause for `LISTAGG`.
3046    ///
3047    /// See [`ListAggOnOverflow`]
3048    pub fn parse_listagg_on_overflow(&mut self) -> Result<Option<ListAggOnOverflow>, ParserError> {
3049        if self.parse_keywords(&[Keyword::ON, Keyword::OVERFLOW]) {
3050            if self.parse_keyword(Keyword::ERROR) {
3051                Ok(Some(ListAggOnOverflow::Error))
3052            } else {
3053                self.expect_keyword_is(Keyword::TRUNCATE)?;
3054                let filler = match &self.peek_token_ref().token {
3055                    Token::Word(w)
3056                        if w.keyword == Keyword::WITH || w.keyword == Keyword::WITHOUT =>
3057                    {
3058                        None
3059                    }
3060                    Token::SingleQuotedString(_)
3061                    | Token::EscapedStringLiteral(_)
3062                    | Token::UnicodeStringLiteral(_)
3063                    | Token::NationalStringLiteral(_)
3064                    | Token::QuoteDelimitedStringLiteral(_)
3065                    | Token::NationalQuoteDelimitedStringLiteral(_)
3066                    | Token::HexStringLiteral(_) => Some(Box::new(self.parse_expr()?)),
3067                    _ => self.expected_ref(
3068                        "either filler, WITH, or WITHOUT in LISTAGG",
3069                        self.peek_token_ref(),
3070                    )?,
3071                };
3072                let with_count = self.parse_keyword(Keyword::WITH);
3073                if !with_count && !self.parse_keyword(Keyword::WITHOUT) {
3074                    self.expected_ref("either WITH or WITHOUT in LISTAGG", self.peek_token_ref())?;
3075                }
3076                self.expect_keyword_is(Keyword::COUNT)?;
3077                Ok(Some(ListAggOnOverflow::Truncate { filler, with_count }))
3078            }
3079        } else {
3080            Ok(None)
3081        }
3082    }
3083
3084    /// Parse a date/time field for `EXTRACT`, interval qualifiers, and ceil/floor operations.
3085    ///
3086    /// `EXTRACT` supports a wider set of date/time fields than interval qualifiers,
3087    /// so this function may need to be split in two.
3088    ///
3089    /// See [`DateTimeField`]
3090    pub fn parse_date_time_field(&mut self) -> Result<DateTimeField, ParserError> {
3091        let next_token = self.next_token();
3092        match &next_token.token {
3093            Token::Word(w) => match w.keyword {
3094                Keyword::YEAR => Ok(DateTimeField::Year),
3095                Keyword::YEARS => Ok(DateTimeField::Years),
3096                Keyword::MONTH => Ok(DateTimeField::Month),
3097                Keyword::MONTHS => Ok(DateTimeField::Months),
3098                Keyword::WEEK => {
3099                    let week_day = if dialect_of!(self is BigQueryDialect | GenericDialect)
3100                        && self.consume_token(&Token::LParen)
3101                    {
3102                        let week_day = self.parse_identifier()?;
3103                        self.expect_token(&Token::RParen)?;
3104                        Some(week_day)
3105                    } else {
3106                        None
3107                    };
3108                    Ok(DateTimeField::Week(week_day))
3109                }
3110                Keyword::WEEKS => Ok(DateTimeField::Weeks),
3111                Keyword::DAY => Ok(DateTimeField::Day),
3112                Keyword::DAYOFWEEK => Ok(DateTimeField::DayOfWeek),
3113                Keyword::DAYOFYEAR => Ok(DateTimeField::DayOfYear),
3114                Keyword::DAYS => Ok(DateTimeField::Days),
3115                Keyword::DATE => Ok(DateTimeField::Date),
3116                Keyword::DATETIME => Ok(DateTimeField::Datetime),
3117                Keyword::HOUR => Ok(DateTimeField::Hour),
3118                Keyword::HOURS => Ok(DateTimeField::Hours),
3119                Keyword::MINUTE => Ok(DateTimeField::Minute),
3120                Keyword::MINUTES => Ok(DateTimeField::Minutes),
3121                Keyword::SECOND => Ok(DateTimeField::Second),
3122                Keyword::SECONDS => Ok(DateTimeField::Seconds),
3123                Keyword::CENTURY => Ok(DateTimeField::Century),
3124                Keyword::DECADE => Ok(DateTimeField::Decade),
3125                Keyword::DOY => Ok(DateTimeField::Doy),
3126                Keyword::DOW => Ok(DateTimeField::Dow),
3127                Keyword::EPOCH => Ok(DateTimeField::Epoch),
3128                Keyword::ISODOW => Ok(DateTimeField::Isodow),
3129                Keyword::ISOYEAR => Ok(DateTimeField::Isoyear),
3130                Keyword::ISOWEEK => Ok(DateTimeField::IsoWeek),
3131                Keyword::JULIAN => Ok(DateTimeField::Julian),
3132                Keyword::MICROSECOND => Ok(DateTimeField::Microsecond),
3133                Keyword::MICROSECONDS => Ok(DateTimeField::Microseconds),
3134                Keyword::MILLENIUM => Ok(DateTimeField::Millenium),
3135                Keyword::MILLENNIUM => Ok(DateTimeField::Millennium),
3136                Keyword::MILLISECOND => Ok(DateTimeField::Millisecond),
3137                Keyword::MILLISECONDS => Ok(DateTimeField::Milliseconds),
3138                Keyword::NANOSECOND => Ok(DateTimeField::Nanosecond),
3139                Keyword::NANOSECONDS => Ok(DateTimeField::Nanoseconds),
3140                Keyword::QUARTER => Ok(DateTimeField::Quarter),
3141                Keyword::TIME => Ok(DateTimeField::Time),
3142                Keyword::TIMEZONE => Ok(DateTimeField::Timezone),
3143                Keyword::TIMEZONE_ABBR => Ok(DateTimeField::TimezoneAbbr),
3144                Keyword::TIMEZONE_HOUR => Ok(DateTimeField::TimezoneHour),
3145                Keyword::TIMEZONE_MINUTE => Ok(DateTimeField::TimezoneMinute),
3146                Keyword::TIMEZONE_REGION => Ok(DateTimeField::TimezoneRegion),
3147                _ if self.dialect.allow_extract_custom() => {
3148                    self.prev_token();
3149                    let custom = self.parse_identifier()?;
3150                    Ok(DateTimeField::Custom(custom))
3151                }
3152                _ => self.expected("date/time field", next_token),
3153            },
3154            Token::SingleQuotedString(_) if self.dialect.allow_extract_single_quotes() => {
3155                self.prev_token();
3156                let custom = self.parse_identifier()?;
3157                Ok(DateTimeField::Custom(custom))
3158            }
3159            _ => self.expected("date/time field", next_token),
3160        }
3161    }
3162
3163    /// Parse a `NOT` expression.
3164    ///
3165    /// Represented in the AST as `Expr::UnaryOp` with `UnaryOperator::Not`.
3166    pub fn parse_not(&mut self) -> Result<Expr, ParserError> {
3167        match &self.peek_token_ref().token {
3168            Token::Word(w) => match w.keyword {
3169                Keyword::EXISTS => {
3170                    let negated = true;
3171                    let _ = self.parse_keyword(Keyword::EXISTS);
3172                    self.parse_exists_expr(negated)
3173                }
3174                _ => Ok(Expr::UnaryOp {
3175                    op: UnaryOperator::Not,
3176                    expr: Box::new(
3177                        self.parse_subexpr(self.dialect.prec_value(Precedence::UnaryNot))?,
3178                    ),
3179                }),
3180            },
3181            _ => Ok(Expr::UnaryOp {
3182                op: UnaryOperator::Not,
3183                expr: Box::new(self.parse_subexpr(self.dialect.prec_value(Precedence::UnaryNot))?),
3184            }),
3185        }
3186    }
3187
3188    /// Parse expression types that start with a left brace '{'.
3189    /// Examples:
3190    /// ```sql
3191    /// -- Dictionary expr.
3192    /// {'key1': 'value1', 'key2': 'value2'}
3193    ///
3194    /// -- Function call using the ODBC syntax.
3195    /// { fn CONCAT('foo', 'bar') }
3196    /// ```
3197    fn parse_lbrace_expr(&mut self) -> Result<Expr, ParserError> {
3198        let token = self.expect_token(&Token::LBrace)?;
3199
3200        if let Some(fn_expr) = self.maybe_parse_odbc_body()? {
3201            self.expect_token(&Token::RBrace)?;
3202            return Ok(fn_expr);
3203        }
3204
3205        if self.dialect.supports_dictionary_syntax() {
3206            self.prev_token(); // Put back the '{'
3207            return self.parse_dictionary();
3208        }
3209
3210        self.expected("an expression", token)
3211    }
3212
3213    /// Parses fulltext expressions [`sqlparser::ast::Expr::MatchAgainst`]
3214    ///
3215    /// # Errors
3216    /// This method will raise an error if the column list is empty or with invalid identifiers,
3217    /// the match expression is not a literal string, or if the search modifier is not valid.
3218    pub fn parse_match_against(&mut self) -> Result<Expr, ParserError> {
3219        let columns = self.parse_parenthesized_qualified_column_list(Mandatory, false)?;
3220
3221        self.expect_keyword_is(Keyword::AGAINST)?;
3222
3223        self.expect_token(&Token::LParen)?;
3224
3225        // MySQL is too permissive about the value, IMO we can't validate it perfectly on syntax level.
3226        let match_value = self.parse_value()?;
3227
3228        let in_natural_language_mode_keywords = &[
3229            Keyword::IN,
3230            Keyword::NATURAL,
3231            Keyword::LANGUAGE,
3232            Keyword::MODE,
3233        ];
3234
3235        let with_query_expansion_keywords = &[Keyword::WITH, Keyword::QUERY, Keyword::EXPANSION];
3236
3237        let in_boolean_mode_keywords = &[Keyword::IN, Keyword::BOOLEAN, Keyword::MODE];
3238
3239        let opt_search_modifier = if self.parse_keywords(in_natural_language_mode_keywords) {
3240            if self.parse_keywords(with_query_expansion_keywords) {
3241                Some(SearchModifier::InNaturalLanguageModeWithQueryExpansion)
3242            } else {
3243                Some(SearchModifier::InNaturalLanguageMode)
3244            }
3245        } else if self.parse_keywords(in_boolean_mode_keywords) {
3246            Some(SearchModifier::InBooleanMode)
3247        } else if self.parse_keywords(with_query_expansion_keywords) {
3248            Some(SearchModifier::WithQueryExpansion)
3249        } else {
3250            None
3251        };
3252
3253        self.expect_token(&Token::RParen)?;
3254
3255        Ok(Expr::MatchAgainst {
3256            columns,
3257            match_value,
3258            opt_search_modifier,
3259        })
3260    }
3261
3262    /// Parse an `INTERVAL` expression.
3263    ///
3264    /// Some syntactically valid intervals:
3265    ///
3266    /// ```sql
3267    ///   1. INTERVAL '1' DAY
3268    ///   2. INTERVAL '1-1' YEAR TO MONTH
3269    ///   3. INTERVAL '1' SECOND
3270    ///   4. INTERVAL '1:1:1.1' HOUR (5) TO SECOND (5)
3271    ///   5. INTERVAL '1.1' SECOND (2, 2)
3272    ///   6. INTERVAL '1:1' HOUR (5) TO MINUTE (5)
3273    ///   7. (MySql & BigQuery only): INTERVAL 1 DAY
3274    /// ```
3275    ///
3276    /// Note that we do not currently attempt to parse the quoted value.
3277    pub fn parse_interval(&mut self) -> Result<Expr, ParserError> {
3278        // The SQL standard allows an optional sign before the value string, but
3279        // it is not clear if any implementations support that syntax, so we
3280        // don't currently try to parse it. (The sign can instead be included
3281        // inside the value string.)
3282
3283        // to match the different flavours of INTERVAL syntax, we only allow expressions
3284        // if the dialect requires an interval qualifier,
3285        // see https://github.com/sqlparser-rs/sqlparser-rs/pull/1398 for more details
3286        let value = if self.dialect.require_interval_qualifier() {
3287            // parse a whole expression so `INTERVAL 1 + 1 DAY` is valid
3288            self.parse_expr()?
3289        } else {
3290            // parse a prefix expression so `INTERVAL 1 DAY` is valid, but `INTERVAL 1 + 1 DAY` is not
3291            // this also means that `INTERVAL '5 days' > INTERVAL '1 day'` treated properly
3292            self.parse_prefix()?
3293        };
3294
3295        // Following the string literal is a qualifier which indicates the units
3296        // of the duration specified in the string literal.
3297        //
3298        // Note that PostgreSQL allows omitting the qualifier, so we provide
3299        // this more general implementation.
3300        let leading_field = if self.next_token_is_temporal_unit() {
3301            Some(self.parse_date_time_field()?)
3302        } else if self.dialect.require_interval_qualifier() {
3303            return parser_err!(
3304                "INTERVAL requires a unit after the literal value",
3305                self.peek_token_ref().span.start
3306            );
3307        } else {
3308            None
3309        };
3310
3311        let (leading_precision, last_field, fsec_precision) =
3312            if leading_field == Some(DateTimeField::Second) {
3313                // SQL mandates special syntax for `SECOND TO SECOND` literals.
3314                // Instead of
3315                //     `SECOND [(<leading precision>)] TO SECOND[(<fractional seconds precision>)]`
3316                // one must use the special format:
3317                //     `SECOND [( <leading precision> [ , <fractional seconds precision>] )]`
3318                let last_field = None;
3319                let (leading_precision, fsec_precision) = self.parse_optional_precision_scale()?;
3320                (leading_precision, last_field, fsec_precision)
3321            } else {
3322                let leading_precision = self.parse_optional_precision()?;
3323                if self.parse_keyword(Keyword::TO) {
3324                    let last_field = Some(self.parse_date_time_field()?);
3325                    let fsec_precision = if last_field == Some(DateTimeField::Second) {
3326                        self.parse_optional_precision()?
3327                    } else {
3328                        None
3329                    };
3330                    (leading_precision, last_field, fsec_precision)
3331                } else {
3332                    (leading_precision, None, None)
3333                }
3334            };
3335
3336        Ok(Expr::Interval(Interval {
3337            value: Box::new(value),
3338            leading_field,
3339            leading_precision,
3340            last_field,
3341            fractional_seconds_precision: fsec_precision,
3342        }))
3343    }
3344
3345    /// Peek at the next token and determine if it is a temporal unit
3346    /// like `second`.
3347    pub fn next_token_is_temporal_unit(&mut self) -> bool {
3348        if let Token::Word(word) = &self.peek_token_ref().token {
3349            matches!(
3350                word.keyword,
3351                Keyword::YEAR
3352                    | Keyword::YEARS
3353                    | Keyword::MONTH
3354                    | Keyword::MONTHS
3355                    | Keyword::WEEK
3356                    | Keyword::WEEKS
3357                    | Keyword::DAY
3358                    | Keyword::DAYS
3359                    | Keyword::HOUR
3360                    | Keyword::HOURS
3361                    | Keyword::MINUTE
3362                    | Keyword::MINUTES
3363                    | Keyword::SECOND
3364                    | Keyword::SECONDS
3365                    | Keyword::CENTURY
3366                    | Keyword::DECADE
3367                    | Keyword::DOW
3368                    | Keyword::DOY
3369                    | Keyword::EPOCH
3370                    | Keyword::ISODOW
3371                    | Keyword::ISOYEAR
3372                    | Keyword::JULIAN
3373                    | Keyword::MICROSECOND
3374                    | Keyword::MICROSECONDS
3375                    | Keyword::MILLENIUM
3376                    | Keyword::MILLENNIUM
3377                    | Keyword::MILLISECOND
3378                    | Keyword::MILLISECONDS
3379                    | Keyword::NANOSECOND
3380                    | Keyword::NANOSECONDS
3381                    | Keyword::QUARTER
3382                    | Keyword::TIMEZONE
3383                    | Keyword::TIMEZONE_HOUR
3384                    | Keyword::TIMEZONE_MINUTE
3385            )
3386        } else {
3387            false
3388        }
3389    }
3390
3391    /// Syntax
3392    /// ```sql
3393    /// -- typed
3394    /// STRUCT<[field_name] field_type, ...>( expr1 [, ... ])
3395    /// -- typeless
3396    /// STRUCT( expr1 [AS field_name] [, ... ])
3397    /// ```
3398    fn parse_struct_literal(&mut self) -> Result<Expr, ParserError> {
3399        // Parse the fields definition if exist `<[field_name] field_type, ...>`
3400        self.prev_token();
3401        let (fields, trailing_bracket) =
3402            self.parse_struct_type_def(Self::parse_struct_field_def)?;
3403        if trailing_bracket.0 {
3404            return parser_err!(
3405                "unmatched > in STRUCT literal",
3406                self.peek_token_ref().span.start
3407            );
3408        }
3409
3410        // Parse the struct values `(expr1 [, ... ])`
3411        self.expect_token(&Token::LParen)?;
3412        let values = self
3413            .parse_comma_separated(|parser| parser.parse_struct_field_expr(!fields.is_empty()))?;
3414        self.expect_token(&Token::RParen)?;
3415
3416        Ok(Expr::Struct { values, fields })
3417    }
3418
3419    /// Parse an expression value for a struct literal
3420    /// Syntax
3421    /// ```sql
3422    /// expr [AS name]
3423    /// ```
3424    ///
3425    /// For biquery [1], Parameter typed_syntax is set to true if the expression
3426    /// is to be parsed as a field expression declared using typed
3427    /// struct syntax [2], and false if using typeless struct syntax [3].
3428    ///
3429    /// [1]: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#constructing_a_struct
3430    /// [2]: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#typed_struct_syntax
3431    /// [3]: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#typeless_struct_syntax
3432    fn parse_struct_field_expr(&mut self, typed_syntax: bool) -> Result<Expr, ParserError> {
3433        let expr = self.parse_expr()?;
3434        if self.parse_keyword(Keyword::AS) {
3435            if typed_syntax {
3436                return parser_err!("Typed syntax does not allow AS", {
3437                    self.prev_token();
3438                    self.peek_token_ref().span.start
3439                });
3440            }
3441            let field_name = self.parse_identifier()?;
3442            Ok(Expr::Named {
3443                expr: expr.into(),
3444                name: field_name,
3445            })
3446        } else {
3447            Ok(expr)
3448        }
3449    }
3450
3451    /// Parse a Struct type definition as a sequence of field-value pairs.
3452    /// The syntax of the Struct elem differs by dialect so it is customised
3453    /// by the `elem_parser` argument.
3454    ///
3455    /// Syntax
3456    /// ```sql
3457    /// Hive:
3458    /// STRUCT<field_name: field_type>
3459    ///
3460    /// BigQuery:
3461    /// STRUCT<[field_name] field_type>
3462    /// ```
3463    fn parse_struct_type_def<F>(
3464        &mut self,
3465        mut elem_parser: F,
3466    ) -> Result<(Vec<StructField>, MatchedTrailingBracket), ParserError>
3467    where
3468        F: FnMut(&mut Parser<'a>) -> Result<(StructField, MatchedTrailingBracket), ParserError>,
3469    {
3470        self.expect_keyword_is(Keyword::STRUCT)?;
3471
3472        // Nothing to do if we have no type information.
3473        if self.peek_token_ref().token != Token::Lt {
3474            return Ok((Default::default(), false.into()));
3475        }
3476        self.next_token();
3477
3478        let mut field_defs = vec![];
3479        let trailing_bracket = loop {
3480            let (def, trailing_bracket) = elem_parser(self)?;
3481            field_defs.push(def);
3482            // The struct field definition is finished if it occurs `>>` or comma.
3483            if trailing_bracket.0 || !self.consume_token(&Token::Comma) {
3484                break trailing_bracket;
3485            }
3486        };
3487
3488        Ok((
3489            field_defs,
3490            self.expect_closing_angle_bracket(trailing_bracket)?,
3491        ))
3492    }
3493
3494    /// Duckdb Struct Data Type <https://duckdb.org/docs/sql/data_types/struct.html#retrieving-from-structs>
3495    fn parse_duckdb_struct_type_def(&mut self) -> Result<Vec<StructField>, ParserError> {
3496        self.expect_keyword_is(Keyword::STRUCT)?;
3497        self.expect_token(&Token::LParen)?;
3498        let struct_body = self.parse_comma_separated(|parser| {
3499            let field_name = parser.parse_identifier()?;
3500            let field_type = parser.parse_data_type()?;
3501
3502            Ok(StructField {
3503                field_name: Some(field_name),
3504                field_type,
3505                options: None,
3506            })
3507        });
3508        self.expect_token(&Token::RParen)?;
3509        struct_body
3510    }
3511
3512    /// Parse a field definition in a [struct] or [tuple].
3513    /// Syntax:
3514    ///
3515    /// ```sql
3516    /// [field_name] field_type
3517    /// field_name: field_type
3518    /// ```
3519    ///
3520    /// [struct]: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#declaring_a_struct_type
3521    /// [tuple]: https://clickhouse.com/docs/en/sql-reference/data-types/tuple
3522    /// [databricks]: https://docs.databricks.com/en/sql/language-manual/data-types/struct-type.html
3523    fn parse_struct_field_def(
3524        &mut self,
3525    ) -> Result<(StructField, MatchedTrailingBracket), ParserError> {
3526        // Look beyond the next item to infer whether both field name
3527        // and type are specified.
3528        let is_named_field = matches!(
3529            (self.peek_nth_token(0).token, self.peek_nth_token(1).token),
3530            (Token::Word(_), Token::Word(_)) | (Token::Word(_), Token::Colon)
3531        );
3532
3533        let field_name = if is_named_field {
3534            let name = self.parse_identifier()?;
3535            let _ = self.consume_token(&Token::Colon);
3536            Some(name)
3537        } else {
3538            None
3539        };
3540
3541        let (field_type, trailing_bracket) = self.parse_data_type_helper()?;
3542
3543        let options = self.maybe_parse_options(Keyword::OPTIONS)?;
3544        Ok((
3545            StructField {
3546                field_name,
3547                field_type,
3548                options,
3549            },
3550            trailing_bracket,
3551        ))
3552    }
3553
3554    /// DuckDB specific: Parse a Union type definition as a sequence of field-value pairs.
3555    ///
3556    /// Syntax:
3557    ///
3558    /// ```sql
3559    /// UNION(field_name field_type[,...])
3560    /// ```
3561    ///
3562    /// [1]: https://duckdb.org/docs/sql/data_types/union.html
3563    fn parse_union_type_def(&mut self) -> Result<Vec<UnionField>, ParserError> {
3564        self.expect_keyword_is(Keyword::UNION)?;
3565
3566        self.expect_token(&Token::LParen)?;
3567
3568        let fields = self.parse_comma_separated(|p| {
3569            Ok(UnionField {
3570                field_name: p.parse_identifier()?,
3571                field_type: p.parse_data_type()?,
3572            })
3573        })?;
3574
3575        self.expect_token(&Token::RParen)?;
3576
3577        Ok(fields)
3578    }
3579
3580    /// DuckDB and ClickHouse specific: Parse a duckdb [dictionary] or a clickhouse [map] setting
3581    ///
3582    /// Syntax:
3583    ///
3584    /// ```sql
3585    /// {'field_name': expr1[, ... ]}
3586    /// ```
3587    ///
3588    /// [dictionary]: https://duckdb.org/docs/sql/data_types/struct#creating-structs
3589    /// [map]: https://clickhouse.com/docs/operations/settings/settings#additional_table_filters
3590    fn parse_dictionary(&mut self) -> Result<Expr, ParserError> {
3591        self.expect_token(&Token::LBrace)?;
3592
3593        let fields = self.parse_comma_separated0(Self::parse_dictionary_field, Token::RBrace)?;
3594
3595        self.expect_token(&Token::RBrace)?;
3596
3597        Ok(Expr::Dictionary(fields))
3598    }
3599
3600    /// Parse a field for a duckdb [dictionary] or a clickhouse [map] setting
3601    ///
3602    /// Syntax
3603    ///
3604    /// ```sql
3605    /// 'name': expr
3606    /// ```
3607    ///
3608    /// [dictionary]: https://duckdb.org/docs/sql/data_types/struct#creating-structs
3609    /// [map]: https://clickhouse.com/docs/operations/settings/settings#additional_table_filters
3610    fn parse_dictionary_field(&mut self) -> Result<DictionaryField, ParserError> {
3611        let key = self.parse_identifier()?;
3612
3613        self.expect_token(&Token::Colon)?;
3614
3615        let expr = self.parse_expr()?;
3616
3617        Ok(DictionaryField {
3618            key,
3619            value: Box::new(expr),
3620        })
3621    }
3622
3623    /// DuckDB specific: Parse a duckdb [map]
3624    ///
3625    /// Syntax:
3626    ///
3627    /// ```sql
3628    /// Map {key1: value1[, ... ]}
3629    /// ```
3630    ///
3631    /// [map]: https://duckdb.org/docs/sql/data_types/map.html#creating-maps
3632    fn parse_duckdb_map_literal(&mut self) -> Result<Expr, ParserError> {
3633        self.expect_token(&Token::LBrace)?;
3634        let fields = self.parse_comma_separated0(Self::parse_duckdb_map_field, Token::RBrace)?;
3635        self.expect_token(&Token::RBrace)?;
3636        Ok(Expr::Map(Map { entries: fields }))
3637    }
3638
3639    /// Parse a field for a duckdb [map]
3640    ///
3641    /// Syntax
3642    ///
3643    /// ```sql
3644    /// key: value
3645    /// ```
3646    ///
3647    /// [map]: https://duckdb.org/docs/sql/data_types/map.html#creating-maps
3648    fn parse_duckdb_map_field(&mut self) -> Result<MapEntry, ParserError> {
3649        // Stop before `:` so it can act as a key/value separator
3650        let key = self.parse_subexpr(self.dialect.prec_value(Precedence::Colon))?;
3651
3652        self.expect_token(&Token::Colon)?;
3653
3654        let value = self.parse_expr()?;
3655
3656        Ok(MapEntry {
3657            key: Box::new(key),
3658            value: Box::new(value),
3659        })
3660    }
3661
3662    /// Parse clickhouse [map]
3663    ///
3664    /// Syntax
3665    ///
3666    /// ```sql
3667    /// Map(key_data_type, value_data_type)
3668    /// ```
3669    ///
3670    /// [map]: https://clickhouse.com/docs/en/sql-reference/data-types/map
3671    fn parse_click_house_map_def(&mut self) -> Result<(DataType, DataType), ParserError> {
3672        self.expect_keyword_is(Keyword::MAP)?;
3673        self.expect_token(&Token::LParen)?;
3674        let key_data_type = self.parse_data_type()?;
3675        self.expect_token(&Token::Comma)?;
3676        let value_data_type = self.parse_data_type()?;
3677        self.expect_token(&Token::RParen)?;
3678
3679        Ok((key_data_type, value_data_type))
3680    }
3681
3682    /// Parse clickhouse [tuple]
3683    ///
3684    /// Syntax
3685    ///
3686    /// ```sql
3687    /// Tuple([field_name] field_type, ...)
3688    /// ```
3689    ///
3690    /// [tuple]: https://clickhouse.com/docs/en/sql-reference/data-types/tuple
3691    fn parse_click_house_tuple_def(&mut self) -> Result<Vec<StructField>, ParserError> {
3692        self.expect_keyword_is(Keyword::TUPLE)?;
3693        self.expect_token(&Token::LParen)?;
3694        let mut field_defs = vec![];
3695        loop {
3696            let (def, _) = self.parse_struct_field_def()?;
3697            field_defs.push(def);
3698            if !self.consume_token(&Token::Comma) {
3699                break;
3700            }
3701        }
3702        self.expect_token(&Token::RParen)?;
3703
3704        Ok(field_defs)
3705    }
3706
3707    /// For nested types that use the angle bracket syntax, this matches either
3708    /// `>`, `>>` or nothing depending on which variant is expected (specified by the previously
3709    /// matched `trailing_bracket` argument). It returns whether there is a trailing
3710    /// left to be matched - (i.e. if '>>' was matched).
3711    fn expect_closing_angle_bracket(
3712        &mut self,
3713        trailing_bracket: MatchedTrailingBracket,
3714    ) -> Result<MatchedTrailingBracket, ParserError> {
3715        let trailing_bracket = if !trailing_bracket.0 {
3716            match &self.peek_token_ref().token {
3717                Token::Gt => {
3718                    self.next_token();
3719                    false.into()
3720                }
3721                Token::ShiftRight => {
3722                    self.next_token();
3723                    true.into()
3724                }
3725                _ => return self.expected_ref(">", self.peek_token_ref()),
3726            }
3727        } else {
3728            false.into()
3729        };
3730
3731        Ok(trailing_bracket)
3732    }
3733
3734    /// Parse an operator following an expression
3735    pub fn parse_infix(&mut self, expr: Expr, precedence: u8) -> Result<Expr, ParserError> {
3736        // allow the dialect to override infix parsing
3737        if let Some(infix) = self.dialect.parse_infix(self, &expr, precedence) {
3738            return infix;
3739        }
3740
3741        let dialect = self.dialect;
3742
3743        self.advance_token();
3744        let tok = self.get_current_token();
3745        debug!("infix: {tok:?}");
3746        let tok_index = self.get_current_index();
3747        let span = tok.span;
3748        let regular_binary_operator = match &tok.token {
3749            Token::Spaceship => Some(BinaryOperator::Spaceship),
3750            Token::DoubleEq => Some(BinaryOperator::Eq),
3751            Token::Assignment => Some(BinaryOperator::Assignment),
3752            Token::Eq => Some(BinaryOperator::Eq),
3753            Token::Neq => Some(BinaryOperator::NotEq),
3754            Token::Gt => Some(BinaryOperator::Gt),
3755            Token::GtEq => Some(BinaryOperator::GtEq),
3756            Token::Lt => Some(BinaryOperator::Lt),
3757            Token::LtEq => Some(BinaryOperator::LtEq),
3758            Token::Plus => Some(BinaryOperator::Plus),
3759            Token::Minus => Some(BinaryOperator::Minus),
3760            Token::Mul => Some(BinaryOperator::Multiply),
3761            Token::Mod => Some(BinaryOperator::Modulo),
3762            Token::StringConcat => Some(BinaryOperator::StringConcat),
3763            Token::Pipe => Some(BinaryOperator::BitwiseOr),
3764            Token::Caret => {
3765                // In PostgreSQL, ^ stands for the exponentiation operation,
3766                // and # stands for XOR. See https://www.postgresql.org/docs/current/functions-math.html
3767                if dialect_is!(dialect is PostgreSqlDialect) {
3768                    Some(BinaryOperator::PGExp)
3769                } else {
3770                    Some(BinaryOperator::BitwiseXor)
3771                }
3772            }
3773            Token::Ampersand => Some(BinaryOperator::BitwiseAnd),
3774            Token::Div => Some(BinaryOperator::Divide),
3775            Token::DuckIntDiv if dialect_is!(dialect is DuckDbDialect | GenericDialect) => {
3776                Some(BinaryOperator::DuckIntegerDivide)
3777            }
3778            Token::ShiftLeft if dialect.supports_bitwise_shift_operators() => {
3779                Some(BinaryOperator::PGBitwiseShiftLeft)
3780            }
3781            Token::ShiftRight if dialect.supports_bitwise_shift_operators() => {
3782                Some(BinaryOperator::PGBitwiseShiftRight)
3783            }
3784            Token::Sharp if dialect_is!(dialect is PostgreSqlDialect | RedshiftSqlDialect) => {
3785                Some(BinaryOperator::PGBitwiseXor)
3786            }
3787            Token::Overlap if dialect_is!(dialect is PostgreSqlDialect | RedshiftSqlDialect) => {
3788                Some(BinaryOperator::PGOverlap)
3789            }
3790            Token::Overlap if dialect_is!(dialect is PostgreSqlDialect | GenericDialect) => {
3791                Some(BinaryOperator::PGOverlap)
3792            }
3793            Token::Overlap if dialect.supports_double_ampersand_operator() => {
3794                Some(BinaryOperator::And)
3795            }
3796            Token::CaretAt if dialect_is!(dialect is PostgreSqlDialect | GenericDialect) => {
3797                Some(BinaryOperator::PGStartsWith)
3798            }
3799            Token::Tilde => Some(BinaryOperator::PGRegexMatch),
3800            Token::TildeAsterisk => Some(BinaryOperator::PGRegexIMatch),
3801            Token::ExclamationMarkTilde => Some(BinaryOperator::PGRegexNotMatch),
3802            Token::ExclamationMarkTildeAsterisk => Some(BinaryOperator::PGRegexNotIMatch),
3803            Token::DoubleTilde => Some(BinaryOperator::PGLikeMatch),
3804            Token::DoubleTildeAsterisk => Some(BinaryOperator::PGILikeMatch),
3805            Token::ExclamationMarkDoubleTilde => Some(BinaryOperator::PGNotLikeMatch),
3806            Token::ExclamationMarkDoubleTildeAsterisk => Some(BinaryOperator::PGNotILikeMatch),
3807            Token::Arrow => Some(BinaryOperator::Arrow),
3808            Token::LongArrow => Some(BinaryOperator::LongArrow),
3809            Token::HashArrow => Some(BinaryOperator::HashArrow),
3810            Token::HashLongArrow => Some(BinaryOperator::HashLongArrow),
3811            Token::AtArrow => Some(BinaryOperator::AtArrow),
3812            Token::ArrowAt => Some(BinaryOperator::ArrowAt),
3813            Token::HashMinus => Some(BinaryOperator::HashMinus),
3814            Token::AtQuestion => Some(BinaryOperator::AtQuestion),
3815            Token::AtAt => Some(BinaryOperator::AtAt),
3816            Token::Question => Some(BinaryOperator::Question),
3817            Token::QuestionAnd => Some(BinaryOperator::QuestionAnd),
3818            Token::QuestionPipe => Some(BinaryOperator::QuestionPipe),
3819            Token::CustomBinaryOperator(s) => Some(BinaryOperator::Custom(s.clone())),
3820            Token::DoubleSharp if self.dialect.supports_geometric_types() => {
3821                Some(BinaryOperator::DoubleHash)
3822            }
3823
3824            Token::AmpersandLeftAngleBracket if self.dialect.supports_geometric_types() => {
3825                Some(BinaryOperator::AndLt)
3826            }
3827            Token::AmpersandRightAngleBracket if self.dialect.supports_geometric_types() => {
3828                Some(BinaryOperator::AndGt)
3829            }
3830            Token::QuestionMarkDash if self.dialect.supports_geometric_types() => {
3831                Some(BinaryOperator::QuestionDash)
3832            }
3833            Token::AmpersandLeftAngleBracketVerticalBar
3834                if self.dialect.supports_geometric_types() =>
3835            {
3836                Some(BinaryOperator::AndLtPipe)
3837            }
3838            Token::VerticalBarAmpersandRightAngleBracket
3839                if self.dialect.supports_geometric_types() =>
3840            {
3841                Some(BinaryOperator::PipeAndGt)
3842            }
3843            Token::TwoWayArrow if self.dialect.supports_geometric_types() => {
3844                Some(BinaryOperator::LtDashGt)
3845            }
3846            Token::LeftAngleBracketCaret if self.dialect.supports_geometric_types() => {
3847                Some(BinaryOperator::LtCaret)
3848            }
3849            Token::RightAngleBracketCaret if self.dialect.supports_geometric_types() => {
3850                Some(BinaryOperator::GtCaret)
3851            }
3852            Token::QuestionMarkSharp if self.dialect.supports_geometric_types() => {
3853                Some(BinaryOperator::QuestionHash)
3854            }
3855            Token::QuestionMarkDoubleVerticalBar if self.dialect.supports_geometric_types() => {
3856                Some(BinaryOperator::QuestionDoublePipe)
3857            }
3858            Token::QuestionMarkDashVerticalBar if self.dialect.supports_geometric_types() => {
3859                Some(BinaryOperator::QuestionDashPipe)
3860            }
3861            Token::TildeEqual if self.dialect.supports_geometric_types() => {
3862                Some(BinaryOperator::TildeEq)
3863            }
3864            Token::ShiftLeftVerticalBar if self.dialect.supports_geometric_types() => {
3865                Some(BinaryOperator::LtLtPipe)
3866            }
3867            Token::VerticalBarShiftRight if self.dialect.supports_geometric_types() => {
3868                Some(BinaryOperator::PipeGtGt)
3869            }
3870            Token::AtSign if self.dialect.supports_geometric_types() => Some(BinaryOperator::At),
3871
3872            Token::Word(w) => match w.keyword {
3873                Keyword::AND => Some(BinaryOperator::And),
3874                Keyword::OR => Some(BinaryOperator::Or),
3875                Keyword::XOR => Some(BinaryOperator::Xor),
3876                Keyword::OVERLAPS => Some(BinaryOperator::Overlaps),
3877                Keyword::OPERATOR if dialect_is!(dialect is PostgreSqlDialect | GenericDialect) => {
3878                    self.expect_token(&Token::LParen)?;
3879                    // there are special rules for operator names in
3880                    // postgres so we can not use 'parse_object'
3881                    // or similar.
3882                    // See https://www.postgresql.org/docs/current/sql-createoperator.html
3883                    let mut idents = vec![];
3884                    loop {
3885                        self.advance_token();
3886                        idents.push(self.get_current_token().to_string());
3887                        if !self.consume_token(&Token::Period) {
3888                            break;
3889                        }
3890                    }
3891                    self.expect_token(&Token::RParen)?;
3892                    Some(BinaryOperator::PGCustomBinaryOperator(idents))
3893                }
3894                _ => None,
3895            },
3896            _ => None,
3897        };
3898
3899        let tok = self.token_at(tok_index);
3900        if let Some(op) = regular_binary_operator {
3901            if let Some(keyword) =
3902                self.parse_one_of_keywords(&[Keyword::ANY, Keyword::ALL, Keyword::SOME])
3903            {
3904                self.expect_token(&Token::LParen)?;
3905                let right = if self.peek_sub_query() {
3906                    // We have a subquery ahead (SELECT\WITH ...) need to rewind and
3907                    // use the parenthesis for parsing the subquery as an expression.
3908                    self.prev_token(); // LParen
3909                    self.parse_subexpr(precedence)?
3910                } else {
3911                    // Non-subquery expression
3912                    let right = self.parse_subexpr(precedence)?;
3913                    self.expect_token(&Token::RParen)?;
3914                    right
3915                };
3916
3917                if !matches!(
3918                    op,
3919                    BinaryOperator::Gt
3920                        | BinaryOperator::Lt
3921                        | BinaryOperator::GtEq
3922                        | BinaryOperator::LtEq
3923                        | BinaryOperator::Eq
3924                        | BinaryOperator::NotEq
3925                        | BinaryOperator::PGRegexMatch
3926                        | BinaryOperator::PGRegexIMatch
3927                        | BinaryOperator::PGRegexNotMatch
3928                        | BinaryOperator::PGRegexNotIMatch
3929                        | BinaryOperator::PGLikeMatch
3930                        | BinaryOperator::PGILikeMatch
3931                        | BinaryOperator::PGNotLikeMatch
3932                        | BinaryOperator::PGNotILikeMatch
3933                ) {
3934                    return parser_err!(
3935                        format!(
3936                        "Expected one of [=, >, <, =>, =<, !=, ~, ~*, !~, !~*, ~~, ~~*, !~~, !~~*] as comparison operator, found: {op}"
3937                    ),
3938                        span.start
3939                    );
3940                };
3941
3942                Ok(match keyword {
3943                    Keyword::ALL => Expr::AllOp {
3944                        left: Box::new(expr),
3945                        compare_op: op,
3946                        right: Box::new(right),
3947                    },
3948                    Keyword::ANY | Keyword::SOME => Expr::AnyOp {
3949                        left: Box::new(expr),
3950                        compare_op: op,
3951                        right: Box::new(right),
3952                        is_some: keyword == Keyword::SOME,
3953                    },
3954                    unexpected_keyword => return Err(ParserError::ParserError(
3955                        format!("Internal parser error: expected any of {{ALL, ANY, SOME}}, got {unexpected_keyword:?}"),
3956                    )),
3957                })
3958            } else {
3959                Ok(Expr::BinaryOp {
3960                    left: Box::new(expr),
3961                    op,
3962                    right: Box::new(self.parse_subexpr(precedence)?),
3963                })
3964            }
3965        } else if let Token::Word(w) = &tok.token {
3966            match w.keyword {
3967                Keyword::IS => {
3968                    if self.parse_keyword(Keyword::NULL) {
3969                        Ok(Expr::IsNull(Box::new(expr)))
3970                    } else if self.parse_keywords(&[Keyword::NOT, Keyword::NULL]) {
3971                        Ok(Expr::IsNotNull(Box::new(expr)))
3972                    } else if self.parse_keywords(&[Keyword::TRUE]) {
3973                        Ok(Expr::IsTrue(Box::new(expr)))
3974                    } else if self.parse_keywords(&[Keyword::NOT, Keyword::TRUE]) {
3975                        Ok(Expr::IsNotTrue(Box::new(expr)))
3976                    } else if self.parse_keywords(&[Keyword::FALSE]) {
3977                        Ok(Expr::IsFalse(Box::new(expr)))
3978                    } else if self.parse_keywords(&[Keyword::NOT, Keyword::FALSE]) {
3979                        Ok(Expr::IsNotFalse(Box::new(expr)))
3980                    } else if self.parse_keywords(&[Keyword::UNKNOWN]) {
3981                        Ok(Expr::IsUnknown(Box::new(expr)))
3982                    } else if self.parse_keywords(&[Keyword::NOT, Keyword::UNKNOWN]) {
3983                        Ok(Expr::IsNotUnknown(Box::new(expr)))
3984                    } else if self.parse_keywords(&[Keyword::DISTINCT, Keyword::FROM]) {
3985                        let expr2 = self.parse_expr()?;
3986                        Ok(Expr::IsDistinctFrom(Box::new(expr), Box::new(expr2)))
3987                    } else if self.parse_keywords(&[Keyword::NOT, Keyword::DISTINCT, Keyword::FROM])
3988                    {
3989                        let expr2 = self.parse_expr()?;
3990                        Ok(Expr::IsNotDistinctFrom(Box::new(expr), Box::new(expr2)))
3991                    } else if let Ok(is_normalized) = self.parse_unicode_is_normalized(expr) {
3992                        Ok(is_normalized)
3993                    } else {
3994                        self.expected_ref(
3995                            "[NOT] NULL | TRUE | FALSE | DISTINCT | [form] NORMALIZED FROM after IS",
3996                            self.peek_token_ref(),
3997                        )
3998                    }
3999                }
4000                Keyword::AT => {
4001                    self.expect_keywords(&[Keyword::TIME, Keyword::ZONE])?;
4002                    Ok(Expr::AtTimeZone {
4003                        timestamp: Box::new(expr),
4004                        time_zone: Box::new(self.parse_subexpr(precedence)?),
4005                    })
4006                }
4007                Keyword::NOT
4008                | Keyword::IN
4009                | Keyword::BETWEEN
4010                | Keyword::LIKE
4011                | Keyword::ILIKE
4012                | Keyword::SIMILAR
4013                | Keyword::REGEXP
4014                | Keyword::RLIKE => {
4015                    self.prev_token();
4016                    let negated = self.parse_keyword(Keyword::NOT);
4017                    let regexp = self.parse_keyword(Keyword::REGEXP);
4018                    let rlike = self.parse_keyword(Keyword::RLIKE);
4019                    let null = if !self.in_column_definition_state() {
4020                        self.parse_keyword(Keyword::NULL)
4021                    } else {
4022                        false
4023                    };
4024                    if regexp || rlike {
4025                        Ok(Expr::RLike {
4026                            negated,
4027                            expr: Box::new(expr),
4028                            pattern: Box::new(
4029                                self.parse_subexpr(self.dialect.prec_value(Precedence::Like))?,
4030                            ),
4031                            regexp,
4032                        })
4033                    } else if negated && null {
4034                        Ok(Expr::IsNotNull(Box::new(expr)))
4035                    } else if self.parse_keyword(Keyword::IN) {
4036                        self.parse_in(expr, negated)
4037                    } else if self.parse_keyword(Keyword::BETWEEN) {
4038                        self.parse_between(expr, negated)
4039                    } else if self.parse_keyword(Keyword::LIKE) {
4040                        Ok(Expr::Like {
4041                            negated,
4042                            any: self.parse_keyword(Keyword::ANY),
4043                            expr: Box::new(expr),
4044                            pattern: Box::new(
4045                                self.parse_subexpr(self.dialect.prec_value(Precedence::Like))?,
4046                            ),
4047                            escape_char: self.parse_escape_char()?,
4048                        })
4049                    } else if self.parse_keyword(Keyword::ILIKE) {
4050                        Ok(Expr::ILike {
4051                            negated,
4052                            any: self.parse_keyword(Keyword::ANY),
4053                            expr: Box::new(expr),
4054                            pattern: Box::new(
4055                                self.parse_subexpr(self.dialect.prec_value(Precedence::Like))?,
4056                            ),
4057                            escape_char: self.parse_escape_char()?,
4058                        })
4059                    } else if self.parse_keywords(&[Keyword::SIMILAR, Keyword::TO]) {
4060                        Ok(Expr::SimilarTo {
4061                            negated,
4062                            expr: Box::new(expr),
4063                            pattern: Box::new(
4064                                self.parse_subexpr(self.dialect.prec_value(Precedence::Like))?,
4065                            ),
4066                            escape_char: self.parse_escape_char()?,
4067                        })
4068                    } else {
4069                        self.expected_ref("IN or BETWEEN after NOT", self.peek_token_ref())
4070                    }
4071                }
4072                Keyword::NOTNULL if dialect.supports_notnull_operator() => {
4073                    Ok(Expr::IsNotNull(Box::new(expr)))
4074                }
4075                Keyword::MEMBER => {
4076                    if self.parse_keyword(Keyword::OF) {
4077                        self.expect_token(&Token::LParen)?;
4078                        let array = self.parse_expr()?;
4079                        self.expect_token(&Token::RParen)?;
4080                        Ok(Expr::MemberOf(MemberOf {
4081                            value: Box::new(expr),
4082                            array: Box::new(array),
4083                        }))
4084                    } else {
4085                        self.expected_ref("OF after MEMBER", self.peek_token_ref())
4086                    }
4087                }
4088                // Can only happen if `get_next_precedence` got out of sync with this function
4089                _ => parser_err!(
4090                    format!("No infix parser for token {:?}", tok.token),
4091                    tok.span.start
4092                ),
4093            }
4094        } else if Token::DoubleColon == *tok {
4095            Ok(Expr::Cast {
4096                kind: CastKind::DoubleColon,
4097                expr: Box::new(expr),
4098                data_type: self.parse_data_type()?,
4099                array: false,
4100                format: None,
4101            })
4102        } else if Token::ExclamationMark == *tok && self.dialect.supports_factorial_operator() {
4103            Ok(Expr::UnaryOp {
4104                op: UnaryOperator::PGPostfixFactorial,
4105                expr: Box::new(expr),
4106            })
4107        } else if Token::LBracket == *tok && self.dialect.supports_partiql()
4108            || (Token::Colon == *tok)
4109        {
4110            self.prev_token();
4111            self.parse_json_access(expr)
4112        } else {
4113            // Can only happen if `get_next_precedence` got out of sync with this function
4114            parser_err!(
4115                format!("No infix parser for token {:?}", tok.token),
4116                tok.span.start
4117            )
4118        }
4119    }
4120
4121    /// Parse the `ESCAPE CHAR` portion of `LIKE`, `ILIKE`, and `SIMILAR TO`
4122    pub fn parse_escape_char(&mut self) -> Result<Option<ValueWithSpan>, ParserError> {
4123        if self.parse_keyword(Keyword::ESCAPE) {
4124            Ok(Some(self.parse_value()?))
4125        } else {
4126            Ok(None)
4127        }
4128    }
4129
4130    /// Parses an array subscript like
4131    /// * `[:]`
4132    /// * `[l]`
4133    /// * `[l:]`
4134    /// * `[:u]`
4135    /// * `[l:u]`
4136    /// * `[l:u:s]`
4137    ///
4138    /// Parser is right after `[`
4139    fn parse_subscript_inner(&mut self) -> Result<Subscript, ParserError> {
4140        // at either `<lower>:(rest)` or `:(rest)]`
4141        let lower_bound = if self.consume_token(&Token::Colon) {
4142            None
4143        } else {
4144            // parse expr until we hit a colon (or any token with lower precedence)
4145            Some(self.parse_subexpr(self.dialect.prec_value(Precedence::Colon))?)
4146        };
4147
4148        // check for end
4149        if self.consume_token(&Token::RBracket) {
4150            if let Some(lower_bound) = lower_bound {
4151                return Ok(Subscript::Index { index: lower_bound });
4152            };
4153            return Ok(Subscript::Slice {
4154                lower_bound,
4155                upper_bound: None,
4156                stride: None,
4157            });
4158        }
4159
4160        // consume the `:`
4161        if lower_bound.is_some() {
4162            self.expect_token(&Token::Colon)?;
4163        }
4164
4165        // we are now at either `]`, `<upper>(rest)]`
4166        let upper_bound = if self.consume_token(&Token::RBracket) {
4167            return Ok(Subscript::Slice {
4168                lower_bound,
4169                upper_bound: None,
4170                stride: None,
4171            });
4172        } else {
4173            // parse expr until we hit a colon (or any token with lower precedence)
4174            Some(self.parse_subexpr(self.dialect.prec_value(Precedence::Colon))?)
4175        };
4176
4177        // check for end
4178        if self.consume_token(&Token::RBracket) {
4179            return Ok(Subscript::Slice {
4180                lower_bound,
4181                upper_bound,
4182                stride: None,
4183            });
4184        }
4185
4186        // we are now at `:]` or `:stride]`
4187        self.expect_token(&Token::Colon)?;
4188        let stride = if self.consume_token(&Token::RBracket) {
4189            None
4190        } else {
4191            Some(self.parse_expr()?)
4192        };
4193
4194        if stride.is_some() {
4195            self.expect_token(&Token::RBracket)?;
4196        }
4197
4198        Ok(Subscript::Slice {
4199            lower_bound,
4200            upper_bound,
4201            stride,
4202        })
4203    }
4204
4205    /// Parse a multi-dimension array accessing like `[1:3][1][1]`
4206    pub fn parse_multi_dim_subscript(
4207        &mut self,
4208        chain: &mut Vec<AccessExpr>,
4209    ) -> Result<(), ParserError> {
4210        while self.consume_token(&Token::LBracket) {
4211            self.parse_subscript(chain)?;
4212        }
4213        Ok(())
4214    }
4215
4216    /// Parses an array subscript like `[1:3]`
4217    ///
4218    /// Parser is right after `[`
4219    fn parse_subscript(&mut self, chain: &mut Vec<AccessExpr>) -> Result<(), ParserError> {
4220        let subscript = self.parse_subscript_inner()?;
4221        chain.push(AccessExpr::Subscript(subscript));
4222        Ok(())
4223    }
4224
4225    fn parse_json_path_object_key(&mut self) -> Result<JsonPathElem, ParserError> {
4226        let token = self.next_token();
4227        match token.token {
4228            Token::Word(Word {
4229                value,
4230                // path segments in SF dot notation can be unquoted or double-quoted;
4231                // Databricks also supports backtick-quoted identifiers
4232                quote_style: quote_style @ (Some('"') | Some('`') | None),
4233                // some experimentation suggests that snowflake permits
4234                // any keyword here unquoted.
4235                keyword: _,
4236            }) => Ok(JsonPathElem::Dot {
4237                key: value,
4238                quoted: quote_style.is_some(),
4239            }),
4240
4241            // This token should never be generated on snowflake or generic
4242            // dialects, but we handle it just in case this is used on future
4243            // dialects.
4244            Token::DoubleQuotedString(key) => Ok(JsonPathElem::Dot { key, quoted: true }),
4245
4246            _ => self.expected("variant object key name", token),
4247        }
4248    }
4249
4250    fn parse_json_access(&mut self, expr: Expr) -> Result<Expr, ParserError> {
4251        let path = self.parse_json_path()?;
4252        Ok(Expr::JsonAccess {
4253            value: Box::new(expr),
4254            path,
4255        })
4256    }
4257
4258    fn parse_json_path(&mut self) -> Result<JsonPath, ParserError> {
4259        let mut path = Vec::new();
4260        loop {
4261            match self.next_token().token {
4262                Token::Colon if path.is_empty() && self.peek_token_ref() == &Token::LBracket => {
4263                    self.next_token();
4264                    let key = self.parse_wildcard_expr()?;
4265                    self.expect_token(&Token::RBracket)?;
4266                    path.push(JsonPathElem::ColonBracket { key });
4267                }
4268                Token::Colon if path.is_empty() => {
4269                    path.push(self.parse_json_path_object_key()?);
4270                }
4271                Token::Period if !path.is_empty() => {
4272                    path.push(self.parse_json_path_object_key()?);
4273                }
4274                Token::LBracket => {
4275                    let key = self.parse_wildcard_expr()?;
4276                    self.expect_token(&Token::RBracket)?;
4277
4278                    path.push(JsonPathElem::Bracket { key });
4279                }
4280                _ => {
4281                    self.prev_token();
4282                    break;
4283                }
4284            };
4285        }
4286
4287        debug_assert!(!path.is_empty());
4288        Ok(JsonPath { path })
4289    }
4290
4291    /// Parses the parens following the `[ NOT ] IN` operator.
4292    pub fn parse_in(&mut self, expr: Expr, negated: bool) -> Result<Expr, ParserError> {
4293        // BigQuery allows `IN UNNEST(array_expression)`
4294        // https://cloud.google.com/bigquery/docs/reference/standard-sql/operators#in_operators
4295        if self.parse_keyword(Keyword::UNNEST) {
4296            self.expect_token(&Token::LParen)?;
4297            let array_expr = self.parse_expr()?;
4298            self.expect_token(&Token::RParen)?;
4299            return Ok(Expr::InUnnest {
4300                expr: Box::new(expr),
4301                array_expr: Box::new(array_expr),
4302                negated,
4303            });
4304        }
4305        self.expect_token(&Token::LParen)?;
4306        let in_op = match self.maybe_parse(|p| p.parse_query())? {
4307            Some(subquery) => Expr::InSubquery {
4308                expr: Box::new(expr),
4309                subquery,
4310                negated,
4311            },
4312            None => Expr::InList {
4313                expr: Box::new(expr),
4314                list: if self.dialect.supports_in_empty_list() {
4315                    self.parse_comma_separated0(Parser::parse_expr, Token::RParen)?
4316                } else {
4317                    self.parse_comma_separated(Parser::parse_expr)?
4318                },
4319                negated,
4320            },
4321        };
4322        self.expect_token(&Token::RParen)?;
4323        Ok(in_op)
4324    }
4325
4326    /// Parses `BETWEEN <low> AND <high>`, assuming the `BETWEEN` keyword was already consumed.
4327    pub fn parse_between(&mut self, expr: Expr, negated: bool) -> Result<Expr, ParserError> {
4328        // Stop parsing subexpressions for <low> and <high> on tokens with
4329        // precedence lower than that of `BETWEEN`, such as `AND`, `IS`, etc.
4330        let low = self.parse_subexpr(self.dialect.prec_value(Precedence::Between))?;
4331        self.expect_keyword_is(Keyword::AND)?;
4332        let high = self.parse_subexpr(self.dialect.prec_value(Precedence::Between))?;
4333        Ok(Expr::Between {
4334            expr: Box::new(expr),
4335            negated,
4336            low: Box::new(low),
4337            high: Box::new(high),
4338        })
4339    }
4340
4341    /// Parse a PostgreSQL casting style which is in the form of `expr::datatype`.
4342    pub fn parse_pg_cast(&mut self, expr: Expr) -> Result<Expr, ParserError> {
4343        Ok(Expr::Cast {
4344            kind: CastKind::DoubleColon,
4345            expr: Box::new(expr),
4346            data_type: self.parse_data_type()?,
4347            array: false,
4348            format: None,
4349        })
4350    }
4351
4352    /// Get the precedence of the next token
4353    pub fn get_next_precedence(&self) -> Result<u8, ParserError> {
4354        self.dialect.get_next_precedence_default(self)
4355    }
4356
4357    /// Return the token at the given location, or EOF if the index is beyond
4358    /// the length of the current set of tokens.
4359    pub fn token_at(&self, index: usize) -> &TokenWithSpan {
4360        self.tokens.get(index).unwrap_or(&EOF_TOKEN)
4361    }
4362
4363    /// Return the first non-whitespace token that has not yet been processed
4364    /// or Token::EOF
4365    ///
4366    /// See [`Self::peek_token_ref`] to avoid the copy.
4367    pub fn peek_token(&self) -> TokenWithSpan {
4368        self.peek_nth_token(0)
4369    }
4370
4371    /// Return a reference to the first non-whitespace token that has not yet
4372    /// been processed or Token::EOF
4373    pub fn peek_token_ref(&self) -> &TokenWithSpan {
4374        self.peek_nth_token_ref(0)
4375    }
4376
4377    /// Returns the `N` next non-whitespace tokens that have not yet been
4378    /// processed.
4379    ///
4380    /// Example:
4381    /// ```rust
4382    /// # use sqlparser::dialect::GenericDialect;
4383    /// # use sqlparser::parser::Parser;
4384    /// # use sqlparser::keywords::Keyword;
4385    /// # use sqlparser::tokenizer::{Token, Word};
4386    /// let dialect = GenericDialect {};
4387    /// let mut parser = Parser::new(&dialect).try_with_sql("ORDER BY foo, bar").unwrap();
4388    ///
4389    /// // Note that Rust infers the number of tokens to peek based on the
4390    /// // length of the slice pattern!
4391    /// assert!(matches!(
4392    ///     parser.peek_tokens(),
4393    ///     [
4394    ///         Token::Word(Word { keyword: Keyword::ORDER, .. }),
4395    ///         Token::Word(Word { keyword: Keyword::BY, .. }),
4396    ///     ]
4397    /// ));
4398    /// ```
4399    pub fn peek_tokens<const N: usize>(&self) -> [Token; N] {
4400        self.peek_tokens_with_location()
4401            .map(|with_loc| with_loc.token)
4402    }
4403
4404    /// Returns the `N` next non-whitespace tokens with locations that have not
4405    /// yet been processed.
4406    ///
4407    /// See [`Self::peek_token`] for an example.
4408    pub fn peek_tokens_with_location<const N: usize>(&self) -> [TokenWithSpan; N] {
4409        let mut index = self.index;
4410        core::array::from_fn(|_| loop {
4411            let token = self.tokens.get(index);
4412            index += 1;
4413            if let Some(TokenWithSpan {
4414                token: Token::Whitespace(_),
4415                span: _,
4416            }) = token
4417            {
4418                continue;
4419            }
4420            break token.cloned().unwrap_or(TokenWithSpan {
4421                token: Token::EOF,
4422                span: Span::empty(),
4423            });
4424        })
4425    }
4426
4427    /// Returns references to the `N` next non-whitespace tokens
4428    /// that have not yet been processed.
4429    ///
4430    /// See [`Self::peek_tokens`] for an example.
4431    pub fn peek_tokens_ref<const N: usize>(&self) -> [&TokenWithSpan; N] {
4432        let mut index = self.index;
4433        core::array::from_fn(|_| loop {
4434            let token = self.tokens.get(index);
4435            index += 1;
4436            if let Some(TokenWithSpan {
4437                token: Token::Whitespace(_),
4438                span: _,
4439            }) = token
4440            {
4441                continue;
4442            }
4443            break token.unwrap_or(&EOF_TOKEN);
4444        })
4445    }
4446
4447    /// Return nth non-whitespace token that has not yet been processed
4448    pub fn peek_nth_token(&self, n: usize) -> TokenWithSpan {
4449        self.peek_nth_token_ref(n).clone()
4450    }
4451
4452    /// Return nth non-whitespace token that has not yet been processed
4453    pub fn peek_nth_token_ref(&self, mut n: usize) -> &TokenWithSpan {
4454        let mut index = self.index;
4455        loop {
4456            index += 1;
4457            match self.tokens.get(index - 1) {
4458                Some(TokenWithSpan {
4459                    token: Token::Whitespace(_),
4460                    span: _,
4461                }) => continue,
4462                non_whitespace => {
4463                    if n == 0 {
4464                        return non_whitespace.unwrap_or(&EOF_TOKEN);
4465                    }
4466                    n -= 1;
4467                }
4468            }
4469        }
4470    }
4471
4472    /// Return the first token, possibly whitespace, that has not yet been processed
4473    /// (or None if reached end-of-file).
4474    pub fn peek_token_no_skip(&self) -> TokenWithSpan {
4475        self.peek_nth_token_no_skip(0)
4476    }
4477
4478    /// Return nth token, possibly whitespace, that has not yet been processed.
4479    pub fn peek_nth_token_no_skip(&self, n: usize) -> TokenWithSpan {
4480        self.tokens
4481            .get(self.index + n)
4482            .cloned()
4483            .unwrap_or(TokenWithSpan {
4484                token: Token::EOF,
4485                span: Span::empty(),
4486            })
4487    }
4488
4489    /// Return nth token, possibly whitespace, that has not yet been processed.
4490    fn peek_nth_token_no_skip_ref(&self, n: usize) -> &TokenWithSpan {
4491        self.tokens.get(self.index + n).unwrap_or(&EOF_TOKEN)
4492    }
4493
4494    /// Return true if the next tokens exactly `expected`
4495    ///
4496    /// Does not advance the current token.
4497    fn peek_keywords(&mut self, expected: &[Keyword]) -> bool {
4498        let index = self.index;
4499        let matched = self.parse_keywords(expected);
4500        self.index = index;
4501        matched
4502    }
4503
4504    /// Advances to the next non-whitespace token and returns a copy.
4505    ///
4506    /// Please use [`Self::advance_token`] and [`Self::get_current_token`] to
4507    /// avoid the copy.
4508    pub fn next_token(&mut self) -> TokenWithSpan {
4509        self.advance_token();
4510        self.get_current_token().clone()
4511    }
4512
4513    /// Returns the index of the current token
4514    ///
4515    /// This can be used with APIs that expect an index, such as
4516    /// [`Self::token_at`]
4517    pub fn get_current_index(&self) -> usize {
4518        self.index.saturating_sub(1)
4519    }
4520
4521    /// Return the next unprocessed token, possibly whitespace.
4522    pub fn next_token_no_skip(&mut self) -> Option<&TokenWithSpan> {
4523        self.index += 1;
4524        self.tokens.get(self.index - 1)
4525    }
4526
4527    /// Advances the current token to the next non-whitespace token
4528    ///
4529    /// See [`Self::get_current_token`] to get the current token after advancing
4530    pub fn advance_token(&mut self) {
4531        loop {
4532            self.index += 1;
4533            match self.tokens.get(self.index - 1) {
4534                Some(TokenWithSpan {
4535                    token: Token::Whitespace(_),
4536                    span: _,
4537                }) => continue,
4538                _ => break,
4539            }
4540        }
4541    }
4542
4543    /// Returns a reference to the current token
4544    ///
4545    /// Does not advance the current token.
4546    pub fn get_current_token(&self) -> &TokenWithSpan {
4547        self.token_at(self.index.saturating_sub(1))
4548    }
4549
4550    /// Returns a reference to the previous token
4551    ///
4552    /// Does not advance the current token.
4553    pub fn get_previous_token(&self) -> &TokenWithSpan {
4554        self.token_at(self.index.saturating_sub(2))
4555    }
4556
4557    /// Returns a reference to the next token
4558    ///
4559    /// Does not advance the current token.
4560    pub fn get_next_token(&self) -> &TokenWithSpan {
4561        self.token_at(self.index)
4562    }
4563
4564    /// Seek back the last one non-whitespace token.
4565    ///
4566    /// Must be called after `next_token()`, otherwise might panic. OK to call
4567    /// after `next_token()` indicates an EOF.
4568    ///
4569    // TODO rename to backup_token and deprecate prev_token?
4570    pub fn prev_token(&mut self) {
4571        loop {
4572            assert!(self.index > 0);
4573            self.index -= 1;
4574            if let Some(TokenWithSpan {
4575                token: Token::Whitespace(_),
4576                span: _,
4577            }) = self.tokens.get(self.index)
4578            {
4579                continue;
4580            }
4581            return;
4582        }
4583    }
4584
4585    /// Report `found` was encountered instead of `expected`
4586    pub fn expected<T>(&self, expected: &str, found: TokenWithSpan) -> Result<T, ParserError> {
4587        parser_err!(
4588            format!("Expected: {expected}, found: {found}"),
4589            found.span.start
4590        )
4591    }
4592
4593    /// report `found` was encountered instead of `expected`
4594    pub fn expected_ref<T>(&self, expected: &str, found: &TokenWithSpan) -> Result<T, ParserError> {
4595        parser_err!(
4596            format!("Expected: {expected}, found: {found}"),
4597            found.span.start
4598        )
4599    }
4600
4601    /// Report that the token at `index` was found instead of `expected`.
4602    pub fn expected_at<T>(&self, expected: &str, index: usize) -> Result<T, ParserError> {
4603        let found = self.tokens.get(index).unwrap_or(&EOF_TOKEN);
4604        parser_err!(
4605            format!("Expected: {expected}, found: {found}"),
4606            found.span.start
4607        )
4608    }
4609
4610    /// If the current token is the `expected` keyword, consume it and returns
4611    /// true. Otherwise, no tokens are consumed and returns false.
4612    #[must_use]
4613    pub fn parse_keyword(&mut self, expected: Keyword) -> bool {
4614        if self.peek_keyword(expected) {
4615            self.advance_token();
4616            true
4617        } else {
4618            false
4619        }
4620    }
4621
4622    #[must_use]
4623    /// Check if the current token is the expected keyword without consuming it.
4624    ///
4625    /// Returns true if the current token matches the expected keyword.
4626    pub fn peek_keyword(&self, expected: Keyword) -> bool {
4627        matches!(&self.peek_token_ref().token, Token::Word(w) if expected == w.keyword)
4628    }
4629
4630    /// If the current token is the `expected` keyword followed by
4631    /// specified tokens, consume them and returns true.
4632    /// Otherwise, no tokens are consumed and returns false.
4633    ///
4634    /// Note that if the length of `tokens` is too long, this function will
4635    /// not be efficient as it does a loop on the tokens with `peek_nth_token`
4636    /// each time.
4637    pub fn parse_keyword_with_tokens(&mut self, expected: Keyword, tokens: &[Token]) -> bool {
4638        self.keyword_with_tokens(expected, tokens, true)
4639    }
4640
4641    /// Peeks to see if the current token is the `expected` keyword followed by specified tokens
4642    /// without consuming them.
4643    ///
4644    /// See [Self::parse_keyword_with_tokens] for details.
4645    pub(crate) fn peek_keyword_with_tokens(&mut self, expected: Keyword, tokens: &[Token]) -> bool {
4646        self.keyword_with_tokens(expected, tokens, false)
4647    }
4648
4649    fn keyword_with_tokens(&mut self, expected: Keyword, tokens: &[Token], consume: bool) -> bool {
4650        match &self.peek_token_ref().token {
4651            Token::Word(w) if expected == w.keyword => {
4652                for (idx, token) in tokens.iter().enumerate() {
4653                    if self.peek_nth_token_ref(idx + 1).token != *token {
4654                        return false;
4655                    }
4656                }
4657
4658                if consume {
4659                    for _ in 0..(tokens.len() + 1) {
4660                        self.advance_token();
4661                    }
4662                }
4663
4664                true
4665            }
4666            _ => false,
4667        }
4668    }
4669
4670    /// If the current and subsequent tokens exactly match the `keywords`
4671    /// sequence, consume them and returns true. Otherwise, no tokens are
4672    /// consumed and returns false
4673    #[must_use]
4674    pub fn parse_keywords(&mut self, keywords: &[Keyword]) -> bool {
4675        self.parse_keywords_indexed(keywords).is_some()
4676    }
4677
4678    /// Just like [Self::parse_keywords], but - upon success - returns the
4679    /// token index of the first keyword.
4680    #[must_use]
4681    fn parse_keywords_indexed(&mut self, keywords: &[Keyword]) -> Option<usize> {
4682        let start_index = self.index;
4683        let mut first_keyword_index = None;
4684        for &keyword in keywords {
4685            if !self.parse_keyword(keyword) {
4686                self.index = start_index;
4687                return None;
4688            }
4689            if first_keyword_index.is_none() {
4690                first_keyword_index = Some(self.index.saturating_sub(1));
4691            }
4692        }
4693        first_keyword_index
4694    }
4695
4696    /// If the current token is one of the given `keywords`, returns the keyword
4697    /// that matches, without consuming the token. Otherwise, returns [`None`].
4698    #[must_use]
4699    pub fn peek_one_of_keywords(&self, keywords: &[Keyword]) -> Option<Keyword> {
4700        for keyword in keywords {
4701            if self.peek_keyword(*keyword) {
4702                return Some(*keyword);
4703            }
4704        }
4705        None
4706    }
4707
4708    /// If the current token is one of the given `keywords`, consume the token
4709    /// and return the keyword that matches. Otherwise, no tokens are consumed
4710    /// and returns [`None`].
4711    #[must_use]
4712    pub fn parse_one_of_keywords(&mut self, keywords: &[Keyword]) -> Option<Keyword> {
4713        match &self.peek_token_ref().token {
4714            Token::Word(w) => {
4715                keywords
4716                    .iter()
4717                    .find(|keyword| **keyword == w.keyword)
4718                    .map(|keyword| {
4719                        self.advance_token();
4720                        *keyword
4721                    })
4722            }
4723            _ => None,
4724        }
4725    }
4726
4727    /// If the current token is one of the expected keywords, consume the token
4728    /// and return the keyword that matches. Otherwise, return an error.
4729    pub fn expect_one_of_keywords(&mut self, keywords: &[Keyword]) -> Result<Keyword, ParserError> {
4730        if let Some(keyword) = self.parse_one_of_keywords(keywords) {
4731            Ok(keyword)
4732        } else {
4733            let keywords: Vec<String> = keywords.iter().map(|x| format!("{x:?}")).collect();
4734            self.expected_ref(
4735                &format!("one of {}", keywords.join(" or ")),
4736                self.peek_token_ref(),
4737            )
4738        }
4739    }
4740
4741    /// If the current token is the `expected` keyword, consume the token.
4742    /// Otherwise, return an error.
4743    ///
4744    // todo deprecate in favor of expected_keyword_is
4745    pub fn expect_keyword(&mut self, expected: Keyword) -> Result<TokenWithSpan, ParserError> {
4746        if self.parse_keyword(expected) {
4747            Ok(self.get_current_token().clone())
4748        } else {
4749            self.expected_ref(format!("{:?}", &expected).as_str(), self.peek_token_ref())
4750        }
4751    }
4752
4753    /// If the current token is the `expected` keyword, consume the token.
4754    /// Otherwise, return an error.
4755    ///
4756    /// This differs from expect_keyword only in that the matched keyword
4757    /// token is not returned.
4758    pub fn expect_keyword_is(&mut self, expected: Keyword) -> Result<(), ParserError> {
4759        if self.parse_keyword(expected) {
4760            Ok(())
4761        } else {
4762            self.expected_ref(format!("{:?}", &expected).as_str(), self.peek_token_ref())
4763        }
4764    }
4765
4766    /// If the current and subsequent tokens exactly match the `keywords`
4767    /// sequence, consume them and returns Ok. Otherwise, return an Error.
4768    pub fn expect_keywords(&mut self, expected: &[Keyword]) -> Result<(), ParserError> {
4769        for &kw in expected {
4770            self.expect_keyword_is(kw)?;
4771        }
4772        Ok(())
4773    }
4774
4775    /// Consume the next token if it matches the expected token, otherwise return false
4776    ///
4777    /// See [Self::advance_token] to consume the token unconditionally
4778    #[must_use]
4779    pub fn consume_token(&mut self, expected: &Token) -> bool {
4780        if self.peek_token_ref() == expected {
4781            self.advance_token();
4782            true
4783        } else {
4784            false
4785        }
4786    }
4787
4788    /// If the current and subsequent tokens exactly match the `tokens`
4789    /// sequence, consume them and returns true. Otherwise, no tokens are
4790    /// consumed and returns false
4791    #[must_use]
4792    pub fn consume_tokens(&mut self, tokens: &[Token]) -> bool {
4793        let index = self.index;
4794        for token in tokens {
4795            if !self.consume_token(token) {
4796                self.index = index;
4797                return false;
4798            }
4799        }
4800        true
4801    }
4802
4803    /// Bail out if the current token is not an expected keyword, or consume it if it is
4804    pub fn expect_token(&mut self, expected: &Token) -> Result<TokenWithSpan, ParserError> {
4805        if self.peek_token_ref() == expected {
4806            Ok(self.next_token())
4807        } else {
4808            self.expected_ref(&expected.to_string(), self.peek_token_ref())
4809        }
4810    }
4811
4812    fn parse<T: FromStr>(s: String, loc: Location) -> Result<T, ParserError>
4813    where
4814        <T as FromStr>::Err: Display,
4815    {
4816        s.parse::<T>().map_err(|e| {
4817            ParserError::ParserError(format!(
4818                "Could not parse '{s}' as {}: {e}{loc}",
4819                core::any::type_name::<T>()
4820            ))
4821        })
4822    }
4823
4824    /// Parse a comma-separated list of 1+ SelectItem
4825    pub fn parse_projection(&mut self) -> Result<Vec<SelectItem>, ParserError> {
4826        // BigQuery and Snowflake allow trailing commas, but only in project lists
4827        // e.g. `SELECT 1, 2, FROM t`
4828        // https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#trailing_commas
4829        // https://docs.snowflake.com/en/release-notes/2024/8_11#select-supports-trailing-commas
4830
4831        let trailing_commas =
4832            self.options.trailing_commas | self.dialect.supports_projection_trailing_commas();
4833
4834        self.parse_comma_separated_with_trailing_commas(
4835            |p| p.parse_select_item(),
4836            trailing_commas,
4837            Self::is_reserved_for_column_alias,
4838        )
4839    }
4840
4841    /// Parse a list of actions for `GRANT` statements.
4842    pub fn parse_actions_list(&mut self) -> Result<Vec<Action>, ParserError> {
4843        let mut values = vec![];
4844        loop {
4845            values.push(self.parse_grant_permission()?);
4846            if !self.consume_token(&Token::Comma) {
4847                break;
4848            } else if self.options.trailing_commas {
4849                match &self.peek_token_ref().token {
4850                    Token::Word(kw) if kw.keyword == Keyword::ON => {
4851                        break;
4852                    }
4853                    Token::RParen
4854                    | Token::SemiColon
4855                    | Token::EOF
4856                    | Token::RBracket
4857                    | Token::RBrace => break,
4858                    _ => continue,
4859                }
4860            }
4861        }
4862        Ok(values)
4863    }
4864
4865    /// Parse a list of [TableWithJoins]
4866    fn parse_table_with_joins(&mut self) -> Result<Vec<TableWithJoins>, ParserError> {
4867        let trailing_commas = self.dialect.supports_from_trailing_commas();
4868
4869        self.parse_comma_separated_with_trailing_commas(
4870            Parser::parse_table_and_joins,
4871            trailing_commas,
4872            |kw, parser| !self.dialect.is_table_factor(kw, parser),
4873        )
4874    }
4875
4876    /// Parse the comma of a comma-separated syntax element.
4877    /// `R` is a predicate that should return true if the next
4878    /// keyword is a reserved keyword.
4879    /// Allows for control over trailing commas
4880    ///
4881    /// Returns true if there is a next element
4882    fn is_parse_comma_separated_end_with_trailing_commas<R>(
4883        &mut self,
4884        trailing_commas: bool,
4885        is_reserved_keyword: &R,
4886    ) -> bool
4887    where
4888        R: Fn(&Keyword, &mut Parser) -> bool,
4889    {
4890        if !self.consume_token(&Token::Comma) {
4891            true
4892        } else if trailing_commas {
4893            let token = self.next_token().token;
4894            let is_end = match token {
4895                Token::Word(ref kw) if is_reserved_keyword(&kw.keyword, self) => true,
4896                Token::RParen | Token::SemiColon | Token::EOF | Token::RBracket | Token::RBrace => {
4897                    true
4898                }
4899                _ => false,
4900            };
4901            self.prev_token();
4902
4903            is_end
4904        } else {
4905            false
4906        }
4907    }
4908
4909    /// Parse the comma of a comma-separated syntax element.
4910    /// Returns true if there is a next element
4911    fn is_parse_comma_separated_end(&mut self) -> bool {
4912        self.is_parse_comma_separated_end_with_trailing_commas(
4913            self.options.trailing_commas,
4914            &Self::is_reserved_for_column_alias,
4915        )
4916    }
4917
4918    /// Parse a comma-separated list of 1+ items accepted by `F`
4919    pub fn parse_comma_separated<T, F>(&mut self, f: F) -> Result<Vec<T>, ParserError>
4920    where
4921        F: FnMut(&mut Parser<'a>) -> Result<T, ParserError>,
4922    {
4923        self.parse_comma_separated_with_trailing_commas(
4924            f,
4925            self.options.trailing_commas,
4926            Self::is_reserved_for_column_alias,
4927        )
4928    }
4929
4930    /// Parse a comma-separated list of 1+ items accepted by `F`.
4931    /// `R` is a predicate that should return true if the next
4932    /// keyword is a reserved keyword.
4933    /// Allows for control over trailing commas.
4934    fn parse_comma_separated_with_trailing_commas<T, F, R>(
4935        &mut self,
4936        mut f: F,
4937        trailing_commas: bool,
4938        is_reserved_keyword: R,
4939    ) -> Result<Vec<T>, ParserError>
4940    where
4941        F: FnMut(&mut Parser<'a>) -> Result<T, ParserError>,
4942        R: Fn(&Keyword, &mut Parser) -> bool,
4943    {
4944        let mut values = vec![];
4945        loop {
4946            values.push(f(self)?);
4947            if self.is_parse_comma_separated_end_with_trailing_commas(
4948                trailing_commas,
4949                &is_reserved_keyword,
4950            ) {
4951                break;
4952            }
4953        }
4954        Ok(values)
4955    }
4956
4957    /// Parse a period-separated list of 1+ items accepted by `F`
4958    fn parse_period_separated<T, F>(&mut self, mut f: F) -> Result<Vec<T>, ParserError>
4959    where
4960        F: FnMut(&mut Parser<'a>) -> Result<T, ParserError>,
4961    {
4962        let mut values = vec![];
4963        loop {
4964            values.push(f(self)?);
4965            if !self.consume_token(&Token::Period) {
4966                break;
4967            }
4968        }
4969        Ok(values)
4970    }
4971
4972    /// Parse a keyword-separated list of 1+ items accepted by `F`
4973    pub fn parse_keyword_separated<T, F>(
4974        &mut self,
4975        keyword: Keyword,
4976        mut f: F,
4977    ) -> Result<Vec<T>, ParserError>
4978    where
4979        F: FnMut(&mut Parser<'a>) -> Result<T, ParserError>,
4980    {
4981        let mut values = vec![];
4982        loop {
4983            values.push(f(self)?);
4984            if !self.parse_keyword(keyword) {
4985                break;
4986            }
4987        }
4988        Ok(values)
4989    }
4990
4991    /// Parse an expression enclosed in parentheses.
4992    pub fn parse_parenthesized<T, F>(&mut self, mut f: F) -> Result<T, ParserError>
4993    where
4994        F: FnMut(&mut Parser<'a>) -> Result<T, ParserError>,
4995    {
4996        self.expect_token(&Token::LParen)?;
4997        let res = f(self)?;
4998        self.expect_token(&Token::RParen)?;
4999        Ok(res)
5000    }
5001
5002    /// Parse a comma-separated list of 0+ items accepted by `F`
5003    /// * `end_token` - expected end token for the closure (e.g. [Token::RParen], [Token::RBrace] ...)
5004    pub fn parse_comma_separated0<T, F>(
5005        &mut self,
5006        f: F,
5007        end_token: Token,
5008    ) -> Result<Vec<T>, ParserError>
5009    where
5010        F: FnMut(&mut Parser<'a>) -> Result<T, ParserError>,
5011    {
5012        if self.peek_token_ref().token == end_token {
5013            return Ok(vec![]);
5014        }
5015
5016        if self.options.trailing_commas && self.peek_tokens() == [Token::Comma, end_token] {
5017            let _ = self.consume_token(&Token::Comma);
5018            return Ok(vec![]);
5019        }
5020
5021        self.parse_comma_separated(f)
5022    }
5023
5024    /// Parses 0 or more statements, each followed by a semicolon.
5025    /// If the next token is any of `terminal_keywords` then no more
5026    /// statements will be parsed.
5027    pub(crate) fn parse_statement_list(
5028        &mut self,
5029        terminal_keywords: &[Keyword],
5030    ) -> Result<Vec<Statement>, ParserError> {
5031        let mut values = vec![];
5032        loop {
5033            match &self.peek_nth_token_ref(0).token {
5034                Token::EOF => break,
5035                Token::Word(w) => {
5036                    if w.quote_style.is_none() && terminal_keywords.contains(&w.keyword) {
5037                        break;
5038                    }
5039                }
5040                _ => {}
5041            }
5042
5043            values.push(self.parse_statement()?);
5044            self.expect_token(&Token::SemiColon)?;
5045        }
5046        Ok(values)
5047    }
5048
5049    /// Default implementation of a predicate that returns true if
5050    /// the specified keyword is reserved for column alias.
5051    /// See [Dialect::is_column_alias]
5052    fn is_reserved_for_column_alias(kw: &Keyword, parser: &mut Parser) -> bool {
5053        !parser.dialect.is_column_alias(kw, parser)
5054    }
5055
5056    /// Run a parser method `f`, reverting back to the current position if unsuccessful.
5057    /// Returns `ParserError::RecursionLimitExceeded` if `f` returns a `RecursionLimitExceeded`.
5058    /// Returns `Ok(None)` if `f` returns any other error.
5059    pub fn maybe_parse<T, F>(&mut self, f: F) -> Result<Option<T>, ParserError>
5060    where
5061        F: FnMut(&mut Parser) -> Result<T, ParserError>,
5062    {
5063        match self.try_parse(f) {
5064            Ok(t) => Ok(Some(t)),
5065            Err(ParserError::RecursionLimitExceeded) => Err(ParserError::RecursionLimitExceeded),
5066            _ => Ok(None),
5067        }
5068    }
5069
5070    /// Run a parser method `f`, reverting back to the current position if unsuccessful.
5071    pub fn try_parse<T, F>(&mut self, mut f: F) -> Result<T, ParserError>
5072    where
5073        F: FnMut(&mut Parser) -> Result<T, ParserError>,
5074    {
5075        let index = self.index;
5076        match f(self) {
5077            Ok(t) => Ok(t),
5078            Err(e) => {
5079                // Unwind stack if limit exceeded
5080                self.index = index;
5081                Err(e)
5082            }
5083        }
5084    }
5085
5086    /// Parse either `ALL`, `DISTINCT` or `DISTINCT ON (...)`. Returns [`None`] if `ALL` is parsed
5087    /// and results in a [`ParserError`] if both `ALL` and `DISTINCT` are found.
5088    pub fn parse_all_or_distinct(&mut self) -> Result<Option<Distinct>, ParserError> {
5089        let loc = self.peek_token_ref().span.start;
5090        let distinct = match self.parse_one_of_keywords(&[Keyword::ALL, Keyword::DISTINCT]) {
5091            Some(Keyword::ALL) => {
5092                if self.peek_keyword(Keyword::DISTINCT) {
5093                    return parser_err!("Cannot specify ALL then DISTINCT".to_string(), loc);
5094                }
5095                Some(Distinct::All)
5096            }
5097            Some(Keyword::DISTINCT) => {
5098                if self.peek_keyword(Keyword::ALL) {
5099                    return parser_err!("Cannot specify DISTINCT then ALL".to_string(), loc);
5100                }
5101                Some(Distinct::Distinct)
5102            }
5103            None => return Ok(None),
5104            _ => return parser_err!("ALL or DISTINCT", loc),
5105        };
5106
5107        let Some(Distinct::Distinct) = distinct else {
5108            return Ok(distinct);
5109        };
5110        if !self.parse_keyword(Keyword::ON) {
5111            return Ok(Some(Distinct::Distinct));
5112        }
5113
5114        self.expect_token(&Token::LParen)?;
5115        let col_names = if self.consume_token(&Token::RParen) {
5116            self.prev_token();
5117            Vec::new()
5118        } else {
5119            self.parse_comma_separated(Parser::parse_expr)?
5120        };
5121        self.expect_token(&Token::RParen)?;
5122        Ok(Some(Distinct::On(col_names)))
5123    }
5124
5125    /// Parse a SQL CREATE statement
5126    pub fn parse_create(&mut self) -> Result<Statement, ParserError> {
5127        let or_replace = self.parse_keywords(&[Keyword::OR, Keyword::REPLACE]);
5128        let or_alter = self.parse_keywords(&[Keyword::OR, Keyword::ALTER]);
5129        let local = self.parse_one_of_keywords(&[Keyword::LOCAL]).is_some();
5130        let global = self.parse_one_of_keywords(&[Keyword::GLOBAL]).is_some();
5131        let transient = self.parse_one_of_keywords(&[Keyword::TRANSIENT]).is_some();
5132        let global: Option<bool> = if global {
5133            Some(true)
5134        } else if local {
5135            Some(false)
5136        } else {
5137            None
5138        };
5139        let temporary = self
5140            .parse_one_of_keywords(&[Keyword::TEMP, Keyword::TEMPORARY])
5141            .is_some();
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)
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            if self.parse_keyword(Keyword::MAPPING) {
5177                self.parse_create_user_mapping().map(Into::into)
5178            } else {
5179                self.parse_create_user(or_replace).map(Into::into)
5180            }
5181        } else if self.parse_keyword(Keyword::AGGREGATE) {
5182            self.parse_create_aggregate(or_replace).map(Into::into)
5183        } else if self.peek_keyword(Keyword::TRUSTED)
5184            || self.peek_keyword(Keyword::PROCEDURAL)
5185            || self.peek_keyword(Keyword::LANGUAGE)
5186        {
5187            let trusted = self.parse_keyword(Keyword::TRUSTED);
5188            let procedural = self.parse_keyword(Keyword::PROCEDURAL);
5189            if self.parse_keyword(Keyword::LANGUAGE) {
5190                self.parse_create_language(or_replace, trusted, procedural)
5191                    .map(Into::into)
5192            } else {
5193                self.expected_ref(
5194                    "LANGUAGE after TRUSTED or PROCEDURAL",
5195                    self.peek_token_ref(),
5196                )
5197            }
5198        } else if self.parse_keyword(Keyword::TRANSFORM) {
5199            self.parse_create_transform(or_replace).map(Into::into)
5200        } else if or_replace {
5201            self.expected_ref(
5202                "[EXTERNAL] TABLE or [MATERIALIZED] VIEW or FUNCTION after CREATE OR REPLACE",
5203                self.peek_token_ref(),
5204            )
5205        } else if self.parse_keyword(Keyword::CAST) {
5206            self.parse_create_cast().map(Into::into)
5207        } else if self.parse_keyword(Keyword::CONVERSION) {
5208            self.parse_create_conversion(false).map(Into::into)
5209        } else if self.parse_keywords(&[Keyword::DEFAULT, Keyword::CONVERSION]) {
5210            self.parse_create_conversion(true).map(Into::into)
5211        } else if self.parse_keyword(Keyword::RULE) {
5212            self.parse_create_rule().map(Into::into)
5213        } else if self.parse_keyword(Keyword::EXTENSION) {
5214            self.parse_create_extension().map(Into::into)
5215        } else if self.parse_keyword(Keyword::INDEX) {
5216            self.parse_create_index(false).map(Into::into)
5217        } else if self.parse_keywords(&[Keyword::UNIQUE, Keyword::INDEX]) {
5218            self.parse_create_index(true).map(Into::into)
5219        } else if self.parse_keyword(Keyword::VIRTUAL) {
5220            self.parse_create_virtual_table()
5221        } else if self.parse_keyword(Keyword::SCHEMA) {
5222            self.parse_create_schema()
5223        } else if self.parse_keyword(Keyword::DATABASE) {
5224            self.parse_create_database()
5225        } else if self.parse_keyword(Keyword::ROLE) {
5226            self.parse_create_role().map(Into::into)
5227        } else if self.parse_keyword(Keyword::SEQUENCE) {
5228            self.parse_create_sequence(temporary)
5229        } else if self.parse_keyword(Keyword::COLLATION) {
5230            self.parse_create_collation().map(Into::into)
5231        } else if self.parse_keyword(Keyword::TYPE) {
5232            self.parse_create_type()
5233        } else if self.parse_keyword(Keyword::PROCEDURE) {
5234            self.parse_create_procedure(or_alter)
5235        } else if self.parse_keyword(Keyword::CONNECTOR) {
5236            self.parse_create_connector().map(Into::into)
5237        } else if self.parse_keyword(Keyword::OPERATOR) {
5238            // Check if this is CREATE OPERATOR FAMILY or CREATE OPERATOR CLASS
5239            if self.parse_keyword(Keyword::FAMILY) {
5240                self.parse_create_operator_family().map(Into::into)
5241            } else if self.parse_keyword(Keyword::CLASS) {
5242                self.parse_create_operator_class().map(Into::into)
5243            } else {
5244                self.parse_create_operator().map(Into::into)
5245            }
5246        } else if self.parse_keyword(Keyword::SERVER) {
5247            self.parse_pg_create_server()
5248        } else if self.parse_keyword(Keyword::FOREIGN) {
5249            if self.parse_keywords(&[Keyword::DATA, Keyword::WRAPPER]) {
5250                self.parse_create_foreign_data_wrapper().map(Into::into)
5251            } else if self.parse_keyword(Keyword::TABLE) {
5252                self.parse_create_foreign_table().map(Into::into)
5253            } else {
5254                self.expected_ref(
5255                    "DATA WRAPPER or TABLE after CREATE FOREIGN",
5256                    self.peek_token_ref(),
5257                )
5258            }
5259        } else if self.parse_keywords(&[Keyword::TEXT, Keyword::SEARCH]) {
5260            self.parse_create_text_search()
5261        } else if self.parse_keyword(Keyword::PUBLICATION) {
5262            self.parse_create_publication().map(Into::into)
5263        } else if self.parse_keyword(Keyword::SUBSCRIPTION) {
5264            self.parse_create_subscription().map(Into::into)
5265        } else if self.parse_keyword(Keyword::STATISTICS) {
5266            self.parse_create_statistics().map(Into::into)
5267        } else if self.parse_keywords(&[Keyword::ACCESS, Keyword::METHOD]) {
5268            self.parse_create_access_method().map(Into::into)
5269        } else if self.parse_keywords(&[Keyword::EVENT, Keyword::TRIGGER]) {
5270            self.parse_create_event_trigger().map(Into::into)
5271        } else if self.parse_keyword(Keyword::TABLESPACE) {
5272            self.parse_create_tablespace().map(Into::into)
5273        } else {
5274            self.expected_ref("an object type after CREATE", self.peek_token_ref())
5275        }
5276    }
5277
5278    fn parse_create_user(&mut self, or_replace: bool) -> Result<CreateUser, ParserError> {
5279        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
5280        let name = self.parse_identifier()?;
5281        let options = self
5282            .parse_key_value_options(false, &[Keyword::WITH, Keyword::TAG])?
5283            .options;
5284        let with_tags = self.parse_keyword(Keyword::WITH);
5285        let tags = if self.parse_keyword(Keyword::TAG) {
5286            self.parse_key_value_options(true, &[])?.options
5287        } else {
5288            vec![]
5289        };
5290        Ok(CreateUser {
5291            or_replace,
5292            if_not_exists,
5293            name,
5294            options: KeyValueOptions {
5295                options,
5296                delimiter: KeyValueOptionsDelimiter::Space,
5297            },
5298            with_tags,
5299            tags: KeyValueOptions {
5300                options: tags,
5301                delimiter: KeyValueOptionsDelimiter::Comma,
5302            },
5303        })
5304    }
5305
5306    /// See [DuckDB Docs](https://duckdb.org/docs/sql/statements/create_secret.html) for more details.
5307    pub fn parse_create_secret(
5308        &mut self,
5309        or_replace: bool,
5310        temporary: bool,
5311        persistent: bool,
5312    ) -> Result<Statement, ParserError> {
5313        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
5314
5315        let mut storage_specifier = None;
5316        let mut name = None;
5317        if self.peek_token_ref().token != Token::LParen {
5318            if self.parse_keyword(Keyword::IN) {
5319                storage_specifier = self.parse_identifier().ok()
5320            } else {
5321                name = self.parse_identifier().ok();
5322            }
5323
5324            // Storage specifier may follow the name
5325            if storage_specifier.is_none()
5326                && self.peek_token_ref().token != Token::LParen
5327                && self.parse_keyword(Keyword::IN)
5328            {
5329                storage_specifier = self.parse_identifier().ok();
5330            }
5331        }
5332
5333        self.expect_token(&Token::LParen)?;
5334        self.expect_keyword_is(Keyword::TYPE)?;
5335        let secret_type = self.parse_identifier()?;
5336
5337        let mut options = Vec::new();
5338        if self.consume_token(&Token::Comma) {
5339            options.append(&mut self.parse_comma_separated(|p| {
5340                let key = p.parse_identifier()?;
5341                let value = p.parse_identifier()?;
5342                Ok(SecretOption { key, value })
5343            })?);
5344        }
5345        self.expect_token(&Token::RParen)?;
5346
5347        let temp = match (temporary, persistent) {
5348            (true, false) => Some(true),
5349            (false, true) => Some(false),
5350            (false, false) => None,
5351            _ => self.expected_ref("TEMPORARY or PERSISTENT", self.peek_token_ref())?,
5352        };
5353
5354        Ok(Statement::CreateSecret {
5355            or_replace,
5356            temporary: temp,
5357            if_not_exists,
5358            name,
5359            storage_specifier,
5360            secret_type,
5361            options,
5362        })
5363    }
5364
5365    /// Parse a CACHE TABLE statement
5366    pub fn parse_cache_table(&mut self) -> Result<Statement, ParserError> {
5367        let (mut table_flag, mut options, mut has_as, mut query) = (None, vec![], false, None);
5368        if self.parse_keyword(Keyword::TABLE) {
5369            let table_name = self.parse_object_name(false)?;
5370            if self.peek_token_ref().token != Token::EOF {
5371                if let Token::Word(word) = &self.peek_token_ref().token {
5372                    if word.keyword == Keyword::OPTIONS {
5373                        options = self.parse_options(Keyword::OPTIONS)?
5374                    }
5375                };
5376
5377                if self.peek_token_ref().token != Token::EOF {
5378                    let (a, q) = self.parse_as_query()?;
5379                    has_as = a;
5380                    query = Some(q);
5381                }
5382
5383                Ok(Statement::Cache {
5384                    table_flag,
5385                    table_name,
5386                    has_as,
5387                    options,
5388                    query,
5389                })
5390            } else {
5391                Ok(Statement::Cache {
5392                    table_flag,
5393                    table_name,
5394                    has_as,
5395                    options,
5396                    query,
5397                })
5398            }
5399        } else {
5400            table_flag = Some(self.parse_object_name(false)?);
5401            if self.parse_keyword(Keyword::TABLE) {
5402                let table_name = self.parse_object_name(false)?;
5403                if self.peek_token_ref().token != Token::EOF {
5404                    if let Token::Word(word) = &self.peek_token_ref().token {
5405                        if word.keyword == Keyword::OPTIONS {
5406                            options = self.parse_options(Keyword::OPTIONS)?
5407                        }
5408                    };
5409
5410                    if self.peek_token_ref().token != Token::EOF {
5411                        let (a, q) = self.parse_as_query()?;
5412                        has_as = a;
5413                        query = Some(q);
5414                    }
5415
5416                    Ok(Statement::Cache {
5417                        table_flag,
5418                        table_name,
5419                        has_as,
5420                        options,
5421                        query,
5422                    })
5423                } else {
5424                    Ok(Statement::Cache {
5425                        table_flag,
5426                        table_name,
5427                        has_as,
5428                        options,
5429                        query,
5430                    })
5431                }
5432            } else {
5433                if self.peek_token_ref().token == Token::EOF {
5434                    self.prev_token();
5435                }
5436                self.expected_ref("a `TABLE` keyword", self.peek_token_ref())
5437            }
5438        }
5439    }
5440
5441    /// Parse 'AS' before as query,such as `WITH XXX AS SELECT XXX` oer `CACHE TABLE AS SELECT XXX`
5442    pub fn parse_as_query(&mut self) -> Result<(bool, Box<Query>), ParserError> {
5443        match &self.peek_token_ref().token {
5444            Token::Word(word) => match word.keyword {
5445                Keyword::AS => {
5446                    self.next_token();
5447                    Ok((true, self.parse_query()?))
5448                }
5449                _ => Ok((false, self.parse_query()?)),
5450            },
5451            _ => self.expected_ref("a QUERY statement", self.peek_token_ref()),
5452        }
5453    }
5454
5455    /// Parse a UNCACHE TABLE statement
5456    pub fn parse_uncache_table(&mut self) -> Result<Statement, ParserError> {
5457        self.expect_keyword_is(Keyword::TABLE)?;
5458        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
5459        let table_name = self.parse_object_name(false)?;
5460        Ok(Statement::UNCache {
5461            table_name,
5462            if_exists,
5463        })
5464    }
5465
5466    /// SQLite-specific `CREATE VIRTUAL TABLE`
5467    pub fn parse_create_virtual_table(&mut self) -> Result<Statement, ParserError> {
5468        self.expect_keyword_is(Keyword::TABLE)?;
5469        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
5470        let table_name = self.parse_object_name(false)?;
5471        self.expect_keyword_is(Keyword::USING)?;
5472        let module_name = self.parse_identifier()?;
5473        // SQLite docs note that module "arguments syntax is sufficiently
5474        // general that the arguments can be made to appear as column
5475        // definitions in a traditional CREATE TABLE statement", but
5476        // we don't implement that.
5477        let module_args = self.parse_parenthesized_column_list(Optional, false)?;
5478        Ok(Statement::CreateVirtualTable {
5479            name: table_name,
5480            if_not_exists,
5481            module_name,
5482            module_args,
5483        })
5484    }
5485
5486    /// Parse a `CREATE SCHEMA` statement.
5487    pub fn parse_create_schema(&mut self) -> Result<Statement, ParserError> {
5488        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
5489
5490        let schema_name = self.parse_schema_name()?;
5491
5492        let default_collate_spec = if self.parse_keywords(&[Keyword::DEFAULT, Keyword::COLLATE]) {
5493            Some(self.parse_expr()?)
5494        } else {
5495            None
5496        };
5497
5498        let with = if self.peek_keyword(Keyword::WITH) {
5499            Some(self.parse_options(Keyword::WITH)?)
5500        } else {
5501            None
5502        };
5503
5504        let options = if self.peek_keyword(Keyword::OPTIONS) {
5505            Some(self.parse_options(Keyword::OPTIONS)?)
5506        } else {
5507            None
5508        };
5509
5510        let clone = if self.parse_keyword(Keyword::CLONE) {
5511            Some(self.parse_object_name(false)?)
5512        } else {
5513            None
5514        };
5515
5516        Ok(Statement::CreateSchema {
5517            schema_name,
5518            if_not_exists,
5519            with,
5520            options,
5521            default_collate_spec,
5522            clone,
5523        })
5524    }
5525
5526    fn parse_schema_name(&mut self) -> Result<SchemaName, ParserError> {
5527        if self.parse_keyword(Keyword::AUTHORIZATION) {
5528            Ok(SchemaName::UnnamedAuthorization(self.parse_identifier()?))
5529        } else {
5530            let name = self.parse_object_name(false)?;
5531
5532            if self.parse_keyword(Keyword::AUTHORIZATION) {
5533                Ok(SchemaName::NamedAuthorization(
5534                    name,
5535                    self.parse_identifier()?,
5536                ))
5537            } else {
5538                Ok(SchemaName::Simple(name))
5539            }
5540        }
5541    }
5542
5543    /// Parse a `CREATE DATABASE` statement.
5544    pub fn parse_create_database(&mut self) -> Result<Statement, ParserError> {
5545        let ine = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
5546        let db_name = self.parse_object_name(false)?;
5547        let mut location = None;
5548        let mut managed_location = None;
5549        loop {
5550            match self.parse_one_of_keywords(&[Keyword::LOCATION, Keyword::MANAGEDLOCATION]) {
5551                Some(Keyword::LOCATION) => location = Some(self.parse_literal_string()?),
5552                Some(Keyword::MANAGEDLOCATION) => {
5553                    managed_location = Some(self.parse_literal_string()?)
5554                }
5555                _ => break,
5556            }
5557        }
5558        let clone = if self.parse_keyword(Keyword::CLONE) {
5559            Some(self.parse_object_name(false)?)
5560        } else {
5561            None
5562        };
5563
5564        // Parse MySQL-style [DEFAULT] CHARACTER SET and [DEFAULT] COLLATE options
5565        //
5566        // Note: The docs only mention `CHARACTER SET`, but `CHARSET` is also supported.
5567        // Furthermore, MySQL will only accept one character set, raising an error if there is more
5568        // than one, but will accept multiple collations and use the last one.
5569        //
5570        // <https://dev.mysql.com/doc/refman/8.4/en/create-database.html>
5571        let mut default_charset = None;
5572        let mut default_collation = None;
5573        loop {
5574            let has_default = self.parse_keyword(Keyword::DEFAULT);
5575            if default_charset.is_none() && self.parse_keywords(&[Keyword::CHARACTER, Keyword::SET])
5576                || self.parse_keyword(Keyword::CHARSET)
5577            {
5578                let _ = self.consume_token(&Token::Eq);
5579                default_charset = Some(self.parse_identifier()?.value);
5580            } else if self.parse_keyword(Keyword::COLLATE) {
5581                let _ = self.consume_token(&Token::Eq);
5582                default_collation = Some(self.parse_identifier()?.value);
5583            } else if has_default {
5584                // DEFAULT keyword not followed by CHARACTER SET, CHARSET, or COLLATE
5585                self.prev_token();
5586                break;
5587            } else {
5588                break;
5589            }
5590        }
5591
5592        Ok(Statement::CreateDatabase {
5593            db_name,
5594            if_not_exists: ine,
5595            location,
5596            managed_location,
5597            or_replace: false,
5598            transient: false,
5599            clone,
5600            data_retention_time_in_days: None,
5601            max_data_extension_time_in_days: None,
5602            external_volume: None,
5603            catalog: None,
5604            replace_invalid_characters: None,
5605            default_ddl_collation: None,
5606            storage_serialization_policy: None,
5607            comment: None,
5608            default_charset,
5609            default_collation,
5610            catalog_sync: None,
5611            catalog_sync_namespace_mode: None,
5612            catalog_sync_namespace_flatten_delimiter: None,
5613            with_tags: None,
5614            with_contacts: None,
5615        })
5616    }
5617
5618    /// Parse an optional `USING` clause for `CREATE FUNCTION`.
5619    pub fn parse_optional_create_function_using(
5620        &mut self,
5621    ) -> Result<Option<CreateFunctionUsing>, ParserError> {
5622        if !self.parse_keyword(Keyword::USING) {
5623            return Ok(None);
5624        };
5625        let keyword =
5626            self.expect_one_of_keywords(&[Keyword::JAR, Keyword::FILE, Keyword::ARCHIVE])?;
5627
5628        let uri = self.parse_literal_string()?;
5629
5630        match keyword {
5631            Keyword::JAR => Ok(Some(CreateFunctionUsing::Jar(uri))),
5632            Keyword::FILE => Ok(Some(CreateFunctionUsing::File(uri))),
5633            Keyword::ARCHIVE => Ok(Some(CreateFunctionUsing::Archive(uri))),
5634            _ => self.expected(
5635                "JAR, FILE or ARCHIVE, got {:?}",
5636                TokenWithSpan::wrap(Token::make_keyword(format!("{keyword:?}").as_str())),
5637            ),
5638        }
5639    }
5640
5641    /// Parse a `CREATE FUNCTION` statement.
5642    pub fn parse_create_function(
5643        &mut self,
5644        or_alter: bool,
5645        or_replace: bool,
5646        temporary: bool,
5647    ) -> Result<Statement, ParserError> {
5648        if dialect_of!(self is HiveDialect) {
5649            self.parse_hive_create_function(or_replace, temporary)
5650                .map(Into::into)
5651        } else if dialect_of!(self is PostgreSqlDialect | GenericDialect) {
5652            self.parse_postgres_create_function(or_replace, temporary)
5653                .map(Into::into)
5654        } else if dialect_of!(self is DuckDbDialect) {
5655            self.parse_create_macro(or_replace, temporary)
5656        } else if dialect_of!(self is BigQueryDialect) {
5657            self.parse_bigquery_create_function(or_replace, temporary)
5658                .map(Into::into)
5659        } else if dialect_of!(self is MsSqlDialect) {
5660            self.parse_mssql_create_function(or_alter, or_replace, temporary)
5661                .map(Into::into)
5662        } else {
5663            self.prev_token();
5664            self.expected_ref("an object type after CREATE", self.peek_token_ref())
5665        }
5666    }
5667
5668    /// Parse `CREATE FUNCTION` for [PostgreSQL]
5669    ///
5670    /// [PostgreSQL]: https://www.postgresql.org/docs/15/sql-createfunction.html
5671    fn parse_postgres_create_function(
5672        &mut self,
5673        or_replace: bool,
5674        temporary: bool,
5675    ) -> Result<CreateFunction, ParserError> {
5676        let name = self.parse_object_name(false)?;
5677
5678        self.expect_token(&Token::LParen)?;
5679        let args = if Token::RParen != self.peek_token_ref().token {
5680            self.parse_comma_separated(Parser::parse_function_arg)?
5681        } else {
5682            vec![]
5683        };
5684        self.expect_token(&Token::RParen)?;
5685
5686        let return_type = if self.parse_keyword(Keyword::RETURNS) {
5687            Some(self.parse_function_return_type()?)
5688        } else {
5689            None
5690        };
5691
5692        #[derive(Default)]
5693        struct Body {
5694            language: Option<Ident>,
5695            behavior: Option<FunctionBehavior>,
5696            function_body: Option<CreateFunctionBody>,
5697            called_on_null: Option<FunctionCalledOnNull>,
5698            parallel: Option<FunctionParallel>,
5699            security: Option<FunctionSecurity>,
5700        }
5701        let mut body = Body::default();
5702        let mut set_params: Vec<FunctionDefinitionSetParam> = Vec::new();
5703        loop {
5704            fn ensure_not_set<T>(field: &Option<T>, name: &str) -> Result<(), ParserError> {
5705                if field.is_some() {
5706                    return Err(ParserError::ParserError(format!(
5707                        "{name} specified more than once",
5708                    )));
5709                }
5710                Ok(())
5711            }
5712            if self.parse_keyword(Keyword::AS) {
5713                ensure_not_set(&body.function_body, "AS")?;
5714                body.function_body = Some(self.parse_create_function_body_string()?);
5715            } else if self.parse_keyword(Keyword::LANGUAGE) {
5716                ensure_not_set(&body.language, "LANGUAGE")?;
5717                body.language = Some(self.parse_identifier()?);
5718            } else if self.parse_keyword(Keyword::IMMUTABLE) {
5719                ensure_not_set(&body.behavior, "IMMUTABLE | STABLE | VOLATILE")?;
5720                body.behavior = Some(FunctionBehavior::Immutable);
5721            } else if self.parse_keyword(Keyword::STABLE) {
5722                ensure_not_set(&body.behavior, "IMMUTABLE | STABLE | VOLATILE")?;
5723                body.behavior = Some(FunctionBehavior::Stable);
5724            } else if self.parse_keyword(Keyword::VOLATILE) {
5725                ensure_not_set(&body.behavior, "IMMUTABLE | STABLE | VOLATILE")?;
5726                body.behavior = Some(FunctionBehavior::Volatile);
5727            } else if self.parse_keywords(&[
5728                Keyword::CALLED,
5729                Keyword::ON,
5730                Keyword::NULL,
5731                Keyword::INPUT,
5732            ]) {
5733                ensure_not_set(
5734                    &body.called_on_null,
5735                    "CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT",
5736                )?;
5737                body.called_on_null = Some(FunctionCalledOnNull::CalledOnNullInput);
5738            } else if self.parse_keywords(&[
5739                Keyword::RETURNS,
5740                Keyword::NULL,
5741                Keyword::ON,
5742                Keyword::NULL,
5743                Keyword::INPUT,
5744            ]) {
5745                ensure_not_set(
5746                    &body.called_on_null,
5747                    "CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT",
5748                )?;
5749                body.called_on_null = Some(FunctionCalledOnNull::ReturnsNullOnNullInput);
5750            } else if self.parse_keyword(Keyword::STRICT) {
5751                ensure_not_set(
5752                    &body.called_on_null,
5753                    "CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT",
5754                )?;
5755                body.called_on_null = Some(FunctionCalledOnNull::Strict);
5756            } else if self.parse_keyword(Keyword::PARALLEL) {
5757                ensure_not_set(&body.parallel, "PARALLEL { UNSAFE | RESTRICTED | SAFE }")?;
5758                if self.parse_keyword(Keyword::UNSAFE) {
5759                    body.parallel = Some(FunctionParallel::Unsafe);
5760                } else if self.parse_keyword(Keyword::RESTRICTED) {
5761                    body.parallel = Some(FunctionParallel::Restricted);
5762                } else if self.parse_keyword(Keyword::SAFE) {
5763                    body.parallel = Some(FunctionParallel::Safe);
5764                } else {
5765                    return self
5766                        .expected_ref("one of UNSAFE | RESTRICTED | SAFE", self.peek_token_ref());
5767                }
5768            } else if self.parse_keyword(Keyword::SECURITY) {
5769                ensure_not_set(&body.security, "SECURITY { DEFINER | INVOKER }")?;
5770                if self.parse_keyword(Keyword::DEFINER) {
5771                    body.security = Some(FunctionSecurity::Definer);
5772                } else if self.parse_keyword(Keyword::INVOKER) {
5773                    body.security = Some(FunctionSecurity::Invoker);
5774                } else {
5775                    return self.expected_ref("DEFINER or INVOKER", self.peek_token_ref());
5776                }
5777            } else if self.parse_keyword(Keyword::SET) {
5778                let name = self.parse_object_name(false)?;
5779                let value = if self.parse_keywords(&[Keyword::FROM, Keyword::CURRENT]) {
5780                    FunctionSetValue::FromCurrent
5781                } else {
5782                    if !self.consume_token(&Token::Eq) && !self.parse_keyword(Keyword::TO) {
5783                        return self.expected_ref("= or TO", self.peek_token_ref());
5784                    }
5785                    if self.parse_keyword(Keyword::DEFAULT) {
5786                        FunctionSetValue::Default
5787                    } else {
5788                        let values = self.parse_comma_separated(Parser::parse_expr)?;
5789                        FunctionSetValue::Values(values)
5790                    }
5791                };
5792                set_params.push(FunctionDefinitionSetParam { name, value });
5793            } else if self.parse_keyword(Keyword::RETURN) {
5794                ensure_not_set(&body.function_body, "RETURN")?;
5795                body.function_body = Some(CreateFunctionBody::Return(self.parse_expr()?));
5796            } else {
5797                break;
5798            }
5799        }
5800
5801        Ok(CreateFunction {
5802            or_alter: false,
5803            or_replace,
5804            temporary,
5805            name,
5806            args: Some(args),
5807            return_type,
5808            behavior: body.behavior,
5809            called_on_null: body.called_on_null,
5810            parallel: body.parallel,
5811            security: body.security,
5812            set_params,
5813            language: body.language,
5814            function_body: body.function_body,
5815            if_not_exists: false,
5816            using: None,
5817            determinism_specifier: None,
5818            options: None,
5819            remote_connection: None,
5820        })
5821    }
5822
5823    /// Parse `CREATE FUNCTION` for [Hive]
5824    ///
5825    /// [Hive]: https://cwiki.apache.org/confluence/display/hive/languagemanual+ddl#LanguageManualDDL-Create/Drop/ReloadFunction
5826    fn parse_hive_create_function(
5827        &mut self,
5828        or_replace: bool,
5829        temporary: bool,
5830    ) -> Result<CreateFunction, ParserError> {
5831        let name = self.parse_object_name(false)?;
5832        self.expect_keyword_is(Keyword::AS)?;
5833
5834        let body = self.parse_create_function_body_string()?;
5835        let using = self.parse_optional_create_function_using()?;
5836
5837        Ok(CreateFunction {
5838            or_alter: false,
5839            or_replace,
5840            temporary,
5841            name,
5842            function_body: Some(body),
5843            using,
5844            if_not_exists: false,
5845            args: None,
5846            return_type: None,
5847            behavior: None,
5848            called_on_null: None,
5849            parallel: None,
5850            security: None,
5851            set_params: vec![],
5852            language: None,
5853            determinism_specifier: None,
5854            options: None,
5855            remote_connection: None,
5856        })
5857    }
5858
5859    /// Parse `CREATE FUNCTION` for [BigQuery]
5860    ///
5861    /// [BigQuery]: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement
5862    fn parse_bigquery_create_function(
5863        &mut self,
5864        or_replace: bool,
5865        temporary: bool,
5866    ) -> Result<CreateFunction, ParserError> {
5867        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
5868        let (name, args) = self.parse_create_function_name_and_params()?;
5869
5870        let return_type = if self.parse_keyword(Keyword::RETURNS) {
5871            Some(self.parse_function_return_type()?)
5872        } else {
5873            None
5874        };
5875
5876        let determinism_specifier = if self.parse_keyword(Keyword::DETERMINISTIC) {
5877            Some(FunctionDeterminismSpecifier::Deterministic)
5878        } else if self.parse_keywords(&[Keyword::NOT, Keyword::DETERMINISTIC]) {
5879            Some(FunctionDeterminismSpecifier::NotDeterministic)
5880        } else {
5881            None
5882        };
5883
5884        let language = if self.parse_keyword(Keyword::LANGUAGE) {
5885            Some(self.parse_identifier()?)
5886        } else {
5887            None
5888        };
5889
5890        let remote_connection =
5891            if self.parse_keywords(&[Keyword::REMOTE, Keyword::WITH, Keyword::CONNECTION]) {
5892                Some(self.parse_object_name(false)?)
5893            } else {
5894                None
5895            };
5896
5897        // `OPTIONS` may come before of after the function body but
5898        // may be specified at most once.
5899        let mut options = self.maybe_parse_options(Keyword::OPTIONS)?;
5900
5901        let function_body = if remote_connection.is_none() {
5902            self.expect_keyword_is(Keyword::AS)?;
5903            let expr = self.parse_expr()?;
5904            if options.is_none() {
5905                options = self.maybe_parse_options(Keyword::OPTIONS)?;
5906                Some(CreateFunctionBody::AsBeforeOptions {
5907                    body: expr,
5908                    link_symbol: None,
5909                })
5910            } else {
5911                Some(CreateFunctionBody::AsAfterOptions(expr))
5912            }
5913        } else {
5914            None
5915        };
5916
5917        Ok(CreateFunction {
5918            or_alter: false,
5919            or_replace,
5920            temporary,
5921            if_not_exists,
5922            name,
5923            args: Some(args),
5924            return_type,
5925            function_body,
5926            language,
5927            determinism_specifier,
5928            options,
5929            remote_connection,
5930            using: None,
5931            behavior: None,
5932            called_on_null: None,
5933            parallel: None,
5934            security: None,
5935            set_params: vec![],
5936        })
5937    }
5938
5939    /// Parse `CREATE FUNCTION` for [MsSql]
5940    ///
5941    /// [MsSql]: https://learn.microsoft.com/en-us/sql/t-sql/statements/create-function-transact-sql
5942    fn parse_mssql_create_function(
5943        &mut self,
5944        or_alter: bool,
5945        or_replace: bool,
5946        temporary: bool,
5947    ) -> Result<CreateFunction, ParserError> {
5948        let (name, args) = self.parse_create_function_name_and_params()?;
5949
5950        self.expect_keyword(Keyword::RETURNS)?;
5951
5952        let return_table = self.maybe_parse(|p| {
5953            let return_table_name = p.parse_identifier()?;
5954
5955            p.expect_keyword_is(Keyword::TABLE)?;
5956            p.prev_token();
5957
5958            let table_column_defs = match p.parse_data_type()? {
5959                DataType::Table(Some(table_column_defs)) if !table_column_defs.is_empty() => {
5960                    table_column_defs
5961                }
5962                _ => parser_err!(
5963                    "Expected table column definitions after TABLE keyword",
5964                    p.peek_token_ref().span.start
5965                )?,
5966            };
5967
5968            Ok(DataType::NamedTable {
5969                name: ObjectName(vec![ObjectNamePart::Identifier(return_table_name)]),
5970                columns: table_column_defs,
5971            })
5972        })?;
5973
5974        let data_type = match return_table {
5975            Some(table_type) => table_type,
5976            None => self.parse_data_type()?,
5977        };
5978        let return_type = Some(FunctionReturnType::DataType(data_type));
5979
5980        let _ = self.parse_keyword(Keyword::AS);
5981
5982        let function_body = if self.peek_keyword(Keyword::BEGIN) {
5983            let begin_token = self.expect_keyword(Keyword::BEGIN)?;
5984            let statements = self.parse_statement_list(&[Keyword::END])?;
5985            let end_token = self.expect_keyword(Keyword::END)?;
5986
5987            Some(CreateFunctionBody::AsBeginEnd(BeginEndStatements {
5988                begin_token: AttachedToken(begin_token),
5989                statements,
5990                end_token: AttachedToken(end_token),
5991            }))
5992        } else if self.parse_keyword(Keyword::RETURN) {
5993            if self.peek_token_ref().token == Token::LParen {
5994                Some(CreateFunctionBody::AsReturnExpr(self.parse_expr()?))
5995            } else if self.peek_keyword(Keyword::SELECT) {
5996                let select = self.parse_select()?;
5997                Some(CreateFunctionBody::AsReturnSelect(select))
5998            } else {
5999                parser_err!(
6000                    "Expected a subquery (or bare SELECT statement) after RETURN",
6001                    self.peek_token_ref().span.start
6002                )?
6003            }
6004        } else {
6005            parser_err!("Unparsable function body", self.peek_token_ref().span.start)?
6006        };
6007
6008        Ok(CreateFunction {
6009            or_alter,
6010            or_replace,
6011            temporary,
6012            if_not_exists: false,
6013            name,
6014            args: Some(args),
6015            return_type,
6016            function_body,
6017            language: None,
6018            determinism_specifier: None,
6019            options: None,
6020            remote_connection: None,
6021            using: None,
6022            behavior: None,
6023            called_on_null: None,
6024            parallel: None,
6025            security: None,
6026            set_params: vec![],
6027        })
6028    }
6029
6030    fn parse_function_return_type(&mut self) -> Result<FunctionReturnType, ParserError> {
6031        if self.parse_keyword(Keyword::SETOF) {
6032            Ok(FunctionReturnType::SetOf(self.parse_data_type()?))
6033        } else {
6034            Ok(FunctionReturnType::DataType(self.parse_data_type()?))
6035        }
6036    }
6037
6038    fn parse_create_function_name_and_params(
6039        &mut self,
6040    ) -> Result<(ObjectName, Vec<OperateFunctionArg>), ParserError> {
6041        let name = self.parse_object_name(false)?;
6042        let parse_function_param =
6043            |parser: &mut Parser| -> Result<OperateFunctionArg, ParserError> {
6044                let name = parser.parse_identifier()?;
6045                let data_type = parser.parse_data_type()?;
6046                let default_expr = if parser.consume_token(&Token::Eq) {
6047                    Some(parser.parse_expr()?)
6048                } else {
6049                    None
6050                };
6051
6052                Ok(OperateFunctionArg {
6053                    mode: None,
6054                    name: Some(name),
6055                    data_type,
6056                    default_expr,
6057                })
6058            };
6059        self.expect_token(&Token::LParen)?;
6060        let args = self.parse_comma_separated0(parse_function_param, Token::RParen)?;
6061        self.expect_token(&Token::RParen)?;
6062        Ok((name, args))
6063    }
6064
6065    fn parse_function_arg(&mut self) -> Result<OperateFunctionArg, ParserError> {
6066        let mode = if self.parse_keyword(Keyword::IN) {
6067            Some(ArgMode::In)
6068        } else if self.parse_keyword(Keyword::OUT) {
6069            Some(ArgMode::Out)
6070        } else if self.parse_keyword(Keyword::INOUT) {
6071            Some(ArgMode::InOut)
6072        } else if self.parse_keyword(Keyword::VARIADIC) {
6073            Some(ArgMode::Variadic)
6074        } else {
6075            None
6076        };
6077
6078        // parse: [ argname ] argtype
6079        let mut name = None;
6080        let mut data_type = self.parse_data_type()?;
6081
6082        // To check whether the first token is a name or a type, we need to
6083        // peek the next token, which if it is another type keyword, then the
6084        // first token is a name and not a type in itself.
6085        let data_type_idx = self.get_current_index();
6086
6087        // DEFAULT will be parsed as `DataType::Custom`, which is undesirable in this context
6088        fn parse_data_type_no_default(parser: &mut Parser) -> Result<DataType, ParserError> {
6089            if parser.peek_keyword(Keyword::DEFAULT) {
6090                // This dummy error is ignored in `maybe_parse`
6091                parser_err!(
6092                    "The DEFAULT keyword is not a type",
6093                    parser.peek_token_ref().span.start
6094                )
6095            } else {
6096                parser.parse_data_type()
6097            }
6098        }
6099
6100        if let Some(next_data_type) = self.maybe_parse(parse_data_type_no_default)? {
6101            let token = self.token_at(data_type_idx);
6102
6103            // We ensure that the token is a `Word` token, and not other special tokens.
6104            if !matches!(token.token, Token::Word(_)) {
6105                return self.expected("a name or type", token.clone());
6106            }
6107
6108            name = Some(Ident::new(token.to_string()));
6109            data_type = next_data_type;
6110        }
6111
6112        let default_expr = if self.parse_keyword(Keyword::DEFAULT) || self.consume_token(&Token::Eq)
6113        {
6114            Some(self.parse_expr()?)
6115        } else {
6116            None
6117        };
6118        Ok(OperateFunctionArg {
6119            mode,
6120            name,
6121            data_type,
6122            default_expr,
6123        })
6124    }
6125
6126    fn parse_aggregate_function_arg(&mut self) -> Result<OperateFunctionArg, ParserError> {
6127        let mode = if self.parse_keyword(Keyword::IN) {
6128            Some(ArgMode::In)
6129        } else {
6130            if self
6131                .peek_one_of_keywords(&[Keyword::OUT, Keyword::INOUT, Keyword::VARIADIC])
6132                .is_some()
6133            {
6134                return self.expected_ref(
6135                    "IN or argument type in aggregate signature",
6136                    self.peek_token_ref(),
6137                );
6138            }
6139            None
6140        };
6141
6142        // Parse: [ argname ] argtype, but do not consume ORDER from
6143        // `... argtype ORDER BY ...` as a type-name disambiguator.
6144        let mut name = None;
6145        let mut data_type = self.parse_data_type()?;
6146        let data_type_idx = self.get_current_index();
6147
6148        fn parse_data_type_for_aggregate_arg(parser: &mut Parser) -> Result<DataType, ParserError> {
6149            if parser.peek_keyword(Keyword::DEFAULT)
6150                || parser.peek_keyword(Keyword::ORDER)
6151                || parser.peek_token_ref().token == Token::Comma
6152                || parser.peek_token_ref().token == Token::RParen
6153            {
6154                // Dummy error ignored by maybe_parse
6155                parser_err!(
6156                    "The current token cannot start an aggregate argument type",
6157                    parser.peek_token_ref().span.start
6158                )
6159            } else {
6160                parser.parse_data_type()
6161            }
6162        }
6163
6164        if let Some(next_data_type) = self.maybe_parse(parse_data_type_for_aggregate_arg)? {
6165            let token = self.token_at(data_type_idx);
6166            if !matches!(token.token, Token::Word(_)) {
6167                return self.expected("a name or type", token.clone());
6168            }
6169
6170            name = Some(Ident::new(token.to_string()));
6171            data_type = next_data_type;
6172        }
6173
6174        if self.peek_keyword(Keyword::DEFAULT) || self.peek_token_ref().token == Token::Eq {
6175            return self.expected_ref(
6176                "',' or ')' or ORDER BY after aggregate argument type",
6177                self.peek_token_ref(),
6178            );
6179        }
6180
6181        Ok(OperateFunctionArg {
6182            mode,
6183            name,
6184            data_type,
6185            default_expr: None,
6186        })
6187    }
6188
6189    /// Parse statements of the DropTrigger type such as:
6190    ///
6191    /// ```sql
6192    /// DROP TRIGGER [ IF EXISTS ] name ON table_name [ CASCADE | RESTRICT ]
6193    /// ```
6194    pub fn parse_drop_trigger(&mut self) -> Result<DropTrigger, ParserError> {
6195        if !dialect_of!(self is PostgreSqlDialect | SQLiteDialect | GenericDialect | MySqlDialect | MsSqlDialect)
6196        {
6197            self.prev_token();
6198            return self.expected_ref("an object type after DROP", self.peek_token_ref());
6199        }
6200        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
6201        let trigger_name = self.parse_object_name(false)?;
6202        let table_name = if self.parse_keyword(Keyword::ON) {
6203            Some(self.parse_object_name(false)?)
6204        } else {
6205            None
6206        };
6207        let option = match self.parse_one_of_keywords(&[Keyword::CASCADE, Keyword::RESTRICT]) {
6208            Some(Keyword::CASCADE) => Some(ReferentialAction::Cascade),
6209            Some(Keyword::RESTRICT) => Some(ReferentialAction::Restrict),
6210            Some(unexpected_keyword) => return Err(ParserError::ParserError(
6211                format!("Internal parser error: expected any of {{CASCADE, RESTRICT}}, got {unexpected_keyword:?}"),
6212            )),
6213            None => None,
6214        };
6215        Ok(DropTrigger {
6216            if_exists,
6217            trigger_name,
6218            table_name,
6219            option,
6220        })
6221    }
6222
6223    /// Parse a `CREATE TRIGGER` statement.
6224    pub fn parse_create_trigger(
6225        &mut self,
6226        temporary: bool,
6227        or_alter: bool,
6228        or_replace: bool,
6229        is_constraint: bool,
6230    ) -> Result<CreateTrigger, ParserError> {
6231        if !dialect_of!(self is PostgreSqlDialect | SQLiteDialect | GenericDialect | MySqlDialect | MsSqlDialect)
6232        {
6233            self.prev_token();
6234            return self.expected_ref("an object type after CREATE", self.peek_token_ref());
6235        }
6236
6237        let name = self.parse_object_name(false)?;
6238        let period = self.maybe_parse(|parser| parser.parse_trigger_period())?;
6239
6240        let events = self.parse_keyword_separated(Keyword::OR, Parser::parse_trigger_event)?;
6241        self.expect_keyword_is(Keyword::ON)?;
6242        let table_name = self.parse_object_name(false)?;
6243
6244        let referenced_table_name = if self.parse_keyword(Keyword::FROM) {
6245            self.parse_object_name(true).ok()
6246        } else {
6247            None
6248        };
6249
6250        let characteristics = self.parse_constraint_characteristics()?;
6251
6252        let mut referencing = vec![];
6253        if self.parse_keyword(Keyword::REFERENCING) {
6254            while let Some(refer) = self.parse_trigger_referencing()? {
6255                referencing.push(refer);
6256            }
6257        }
6258
6259        let trigger_object = if self.parse_keyword(Keyword::FOR) {
6260            let include_each = self.parse_keyword(Keyword::EACH);
6261            let trigger_object =
6262                match self.expect_one_of_keywords(&[Keyword::ROW, Keyword::STATEMENT])? {
6263                    Keyword::ROW => TriggerObject::Row,
6264                    Keyword::STATEMENT => TriggerObject::Statement,
6265                    unexpected_keyword => return Err(ParserError::ParserError(
6266                        format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in ROW/STATEMENT"),
6267                    )),
6268                };
6269
6270            Some(if include_each {
6271                TriggerObjectKind::ForEach(trigger_object)
6272            } else {
6273                TriggerObjectKind::For(trigger_object)
6274            })
6275        } else {
6276            let _ = self.parse_keyword(Keyword::FOR);
6277
6278            None
6279        };
6280
6281        let condition = self
6282            .parse_keyword(Keyword::WHEN)
6283            .then(|| self.parse_expr())
6284            .transpose()?;
6285
6286        let mut exec_body = None;
6287        let mut statements = None;
6288        if self.parse_keyword(Keyword::EXECUTE) {
6289            exec_body = Some(self.parse_trigger_exec_body()?);
6290        } else {
6291            statements = Some(self.parse_conditional_statements(&[Keyword::END])?);
6292        }
6293
6294        Ok(CreateTrigger {
6295            or_alter,
6296            temporary,
6297            or_replace,
6298            is_constraint,
6299            name,
6300            period,
6301            period_before_table: true,
6302            events,
6303            table_name,
6304            referenced_table_name,
6305            referencing,
6306            trigger_object,
6307            condition,
6308            exec_body,
6309            statements_as: false,
6310            statements,
6311            characteristics,
6312        })
6313    }
6314
6315    /// Parse the period part of a trigger (`BEFORE`, `AFTER`, etc.).
6316    pub fn parse_trigger_period(&mut self) -> Result<TriggerPeriod, ParserError> {
6317        Ok(
6318            match self.expect_one_of_keywords(&[
6319                Keyword::FOR,
6320                Keyword::BEFORE,
6321                Keyword::AFTER,
6322                Keyword::INSTEAD,
6323            ])? {
6324                Keyword::FOR => TriggerPeriod::For,
6325                Keyword::BEFORE => TriggerPeriod::Before,
6326                Keyword::AFTER => TriggerPeriod::After,
6327                Keyword::INSTEAD => self
6328                    .expect_keyword_is(Keyword::OF)
6329                    .map(|_| TriggerPeriod::InsteadOf)?,
6330                unexpected_keyword => return Err(ParserError::ParserError(
6331                    format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in trigger period"),
6332                )),
6333            },
6334        )
6335    }
6336
6337    /// Parse the event part of a trigger (`INSERT`, `UPDATE`, etc.).
6338    pub fn parse_trigger_event(&mut self) -> Result<TriggerEvent, ParserError> {
6339        Ok(
6340            match self.expect_one_of_keywords(&[
6341                Keyword::INSERT,
6342                Keyword::UPDATE,
6343                Keyword::DELETE,
6344                Keyword::TRUNCATE,
6345            ])? {
6346                Keyword::INSERT => TriggerEvent::Insert,
6347                Keyword::UPDATE => {
6348                    if self.parse_keyword(Keyword::OF) {
6349                        let cols = self.parse_comma_separated(Parser::parse_identifier)?;
6350                        TriggerEvent::Update(cols)
6351                    } else {
6352                        TriggerEvent::Update(vec![])
6353                    }
6354                }
6355                Keyword::DELETE => TriggerEvent::Delete,
6356                Keyword::TRUNCATE => TriggerEvent::Truncate,
6357                unexpected_keyword => return Err(ParserError::ParserError(
6358                    format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in trigger event"),
6359                )),
6360            },
6361        )
6362    }
6363
6364    /// Parse the `REFERENCING` clause of a trigger.
6365    pub fn parse_trigger_referencing(&mut self) -> Result<Option<TriggerReferencing>, ParserError> {
6366        let refer_type = match self.parse_one_of_keywords(&[Keyword::OLD, Keyword::NEW]) {
6367            Some(Keyword::OLD) if self.parse_keyword(Keyword::TABLE) => {
6368                TriggerReferencingType::OldTable
6369            }
6370            Some(Keyword::NEW) if self.parse_keyword(Keyword::TABLE) => {
6371                TriggerReferencingType::NewTable
6372            }
6373            _ => {
6374                return Ok(None);
6375            }
6376        };
6377
6378        let is_as = self.parse_keyword(Keyword::AS);
6379        let transition_relation_name = self.parse_object_name(false)?;
6380        Ok(Some(TriggerReferencing {
6381            refer_type,
6382            is_as,
6383            transition_relation_name,
6384        }))
6385    }
6386
6387    /// Parse the execution body of a trigger (`FUNCTION` or `PROCEDURE`).
6388    pub fn parse_trigger_exec_body(&mut self) -> Result<TriggerExecBody, ParserError> {
6389        Ok(TriggerExecBody {
6390            exec_type: match self
6391                .expect_one_of_keywords(&[Keyword::FUNCTION, Keyword::PROCEDURE])?
6392            {
6393                Keyword::FUNCTION => TriggerExecBodyType::Function,
6394                Keyword::PROCEDURE => TriggerExecBodyType::Procedure,
6395                unexpected_keyword => return Err(ParserError::ParserError(
6396                    format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in trigger exec body"),
6397                )),
6398            },
6399            func_desc: self.parse_function_desc()?,
6400        })
6401    }
6402
6403    /// Parse a `CREATE MACRO` statement.
6404    pub fn parse_create_macro(
6405        &mut self,
6406        or_replace: bool,
6407        temporary: bool,
6408    ) -> Result<Statement, ParserError> {
6409        if dialect_of!(self is DuckDbDialect |  GenericDialect) {
6410            let name = self.parse_object_name(false)?;
6411            self.expect_token(&Token::LParen)?;
6412            let args = if self.consume_token(&Token::RParen) {
6413                self.prev_token();
6414                None
6415            } else {
6416                Some(self.parse_comma_separated(Parser::parse_macro_arg)?)
6417            };
6418
6419            self.expect_token(&Token::RParen)?;
6420            self.expect_keyword_is(Keyword::AS)?;
6421
6422            Ok(Statement::CreateMacro {
6423                or_replace,
6424                temporary,
6425                name,
6426                args,
6427                definition: if self.parse_keyword(Keyword::TABLE) {
6428                    MacroDefinition::Table(self.parse_query()?)
6429                } else {
6430                    MacroDefinition::Expr(self.parse_expr()?)
6431                },
6432            })
6433        } else {
6434            self.prev_token();
6435            self.expected_ref("an object type after CREATE", self.peek_token_ref())
6436        }
6437    }
6438
6439    fn parse_macro_arg(&mut self) -> Result<MacroArg, ParserError> {
6440        let name = self.parse_identifier()?;
6441
6442        let default_expr =
6443            if self.consume_token(&Token::Assignment) || self.consume_token(&Token::RArrow) {
6444                Some(self.parse_expr()?)
6445            } else {
6446                None
6447            };
6448        Ok(MacroArg { name, default_expr })
6449    }
6450
6451    /// Parse a `CREATE EXTERNAL TABLE` statement.
6452    pub fn parse_create_external_table(
6453        &mut self,
6454        or_replace: bool,
6455    ) -> Result<CreateTable, ParserError> {
6456        self.expect_keyword_is(Keyword::TABLE)?;
6457        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
6458        let table_name = self.parse_object_name(false)?;
6459        let (columns, constraints) = self.parse_columns()?;
6460
6461        let hive_distribution = self.parse_hive_distribution()?;
6462        let hive_formats = self.parse_hive_formats()?;
6463
6464        let file_format = if let Some(ref hf) = hive_formats {
6465            if let Some(ref ff) = hf.storage {
6466                match ff {
6467                    HiveIOFormat::FileFormat { format } => Some(*format),
6468                    _ => None,
6469                }
6470            } else {
6471                None
6472            }
6473        } else {
6474            None
6475        };
6476        let location = hive_formats.as_ref().and_then(|hf| hf.location.clone());
6477        let table_properties = self.parse_options(Keyword::TBLPROPERTIES)?;
6478        let table_options = if !table_properties.is_empty() {
6479            CreateTableOptions::TableProperties(table_properties)
6480        } else if let Some(options) = self.maybe_parse_options(Keyword::OPTIONS)? {
6481            CreateTableOptions::Options(options)
6482        } else {
6483            CreateTableOptions::None
6484        };
6485        Ok(CreateTableBuilder::new(table_name)
6486            .columns(columns)
6487            .constraints(constraints)
6488            .hive_distribution(hive_distribution)
6489            .hive_formats(hive_formats)
6490            .table_options(table_options)
6491            .or_replace(or_replace)
6492            .if_not_exists(if_not_exists)
6493            .external(true)
6494            .file_format(file_format)
6495            .location(location)
6496            .build())
6497    }
6498
6499    /// Parse `CREATE SNAPSHOT TABLE` statement.
6500    ///
6501    /// <https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement>
6502    pub fn parse_create_snapshot_table(&mut self) -> Result<CreateTable, ParserError> {
6503        self.expect_keywords(&[Keyword::SNAPSHOT, Keyword::TABLE])?;
6504        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
6505        let table_name = self.parse_object_name(true)?;
6506
6507        self.expect_keyword_is(Keyword::CLONE)?;
6508        let clone = Some(self.parse_object_name(true)?);
6509
6510        let version =
6511            if self.parse_keywords(&[Keyword::FOR, Keyword::SYSTEM_TIME, Keyword::AS, Keyword::OF])
6512            {
6513                Some(TableVersion::ForSystemTimeAsOf(self.parse_expr()?))
6514            } else {
6515                None
6516            };
6517
6518        let table_options = if let Some(options) = self.maybe_parse_options(Keyword::OPTIONS)? {
6519            CreateTableOptions::Options(options)
6520        } else {
6521            CreateTableOptions::None
6522        };
6523
6524        Ok(CreateTableBuilder::new(table_name)
6525            .snapshot(true)
6526            .if_not_exists(if_not_exists)
6527            .clone_clause(clone)
6528            .version(version)
6529            .table_options(table_options)
6530            .build())
6531    }
6532
6533    /// Parse a file format for external tables.
6534    pub fn parse_file_format(&mut self) -> Result<FileFormat, ParserError> {
6535        let next_token = self.next_token();
6536        match &next_token.token {
6537            Token::Word(w) => match w.keyword {
6538                Keyword::AVRO => Ok(FileFormat::AVRO),
6539                Keyword::JSONFILE => Ok(FileFormat::JSONFILE),
6540                Keyword::ORC => Ok(FileFormat::ORC),
6541                Keyword::PARQUET => Ok(FileFormat::PARQUET),
6542                Keyword::RCFILE => Ok(FileFormat::RCFILE),
6543                Keyword::SEQUENCEFILE => Ok(FileFormat::SEQUENCEFILE),
6544                Keyword::TEXTFILE => Ok(FileFormat::TEXTFILE),
6545                _ => self.expected("fileformat", next_token),
6546            },
6547            _ => self.expected("fileformat", next_token),
6548        }
6549    }
6550
6551    fn parse_analyze_format_kind(&mut self) -> Result<AnalyzeFormatKind, ParserError> {
6552        if self.consume_token(&Token::Eq) {
6553            Ok(AnalyzeFormatKind::Assignment(self.parse_analyze_format()?))
6554        } else {
6555            Ok(AnalyzeFormatKind::Keyword(self.parse_analyze_format()?))
6556        }
6557    }
6558
6559    /// Parse an `ANALYZE FORMAT`.
6560    pub fn parse_analyze_format(&mut self) -> Result<AnalyzeFormat, ParserError> {
6561        let next_token = self.next_token();
6562        match &next_token.token {
6563            Token::Word(w) => match w.keyword {
6564                Keyword::TEXT => Ok(AnalyzeFormat::TEXT),
6565                Keyword::GRAPHVIZ => Ok(AnalyzeFormat::GRAPHVIZ),
6566                Keyword::JSON => Ok(AnalyzeFormat::JSON),
6567                Keyword::TREE => Ok(AnalyzeFormat::TREE),
6568                _ => self.expected("fileformat", next_token),
6569            },
6570            _ => self.expected("fileformat", next_token),
6571        }
6572    }
6573
6574    /// Parse a `CREATE VIEW` statement.
6575    pub fn parse_create_view(
6576        &mut self,
6577        or_alter: bool,
6578        or_replace: bool,
6579        temporary: bool,
6580        create_view_params: Option<CreateViewParams>,
6581    ) -> Result<CreateView, ParserError> {
6582        let secure = self.parse_keyword(Keyword::SECURE);
6583        let materialized = self.parse_keyword(Keyword::MATERIALIZED);
6584        self.expect_keyword_is(Keyword::VIEW)?;
6585        let allow_unquoted_hyphen = dialect_of!(self is BigQueryDialect);
6586        // Tries to parse IF NOT EXISTS either before name or after name
6587        // Name before IF NOT EXISTS is supported by snowflake but undocumented
6588        let if_not_exists_first =
6589            self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
6590        let name = self.parse_object_name(allow_unquoted_hyphen)?;
6591        let name_before_not_exists = !if_not_exists_first
6592            && self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
6593        let if_not_exists = if_not_exists_first || name_before_not_exists;
6594        let copy_grants = self.parse_keywords(&[Keyword::COPY, Keyword::GRANTS]);
6595        // Many dialects support `OR ALTER` right after `CREATE`, but we don't (yet).
6596        // ANSI SQL and Postgres support RECURSIVE here, but we don't support it either.
6597        let columns = self.parse_view_columns()?;
6598        let mut options = CreateTableOptions::None;
6599        let with_options = self.parse_options(Keyword::WITH)?;
6600        if !with_options.is_empty() {
6601            options = CreateTableOptions::With(with_options);
6602        }
6603
6604        let cluster_by = if self.parse_keyword(Keyword::CLUSTER) {
6605            self.expect_keyword_is(Keyword::BY)?;
6606            self.parse_parenthesized_column_list(Optional, false)?
6607        } else {
6608            vec![]
6609        };
6610
6611        if dialect_of!(self is BigQueryDialect | GenericDialect) {
6612            if let Some(opts) = self.maybe_parse_options(Keyword::OPTIONS)? {
6613                if !opts.is_empty() {
6614                    options = CreateTableOptions::Options(opts);
6615                }
6616            };
6617        }
6618
6619        let to = if dialect_of!(self is ClickHouseDialect | GenericDialect)
6620            && self.parse_keyword(Keyword::TO)
6621        {
6622            Some(self.parse_object_name(false)?)
6623        } else {
6624            None
6625        };
6626
6627        let comment = if self.dialect.supports_create_view_comment_syntax()
6628            && self.parse_keyword(Keyword::COMMENT)
6629        {
6630            self.expect_token(&Token::Eq)?;
6631            Some(self.parse_comment_value()?)
6632        } else {
6633            None
6634        };
6635
6636        self.expect_keyword_is(Keyword::AS)?;
6637        let query = self.parse_query()?;
6638        // Optional `WITH [ CASCADED | LOCAL ] CHECK OPTION` is widely supported here.
6639
6640        let with_no_schema_binding = dialect_of!(self is RedshiftSqlDialect | GenericDialect)
6641            && self.parse_keywords(&[
6642                Keyword::WITH,
6643                Keyword::NO,
6644                Keyword::SCHEMA,
6645                Keyword::BINDING,
6646            ]);
6647
6648        // PostgreSQL: optional WITH [NO] DATA clause on materialized views.
6649        // pg_dump emits this clause; parse it so corpus schemas round-trip cleanly.
6650        let with_data = if materialized && self.parse_keyword(Keyword::WITH) {
6651            if self.parse_keyword(Keyword::NO) {
6652                self.expect_keyword_is(Keyword::DATA)?;
6653                Some(false)
6654            } else {
6655                self.expect_keyword_is(Keyword::DATA)?;
6656                Some(true)
6657            }
6658        } else {
6659            None
6660        };
6661
6662        Ok(CreateView {
6663            or_alter,
6664            name,
6665            columns,
6666            query,
6667            materialized,
6668            secure,
6669            or_replace,
6670            options,
6671            cluster_by,
6672            comment,
6673            with_no_schema_binding,
6674            if_not_exists,
6675            temporary,
6676            copy_grants,
6677            to,
6678            params: create_view_params,
6679            name_before_not_exists,
6680            with_data,
6681        })
6682    }
6683
6684    /// Parse optional parameters for the `CREATE VIEW` statement supported by [MySQL].
6685    ///
6686    /// [MySQL]: https://dev.mysql.com/doc/refman/9.1/en/create-view.html
6687    fn parse_create_view_params(&mut self) -> Result<Option<CreateViewParams>, ParserError> {
6688        let algorithm = if self.parse_keyword(Keyword::ALGORITHM) {
6689            self.expect_token(&Token::Eq)?;
6690            Some(
6691                match self.expect_one_of_keywords(&[
6692                    Keyword::UNDEFINED,
6693                    Keyword::MERGE,
6694                    Keyword::TEMPTABLE,
6695                ])? {
6696                    Keyword::UNDEFINED => CreateViewAlgorithm::Undefined,
6697                    Keyword::MERGE => CreateViewAlgorithm::Merge,
6698                    Keyword::TEMPTABLE => CreateViewAlgorithm::TempTable,
6699                    _ => {
6700                        self.prev_token();
6701                        let found = self.next_token();
6702                        return self
6703                            .expected("UNDEFINED or MERGE or TEMPTABLE after ALGORITHM =", found);
6704                    }
6705                },
6706            )
6707        } else {
6708            None
6709        };
6710        let definer = if self.parse_keyword(Keyword::DEFINER) {
6711            self.expect_token(&Token::Eq)?;
6712            Some(self.parse_grantee_name()?)
6713        } else {
6714            None
6715        };
6716        let security = if self.parse_keywords(&[Keyword::SQL, Keyword::SECURITY]) {
6717            Some(
6718                match self.expect_one_of_keywords(&[Keyword::DEFINER, Keyword::INVOKER])? {
6719                    Keyword::DEFINER => CreateViewSecurity::Definer,
6720                    Keyword::INVOKER => CreateViewSecurity::Invoker,
6721                    _ => {
6722                        self.prev_token();
6723                        let found = self.next_token();
6724                        return self.expected("DEFINER or INVOKER after SQL SECURITY", found);
6725                    }
6726                },
6727            )
6728        } else {
6729            None
6730        };
6731        if algorithm.is_some() || definer.is_some() || security.is_some() {
6732            Ok(Some(CreateViewParams {
6733                algorithm,
6734                definer,
6735                security,
6736            }))
6737        } else {
6738            Ok(None)
6739        }
6740    }
6741
6742    /// Parse a `CREATE ROLE` statement.
6743    pub fn parse_create_role(&mut self) -> Result<CreateRole, ParserError> {
6744        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
6745        let names = self.parse_comma_separated(|p| p.parse_object_name(false))?;
6746
6747        let _ = self.parse_keyword(Keyword::WITH); // [ WITH ]
6748
6749        let optional_keywords = if dialect_of!(self is MsSqlDialect) {
6750            vec![Keyword::AUTHORIZATION]
6751        } else if dialect_of!(self is PostgreSqlDialect) {
6752            vec![
6753                Keyword::LOGIN,
6754                Keyword::NOLOGIN,
6755                Keyword::INHERIT,
6756                Keyword::NOINHERIT,
6757                Keyword::BYPASSRLS,
6758                Keyword::NOBYPASSRLS,
6759                Keyword::PASSWORD,
6760                Keyword::CREATEDB,
6761                Keyword::NOCREATEDB,
6762                Keyword::CREATEROLE,
6763                Keyword::NOCREATEROLE,
6764                Keyword::SUPERUSER,
6765                Keyword::NOSUPERUSER,
6766                Keyword::REPLICATION,
6767                Keyword::NOREPLICATION,
6768                Keyword::CONNECTION,
6769                Keyword::VALID,
6770                Keyword::IN,
6771                Keyword::ROLE,
6772                Keyword::ADMIN,
6773                Keyword::USER,
6774            ]
6775        } else {
6776            vec![]
6777        };
6778
6779        // MSSQL
6780        let mut authorization_owner = None;
6781        // Postgres
6782        let mut login = None;
6783        let mut inherit = None;
6784        let mut bypassrls = None;
6785        let mut password = None;
6786        let mut create_db = None;
6787        let mut create_role = None;
6788        let mut superuser = None;
6789        let mut replication = None;
6790        let mut connection_limit = None;
6791        let mut valid_until = None;
6792        let mut in_role = vec![];
6793        let mut in_group = vec![];
6794        let mut role = vec![];
6795        let mut user = vec![];
6796        let mut admin = vec![];
6797
6798        while let Some(keyword) = self.parse_one_of_keywords(&optional_keywords) {
6799            let loc = self
6800                .tokens
6801                .get(self.index - 1)
6802                .map_or(Location { line: 0, column: 0 }, |t| t.span.start);
6803            match keyword {
6804                Keyword::AUTHORIZATION => {
6805                    if authorization_owner.is_some() {
6806                        parser_err!("Found multiple AUTHORIZATION", loc)
6807                    } else {
6808                        authorization_owner = Some(self.parse_object_name(false)?);
6809                        Ok(())
6810                    }
6811                }
6812                Keyword::LOGIN | Keyword::NOLOGIN => {
6813                    if login.is_some() {
6814                        parser_err!("Found multiple LOGIN or NOLOGIN", loc)
6815                    } else {
6816                        login = Some(keyword == Keyword::LOGIN);
6817                        Ok(())
6818                    }
6819                }
6820                Keyword::INHERIT | Keyword::NOINHERIT => {
6821                    if inherit.is_some() {
6822                        parser_err!("Found multiple INHERIT or NOINHERIT", loc)
6823                    } else {
6824                        inherit = Some(keyword == Keyword::INHERIT);
6825                        Ok(())
6826                    }
6827                }
6828                Keyword::BYPASSRLS | Keyword::NOBYPASSRLS => {
6829                    if bypassrls.is_some() {
6830                        parser_err!("Found multiple BYPASSRLS or NOBYPASSRLS", loc)
6831                    } else {
6832                        bypassrls = Some(keyword == Keyword::BYPASSRLS);
6833                        Ok(())
6834                    }
6835                }
6836                Keyword::CREATEDB | Keyword::NOCREATEDB => {
6837                    if create_db.is_some() {
6838                        parser_err!("Found multiple CREATEDB or NOCREATEDB", loc)
6839                    } else {
6840                        create_db = Some(keyword == Keyword::CREATEDB);
6841                        Ok(())
6842                    }
6843                }
6844                Keyword::CREATEROLE | Keyword::NOCREATEROLE => {
6845                    if create_role.is_some() {
6846                        parser_err!("Found multiple CREATEROLE or NOCREATEROLE", loc)
6847                    } else {
6848                        create_role = Some(keyword == Keyword::CREATEROLE);
6849                        Ok(())
6850                    }
6851                }
6852                Keyword::SUPERUSER | Keyword::NOSUPERUSER => {
6853                    if superuser.is_some() {
6854                        parser_err!("Found multiple SUPERUSER or NOSUPERUSER", loc)
6855                    } else {
6856                        superuser = Some(keyword == Keyword::SUPERUSER);
6857                        Ok(())
6858                    }
6859                }
6860                Keyword::REPLICATION | Keyword::NOREPLICATION => {
6861                    if replication.is_some() {
6862                        parser_err!("Found multiple REPLICATION or NOREPLICATION", loc)
6863                    } else {
6864                        replication = Some(keyword == Keyword::REPLICATION);
6865                        Ok(())
6866                    }
6867                }
6868                Keyword::PASSWORD => {
6869                    if password.is_some() {
6870                        parser_err!("Found multiple PASSWORD", loc)
6871                    } else {
6872                        password = if self.parse_keyword(Keyword::NULL) {
6873                            Some(Password::NullPassword)
6874                        } else {
6875                            Some(Password::Password(Expr::Value(self.parse_value()?)))
6876                        };
6877                        Ok(())
6878                    }
6879                }
6880                Keyword::CONNECTION => {
6881                    self.expect_keyword_is(Keyword::LIMIT)?;
6882                    if connection_limit.is_some() {
6883                        parser_err!("Found multiple CONNECTION LIMIT", loc)
6884                    } else {
6885                        connection_limit = Some(Expr::Value(self.parse_number_value()?));
6886                        Ok(())
6887                    }
6888                }
6889                Keyword::VALID => {
6890                    self.expect_keyword_is(Keyword::UNTIL)?;
6891                    if valid_until.is_some() {
6892                        parser_err!("Found multiple VALID UNTIL", loc)
6893                    } else {
6894                        valid_until = Some(Expr::Value(self.parse_value()?));
6895                        Ok(())
6896                    }
6897                }
6898                Keyword::IN => {
6899                    if self.parse_keyword(Keyword::ROLE) {
6900                        if !in_role.is_empty() {
6901                            parser_err!("Found multiple IN ROLE", loc)
6902                        } else {
6903                            in_role = self.parse_comma_separated(|p| p.parse_identifier())?;
6904                            Ok(())
6905                        }
6906                    } else if self.parse_keyword(Keyword::GROUP) {
6907                        if !in_group.is_empty() {
6908                            parser_err!("Found multiple IN GROUP", loc)
6909                        } else {
6910                            in_group = self.parse_comma_separated(|p| p.parse_identifier())?;
6911                            Ok(())
6912                        }
6913                    } else {
6914                        self.expected_ref("ROLE or GROUP after IN", self.peek_token_ref())
6915                    }
6916                }
6917                Keyword::ROLE => {
6918                    if !role.is_empty() {
6919                        parser_err!("Found multiple ROLE", loc)
6920                    } else {
6921                        role = self.parse_comma_separated(|p| p.parse_identifier())?;
6922                        Ok(())
6923                    }
6924                }
6925                Keyword::USER => {
6926                    if !user.is_empty() {
6927                        parser_err!("Found multiple USER", loc)
6928                    } else {
6929                        user = self.parse_comma_separated(|p| p.parse_identifier())?;
6930                        Ok(())
6931                    }
6932                }
6933                Keyword::ADMIN => {
6934                    if !admin.is_empty() {
6935                        parser_err!("Found multiple ADMIN", loc)
6936                    } else {
6937                        admin = self.parse_comma_separated(|p| p.parse_identifier())?;
6938                        Ok(())
6939                    }
6940                }
6941                _ => break,
6942            }?
6943        }
6944
6945        Ok(CreateRole {
6946            names,
6947            if_not_exists,
6948            login,
6949            inherit,
6950            bypassrls,
6951            password,
6952            create_db,
6953            create_role,
6954            replication,
6955            superuser,
6956            connection_limit,
6957            valid_until,
6958            in_role,
6959            in_group,
6960            role,
6961            user,
6962            admin,
6963            authorization_owner,
6964        })
6965    }
6966
6967    /// Parse an `OWNER` clause.
6968    pub fn parse_owner(&mut self) -> Result<Owner, ParserError> {
6969        let owner = match self.parse_one_of_keywords(&[Keyword::CURRENT_USER, Keyword::CURRENT_ROLE, Keyword::SESSION_USER]) {
6970            Some(Keyword::CURRENT_USER) => Owner::CurrentUser,
6971            Some(Keyword::CURRENT_ROLE) => Owner::CurrentRole,
6972            Some(Keyword::SESSION_USER) => Owner::SessionUser,
6973            Some(unexpected_keyword) => return Err(ParserError::ParserError(
6974                format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in owner"),
6975            )),
6976            None => {
6977                match self.parse_identifier() {
6978                    Ok(ident) => Owner::Ident(ident),
6979                    Err(e) => {
6980                        return Err(ParserError::ParserError(format!("Expected: CURRENT_USER, CURRENT_ROLE, SESSION_USER or identifier after OWNER TO. {e}")))
6981                    }
6982                }
6983            }
6984        };
6985        Ok(owner)
6986    }
6987
6988    /// Parses a [Statement::CreateDomain] statement.
6989    fn parse_create_domain(&mut self) -> Result<CreateDomain, ParserError> {
6990        let name = self.parse_object_name(false)?;
6991        self.expect_keyword_is(Keyword::AS)?;
6992        let data_type = self.parse_data_type()?;
6993        let collation = if self.parse_keyword(Keyword::COLLATE) {
6994            Some(self.parse_identifier()?)
6995        } else {
6996            None
6997        };
6998        let default = if self.parse_keyword(Keyword::DEFAULT) {
6999            Some(self.parse_expr()?)
7000        } else {
7001            None
7002        };
7003        let mut constraints = Vec::new();
7004        while let Some(constraint) = self.parse_optional_table_constraint()? {
7005            constraints.push(constraint);
7006        }
7007
7008        Ok(CreateDomain {
7009            name,
7010            data_type,
7011            collation,
7012            default,
7013            constraints,
7014        })
7015    }
7016
7017    /// ```sql
7018    ///     CREATE POLICY name ON table_name [ AS { PERMISSIVE | RESTRICTIVE } ]
7019    ///     [ FOR { ALL | SELECT | INSERT | UPDATE | DELETE } ]
7020    ///     [ TO { role_name | PUBLIC | CURRENT_USER | CURRENT_ROLE | SESSION_USER } [, ...] ]
7021    ///     [ USING ( using_expression ) ]
7022    ///     [ WITH CHECK ( with_check_expression ) ]
7023    /// ```
7024    ///
7025    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-createpolicy.html)
7026    pub fn parse_create_policy(&mut self) -> Result<CreatePolicy, ParserError> {
7027        let name = self.parse_identifier()?;
7028        self.expect_keyword_is(Keyword::ON)?;
7029        let table_name = self.parse_object_name(false)?;
7030
7031        let policy_type = if self.parse_keyword(Keyword::AS) {
7032            let keyword =
7033                self.expect_one_of_keywords(&[Keyword::PERMISSIVE, Keyword::RESTRICTIVE])?;
7034            Some(match keyword {
7035                Keyword::PERMISSIVE => CreatePolicyType::Permissive,
7036                Keyword::RESTRICTIVE => CreatePolicyType::Restrictive,
7037                unexpected_keyword => return Err(ParserError::ParserError(
7038                    format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in policy type"),
7039                )),
7040            })
7041        } else {
7042            None
7043        };
7044
7045        let command = if self.parse_keyword(Keyword::FOR) {
7046            let keyword = self.expect_one_of_keywords(&[
7047                Keyword::ALL,
7048                Keyword::SELECT,
7049                Keyword::INSERT,
7050                Keyword::UPDATE,
7051                Keyword::DELETE,
7052            ])?;
7053            Some(match keyword {
7054                Keyword::ALL => CreatePolicyCommand::All,
7055                Keyword::SELECT => CreatePolicyCommand::Select,
7056                Keyword::INSERT => CreatePolicyCommand::Insert,
7057                Keyword::UPDATE => CreatePolicyCommand::Update,
7058                Keyword::DELETE => CreatePolicyCommand::Delete,
7059                unexpected_keyword => return Err(ParserError::ParserError(
7060                    format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in policy command"),
7061                )),
7062            })
7063        } else {
7064            None
7065        };
7066
7067        let to = if self.parse_keyword(Keyword::TO) {
7068            Some(self.parse_comma_separated(|p| p.parse_owner())?)
7069        } else {
7070            None
7071        };
7072
7073        let using = if self.parse_keyword(Keyword::USING) {
7074            self.expect_token(&Token::LParen)?;
7075            let expr = self.parse_expr()?;
7076            self.expect_token(&Token::RParen)?;
7077            Some(expr)
7078        } else {
7079            None
7080        };
7081
7082        let with_check = if self.parse_keywords(&[Keyword::WITH, Keyword::CHECK]) {
7083            self.expect_token(&Token::LParen)?;
7084            let expr = self.parse_expr()?;
7085            self.expect_token(&Token::RParen)?;
7086            Some(expr)
7087        } else {
7088            None
7089        };
7090
7091        Ok(CreatePolicy {
7092            name,
7093            table_name,
7094            policy_type,
7095            command,
7096            to,
7097            using,
7098            with_check,
7099        })
7100    }
7101
7102    /// ```sql
7103    /// CREATE CONNECTOR [IF NOT EXISTS] connector_name
7104    /// [TYPE datasource_type]
7105    /// [URL datasource_url]
7106    /// [COMMENT connector_comment]
7107    /// [WITH DCPROPERTIES(property_name=property_value, ...)]
7108    /// ```
7109    ///
7110    /// [Hive Documentation](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=27362034#LanguageManualDDL-CreateDataConnectorCreateConnector)
7111    pub fn parse_create_connector(&mut self) -> Result<CreateConnector, ParserError> {
7112        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
7113        let name = self.parse_identifier()?;
7114
7115        let connector_type = if self.parse_keyword(Keyword::TYPE) {
7116            Some(self.parse_literal_string()?)
7117        } else {
7118            None
7119        };
7120
7121        let url = if self.parse_keyword(Keyword::URL) {
7122            Some(self.parse_literal_string()?)
7123        } else {
7124            None
7125        };
7126
7127        let comment = self.parse_optional_inline_comment()?;
7128
7129        let with_dcproperties =
7130            match self.parse_options_with_keywords(&[Keyword::WITH, Keyword::DCPROPERTIES])? {
7131                properties if !properties.is_empty() => Some(properties),
7132                _ => None,
7133            };
7134
7135        Ok(CreateConnector {
7136            name,
7137            if_not_exists,
7138            connector_type,
7139            url,
7140            comment,
7141            with_dcproperties,
7142        })
7143    }
7144
7145    /// Parse an operator name, which can contain special characters like +, -, <, >, =
7146    /// that are tokenized as operator tokens rather than identifiers.
7147    /// This is used for PostgreSQL CREATE OPERATOR statements.
7148    ///
7149    /// Examples: `+`, `myschema.+`, `pg_catalog.<=`
7150    fn parse_operator_name(&mut self) -> Result<ObjectName, ParserError> {
7151        let mut parts = vec![];
7152        loop {
7153            parts.push(ObjectNamePart::Identifier(Ident::new(
7154                self.next_token().to_string(),
7155            )));
7156            if !self.consume_token(&Token::Period) {
7157                break;
7158            }
7159        }
7160        Ok(ObjectName(parts))
7161    }
7162
7163    /// Parse a [Statement::CreateOperator]
7164    ///
7165    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-createoperator.html)
7166    pub fn parse_create_operator(&mut self) -> Result<CreateOperator, ParserError> {
7167        let name = self.parse_operator_name()?;
7168        self.expect_token(&Token::LParen)?;
7169
7170        let mut function: Option<ObjectName> = None;
7171        let mut is_procedure = false;
7172        let mut left_arg: Option<DataType> = None;
7173        let mut right_arg: Option<DataType> = None;
7174        let mut options: Vec<OperatorOption> = Vec::new();
7175
7176        loop {
7177            let keyword = self.expect_one_of_keywords(&[
7178                Keyword::FUNCTION,
7179                Keyword::PROCEDURE,
7180                Keyword::LEFTARG,
7181                Keyword::RIGHTARG,
7182                Keyword::COMMUTATOR,
7183                Keyword::NEGATOR,
7184                Keyword::RESTRICT,
7185                Keyword::JOIN,
7186                Keyword::HASHES,
7187                Keyword::MERGES,
7188            ])?;
7189
7190            match keyword {
7191                Keyword::HASHES if !options.iter().any(|o| matches!(o, OperatorOption::Hashes)) => {
7192                    options.push(OperatorOption::Hashes);
7193                }
7194                Keyword::MERGES if !options.iter().any(|o| matches!(o, OperatorOption::Merges)) => {
7195                    options.push(OperatorOption::Merges);
7196                }
7197                Keyword::FUNCTION | Keyword::PROCEDURE if function.is_none() => {
7198                    self.expect_token(&Token::Eq)?;
7199                    function = Some(self.parse_object_name(false)?);
7200                    is_procedure = keyword == Keyword::PROCEDURE;
7201                }
7202                Keyword::LEFTARG if left_arg.is_none() => {
7203                    self.expect_token(&Token::Eq)?;
7204                    left_arg = Some(self.parse_data_type()?);
7205                }
7206                Keyword::RIGHTARG if right_arg.is_none() => {
7207                    self.expect_token(&Token::Eq)?;
7208                    right_arg = Some(self.parse_data_type()?);
7209                }
7210                Keyword::COMMUTATOR
7211                    if !options
7212                        .iter()
7213                        .any(|o| matches!(o, OperatorOption::Commutator(_))) =>
7214                {
7215                    self.expect_token(&Token::Eq)?;
7216                    if self.parse_keyword(Keyword::OPERATOR) {
7217                        self.expect_token(&Token::LParen)?;
7218                        let op = self.parse_operator_name()?;
7219                        self.expect_token(&Token::RParen)?;
7220                        options.push(OperatorOption::Commutator(op));
7221                    } else {
7222                        options.push(OperatorOption::Commutator(self.parse_operator_name()?));
7223                    }
7224                }
7225                Keyword::NEGATOR
7226                    if !options
7227                        .iter()
7228                        .any(|o| matches!(o, OperatorOption::Negator(_))) =>
7229                {
7230                    self.expect_token(&Token::Eq)?;
7231                    if self.parse_keyword(Keyword::OPERATOR) {
7232                        self.expect_token(&Token::LParen)?;
7233                        let op = self.parse_operator_name()?;
7234                        self.expect_token(&Token::RParen)?;
7235                        options.push(OperatorOption::Negator(op));
7236                    } else {
7237                        options.push(OperatorOption::Negator(self.parse_operator_name()?));
7238                    }
7239                }
7240                Keyword::RESTRICT
7241                    if !options
7242                        .iter()
7243                        .any(|o| matches!(o, OperatorOption::Restrict(_))) =>
7244                {
7245                    self.expect_token(&Token::Eq)?;
7246                    options.push(OperatorOption::Restrict(Some(
7247                        self.parse_object_name(false)?,
7248                    )));
7249                }
7250                Keyword::JOIN if !options.iter().any(|o| matches!(o, OperatorOption::Join(_))) => {
7251                    self.expect_token(&Token::Eq)?;
7252                    options.push(OperatorOption::Join(Some(self.parse_object_name(false)?)));
7253                }
7254                _ => {
7255                    return Err(ParserError::ParserError(format!(
7256                        "Duplicate or unexpected keyword {:?} in CREATE OPERATOR",
7257                        keyword
7258                    )))
7259                }
7260            }
7261
7262            if !self.consume_token(&Token::Comma) {
7263                break;
7264            }
7265        }
7266
7267        // Expect closing parenthesis
7268        self.expect_token(&Token::RParen)?;
7269
7270        // FUNCTION is required
7271        let function = function.ok_or_else(|| {
7272            ParserError::ParserError("CREATE OPERATOR requires FUNCTION parameter".to_string())
7273        })?;
7274
7275        Ok(CreateOperator {
7276            name,
7277            function,
7278            is_procedure,
7279            left_arg,
7280            right_arg,
7281            options,
7282        })
7283    }
7284
7285    /// Parse a [Statement::CreateAggregate]
7286    ///
7287    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-createaggregate.html)
7288    pub fn parse_create_aggregate(
7289        &mut self,
7290        or_replace: bool,
7291    ) -> Result<CreateAggregate, ParserError> {
7292        let name = self.parse_object_name(false)?;
7293
7294        // Argument type list: `(input_data_type [, ...])` or `(*)` for zero-arg.
7295        self.expect_token(&Token::LParen)?;
7296        let args = if self.consume_token(&Token::Mul) {
7297            // zero-argument aggregate written as `(*)` — treat as empty arg list.
7298            vec![]
7299        } else if self.consume_token(&Token::RParen) {
7300            self.prev_token();
7301            vec![]
7302        } else {
7303            let parsed = self.parse_comma_separated(|p| p.parse_data_type())?;
7304            parsed
7305        };
7306        self.expect_token(&Token::RParen)?;
7307
7308        // Options block: `( SFUNC = ..., STYPE = ..., ... )`
7309        self.expect_token(&Token::LParen)?;
7310        let mut options: Vec<CreateAggregateOption> = Vec::new();
7311        loop {
7312            let token = self.next_token();
7313            match &token.token {
7314                Token::RParen => break,
7315                Token::Comma => continue,
7316                Token::Word(word) => {
7317                    let option = self.parse_create_aggregate_option(&word.value.to_uppercase())?;
7318                    options.push(option);
7319                }
7320                other => {
7321                    return Err(ParserError::ParserError(format!(
7322                        "Unexpected token in CREATE AGGREGATE options: {other:?}"
7323                    )));
7324                }
7325            }
7326        }
7327
7328        Ok(CreateAggregate {
7329            or_replace,
7330            name,
7331            args,
7332            options,
7333        })
7334    }
7335
7336    fn parse_create_aggregate_option(
7337        &mut self,
7338        key: &str,
7339    ) -> Result<CreateAggregateOption, ParserError> {
7340        match key {
7341            "SFUNC" => {
7342                self.expect_token(&Token::Eq)?;
7343                Ok(CreateAggregateOption::Sfunc(
7344                    self.parse_object_name(false)?,
7345                ))
7346            }
7347            "STYPE" => {
7348                self.expect_token(&Token::Eq)?;
7349                Ok(CreateAggregateOption::Stype(self.parse_data_type()?))
7350            }
7351            "SSPACE" => {
7352                self.expect_token(&Token::Eq)?;
7353                let size = self.parse_literal_uint()?;
7354                Ok(CreateAggregateOption::Sspace(size))
7355            }
7356            "FINALFUNC" => {
7357                self.expect_token(&Token::Eq)?;
7358                Ok(CreateAggregateOption::Finalfunc(
7359                    self.parse_object_name(false)?,
7360                ))
7361            }
7362            "FINALFUNC_EXTRA" => Ok(CreateAggregateOption::FinalfuncExtra),
7363            "FINALFUNC_MODIFY" => {
7364                self.expect_token(&Token::Eq)?;
7365                Ok(CreateAggregateOption::FinalfuncModify(
7366                    self.parse_aggregate_modify_kind()?,
7367                ))
7368            }
7369            "COMBINEFUNC" => {
7370                self.expect_token(&Token::Eq)?;
7371                Ok(CreateAggregateOption::Combinefunc(
7372                    self.parse_object_name(false)?,
7373                ))
7374            }
7375            "SERIALFUNC" => {
7376                self.expect_token(&Token::Eq)?;
7377                Ok(CreateAggregateOption::Serialfunc(
7378                    self.parse_object_name(false)?,
7379                ))
7380            }
7381            "DESERIALFUNC" => {
7382                self.expect_token(&Token::Eq)?;
7383                Ok(CreateAggregateOption::Deserialfunc(
7384                    self.parse_object_name(false)?,
7385                ))
7386            }
7387            "INITCOND" => {
7388                self.expect_token(&Token::Eq)?;
7389                Ok(CreateAggregateOption::Initcond(self.parse_value()?.value))
7390            }
7391            "MSFUNC" => {
7392                self.expect_token(&Token::Eq)?;
7393                Ok(CreateAggregateOption::Msfunc(
7394                    self.parse_object_name(false)?,
7395                ))
7396            }
7397            "MINVFUNC" => {
7398                self.expect_token(&Token::Eq)?;
7399                Ok(CreateAggregateOption::Minvfunc(
7400                    self.parse_object_name(false)?,
7401                ))
7402            }
7403            "MSTYPE" => {
7404                self.expect_token(&Token::Eq)?;
7405                Ok(CreateAggregateOption::Mstype(self.parse_data_type()?))
7406            }
7407            "MSSPACE" => {
7408                self.expect_token(&Token::Eq)?;
7409                let size = self.parse_literal_uint()?;
7410                Ok(CreateAggregateOption::Msspace(size))
7411            }
7412            "MFINALFUNC" => {
7413                self.expect_token(&Token::Eq)?;
7414                Ok(CreateAggregateOption::Mfinalfunc(
7415                    self.parse_object_name(false)?,
7416                ))
7417            }
7418            "MFINALFUNC_EXTRA" => Ok(CreateAggregateOption::MfinalfuncExtra),
7419            "MFINALFUNC_MODIFY" => {
7420                self.expect_token(&Token::Eq)?;
7421                Ok(CreateAggregateOption::MfinalfuncModify(
7422                    self.parse_aggregate_modify_kind()?,
7423                ))
7424            }
7425            "MINITCOND" => {
7426                self.expect_token(&Token::Eq)?;
7427                Ok(CreateAggregateOption::Minitcond(self.parse_value()?.value))
7428            }
7429            "SORTOP" => {
7430                self.expect_token(&Token::Eq)?;
7431                Ok(CreateAggregateOption::Sortop(
7432                    self.parse_object_name(false)?,
7433                ))
7434            }
7435            "PARALLEL" => {
7436                self.expect_token(&Token::Eq)?;
7437                let parallel = match self.expect_one_of_keywords(&[
7438                    Keyword::SAFE,
7439                    Keyword::RESTRICTED,
7440                    Keyword::UNSAFE,
7441                ])? {
7442                    Keyword::SAFE => FunctionParallel::Safe,
7443                    Keyword::RESTRICTED => FunctionParallel::Restricted,
7444                    Keyword::UNSAFE => FunctionParallel::Unsafe,
7445                    _ => unreachable!(),
7446                };
7447                Ok(CreateAggregateOption::Parallel(parallel))
7448            }
7449            "HYPOTHETICAL" => Ok(CreateAggregateOption::Hypothetical),
7450            other => Err(ParserError::ParserError(format!(
7451                "Unknown CREATE AGGREGATE option: {other}"
7452            ))),
7453        }
7454    }
7455
7456    fn parse_aggregate_modify_kind(&mut self) -> Result<AggregateModifyKind, ParserError> {
7457        let token = self.next_token();
7458        match &token.token {
7459            Token::Word(word) => match word.value.to_uppercase().as_str() {
7460                "READ_ONLY" => Ok(AggregateModifyKind::ReadOnly),
7461                "SHAREABLE" => Ok(AggregateModifyKind::Shareable),
7462                "READ_WRITE" => Ok(AggregateModifyKind::ReadWrite),
7463                other => Err(ParserError::ParserError(format!(
7464                    "Expected READ_ONLY, SHAREABLE, or READ_WRITE, got: {other}"
7465                ))),
7466            },
7467            other => Err(ParserError::ParserError(format!(
7468                "Expected READ_ONLY, SHAREABLE, or READ_WRITE, got: {other:?}"
7469            ))),
7470        }
7471    }
7472
7473    /// Parse a [Statement::CreateOperatorFamily]
7474    ///
7475    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-createopfamily.html)
7476    pub fn parse_create_operator_family(&mut self) -> Result<CreateOperatorFamily, ParserError> {
7477        let name = self.parse_object_name(false)?;
7478        self.expect_keyword(Keyword::USING)?;
7479        let using = self.parse_identifier()?;
7480
7481        Ok(CreateOperatorFamily { name, using })
7482    }
7483
7484    /// Parse a [Statement::CreateOperatorClass]
7485    ///
7486    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-createopclass.html)
7487    pub fn parse_create_operator_class(&mut self) -> Result<CreateOperatorClass, ParserError> {
7488        let name = self.parse_object_name(false)?;
7489        let default = self.parse_keyword(Keyword::DEFAULT);
7490        self.expect_keywords(&[Keyword::FOR, Keyword::TYPE])?;
7491        let for_type = self.parse_data_type()?;
7492        self.expect_keyword(Keyword::USING)?;
7493        let using = self.parse_identifier()?;
7494
7495        let family = if self.parse_keyword(Keyword::FAMILY) {
7496            Some(self.parse_object_name(false)?)
7497        } else {
7498            None
7499        };
7500
7501        self.expect_keyword(Keyword::AS)?;
7502
7503        let mut items = vec![];
7504        loop {
7505            if self.parse_keyword(Keyword::OPERATOR) {
7506                let strategy_number = self.parse_literal_uint()?;
7507                let operator_name = self.parse_operator_name()?;
7508
7509                // Optional operator argument types
7510                let op_types = if self.consume_token(&Token::LParen) {
7511                    let left = self.parse_data_type()?;
7512                    self.expect_token(&Token::Comma)?;
7513                    let right = self.parse_data_type()?;
7514                    self.expect_token(&Token::RParen)?;
7515                    Some(OperatorArgTypes { left, right })
7516                } else {
7517                    None
7518                };
7519
7520                // Optional purpose
7521                let purpose = if self.parse_keyword(Keyword::FOR) {
7522                    if self.parse_keyword(Keyword::SEARCH) {
7523                        Some(OperatorPurpose::ForSearch)
7524                    } else if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
7525                        let sort_family = self.parse_object_name(false)?;
7526                        Some(OperatorPurpose::ForOrderBy { sort_family })
7527                    } else {
7528                        return self
7529                            .expected_ref("SEARCH or ORDER BY after FOR", self.peek_token_ref());
7530                    }
7531                } else {
7532                    None
7533                };
7534
7535                items.push(OperatorClassItem::Operator {
7536                    strategy_number,
7537                    operator_name,
7538                    op_types,
7539                    purpose,
7540                });
7541            } else if self.parse_keyword(Keyword::FUNCTION) {
7542                let support_number = self.parse_literal_uint()?;
7543
7544                // Optional operator types
7545                let op_types = if self.consume_token(&Token::LParen)
7546                    && self.peek_token_ref().token != Token::RParen
7547                {
7548                    let mut types = vec![];
7549                    loop {
7550                        types.push(self.parse_data_type()?);
7551                        if !self.consume_token(&Token::Comma) {
7552                            break;
7553                        }
7554                    }
7555                    self.expect_token(&Token::RParen)?;
7556                    Some(types)
7557                } else if self.consume_token(&Token::LParen) {
7558                    self.expect_token(&Token::RParen)?;
7559                    Some(vec![])
7560                } else {
7561                    None
7562                };
7563
7564                let function_name = self.parse_object_name(false)?;
7565
7566                // Function argument types
7567                let argument_types = if self.consume_token(&Token::LParen) {
7568                    let mut types = vec![];
7569                    loop {
7570                        if self.peek_token_ref().token == Token::RParen {
7571                            break;
7572                        }
7573                        types.push(self.parse_data_type()?);
7574                        if !self.consume_token(&Token::Comma) {
7575                            break;
7576                        }
7577                    }
7578                    self.expect_token(&Token::RParen)?;
7579                    types
7580                } else {
7581                    vec![]
7582                };
7583
7584                items.push(OperatorClassItem::Function {
7585                    support_number,
7586                    op_types,
7587                    function_name,
7588                    argument_types,
7589                });
7590            } else if self.parse_keyword(Keyword::STORAGE) {
7591                let storage_type = self.parse_data_type()?;
7592                items.push(OperatorClassItem::Storage { storage_type });
7593            } else {
7594                break;
7595            }
7596
7597            // Check for comma separator
7598            if !self.consume_token(&Token::Comma) {
7599                break;
7600            }
7601        }
7602
7603        Ok(CreateOperatorClass {
7604            name,
7605            default,
7606            for_type,
7607            using,
7608            family,
7609            items,
7610        })
7611    }
7612
7613    /// Parse a `DROP` statement.
7614    pub fn parse_drop(&mut self) -> Result<Statement, ParserError> {
7615        // MySQL dialect supports `TEMPORARY`
7616        let temporary = dialect_of!(self is MySqlDialect | GenericDialect | DuckDbDialect)
7617            && self.parse_keyword(Keyword::TEMPORARY);
7618        let persistent = dialect_of!(self is DuckDbDialect)
7619            && self.parse_one_of_keywords(&[Keyword::PERSISTENT]).is_some();
7620
7621        let object_type = if self.parse_keyword(Keyword::TABLE) {
7622            ObjectType::Table
7623        } else if self.parse_keyword(Keyword::COLLATION) {
7624            ObjectType::Collation
7625        } else if self.parse_keyword(Keyword::VIEW) {
7626            ObjectType::View
7627        } else if self.parse_keywords(&[Keyword::MATERIALIZED, Keyword::VIEW]) {
7628            ObjectType::MaterializedView
7629        } else if self.parse_keyword(Keyword::INDEX) {
7630            ObjectType::Index
7631        } else if self.parse_keyword(Keyword::ROLE) {
7632            ObjectType::Role
7633        } else if self.parse_keyword(Keyword::SCHEMA) {
7634            ObjectType::Schema
7635        } else if self.parse_keyword(Keyword::DATABASE) {
7636            ObjectType::Database
7637        } else if self.parse_keyword(Keyword::SEQUENCE) {
7638            ObjectType::Sequence
7639        } else if self.parse_keyword(Keyword::STAGE) {
7640            ObjectType::Stage
7641        } else if self.parse_keyword(Keyword::TYPE) {
7642            ObjectType::Type
7643        } else if self.parse_keyword(Keyword::USER) {
7644            ObjectType::User
7645        } else if self.parse_keyword(Keyword::STREAM) {
7646            ObjectType::Stream
7647        } else if self.parse_keyword(Keyword::FUNCTION) {
7648            return self.parse_drop_function().map(Into::into);
7649        } else if self.parse_keyword(Keyword::POLICY) {
7650            return self.parse_drop_policy().map(Into::into);
7651        } else if self.parse_keyword(Keyword::CONNECTOR) {
7652            return self.parse_drop_connector();
7653        } else if self.parse_keyword(Keyword::DOMAIN) {
7654            return self.parse_drop_domain().map(Into::into);
7655        } else if self.parse_keyword(Keyword::PROCEDURE) {
7656            return self.parse_drop_procedure();
7657        } else if self.parse_keyword(Keyword::SECRET) {
7658            return self.parse_drop_secret(temporary, persistent);
7659        } else if self.parse_keyword(Keyword::TRIGGER) {
7660            return self.parse_drop_trigger().map(Into::into);
7661        } else if self.parse_keyword(Keyword::EXTENSION) {
7662            return self.parse_drop_extension();
7663        } else if self.parse_keyword(Keyword::OPERATOR) {
7664            // Check if this is DROP OPERATOR FAMILY or DROP OPERATOR CLASS
7665            return if self.parse_keyword(Keyword::FAMILY) {
7666                self.parse_drop_operator_family()
7667            } else if self.parse_keyword(Keyword::CLASS) {
7668                self.parse_drop_operator_class()
7669            } else {
7670                self.parse_drop_operator()
7671            };
7672        } else {
7673            return self.expected_ref(
7674                "COLLATION, CONNECTOR, DATABASE, EXTENSION, FUNCTION, INDEX, OPERATOR, POLICY, PROCEDURE, ROLE, SCHEMA, SECRET, SEQUENCE, STAGE, TABLE, TRIGGER, TYPE, VIEW, MATERIALIZED VIEW or USER after DROP",
7675                self.peek_token_ref(),
7676            );
7677        };
7678        // Many dialects support the non-standard `IF EXISTS` clause and allow
7679        // specifying multiple objects to delete in a single statement
7680        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
7681        let names = self.parse_comma_separated(|p| p.parse_object_name(false))?;
7682
7683        let loc = self.peek_token_ref().span.start;
7684        let cascade = self.parse_keyword(Keyword::CASCADE);
7685        let restrict = self.parse_keyword(Keyword::RESTRICT);
7686        let purge = self.parse_keyword(Keyword::PURGE);
7687        if cascade && restrict {
7688            return parser_err!("Cannot specify both CASCADE and RESTRICT in DROP", loc);
7689        }
7690        if object_type == ObjectType::Role && (cascade || restrict || purge) {
7691            return parser_err!(
7692                "Cannot specify CASCADE, RESTRICT, or PURGE in DROP ROLE",
7693                loc
7694            );
7695        }
7696        let table = if self.parse_keyword(Keyword::ON) {
7697            Some(self.parse_object_name(false)?)
7698        } else {
7699            None
7700        };
7701        Ok(Statement::Drop {
7702            object_type,
7703            if_exists,
7704            names,
7705            cascade,
7706            restrict,
7707            purge,
7708            temporary,
7709            table,
7710        })
7711    }
7712
7713    fn parse_optional_drop_behavior(&mut self) -> Option<DropBehavior> {
7714        match self.parse_one_of_keywords(&[Keyword::CASCADE, Keyword::RESTRICT]) {
7715            Some(Keyword::CASCADE) => Some(DropBehavior::Cascade),
7716            Some(Keyword::RESTRICT) => Some(DropBehavior::Restrict),
7717            _ => None,
7718        }
7719    }
7720
7721    /// ```sql
7722    /// DROP FUNCTION [ IF EXISTS ] name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] [, ...]
7723    /// [ CASCADE | RESTRICT ]
7724    /// ```
7725    fn parse_drop_function(&mut self) -> Result<DropFunction, ParserError> {
7726        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
7727        let func_desc = self.parse_comma_separated(Parser::parse_function_desc)?;
7728        let drop_behavior = self.parse_optional_drop_behavior();
7729        Ok(DropFunction {
7730            if_exists,
7731            func_desc,
7732            drop_behavior,
7733        })
7734    }
7735
7736    /// ```sql
7737    /// DROP POLICY [ IF EXISTS ] name ON table_name [ CASCADE | RESTRICT ]
7738    /// ```
7739    ///
7740    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-droppolicy.html)
7741    fn parse_drop_policy(&mut self) -> Result<DropPolicy, ParserError> {
7742        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
7743        let name = self.parse_identifier()?;
7744        self.expect_keyword_is(Keyword::ON)?;
7745        let table_name = self.parse_object_name(false)?;
7746        let drop_behavior = self.parse_optional_drop_behavior();
7747        Ok(DropPolicy {
7748            if_exists,
7749            name,
7750            table_name,
7751            drop_behavior,
7752        })
7753    }
7754    /// ```sql
7755    /// DROP CONNECTOR [IF EXISTS] name
7756    /// ```
7757    ///
7758    /// See [Hive](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=27362034#LanguageManualDDL-DropConnector)
7759    fn parse_drop_connector(&mut self) -> Result<Statement, ParserError> {
7760        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
7761        let name = self.parse_identifier()?;
7762        Ok(Statement::DropConnector { if_exists, name })
7763    }
7764
7765    /// ```sql
7766    /// DROP DOMAIN [ IF EXISTS ] name [ CASCADE | RESTRICT ]
7767    /// ```
7768    fn parse_drop_domain(&mut self) -> Result<DropDomain, ParserError> {
7769        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
7770        let name = self.parse_object_name(false)?;
7771        let drop_behavior = self.parse_optional_drop_behavior();
7772        Ok(DropDomain {
7773            if_exists,
7774            name,
7775            drop_behavior,
7776        })
7777    }
7778
7779    /// ```sql
7780    /// DROP PROCEDURE [ IF EXISTS ] name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] [, ...]
7781    /// [ CASCADE | RESTRICT ]
7782    /// ```
7783    fn parse_drop_procedure(&mut self) -> Result<Statement, ParserError> {
7784        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
7785        let proc_desc = self.parse_comma_separated(Parser::parse_function_desc)?;
7786        let drop_behavior = self.parse_optional_drop_behavior();
7787        Ok(Statement::DropProcedure {
7788            if_exists,
7789            proc_desc,
7790            drop_behavior,
7791        })
7792    }
7793
7794    fn parse_function_desc(&mut self) -> Result<FunctionDesc, ParserError> {
7795        let name = self.parse_object_name(false)?;
7796
7797        let args = if self.consume_token(&Token::LParen) {
7798            if self.consume_token(&Token::RParen) {
7799                Some(vec![])
7800            } else {
7801                let args = self.parse_comma_separated(Parser::parse_function_arg)?;
7802                self.expect_token(&Token::RParen)?;
7803                Some(args)
7804            }
7805        } else {
7806            None
7807        };
7808
7809        Ok(FunctionDesc { name, args })
7810    }
7811
7812    /// See [DuckDB Docs](https://duckdb.org/docs/sql/statements/create_secret.html) for more details.
7813    fn parse_drop_secret(
7814        &mut self,
7815        temporary: bool,
7816        persistent: bool,
7817    ) -> Result<Statement, ParserError> {
7818        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
7819        let name = self.parse_identifier()?;
7820        let storage_specifier = if self.parse_keyword(Keyword::FROM) {
7821            self.parse_identifier().ok()
7822        } else {
7823            None
7824        };
7825        let temp = match (temporary, persistent) {
7826            (true, false) => Some(true),
7827            (false, true) => Some(false),
7828            (false, false) => None,
7829            _ => self.expected_ref("TEMPORARY or PERSISTENT", self.peek_token_ref())?,
7830        };
7831
7832        Ok(Statement::DropSecret {
7833            if_exists,
7834            temporary: temp,
7835            name,
7836            storage_specifier,
7837        })
7838    }
7839
7840    /// Parse a `DECLARE` statement.
7841    ///
7842    /// ```sql
7843    /// DECLARE name [ BINARY ] [ ASENSITIVE | INSENSITIVE ] [ [ NO ] SCROLL ]
7844    ///     CURSOR [ { WITH | WITHOUT } HOLD ] FOR query
7845    /// ```
7846    ///
7847    /// The syntax can vary significantly between warehouses. See the grammar
7848    /// on the warehouse specific function in such cases.
7849    pub fn parse_declare(&mut self) -> Result<Statement, ParserError> {
7850        if dialect_of!(self is BigQueryDialect) {
7851            return self.parse_big_query_declare();
7852        }
7853        if dialect_of!(self is SnowflakeDialect) {
7854            return self.parse_snowflake_declare();
7855        }
7856        if dialect_of!(self is MsSqlDialect) {
7857            return self.parse_mssql_declare();
7858        }
7859
7860        let name = self.parse_identifier()?;
7861
7862        let binary = Some(self.parse_keyword(Keyword::BINARY));
7863        let sensitive = if self.parse_keyword(Keyword::INSENSITIVE) {
7864            Some(true)
7865        } else if self.parse_keyword(Keyword::ASENSITIVE) {
7866            Some(false)
7867        } else {
7868            None
7869        };
7870        let scroll = if self.parse_keyword(Keyword::SCROLL) {
7871            Some(true)
7872        } else if self.parse_keywords(&[Keyword::NO, Keyword::SCROLL]) {
7873            Some(false)
7874        } else {
7875            None
7876        };
7877
7878        self.expect_keyword_is(Keyword::CURSOR)?;
7879        let declare_type = Some(DeclareType::Cursor);
7880
7881        let hold = match self.parse_one_of_keywords(&[Keyword::WITH, Keyword::WITHOUT]) {
7882            Some(keyword) => {
7883                self.expect_keyword_is(Keyword::HOLD)?;
7884
7885                match keyword {
7886                    Keyword::WITH => Some(true),
7887                    Keyword::WITHOUT => Some(false),
7888                    unexpected_keyword => return Err(ParserError::ParserError(
7889                        format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in cursor hold"),
7890                    )),
7891                }
7892            }
7893            None => None,
7894        };
7895
7896        self.expect_keyword_is(Keyword::FOR)?;
7897
7898        let query = Some(self.parse_query()?);
7899
7900        Ok(Statement::Declare {
7901            stmts: vec![Declare {
7902                names: vec![name],
7903                data_type: None,
7904                assignment: None,
7905                declare_type,
7906                binary,
7907                sensitive,
7908                scroll,
7909                hold,
7910                for_query: query,
7911            }],
7912        })
7913    }
7914
7915    /// Parse a [BigQuery] `DECLARE` statement.
7916    ///
7917    /// Syntax:
7918    /// ```text
7919    /// DECLARE variable_name[, ...] [{ <variable_type> | <DEFAULT expression> }];
7920    /// ```
7921    /// [BigQuery]: https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#declare
7922    pub fn parse_big_query_declare(&mut self) -> Result<Statement, ParserError> {
7923        let names = self.parse_comma_separated(Parser::parse_identifier)?;
7924
7925        let data_type = match &self.peek_token_ref().token {
7926            Token::Word(w) if w.keyword == Keyword::DEFAULT => None,
7927            _ => Some(self.parse_data_type()?),
7928        };
7929
7930        let expr = if data_type.is_some() {
7931            if self.parse_keyword(Keyword::DEFAULT) {
7932                Some(self.parse_expr()?)
7933            } else {
7934                None
7935            }
7936        } else {
7937            // If no variable type - default expression must be specified, per BQ docs.
7938            // i.e `DECLARE foo;` is invalid.
7939            self.expect_keyword_is(Keyword::DEFAULT)?;
7940            Some(self.parse_expr()?)
7941        };
7942
7943        Ok(Statement::Declare {
7944            stmts: vec![Declare {
7945                names,
7946                data_type,
7947                assignment: expr.map(|expr| DeclareAssignment::Default(Box::new(expr))),
7948                declare_type: None,
7949                binary: None,
7950                sensitive: None,
7951                scroll: None,
7952                hold: None,
7953                for_query: None,
7954            }],
7955        })
7956    }
7957
7958    /// Parse a [Snowflake] `DECLARE` statement.
7959    ///
7960    /// Syntax:
7961    /// ```text
7962    /// DECLARE
7963    ///   [{ <variable_declaration>
7964    ///      | <cursor_declaration>
7965    ///      | <resultset_declaration>
7966    ///      | <exception_declaration> }; ... ]
7967    ///
7968    /// <variable_declaration>
7969    /// <variable_name> [<type>] [ { DEFAULT | := } <expression>]
7970    ///
7971    /// <cursor_declaration>
7972    /// <cursor_name> CURSOR FOR <query>
7973    ///
7974    /// <resultset_declaration>
7975    /// <resultset_name> RESULTSET [ { DEFAULT | := } ( <query> ) ] ;
7976    ///
7977    /// <exception_declaration>
7978    /// <exception_name> EXCEPTION [ ( <exception_number> , '<exception_message>' ) ] ;
7979    /// ```
7980    ///
7981    /// [Snowflake]: https://docs.snowflake.com/en/sql-reference/snowflake-scripting/declare
7982    pub fn parse_snowflake_declare(&mut self) -> Result<Statement, ParserError> {
7983        let mut stmts = vec![];
7984        loop {
7985            let name = self.parse_identifier()?;
7986            let (declare_type, for_query, assigned_expr, data_type) =
7987                if self.parse_keyword(Keyword::CURSOR) {
7988                    self.expect_keyword_is(Keyword::FOR)?;
7989                    match &self.peek_token_ref().token {
7990                        Token::Word(w) if w.keyword == Keyword::SELECT => (
7991                            Some(DeclareType::Cursor),
7992                            Some(self.parse_query()?),
7993                            None,
7994                            None,
7995                        ),
7996                        _ => (
7997                            Some(DeclareType::Cursor),
7998                            None,
7999                            Some(DeclareAssignment::For(Box::new(self.parse_expr()?))),
8000                            None,
8001                        ),
8002                    }
8003                } else if self.parse_keyword(Keyword::RESULTSET) {
8004                    let assigned_expr = if self.peek_token_ref().token != Token::SemiColon {
8005                        self.parse_snowflake_variable_declaration_expression()?
8006                    } else {
8007                        // Nothing more to do. The statement has no further parameters.
8008                        None
8009                    };
8010
8011                    (Some(DeclareType::ResultSet), None, assigned_expr, None)
8012                } else if self.parse_keyword(Keyword::EXCEPTION) {
8013                    let assigned_expr = if self.peek_token_ref().token == Token::LParen {
8014                        Some(DeclareAssignment::Expr(Box::new(self.parse_expr()?)))
8015                    } else {
8016                        // Nothing more to do. The statement has no further parameters.
8017                        None
8018                    };
8019
8020                    (Some(DeclareType::Exception), None, assigned_expr, None)
8021                } else {
8022                    // Without an explicit keyword, the only valid option is variable declaration.
8023                    let (assigned_expr, data_type) = if let Some(assigned_expr) =
8024                        self.parse_snowflake_variable_declaration_expression()?
8025                    {
8026                        (Some(assigned_expr), None)
8027                    } else if let Token::Word(_) = &self.peek_token_ref().token {
8028                        let data_type = self.parse_data_type()?;
8029                        (
8030                            self.parse_snowflake_variable_declaration_expression()?,
8031                            Some(data_type),
8032                        )
8033                    } else {
8034                        (None, None)
8035                    };
8036                    (None, None, assigned_expr, data_type)
8037                };
8038            let stmt = Declare {
8039                names: vec![name],
8040                data_type,
8041                assignment: assigned_expr,
8042                declare_type,
8043                binary: None,
8044                sensitive: None,
8045                scroll: None,
8046                hold: None,
8047                for_query,
8048            };
8049
8050            stmts.push(stmt);
8051            if self.consume_token(&Token::SemiColon) {
8052                match &self.peek_token_ref().token {
8053                    Token::Word(w)
8054                        if ALL_KEYWORDS
8055                            .binary_search(&w.value.to_uppercase().as_str())
8056                            .is_err() =>
8057                    {
8058                        // Not a keyword - start of a new declaration.
8059                        continue;
8060                    }
8061                    _ => {
8062                        // Put back the semicolon, this is the end of the DECLARE statement.
8063                        self.prev_token();
8064                    }
8065                }
8066            }
8067
8068            break;
8069        }
8070
8071        Ok(Statement::Declare { stmts })
8072    }
8073
8074    /// Parse a [MsSql] `DECLARE` statement.
8075    ///
8076    /// Syntax:
8077    /// ```text
8078    /// DECLARE
8079    // {
8080    //   { @local_variable [AS] data_type [ = value ] }
8081    //   | { @cursor_variable_name CURSOR [ FOR ] }
8082    // } [ ,...n ]
8083    /// ```
8084    /// [MsSql]: https://learn.microsoft.com/en-us/sql/t-sql/language-elements/declare-local-variable-transact-sql?view=sql-server-ver16
8085    pub fn parse_mssql_declare(&mut self) -> Result<Statement, ParserError> {
8086        let stmts = self.parse_comma_separated(Parser::parse_mssql_declare_stmt)?;
8087
8088        Ok(Statement::Declare { stmts })
8089    }
8090
8091    /// Parse the body of a [MsSql] `DECLARE`statement.
8092    ///
8093    /// Syntax:
8094    /// ```text
8095    // {
8096    //   { @local_variable [AS] data_type [ = value ] }
8097    //   | { @cursor_variable_name CURSOR [ FOR ]}
8098    // } [ ,...n ]
8099    /// ```
8100    /// [MsSql]: https://learn.microsoft.com/en-us/sql/t-sql/language-elements/declare-local-variable-transact-sql?view=sql-server-ver16
8101    pub fn parse_mssql_declare_stmt(&mut self) -> Result<Declare, ParserError> {
8102        let name = {
8103            let ident = self.parse_identifier()?;
8104            if !ident.value.starts_with('@')
8105                && !matches!(
8106                    &self.peek_token_ref().token,
8107                    Token::Word(w) if w.keyword == Keyword::CURSOR
8108                )
8109            {
8110                Err(ParserError::TokenizerError(
8111                    "Invalid MsSql variable declaration.".to_string(),
8112                ))
8113            } else {
8114                Ok(ident)
8115            }
8116        }?;
8117
8118        let (declare_type, data_type) = match &self.peek_token_ref().token {
8119            Token::Word(w) => match w.keyword {
8120                Keyword::CURSOR => {
8121                    self.next_token();
8122                    (Some(DeclareType::Cursor), None)
8123                }
8124                Keyword::AS => {
8125                    self.next_token();
8126                    (None, Some(self.parse_data_type()?))
8127                }
8128                _ => (None, Some(self.parse_data_type()?)),
8129            },
8130            _ => (None, Some(self.parse_data_type()?)),
8131        };
8132
8133        let (for_query, assignment) = if self.peek_keyword(Keyword::FOR) {
8134            self.next_token();
8135            let query = Some(self.parse_query()?);
8136            (query, None)
8137        } else {
8138            let assignment = self.parse_mssql_variable_declaration_expression()?;
8139            (None, assignment)
8140        };
8141
8142        Ok(Declare {
8143            names: vec![name],
8144            data_type,
8145            assignment,
8146            declare_type,
8147            binary: None,
8148            sensitive: None,
8149            scroll: None,
8150            hold: None,
8151            for_query,
8152        })
8153    }
8154
8155    /// Parses the assigned expression in a variable declaration.
8156    ///
8157    /// Syntax:
8158    /// ```text
8159    /// [ { DEFAULT | := } <expression>]
8160    /// ```
8161    /// <https://docs.snowflake.com/en/sql-reference/snowflake-scripting/declare#variable-declaration-syntax>
8162    pub fn parse_snowflake_variable_declaration_expression(
8163        &mut self,
8164    ) -> Result<Option<DeclareAssignment>, ParserError> {
8165        Ok(match &self.peek_token_ref().token {
8166            Token::Word(w) if w.keyword == Keyword::DEFAULT => {
8167                self.next_token(); // Skip `DEFAULT`
8168                Some(DeclareAssignment::Default(Box::new(self.parse_expr()?)))
8169            }
8170            Token::Assignment => {
8171                self.next_token(); // Skip `:=`
8172                Some(DeclareAssignment::DuckAssignment(Box::new(
8173                    self.parse_expr()?,
8174                )))
8175            }
8176            _ => None,
8177        })
8178    }
8179
8180    /// Parses the assigned expression in a variable declaration.
8181    ///
8182    /// Syntax:
8183    /// ```text
8184    /// [ = <expression>]
8185    /// ```
8186    pub fn parse_mssql_variable_declaration_expression(
8187        &mut self,
8188    ) -> Result<Option<DeclareAssignment>, ParserError> {
8189        Ok(match &self.peek_token_ref().token {
8190            Token::Eq => {
8191                self.next_token(); // Skip `=`
8192                Some(DeclareAssignment::MsSqlAssignment(Box::new(
8193                    self.parse_expr()?,
8194                )))
8195            }
8196            _ => None,
8197        })
8198    }
8199
8200    /// Parse `FETCH [direction] { FROM | IN } cursor INTO target;` statement.
8201    pub fn parse_fetch_statement(&mut self) -> Result<Statement, ParserError> {
8202        let direction = if self.parse_keyword(Keyword::NEXT) {
8203            FetchDirection::Next
8204        } else if self.parse_keyword(Keyword::PRIOR) {
8205            FetchDirection::Prior
8206        } else if self.parse_keyword(Keyword::FIRST) {
8207            FetchDirection::First
8208        } else if self.parse_keyword(Keyword::LAST) {
8209            FetchDirection::Last
8210        } else if self.parse_keyword(Keyword::ABSOLUTE) {
8211            FetchDirection::Absolute {
8212                limit: self.parse_number_value()?,
8213            }
8214        } else if self.parse_keyword(Keyword::RELATIVE) {
8215            FetchDirection::Relative {
8216                limit: self.parse_number_value()?,
8217            }
8218        } else if self.parse_keyword(Keyword::FORWARD) {
8219            if self.parse_keyword(Keyword::ALL) {
8220                FetchDirection::ForwardAll
8221            } else {
8222                FetchDirection::Forward {
8223                    // TODO: Support optional
8224                    limit: Some(self.parse_number_value()?),
8225                }
8226            }
8227        } else if self.parse_keyword(Keyword::BACKWARD) {
8228            if self.parse_keyword(Keyword::ALL) {
8229                FetchDirection::BackwardAll
8230            } else {
8231                FetchDirection::Backward {
8232                    // TODO: Support optional
8233                    limit: Some(self.parse_number_value()?),
8234                }
8235            }
8236        } else if self.parse_keyword(Keyword::ALL) {
8237            FetchDirection::All
8238        } else {
8239            FetchDirection::Count {
8240                limit: self.parse_number_value()?,
8241            }
8242        };
8243
8244        let position = if self.peek_keyword(Keyword::FROM) {
8245            self.expect_keyword(Keyword::FROM)?;
8246            FetchPosition::From
8247        } else if self.peek_keyword(Keyword::IN) {
8248            self.expect_keyword(Keyword::IN)?;
8249            FetchPosition::In
8250        } else {
8251            return parser_err!("Expected FROM or IN", self.peek_token_ref().span.start);
8252        };
8253
8254        let name = self.parse_identifier()?;
8255
8256        let into = if self.parse_keyword(Keyword::INTO) {
8257            Some(self.parse_object_name(false)?)
8258        } else {
8259            None
8260        };
8261
8262        Ok(Statement::Fetch {
8263            name,
8264            direction,
8265            position,
8266            into,
8267        })
8268    }
8269
8270    /// Parse a `DISCARD` statement.
8271    pub fn parse_discard(&mut self) -> Result<Statement, ParserError> {
8272        let object_type = if self.parse_keyword(Keyword::ALL) {
8273            DiscardObject::ALL
8274        } else if self.parse_keyword(Keyword::PLANS) {
8275            DiscardObject::PLANS
8276        } else if self.parse_keyword(Keyword::SEQUENCES) {
8277            DiscardObject::SEQUENCES
8278        } else if self.parse_keyword(Keyword::TEMP) || self.parse_keyword(Keyword::TEMPORARY) {
8279            DiscardObject::TEMP
8280        } else {
8281            return self.expected_ref(
8282                "ALL, PLANS, SEQUENCES, TEMP or TEMPORARY after DISCARD",
8283                self.peek_token_ref(),
8284            );
8285        };
8286        Ok(Statement::Discard { object_type })
8287    }
8288
8289    /// Parse a `CREATE INDEX` statement.
8290    pub fn parse_create_index(&mut self, unique: bool) -> Result<CreateIndex, ParserError> {
8291        let concurrently = self.parse_keyword(Keyword::CONCURRENTLY);
8292        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
8293
8294        let mut using = None;
8295
8296        let index_name = if if_not_exists || !self.parse_keyword(Keyword::ON) {
8297            let index_name = self.parse_object_name(false)?;
8298            // MySQL allows `USING index_type` either before or after `ON table_name`
8299            using = self.parse_optional_using_then_index_type()?;
8300            self.expect_keyword_is(Keyword::ON)?;
8301            Some(index_name)
8302        } else {
8303            None
8304        };
8305
8306        let table_name = self.parse_object_name(false)?;
8307
8308        // MySQL allows having two `USING` clauses.
8309        // In that case, the second clause overwrites the first.
8310        using = self.parse_optional_using_then_index_type()?.or(using);
8311
8312        let columns = self.parse_parenthesized_index_column_list()?;
8313
8314        let include = if self.parse_keyword(Keyword::INCLUDE) {
8315            self.expect_token(&Token::LParen)?;
8316            let columns = self.parse_comma_separated(|p| p.parse_identifier())?;
8317            self.expect_token(&Token::RParen)?;
8318            columns
8319        } else {
8320            vec![]
8321        };
8322
8323        let nulls_distinct = if self.parse_keyword(Keyword::NULLS) {
8324            let not = self.parse_keyword(Keyword::NOT);
8325            self.expect_keyword_is(Keyword::DISTINCT)?;
8326            Some(!not)
8327        } else {
8328            None
8329        };
8330
8331        let with = if self.dialect.supports_create_index_with_clause()
8332            && self.parse_keyword(Keyword::WITH)
8333        {
8334            self.expect_token(&Token::LParen)?;
8335            let with_params = self.parse_comma_separated(Parser::parse_expr)?;
8336            self.expect_token(&Token::RParen)?;
8337            with_params
8338        } else {
8339            Vec::new()
8340        };
8341
8342        let predicate = if self.parse_keyword(Keyword::WHERE) {
8343            Some(self.parse_expr()?)
8344        } else {
8345            None
8346        };
8347
8348        // MySQL options (including the modern style of `USING` after the column list instead of
8349        // before, which is deprecated) shouldn't conflict with other preceding options (e.g. `WITH
8350        // PARSER` won't be caught by the above `WITH` clause parsing because MySQL doesn't set that
8351        // support flag). This is probably invalid syntax for other dialects, but it is simpler to
8352        // parse it anyway (as we do inside `ALTER TABLE` and `CREATE TABLE` parsing).
8353        let index_options = self.parse_index_options()?;
8354
8355        // MySQL allows `ALGORITHM` and `LOCK` options. Unlike in `ALTER TABLE`, they need not be comma separated.
8356        let mut alter_options = Vec::new();
8357        while self
8358            .peek_one_of_keywords(&[Keyword::ALGORITHM, Keyword::LOCK])
8359            .is_some()
8360        {
8361            alter_options.push(self.parse_alter_table_operation()?)
8362        }
8363
8364        Ok(CreateIndex {
8365            name: index_name,
8366            table_name,
8367            using,
8368            columns,
8369            unique,
8370            concurrently,
8371            if_not_exists,
8372            include,
8373            nulls_distinct,
8374            with,
8375            predicate,
8376            index_options,
8377            alter_options,
8378        })
8379    }
8380
8381    /// Parse a `CREATE EXTENSION` statement.
8382    pub fn parse_create_extension(&mut self) -> Result<CreateExtension, ParserError> {
8383        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
8384        let name = self.parse_identifier()?;
8385
8386        let (schema, version, cascade) = if self.parse_keyword(Keyword::WITH) {
8387            let schema = if self.parse_keyword(Keyword::SCHEMA) {
8388                Some(self.parse_identifier()?)
8389            } else {
8390                None
8391            };
8392
8393            let version = if self.parse_keyword(Keyword::VERSION) {
8394                Some(self.parse_identifier()?)
8395            } else {
8396                None
8397            };
8398
8399            let cascade = self.parse_keyword(Keyword::CASCADE);
8400
8401            (schema, version, cascade)
8402        } else {
8403            (None, None, false)
8404        };
8405
8406        Ok(CreateExtension {
8407            name,
8408            if_not_exists,
8409            schema,
8410            version,
8411            cascade,
8412        })
8413    }
8414
8415    /// Parse a PostgreSQL-specific [Statement::CreateCollation] statement.
8416    pub fn parse_create_collation(&mut self) -> Result<CreateCollation, ParserError> {
8417        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
8418        let name = self.parse_object_name(false)?;
8419
8420        let definition = if self.parse_keyword(Keyword::FROM) {
8421            CreateCollationDefinition::From(self.parse_object_name(false)?)
8422        } else if self.consume_token(&Token::LParen) {
8423            let options = self.parse_comma_separated(Parser::parse_sql_option)?;
8424            self.expect_token(&Token::RParen)?;
8425            CreateCollationDefinition::Options(options)
8426        } else {
8427            return self.expected_ref(
8428                "FROM or parenthesized option list after CREATE COLLATION name",
8429                self.peek_token_ref(),
8430            );
8431        };
8432
8433        Ok(CreateCollation {
8434            if_not_exists,
8435            name,
8436            definition,
8437        })
8438    }
8439
8440    /// Parse a PostgreSQL-specific `CREATE TEXT SEARCH CONFIGURATION | DICTIONARY | PARSER | TEMPLATE` statement.
8441    pub fn parse_create_text_search(&mut self) -> Result<Statement, ParserError> {
8442        if self.parse_keyword(Keyword::CONFIGURATION) {
8443            let name = self.parse_object_name(false)?;
8444            self.expect_token(&Token::LParen)?;
8445            let options = self.parse_comma_separated(Parser::parse_sql_option)?;
8446            self.expect_token(&Token::RParen)?;
8447            Ok(Statement::CreateTextSearchConfiguration(
8448                CreateTextSearchConfiguration { name, options },
8449            ))
8450        } else if self.parse_keyword(Keyword::DICTIONARY) {
8451            let name = self.parse_object_name(false)?;
8452            self.expect_token(&Token::LParen)?;
8453            let options = self.parse_comma_separated(Parser::parse_sql_option)?;
8454            self.expect_token(&Token::RParen)?;
8455            Ok(Statement::CreateTextSearchDictionary(
8456                CreateTextSearchDictionary { name, options },
8457            ))
8458        } else if self.parse_keyword(Keyword::PARSER) {
8459            let name = self.parse_object_name(false)?;
8460            self.expect_token(&Token::LParen)?;
8461            let options = self.parse_comma_separated(Parser::parse_sql_option)?;
8462            self.expect_token(&Token::RParen)?;
8463            Ok(Statement::CreateTextSearchParser(CreateTextSearchParser {
8464                name,
8465                options,
8466            }))
8467        } else if self.parse_keyword(Keyword::TEMPLATE) {
8468            let name = self.parse_object_name(false)?;
8469            self.expect_token(&Token::LParen)?;
8470            let options = self.parse_comma_separated(Parser::parse_sql_option)?;
8471            self.expect_token(&Token::RParen)?;
8472            Ok(Statement::CreateTextSearchTemplate(
8473                CreateTextSearchTemplate { name, options },
8474            ))
8475        } else {
8476            self.expected_ref(
8477                "CONFIGURATION, DICTIONARY, PARSER, or TEMPLATE after CREATE TEXT SEARCH",
8478                self.peek_token_ref(),
8479            )
8480        }
8481    }
8482
8483    /// Parse a PostgreSQL-specific [Statement::DropExtension] statement.
8484    pub fn parse_drop_extension(&mut self) -> Result<Statement, ParserError> {
8485        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
8486        let names = self.parse_comma_separated(|p| p.parse_identifier())?;
8487        let cascade_or_restrict =
8488            self.parse_one_of_keywords(&[Keyword::CASCADE, Keyword::RESTRICT]);
8489        Ok(Statement::DropExtension(DropExtension {
8490            names,
8491            if_exists,
8492            cascade_or_restrict: cascade_or_restrict
8493                .map(|k| match k {
8494                    Keyword::CASCADE => Ok(ReferentialAction::Cascade),
8495                    Keyword::RESTRICT => Ok(ReferentialAction::Restrict),
8496                    _ => self.expected_ref("CASCADE or RESTRICT", self.peek_token_ref()),
8497                })
8498                .transpose()?,
8499        }))
8500    }
8501
8502    /// Parse a[Statement::DropOperator] statement.
8503    ///
8504    pub fn parse_drop_operator(&mut self) -> Result<Statement, ParserError> {
8505        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
8506        let operators = self.parse_comma_separated(|p| p.parse_drop_operator_signature())?;
8507        let drop_behavior = self.parse_optional_drop_behavior();
8508        Ok(Statement::DropOperator(DropOperator {
8509            if_exists,
8510            operators,
8511            drop_behavior,
8512        }))
8513    }
8514
8515    /// Parse an operator signature for a [Statement::DropOperator]
8516    /// Format: `name ( { left_type | NONE } , right_type )`
8517    fn parse_drop_operator_signature(&mut self) -> Result<DropOperatorSignature, ParserError> {
8518        let name = self.parse_operator_name()?;
8519        self.expect_token(&Token::LParen)?;
8520
8521        // Parse left operand type (or NONE for prefix operators)
8522        let left_type = if self.parse_keyword(Keyword::NONE) {
8523            None
8524        } else {
8525            Some(self.parse_data_type()?)
8526        };
8527
8528        self.expect_token(&Token::Comma)?;
8529
8530        // Parse right operand type (always required)
8531        let right_type = self.parse_data_type()?;
8532
8533        self.expect_token(&Token::RParen)?;
8534
8535        Ok(DropOperatorSignature {
8536            name,
8537            left_type,
8538            right_type,
8539        })
8540    }
8541
8542    /// Parse a [Statement::DropOperatorFamily]
8543    ///
8544    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-dropopfamily.html)
8545    pub fn parse_drop_operator_family(&mut self) -> Result<Statement, ParserError> {
8546        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
8547        let names = self.parse_comma_separated(|p| p.parse_object_name(false))?;
8548        self.expect_keyword(Keyword::USING)?;
8549        let using = self.parse_identifier()?;
8550        let drop_behavior = self.parse_optional_drop_behavior();
8551        Ok(Statement::DropOperatorFamily(DropOperatorFamily {
8552            if_exists,
8553            names,
8554            using,
8555            drop_behavior,
8556        }))
8557    }
8558
8559    /// Parse a [Statement::DropOperatorClass]
8560    ///
8561    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-dropopclass.html)
8562    pub fn parse_drop_operator_class(&mut self) -> Result<Statement, ParserError> {
8563        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
8564        let names = self.parse_comma_separated(|p| p.parse_object_name(false))?;
8565        self.expect_keyword(Keyword::USING)?;
8566        let using = self.parse_identifier()?;
8567        let drop_behavior = self.parse_optional_drop_behavior();
8568        Ok(Statement::DropOperatorClass(DropOperatorClass {
8569            if_exists,
8570            names,
8571            using,
8572            drop_behavior,
8573        }))
8574    }
8575
8576    /// Parse Hive distribution style.
8577    ///
8578    /// TODO: Support parsing for `SKEWED` distribution style.
8579    pub fn parse_hive_distribution(&mut self) -> Result<HiveDistributionStyle, ParserError> {
8580        if self.parse_keywords(&[Keyword::PARTITIONED, Keyword::BY]) {
8581            self.expect_token(&Token::LParen)?;
8582            let columns =
8583                self.parse_comma_separated(|parser| parser.parse_column_def_inner(true))?;
8584            self.expect_token(&Token::RParen)?;
8585            Ok(HiveDistributionStyle::PARTITIONED { columns })
8586        } else {
8587            Ok(HiveDistributionStyle::NONE)
8588        }
8589    }
8590
8591    /// Parse Redshift `DISTSTYLE { AUTO | EVEN | KEY | ALL }`.
8592    ///
8593    /// See <https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_TABLE_NEW.html>
8594    fn parse_dist_style(&mut self) -> Result<DistStyle, ParserError> {
8595        let token = self.next_token();
8596        match &token.token {
8597            Token::Word(w) => match w.keyword {
8598                Keyword::AUTO => Ok(DistStyle::Auto),
8599                Keyword::EVEN => Ok(DistStyle::Even),
8600                Keyword::KEY => Ok(DistStyle::Key),
8601                Keyword::ALL => Ok(DistStyle::All),
8602                _ => self.expected("AUTO, EVEN, KEY, or ALL", token),
8603            },
8604            _ => self.expected("AUTO, EVEN, KEY, or ALL", token),
8605        }
8606    }
8607
8608    /// Parse Hive formats.
8609    pub fn parse_hive_formats(&mut self) -> Result<Option<HiveFormat>, ParserError> {
8610        let mut hive_format: Option<HiveFormat> = None;
8611        loop {
8612            match self.parse_one_of_keywords(&[
8613                Keyword::ROW,
8614                Keyword::STORED,
8615                Keyword::LOCATION,
8616                Keyword::WITH,
8617            ]) {
8618                Some(Keyword::ROW) => {
8619                    hive_format
8620                        .get_or_insert_with(HiveFormat::default)
8621                        .row_format = Some(self.parse_row_format()?);
8622                }
8623                Some(Keyword::STORED) => {
8624                    self.expect_keyword_is(Keyword::AS)?;
8625                    if self.parse_keyword(Keyword::INPUTFORMAT) {
8626                        let input_format = self.parse_expr()?;
8627                        self.expect_keyword_is(Keyword::OUTPUTFORMAT)?;
8628                        let output_format = self.parse_expr()?;
8629                        hive_format.get_or_insert_with(HiveFormat::default).storage =
8630                            Some(HiveIOFormat::IOF {
8631                                input_format,
8632                                output_format,
8633                            });
8634                    } else {
8635                        let format = self.parse_file_format()?;
8636                        hive_format.get_or_insert_with(HiveFormat::default).storage =
8637                            Some(HiveIOFormat::FileFormat { format });
8638                    }
8639                }
8640                Some(Keyword::LOCATION) => {
8641                    hive_format.get_or_insert_with(HiveFormat::default).location =
8642                        Some(self.parse_literal_string()?);
8643                }
8644                Some(Keyword::WITH) => {
8645                    self.prev_token();
8646                    let properties = self
8647                        .parse_options_with_keywords(&[Keyword::WITH, Keyword::SERDEPROPERTIES])?;
8648                    if !properties.is_empty() {
8649                        hive_format
8650                            .get_or_insert_with(HiveFormat::default)
8651                            .serde_properties = Some(properties);
8652                    } else {
8653                        break;
8654                    }
8655                }
8656                None => break,
8657                _ => break,
8658            }
8659        }
8660
8661        Ok(hive_format)
8662    }
8663
8664    /// Parse Hive row format.
8665    pub fn parse_row_format(&mut self) -> Result<HiveRowFormat, ParserError> {
8666        self.expect_keyword_is(Keyword::FORMAT)?;
8667        match self.parse_one_of_keywords(&[Keyword::SERDE, Keyword::DELIMITED]) {
8668            Some(Keyword::SERDE) => {
8669                let class = self.parse_literal_string()?;
8670                Ok(HiveRowFormat::SERDE { class })
8671            }
8672            _ => {
8673                let mut row_delimiters = vec![];
8674
8675                loop {
8676                    match self.parse_one_of_keywords(&[
8677                        Keyword::FIELDS,
8678                        Keyword::COLLECTION,
8679                        Keyword::MAP,
8680                        Keyword::LINES,
8681                        Keyword::NULL,
8682                    ]) {
8683                        Some(Keyword::FIELDS) => {
8684                            if self.parse_keywords(&[Keyword::TERMINATED, Keyword::BY]) {
8685                                row_delimiters.push(HiveRowDelimiter {
8686                                    delimiter: HiveDelimiter::FieldsTerminatedBy,
8687                                    char: self.parse_identifier()?,
8688                                });
8689
8690                                if self.parse_keywords(&[Keyword::ESCAPED, Keyword::BY]) {
8691                                    row_delimiters.push(HiveRowDelimiter {
8692                                        delimiter: HiveDelimiter::FieldsEscapedBy,
8693                                        char: self.parse_identifier()?,
8694                                    });
8695                                }
8696                            } else {
8697                                break;
8698                            }
8699                        }
8700                        Some(Keyword::COLLECTION) => {
8701                            if self.parse_keywords(&[
8702                                Keyword::ITEMS,
8703                                Keyword::TERMINATED,
8704                                Keyword::BY,
8705                            ]) {
8706                                row_delimiters.push(HiveRowDelimiter {
8707                                    delimiter: HiveDelimiter::CollectionItemsTerminatedBy,
8708                                    char: self.parse_identifier()?,
8709                                });
8710                            } else {
8711                                break;
8712                            }
8713                        }
8714                        Some(Keyword::MAP) => {
8715                            if self.parse_keywords(&[
8716                                Keyword::KEYS,
8717                                Keyword::TERMINATED,
8718                                Keyword::BY,
8719                            ]) {
8720                                row_delimiters.push(HiveRowDelimiter {
8721                                    delimiter: HiveDelimiter::MapKeysTerminatedBy,
8722                                    char: self.parse_identifier()?,
8723                                });
8724                            } else {
8725                                break;
8726                            }
8727                        }
8728                        Some(Keyword::LINES) => {
8729                            if self.parse_keywords(&[Keyword::TERMINATED, Keyword::BY]) {
8730                                row_delimiters.push(HiveRowDelimiter {
8731                                    delimiter: HiveDelimiter::LinesTerminatedBy,
8732                                    char: self.parse_identifier()?,
8733                                });
8734                            } else {
8735                                break;
8736                            }
8737                        }
8738                        Some(Keyword::NULL) => {
8739                            if self.parse_keywords(&[Keyword::DEFINED, Keyword::AS]) {
8740                                row_delimiters.push(HiveRowDelimiter {
8741                                    delimiter: HiveDelimiter::NullDefinedAs,
8742                                    char: self.parse_identifier()?,
8743                                });
8744                            } else {
8745                                break;
8746                            }
8747                        }
8748                        _ => {
8749                            break;
8750                        }
8751                    }
8752                }
8753
8754                Ok(HiveRowFormat::DELIMITED {
8755                    delimiters: row_delimiters,
8756                })
8757            }
8758        }
8759    }
8760
8761    fn parse_optional_on_cluster(&mut self) -> Result<Option<Ident>, ParserError> {
8762        if self.parse_keywords(&[Keyword::ON, Keyword::CLUSTER]) {
8763            Ok(Some(self.parse_identifier()?))
8764        } else {
8765            Ok(None)
8766        }
8767    }
8768
8769    /// Parse `CREATE TABLE` statement.
8770    pub fn parse_create_table(
8771        &mut self,
8772        or_replace: bool,
8773        temporary: bool,
8774        global: Option<bool>,
8775        transient: bool,
8776    ) -> Result<CreateTable, ParserError> {
8777        let allow_unquoted_hyphen = dialect_of!(self is BigQueryDialect);
8778        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
8779        let table_name = self.parse_object_name(allow_unquoted_hyphen)?;
8780
8781        // Note: This is a PostgreSQL-specific feature, but the dialect check was intentionally
8782        // removed to allow GenericDialect and other dialects to parse this syntax. This enables
8783        // multi-dialect SQL tools to work with PostgreSQL-specific DDL statements.
8784        //
8785        // PARTITION OF can be combined with other table definition clauses in the AST,
8786        // though PostgreSQL itself prohibits PARTITION OF with AS SELECT or LIKE clauses.
8787        // The parser accepts these combinations for flexibility; semantic validation
8788        // is left to downstream tools.
8789        // Child partitions can have their own constraints and indexes.
8790        let partition_of = if self.parse_keywords(&[Keyword::PARTITION, Keyword::OF]) {
8791            Some(self.parse_object_name(allow_unquoted_hyphen)?)
8792        } else {
8793            None
8794        };
8795
8796        // Clickhouse has `ON CLUSTER 'cluster'` syntax for DDLs
8797        let on_cluster = self.parse_optional_on_cluster()?;
8798
8799        let like = self.maybe_parse_create_table_like(allow_unquoted_hyphen)?;
8800
8801        let clone = if self.parse_keyword(Keyword::CLONE) {
8802            self.parse_object_name(allow_unquoted_hyphen).ok()
8803        } else {
8804            None
8805        };
8806
8807        // parse optional column list (schema)
8808        let (columns, constraints) = self.parse_columns()?;
8809        let comment_after_column_def =
8810            if dialect_of!(self is HiveDialect) && self.parse_keyword(Keyword::COMMENT) {
8811                let next_token = self.next_token();
8812                match next_token.token {
8813                    Token::SingleQuotedString(str) => Some(CommentDef::WithoutEq(str)),
8814                    _ => self.expected("comment", next_token)?,
8815                }
8816            } else {
8817                None
8818            };
8819
8820        // PostgreSQL PARTITION OF: partition bound specification
8821        let for_values = if partition_of.is_some() {
8822            if self.peek_keyword(Keyword::FOR) || self.peek_keyword(Keyword::DEFAULT) {
8823                Some(self.parse_partition_for_values()?)
8824            } else {
8825                return self.expected_ref(
8826                    "FOR VALUES or DEFAULT after PARTITION OF",
8827                    self.peek_token_ref(),
8828                );
8829            }
8830        } else {
8831            None
8832        };
8833
8834        // SQLite supports `WITHOUT ROWID` at the end of `CREATE TABLE`
8835        let without_rowid = self.parse_keywords(&[Keyword::WITHOUT, Keyword::ROWID]);
8836
8837        let hive_distribution = self.parse_hive_distribution()?;
8838        let clustered_by = self.parse_optional_clustered_by()?;
8839        let hive_formats = self.parse_hive_formats()?;
8840
8841        let create_table_config = self.parse_optional_create_table_config()?;
8842
8843        // ClickHouse supports `PRIMARY KEY`, before `ORDER BY`
8844        // https://clickhouse.com/docs/en/sql-reference/statements/create/table#primary-key
8845        let primary_key = if dialect_of!(self is ClickHouseDialect | GenericDialect)
8846            && self.parse_keywords(&[Keyword::PRIMARY, Keyword::KEY])
8847        {
8848            Some(Box::new(self.parse_expr()?))
8849        } else {
8850            None
8851        };
8852
8853        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
8854            if self.consume_token(&Token::LParen) {
8855                let columns = if self.peek_token_ref().token != Token::RParen {
8856                    self.parse_comma_separated(|p| p.parse_expr())?
8857                } else {
8858                    vec![]
8859                };
8860                self.expect_token(&Token::RParen)?;
8861                Some(OneOrManyWithParens::Many(columns))
8862            } else {
8863                Some(OneOrManyWithParens::One(self.parse_expr()?))
8864            }
8865        } else {
8866            None
8867        };
8868
8869        let on_commit = if self.parse_keywords(&[Keyword::ON, Keyword::COMMIT]) {
8870            Some(self.parse_create_table_on_commit()?)
8871        } else {
8872            None
8873        };
8874
8875        let strict = self.parse_keyword(Keyword::STRICT);
8876
8877        // Redshift: BACKUP YES|NO
8878        let backup = if self.parse_keyword(Keyword::BACKUP) {
8879            let keyword = self.expect_one_of_keywords(&[Keyword::YES, Keyword::NO])?;
8880            Some(keyword == Keyword::YES)
8881        } else {
8882            None
8883        };
8884
8885        // Redshift: DISTSTYLE, DISTKEY, SORTKEY
8886        let diststyle = if self.parse_keyword(Keyword::DISTSTYLE) {
8887            Some(self.parse_dist_style()?)
8888        } else {
8889            None
8890        };
8891        let distkey = if self.parse_keyword(Keyword::DISTKEY) {
8892            self.expect_token(&Token::LParen)?;
8893            let expr = self.parse_expr()?;
8894            self.expect_token(&Token::RParen)?;
8895            Some(expr)
8896        } else {
8897            None
8898        };
8899        let sortkey = if self.parse_keyword(Keyword::SORTKEY) {
8900            self.expect_token(&Token::LParen)?;
8901            let columns = self.parse_comma_separated(|p| p.parse_expr())?;
8902            self.expect_token(&Token::RParen)?;
8903            Some(columns)
8904        } else {
8905            None
8906        };
8907
8908        // Parse optional `AS ( query )`
8909        let query = if self.parse_keyword(Keyword::AS) {
8910            Some(self.parse_query()?)
8911        } else if self.dialect.supports_create_table_select() && self.parse_keyword(Keyword::SELECT)
8912        {
8913            // rewind the SELECT keyword
8914            self.prev_token();
8915            Some(self.parse_query()?)
8916        } else {
8917            None
8918        };
8919
8920        Ok(CreateTableBuilder::new(table_name)
8921            .temporary(temporary)
8922            .columns(columns)
8923            .constraints(constraints)
8924            .or_replace(or_replace)
8925            .if_not_exists(if_not_exists)
8926            .transient(transient)
8927            .hive_distribution(hive_distribution)
8928            .hive_formats(hive_formats)
8929            .global(global)
8930            .query(query)
8931            .without_rowid(without_rowid)
8932            .like(like)
8933            .clone_clause(clone)
8934            .comment_after_column_def(comment_after_column_def)
8935            .order_by(order_by)
8936            .on_commit(on_commit)
8937            .on_cluster(on_cluster)
8938            .clustered_by(clustered_by)
8939            .partition_by(create_table_config.partition_by)
8940            .cluster_by(create_table_config.cluster_by)
8941            .inherits(create_table_config.inherits)
8942            .partition_of(partition_of)
8943            .for_values(for_values)
8944            .table_options(create_table_config.table_options)
8945            .primary_key(primary_key)
8946            .strict(strict)
8947            .backup(backup)
8948            .diststyle(diststyle)
8949            .distkey(distkey)
8950            .sortkey(sortkey)
8951            .build())
8952    }
8953
8954    fn maybe_parse_create_table_like(
8955        &mut self,
8956        allow_unquoted_hyphen: bool,
8957    ) -> Result<Option<CreateTableLikeKind>, ParserError> {
8958        let like = if self.dialect.supports_create_table_like_parenthesized()
8959            && self.consume_token(&Token::LParen)
8960        {
8961            if self.parse_keyword(Keyword::LIKE) {
8962                let name = self.parse_object_name(allow_unquoted_hyphen)?;
8963                let defaults = if self.parse_keywords(&[Keyword::INCLUDING, Keyword::DEFAULTS]) {
8964                    Some(CreateTableLikeDefaults::Including)
8965                } else if self.parse_keywords(&[Keyword::EXCLUDING, Keyword::DEFAULTS]) {
8966                    Some(CreateTableLikeDefaults::Excluding)
8967                } else {
8968                    None
8969                };
8970                self.expect_token(&Token::RParen)?;
8971                Some(CreateTableLikeKind::Parenthesized(CreateTableLike {
8972                    name,
8973                    defaults,
8974                }))
8975            } else {
8976                // Rollback the '(' it's probably the columns list
8977                self.prev_token();
8978                None
8979            }
8980        } else if self.parse_keyword(Keyword::LIKE) || self.parse_keyword(Keyword::ILIKE) {
8981            let name = self.parse_object_name(allow_unquoted_hyphen)?;
8982            Some(CreateTableLikeKind::Plain(CreateTableLike {
8983                name,
8984                defaults: None,
8985            }))
8986        } else {
8987            None
8988        };
8989        Ok(like)
8990    }
8991
8992    pub(crate) fn parse_create_table_on_commit(&mut self) -> Result<OnCommit, ParserError> {
8993        if self.parse_keywords(&[Keyword::DELETE, Keyword::ROWS]) {
8994            Ok(OnCommit::DeleteRows)
8995        } else if self.parse_keywords(&[Keyword::PRESERVE, Keyword::ROWS]) {
8996            Ok(OnCommit::PreserveRows)
8997        } else if self.parse_keywords(&[Keyword::DROP]) {
8998            Ok(OnCommit::Drop)
8999        } else {
9000            parser_err!(
9001                "Expecting DELETE ROWS, PRESERVE ROWS or DROP",
9002                self.peek_token_ref()
9003            )
9004        }
9005    }
9006
9007    /// Parse [ForValues] of a `PARTITION OF` clause.
9008    ///
9009    /// Parses: `FOR VALUES partition_bound_spec | DEFAULT`
9010    ///
9011    /// [PostgreSQL](https://www.postgresql.org/docs/current/sql-createtable.html)
9012    fn parse_partition_for_values(&mut self) -> Result<ForValues, ParserError> {
9013        if self.parse_keyword(Keyword::DEFAULT) {
9014            return Ok(ForValues::Default);
9015        }
9016
9017        self.expect_keywords(&[Keyword::FOR, Keyword::VALUES])?;
9018
9019        if self.parse_keyword(Keyword::IN) {
9020            // FOR VALUES IN (expr, ...)
9021            self.expect_token(&Token::LParen)?;
9022            if self.peek_token_ref().token == Token::RParen {
9023                return self.expected_ref("at least one value", self.peek_token_ref());
9024            }
9025            let values = self.parse_comma_separated(Parser::parse_expr)?;
9026            self.expect_token(&Token::RParen)?;
9027            Ok(ForValues::In(values))
9028        } else if self.parse_keyword(Keyword::FROM) {
9029            // FOR VALUES FROM (...) TO (...)
9030            self.expect_token(&Token::LParen)?;
9031            if self.peek_token_ref().token == Token::RParen {
9032                return self.expected_ref("at least one value", self.peek_token_ref());
9033            }
9034            let from = self.parse_comma_separated(Parser::parse_partition_bound_value)?;
9035            self.expect_token(&Token::RParen)?;
9036            self.expect_keyword(Keyword::TO)?;
9037            self.expect_token(&Token::LParen)?;
9038            if self.peek_token_ref().token == Token::RParen {
9039                return self.expected_ref("at least one value", self.peek_token_ref());
9040            }
9041            let to = self.parse_comma_separated(Parser::parse_partition_bound_value)?;
9042            self.expect_token(&Token::RParen)?;
9043            Ok(ForValues::From { from, to })
9044        } else if self.parse_keyword(Keyword::WITH) {
9045            // FOR VALUES WITH (MODULUS n, REMAINDER r)
9046            self.expect_token(&Token::LParen)?;
9047            self.expect_keyword(Keyword::MODULUS)?;
9048            let modulus = self.parse_literal_uint()?;
9049            self.expect_token(&Token::Comma)?;
9050            self.expect_keyword(Keyword::REMAINDER)?;
9051            let remainder = self.parse_literal_uint()?;
9052            self.expect_token(&Token::RParen)?;
9053            Ok(ForValues::With { modulus, remainder })
9054        } else {
9055            self.expected_ref("IN, FROM, or WITH after FOR VALUES", self.peek_token_ref())
9056        }
9057    }
9058
9059    /// Parse a single partition bound value (MINVALUE, MAXVALUE, or expression).
9060    fn parse_partition_bound_value(&mut self) -> Result<PartitionBoundValue, ParserError> {
9061        if self.parse_keyword(Keyword::MINVALUE) {
9062            Ok(PartitionBoundValue::MinValue)
9063        } else if self.parse_keyword(Keyword::MAXVALUE) {
9064            Ok(PartitionBoundValue::MaxValue)
9065        } else {
9066            Ok(PartitionBoundValue::Expr(self.parse_expr()?))
9067        }
9068    }
9069
9070    /// Parse configuration like inheritance, partitioning, clustering information during the table creation.
9071    ///
9072    /// [BigQuery](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#syntax_2)
9073    /// [PostgreSQL](https://www.postgresql.org/docs/current/ddl-partitioning.html)
9074    /// [MySql](https://dev.mysql.com/doc/refman/8.4/en/create-table.html)
9075    fn parse_optional_create_table_config(
9076        &mut self,
9077    ) -> Result<CreateTableConfiguration, ParserError> {
9078        let mut table_options = CreateTableOptions::None;
9079
9080        let inherits = if self.parse_keyword(Keyword::INHERITS) {
9081            Some(self.parse_parenthesized_qualified_column_list(IsOptional::Mandatory, false)?)
9082        } else {
9083            None
9084        };
9085
9086        // PostgreSQL supports `WITH ( options )`, before `AS`
9087        let with_options = self.parse_options(Keyword::WITH)?;
9088        if !with_options.is_empty() {
9089            table_options = CreateTableOptions::With(with_options)
9090        }
9091
9092        let table_properties = self.parse_options(Keyword::TBLPROPERTIES)?;
9093        if !table_properties.is_empty() {
9094            table_options = CreateTableOptions::TableProperties(table_properties);
9095        }
9096        let partition_by = if dialect_of!(self is BigQueryDialect | PostgreSqlDialect | GenericDialect)
9097            && self.parse_keywords(&[Keyword::PARTITION, Keyword::BY])
9098        {
9099            Some(Box::new(self.parse_expr()?))
9100        } else {
9101            None
9102        };
9103
9104        let mut cluster_by = None;
9105        if dialect_of!(self is BigQueryDialect | GenericDialect) {
9106            if self.parse_keywords(&[Keyword::CLUSTER, Keyword::BY]) {
9107                cluster_by = Some(WrappedCollection::NoWrapping(
9108                    self.parse_comma_separated(|p| p.parse_expr())?,
9109                ));
9110            };
9111
9112            if let Token::Word(word) = &self.peek_token_ref().token {
9113                if word.keyword == Keyword::OPTIONS {
9114                    table_options =
9115                        CreateTableOptions::Options(self.parse_options(Keyword::OPTIONS)?)
9116                }
9117            };
9118        }
9119
9120        if !dialect_of!(self is HiveDialect) && table_options == CreateTableOptions::None {
9121            let plain_options = self.parse_plain_options()?;
9122            if !plain_options.is_empty() {
9123                table_options = CreateTableOptions::Plain(plain_options)
9124            }
9125        };
9126
9127        Ok(CreateTableConfiguration {
9128            partition_by,
9129            cluster_by,
9130            inherits,
9131            table_options,
9132        })
9133    }
9134
9135    fn parse_plain_option(&mut self) -> Result<Option<SqlOption>, ParserError> {
9136        // Single parameter option
9137        // <https://dev.mysql.com/doc/refman/8.4/en/create-table.html>
9138        if self.parse_keywords(&[Keyword::START, Keyword::TRANSACTION]) {
9139            return Ok(Some(SqlOption::Ident(Ident::new("START TRANSACTION"))));
9140        }
9141
9142        // Custom option
9143        // <https://dev.mysql.com/doc/refman/8.4/en/create-table.html>
9144        if self.parse_keywords(&[Keyword::COMMENT]) {
9145            let has_eq = self.consume_token(&Token::Eq);
9146            let value = self.next_token();
9147
9148            let comment = match (has_eq, value.token) {
9149                (true, Token::SingleQuotedString(s)) => {
9150                    Ok(Some(SqlOption::Comment(CommentDef::WithEq(s))))
9151                }
9152                (false, Token::SingleQuotedString(s)) => {
9153                    Ok(Some(SqlOption::Comment(CommentDef::WithoutEq(s))))
9154                }
9155                (_, token) => {
9156                    self.expected("Token::SingleQuotedString", TokenWithSpan::wrap(token))
9157                }
9158            };
9159            return comment;
9160        }
9161
9162        // <https://dev.mysql.com/doc/refman/8.4/en/create-table.html>
9163        // <https://clickhouse.com/docs/sql-reference/statements/create/table>
9164        if self.parse_keywords(&[Keyword::ENGINE]) {
9165            let _ = self.consume_token(&Token::Eq);
9166            let value = self.next_token();
9167
9168            let engine = match value.token {
9169                Token::Word(w) => {
9170                    let parameters = if self.peek_token_ref().token == Token::LParen {
9171                        self.parse_parenthesized_identifiers()?
9172                    } else {
9173                        vec![]
9174                    };
9175
9176                    Ok(Some(SqlOption::NamedParenthesizedList(
9177                        NamedParenthesizedList {
9178                            key: Ident::new("ENGINE"),
9179                            name: Some(Ident::new(w.value)),
9180                            values: parameters,
9181                        },
9182                    )))
9183                }
9184                _ => {
9185                    return self.expected("Token::Word", value)?;
9186                }
9187            };
9188
9189            return engine;
9190        }
9191
9192        // <https://dev.mysql.com/doc/refman/8.4/en/create-table.html>
9193        if self.parse_keywords(&[Keyword::TABLESPACE]) {
9194            let _ = self.consume_token(&Token::Eq);
9195            let value = self.next_token();
9196
9197            let tablespace = match value.token {
9198                Token::Word(Word { value: name, .. }) | Token::SingleQuotedString(name) => {
9199                    let storage = match self.parse_keyword(Keyword::STORAGE) {
9200                        true => {
9201                            let _ = self.consume_token(&Token::Eq);
9202                            let storage_token = self.next_token();
9203                            match &storage_token.token {
9204                                Token::Word(w) => match w.value.to_uppercase().as_str() {
9205                                    "DISK" => Some(StorageType::Disk),
9206                                    "MEMORY" => Some(StorageType::Memory),
9207                                    _ => self
9208                                        .expected("Storage type (DISK or MEMORY)", storage_token)?,
9209                                },
9210                                _ => self.expected("Token::Word", storage_token)?,
9211                            }
9212                        }
9213                        false => None,
9214                    };
9215
9216                    Ok(Some(SqlOption::TableSpace(TablespaceOption {
9217                        name,
9218                        storage,
9219                    })))
9220                }
9221                _ => {
9222                    return self.expected("Token::Word", value)?;
9223                }
9224            };
9225
9226            return tablespace;
9227        }
9228
9229        // <https://dev.mysql.com/doc/refman/8.4/en/create-table.html>
9230        if self.parse_keyword(Keyword::UNION) {
9231            let _ = self.consume_token(&Token::Eq);
9232            let value = self.next_token();
9233
9234            match value.token {
9235                Token::LParen => {
9236                    let tables: Vec<Ident> =
9237                        self.parse_comma_separated0(Parser::parse_identifier, Token::RParen)?;
9238                    self.expect_token(&Token::RParen)?;
9239
9240                    return Ok(Some(SqlOption::NamedParenthesizedList(
9241                        NamedParenthesizedList {
9242                            key: Ident::new("UNION"),
9243                            name: None,
9244                            values: tables,
9245                        },
9246                    )));
9247                }
9248                _ => {
9249                    return self.expected("Token::LParen", value)?;
9250                }
9251            }
9252        }
9253
9254        // Key/Value parameter option
9255        let key = if self.parse_keywords(&[Keyword::DEFAULT, Keyword::CHARSET]) {
9256            Ident::new("DEFAULT CHARSET")
9257        } else if self.parse_keyword(Keyword::CHARSET) {
9258            Ident::new("CHARSET")
9259        } else if self.parse_keywords(&[Keyword::DEFAULT, Keyword::CHARACTER, Keyword::SET]) {
9260            Ident::new("DEFAULT CHARACTER SET")
9261        } else if self.parse_keywords(&[Keyword::CHARACTER, Keyword::SET]) {
9262            Ident::new("CHARACTER SET")
9263        } else if self.parse_keywords(&[Keyword::DEFAULT, Keyword::COLLATE]) {
9264            Ident::new("DEFAULT COLLATE")
9265        } else if self.parse_keyword(Keyword::COLLATE) {
9266            Ident::new("COLLATE")
9267        } else if self.parse_keywords(&[Keyword::DATA, Keyword::DIRECTORY]) {
9268            Ident::new("DATA DIRECTORY")
9269        } else if self.parse_keywords(&[Keyword::INDEX, Keyword::DIRECTORY]) {
9270            Ident::new("INDEX DIRECTORY")
9271        } else if self.parse_keyword(Keyword::KEY_BLOCK_SIZE) {
9272            Ident::new("KEY_BLOCK_SIZE")
9273        } else if self.parse_keyword(Keyword::ROW_FORMAT) {
9274            Ident::new("ROW_FORMAT")
9275        } else if self.parse_keyword(Keyword::PACK_KEYS) {
9276            Ident::new("PACK_KEYS")
9277        } else if self.parse_keyword(Keyword::STATS_AUTO_RECALC) {
9278            Ident::new("STATS_AUTO_RECALC")
9279        } else if self.parse_keyword(Keyword::STATS_PERSISTENT) {
9280            Ident::new("STATS_PERSISTENT")
9281        } else if self.parse_keyword(Keyword::STATS_SAMPLE_PAGES) {
9282            Ident::new("STATS_SAMPLE_PAGES")
9283        } else if self.parse_keyword(Keyword::DELAY_KEY_WRITE) {
9284            Ident::new("DELAY_KEY_WRITE")
9285        } else if self.parse_keyword(Keyword::COMPRESSION) {
9286            Ident::new("COMPRESSION")
9287        } else if self.parse_keyword(Keyword::ENCRYPTION) {
9288            Ident::new("ENCRYPTION")
9289        } else if self.parse_keyword(Keyword::MAX_ROWS) {
9290            Ident::new("MAX_ROWS")
9291        } else if self.parse_keyword(Keyword::MIN_ROWS) {
9292            Ident::new("MIN_ROWS")
9293        } else if self.parse_keyword(Keyword::AUTOEXTEND_SIZE) {
9294            Ident::new("AUTOEXTEND_SIZE")
9295        } else if self.parse_keyword(Keyword::AVG_ROW_LENGTH) {
9296            Ident::new("AVG_ROW_LENGTH")
9297        } else if self.parse_keyword(Keyword::CHECKSUM) {
9298            Ident::new("CHECKSUM")
9299        } else if self.parse_keyword(Keyword::CONNECTION) {
9300            Ident::new("CONNECTION")
9301        } else if self.parse_keyword(Keyword::ENGINE_ATTRIBUTE) {
9302            Ident::new("ENGINE_ATTRIBUTE")
9303        } else if self.parse_keyword(Keyword::PASSWORD) {
9304            Ident::new("PASSWORD")
9305        } else if self.parse_keyword(Keyword::SECONDARY_ENGINE_ATTRIBUTE) {
9306            Ident::new("SECONDARY_ENGINE_ATTRIBUTE")
9307        } else if self.parse_keyword(Keyword::INSERT_METHOD) {
9308            Ident::new("INSERT_METHOD")
9309        } else if self.parse_keyword(Keyword::AUTO_INCREMENT) {
9310            Ident::new("AUTO_INCREMENT")
9311        } else {
9312            return Ok(None);
9313        };
9314
9315        let _ = self.consume_token(&Token::Eq);
9316
9317        let value = match self
9318            .maybe_parse(|parser| parser.parse_value())?
9319            .map(Expr::Value)
9320        {
9321            Some(expr) => expr,
9322            None => Expr::Identifier(self.parse_identifier()?),
9323        };
9324
9325        Ok(Some(SqlOption::KeyValue { key, value }))
9326    }
9327
9328    /// Parse plain options.
9329    pub fn parse_plain_options(&mut self) -> Result<Vec<SqlOption>, ParserError> {
9330        let mut options = Vec::new();
9331
9332        while let Some(option) = self.parse_plain_option()? {
9333            options.push(option);
9334            // Some dialects support comma-separated options; it shouldn't introduce ambiguity to
9335            // consume it for all dialects.
9336            let _ = self.consume_token(&Token::Comma);
9337        }
9338
9339        Ok(options)
9340    }
9341
9342    /// Parse optional inline comment.
9343    pub fn parse_optional_inline_comment(&mut self) -> Result<Option<CommentDef>, ParserError> {
9344        let comment = if self.parse_keyword(Keyword::COMMENT) {
9345            let has_eq = self.consume_token(&Token::Eq);
9346            let comment = self.parse_comment_value()?;
9347            Some(if has_eq {
9348                CommentDef::WithEq(comment)
9349            } else {
9350                CommentDef::WithoutEq(comment)
9351            })
9352        } else {
9353            None
9354        };
9355        Ok(comment)
9356    }
9357
9358    /// Parse comment value.
9359    pub fn parse_comment_value(&mut self) -> Result<String, ParserError> {
9360        let next_token = self.next_token();
9361        let value = match next_token.token {
9362            Token::SingleQuotedString(str) => str,
9363            Token::DollarQuotedString(str) => str.value,
9364            _ => self.expected("string literal", next_token)?,
9365        };
9366        Ok(value)
9367    }
9368
9369    /// Parse optional procedure parameters.
9370    pub fn parse_optional_procedure_parameters(
9371        &mut self,
9372    ) -> Result<Option<Vec<ProcedureParam>>, ParserError> {
9373        let mut params = vec![];
9374        if !self.consume_token(&Token::LParen) || self.consume_token(&Token::RParen) {
9375            return Ok(Some(params));
9376        }
9377        loop {
9378            if let Token::Word(_) = &self.peek_token_ref().token {
9379                params.push(self.parse_procedure_param()?)
9380            }
9381            let comma = self.consume_token(&Token::Comma);
9382            if self.consume_token(&Token::RParen) {
9383                // allow a trailing comma, even though it's not in standard
9384                break;
9385            } else if !comma {
9386                return self.expected_ref(
9387                    "',' or ')' after parameter definition",
9388                    self.peek_token_ref(),
9389                );
9390            }
9391        }
9392        Ok(Some(params))
9393    }
9394
9395    /// Parse columns and constraints.
9396    pub fn parse_columns(&mut self) -> Result<(Vec<ColumnDef>, Vec<TableConstraint>), ParserError> {
9397        let mut columns = vec![];
9398        let mut constraints = vec![];
9399        if !self.consume_token(&Token::LParen) || self.consume_token(&Token::RParen) {
9400            return Ok((columns, constraints));
9401        }
9402
9403        loop {
9404            if let Some(constraint) = self.parse_optional_table_constraint()? {
9405                constraints.push(constraint);
9406            } else if let Token::Word(_) = &self.peek_token_ref().token {
9407                columns.push(self.parse_column_def()?);
9408            } else {
9409                return self.expected_ref(
9410                    "column name or constraint definition",
9411                    self.peek_token_ref(),
9412                );
9413            }
9414
9415            let comma = self.consume_token(&Token::Comma);
9416            let rparen = self.peek_token_ref().token == Token::RParen;
9417
9418            if !comma && !rparen {
9419                return self
9420                    .expected_ref("',' or ')' after column definition", self.peek_token_ref());
9421            };
9422
9423            if rparen
9424                && (!comma
9425                    || self.dialect.supports_column_definition_trailing_commas()
9426                    || self.options.trailing_commas)
9427            {
9428                let _ = self.consume_token(&Token::RParen);
9429                break;
9430            }
9431        }
9432
9433        Ok((columns, constraints))
9434    }
9435
9436    /// Parse procedure parameter.
9437    pub fn parse_procedure_param(&mut self) -> Result<ProcedureParam, ParserError> {
9438        let mode = if self.parse_keyword(Keyword::IN) {
9439            Some(ArgMode::In)
9440        } else if self.parse_keyword(Keyword::OUT) {
9441            Some(ArgMode::Out)
9442        } else if self.parse_keyword(Keyword::INOUT) {
9443            Some(ArgMode::InOut)
9444        } else {
9445            None
9446        };
9447        let name = self.parse_identifier()?;
9448        let data_type = self.parse_data_type()?;
9449        let default = if self.consume_token(&Token::Eq) {
9450            Some(self.parse_expr()?)
9451        } else {
9452            None
9453        };
9454
9455        Ok(ProcedureParam {
9456            name,
9457            data_type,
9458            mode,
9459            default,
9460        })
9461    }
9462
9463    /// Parse column definition.
9464    pub fn parse_column_def(&mut self) -> Result<ColumnDef, ParserError> {
9465        self.parse_column_def_inner(false)
9466    }
9467
9468    fn parse_column_def_inner(
9469        &mut self,
9470        optional_data_type: bool,
9471    ) -> Result<ColumnDef, ParserError> {
9472        let col_name = self.parse_identifier()?;
9473        let data_type = if self.is_column_type_sqlite_unspecified() {
9474            DataType::Unspecified
9475        } else if optional_data_type {
9476            self.maybe_parse(|parser| parser.parse_data_type())?
9477                .unwrap_or(DataType::Unspecified)
9478        } else {
9479            self.parse_data_type()?
9480        };
9481        let mut options = vec![];
9482        loop {
9483            if self.parse_keyword(Keyword::CONSTRAINT) {
9484                let name = Some(self.parse_identifier()?);
9485                if let Some(option) = self.parse_optional_column_option()? {
9486                    options.push(ColumnOptionDef { name, option });
9487                } else {
9488                    return self.expected_ref(
9489                        "constraint details after CONSTRAINT <name>",
9490                        self.peek_token_ref(),
9491                    );
9492                }
9493            } else if let Some(option) = self.parse_optional_column_option()? {
9494                options.push(ColumnOptionDef { name: None, option });
9495            } else {
9496                break;
9497            };
9498        }
9499        Ok(ColumnDef {
9500            name: col_name,
9501            data_type,
9502            options,
9503        })
9504    }
9505
9506    fn is_column_type_sqlite_unspecified(&mut self) -> bool {
9507        if dialect_of!(self is SQLiteDialect) {
9508            match &self.peek_token_ref().token {
9509                Token::Word(word) => matches!(
9510                    word.keyword,
9511                    Keyword::CONSTRAINT
9512                        | Keyword::PRIMARY
9513                        | Keyword::NOT
9514                        | Keyword::UNIQUE
9515                        | Keyword::CHECK
9516                        | Keyword::DEFAULT
9517                        | Keyword::COLLATE
9518                        | Keyword::REFERENCES
9519                        | Keyword::GENERATED
9520                        | Keyword::AS
9521                ),
9522                _ => true, // e.g. comma immediately after column name
9523            }
9524        } else {
9525            false
9526        }
9527    }
9528
9529    /// Parse optional column option.
9530    pub fn parse_optional_column_option(&mut self) -> Result<Option<ColumnOption>, ParserError> {
9531        if let Some(option) = self.dialect.parse_column_option(self)? {
9532            return option;
9533        }
9534
9535        self.with_state(
9536            ColumnDefinition,
9537            |parser| -> Result<Option<ColumnOption>, ParserError> {
9538                parser.parse_optional_column_option_inner()
9539            },
9540        )
9541    }
9542
9543    fn parse_optional_column_option_inner(&mut self) -> Result<Option<ColumnOption>, ParserError> {
9544        if self.parse_keywords(&[Keyword::CHARACTER, Keyword::SET]) {
9545            Ok(Some(ColumnOption::CharacterSet(
9546                self.parse_object_name(false)?,
9547            )))
9548        } else if self.parse_keywords(&[Keyword::COLLATE]) {
9549            Ok(Some(ColumnOption::Collation(
9550                self.parse_object_name(false)?,
9551            )))
9552        } else if self.parse_keywords(&[Keyword::NOT, Keyword::NULL]) {
9553            Ok(Some(ColumnOption::NotNull))
9554        } else if self.parse_keywords(&[Keyword::COMMENT]) {
9555            Ok(Some(ColumnOption::Comment(self.parse_comment_value()?)))
9556        } else if self.parse_keyword(Keyword::NULL) {
9557            Ok(Some(ColumnOption::Null))
9558        } else if self.parse_keyword(Keyword::DEFAULT) {
9559            Ok(Some(ColumnOption::Default(self.parse_expr()?)))
9560        } else if dialect_of!(self is ClickHouseDialect| GenericDialect)
9561            && self.parse_keyword(Keyword::MATERIALIZED)
9562        {
9563            Ok(Some(ColumnOption::Materialized(self.parse_expr()?)))
9564        } else if dialect_of!(self is ClickHouseDialect| GenericDialect)
9565            && self.parse_keyword(Keyword::ALIAS)
9566        {
9567            Ok(Some(ColumnOption::Alias(self.parse_expr()?)))
9568        } else if dialect_of!(self is ClickHouseDialect| GenericDialect)
9569            && self.parse_keyword(Keyword::EPHEMERAL)
9570        {
9571            // The expression is optional for the EPHEMERAL syntax, so we need to check
9572            // if the column definition has remaining tokens before parsing the expression.
9573            if matches!(self.peek_token_ref().token, Token::Comma | Token::RParen) {
9574                Ok(Some(ColumnOption::Ephemeral(None)))
9575            } else {
9576                Ok(Some(ColumnOption::Ephemeral(Some(self.parse_expr()?))))
9577            }
9578        } else if self.parse_keywords(&[Keyword::PRIMARY, Keyword::KEY]) {
9579            let characteristics = self.parse_constraint_characteristics()?;
9580            Ok(Some(
9581                PrimaryKeyConstraint {
9582                    name: None,
9583                    index_name: None,
9584                    index_type: None,
9585                    columns: vec![],
9586                    index_options: vec![],
9587                    characteristics,
9588                }
9589                .into(),
9590            ))
9591        } else if self.parse_keyword(Keyword::UNIQUE) {
9592            let index_type_display =
9593                if self.dialect.supports_key_column_option() && self.parse_keyword(Keyword::KEY) {
9594                    KeyOrIndexDisplay::Key
9595                } else {
9596                    KeyOrIndexDisplay::None
9597                };
9598            let characteristics = self.parse_constraint_characteristics()?;
9599            Ok(Some(
9600                UniqueConstraint {
9601                    name: None,
9602                    index_name: None,
9603                    index_type_display,
9604                    index_type: None,
9605                    columns: vec![],
9606                    index_options: vec![],
9607                    characteristics,
9608                    nulls_distinct: NullsDistinctOption::None,
9609                }
9610                .into(),
9611            ))
9612        } else if self.dialect.supports_key_column_option() && self.parse_keyword(Keyword::KEY) {
9613            // In MySQL, `KEY` in a column definition is shorthand for `PRIMARY KEY`.
9614            // See: https://dev.mysql.com/doc/refman/8.4/en/create-table.html
9615            let characteristics = self.parse_constraint_characteristics()?;
9616            Ok(Some(
9617                PrimaryKeyConstraint {
9618                    name: None,
9619                    index_name: None,
9620                    index_type: None,
9621                    columns: vec![],
9622                    index_options: vec![],
9623                    characteristics,
9624                }
9625                .into(),
9626            ))
9627        } else if self.parse_keyword(Keyword::REFERENCES) {
9628            let foreign_table = self.parse_object_name(false)?;
9629            // PostgreSQL allows omitting the column list and
9630            // uses the primary key column of the foreign table by default
9631            let referred_columns = self.parse_parenthesized_column_list(Optional, false)?;
9632            let mut match_kind = None;
9633            let mut on_delete = None;
9634            let mut on_update = None;
9635            loop {
9636                if match_kind.is_none() && self.parse_keyword(Keyword::MATCH) {
9637                    match_kind = Some(self.parse_match_kind()?);
9638                } else if on_delete.is_none()
9639                    && self.parse_keywords(&[Keyword::ON, Keyword::DELETE])
9640                {
9641                    on_delete = Some(self.parse_referential_action()?);
9642                } else if on_update.is_none()
9643                    && self.parse_keywords(&[Keyword::ON, Keyword::UPDATE])
9644                {
9645                    on_update = Some(self.parse_referential_action()?);
9646                } else {
9647                    break;
9648                }
9649            }
9650            let characteristics = self.parse_constraint_characteristics()?;
9651
9652            Ok(Some(
9653                ForeignKeyConstraint {
9654                    name: None,       // Column-level constraints don't have names
9655                    index_name: None, // Not applicable for column-level constraints
9656                    columns: vec![],  // Not applicable for column-level constraints
9657                    foreign_table,
9658                    referred_columns,
9659                    on_delete,
9660                    on_update,
9661                    match_kind,
9662                    characteristics,
9663                }
9664                .into(),
9665            ))
9666        } else if self.parse_keyword(Keyword::CHECK) {
9667            self.expect_token(&Token::LParen)?;
9668            // since `CHECK` requires parentheses, we can parse the inner expression in ParserState::Normal
9669            let expr: Expr = self.with_state(ParserState::Normal, |p| p.parse_expr())?;
9670            self.expect_token(&Token::RParen)?;
9671
9672            let enforced = if self.parse_keyword(Keyword::ENFORCED) {
9673                Some(true)
9674            } else if self.parse_keywords(&[Keyword::NOT, Keyword::ENFORCED]) {
9675                Some(false)
9676            } else {
9677                None
9678            };
9679
9680            Ok(Some(
9681                CheckConstraint {
9682                    name: None, // Column-level check constraints don't have names
9683                    expr: Box::new(expr),
9684                    enforced,
9685                }
9686                .into(),
9687            ))
9688        } else if self.parse_keyword(Keyword::AUTO_INCREMENT)
9689            && dialect_of!(self is MySqlDialect | GenericDialect)
9690        {
9691            // Support AUTO_INCREMENT for MySQL
9692            Ok(Some(ColumnOption::DialectSpecific(vec![
9693                Token::make_keyword("AUTO_INCREMENT"),
9694            ])))
9695        } else if self.parse_keyword(Keyword::AUTOINCREMENT)
9696            && dialect_of!(self is SQLiteDialect |  GenericDialect)
9697        {
9698            // Support AUTOINCREMENT for SQLite
9699            Ok(Some(ColumnOption::DialectSpecific(vec![
9700                Token::make_keyword("AUTOINCREMENT"),
9701            ])))
9702        } else if self.parse_keyword(Keyword::ASC)
9703            && self.dialect.supports_asc_desc_in_column_definition()
9704        {
9705            // Support ASC for SQLite
9706            Ok(Some(ColumnOption::DialectSpecific(vec![
9707                Token::make_keyword("ASC"),
9708            ])))
9709        } else if self.parse_keyword(Keyword::DESC)
9710            && self.dialect.supports_asc_desc_in_column_definition()
9711        {
9712            // Support DESC for SQLite
9713            Ok(Some(ColumnOption::DialectSpecific(vec![
9714                Token::make_keyword("DESC"),
9715            ])))
9716        } else if self.parse_keywords(&[Keyword::ON, Keyword::UPDATE])
9717            && dialect_of!(self is MySqlDialect | GenericDialect)
9718        {
9719            let expr = self.parse_expr()?;
9720            Ok(Some(ColumnOption::OnUpdate(expr)))
9721        } else if self.parse_keyword(Keyword::GENERATED) {
9722            self.parse_optional_column_option_generated()
9723        } else if dialect_of!(self is BigQueryDialect | GenericDialect)
9724            && self.parse_keyword(Keyword::OPTIONS)
9725        {
9726            self.prev_token();
9727            Ok(Some(ColumnOption::Options(
9728                self.parse_options(Keyword::OPTIONS)?,
9729            )))
9730        } else if self.parse_keyword(Keyword::AS)
9731            && dialect_of!(self is MySqlDialect | SQLiteDialect | DuckDbDialect | GenericDialect)
9732        {
9733            self.parse_optional_column_option_as()
9734        } else if self.parse_keyword(Keyword::SRID)
9735            && dialect_of!(self is MySqlDialect | GenericDialect)
9736        {
9737            Ok(Some(ColumnOption::Srid(Box::new(self.parse_expr()?))))
9738        } else if self.parse_keyword(Keyword::IDENTITY)
9739            && dialect_of!(self is MsSqlDialect | GenericDialect)
9740        {
9741            let parameters = if self.consume_token(&Token::LParen) {
9742                let seed = self.parse_number()?;
9743                self.expect_token(&Token::Comma)?;
9744                let increment = self.parse_number()?;
9745                self.expect_token(&Token::RParen)?;
9746
9747                Some(IdentityPropertyFormatKind::FunctionCall(
9748                    IdentityParameters { seed, increment },
9749                ))
9750            } else {
9751                None
9752            };
9753            Ok(Some(ColumnOption::Identity(
9754                IdentityPropertyKind::Identity(IdentityProperty {
9755                    parameters,
9756                    order: None,
9757                }),
9758            )))
9759        } else if dialect_of!(self is SQLiteDialect | GenericDialect)
9760            && self.parse_keywords(&[Keyword::ON, Keyword::CONFLICT])
9761        {
9762            // Support ON CONFLICT for SQLite
9763            Ok(Some(ColumnOption::OnConflict(
9764                self.expect_one_of_keywords(&[
9765                    Keyword::ROLLBACK,
9766                    Keyword::ABORT,
9767                    Keyword::FAIL,
9768                    Keyword::IGNORE,
9769                    Keyword::REPLACE,
9770                ])?,
9771            )))
9772        } else if self.parse_keyword(Keyword::INVISIBLE) {
9773            Ok(Some(ColumnOption::Invisible))
9774        } else {
9775            Ok(None)
9776        }
9777    }
9778
9779    pub(crate) fn parse_tag(&mut self) -> Result<Tag, ParserError> {
9780        let name = self.parse_object_name(false)?;
9781        self.expect_token(&Token::Eq)?;
9782        let value = self.parse_literal_string()?;
9783
9784        Ok(Tag::new(name, value))
9785    }
9786
9787    fn parse_optional_column_option_generated(
9788        &mut self,
9789    ) -> Result<Option<ColumnOption>, ParserError> {
9790        if self.parse_keywords(&[Keyword::ALWAYS, Keyword::AS, Keyword::IDENTITY]) {
9791            let mut sequence_options = vec![];
9792            if self.expect_token(&Token::LParen).is_ok() {
9793                sequence_options = self.parse_create_sequence_options()?;
9794                self.expect_token(&Token::RParen)?;
9795            }
9796            Ok(Some(ColumnOption::Generated {
9797                generated_as: GeneratedAs::Always,
9798                sequence_options: Some(sequence_options),
9799                generation_expr: None,
9800                generation_expr_mode: None,
9801                generated_keyword: true,
9802            }))
9803        } else if self.parse_keywords(&[
9804            Keyword::BY,
9805            Keyword::DEFAULT,
9806            Keyword::AS,
9807            Keyword::IDENTITY,
9808        ]) {
9809            let mut sequence_options = vec![];
9810            if self.expect_token(&Token::LParen).is_ok() {
9811                sequence_options = self.parse_create_sequence_options()?;
9812                self.expect_token(&Token::RParen)?;
9813            }
9814            Ok(Some(ColumnOption::Generated {
9815                generated_as: GeneratedAs::ByDefault,
9816                sequence_options: Some(sequence_options),
9817                generation_expr: None,
9818                generation_expr_mode: None,
9819                generated_keyword: true,
9820            }))
9821        } else if self.parse_keywords(&[Keyword::ALWAYS, Keyword::AS]) {
9822            if self.expect_token(&Token::LParen).is_ok() {
9823                let expr: Expr = self.with_state(ParserState::Normal, |p| p.parse_expr())?;
9824                self.expect_token(&Token::RParen)?;
9825                let (gen_as, expr_mode) = if self.parse_keywords(&[Keyword::STORED]) {
9826                    Ok((
9827                        GeneratedAs::ExpStored,
9828                        Some(GeneratedExpressionMode::Stored),
9829                    ))
9830                } else if dialect_of!(self is PostgreSqlDialect) {
9831                    // Postgres' AS IDENTITY branches are above, this one needs STORED
9832                    self.expected_ref("STORED", self.peek_token_ref())
9833                } else if self.parse_keywords(&[Keyword::VIRTUAL]) {
9834                    Ok((GeneratedAs::Always, Some(GeneratedExpressionMode::Virtual)))
9835                } else {
9836                    Ok((GeneratedAs::Always, None))
9837                }?;
9838
9839                Ok(Some(ColumnOption::Generated {
9840                    generated_as: gen_as,
9841                    sequence_options: None,
9842                    generation_expr: Some(expr),
9843                    generation_expr_mode: expr_mode,
9844                    generated_keyword: true,
9845                }))
9846            } else {
9847                Ok(None)
9848            }
9849        } else {
9850            Ok(None)
9851        }
9852    }
9853
9854    fn parse_optional_column_option_as(&mut self) -> Result<Option<ColumnOption>, ParserError> {
9855        // Some DBs allow 'AS (expr)', shorthand for GENERATED ALWAYS AS
9856        self.expect_token(&Token::LParen)?;
9857        let expr = self.parse_expr()?;
9858        self.expect_token(&Token::RParen)?;
9859
9860        let (gen_as, expr_mode) = if self.parse_keywords(&[Keyword::STORED]) {
9861            (
9862                GeneratedAs::ExpStored,
9863                Some(GeneratedExpressionMode::Stored),
9864            )
9865        } else if self.parse_keywords(&[Keyword::VIRTUAL]) {
9866            (GeneratedAs::Always, Some(GeneratedExpressionMode::Virtual))
9867        } else {
9868            (GeneratedAs::Always, None)
9869        };
9870
9871        Ok(Some(ColumnOption::Generated {
9872            generated_as: gen_as,
9873            sequence_options: None,
9874            generation_expr: Some(expr),
9875            generation_expr_mode: expr_mode,
9876            generated_keyword: false,
9877        }))
9878    }
9879
9880    /// Parse optional `CLUSTERED BY` clause for Hive/Generic dialects.
9881    pub fn parse_optional_clustered_by(&mut self) -> Result<Option<ClusteredBy>, ParserError> {
9882        let clustered_by = if dialect_of!(self is HiveDialect|GenericDialect)
9883            && self.parse_keywords(&[Keyword::CLUSTERED, Keyword::BY])
9884        {
9885            let columns = self.parse_parenthesized_column_list(Mandatory, false)?;
9886
9887            let sorted_by = if self.parse_keywords(&[Keyword::SORTED, Keyword::BY]) {
9888                self.expect_token(&Token::LParen)?;
9889                let sorted_by_columns = self.parse_comma_separated(|p| p.parse_order_by_expr())?;
9890                self.expect_token(&Token::RParen)?;
9891                Some(sorted_by_columns)
9892            } else {
9893                None
9894            };
9895
9896            self.expect_keyword_is(Keyword::INTO)?;
9897            let num_buckets = self.parse_number_value()?.value;
9898            self.expect_keyword_is(Keyword::BUCKETS)?;
9899            Some(ClusteredBy {
9900                columns,
9901                sorted_by,
9902                num_buckets,
9903            })
9904        } else {
9905            None
9906        };
9907        Ok(clustered_by)
9908    }
9909
9910    /// Parse a referential action used in foreign key clauses.
9911    ///
9912    /// Recognized forms: `RESTRICT`, `CASCADE`, `SET NULL`, `NO ACTION`, `SET DEFAULT`.
9913    pub fn parse_referential_action(&mut self) -> Result<ReferentialAction, ParserError> {
9914        if self.parse_keyword(Keyword::RESTRICT) {
9915            Ok(ReferentialAction::Restrict)
9916        } else if self.parse_keyword(Keyword::CASCADE) {
9917            Ok(ReferentialAction::Cascade)
9918        } else if self.parse_keywords(&[Keyword::SET, Keyword::NULL]) {
9919            Ok(ReferentialAction::SetNull)
9920        } else if self.parse_keywords(&[Keyword::NO, Keyword::ACTION]) {
9921            Ok(ReferentialAction::NoAction)
9922        } else if self.parse_keywords(&[Keyword::SET, Keyword::DEFAULT]) {
9923            Ok(ReferentialAction::SetDefault)
9924        } else {
9925            self.expected_ref(
9926                "one of RESTRICT, CASCADE, SET NULL, NO ACTION or SET DEFAULT",
9927                self.peek_token_ref(),
9928            )
9929        }
9930    }
9931
9932    /// Parse a `MATCH` kind for constraint references: `FULL`, `PARTIAL`, or `SIMPLE`.
9933    pub fn parse_match_kind(&mut self) -> Result<ConstraintReferenceMatchKind, ParserError> {
9934        if self.parse_keyword(Keyword::FULL) {
9935            Ok(ConstraintReferenceMatchKind::Full)
9936        } else if self.parse_keyword(Keyword::PARTIAL) {
9937            Ok(ConstraintReferenceMatchKind::Partial)
9938        } else if self.parse_keyword(Keyword::SIMPLE) {
9939            Ok(ConstraintReferenceMatchKind::Simple)
9940        } else {
9941            self.expected_ref("one of FULL, PARTIAL or SIMPLE", self.peek_token_ref())
9942        }
9943    }
9944
9945    /// Parse `index_name [ DEFERRABLE | NOT DEFERRABLE ] [ INITIALLY DEFERRED | INITIALLY IMMEDIATE ]`
9946    /// after `{ PRIMARY KEY | UNIQUE } USING INDEX`.
9947    fn parse_constraint_using_index(
9948        &mut self,
9949        name: Option<Ident>,
9950    ) -> Result<ConstraintUsingIndex, ParserError> {
9951        let index_name = self.parse_identifier()?;
9952        let characteristics = self.parse_constraint_characteristics()?;
9953        Ok(ConstraintUsingIndex {
9954            name,
9955            index_name,
9956            characteristics,
9957        })
9958    }
9959
9960    /// Parse optional constraint characteristics such as `DEFERRABLE`, `INITIALLY` and `ENFORCED`.
9961    pub fn parse_constraint_characteristics(
9962        &mut self,
9963    ) -> Result<Option<ConstraintCharacteristics>, ParserError> {
9964        let mut cc = ConstraintCharacteristics::default();
9965
9966        loop {
9967            if cc.deferrable.is_none() && self.parse_keywords(&[Keyword::NOT, Keyword::DEFERRABLE])
9968            {
9969                cc.deferrable = Some(false);
9970            } else if cc.deferrable.is_none() && self.parse_keyword(Keyword::DEFERRABLE) {
9971                cc.deferrable = Some(true);
9972            } else if cc.initially.is_none() && self.parse_keyword(Keyword::INITIALLY) {
9973                if self.parse_keyword(Keyword::DEFERRED) {
9974                    cc.initially = Some(DeferrableInitial::Deferred);
9975                } else if self.parse_keyword(Keyword::IMMEDIATE) {
9976                    cc.initially = Some(DeferrableInitial::Immediate);
9977                } else {
9978                    self.expected_ref("one of DEFERRED or IMMEDIATE", self.peek_token_ref())?;
9979                }
9980            } else if cc.enforced.is_none() && self.parse_keyword(Keyword::ENFORCED) {
9981                cc.enforced = Some(true);
9982            } else if cc.enforced.is_none()
9983                && self.parse_keywords(&[Keyword::NOT, Keyword::ENFORCED])
9984            {
9985                cc.enforced = Some(false);
9986            } else {
9987                break;
9988            }
9989        }
9990
9991        if cc.deferrable.is_some() || cc.initially.is_some() || cc.enforced.is_some() {
9992            Ok(Some(cc))
9993        } else {
9994            Ok(None)
9995        }
9996    }
9997
9998    /// Parse an optional table constraint (e.g. `PRIMARY KEY`, `UNIQUE`, `FOREIGN KEY`, `CHECK`).
9999    pub fn parse_optional_table_constraint(
10000        &mut self,
10001    ) -> Result<Option<TableConstraint>, ParserError> {
10002        let name = if self.parse_keyword(Keyword::CONSTRAINT) {
10003            if self.dialect.supports_constraint_keyword_without_name()
10004                && self
10005                    .peek_one_of_keywords(&[
10006                        Keyword::CHECK,
10007                        Keyword::PRIMARY,
10008                        Keyword::UNIQUE,
10009                        Keyword::FOREIGN,
10010                    ])
10011                    .is_some()
10012            {
10013                None
10014            } else {
10015                Some(self.parse_identifier()?)
10016            }
10017        } else {
10018            None
10019        };
10020
10021        let next_token = self.next_token();
10022        match next_token.token {
10023            Token::Word(w) if w.keyword == Keyword::UNIQUE => {
10024                // PostgreSQL: UNIQUE USING INDEX index_name
10025                // https://www.postgresql.org/docs/current/sql-altertable.html
10026                if self.parse_keywords(&[Keyword::USING, Keyword::INDEX]) {
10027                    return Ok(Some(TableConstraint::UniqueUsingIndex(
10028                        self.parse_constraint_using_index(name)?,
10029                    )));
10030                }
10031
10032                let index_type_display = self.parse_index_type_display();
10033                if !dialect_of!(self is GenericDialect | MySqlDialect)
10034                    && !index_type_display.is_none()
10035                {
10036                    return self.expected_ref(
10037                        "`index_name` or `(column_name [, ...])`",
10038                        self.peek_token_ref(),
10039                    );
10040                }
10041
10042                let nulls_distinct = self.parse_optional_nulls_distinct()?;
10043
10044                // optional index name
10045                let index_name = self.parse_optional_ident()?;
10046                let index_type = self.parse_optional_using_then_index_type()?;
10047
10048                let columns = self.parse_parenthesized_index_column_list()?;
10049                let index_options = self.parse_index_options()?;
10050                let characteristics = self.parse_constraint_characteristics()?;
10051                Ok(Some(
10052                    UniqueConstraint {
10053                        name,
10054                        index_name,
10055                        index_type_display,
10056                        index_type,
10057                        columns,
10058                        index_options,
10059                        characteristics,
10060                        nulls_distinct,
10061                    }
10062                    .into(),
10063                ))
10064            }
10065            Token::Word(w) if w.keyword == Keyword::PRIMARY => {
10066                // after `PRIMARY` always stay `KEY`
10067                self.expect_keyword_is(Keyword::KEY)?;
10068
10069                // PostgreSQL: PRIMARY KEY USING INDEX index_name
10070                // https://www.postgresql.org/docs/current/sql-altertable.html
10071                if self.parse_keywords(&[Keyword::USING, Keyword::INDEX]) {
10072                    return Ok(Some(TableConstraint::PrimaryKeyUsingIndex(
10073                        self.parse_constraint_using_index(name)?,
10074                    )));
10075                }
10076
10077                // optional index name
10078                let index_name = self.parse_optional_ident()?;
10079                let index_type = self.parse_optional_using_then_index_type()?;
10080
10081                let columns = self.parse_parenthesized_index_column_list()?;
10082                let index_options = self.parse_index_options()?;
10083                let characteristics = self.parse_constraint_characteristics()?;
10084                Ok(Some(
10085                    PrimaryKeyConstraint {
10086                        name,
10087                        index_name,
10088                        index_type,
10089                        columns,
10090                        index_options,
10091                        characteristics,
10092                    }
10093                    .into(),
10094                ))
10095            }
10096            Token::Word(w) if w.keyword == Keyword::FOREIGN => {
10097                self.expect_keyword_is(Keyword::KEY)?;
10098                let index_name = self.parse_optional_ident()?;
10099                let columns = self.parse_parenthesized_column_list(Mandatory, false)?;
10100                self.expect_keyword_is(Keyword::REFERENCES)?;
10101                let foreign_table = self.parse_object_name(false)?;
10102                let referred_columns = self.parse_parenthesized_column_list(Optional, false)?;
10103                let mut match_kind = None;
10104                let mut on_delete = None;
10105                let mut on_update = None;
10106                loop {
10107                    if match_kind.is_none() && self.parse_keyword(Keyword::MATCH) {
10108                        match_kind = Some(self.parse_match_kind()?);
10109                    } else if on_delete.is_none()
10110                        && self.parse_keywords(&[Keyword::ON, Keyword::DELETE])
10111                    {
10112                        on_delete = Some(self.parse_referential_action()?);
10113                    } else if on_update.is_none()
10114                        && self.parse_keywords(&[Keyword::ON, Keyword::UPDATE])
10115                    {
10116                        on_update = Some(self.parse_referential_action()?);
10117                    } else {
10118                        break;
10119                    }
10120                }
10121
10122                let characteristics = self.parse_constraint_characteristics()?;
10123
10124                Ok(Some(
10125                    ForeignKeyConstraint {
10126                        name,
10127                        index_name,
10128                        columns,
10129                        foreign_table,
10130                        referred_columns,
10131                        on_delete,
10132                        on_update,
10133                        match_kind,
10134                        characteristics,
10135                    }
10136                    .into(),
10137                ))
10138            }
10139            Token::Word(w) if w.keyword == Keyword::CHECK => {
10140                self.expect_token(&Token::LParen)?;
10141                let expr = Box::new(self.parse_expr()?);
10142                self.expect_token(&Token::RParen)?;
10143
10144                let enforced = if self.parse_keyword(Keyword::ENFORCED) {
10145                    Some(true)
10146                } else if self.parse_keywords(&[Keyword::NOT, Keyword::ENFORCED]) {
10147                    Some(false)
10148                } else {
10149                    None
10150                };
10151
10152                Ok(Some(
10153                    CheckConstraint {
10154                        name,
10155                        expr,
10156                        enforced,
10157                    }
10158                    .into(),
10159                ))
10160            }
10161            Token::Word(w)
10162                if (w.keyword == Keyword::INDEX || w.keyword == Keyword::KEY)
10163                    && dialect_of!(self is GenericDialect | MySqlDialect)
10164                    && name.is_none() =>
10165            {
10166                let display_as_key = w.keyword == Keyword::KEY;
10167
10168                let name = match &self.peek_token_ref().token {
10169                    Token::Word(word) if word.keyword == Keyword::USING => None,
10170                    _ => self.parse_optional_ident()?,
10171                };
10172
10173                let index_type = self.parse_optional_using_then_index_type()?;
10174                let columns = self.parse_parenthesized_index_column_list()?;
10175                let index_options = self.parse_index_options()?;
10176
10177                Ok(Some(
10178                    IndexConstraint {
10179                        display_as_key,
10180                        name,
10181                        index_type,
10182                        columns,
10183                        index_options,
10184                    }
10185                    .into(),
10186                ))
10187            }
10188            Token::Word(w)
10189                if (w.keyword == Keyword::FULLTEXT || w.keyword == Keyword::SPATIAL)
10190                    && dialect_of!(self is GenericDialect | MySqlDialect) =>
10191            {
10192                if let Some(name) = name {
10193                    return self.expected(
10194                        "FULLTEXT or SPATIAL option without constraint name",
10195                        TokenWithSpan {
10196                            token: Token::make_keyword(&name.to_string()),
10197                            span: next_token.span,
10198                        },
10199                    );
10200                }
10201
10202                let fulltext = w.keyword == Keyword::FULLTEXT;
10203
10204                let index_type_display = self.parse_index_type_display();
10205
10206                let opt_index_name = self.parse_optional_ident()?;
10207
10208                let columns = self.parse_parenthesized_index_column_list()?;
10209
10210                Ok(Some(
10211                    FullTextOrSpatialConstraint {
10212                        fulltext,
10213                        index_type_display,
10214                        opt_index_name,
10215                        columns,
10216                    }
10217                    .into(),
10218                ))
10219            }
10220            Token::Word(w) if w.keyword == Keyword::EXCLUDE => {
10221                let index_method = if self.parse_keyword(Keyword::USING) {
10222                    Some(self.parse_identifier()?)
10223                } else {
10224                    None
10225                };
10226
10227                self.expect_token(&Token::LParen)?;
10228                let elements =
10229                    self.parse_comma_separated(|p| p.parse_exclusion_element())?;
10230                self.expect_token(&Token::RParen)?;
10231
10232                let include = if self.parse_keyword(Keyword::INCLUDE) {
10233                    self.expect_token(&Token::LParen)?;
10234                    let cols = self.parse_comma_separated(|p| p.parse_identifier())?;
10235                    self.expect_token(&Token::RParen)?;
10236                    cols
10237                } else {
10238                    vec![]
10239                };
10240
10241                let where_clause = if self.parse_keyword(Keyword::WHERE) {
10242                    self.expect_token(&Token::LParen)?;
10243                    let predicate = self.parse_expr()?;
10244                    self.expect_token(&Token::RParen)?;
10245                    Some(Box::new(predicate))
10246                } else {
10247                    None
10248                };
10249
10250                let characteristics = self.parse_constraint_characteristics()?;
10251
10252                Ok(Some(
10253                    ExclusionConstraint {
10254                        name,
10255                        index_method,
10256                        elements,
10257                        include,
10258                        where_clause,
10259                        characteristics,
10260                    }
10261                    .into(),
10262                ))
10263            }
10264            _ => {
10265                if name.is_some() {
10266                    self.expected("PRIMARY, UNIQUE, FOREIGN, or CHECK", next_token)
10267                } else {
10268                    self.prev_token();
10269                    Ok(None)
10270                }
10271            }
10272        }
10273    }
10274
10275    fn parse_exclusion_element(&mut self) -> Result<ExclusionElement, ParserError> {
10276        let expr = self.parse_expr()?;
10277        self.expect_keyword_is(Keyword::WITH)?;
10278        let operator_token = self.next_token();
10279        let operator = operator_token.token.to_string();
10280        Ok(ExclusionElement { expr, operator })
10281    }
10282
10283    fn parse_optional_nulls_distinct(&mut self) -> Result<NullsDistinctOption, ParserError> {
10284        Ok(if self.parse_keyword(Keyword::NULLS) {
10285            let not = self.parse_keyword(Keyword::NOT);
10286            self.expect_keyword_is(Keyword::DISTINCT)?;
10287            if not {
10288                NullsDistinctOption::NotDistinct
10289            } else {
10290                NullsDistinctOption::Distinct
10291            }
10292        } else {
10293            NullsDistinctOption::None
10294        })
10295    }
10296
10297    /// Optionally parse a parenthesized list of `SqlOption`s introduced by `keyword`.
10298    pub fn maybe_parse_options(
10299        &mut self,
10300        keyword: Keyword,
10301    ) -> Result<Option<Vec<SqlOption>>, ParserError> {
10302        if let Token::Word(word) = &self.peek_token_ref().token {
10303            if word.keyword == keyword {
10304                return Ok(Some(self.parse_options(keyword)?));
10305            }
10306        };
10307        Ok(None)
10308    }
10309
10310    /// Parse a parenthesized list of `SqlOption`s following `keyword`, or return an empty vec.
10311    pub fn parse_options(&mut self, keyword: Keyword) -> Result<Vec<SqlOption>, ParserError> {
10312        if self.parse_keyword(keyword) {
10313            self.expect_token(&Token::LParen)?;
10314            let options = self.parse_comma_separated0(Parser::parse_sql_option, Token::RParen)?;
10315            self.expect_token(&Token::RParen)?;
10316            Ok(options)
10317        } else {
10318            Ok(vec![])
10319        }
10320    }
10321
10322    /// Parse options introduced by one of `keywords` followed by a parenthesized list.
10323    pub fn parse_options_with_keywords(
10324        &mut self,
10325        keywords: &[Keyword],
10326    ) -> Result<Vec<SqlOption>, ParserError> {
10327        if self.parse_keywords(keywords) {
10328            self.expect_token(&Token::LParen)?;
10329            let options = self.parse_comma_separated(Parser::parse_sql_option)?;
10330            self.expect_token(&Token::RParen)?;
10331            Ok(options)
10332        } else {
10333            Ok(vec![])
10334        }
10335    }
10336
10337    /// Parse an index type token (e.g. `BTREE`, `HASH`, or a custom identifier).
10338    pub fn parse_index_type(&mut self) -> Result<IndexType, ParserError> {
10339        Ok(if self.parse_keyword(Keyword::BTREE) {
10340            IndexType::BTree
10341        } else if self.parse_keyword(Keyword::HASH) {
10342            IndexType::Hash
10343        } else if self.parse_keyword(Keyword::GIN) {
10344            IndexType::GIN
10345        } else if self.parse_keyword(Keyword::GIST) {
10346            IndexType::GiST
10347        } else if self.parse_keyword(Keyword::SPGIST) {
10348            IndexType::SPGiST
10349        } else if self.parse_keyword(Keyword::BRIN) {
10350            IndexType::BRIN
10351        } else if self.parse_keyword(Keyword::BLOOM) {
10352            IndexType::Bloom
10353        } else {
10354            IndexType::Custom(self.parse_identifier()?)
10355        })
10356    }
10357
10358    /// Optionally parse the `USING` keyword, followed by an [IndexType]
10359    /// Example:
10360    /// ```sql
10361    //// USING BTREE (name, age DESC)
10362    /// ```
10363    /// Optionally parse `USING <index_type>` and return the parsed `IndexType` if present.
10364    pub fn parse_optional_using_then_index_type(
10365        &mut self,
10366    ) -> Result<Option<IndexType>, ParserError> {
10367        if self.parse_keyword(Keyword::USING) {
10368            Ok(Some(self.parse_index_type()?))
10369        } else {
10370            Ok(None)
10371        }
10372    }
10373
10374    /// Parse `[ident]`, mostly `ident` is name, like:
10375    /// `window_name`, `index_name`, ...
10376    /// Parse an optional identifier, returning `Some(Ident)` if present.
10377    pub fn parse_optional_ident(&mut self) -> Result<Option<Ident>, ParserError> {
10378        self.maybe_parse(|parser| parser.parse_identifier())
10379    }
10380
10381    #[must_use]
10382    /// Parse optional `KEY` or `INDEX` display tokens used in index/constraint declarations.
10383    pub fn parse_index_type_display(&mut self) -> KeyOrIndexDisplay {
10384        if self.parse_keyword(Keyword::KEY) {
10385            KeyOrIndexDisplay::Key
10386        } else if self.parse_keyword(Keyword::INDEX) {
10387            KeyOrIndexDisplay::Index
10388        } else {
10389            KeyOrIndexDisplay::None
10390        }
10391    }
10392
10393    /// Parse an optional index option such as `USING <type>` or `COMMENT <string>`.
10394    pub fn parse_optional_index_option(&mut self) -> Result<Option<IndexOption>, ParserError> {
10395        if let Some(index_type) = self.parse_optional_using_then_index_type()? {
10396            Ok(Some(IndexOption::Using(index_type)))
10397        } else if self.parse_keyword(Keyword::COMMENT) {
10398            let s = self.parse_literal_string()?;
10399            Ok(Some(IndexOption::Comment(s)))
10400        } else {
10401            Ok(None)
10402        }
10403    }
10404
10405    /// Parse zero or more index options and return them as a vector.
10406    pub fn parse_index_options(&mut self) -> Result<Vec<IndexOption>, ParserError> {
10407        let mut options = Vec::new();
10408
10409        loop {
10410            match self.parse_optional_index_option()? {
10411                Some(index_option) => options.push(index_option),
10412                None => return Ok(options),
10413            }
10414        }
10415    }
10416
10417    /// Parse a single `SqlOption` used by various dialect-specific DDL statements.
10418    pub fn parse_sql_option(&mut self) -> Result<SqlOption, ParserError> {
10419        let is_mssql = dialect_of!(self is MsSqlDialect|GenericDialect);
10420
10421        match &self.peek_token_ref().token {
10422            Token::Word(w) if w.keyword == Keyword::HEAP && is_mssql => {
10423                Ok(SqlOption::Ident(self.parse_identifier()?))
10424            }
10425            Token::Word(w) if w.keyword == Keyword::PARTITION && is_mssql => {
10426                self.parse_option_partition()
10427            }
10428            Token::Word(w) if w.keyword == Keyword::CLUSTERED && is_mssql => {
10429                self.parse_option_clustered()
10430            }
10431            _ => {
10432                let name = self.parse_identifier()?;
10433                self.expect_token(&Token::Eq)?;
10434                let value = self.parse_expr()?;
10435
10436                Ok(SqlOption::KeyValue { key: name, value })
10437            }
10438        }
10439    }
10440
10441    /// Parse a `CLUSTERED` table option (MSSQL-specific syntaxes supported).
10442    pub fn parse_option_clustered(&mut self) -> Result<SqlOption, ParserError> {
10443        if self.parse_keywords(&[
10444            Keyword::CLUSTERED,
10445            Keyword::COLUMNSTORE,
10446            Keyword::INDEX,
10447            Keyword::ORDER,
10448        ]) {
10449            Ok(SqlOption::Clustered(
10450                TableOptionsClustered::ColumnstoreIndexOrder(
10451                    self.parse_parenthesized_column_list(IsOptional::Mandatory, false)?,
10452                ),
10453            ))
10454        } else if self.parse_keywords(&[Keyword::CLUSTERED, Keyword::COLUMNSTORE, Keyword::INDEX]) {
10455            Ok(SqlOption::Clustered(
10456                TableOptionsClustered::ColumnstoreIndex,
10457            ))
10458        } else if self.parse_keywords(&[Keyword::CLUSTERED, Keyword::INDEX]) {
10459            self.expect_token(&Token::LParen)?;
10460
10461            let columns = self.parse_comma_separated(|p| {
10462                let name = p.parse_identifier()?;
10463                let asc = p.parse_asc_desc();
10464
10465                Ok(ClusteredIndex { name, asc })
10466            })?;
10467
10468            self.expect_token(&Token::RParen)?;
10469
10470            Ok(SqlOption::Clustered(TableOptionsClustered::Index(columns)))
10471        } else {
10472            Err(ParserError::ParserError(
10473                "invalid CLUSTERED sequence".to_string(),
10474            ))
10475        }
10476    }
10477
10478    /// Parse a `PARTITION(...) FOR VALUES(...)` table option.
10479    pub fn parse_option_partition(&mut self) -> Result<SqlOption, ParserError> {
10480        self.expect_keyword_is(Keyword::PARTITION)?;
10481        self.expect_token(&Token::LParen)?;
10482        let column_name = self.parse_identifier()?;
10483
10484        self.expect_keyword_is(Keyword::RANGE)?;
10485        let range_direction = if self.parse_keyword(Keyword::LEFT) {
10486            Some(PartitionRangeDirection::Left)
10487        } else if self.parse_keyword(Keyword::RIGHT) {
10488            Some(PartitionRangeDirection::Right)
10489        } else {
10490            None
10491        };
10492
10493        self.expect_keywords(&[Keyword::FOR, Keyword::VALUES])?;
10494        self.expect_token(&Token::LParen)?;
10495
10496        let for_values = self.parse_comma_separated(Parser::parse_expr)?;
10497
10498        self.expect_token(&Token::RParen)?;
10499        self.expect_token(&Token::RParen)?;
10500
10501        Ok(SqlOption::Partition {
10502            column_name,
10503            range_direction,
10504            for_values,
10505        })
10506    }
10507
10508    /// Parse a parenthesized list of partition expressions and return a `Partition` value.
10509    pub fn parse_partition(&mut self) -> Result<Partition, ParserError> {
10510        self.expect_token(&Token::LParen)?;
10511        let partitions = self.parse_comma_separated(Parser::parse_expr)?;
10512        self.expect_token(&Token::RParen)?;
10513        Ok(Partition::Partitions(partitions))
10514    }
10515
10516    /// Parse a parenthesized `SELECT` projection used for projection-based operations.
10517    pub fn parse_projection_select(&mut self) -> Result<ProjectionSelect, ParserError> {
10518        self.expect_token(&Token::LParen)?;
10519        self.expect_keyword_is(Keyword::SELECT)?;
10520        let projection = self.parse_projection()?;
10521        let group_by = self.parse_optional_group_by()?;
10522        let order_by = self.parse_optional_order_by()?;
10523        self.expect_token(&Token::RParen)?;
10524        Ok(ProjectionSelect {
10525            projection,
10526            group_by,
10527            order_by,
10528        })
10529    }
10530    /// Parse `ALTER TABLE ... ADD PROJECTION ...` operation.
10531    pub fn parse_alter_table_add_projection(&mut self) -> Result<AlterTableOperation, ParserError> {
10532        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
10533        let name = self.parse_identifier()?;
10534        let query = self.parse_projection_select()?;
10535        Ok(AlterTableOperation::AddProjection {
10536            if_not_exists,
10537            name,
10538            select: query,
10539        })
10540    }
10541
10542    /// Parse Redshift `ALTER SORTKEY (column_list)`.
10543    ///
10544    /// See <https://docs.aws.amazon.com/redshift/latest/dg/r_ALTER_TABLE.html>
10545    fn parse_alter_sort_key(&mut self) -> Result<AlterTableOperation, ParserError> {
10546        self.expect_keyword_is(Keyword::ALTER)?;
10547        self.expect_keyword_is(Keyword::SORTKEY)?;
10548        self.expect_token(&Token::LParen)?;
10549        let columns = self.parse_comma_separated(|p| p.parse_expr())?;
10550        self.expect_token(&Token::RParen)?;
10551        Ok(AlterTableOperation::AlterSortKey { columns })
10552    }
10553
10554    /// Parse a single `ALTER TABLE` operation and return an `AlterTableOperation`.
10555    pub fn parse_alter_table_operation(&mut self) -> Result<AlterTableOperation, ParserError> {
10556        let operation = if self.parse_keyword(Keyword::ADD) {
10557            if let Some(constraint) = self.parse_optional_table_constraint()? {
10558                let not_valid = self.parse_keywords(&[Keyword::NOT, Keyword::VALID]);
10559                AlterTableOperation::AddConstraint {
10560                    constraint,
10561                    not_valid,
10562                }
10563            } else if dialect_of!(self is ClickHouseDialect|GenericDialect)
10564                && self.parse_keyword(Keyword::PROJECTION)
10565            {
10566                return self.parse_alter_table_add_projection();
10567            } else {
10568                let if_not_exists =
10569                    self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
10570                let mut new_partitions = vec![];
10571                loop {
10572                    if self.parse_keyword(Keyword::PARTITION) {
10573                        new_partitions.push(self.parse_partition()?);
10574                    } else {
10575                        break;
10576                    }
10577                }
10578                if !new_partitions.is_empty() {
10579                    AlterTableOperation::AddPartitions {
10580                        if_not_exists,
10581                        new_partitions,
10582                    }
10583                } else {
10584                    let column_keyword = self.parse_keyword(Keyword::COLUMN);
10585
10586                    let if_not_exists = if dialect_of!(self is PostgreSqlDialect | BigQueryDialect | DuckDbDialect | GenericDialect)
10587                    {
10588                        self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS])
10589                            || if_not_exists
10590                    } else {
10591                        false
10592                    };
10593
10594                    let column_def = self.parse_column_def()?;
10595
10596                    let column_position = self.parse_column_position()?;
10597
10598                    AlterTableOperation::AddColumn {
10599                        column_keyword,
10600                        if_not_exists,
10601                        column_def,
10602                        column_position,
10603                    }
10604                }
10605            }
10606        } else if self.parse_keyword(Keyword::RENAME) {
10607            if dialect_of!(self is PostgreSqlDialect) && self.parse_keyword(Keyword::CONSTRAINT) {
10608                let old_name = self.parse_identifier()?;
10609                self.expect_keyword_is(Keyword::TO)?;
10610                let new_name = self.parse_identifier()?;
10611                AlterTableOperation::RenameConstraint { old_name, new_name }
10612            } else if self.parse_keyword(Keyword::TO) {
10613                let table_name = self.parse_object_name(false)?;
10614                AlterTableOperation::RenameTable {
10615                    table_name: RenameTableNameKind::To(table_name),
10616                }
10617            } else if self.parse_keyword(Keyword::AS) {
10618                let table_name = self.parse_object_name(false)?;
10619                AlterTableOperation::RenameTable {
10620                    table_name: RenameTableNameKind::As(table_name),
10621                }
10622            } else {
10623                let _ = self.parse_keyword(Keyword::COLUMN); // [ COLUMN ]
10624                let old_column_name = self.parse_identifier()?;
10625                self.expect_keyword_is(Keyword::TO)?;
10626                let new_column_name = self.parse_identifier()?;
10627                AlterTableOperation::RenameColumn {
10628                    old_column_name,
10629                    new_column_name,
10630                }
10631            }
10632        } else if self.parse_keyword(Keyword::DISABLE) {
10633            if self.parse_keywords(&[Keyword::ROW, Keyword::LEVEL, Keyword::SECURITY]) {
10634                AlterTableOperation::DisableRowLevelSecurity {}
10635            } else if self.parse_keyword(Keyword::RULE) {
10636                let name = self.parse_identifier()?;
10637                AlterTableOperation::DisableRule { name }
10638            } else if self.parse_keyword(Keyword::TRIGGER) {
10639                let name = self.parse_identifier()?;
10640                AlterTableOperation::DisableTrigger { name }
10641            } else {
10642                return self.expected_ref(
10643                    "ROW LEVEL SECURITY, RULE, or TRIGGER after DISABLE",
10644                    self.peek_token_ref(),
10645                );
10646            }
10647        } else if self.parse_keyword(Keyword::ENABLE) {
10648            if self.parse_keywords(&[Keyword::ALWAYS, Keyword::RULE]) {
10649                let name = self.parse_identifier()?;
10650                AlterTableOperation::EnableAlwaysRule { name }
10651            } else if self.parse_keywords(&[Keyword::ALWAYS, Keyword::TRIGGER]) {
10652                let name = self.parse_identifier()?;
10653                AlterTableOperation::EnableAlwaysTrigger { name }
10654            } else if self.parse_keywords(&[Keyword::ROW, Keyword::LEVEL, Keyword::SECURITY]) {
10655                AlterTableOperation::EnableRowLevelSecurity {}
10656            } else if self.parse_keywords(&[Keyword::REPLICA, Keyword::RULE]) {
10657                let name = self.parse_identifier()?;
10658                AlterTableOperation::EnableReplicaRule { name }
10659            } else if self.parse_keywords(&[Keyword::REPLICA, Keyword::TRIGGER]) {
10660                let name = self.parse_identifier()?;
10661                AlterTableOperation::EnableReplicaTrigger { name }
10662            } else if self.parse_keyword(Keyword::RULE) {
10663                let name = self.parse_identifier()?;
10664                AlterTableOperation::EnableRule { name }
10665            } else if self.parse_keyword(Keyword::TRIGGER) {
10666                let name = self.parse_identifier()?;
10667                AlterTableOperation::EnableTrigger { name }
10668            } else {
10669                return self.expected_ref(
10670                    "ALWAYS, REPLICA, ROW LEVEL SECURITY, RULE, or TRIGGER after ENABLE",
10671                    self.peek_token_ref(),
10672                );
10673            }
10674        } else if self.parse_keywords(&[
10675            Keyword::FORCE,
10676            Keyword::ROW,
10677            Keyword::LEVEL,
10678            Keyword::SECURITY,
10679        ]) {
10680            AlterTableOperation::ForceRowLevelSecurity
10681        } else if self.parse_keywords(&[
10682            Keyword::NO,
10683            Keyword::FORCE,
10684            Keyword::ROW,
10685            Keyword::LEVEL,
10686            Keyword::SECURITY,
10687        ]) {
10688            AlterTableOperation::NoForceRowLevelSecurity
10689        } else if self.parse_keywords(&[Keyword::CLEAR, Keyword::PROJECTION])
10690            && dialect_of!(self is ClickHouseDialect|GenericDialect)
10691        {
10692            let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
10693            let name = self.parse_identifier()?;
10694            let partition = if self.parse_keywords(&[Keyword::IN, Keyword::PARTITION]) {
10695                Some(self.parse_identifier()?)
10696            } else {
10697                None
10698            };
10699            AlterTableOperation::ClearProjection {
10700                if_exists,
10701                name,
10702                partition,
10703            }
10704        } else if self.parse_keywords(&[Keyword::MATERIALIZE, Keyword::PROJECTION])
10705            && dialect_of!(self is ClickHouseDialect|GenericDialect)
10706        {
10707            let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
10708            let name = self.parse_identifier()?;
10709            let partition = if self.parse_keywords(&[Keyword::IN, Keyword::PARTITION]) {
10710                Some(self.parse_identifier()?)
10711            } else {
10712                None
10713            };
10714            AlterTableOperation::MaterializeProjection {
10715                if_exists,
10716                name,
10717                partition,
10718            }
10719        } else if self.parse_keyword(Keyword::DROP) {
10720            if self.parse_keywords(&[Keyword::IF, Keyword::EXISTS, Keyword::PARTITION]) {
10721                self.expect_token(&Token::LParen)?;
10722                let partitions = self.parse_comma_separated(Parser::parse_expr)?;
10723                self.expect_token(&Token::RParen)?;
10724                AlterTableOperation::DropPartitions {
10725                    partitions,
10726                    if_exists: true,
10727                }
10728            } else if self.parse_keyword(Keyword::PARTITION) {
10729                self.expect_token(&Token::LParen)?;
10730                let partitions = self.parse_comma_separated(Parser::parse_expr)?;
10731                self.expect_token(&Token::RParen)?;
10732                AlterTableOperation::DropPartitions {
10733                    partitions,
10734                    if_exists: false,
10735                }
10736            } else if self.parse_keyword(Keyword::CONSTRAINT) {
10737                let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
10738                let name = self.parse_identifier()?;
10739                let drop_behavior = self.parse_optional_drop_behavior();
10740                AlterTableOperation::DropConstraint {
10741                    if_exists,
10742                    name,
10743                    drop_behavior,
10744                }
10745            } else if self.parse_keywords(&[Keyword::PRIMARY, Keyword::KEY]) {
10746                let drop_behavior = self.parse_optional_drop_behavior();
10747                AlterTableOperation::DropPrimaryKey { drop_behavior }
10748            } else if self.parse_keywords(&[Keyword::FOREIGN, Keyword::KEY]) {
10749                let name = self.parse_identifier()?;
10750                let drop_behavior = self.parse_optional_drop_behavior();
10751                AlterTableOperation::DropForeignKey {
10752                    name,
10753                    drop_behavior,
10754                }
10755            } else if self.parse_keyword(Keyword::INDEX) {
10756                let name = self.parse_identifier()?;
10757                AlterTableOperation::DropIndex { name }
10758            } else if self.parse_keyword(Keyword::PROJECTION)
10759                && dialect_of!(self is ClickHouseDialect|GenericDialect)
10760            {
10761                let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
10762                let name = self.parse_identifier()?;
10763                AlterTableOperation::DropProjection { if_exists, name }
10764            } else if self.parse_keywords(&[Keyword::CLUSTERING, Keyword::KEY]) {
10765                AlterTableOperation::DropClusteringKey
10766            } else {
10767                let has_column_keyword = self.parse_keyword(Keyword::COLUMN); // [ COLUMN ]
10768                let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
10769                let column_names = if self.dialect.supports_comma_separated_drop_column_list() {
10770                    self.parse_comma_separated(Parser::parse_identifier)?
10771                } else {
10772                    vec![self.parse_identifier()?]
10773                };
10774                let drop_behavior = self.parse_optional_drop_behavior();
10775                AlterTableOperation::DropColumn {
10776                    has_column_keyword,
10777                    column_names,
10778                    if_exists,
10779                    drop_behavior,
10780                }
10781            }
10782        } else if self.parse_keyword(Keyword::PARTITION) {
10783            self.expect_token(&Token::LParen)?;
10784            let before = self.parse_comma_separated(Parser::parse_expr)?;
10785            self.expect_token(&Token::RParen)?;
10786            self.expect_keyword_is(Keyword::RENAME)?;
10787            self.expect_keywords(&[Keyword::TO, Keyword::PARTITION])?;
10788            self.expect_token(&Token::LParen)?;
10789            let renames = self.parse_comma_separated(Parser::parse_expr)?;
10790            self.expect_token(&Token::RParen)?;
10791            AlterTableOperation::RenamePartitions {
10792                old_partitions: before,
10793                new_partitions: renames,
10794            }
10795        } else if self.parse_keyword(Keyword::CHANGE) {
10796            let _ = self.parse_keyword(Keyword::COLUMN); // [ COLUMN ]
10797            let old_name = self.parse_identifier()?;
10798            let new_name = self.parse_identifier()?;
10799            let data_type = self.parse_data_type()?;
10800            let mut options = vec![];
10801            while let Some(option) = self.parse_optional_column_option()? {
10802                options.push(option);
10803            }
10804
10805            let column_position = self.parse_column_position()?;
10806
10807            AlterTableOperation::ChangeColumn {
10808                old_name,
10809                new_name,
10810                data_type,
10811                options,
10812                column_position,
10813            }
10814        } else if self.parse_keyword(Keyword::MODIFY) {
10815            let _ = self.parse_keyword(Keyword::COLUMN); // [ COLUMN ]
10816            let col_name = self.parse_identifier()?;
10817            let data_type = self.parse_data_type()?;
10818            let mut options = vec![];
10819            while let Some(option) = self.parse_optional_column_option()? {
10820                options.push(option);
10821            }
10822
10823            let column_position = self.parse_column_position()?;
10824
10825            AlterTableOperation::ModifyColumn {
10826                col_name,
10827                data_type,
10828                options,
10829                column_position,
10830            }
10831        } else if self.parse_keyword(Keyword::ALTER) {
10832            if self.peek_keyword(Keyword::SORTKEY) {
10833                self.prev_token();
10834                return self.parse_alter_sort_key();
10835            }
10836
10837            let _ = self.parse_keyword(Keyword::COLUMN); // [ COLUMN ]
10838            let column_name = self.parse_identifier()?;
10839            let is_postgresql = dialect_of!(self is PostgreSqlDialect);
10840
10841            let op: AlterColumnOperation = if self.parse_keywords(&[
10842                Keyword::SET,
10843                Keyword::NOT,
10844                Keyword::NULL,
10845            ]) {
10846                AlterColumnOperation::SetNotNull {}
10847            } else if self.parse_keywords(&[Keyword::DROP, Keyword::NOT, Keyword::NULL]) {
10848                AlterColumnOperation::DropNotNull {}
10849            } else if self.parse_keywords(&[Keyword::SET, Keyword::DEFAULT]) {
10850                AlterColumnOperation::SetDefault {
10851                    value: self.parse_expr()?,
10852                }
10853            } else if self.parse_keywords(&[Keyword::DROP, Keyword::DEFAULT]) {
10854                AlterColumnOperation::DropDefault {}
10855            } else if self.parse_keywords(&[Keyword::SET, Keyword::DATA, Keyword::TYPE]) {
10856                self.parse_set_data_type(true)?
10857            } else if self.parse_keyword(Keyword::TYPE) {
10858                self.parse_set_data_type(false)?
10859            } else if self.parse_keywords(&[Keyword::ADD, Keyword::GENERATED]) {
10860                let generated_as = if self.parse_keyword(Keyword::ALWAYS) {
10861                    Some(GeneratedAs::Always)
10862                } else if self.parse_keywords(&[Keyword::BY, Keyword::DEFAULT]) {
10863                    Some(GeneratedAs::ByDefault)
10864                } else {
10865                    None
10866                };
10867
10868                self.expect_keywords(&[Keyword::AS, Keyword::IDENTITY])?;
10869
10870                let mut sequence_options: Option<Vec<SequenceOptions>> = None;
10871
10872                if self.peek_token_ref().token == Token::LParen {
10873                    self.expect_token(&Token::LParen)?;
10874                    sequence_options = Some(self.parse_create_sequence_options()?);
10875                    self.expect_token(&Token::RParen)?;
10876                }
10877
10878                AlterColumnOperation::AddGenerated {
10879                    generated_as,
10880                    sequence_options,
10881                }
10882            } else {
10883                let message = if is_postgresql {
10884                    "SET/DROP NOT NULL, SET DEFAULT, SET DATA TYPE, or ADD GENERATED after ALTER COLUMN"
10885                } else {
10886                    "SET/DROP NOT NULL, SET DEFAULT, or SET DATA TYPE after ALTER COLUMN"
10887                };
10888
10889                return self.expected_ref(message, self.peek_token_ref());
10890            };
10891            AlterTableOperation::AlterColumn { column_name, op }
10892        } else if self.parse_keyword(Keyword::SWAP) {
10893            self.expect_keyword_is(Keyword::WITH)?;
10894            let table_name = self.parse_object_name(false)?;
10895            AlterTableOperation::SwapWith { table_name }
10896        } else if dialect_of!(self is PostgreSqlDialect | GenericDialect)
10897            && self.parse_keywords(&[Keyword::OWNER, Keyword::TO])
10898        {
10899            let new_owner = self.parse_owner()?;
10900            AlterTableOperation::OwnerTo { new_owner }
10901        } else if dialect_of!(self is PostgreSqlDialect)
10902            && self.parse_keywords(&[Keyword::ATTACH, Keyword::PARTITION])
10903        {
10904            let partition_name = self.parse_object_name(false)?;
10905            let partition_bound = self.parse_partition_for_values()?;
10906            AlterTableOperation::AttachPartitionOf {
10907                partition_name,
10908                partition_bound,
10909            }
10910        } else if dialect_of!(self is PostgreSqlDialect)
10911            && self.parse_keywords(&[Keyword::DETACH, Keyword::PARTITION])
10912        {
10913            let partition_name = self.parse_object_name(false)?;
10914            let concurrently = self.parse_keyword(Keyword::CONCURRENTLY);
10915            let finalize = self.parse_keyword(Keyword::FINALIZE);
10916            AlterTableOperation::DetachPartitionOf {
10917                partition_name,
10918                concurrently,
10919                finalize,
10920            }
10921        } else if dialect_of!(self is ClickHouseDialect|GenericDialect)
10922            && self.parse_keyword(Keyword::ATTACH)
10923        {
10924            AlterTableOperation::AttachPartition {
10925                partition: self.parse_part_or_partition()?,
10926            }
10927        } else if dialect_of!(self is ClickHouseDialect|GenericDialect)
10928            && self.parse_keyword(Keyword::DETACH)
10929        {
10930            AlterTableOperation::DetachPartition {
10931                partition: self.parse_part_or_partition()?,
10932            }
10933        } else if dialect_of!(self is ClickHouseDialect|GenericDialect)
10934            && self.parse_keyword(Keyword::FREEZE)
10935        {
10936            let partition = self.parse_part_or_partition()?;
10937            let with_name = if self.parse_keyword(Keyword::WITH) {
10938                self.expect_keyword_is(Keyword::NAME)?;
10939                Some(self.parse_identifier()?)
10940            } else {
10941                None
10942            };
10943            AlterTableOperation::FreezePartition {
10944                partition,
10945                with_name,
10946            }
10947        } else if dialect_of!(self is ClickHouseDialect|GenericDialect)
10948            && self.parse_keyword(Keyword::UNFREEZE)
10949        {
10950            let partition = self.parse_part_or_partition()?;
10951            let with_name = if self.parse_keyword(Keyword::WITH) {
10952                self.expect_keyword_is(Keyword::NAME)?;
10953                Some(self.parse_identifier()?)
10954            } else {
10955                None
10956            };
10957            AlterTableOperation::UnfreezePartition {
10958                partition,
10959                with_name,
10960            }
10961        } else if self.parse_keywords(&[Keyword::CLUSTER, Keyword::BY]) {
10962            self.expect_token(&Token::LParen)?;
10963            let exprs = self.parse_comma_separated(|parser| parser.parse_expr())?;
10964            self.expect_token(&Token::RParen)?;
10965            AlterTableOperation::ClusterBy { exprs }
10966        } else if self.parse_keywords(&[Keyword::SUSPEND, Keyword::RECLUSTER]) {
10967            AlterTableOperation::SuspendRecluster
10968        } else if self.parse_keywords(&[Keyword::RESUME, Keyword::RECLUSTER]) {
10969            AlterTableOperation::ResumeRecluster
10970        } else if self.parse_keyword(Keyword::LOCK) {
10971            let equals = self.consume_token(&Token::Eq);
10972            let lock = match self.parse_one_of_keywords(&[
10973                Keyword::DEFAULT,
10974                Keyword::EXCLUSIVE,
10975                Keyword::NONE,
10976                Keyword::SHARED,
10977            ]) {
10978                Some(Keyword::DEFAULT) => AlterTableLock::Default,
10979                Some(Keyword::EXCLUSIVE) => AlterTableLock::Exclusive,
10980                Some(Keyword::NONE) => AlterTableLock::None,
10981                Some(Keyword::SHARED) => AlterTableLock::Shared,
10982                _ => self.expected_ref(
10983                    "DEFAULT, EXCLUSIVE, NONE or SHARED after LOCK [=]",
10984                    self.peek_token_ref(),
10985                )?,
10986            };
10987            AlterTableOperation::Lock { equals, lock }
10988        } else if self.parse_keyword(Keyword::ALGORITHM) {
10989            let equals = self.consume_token(&Token::Eq);
10990            let algorithm = match self.parse_one_of_keywords(&[
10991                Keyword::DEFAULT,
10992                Keyword::INSTANT,
10993                Keyword::INPLACE,
10994                Keyword::COPY,
10995            ]) {
10996                Some(Keyword::DEFAULT) => AlterTableAlgorithm::Default,
10997                Some(Keyword::INSTANT) => AlterTableAlgorithm::Instant,
10998                Some(Keyword::INPLACE) => AlterTableAlgorithm::Inplace,
10999                Some(Keyword::COPY) => AlterTableAlgorithm::Copy,
11000                _ => self.expected_ref(
11001                    "DEFAULT, INSTANT, INPLACE, or COPY after ALGORITHM [=]",
11002                    self.peek_token_ref(),
11003                )?,
11004            };
11005            AlterTableOperation::Algorithm { equals, algorithm }
11006        } else if self.parse_keyword(Keyword::AUTO_INCREMENT) {
11007            let equals = self.consume_token(&Token::Eq);
11008            let value = self.parse_number_value()?;
11009            AlterTableOperation::AutoIncrement { equals, value }
11010        } else if self.parse_keywords(&[Keyword::REPLICA, Keyword::IDENTITY]) {
11011            let identity = if self.parse_keyword(Keyword::NOTHING) {
11012                ReplicaIdentity::Nothing
11013            } else if self.parse_keyword(Keyword::FULL) {
11014                ReplicaIdentity::Full
11015            } else if self.parse_keyword(Keyword::DEFAULT) {
11016                ReplicaIdentity::Default
11017            } else if self.parse_keywords(&[Keyword::USING, Keyword::INDEX]) {
11018                ReplicaIdentity::Index(self.parse_identifier()?)
11019            } else {
11020                return self.expected_ref(
11021                    "NOTHING, FULL, DEFAULT, or USING INDEX index_name after REPLICA IDENTITY",
11022                    self.peek_token_ref(),
11023                );
11024            };
11025
11026            AlterTableOperation::ReplicaIdentity { identity }
11027        } else if self.parse_keywords(&[Keyword::VALIDATE, Keyword::CONSTRAINT]) {
11028            let name = self.parse_identifier()?;
11029            AlterTableOperation::ValidateConstraint { name }
11030        } else if self.parse_keywords(&[Keyword::SET, Keyword::TABLESPACE]) {
11031            let tablespace_name = self.parse_identifier()?;
11032            AlterTableOperation::SetTablespace { tablespace_name }
11033        } else {
11034            let mut options =
11035                self.parse_options_with_keywords(&[Keyword::SET, Keyword::TBLPROPERTIES])?;
11036            if !options.is_empty() {
11037                AlterTableOperation::SetTblProperties {
11038                    table_properties: options,
11039                }
11040            } else {
11041                options = self.parse_options(Keyword::SET)?;
11042                if !options.is_empty() {
11043                    AlterTableOperation::SetOptionsParens { options }
11044                } else {
11045                    return self.expected_ref(
11046                    "ADD, RENAME, PARTITION, SWAP, DROP, REPLICA IDENTITY, SET, or SET TBLPROPERTIES after ALTER TABLE",
11047                    self.peek_token_ref(),
11048                  );
11049                }
11050            }
11051        };
11052        Ok(operation)
11053    }
11054
11055    fn parse_set_data_type(&mut self, had_set: bool) -> Result<AlterColumnOperation, ParserError> {
11056        let data_type = self.parse_data_type()?;
11057        let using = if self.dialect.supports_alter_column_type_using()
11058            && self.parse_keyword(Keyword::USING)
11059        {
11060            Some(self.parse_expr()?)
11061        } else {
11062            None
11063        };
11064        Ok(AlterColumnOperation::SetDataType {
11065            data_type,
11066            using,
11067            had_set,
11068        })
11069    }
11070
11071    fn parse_part_or_partition(&mut self) -> Result<Partition, ParserError> {
11072        let keyword = self.expect_one_of_keywords(&[Keyword::PART, Keyword::PARTITION])?;
11073        match keyword {
11074            Keyword::PART => Ok(Partition::Part(self.parse_expr()?)),
11075            Keyword::PARTITION => Ok(Partition::Expr(self.parse_expr()?)),
11076            // unreachable because expect_one_of_keywords used above
11077            unexpected_keyword => Err(ParserError::ParserError(
11078                format!("Internal parser error: expected any of {{PART, PARTITION}}, got {unexpected_keyword:?}"),
11079            )),
11080        }
11081    }
11082
11083    /// Parse an `ALTER <object>` statement and dispatch to the appropriate alter handler.
11084    pub fn parse_alter(&mut self) -> Result<Statement, ParserError> {
11085        let object_type = self.expect_one_of_keywords(&[
11086            Keyword::VIEW,
11087            Keyword::TYPE,
11088            Keyword::COLLATION,
11089            Keyword::TABLE,
11090            Keyword::INDEX,
11091            Keyword::FUNCTION,
11092            Keyword::AGGREGATE,
11093            Keyword::ROLE,
11094            Keyword::POLICY,
11095            Keyword::CONNECTOR,
11096            Keyword::ICEBERG,
11097            Keyword::SCHEMA,
11098            Keyword::USER,
11099            Keyword::OPERATOR,
11100            Keyword::DOMAIN,
11101            Keyword::TRIGGER,
11102            Keyword::EXTENSION,
11103            Keyword::PROCEDURE,
11104        ])?;
11105        match object_type {
11106            Keyword::SCHEMA => {
11107                self.prev_token();
11108                self.prev_token();
11109                self.parse_alter_schema()
11110            }
11111            Keyword::VIEW => self.parse_alter_view(),
11112            Keyword::TYPE => self.parse_alter_type(),
11113            Keyword::COLLATION => self.parse_alter_collation().map(Into::into),
11114            Keyword::TABLE => self.parse_alter_table(false),
11115            Keyword::ICEBERG => {
11116                self.expect_keyword(Keyword::TABLE)?;
11117                self.parse_alter_table(true)
11118            }
11119            Keyword::INDEX => {
11120                let index_name = self.parse_object_name(false)?;
11121                let operation = if self.parse_keyword(Keyword::RENAME) {
11122                    if self.parse_keyword(Keyword::TO) {
11123                        let index_name = self.parse_object_name(false)?;
11124                        AlterIndexOperation::RenameIndex { index_name }
11125                    } else {
11126                        return self.expected_ref("TO after RENAME", self.peek_token_ref());
11127                    }
11128                } else if self.parse_keywords(&[Keyword::SET, Keyword::TABLESPACE]) {
11129                    let tablespace_name = self.parse_identifier()?;
11130                    AlterIndexOperation::SetTablespace { tablespace_name }
11131                } else {
11132                    return self.expected_ref(
11133                        "RENAME or SET TABLESPACE after ALTER INDEX",
11134                        self.peek_token_ref(),
11135                    );
11136                };
11137
11138                Ok(Statement::AlterIndex {
11139                    name: index_name,
11140                    operation,
11141                })
11142            }
11143            Keyword::FUNCTION => self.parse_alter_function(AlterFunctionKind::Function),
11144            Keyword::AGGREGATE => self.parse_alter_function(AlterFunctionKind::Aggregate),
11145            Keyword::PROCEDURE => self.parse_alter_function(AlterFunctionKind::Procedure),
11146            Keyword::OPERATOR => {
11147                if self.parse_keyword(Keyword::FAMILY) {
11148                    self.parse_alter_operator_family().map(Into::into)
11149                } else if self.parse_keyword(Keyword::CLASS) {
11150                    self.parse_alter_operator_class().map(Into::into)
11151                } else {
11152                    self.parse_alter_operator().map(Into::into)
11153                }
11154            }
11155            Keyword::ROLE => self.parse_alter_role(),
11156            Keyword::POLICY => self.parse_alter_policy().map(Into::into),
11157            Keyword::CONNECTOR => self.parse_alter_connector(),
11158            Keyword::USER => self.parse_alter_user().map(Into::into),
11159            Keyword::DOMAIN => self.parse_alter_domain(),
11160            Keyword::TRIGGER => self.parse_alter_trigger(),
11161            Keyword::EXTENSION => self.parse_alter_extension(),
11162            // unreachable because expect_one_of_keywords used above
11163            unexpected_keyword => Err(ParserError::ParserError(
11164                format!("Internal parser error: expected any of {{VIEW, TYPE, COLLATION, TABLE, INDEX, FUNCTION, AGGREGATE, ROLE, POLICY, CONNECTOR, ICEBERG, SCHEMA, USER, OPERATOR, DOMAIN, TRIGGER, EXTENSION, PROCEDURE}}, got {unexpected_keyword:?}"),
11165            )),
11166        }
11167    }
11168
11169    fn parse_alter_aggregate_signature(
11170        &mut self,
11171    ) -> Result<(FunctionDesc, bool, Option<Vec<OperateFunctionArg>>), ParserError> {
11172        let name = self.parse_object_name(false)?;
11173        self.expect_token(&Token::LParen)?;
11174
11175        if self.consume_token(&Token::Mul) {
11176            self.expect_token(&Token::RParen)?;
11177            return Ok((
11178                FunctionDesc {
11179                    name,
11180                    args: Some(vec![]),
11181                },
11182                true,
11183                None,
11184            ));
11185        }
11186
11187        let args =
11188            if self.peek_keyword(Keyword::ORDER) || self.peek_token_ref().token == Token::RParen {
11189                vec![]
11190            } else {
11191                self.parse_comma_separated(Parser::parse_aggregate_function_arg)?
11192            };
11193
11194        let aggregate_order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
11195            Some(self.parse_comma_separated(Parser::parse_aggregate_function_arg)?)
11196        } else {
11197            None
11198        };
11199
11200        self.expect_token(&Token::RParen)?;
11201        Ok((
11202            FunctionDesc {
11203                name,
11204                args: Some(args),
11205            },
11206            false,
11207            aggregate_order_by,
11208        ))
11209    }
11210
11211    fn parse_alter_function_action(&mut self) -> Result<Option<AlterFunctionAction>, ParserError> {
11212        let action = if self.parse_keywords(&[
11213            Keyword::CALLED,
11214            Keyword::ON,
11215            Keyword::NULL,
11216            Keyword::INPUT,
11217        ]) {
11218            Some(AlterFunctionAction::CalledOnNull(
11219                FunctionCalledOnNull::CalledOnNullInput,
11220            ))
11221        } else if self.parse_keywords(&[
11222            Keyword::RETURNS,
11223            Keyword::NULL,
11224            Keyword::ON,
11225            Keyword::NULL,
11226            Keyword::INPUT,
11227        ]) {
11228            Some(AlterFunctionAction::CalledOnNull(
11229                FunctionCalledOnNull::ReturnsNullOnNullInput,
11230            ))
11231        } else if self.parse_keyword(Keyword::STRICT) {
11232            Some(AlterFunctionAction::CalledOnNull(
11233                FunctionCalledOnNull::Strict,
11234            ))
11235        } else if self.parse_keyword(Keyword::IMMUTABLE) {
11236            Some(AlterFunctionAction::Behavior(FunctionBehavior::Immutable))
11237        } else if self.parse_keyword(Keyword::STABLE) {
11238            Some(AlterFunctionAction::Behavior(FunctionBehavior::Stable))
11239        } else if self.parse_keyword(Keyword::VOLATILE) {
11240            Some(AlterFunctionAction::Behavior(FunctionBehavior::Volatile))
11241        } else if self.parse_keyword(Keyword::NOT) {
11242            self.expect_keyword(Keyword::LEAKPROOF)?;
11243            Some(AlterFunctionAction::Leakproof(false))
11244        } else if self.parse_keyword(Keyword::LEAKPROOF) {
11245            Some(AlterFunctionAction::Leakproof(true))
11246        } else if self.parse_keyword(Keyword::EXTERNAL) {
11247            self.expect_keyword(Keyword::SECURITY)?;
11248            let security = if self.parse_keyword(Keyword::DEFINER) {
11249                FunctionSecurity::Definer
11250            } else if self.parse_keyword(Keyword::INVOKER) {
11251                FunctionSecurity::Invoker
11252            } else {
11253                return self.expected_ref("DEFINER or INVOKER", self.peek_token_ref());
11254            };
11255            Some(AlterFunctionAction::Security {
11256                external: true,
11257                security,
11258            })
11259        } else if self.parse_keyword(Keyword::SECURITY) {
11260            let security = if self.parse_keyword(Keyword::DEFINER) {
11261                FunctionSecurity::Definer
11262            } else if self.parse_keyword(Keyword::INVOKER) {
11263                FunctionSecurity::Invoker
11264            } else {
11265                return self.expected_ref("DEFINER or INVOKER", self.peek_token_ref());
11266            };
11267            Some(AlterFunctionAction::Security {
11268                external: false,
11269                security,
11270            })
11271        } else if self.parse_keyword(Keyword::PARALLEL) {
11272            let parallel = if self.parse_keyword(Keyword::UNSAFE) {
11273                FunctionParallel::Unsafe
11274            } else if self.parse_keyword(Keyword::RESTRICTED) {
11275                FunctionParallel::Restricted
11276            } else if self.parse_keyword(Keyword::SAFE) {
11277                FunctionParallel::Safe
11278            } else {
11279                return self
11280                    .expected_ref("one of UNSAFE | RESTRICTED | SAFE", self.peek_token_ref());
11281            };
11282            Some(AlterFunctionAction::Parallel(parallel))
11283        } else if self.parse_keyword(Keyword::COST) {
11284            Some(AlterFunctionAction::Cost(self.parse_number()?))
11285        } else if self.parse_keyword(Keyword::ROWS) {
11286            Some(AlterFunctionAction::Rows(self.parse_number()?))
11287        } else if self.parse_keyword(Keyword::SUPPORT) {
11288            Some(AlterFunctionAction::Support(self.parse_object_name(false)?))
11289        } else if self.parse_keyword(Keyword::SET) {
11290            let name = self.parse_object_name(false)?;
11291            let value = if self.parse_keywords(&[Keyword::FROM, Keyword::CURRENT]) {
11292                FunctionSetValue::FromCurrent
11293            } else {
11294                if !self.consume_token(&Token::Eq) && !self.parse_keyword(Keyword::TO) {
11295                    return self.expected_ref("= or TO", self.peek_token_ref());
11296                }
11297                if self.parse_keyword(Keyword::DEFAULT) {
11298                    FunctionSetValue::Default
11299                } else {
11300                    FunctionSetValue::Values(self.parse_comma_separated(Parser::parse_expr)?)
11301                }
11302            };
11303            Some(AlterFunctionAction::Set(FunctionDefinitionSetParam {
11304                name,
11305                value,
11306            }))
11307        } else if self.parse_keyword(Keyword::RESET) {
11308            let reset_config = if self.parse_keyword(Keyword::ALL) {
11309                ResetConfig::ALL
11310            } else {
11311                ResetConfig::ConfigName(self.parse_object_name(false)?)
11312            };
11313            Some(AlterFunctionAction::Reset(reset_config))
11314        } else {
11315            None
11316        };
11317
11318        Ok(action)
11319    }
11320
11321    fn parse_alter_function_actions(
11322        &mut self,
11323    ) -> Result<(Vec<AlterFunctionAction>, bool), ParserError> {
11324        let mut actions = vec![];
11325        while let Some(action) = self.parse_alter_function_action()? {
11326            actions.push(action);
11327        }
11328        if actions.is_empty() {
11329            return self.expected_ref("at least one ALTER FUNCTION action", self.peek_token_ref());
11330        }
11331        let restrict = self.parse_keyword(Keyword::RESTRICT);
11332        Ok((actions, restrict))
11333    }
11334
11335    /// Parse an `ALTER FUNCTION` or `ALTER AGGREGATE` statement.
11336    pub fn parse_alter_function(
11337        &mut self,
11338        kind: AlterFunctionKind,
11339    ) -> Result<Statement, ParserError> {
11340        let (function, aggregate_star, aggregate_order_by) = match kind {
11341            AlterFunctionKind::Function | AlterFunctionKind::Procedure => {
11342                (self.parse_function_desc()?, false, None)
11343            }
11344            AlterFunctionKind::Aggregate => self.parse_alter_aggregate_signature()?,
11345        };
11346
11347        let operation = if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11348            let new_name = self.parse_identifier()?;
11349            AlterFunctionOperation::RenameTo { new_name }
11350        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11351            AlterFunctionOperation::OwnerTo(self.parse_owner()?)
11352        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11353            AlterFunctionOperation::SetSchema {
11354                schema_name: self.parse_object_name(false)?,
11355            }
11356        } else if matches!(kind, AlterFunctionKind::Function | AlterFunctionKind::Procedure)
11357            && self.parse_keyword(Keyword::NO)
11358        {
11359            if !self.parse_keyword(Keyword::DEPENDS) {
11360                return self.expected_ref("DEPENDS after NO", self.peek_token_ref());
11361            }
11362            self.expect_keywords(&[Keyword::ON, Keyword::EXTENSION])?;
11363            AlterFunctionOperation::DependsOnExtension {
11364                no: true,
11365                extension_name: self.parse_object_name(false)?,
11366            }
11367        } else if matches!(kind, AlterFunctionKind::Function | AlterFunctionKind::Procedure)
11368            && self.parse_keyword(Keyword::DEPENDS)
11369        {
11370            self.expect_keywords(&[Keyword::ON, Keyword::EXTENSION])?;
11371            AlterFunctionOperation::DependsOnExtension {
11372                no: false,
11373                extension_name: self.parse_object_name(false)?,
11374            }
11375        } else if matches!(kind, AlterFunctionKind::Function | AlterFunctionKind::Procedure) {
11376            let (actions, restrict) = self.parse_alter_function_actions()?;
11377            AlterFunctionOperation::Actions { actions, restrict }
11378        } else {
11379            return self.expected_ref(
11380                "RENAME TO, OWNER TO, or SET SCHEMA after ALTER AGGREGATE",
11381                self.peek_token_ref(),
11382            );
11383        };
11384
11385        Ok(Statement::AlterFunction(AlterFunction {
11386            kind,
11387            function,
11388            aggregate_order_by,
11389            aggregate_star,
11390            operation,
11391        }))
11392    }
11393
11394    /// Parse an `ALTER DOMAIN` statement.
11395    pub fn parse_alter_domain(&mut self) -> Result<Statement, ParserError> {
11396        let name = self.parse_object_name(false)?;
11397
11398        let operation = if self.parse_keyword(Keyword::ADD) {
11399            if let Some(constraint) = self.parse_optional_table_constraint()? {
11400                let not_valid = self.parse_keywords(&[Keyword::NOT, Keyword::VALID]);
11401                AlterDomainOperation::AddConstraint {
11402                    constraint,
11403                    not_valid,
11404                }
11405            } else {
11406                return self.expected_ref("constraint after ADD", self.peek_token_ref());
11407            }
11408        } else if self.parse_keywords(&[Keyword::DROP, Keyword::CONSTRAINT]) {
11409            let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
11410            let name = self.parse_identifier()?;
11411            let drop_behavior = self.parse_optional_drop_behavior();
11412            AlterDomainOperation::DropConstraint {
11413                if_exists,
11414                name,
11415                drop_behavior,
11416            }
11417        } else if self.parse_keywords(&[Keyword::DROP, Keyword::DEFAULT]) {
11418            AlterDomainOperation::DropDefault
11419        } else if self.parse_keywords(&[Keyword::RENAME, Keyword::CONSTRAINT]) {
11420            let old_name = self.parse_identifier()?;
11421            self.expect_keyword_is(Keyword::TO)?;
11422            let new_name = self.parse_identifier()?;
11423            AlterDomainOperation::RenameConstraint { old_name, new_name }
11424        } else if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11425            let new_name = self.parse_identifier()?;
11426            AlterDomainOperation::RenameTo { new_name }
11427        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11428            AlterDomainOperation::OwnerTo(self.parse_owner()?)
11429        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11430            AlterDomainOperation::SetSchema {
11431                schema_name: self.parse_object_name(false)?,
11432            }
11433        } else if self.parse_keywords(&[Keyword::SET, Keyword::DEFAULT]) {
11434            AlterDomainOperation::SetDefault {
11435                default: self.parse_expr()?,
11436            }
11437        } else if self.parse_keywords(&[Keyword::VALIDATE, Keyword::CONSTRAINT]) {
11438            let name = self.parse_identifier()?;
11439            AlterDomainOperation::ValidateConstraint { name }
11440        } else {
11441            return self.expected_ref(
11442                "ADD, DROP, RENAME, OWNER TO, SET, VALIDATE after ALTER DOMAIN",
11443                self.peek_token_ref(),
11444            );
11445        };
11446
11447        Ok(AlterDomain { name, operation }.into())
11448    }
11449
11450    /// Parse an `ALTER TRIGGER` statement.
11451    pub fn parse_alter_trigger(&mut self) -> Result<Statement, ParserError> {
11452        let name = self.parse_identifier()?;
11453        self.expect_keyword_is(Keyword::ON)?;
11454        let table_name = self.parse_object_name(false)?;
11455
11456        let operation = if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11457            let new_name = self.parse_identifier()?;
11458            AlterTriggerOperation::RenameTo { new_name }
11459        } else {
11460            return self.expected_ref("RENAME TO after ALTER TRIGGER ... ON ...", self.peek_token_ref());
11461        };
11462
11463        Ok(AlterTrigger {
11464            name,
11465            table_name,
11466            operation,
11467        }
11468        .into())
11469    }
11470
11471    /// Parse an `ALTER EXTENSION` statement.
11472    pub fn parse_alter_extension(&mut self) -> Result<Statement, ParserError> {
11473        let name = self.parse_identifier()?;
11474
11475        let operation = if self.parse_keyword(Keyword::UPDATE) {
11476            let version = if self.parse_keyword(Keyword::TO) {
11477                Some(self.parse_identifier()?)
11478            } else {
11479                None
11480            };
11481            AlterExtensionOperation::UpdateTo { version }
11482        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11483            AlterExtensionOperation::SetSchema {
11484                schema_name: self.parse_object_name(false)?,
11485            }
11486        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11487            AlterExtensionOperation::OwnerTo(self.parse_owner()?)
11488        } else if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11489            let new_name = self.parse_identifier()?;
11490            AlterExtensionOperation::RenameTo { new_name }
11491        } else {
11492            return self.expected_ref(
11493                "UPDATE, SET SCHEMA, OWNER TO, or RENAME TO after ALTER EXTENSION",
11494                self.peek_token_ref(),
11495            );
11496        };
11497
11498        Ok(AlterExtension { name, operation }.into())
11499    }
11500
11501    /// Parse a [Statement::AlterTable]
11502    pub fn parse_alter_table(&mut self, iceberg: bool) -> Result<Statement, ParserError> {
11503        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
11504        let only = self.parse_keyword(Keyword::ONLY); // [ ONLY ]
11505        let table_name = self.parse_object_name(false)?;
11506        let on_cluster = self.parse_optional_on_cluster()?;
11507        let operations = self.parse_comma_separated(Parser::parse_alter_table_operation)?;
11508
11509        let mut location = None;
11510        if self.parse_keyword(Keyword::LOCATION) {
11511            location = Some(HiveSetLocation {
11512                has_set: false,
11513                location: self.parse_identifier()?,
11514            });
11515        } else if self.parse_keywords(&[Keyword::SET, Keyword::LOCATION]) {
11516            location = Some(HiveSetLocation {
11517                has_set: true,
11518                location: self.parse_identifier()?,
11519            });
11520        }
11521
11522        let end_token = if self.peek_token_ref().token == Token::SemiColon {
11523            self.peek_token_ref().clone()
11524        } else {
11525            self.get_current_token().clone()
11526        };
11527
11528        Ok(AlterTable {
11529            name: table_name,
11530            if_exists,
11531            only,
11532            operations,
11533            location,
11534            on_cluster,
11535            table_type: if iceberg {
11536                Some(AlterTableType::Iceberg)
11537            } else {
11538                None
11539            },
11540            end_token: AttachedToken(end_token),
11541        }
11542        .into())
11543    }
11544
11545    /// Parse an `ALTER VIEW` statement.
11546    pub fn parse_alter_view(&mut self) -> Result<Statement, ParserError> {
11547        let name = self.parse_object_name(false)?;
11548        let columns = self.parse_parenthesized_column_list(Optional, false)?;
11549
11550        let with_options = self.parse_options(Keyword::WITH)?;
11551
11552        self.expect_keyword_is(Keyword::AS)?;
11553        let query = self.parse_query()?;
11554
11555        Ok(Statement::AlterView {
11556            name,
11557            columns,
11558            query,
11559            with_options,
11560        })
11561    }
11562
11563    /// Parse a [Statement::AlterType]
11564    pub fn parse_alter_type(&mut self) -> Result<Statement, ParserError> {
11565        let name = self.parse_object_name(false)?;
11566
11567        if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11568            let new_name = self.parse_identifier()?;
11569            Ok(Statement::AlterType(AlterType {
11570                name,
11571                operation: AlterTypeOperation::Rename(AlterTypeRename { new_name }),
11572            }))
11573        } else if self.parse_keywords(&[Keyword::ADD, Keyword::VALUE]) {
11574            let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
11575            let new_enum_value = self.parse_identifier()?;
11576            let position = if self.parse_keyword(Keyword::BEFORE) {
11577                Some(AlterTypeAddValuePosition::Before(self.parse_identifier()?))
11578            } else if self.parse_keyword(Keyword::AFTER) {
11579                Some(AlterTypeAddValuePosition::After(self.parse_identifier()?))
11580            } else {
11581                None
11582            };
11583
11584            Ok(Statement::AlterType(AlterType {
11585                name,
11586                operation: AlterTypeOperation::AddValue(AlterTypeAddValue {
11587                    if_not_exists,
11588                    value: new_enum_value,
11589                    position,
11590                }),
11591            }))
11592        } else if self.parse_keywords(&[Keyword::RENAME, Keyword::VALUE]) {
11593            let existing_enum_value = self.parse_identifier()?;
11594            self.expect_keyword(Keyword::TO)?;
11595            let new_enum_value = self.parse_identifier()?;
11596
11597            Ok(Statement::AlterType(AlterType {
11598                name,
11599                operation: AlterTypeOperation::RenameValue(AlterTypeRenameValue {
11600                    from: existing_enum_value,
11601                    to: new_enum_value,
11602                }),
11603            }))
11604        } else {
11605            self.expected_ref(
11606                "{RENAME TO | { RENAME | ADD } VALUE}",
11607                self.peek_token_ref(),
11608            )
11609        }
11610    }
11611
11612    /// Parse a [Statement::AlterCollation].
11613    ///
11614    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-altercollation.html)
11615    pub fn parse_alter_collation(&mut self) -> Result<AlterCollation, ParserError> {
11616        let name = self.parse_object_name(false)?;
11617        let operation = if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11618            AlterCollationOperation::RenameTo {
11619                new_name: self.parse_identifier()?,
11620            }
11621        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11622            AlterCollationOperation::OwnerTo(self.parse_owner()?)
11623        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11624            AlterCollationOperation::SetSchema {
11625                schema_name: self.parse_object_name(false)?,
11626            }
11627        } else if self.parse_keywords(&[Keyword::REFRESH, Keyword::VERSION]) {
11628            AlterCollationOperation::RefreshVersion
11629        } else {
11630            return self.expected_ref(
11631                "RENAME TO, OWNER TO, SET SCHEMA, or REFRESH VERSION after ALTER COLLATION",
11632                self.peek_token_ref(),
11633            );
11634        };
11635
11636        Ok(AlterCollation { name, operation })
11637    }
11638
11639    /// Parse a [Statement::AlterOperator]
11640    ///
11641    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-alteroperator.html)
11642    pub fn parse_alter_operator(&mut self) -> Result<AlterOperator, ParserError> {
11643        let name = self.parse_operator_name()?;
11644
11645        // Parse (left_type, right_type)
11646        self.expect_token(&Token::LParen)?;
11647
11648        let left_type = if self.parse_keyword(Keyword::NONE) {
11649            None
11650        } else {
11651            Some(self.parse_data_type()?)
11652        };
11653
11654        self.expect_token(&Token::Comma)?;
11655        let right_type = self.parse_data_type()?;
11656        self.expect_token(&Token::RParen)?;
11657
11658        // Parse the operation
11659        let operation = if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11660            let owner = if self.parse_keyword(Keyword::CURRENT_ROLE) {
11661                Owner::CurrentRole
11662            } else if self.parse_keyword(Keyword::CURRENT_USER) {
11663                Owner::CurrentUser
11664            } else if self.parse_keyword(Keyword::SESSION_USER) {
11665                Owner::SessionUser
11666            } else {
11667                Owner::Ident(self.parse_identifier()?)
11668            };
11669            AlterOperatorOperation::OwnerTo(owner)
11670        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11671            let schema_name = self.parse_object_name(false)?;
11672            AlterOperatorOperation::SetSchema { schema_name }
11673        } else if self.parse_keyword(Keyword::SET) {
11674            self.expect_token(&Token::LParen)?;
11675
11676            let mut options = Vec::new();
11677            loop {
11678                let keyword = self.expect_one_of_keywords(&[
11679                    Keyword::RESTRICT,
11680                    Keyword::JOIN,
11681                    Keyword::COMMUTATOR,
11682                    Keyword::NEGATOR,
11683                    Keyword::HASHES,
11684                    Keyword::MERGES,
11685                ])?;
11686
11687                match keyword {
11688                    Keyword::RESTRICT => {
11689                        self.expect_token(&Token::Eq)?;
11690                        let proc_name = if self.parse_keyword(Keyword::NONE) {
11691                            None
11692                        } else {
11693                            Some(self.parse_object_name(false)?)
11694                        };
11695                        options.push(OperatorOption::Restrict(proc_name));
11696                    }
11697                    Keyword::JOIN => {
11698                        self.expect_token(&Token::Eq)?;
11699                        let proc_name = if self.parse_keyword(Keyword::NONE) {
11700                            None
11701                        } else {
11702                            Some(self.parse_object_name(false)?)
11703                        };
11704                        options.push(OperatorOption::Join(proc_name));
11705                    }
11706                    Keyword::COMMUTATOR => {
11707                        self.expect_token(&Token::Eq)?;
11708                        let op_name = self.parse_operator_name()?;
11709                        options.push(OperatorOption::Commutator(op_name));
11710                    }
11711                    Keyword::NEGATOR => {
11712                        self.expect_token(&Token::Eq)?;
11713                        let op_name = self.parse_operator_name()?;
11714                        options.push(OperatorOption::Negator(op_name));
11715                    }
11716                    Keyword::HASHES => {
11717                        options.push(OperatorOption::Hashes);
11718                    }
11719                    Keyword::MERGES => {
11720                        options.push(OperatorOption::Merges);
11721                    }
11722                    unexpected_keyword => return Err(ParserError::ParserError(
11723                        format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in operator option"),
11724                    )),
11725                }
11726
11727                if !self.consume_token(&Token::Comma) {
11728                    break;
11729                }
11730            }
11731
11732            self.expect_token(&Token::RParen)?;
11733            AlterOperatorOperation::Set { options }
11734        } else {
11735            return self.expected_ref(
11736                "OWNER TO, SET SCHEMA, or SET after ALTER OPERATOR",
11737                self.peek_token_ref(),
11738            );
11739        };
11740
11741        Ok(AlterOperator {
11742            name,
11743            left_type,
11744            right_type,
11745            operation,
11746        })
11747    }
11748
11749    /// Parse an operator item for ALTER OPERATOR FAMILY ADD operations
11750    fn parse_operator_family_add_operator(&mut self) -> Result<OperatorFamilyItem, ParserError> {
11751        let strategy_number = self.parse_literal_uint()?;
11752        let operator_name = self.parse_operator_name()?;
11753
11754        // Operator argument types (required for ALTER OPERATOR FAMILY)
11755        self.expect_token(&Token::LParen)?;
11756        let op_types = self.parse_comma_separated(Parser::parse_data_type)?;
11757        self.expect_token(&Token::RParen)?;
11758
11759        // Optional purpose
11760        let purpose = if self.parse_keyword(Keyword::FOR) {
11761            if self.parse_keyword(Keyword::SEARCH) {
11762                Some(OperatorPurpose::ForSearch)
11763            } else if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
11764                let sort_family = self.parse_object_name(false)?;
11765                Some(OperatorPurpose::ForOrderBy { sort_family })
11766            } else {
11767                return self.expected_ref("SEARCH or ORDER BY after FOR", self.peek_token_ref());
11768            }
11769        } else {
11770            None
11771        };
11772
11773        Ok(OperatorFamilyItem::Operator {
11774            strategy_number,
11775            operator_name,
11776            op_types,
11777            purpose,
11778        })
11779    }
11780
11781    /// Parse a function item for ALTER OPERATOR FAMILY ADD operations
11782    fn parse_operator_family_add_function(&mut self) -> Result<OperatorFamilyItem, ParserError> {
11783        let support_number = self.parse_literal_uint()?;
11784
11785        // Optional operator types
11786        let op_types =
11787            if self.consume_token(&Token::LParen) && self.peek_token_ref().token != Token::RParen {
11788                let types = self.parse_comma_separated(Parser::parse_data_type)?;
11789                self.expect_token(&Token::RParen)?;
11790                Some(types)
11791            } else if self.consume_token(&Token::LParen) {
11792                self.expect_token(&Token::RParen)?;
11793                Some(vec![])
11794            } else {
11795                None
11796            };
11797
11798        let function_name = self.parse_object_name(false)?;
11799
11800        // Function argument types
11801        let argument_types = if self.consume_token(&Token::LParen) {
11802            if self.peek_token_ref().token == Token::RParen {
11803                self.expect_token(&Token::RParen)?;
11804                vec![]
11805            } else {
11806                let types = self.parse_comma_separated(Parser::parse_data_type)?;
11807                self.expect_token(&Token::RParen)?;
11808                types
11809            }
11810        } else {
11811            vec![]
11812        };
11813
11814        Ok(OperatorFamilyItem::Function {
11815            support_number,
11816            op_types,
11817            function_name,
11818            argument_types,
11819        })
11820    }
11821
11822    /// Parse an operator item for ALTER OPERATOR FAMILY DROP operations
11823    fn parse_operator_family_drop_operator(
11824        &mut self,
11825    ) -> Result<OperatorFamilyDropItem, ParserError> {
11826        let strategy_number = self.parse_literal_uint()?;
11827
11828        // Operator argument types (required for DROP)
11829        self.expect_token(&Token::LParen)?;
11830        let op_types = self.parse_comma_separated(Parser::parse_data_type)?;
11831        self.expect_token(&Token::RParen)?;
11832
11833        Ok(OperatorFamilyDropItem::Operator {
11834            strategy_number,
11835            op_types,
11836        })
11837    }
11838
11839    /// Parse a function item for ALTER OPERATOR FAMILY DROP operations
11840    fn parse_operator_family_drop_function(
11841        &mut self,
11842    ) -> Result<OperatorFamilyDropItem, ParserError> {
11843        let support_number = self.parse_literal_uint()?;
11844
11845        // Operator types (required for DROP)
11846        self.expect_token(&Token::LParen)?;
11847        let op_types = self.parse_comma_separated(Parser::parse_data_type)?;
11848        self.expect_token(&Token::RParen)?;
11849
11850        Ok(OperatorFamilyDropItem::Function {
11851            support_number,
11852            op_types,
11853        })
11854    }
11855
11856    /// Parse an operator family item for ADD operations (dispatches to operator or function parsing)
11857    fn parse_operator_family_add_item(&mut self) -> Result<OperatorFamilyItem, ParserError> {
11858        if self.parse_keyword(Keyword::OPERATOR) {
11859            self.parse_operator_family_add_operator()
11860        } else if self.parse_keyword(Keyword::FUNCTION) {
11861            self.parse_operator_family_add_function()
11862        } else {
11863            self.expected_ref("OPERATOR or FUNCTION", self.peek_token_ref())
11864        }
11865    }
11866
11867    /// Parse an operator family item for DROP operations (dispatches to operator or function parsing)
11868    fn parse_operator_family_drop_item(&mut self) -> Result<OperatorFamilyDropItem, ParserError> {
11869        if self.parse_keyword(Keyword::OPERATOR) {
11870            self.parse_operator_family_drop_operator()
11871        } else if self.parse_keyword(Keyword::FUNCTION) {
11872            self.parse_operator_family_drop_function()
11873        } else {
11874            self.expected_ref("OPERATOR or FUNCTION", self.peek_token_ref())
11875        }
11876    }
11877
11878    /// Parse a [Statement::AlterOperatorFamily]
11879    /// See <https://www.postgresql.org/docs/current/sql-alteropfamily.html>
11880    pub fn parse_alter_operator_family(&mut self) -> Result<AlterOperatorFamily, ParserError> {
11881        let name = self.parse_object_name(false)?;
11882        self.expect_keyword(Keyword::USING)?;
11883        let using = self.parse_identifier()?;
11884
11885        let operation = if self.parse_keyword(Keyword::ADD) {
11886            let items = self.parse_comma_separated(Parser::parse_operator_family_add_item)?;
11887            AlterOperatorFamilyOperation::Add { items }
11888        } else if self.parse_keyword(Keyword::DROP) {
11889            let items = self.parse_comma_separated(Parser::parse_operator_family_drop_item)?;
11890            AlterOperatorFamilyOperation::Drop { items }
11891        } else if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11892            let new_name = self.parse_object_name(false)?;
11893            AlterOperatorFamilyOperation::RenameTo { new_name }
11894        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11895            let owner = self.parse_owner()?;
11896            AlterOperatorFamilyOperation::OwnerTo(owner)
11897        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11898            let schema_name = self.parse_object_name(false)?;
11899            AlterOperatorFamilyOperation::SetSchema { schema_name }
11900        } else {
11901            return self.expected_ref(
11902                "ADD, DROP, RENAME TO, OWNER TO, or SET SCHEMA after ALTER OPERATOR FAMILY",
11903                self.peek_token_ref(),
11904            );
11905        };
11906
11907        Ok(AlterOperatorFamily {
11908            name,
11909            using,
11910            operation,
11911        })
11912    }
11913
11914    /// Parse an `ALTER OPERATOR CLASS` statement.
11915    ///
11916    /// Handles operations like `RENAME TO`, `OWNER TO`, and `SET SCHEMA`.
11917    pub fn parse_alter_operator_class(&mut self) -> Result<AlterOperatorClass, ParserError> {
11918        let name = self.parse_object_name(false)?;
11919        self.expect_keyword(Keyword::USING)?;
11920        let using = self.parse_identifier()?;
11921
11922        let operation = if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11923            let new_name = self.parse_object_name(false)?;
11924            AlterOperatorClassOperation::RenameTo { new_name }
11925        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11926            let owner = self.parse_owner()?;
11927            AlterOperatorClassOperation::OwnerTo(owner)
11928        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11929            let schema_name = self.parse_object_name(false)?;
11930            AlterOperatorClassOperation::SetSchema { schema_name }
11931        } else {
11932            return self.expected_ref(
11933                "RENAME TO, OWNER TO, or SET SCHEMA after ALTER OPERATOR CLASS",
11934                self.peek_token_ref(),
11935            );
11936        };
11937
11938        Ok(AlterOperatorClass {
11939            name,
11940            using,
11941            operation,
11942        })
11943    }
11944
11945    /// Parse an `ALTER SCHEMA` statement.
11946    ///
11947    /// Supports operations such as setting options, renaming, adding/dropping replicas, and changing owner.
11948    pub fn parse_alter_schema(&mut self) -> Result<Statement, ParserError> {
11949        self.expect_keywords(&[Keyword::ALTER, Keyword::SCHEMA])?;
11950        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
11951        let name = self.parse_object_name(false)?;
11952        let operation = if self.parse_keywords(&[Keyword::SET, Keyword::OPTIONS]) {
11953            self.prev_token();
11954            let options = self.parse_options(Keyword::OPTIONS)?;
11955            AlterSchemaOperation::SetOptionsParens { options }
11956        } else if self.parse_keywords(&[Keyword::SET, Keyword::DEFAULT, Keyword::COLLATE]) {
11957            let collate = self.parse_expr()?;
11958            AlterSchemaOperation::SetDefaultCollate { collate }
11959        } else if self.parse_keywords(&[Keyword::ADD, Keyword::REPLICA]) {
11960            let replica = self.parse_identifier()?;
11961            let options = if self.peek_keyword(Keyword::OPTIONS) {
11962                Some(self.parse_options(Keyword::OPTIONS)?)
11963            } else {
11964                None
11965            };
11966            AlterSchemaOperation::AddReplica { replica, options }
11967        } else if self.parse_keywords(&[Keyword::DROP, Keyword::REPLICA]) {
11968            let replica = self.parse_identifier()?;
11969            AlterSchemaOperation::DropReplica { replica }
11970        } else if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11971            let new_name = self.parse_object_name(false)?;
11972            AlterSchemaOperation::Rename { name: new_name }
11973        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11974            let owner = self.parse_owner()?;
11975            AlterSchemaOperation::OwnerTo { owner }
11976        } else {
11977            return self.expected_ref("ALTER SCHEMA operation", self.peek_token_ref());
11978        };
11979        Ok(Statement::AlterSchema(AlterSchema {
11980            name,
11981            if_exists,
11982            operations: vec![operation],
11983        }))
11984    }
11985
11986    /// Parse a `CALL procedure_name(arg1, arg2, ...)`
11987    /// or `CALL procedure_name` statement
11988    pub fn parse_call(&mut self) -> Result<Statement, ParserError> {
11989        let object_name = self.parse_object_name(false)?;
11990        if self.peek_token_ref().token == Token::LParen {
11991            match self.parse_function(object_name)? {
11992                Expr::Function(f) => Ok(Statement::Call(f)),
11993                other => parser_err!(
11994                    format!("Expected a simple procedure call but found: {other}"),
11995                    self.peek_token_ref().span.start
11996                ),
11997            }
11998        } else {
11999            Ok(Statement::Call(Function {
12000                name: object_name,
12001                uses_odbc_syntax: false,
12002                parameters: FunctionArguments::None,
12003                args: FunctionArguments::None,
12004                over: None,
12005                filter: None,
12006                null_treatment: None,
12007                within_group: vec![],
12008            }))
12009        }
12010    }
12011
12012    /// Parse a copy statement
12013    pub fn parse_copy(&mut self) -> Result<Statement, ParserError> {
12014        let source;
12015        if self.consume_token(&Token::LParen) {
12016            source = CopySource::Query(self.parse_query()?);
12017            self.expect_token(&Token::RParen)?;
12018        } else {
12019            let table_name = self.parse_object_name(false)?;
12020            let columns = self.parse_parenthesized_column_list(Optional, false)?;
12021            source = CopySource::Table {
12022                table_name,
12023                columns,
12024            };
12025        }
12026        let to = match self.parse_one_of_keywords(&[Keyword::FROM, Keyword::TO]) {
12027            Some(Keyword::FROM) => false,
12028            Some(Keyword::TO) => true,
12029            _ => self.expected_ref("FROM or TO", self.peek_token_ref())?,
12030        };
12031        if !to {
12032            // Use a separate if statement to prevent Rust compiler from complaining about
12033            // "if statement in this position is unstable: https://github.com/rust-lang/rust/issues/53667"
12034            if let CopySource::Query(_) = source {
12035                return Err(ParserError::ParserError(
12036                    "COPY ... FROM does not support query as a source".to_string(),
12037                ));
12038            }
12039        }
12040        let target = if self.parse_keyword(Keyword::STDIN) {
12041            CopyTarget::Stdin
12042        } else if self.parse_keyword(Keyword::STDOUT) {
12043            CopyTarget::Stdout
12044        } else if self.parse_keyword(Keyword::PROGRAM) {
12045            CopyTarget::Program {
12046                command: self.parse_literal_string()?,
12047            }
12048        } else {
12049            CopyTarget::File {
12050                filename: self.parse_literal_string()?,
12051            }
12052        };
12053        let _ = self.parse_keyword(Keyword::WITH); // [ WITH ]
12054        let mut options = vec![];
12055        if self.consume_token(&Token::LParen) {
12056            options = self.parse_comma_separated(Parser::parse_copy_option)?;
12057            self.expect_token(&Token::RParen)?;
12058        }
12059        let mut legacy_options = vec![];
12060        while let Some(opt) = self.maybe_parse(|parser| parser.parse_copy_legacy_option())? {
12061            legacy_options.push(opt);
12062        }
12063        let values =
12064            if matches!(target, CopyTarget::Stdin) && self.peek_token_ref().token != Token::EOF {
12065                self.expect_token(&Token::SemiColon)?;
12066                self.parse_tsv()
12067            } else {
12068                vec![]
12069            };
12070        Ok(Statement::Copy {
12071            source,
12072            to,
12073            target,
12074            options,
12075            legacy_options,
12076            values,
12077        })
12078    }
12079
12080    /// Parse [Statement::Open]
12081    fn parse_open(&mut self) -> Result<Statement, ParserError> {
12082        self.expect_keyword(Keyword::OPEN)?;
12083        Ok(Statement::Open(OpenStatement {
12084            cursor_name: self.parse_identifier()?,
12085        }))
12086    }
12087
12088    /// Parse a `CLOSE` cursor statement.
12089    pub fn parse_close(&mut self) -> Result<Statement, ParserError> {
12090        let cursor = if self.parse_keyword(Keyword::ALL) {
12091            CloseCursor::All
12092        } else {
12093            let name = self.parse_identifier()?;
12094
12095            CloseCursor::Specific { name }
12096        };
12097
12098        Ok(Statement::Close { cursor })
12099    }
12100
12101    fn parse_copy_option(&mut self) -> Result<CopyOption, ParserError> {
12102        let ret = match self.parse_one_of_keywords(&[
12103            Keyword::FORMAT,
12104            Keyword::FREEZE,
12105            Keyword::DELIMITER,
12106            Keyword::NULL,
12107            Keyword::HEADER,
12108            Keyword::QUOTE,
12109            Keyword::ESCAPE,
12110            Keyword::FORCE_QUOTE,
12111            Keyword::FORCE_NOT_NULL,
12112            Keyword::FORCE_NULL,
12113            Keyword::ENCODING,
12114        ]) {
12115            Some(Keyword::FORMAT) => CopyOption::Format(self.parse_identifier()?),
12116            Some(Keyword::FREEZE) => CopyOption::Freeze(!matches!(
12117                self.parse_one_of_keywords(&[Keyword::TRUE, Keyword::FALSE]),
12118                Some(Keyword::FALSE)
12119            )),
12120            Some(Keyword::DELIMITER) => CopyOption::Delimiter(self.parse_literal_char()?),
12121            Some(Keyword::NULL) => CopyOption::Null(self.parse_literal_string()?),
12122            Some(Keyword::HEADER) => CopyOption::Header(!matches!(
12123                self.parse_one_of_keywords(&[Keyword::TRUE, Keyword::FALSE]),
12124                Some(Keyword::FALSE)
12125            )),
12126            Some(Keyword::QUOTE) => CopyOption::Quote(self.parse_literal_char()?),
12127            Some(Keyword::ESCAPE) => CopyOption::Escape(self.parse_literal_char()?),
12128            Some(Keyword::FORCE_QUOTE) => {
12129                CopyOption::ForceQuote(self.parse_parenthesized_column_list(Mandatory, false)?)
12130            }
12131            Some(Keyword::FORCE_NOT_NULL) => {
12132                CopyOption::ForceNotNull(self.parse_parenthesized_column_list(Mandatory, false)?)
12133            }
12134            Some(Keyword::FORCE_NULL) => {
12135                CopyOption::ForceNull(self.parse_parenthesized_column_list(Mandatory, false)?)
12136            }
12137            Some(Keyword::ENCODING) => CopyOption::Encoding(self.parse_literal_string()?),
12138            _ => self.expected_ref("option", self.peek_token_ref())?,
12139        };
12140        Ok(ret)
12141    }
12142
12143    fn parse_copy_legacy_option(&mut self) -> Result<CopyLegacyOption, ParserError> {
12144        // FORMAT \[ AS \] is optional
12145        if self.parse_keyword(Keyword::FORMAT) {
12146            let _ = self.parse_keyword(Keyword::AS);
12147        }
12148
12149        let ret = match self.parse_one_of_keywords(&[
12150            Keyword::ACCEPTANYDATE,
12151            Keyword::ACCEPTINVCHARS,
12152            Keyword::ADDQUOTES,
12153            Keyword::ALLOWOVERWRITE,
12154            Keyword::BINARY,
12155            Keyword::BLANKSASNULL,
12156            Keyword::BZIP2,
12157            Keyword::CLEANPATH,
12158            Keyword::COMPUPDATE,
12159            Keyword::CREDENTIALS,
12160            Keyword::CSV,
12161            Keyword::DATEFORMAT,
12162            Keyword::DELIMITER,
12163            Keyword::EMPTYASNULL,
12164            Keyword::ENCRYPTED,
12165            Keyword::ESCAPE,
12166            Keyword::EXTENSION,
12167            Keyword::FIXEDWIDTH,
12168            Keyword::GZIP,
12169            Keyword::HEADER,
12170            Keyword::IAM_ROLE,
12171            Keyword::IGNOREHEADER,
12172            Keyword::JSON,
12173            Keyword::MANIFEST,
12174            Keyword::MAXFILESIZE,
12175            Keyword::NULL,
12176            Keyword::PARALLEL,
12177            Keyword::PARQUET,
12178            Keyword::PARTITION,
12179            Keyword::REGION,
12180            Keyword::REMOVEQUOTES,
12181            Keyword::ROWGROUPSIZE,
12182            Keyword::STATUPDATE,
12183            Keyword::TIMEFORMAT,
12184            Keyword::TRUNCATECOLUMNS,
12185            Keyword::ZSTD,
12186        ]) {
12187            Some(Keyword::ACCEPTANYDATE) => CopyLegacyOption::AcceptAnyDate,
12188            Some(Keyword::ACCEPTINVCHARS) => {
12189                let _ = self.parse_keyword(Keyword::AS); // [ AS ]
12190                let ch = if matches!(self.peek_token_ref().token, Token::SingleQuotedString(_)) {
12191                    Some(self.parse_literal_string()?)
12192                } else {
12193                    None
12194                };
12195                CopyLegacyOption::AcceptInvChars(ch)
12196            }
12197            Some(Keyword::ADDQUOTES) => CopyLegacyOption::AddQuotes,
12198            Some(Keyword::ALLOWOVERWRITE) => CopyLegacyOption::AllowOverwrite,
12199            Some(Keyword::BINARY) => CopyLegacyOption::Binary,
12200            Some(Keyword::BLANKSASNULL) => CopyLegacyOption::BlankAsNull,
12201            Some(Keyword::BZIP2) => CopyLegacyOption::Bzip2,
12202            Some(Keyword::CLEANPATH) => CopyLegacyOption::CleanPath,
12203            Some(Keyword::COMPUPDATE) => {
12204                let preset = self.parse_keyword(Keyword::PRESET);
12205                let enabled = match self.parse_one_of_keywords(&[
12206                    Keyword::TRUE,
12207                    Keyword::FALSE,
12208                    Keyword::ON,
12209                    Keyword::OFF,
12210                ]) {
12211                    Some(Keyword::TRUE) | Some(Keyword::ON) => Some(true),
12212                    Some(Keyword::FALSE) | Some(Keyword::OFF) => Some(false),
12213                    _ => None,
12214                };
12215                CopyLegacyOption::CompUpdate { preset, enabled }
12216            }
12217            Some(Keyword::CREDENTIALS) => {
12218                CopyLegacyOption::Credentials(self.parse_literal_string()?)
12219            }
12220            Some(Keyword::CSV) => CopyLegacyOption::Csv({
12221                let mut opts = vec![];
12222                while let Some(opt) =
12223                    self.maybe_parse(|parser| parser.parse_copy_legacy_csv_option())?
12224                {
12225                    opts.push(opt);
12226                }
12227                opts
12228            }),
12229            Some(Keyword::DATEFORMAT) => {
12230                let _ = self.parse_keyword(Keyword::AS);
12231                let fmt = if matches!(self.peek_token_ref().token, Token::SingleQuotedString(_)) {
12232                    Some(self.parse_literal_string()?)
12233                } else {
12234                    None
12235                };
12236                CopyLegacyOption::DateFormat(fmt)
12237            }
12238            Some(Keyword::DELIMITER) => {
12239                let _ = self.parse_keyword(Keyword::AS);
12240                CopyLegacyOption::Delimiter(self.parse_literal_char()?)
12241            }
12242            Some(Keyword::EMPTYASNULL) => CopyLegacyOption::EmptyAsNull,
12243            Some(Keyword::ENCRYPTED) => {
12244                let auto = self.parse_keyword(Keyword::AUTO);
12245                CopyLegacyOption::Encrypted { auto }
12246            }
12247            Some(Keyword::ESCAPE) => CopyLegacyOption::Escape,
12248            Some(Keyword::EXTENSION) => {
12249                let ext = self.parse_literal_string()?;
12250                CopyLegacyOption::Extension(ext)
12251            }
12252            Some(Keyword::FIXEDWIDTH) => {
12253                let spec = self.parse_literal_string()?;
12254                CopyLegacyOption::FixedWidth(spec)
12255            }
12256            Some(Keyword::GZIP) => CopyLegacyOption::Gzip,
12257            Some(Keyword::HEADER) => CopyLegacyOption::Header,
12258            Some(Keyword::IAM_ROLE) => CopyLegacyOption::IamRole(self.parse_iam_role_kind()?),
12259            Some(Keyword::IGNOREHEADER) => {
12260                let _ = self.parse_keyword(Keyword::AS);
12261                let num_rows = self.parse_literal_uint()?;
12262                CopyLegacyOption::IgnoreHeader(num_rows)
12263            }
12264            Some(Keyword::JSON) => {
12265                let _ = self.parse_keyword(Keyword::AS);
12266                let fmt = if matches!(self.peek_token_ref().token, Token::SingleQuotedString(_)) {
12267                    Some(self.parse_literal_string()?)
12268                } else {
12269                    None
12270                };
12271                CopyLegacyOption::Json(fmt)
12272            }
12273            Some(Keyword::MANIFEST) => {
12274                let verbose = self.parse_keyword(Keyword::VERBOSE);
12275                CopyLegacyOption::Manifest { verbose }
12276            }
12277            Some(Keyword::MAXFILESIZE) => {
12278                let _ = self.parse_keyword(Keyword::AS);
12279                let size = self.parse_number_value()?;
12280                let unit = match self.parse_one_of_keywords(&[Keyword::MB, Keyword::GB]) {
12281                    Some(Keyword::MB) => Some(FileSizeUnit::MB),
12282                    Some(Keyword::GB) => Some(FileSizeUnit::GB),
12283                    _ => None,
12284                };
12285                CopyLegacyOption::MaxFileSize(FileSize { size, unit })
12286            }
12287            Some(Keyword::NULL) => {
12288                let _ = self.parse_keyword(Keyword::AS);
12289                CopyLegacyOption::Null(self.parse_literal_string()?)
12290            }
12291            Some(Keyword::PARALLEL) => {
12292                let enabled = match self.parse_one_of_keywords(&[
12293                    Keyword::TRUE,
12294                    Keyword::FALSE,
12295                    Keyword::ON,
12296                    Keyword::OFF,
12297                ]) {
12298                    Some(Keyword::TRUE) | Some(Keyword::ON) => Some(true),
12299                    Some(Keyword::FALSE) | Some(Keyword::OFF) => Some(false),
12300                    _ => None,
12301                };
12302                CopyLegacyOption::Parallel(enabled)
12303            }
12304            Some(Keyword::PARQUET) => CopyLegacyOption::Parquet,
12305            Some(Keyword::PARTITION) => {
12306                self.expect_keyword(Keyword::BY)?;
12307                let columns = self.parse_parenthesized_column_list(IsOptional::Mandatory, false)?;
12308                let include = self.parse_keyword(Keyword::INCLUDE);
12309                CopyLegacyOption::PartitionBy(UnloadPartitionBy { columns, include })
12310            }
12311            Some(Keyword::REGION) => {
12312                let _ = self.parse_keyword(Keyword::AS);
12313                let region = self.parse_literal_string()?;
12314                CopyLegacyOption::Region(region)
12315            }
12316            Some(Keyword::REMOVEQUOTES) => CopyLegacyOption::RemoveQuotes,
12317            Some(Keyword::ROWGROUPSIZE) => {
12318                let _ = self.parse_keyword(Keyword::AS);
12319                let file_size = self.parse_file_size()?;
12320                CopyLegacyOption::RowGroupSize(file_size)
12321            }
12322            Some(Keyword::STATUPDATE) => {
12323                let enabled = match self.parse_one_of_keywords(&[
12324                    Keyword::TRUE,
12325                    Keyword::FALSE,
12326                    Keyword::ON,
12327                    Keyword::OFF,
12328                ]) {
12329                    Some(Keyword::TRUE) | Some(Keyword::ON) => Some(true),
12330                    Some(Keyword::FALSE) | Some(Keyword::OFF) => Some(false),
12331                    _ => None,
12332                };
12333                CopyLegacyOption::StatUpdate(enabled)
12334            }
12335            Some(Keyword::TIMEFORMAT) => {
12336                let _ = self.parse_keyword(Keyword::AS);
12337                let fmt = if matches!(self.peek_token_ref().token, Token::SingleQuotedString(_)) {
12338                    Some(self.parse_literal_string()?)
12339                } else {
12340                    None
12341                };
12342                CopyLegacyOption::TimeFormat(fmt)
12343            }
12344            Some(Keyword::TRUNCATECOLUMNS) => CopyLegacyOption::TruncateColumns,
12345            Some(Keyword::ZSTD) => CopyLegacyOption::Zstd,
12346            _ => self.expected_ref("option", self.peek_token_ref())?,
12347        };
12348        Ok(ret)
12349    }
12350
12351    fn parse_file_size(&mut self) -> Result<FileSize, ParserError> {
12352        let size = self.parse_number_value()?;
12353        let unit = self.maybe_parse_file_size_unit();
12354        Ok(FileSize { size, unit })
12355    }
12356
12357    fn maybe_parse_file_size_unit(&mut self) -> Option<FileSizeUnit> {
12358        match self.parse_one_of_keywords(&[Keyword::MB, Keyword::GB]) {
12359            Some(Keyword::MB) => Some(FileSizeUnit::MB),
12360            Some(Keyword::GB) => Some(FileSizeUnit::GB),
12361            _ => None,
12362        }
12363    }
12364
12365    fn parse_iam_role_kind(&mut self) -> Result<IamRoleKind, ParserError> {
12366        if self.parse_keyword(Keyword::DEFAULT) {
12367            Ok(IamRoleKind::Default)
12368        } else {
12369            let arn = self.parse_literal_string()?;
12370            Ok(IamRoleKind::Arn(arn))
12371        }
12372    }
12373
12374    fn parse_copy_legacy_csv_option(&mut self) -> Result<CopyLegacyCsvOption, ParserError> {
12375        let ret = match self.parse_one_of_keywords(&[
12376            Keyword::HEADER,
12377            Keyword::QUOTE,
12378            Keyword::ESCAPE,
12379            Keyword::FORCE,
12380        ]) {
12381            Some(Keyword::HEADER) => CopyLegacyCsvOption::Header,
12382            Some(Keyword::QUOTE) => {
12383                let _ = self.parse_keyword(Keyword::AS); // [ AS ]
12384                CopyLegacyCsvOption::Quote(self.parse_literal_char()?)
12385            }
12386            Some(Keyword::ESCAPE) => {
12387                let _ = self.parse_keyword(Keyword::AS); // [ AS ]
12388                CopyLegacyCsvOption::Escape(self.parse_literal_char()?)
12389            }
12390            Some(Keyword::FORCE) if self.parse_keywords(&[Keyword::NOT, Keyword::NULL]) => {
12391                CopyLegacyCsvOption::ForceNotNull(
12392                    self.parse_comma_separated(|p| p.parse_identifier())?,
12393                )
12394            }
12395            Some(Keyword::FORCE) if self.parse_keywords(&[Keyword::QUOTE]) => {
12396                CopyLegacyCsvOption::ForceQuote(
12397                    self.parse_comma_separated(|p| p.parse_identifier())?,
12398                )
12399            }
12400            _ => self.expected_ref("csv option", self.peek_token_ref())?,
12401        };
12402        Ok(ret)
12403    }
12404
12405    fn parse_literal_char(&mut self) -> Result<char, ParserError> {
12406        let s = self.parse_literal_string()?;
12407        if s.len() != 1 {
12408            let loc = self
12409                .tokens
12410                .get(self.index - 1)
12411                .map_or(Location { line: 0, column: 0 }, |t| t.span.start);
12412            return parser_err!(format!("Expect a char, found {s:?}"), loc);
12413        }
12414        Ok(s.chars().next().unwrap())
12415    }
12416
12417    /// Parse a tab separated values in
12418    /// COPY payload
12419    pub fn parse_tsv(&mut self) -> Vec<Option<String>> {
12420        self.parse_tab_value()
12421    }
12422
12423    /// Parse a single tab-separated value row used by `COPY` payload parsing.
12424    pub fn parse_tab_value(&mut self) -> Vec<Option<String>> {
12425        let mut values = vec![];
12426        let mut content = String::new();
12427        while let Some(t) = self.next_token_no_skip().map(|t| &t.token) {
12428            match t {
12429                Token::Whitespace(Whitespace::Tab) => {
12430                    values.push(Some(core::mem::take(&mut content)));
12431                }
12432                Token::Whitespace(Whitespace::Newline) => {
12433                    values.push(Some(core::mem::take(&mut content)));
12434                }
12435                Token::Backslash => {
12436                    if self.consume_token(&Token::Period) {
12437                        return values;
12438                    }
12439                    if let Token::Word(w) = self.next_token().token {
12440                        if w.value == "N" {
12441                            values.push(None);
12442                        }
12443                    }
12444                }
12445                _ => {
12446                    content.push_str(&t.to_string());
12447                }
12448            }
12449        }
12450        values
12451    }
12452
12453    /// Parse a literal value (numbers, strings, date/time, booleans)
12454    pub fn parse_value(&mut self) -> Result<ValueWithSpan, ParserError> {
12455        let next_token = self.next_token();
12456        let span = next_token.span;
12457        let ok_value = |value: Value| Ok(value.with_span(span));
12458        match next_token.token {
12459            Token::Word(w) => match w.keyword {
12460                Keyword::TRUE if self.dialect.supports_boolean_literals() => {
12461                    ok_value(Value::Boolean(true))
12462                }
12463                Keyword::FALSE if self.dialect.supports_boolean_literals() => {
12464                    ok_value(Value::Boolean(false))
12465                }
12466                Keyword::NULL => ok_value(Value::Null),
12467                Keyword::NoKeyword if w.quote_style.is_some() => match w.quote_style {
12468                    Some('"') => ok_value(Value::DoubleQuotedString(w.value)),
12469                    Some('\'') => ok_value(Value::SingleQuotedString(w.value)),
12470                    _ => self.expected(
12471                        "A value?",
12472                        TokenWithSpan {
12473                            token: Token::Word(w),
12474                            span,
12475                        },
12476                    )?,
12477                },
12478                _ => self.expected(
12479                    "a concrete value",
12480                    TokenWithSpan {
12481                        token: Token::Word(w),
12482                        span,
12483                    },
12484                ),
12485            },
12486            // The call to n.parse() returns a bigdecimal when the
12487            // bigdecimal feature is enabled, and is otherwise a no-op
12488            // (i.e., it returns the input string).
12489            Token::Number(n, l) => ok_value(Value::Number(Self::parse(n, span.start)?, l)),
12490            Token::SingleQuotedString(ref s) => ok_value(Value::SingleQuotedString(
12491                self.maybe_concat_string_literal(s.to_string()),
12492            )),
12493            Token::DoubleQuotedString(ref s) => ok_value(Value::DoubleQuotedString(
12494                self.maybe_concat_string_literal(s.to_string()),
12495            )),
12496            Token::TripleSingleQuotedString(ref s) => {
12497                ok_value(Value::TripleSingleQuotedString(s.to_string()))
12498            }
12499            Token::TripleDoubleQuotedString(ref s) => {
12500                ok_value(Value::TripleDoubleQuotedString(s.to_string()))
12501            }
12502            Token::DollarQuotedString(ref s) => ok_value(Value::DollarQuotedString(s.clone())),
12503            Token::SingleQuotedByteStringLiteral(ref s) => {
12504                ok_value(Value::SingleQuotedByteStringLiteral(s.clone()))
12505            }
12506            Token::DoubleQuotedByteStringLiteral(ref s) => {
12507                ok_value(Value::DoubleQuotedByteStringLiteral(s.clone()))
12508            }
12509            Token::TripleSingleQuotedByteStringLiteral(ref s) => {
12510                ok_value(Value::TripleSingleQuotedByteStringLiteral(s.clone()))
12511            }
12512            Token::TripleDoubleQuotedByteStringLiteral(ref s) => {
12513                ok_value(Value::TripleDoubleQuotedByteStringLiteral(s.clone()))
12514            }
12515            Token::SingleQuotedRawStringLiteral(ref s) => {
12516                ok_value(Value::SingleQuotedRawStringLiteral(s.clone()))
12517            }
12518            Token::DoubleQuotedRawStringLiteral(ref s) => {
12519                ok_value(Value::DoubleQuotedRawStringLiteral(s.clone()))
12520            }
12521            Token::TripleSingleQuotedRawStringLiteral(ref s) => {
12522                ok_value(Value::TripleSingleQuotedRawStringLiteral(s.clone()))
12523            }
12524            Token::TripleDoubleQuotedRawStringLiteral(ref s) => {
12525                ok_value(Value::TripleDoubleQuotedRawStringLiteral(s.clone()))
12526            }
12527            Token::NationalStringLiteral(ref s) => {
12528                ok_value(Value::NationalStringLiteral(s.to_string()))
12529            }
12530            Token::QuoteDelimitedStringLiteral(v) => {
12531                ok_value(Value::QuoteDelimitedStringLiteral(v))
12532            }
12533            Token::NationalQuoteDelimitedStringLiteral(v) => {
12534                ok_value(Value::NationalQuoteDelimitedStringLiteral(v))
12535            }
12536            Token::EscapedStringLiteral(ref s) => {
12537                ok_value(Value::EscapedStringLiteral(s.to_string()))
12538            }
12539            Token::UnicodeStringLiteral(ref s) => {
12540                ok_value(Value::UnicodeStringLiteral(s.to_string()))
12541            }
12542            Token::HexStringLiteral(ref s) => ok_value(Value::HexStringLiteral(s.to_string())),
12543            Token::Placeholder(ref s) => ok_value(Value::Placeholder(s.to_string())),
12544            tok @ Token::Colon | tok @ Token::AtSign => {
12545                // 1. Not calling self.parse_identifier(false)?
12546                //    because only in placeholder we want to check
12547                //    numbers as idfentifies.  This because snowflake
12548                //    allows numbers as placeholders
12549                // 2. Not calling self.next_token() to enforce `tok`
12550                //    be followed immediately by a word/number, ie.
12551                //    without any whitespace in between
12552                let next_token = self.next_token_no_skip().unwrap_or(&EOF_TOKEN).clone();
12553                let ident = match next_token.token {
12554                    Token::Word(w) => Ok(w.into_ident(next_token.span)),
12555                    Token::Number(w, false) => Ok(Ident::with_span(next_token.span, w)),
12556                    _ => self.expected("placeholder", next_token),
12557                }?;
12558                Ok(Value::Placeholder(format!("{tok}{}", ident.value))
12559                    .with_span(Span::new(span.start, ident.span.end)))
12560            }
12561            unexpected => self.expected(
12562                "a value",
12563                TokenWithSpan {
12564                    token: unexpected,
12565                    span,
12566                },
12567            ),
12568        }
12569    }
12570
12571    fn maybe_concat_string_literal(&mut self, mut str: String) -> String {
12572        if self.dialect.supports_string_literal_concatenation() {
12573            while let Token::SingleQuotedString(ref s) | Token::DoubleQuotedString(ref s) =
12574                self.peek_token_ref().token
12575            {
12576                str.push_str(s);
12577                self.advance_token();
12578            }
12579        } else if self
12580            .dialect
12581            .supports_string_literal_concatenation_with_newline()
12582        {
12583            // We are iterating over tokens including whitespaces, to identify
12584            // string literals separated by newlines so we can concatenate them.
12585            let mut after_newline = false;
12586            loop {
12587                match self.peek_token_no_skip().token {
12588                    Token::Whitespace(Whitespace::Newline) => {
12589                        after_newline = true;
12590                        self.next_token_no_skip();
12591                    }
12592                    Token::Whitespace(_) => {
12593                        self.next_token_no_skip();
12594                    }
12595                    Token::SingleQuotedString(ref s) | Token::DoubleQuotedString(ref s)
12596                        if after_newline =>
12597                    {
12598                        str.push_str(s.clone().as_str());
12599                        self.next_token_no_skip();
12600                        after_newline = false;
12601                    }
12602                    _ => break,
12603                }
12604            }
12605        }
12606
12607        str
12608    }
12609
12610    /// Parse an unsigned numeric literal
12611    pub fn parse_number_value(&mut self) -> Result<ValueWithSpan, ParserError> {
12612        let value_wrapper = self.parse_value()?;
12613        match &value_wrapper.value {
12614            Value::Number(_, _) => Ok(value_wrapper),
12615            Value::Placeholder(_) => Ok(value_wrapper),
12616            _ => {
12617                self.prev_token();
12618                self.expected_ref("literal number", self.peek_token_ref())
12619            }
12620        }
12621    }
12622
12623    /// Parse a numeric literal as an expression. Returns a [`Expr::UnaryOp`] if the number is signed,
12624    /// otherwise returns a [`Expr::Value`]
12625    pub fn parse_number(&mut self) -> Result<Expr, ParserError> {
12626        let next_token = self.next_token();
12627        match next_token.token {
12628            Token::Plus => Ok(Expr::UnaryOp {
12629                op: UnaryOperator::Plus,
12630                expr: Box::new(Expr::Value(self.parse_number_value()?)),
12631            }),
12632            Token::Minus => Ok(Expr::UnaryOp {
12633                op: UnaryOperator::Minus,
12634                expr: Box::new(Expr::Value(self.parse_number_value()?)),
12635            }),
12636            _ => {
12637                self.prev_token();
12638                Ok(Expr::Value(self.parse_number_value()?))
12639            }
12640        }
12641    }
12642
12643    fn parse_introduced_string_expr(&mut self) -> Result<Expr, ParserError> {
12644        let next_token = self.next_token();
12645        let span = next_token.span;
12646        match next_token.token {
12647            Token::SingleQuotedString(ref s) => Ok(Expr::Value(
12648                Value::SingleQuotedString(s.to_string()).with_span(span),
12649            )),
12650            Token::DoubleQuotedString(ref s) => Ok(Expr::Value(
12651                Value::DoubleQuotedString(s.to_string()).with_span(span),
12652            )),
12653            Token::HexStringLiteral(ref s) => Ok(Expr::Value(
12654                Value::HexStringLiteral(s.to_string()).with_span(span),
12655            )),
12656            unexpected => self.expected(
12657                "a string value",
12658                TokenWithSpan {
12659                    token: unexpected,
12660                    span,
12661                },
12662            ),
12663        }
12664    }
12665
12666    /// Parse an unsigned literal integer/long
12667    pub fn parse_literal_uint(&mut self) -> Result<u64, ParserError> {
12668        let next_token = self.next_token();
12669        match next_token.token {
12670            Token::Number(s, _) => Self::parse::<u64>(s, next_token.span.start),
12671            _ => self.expected("literal int", next_token),
12672        }
12673    }
12674
12675    /// Parse the body of a `CREATE FUNCTION` specified as a string.
12676    /// e.g. `CREATE FUNCTION ... AS $$ body $$`.
12677    fn parse_create_function_body_string(&mut self) -> Result<CreateFunctionBody, ParserError> {
12678        let parse_string_expr = |parser: &mut Parser| -> Result<Expr, ParserError> {
12679            let peek_token = parser.peek_token();
12680            let span = peek_token.span;
12681            match peek_token.token {
12682                Token::DollarQuotedString(s) if dialect_of!(parser is PostgreSqlDialect | GenericDialect) =>
12683                {
12684                    parser.next_token();
12685                    Ok(Expr::Value(Value::DollarQuotedString(s).with_span(span)))
12686                }
12687                _ => Ok(Expr::Value(
12688                    Value::SingleQuotedString(parser.parse_literal_string()?).with_span(span),
12689                )),
12690            }
12691        };
12692
12693        Ok(CreateFunctionBody::AsBeforeOptions {
12694            body: parse_string_expr(self)?,
12695            link_symbol: if self.consume_token(&Token::Comma) {
12696                Some(parse_string_expr(self)?)
12697            } else {
12698                None
12699            },
12700        })
12701    }
12702
12703    /// Parse a literal string
12704    pub fn parse_literal_string(&mut self) -> Result<String, ParserError> {
12705        let next_token = self.next_token();
12706        match next_token.token {
12707            Token::Word(Word {
12708                value,
12709                keyword: Keyword::NoKeyword,
12710                ..
12711            }) => Ok(value),
12712            Token::SingleQuotedString(s) => Ok(s),
12713            Token::DoubleQuotedString(s) => Ok(s),
12714            Token::EscapedStringLiteral(s) if dialect_of!(self is PostgreSqlDialect | GenericDialect) => {
12715                Ok(s)
12716            }
12717            Token::UnicodeStringLiteral(s) => Ok(s),
12718            _ => self.expected("literal string", next_token),
12719        }
12720    }
12721
12722    /// Parse a boolean string
12723    pub(crate) fn parse_boolean_string(&mut self) -> Result<bool, ParserError> {
12724        match self.parse_one_of_keywords(&[Keyword::TRUE, Keyword::FALSE]) {
12725            Some(Keyword::TRUE) => Ok(true),
12726            Some(Keyword::FALSE) => Ok(false),
12727            _ => self.expected_ref("TRUE or FALSE", self.peek_token_ref()),
12728        }
12729    }
12730
12731    /// Parse a literal unicode normalization clause
12732    pub fn parse_unicode_is_normalized(&mut self, expr: Expr) -> Result<Expr, ParserError> {
12733        let neg = self.parse_keyword(Keyword::NOT);
12734        let normalized_form = self.maybe_parse(|parser| {
12735            match parser.parse_one_of_keywords(&[
12736                Keyword::NFC,
12737                Keyword::NFD,
12738                Keyword::NFKC,
12739                Keyword::NFKD,
12740            ]) {
12741                Some(Keyword::NFC) => Ok(NormalizationForm::NFC),
12742                Some(Keyword::NFD) => Ok(NormalizationForm::NFD),
12743                Some(Keyword::NFKC) => Ok(NormalizationForm::NFKC),
12744                Some(Keyword::NFKD) => Ok(NormalizationForm::NFKD),
12745                _ => parser.expected_ref("unicode normalization form", parser.peek_token_ref()),
12746            }
12747        })?;
12748        if self.parse_keyword(Keyword::NORMALIZED) {
12749            return Ok(Expr::IsNormalized {
12750                expr: Box::new(expr),
12751                form: normalized_form,
12752                negated: neg,
12753            });
12754        }
12755        self.expected_ref("unicode normalization form", self.peek_token_ref())
12756    }
12757
12758    /// Parse parenthesized enum members, used with `ENUM(...)` type definitions.
12759    pub fn parse_enum_values(&mut self) -> Result<Vec<EnumMember>, ParserError> {
12760        self.expect_token(&Token::LParen)?;
12761        let values = self.parse_comma_separated(|parser| {
12762            let name = parser.parse_literal_string()?;
12763            let e = if parser.consume_token(&Token::Eq) {
12764                let value = parser.parse_number()?;
12765                EnumMember::NamedValue(name, value)
12766            } else {
12767                EnumMember::Name(name)
12768            };
12769            Ok(e)
12770        })?;
12771        self.expect_token(&Token::RParen)?;
12772
12773        Ok(values)
12774    }
12775
12776    /// Parse a SQL datatype (in the context of a CREATE TABLE statement for example)
12777    pub fn parse_data_type(&mut self) -> Result<DataType, ParserError> {
12778        let (ty, trailing_bracket) = self.parse_data_type_helper()?;
12779        if trailing_bracket.0 {
12780            return parser_err!(
12781                format!("unmatched > after parsing data type {ty}"),
12782                self.peek_token_ref()
12783            );
12784        }
12785
12786        Ok(ty)
12787    }
12788
12789    fn parse_data_type_helper(
12790        &mut self,
12791    ) -> Result<(DataType, MatchedTrailingBracket), ParserError> {
12792        let dialect = self.dialect;
12793        self.advance_token();
12794        let next_token = self.get_current_token();
12795        let next_token_index = self.get_current_index();
12796
12797        let mut trailing_bracket: MatchedTrailingBracket = false.into();
12798        let mut data = match &next_token.token {
12799            Token::Word(w) => match w.keyword {
12800                Keyword::BOOLEAN => Ok(DataType::Boolean),
12801                Keyword::BOOL => Ok(DataType::Bool),
12802                Keyword::FLOAT => {
12803                    let precision = self.parse_exact_number_optional_precision_scale()?;
12804
12805                    if self.parse_keyword(Keyword::UNSIGNED) {
12806                        Ok(DataType::FloatUnsigned(precision))
12807                    } else {
12808                        Ok(DataType::Float(precision))
12809                    }
12810                }
12811                Keyword::REAL => {
12812                    if self.parse_keyword(Keyword::UNSIGNED) {
12813                        Ok(DataType::RealUnsigned)
12814                    } else {
12815                        Ok(DataType::Real)
12816                    }
12817                }
12818                Keyword::FLOAT4 => Ok(DataType::Float4),
12819                Keyword::FLOAT32 => Ok(DataType::Float32),
12820                Keyword::FLOAT64 => Ok(DataType::Float64),
12821                Keyword::FLOAT8 => Ok(DataType::Float8),
12822                Keyword::DOUBLE => {
12823                    if self.parse_keyword(Keyword::PRECISION) {
12824                        if self.parse_keyword(Keyword::UNSIGNED) {
12825                            Ok(DataType::DoublePrecisionUnsigned)
12826                        } else {
12827                            Ok(DataType::DoublePrecision)
12828                        }
12829                    } else {
12830                        let precision = self.parse_exact_number_optional_precision_scale()?;
12831
12832                        if self.parse_keyword(Keyword::UNSIGNED) {
12833                            Ok(DataType::DoubleUnsigned(precision))
12834                        } else {
12835                            Ok(DataType::Double(precision))
12836                        }
12837                    }
12838                }
12839                Keyword::TINYINT => {
12840                    let optional_precision = self.parse_optional_precision();
12841                    if self.parse_keyword(Keyword::UNSIGNED) {
12842                        Ok(DataType::TinyIntUnsigned(optional_precision?))
12843                    } else {
12844                        if dialect.supports_data_type_signed_suffix() {
12845                            let _ = self.parse_keyword(Keyword::SIGNED);
12846                        }
12847                        Ok(DataType::TinyInt(optional_precision?))
12848                    }
12849                }
12850                Keyword::INT2 => {
12851                    let optional_precision = self.parse_optional_precision();
12852                    if self.parse_keyword(Keyword::UNSIGNED) {
12853                        Ok(DataType::Int2Unsigned(optional_precision?))
12854                    } else {
12855                        Ok(DataType::Int2(optional_precision?))
12856                    }
12857                }
12858                Keyword::SMALLINT => {
12859                    let optional_precision = self.parse_optional_precision();
12860                    if self.parse_keyword(Keyword::UNSIGNED) {
12861                        Ok(DataType::SmallIntUnsigned(optional_precision?))
12862                    } else {
12863                        if dialect.supports_data_type_signed_suffix() {
12864                            let _ = self.parse_keyword(Keyword::SIGNED);
12865                        }
12866                        Ok(DataType::SmallInt(optional_precision?))
12867                    }
12868                }
12869                Keyword::MEDIUMINT => {
12870                    let optional_precision = self.parse_optional_precision();
12871                    if self.parse_keyword(Keyword::UNSIGNED) {
12872                        Ok(DataType::MediumIntUnsigned(optional_precision?))
12873                    } else {
12874                        if dialect.supports_data_type_signed_suffix() {
12875                            let _ = self.parse_keyword(Keyword::SIGNED);
12876                        }
12877                        Ok(DataType::MediumInt(optional_precision?))
12878                    }
12879                }
12880                Keyword::INT => {
12881                    let optional_precision = self.parse_optional_precision();
12882                    if self.parse_keyword(Keyword::UNSIGNED) {
12883                        Ok(DataType::IntUnsigned(optional_precision?))
12884                    } else {
12885                        if dialect.supports_data_type_signed_suffix() {
12886                            let _ = self.parse_keyword(Keyword::SIGNED);
12887                        }
12888                        Ok(DataType::Int(optional_precision?))
12889                    }
12890                }
12891                Keyword::INT4 => {
12892                    let optional_precision = self.parse_optional_precision();
12893                    if self.parse_keyword(Keyword::UNSIGNED) {
12894                        Ok(DataType::Int4Unsigned(optional_precision?))
12895                    } else {
12896                        Ok(DataType::Int4(optional_precision?))
12897                    }
12898                }
12899                Keyword::INT8 => {
12900                    let optional_precision = self.parse_optional_precision();
12901                    if self.parse_keyword(Keyword::UNSIGNED) {
12902                        Ok(DataType::Int8Unsigned(optional_precision?))
12903                    } else {
12904                        Ok(DataType::Int8(optional_precision?))
12905                    }
12906                }
12907                Keyword::INT16 => Ok(DataType::Int16),
12908                Keyword::INT32 => Ok(DataType::Int32),
12909                Keyword::INT64 => Ok(DataType::Int64),
12910                Keyword::INT128 => Ok(DataType::Int128),
12911                Keyword::INT256 => Ok(DataType::Int256),
12912                Keyword::INTEGER => {
12913                    let optional_precision = self.parse_optional_precision();
12914                    if self.parse_keyword(Keyword::UNSIGNED) {
12915                        Ok(DataType::IntegerUnsigned(optional_precision?))
12916                    } else {
12917                        if dialect.supports_data_type_signed_suffix() {
12918                            let _ = self.parse_keyword(Keyword::SIGNED);
12919                        }
12920                        Ok(DataType::Integer(optional_precision?))
12921                    }
12922                }
12923                Keyword::BIGINT => {
12924                    let optional_precision = self.parse_optional_precision();
12925                    if self.parse_keyword(Keyword::UNSIGNED) {
12926                        Ok(DataType::BigIntUnsigned(optional_precision?))
12927                    } else {
12928                        if dialect.supports_data_type_signed_suffix() {
12929                            let _ = self.parse_keyword(Keyword::SIGNED);
12930                        }
12931                        Ok(DataType::BigInt(optional_precision?))
12932                    }
12933                }
12934                Keyword::HUGEINT => Ok(DataType::HugeInt),
12935                Keyword::UBIGINT => Ok(DataType::UBigInt),
12936                Keyword::UHUGEINT => Ok(DataType::UHugeInt),
12937                Keyword::USMALLINT => Ok(DataType::USmallInt),
12938                Keyword::UTINYINT => Ok(DataType::UTinyInt),
12939                Keyword::UINT8 => Ok(DataType::UInt8),
12940                Keyword::UINT16 => Ok(DataType::UInt16),
12941                Keyword::UINT32 => Ok(DataType::UInt32),
12942                Keyword::UINT64 => Ok(DataType::UInt64),
12943                Keyword::UINT128 => Ok(DataType::UInt128),
12944                Keyword::UINT256 => Ok(DataType::UInt256),
12945                Keyword::VARCHAR => Ok(DataType::Varchar(self.parse_optional_character_length()?)),
12946                Keyword::NVARCHAR => {
12947                    Ok(DataType::Nvarchar(self.parse_optional_character_length()?))
12948                }
12949                Keyword::CHARACTER => {
12950                    if self.parse_keyword(Keyword::VARYING) {
12951                        Ok(DataType::CharacterVarying(
12952                            self.parse_optional_character_length()?,
12953                        ))
12954                    } else if self.parse_keywords(&[Keyword::LARGE, Keyword::OBJECT]) {
12955                        Ok(DataType::CharacterLargeObject(
12956                            self.parse_optional_precision()?,
12957                        ))
12958                    } else {
12959                        Ok(DataType::Character(self.parse_optional_character_length()?))
12960                    }
12961                }
12962                Keyword::CHAR => {
12963                    if self.parse_keyword(Keyword::VARYING) {
12964                        Ok(DataType::CharVarying(
12965                            self.parse_optional_character_length()?,
12966                        ))
12967                    } else if self.parse_keywords(&[Keyword::LARGE, Keyword::OBJECT]) {
12968                        Ok(DataType::CharLargeObject(self.parse_optional_precision()?))
12969                    } else {
12970                        Ok(DataType::Char(self.parse_optional_character_length()?))
12971                    }
12972                }
12973                Keyword::CLOB => Ok(DataType::Clob(self.parse_optional_precision()?)),
12974                Keyword::BINARY => Ok(DataType::Binary(self.parse_optional_precision()?)),
12975                Keyword::VARBINARY => Ok(DataType::Varbinary(self.parse_optional_binary_length()?)),
12976                Keyword::BLOB => Ok(DataType::Blob(self.parse_optional_precision()?)),
12977                Keyword::TINYBLOB => Ok(DataType::TinyBlob),
12978                Keyword::MEDIUMBLOB => Ok(DataType::MediumBlob),
12979                Keyword::LONGBLOB => Ok(DataType::LongBlob),
12980                Keyword::BYTES => Ok(DataType::Bytes(self.parse_optional_precision()?)),
12981                Keyword::BIT => {
12982                    if self.parse_keyword(Keyword::VARYING) {
12983                        Ok(DataType::BitVarying(self.parse_optional_precision()?))
12984                    } else {
12985                        Ok(DataType::Bit(self.parse_optional_precision()?))
12986                    }
12987                }
12988                Keyword::VARBIT => Ok(DataType::VarBit(self.parse_optional_precision()?)),
12989                Keyword::UUID => Ok(DataType::Uuid),
12990                Keyword::DATE => Ok(DataType::Date),
12991                Keyword::DATE32 => Ok(DataType::Date32),
12992                Keyword::DATETIME => Ok(DataType::Datetime(self.parse_optional_precision()?)),
12993                Keyword::DATETIME64 => {
12994                    self.prev_token();
12995                    let (precision, time_zone) = self.parse_datetime_64()?;
12996                    Ok(DataType::Datetime64(precision, time_zone))
12997                }
12998                Keyword::TIMESTAMP => {
12999                    let precision = self.parse_optional_precision()?;
13000                    let tz = if self.parse_keyword(Keyword::WITH) {
13001                        self.expect_keywords(&[Keyword::TIME, Keyword::ZONE])?;
13002                        TimezoneInfo::WithTimeZone
13003                    } else if self.parse_keyword(Keyword::WITHOUT) {
13004                        self.expect_keywords(&[Keyword::TIME, Keyword::ZONE])?;
13005                        TimezoneInfo::WithoutTimeZone
13006                    } else {
13007                        TimezoneInfo::None
13008                    };
13009                    Ok(DataType::Timestamp(precision, tz))
13010                }
13011                Keyword::TIMESTAMPTZ => Ok(DataType::Timestamp(
13012                    self.parse_optional_precision()?,
13013                    TimezoneInfo::Tz,
13014                )),
13015                Keyword::TIMESTAMP_NTZ => {
13016                    Ok(DataType::TimestampNtz(self.parse_optional_precision()?))
13017                }
13018                Keyword::TIME => {
13019                    let precision = self.parse_optional_precision()?;
13020                    let tz = if self.parse_keyword(Keyword::WITH) {
13021                        self.expect_keywords(&[Keyword::TIME, Keyword::ZONE])?;
13022                        TimezoneInfo::WithTimeZone
13023                    } else if self.parse_keyword(Keyword::WITHOUT) {
13024                        self.expect_keywords(&[Keyword::TIME, Keyword::ZONE])?;
13025                        TimezoneInfo::WithoutTimeZone
13026                    } else {
13027                        TimezoneInfo::None
13028                    };
13029                    Ok(DataType::Time(precision, tz))
13030                }
13031                Keyword::TIMETZ => Ok(DataType::Time(
13032                    self.parse_optional_precision()?,
13033                    TimezoneInfo::Tz,
13034                )),
13035                Keyword::INTERVAL => {
13036                    if self.dialect.supports_interval_options() {
13037                        let fields = self.maybe_parse_optional_interval_fields()?;
13038                        let precision = self.parse_optional_precision()?;
13039                        Ok(DataType::Interval { fields, precision })
13040                    } else {
13041                        Ok(DataType::Interval {
13042                            fields: None,
13043                            precision: None,
13044                        })
13045                    }
13046                }
13047                Keyword::JSON => Ok(DataType::JSON),
13048                Keyword::JSONB => Ok(DataType::JSONB),
13049                Keyword::REGCLASS => Ok(DataType::Regclass),
13050                Keyword::STRING => Ok(DataType::String(self.parse_optional_precision()?)),
13051                Keyword::FIXEDSTRING => {
13052                    self.expect_token(&Token::LParen)?;
13053                    let character_length = self.parse_literal_uint()?;
13054                    self.expect_token(&Token::RParen)?;
13055                    Ok(DataType::FixedString(character_length))
13056                }
13057                Keyword::TEXT => Ok(DataType::Text),
13058                Keyword::TINYTEXT => Ok(DataType::TinyText),
13059                Keyword::MEDIUMTEXT => Ok(DataType::MediumText),
13060                Keyword::LONGTEXT => Ok(DataType::LongText),
13061                Keyword::BYTEA => Ok(DataType::Bytea),
13062                Keyword::NUMERIC => Ok(DataType::Numeric(
13063                    self.parse_exact_number_optional_precision_scale()?,
13064                )),
13065                Keyword::DECIMAL => {
13066                    let precision = self.parse_exact_number_optional_precision_scale()?;
13067
13068                    if self.parse_keyword(Keyword::UNSIGNED) {
13069                        Ok(DataType::DecimalUnsigned(precision))
13070                    } else {
13071                        Ok(DataType::Decimal(precision))
13072                    }
13073                }
13074                Keyword::DEC => {
13075                    let precision = self.parse_exact_number_optional_precision_scale()?;
13076
13077                    if self.parse_keyword(Keyword::UNSIGNED) {
13078                        Ok(DataType::DecUnsigned(precision))
13079                    } else {
13080                        Ok(DataType::Dec(precision))
13081                    }
13082                }
13083                Keyword::BIGNUMERIC => Ok(DataType::BigNumeric(
13084                    self.parse_exact_number_optional_precision_scale()?,
13085                )),
13086                Keyword::BIGDECIMAL => Ok(DataType::BigDecimal(
13087                    self.parse_exact_number_optional_precision_scale()?,
13088                )),
13089                Keyword::ENUM => Ok(DataType::Enum(self.parse_enum_values()?, None)),
13090                Keyword::ENUM8 => Ok(DataType::Enum(self.parse_enum_values()?, Some(8))),
13091                Keyword::ENUM16 => Ok(DataType::Enum(self.parse_enum_values()?, Some(16))),
13092                Keyword::SET => Ok(DataType::Set(self.parse_string_values()?)),
13093                Keyword::ARRAY => {
13094                    if self.dialect.supports_array_typedef_without_element_type() {
13095                        Ok(DataType::Array(ArrayElemTypeDef::None))
13096                    } else if dialect_of!(self is ClickHouseDialect) {
13097                        Ok(self.parse_sub_type(|internal_type| {
13098                            DataType::Array(ArrayElemTypeDef::Parenthesis(internal_type))
13099                        })?)
13100                    } else {
13101                        self.expect_token(&Token::Lt)?;
13102                        let (inside_type, _trailing_bracket) = self.parse_data_type_helper()?;
13103                        trailing_bracket = self.expect_closing_angle_bracket(_trailing_bracket)?;
13104                        Ok(DataType::Array(ArrayElemTypeDef::AngleBracket(Box::new(
13105                            inside_type,
13106                        ))))
13107                    }
13108                }
13109                Keyword::STRUCT if dialect_is!(dialect is DuckDbDialect) => {
13110                    self.prev_token();
13111                    let field_defs = self.parse_duckdb_struct_type_def()?;
13112                    Ok(DataType::Struct(field_defs, StructBracketKind::Parentheses))
13113                }
13114                Keyword::STRUCT if dialect_is!(dialect is BigQueryDialect | DatabricksDialect | GenericDialect) =>
13115                {
13116                    self.prev_token();
13117                    let (field_defs, _trailing_bracket) =
13118                        self.parse_struct_type_def(Self::parse_struct_field_def)?;
13119                    trailing_bracket = _trailing_bracket;
13120                    Ok(DataType::Struct(
13121                        field_defs,
13122                        StructBracketKind::AngleBrackets,
13123                    ))
13124                }
13125                Keyword::UNION if dialect_is!(dialect is DuckDbDialect | GenericDialect) => {
13126                    self.prev_token();
13127                    let fields = self.parse_union_type_def()?;
13128                    Ok(DataType::Union(fields))
13129                }
13130                Keyword::NULLABLE if dialect_is!(dialect is ClickHouseDialect | GenericDialect) => {
13131                    Ok(self.parse_sub_type(DataType::Nullable)?)
13132                }
13133                Keyword::LOWCARDINALITY if dialect_is!(dialect is ClickHouseDialect | GenericDialect) => {
13134                    Ok(self.parse_sub_type(DataType::LowCardinality)?)
13135                }
13136                Keyword::MAP if dialect_is!(dialect is ClickHouseDialect | GenericDialect) => {
13137                    self.prev_token();
13138                    let (key_data_type, value_data_type) = self.parse_click_house_map_def()?;
13139                    Ok(DataType::Map(
13140                        Box::new(key_data_type),
13141                        Box::new(value_data_type),
13142                    ))
13143                }
13144                Keyword::NESTED if dialect_is!(dialect is ClickHouseDialect | GenericDialect) => {
13145                    self.expect_token(&Token::LParen)?;
13146                    let field_defs = self.parse_comma_separated(Parser::parse_column_def)?;
13147                    self.expect_token(&Token::RParen)?;
13148                    Ok(DataType::Nested(field_defs))
13149                }
13150                Keyword::TUPLE if dialect_is!(dialect is ClickHouseDialect | GenericDialect) => {
13151                    self.prev_token();
13152                    let field_defs = self.parse_click_house_tuple_def()?;
13153                    Ok(DataType::Tuple(field_defs))
13154                }
13155                Keyword::TRIGGER => Ok(DataType::Trigger),
13156                Keyword::SETOF => {
13157                    let inner = self.parse_data_type()?;
13158                    Ok(DataType::SetOf(Box::new(inner)))
13159                }
13160                Keyword::ANY if self.peek_keyword(Keyword::TYPE) => {
13161                    let _ = self.parse_keyword(Keyword::TYPE);
13162                    Ok(DataType::AnyType)
13163                }
13164                Keyword::TABLE => {
13165                    // an LParen after the TABLE keyword indicates that table columns are being defined
13166                    // whereas no LParen indicates an anonymous table expression will be returned
13167                    if self.peek_token_ref().token == Token::LParen {
13168                        let columns = self.parse_returns_table_columns()?;
13169                        Ok(DataType::Table(Some(columns)))
13170                    } else {
13171                        Ok(DataType::Table(None))
13172                    }
13173                }
13174                Keyword::SIGNED => {
13175                    if self.parse_keyword(Keyword::INTEGER) {
13176                        Ok(DataType::SignedInteger)
13177                    } else {
13178                        Ok(DataType::Signed)
13179                    }
13180                }
13181                Keyword::UNSIGNED => {
13182                    if self.parse_keyword(Keyword::INTEGER) {
13183                        Ok(DataType::UnsignedInteger)
13184                    } else {
13185                        Ok(DataType::Unsigned)
13186                    }
13187                }
13188                Keyword::TSVECTOR if dialect_is!(dialect is PostgreSqlDialect | GenericDialect) => {
13189                    Ok(DataType::TsVector)
13190                }
13191                Keyword::TSQUERY if dialect_is!(dialect is PostgreSqlDialect | GenericDialect) => {
13192                    Ok(DataType::TsQuery)
13193                }
13194                _ => {
13195                    self.prev_token();
13196                    let type_name = self.parse_object_name(false)?;
13197                    if let Some(modifiers) = self.parse_optional_type_modifiers()? {
13198                        Ok(DataType::Custom(type_name, modifiers))
13199                    } else {
13200                        Ok(DataType::Custom(type_name, vec![]))
13201                    }
13202                }
13203            },
13204            _ => self.expected_at("a data type name", next_token_index),
13205        }?;
13206
13207        if self.dialect.supports_array_typedef_with_brackets() {
13208            while self.consume_token(&Token::LBracket) {
13209                // Parse optional array data type size
13210                let size = self.maybe_parse(|p| p.parse_literal_uint())?;
13211                self.expect_token(&Token::RBracket)?;
13212                data = DataType::Array(ArrayElemTypeDef::SquareBracket(Box::new(data), size))
13213            }
13214        }
13215        Ok((data, trailing_bracket))
13216    }
13217
13218    fn parse_returns_table_column(&mut self) -> Result<ColumnDef, ParserError> {
13219        self.parse_column_def()
13220    }
13221
13222    fn parse_returns_table_columns(&mut self) -> Result<Vec<ColumnDef>, ParserError> {
13223        self.expect_token(&Token::LParen)?;
13224        let columns = self.parse_comma_separated(Parser::parse_returns_table_column)?;
13225        self.expect_token(&Token::RParen)?;
13226        Ok(columns)
13227    }
13228
13229    /// Parse a parenthesized, comma-separated list of single-quoted strings.
13230    pub fn parse_string_values(&mut self) -> Result<Vec<String>, ParserError> {
13231        self.expect_token(&Token::LParen)?;
13232        let mut values = Vec::new();
13233        loop {
13234            let next_token = self.next_token();
13235            match next_token.token {
13236                Token::SingleQuotedString(value) => values.push(value),
13237                _ => self.expected("a string", next_token)?,
13238            }
13239            let next_token = self.next_token();
13240            match next_token.token {
13241                Token::Comma => (),
13242                Token::RParen => break,
13243                _ => self.expected(", or }", next_token)?,
13244            }
13245        }
13246        Ok(values)
13247    }
13248
13249    /// Strictly parse `identifier AS identifier`
13250    pub fn parse_identifier_with_alias(&mut self) -> Result<IdentWithAlias, ParserError> {
13251        let ident = self.parse_identifier()?;
13252        self.expect_keyword_is(Keyword::AS)?;
13253        let alias = self.parse_identifier()?;
13254        Ok(IdentWithAlias { ident, alias })
13255    }
13256
13257    /// Parse `identifier [AS] identifier` where the AS keyword is optional
13258    fn parse_identifier_with_optional_alias(&mut self) -> Result<IdentWithAlias, ParserError> {
13259        let ident = self.parse_identifier()?;
13260        let _after_as = self.parse_keyword(Keyword::AS);
13261        let alias = self.parse_identifier()?;
13262        Ok(IdentWithAlias { ident, alias })
13263    }
13264
13265    /// Parse comma-separated list of parenthesized queries for pipe operators
13266    fn parse_pipe_operator_queries(&mut self) -> Result<Vec<Query>, ParserError> {
13267        self.parse_comma_separated(|parser| {
13268            parser.expect_token(&Token::LParen)?;
13269            let query = parser.parse_query()?;
13270            parser.expect_token(&Token::RParen)?;
13271            Ok(*query)
13272        })
13273    }
13274
13275    /// Parse set quantifier for pipe operators that require DISTINCT. E.g. INTERSECT and EXCEPT
13276    fn parse_distinct_required_set_quantifier(
13277        &mut self,
13278        operator_name: &str,
13279    ) -> Result<SetQuantifier, ParserError> {
13280        let quantifier = self.parse_set_quantifier(&Some(SetOperator::Intersect));
13281        match quantifier {
13282            SetQuantifier::Distinct | SetQuantifier::DistinctByName => Ok(quantifier),
13283            _ => Err(ParserError::ParserError(format!(
13284                "{operator_name} pipe operator requires DISTINCT modifier",
13285            ))),
13286        }
13287    }
13288
13289    /// Parse optional identifier alias (with or without AS keyword)
13290    fn parse_identifier_optional_alias(&mut self) -> Result<Option<Ident>, ParserError> {
13291        if self.parse_keyword(Keyword::AS) {
13292            Ok(Some(self.parse_identifier()?))
13293        } else {
13294            // Check if the next token is an identifier (implicit alias)
13295            self.maybe_parse(|parser| parser.parse_identifier())
13296        }
13297    }
13298
13299    /// Optionally parses an alias for a select list item
13300    fn maybe_parse_select_item_alias(&mut self) -> Result<Option<Ident>, ParserError> {
13301        fn validator(explicit: bool, kw: &Keyword, parser: &mut Parser) -> bool {
13302            parser.dialect.is_select_item_alias(explicit, kw, parser)
13303        }
13304        self.parse_optional_alias_inner(None, validator)
13305    }
13306
13307    /// Optionally parses an alias for a table like in `... FROM generate_series(1, 10) AS t (col)`.
13308    /// In this case, the alias is allowed to optionally name the columns in the table, in
13309    /// addition to the table itself.
13310    pub fn maybe_parse_table_alias(&mut self) -> Result<Option<TableAlias>, ParserError> {
13311        fn validator(explicit: bool, kw: &Keyword, parser: &mut Parser) -> bool {
13312            parser.dialect.is_table_factor_alias(explicit, kw, parser)
13313        }
13314        let explicit = self.peek_keyword(Keyword::AS);
13315        match self.parse_optional_alias_inner(None, validator)? {
13316            Some(name) => {
13317                let columns = self.parse_table_alias_column_defs()?;
13318                Ok(Some(TableAlias {
13319                    explicit,
13320                    name,
13321                    columns,
13322                }))
13323            }
13324            None => Ok(None),
13325        }
13326    }
13327
13328    fn parse_table_index_hints(&mut self) -> Result<Vec<TableIndexHints>, ParserError> {
13329        let mut hints = vec![];
13330        while let Some(hint_type) =
13331            self.parse_one_of_keywords(&[Keyword::USE, Keyword::IGNORE, Keyword::FORCE])
13332        {
13333            let hint_type = match hint_type {
13334                Keyword::USE => TableIndexHintType::Use,
13335                Keyword::IGNORE => TableIndexHintType::Ignore,
13336                Keyword::FORCE => TableIndexHintType::Force,
13337                _ => {
13338                    return self.expected_ref(
13339                        "expected to match USE/IGNORE/FORCE keyword",
13340                        self.peek_token_ref(),
13341                    )
13342                }
13343            };
13344            let index_type = match self.parse_one_of_keywords(&[Keyword::INDEX, Keyword::KEY]) {
13345                Some(Keyword::INDEX) => TableIndexType::Index,
13346                Some(Keyword::KEY) => TableIndexType::Key,
13347                _ => {
13348                    return self
13349                        .expected_ref("expected to match INDEX/KEY keyword", self.peek_token_ref())
13350                }
13351            };
13352            let for_clause = if self.parse_keyword(Keyword::FOR) {
13353                let clause = if self.parse_keyword(Keyword::JOIN) {
13354                    TableIndexHintForClause::Join
13355                } else if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
13356                    TableIndexHintForClause::OrderBy
13357                } else if self.parse_keywords(&[Keyword::GROUP, Keyword::BY]) {
13358                    TableIndexHintForClause::GroupBy
13359                } else {
13360                    return self.expected_ref(
13361                        "expected to match FOR/ORDER BY/GROUP BY table hint in for clause",
13362                        self.peek_token_ref(),
13363                    );
13364                };
13365                Some(clause)
13366            } else {
13367                None
13368            };
13369
13370            self.expect_token(&Token::LParen)?;
13371            let index_names = if self.peek_token_ref().token != Token::RParen {
13372                self.parse_comma_separated(Parser::parse_identifier)?
13373            } else {
13374                vec![]
13375            };
13376            self.expect_token(&Token::RParen)?;
13377            hints.push(TableIndexHints {
13378                hint_type,
13379                index_type,
13380                for_clause,
13381                index_names,
13382            });
13383        }
13384        Ok(hints)
13385    }
13386
13387    /// Wrapper for parse_optional_alias_inner, left for backwards-compatibility
13388    /// but new flows should use the context-specific methods such as `maybe_parse_select_item_alias`
13389    /// and `maybe_parse_table_alias`.
13390    pub fn parse_optional_alias(
13391        &mut self,
13392        reserved_kwds: &[Keyword],
13393    ) -> Result<Option<Ident>, ParserError> {
13394        fn validator(_explicit: bool, _kw: &Keyword, _parser: &mut Parser) -> bool {
13395            false
13396        }
13397        self.parse_optional_alias_inner(Some(reserved_kwds), validator)
13398    }
13399
13400    /// Parses an optional alias after a SQL element such as a select list item
13401    /// or a table name.
13402    ///
13403    /// This method accepts an optional list of reserved keywords or a function
13404    /// to call to validate if a keyword should be parsed as an alias, to allow
13405    /// callers to customize the parsing logic based on their context.
13406    fn parse_optional_alias_inner<F>(
13407        &mut self,
13408        reserved_kwds: Option<&[Keyword]>,
13409        validator: F,
13410    ) -> Result<Option<Ident>, ParserError>
13411    where
13412        F: Fn(bool, &Keyword, &mut Parser) -> bool,
13413    {
13414        let after_as = self.parse_keyword(Keyword::AS);
13415
13416        let next_token = self.next_token();
13417        match next_token.token {
13418            // Accepts a keyword as an alias if the AS keyword explicitly indicate an alias or if the
13419            // caller provided a list of reserved keywords and the keyword is not on that list.
13420            Token::Word(w)
13421                if reserved_kwds.is_some()
13422                    && (after_as || reserved_kwds.is_some_and(|x| !x.contains(&w.keyword))) =>
13423            {
13424                Ok(Some(w.into_ident(next_token.span)))
13425            }
13426            // Accepts a keyword as alias based on the caller's context, such as to what SQL element
13427            // this word is a potential alias of using the validator call-back. This allows for
13428            // dialect-specific logic.
13429            Token::Word(w) if validator(after_as, &w.keyword, self) => {
13430                Ok(Some(w.into_ident(next_token.span)))
13431            }
13432            // For backwards-compatibility, we accept quoted strings as aliases regardless of the context.
13433            Token::SingleQuotedString(s) => Ok(Some(Ident::with_quote('\'', s))),
13434            Token::DoubleQuotedString(s) => Ok(Some(Ident::with_quote('\"', s))),
13435            _ => {
13436                if after_as {
13437                    return self.expected("an identifier after AS", next_token);
13438                }
13439                self.prev_token();
13440                Ok(None) // no alias found
13441            }
13442        }
13443    }
13444
13445    /// Parse an optional `GROUP BY` clause, returning `Some(GroupByExpr)` when present.
13446    pub fn parse_optional_group_by(&mut self) -> Result<Option<GroupByExpr>, ParserError> {
13447        if self.parse_keywords(&[Keyword::GROUP, Keyword::BY]) {
13448            let expressions = if self.parse_keyword(Keyword::ALL) {
13449                None
13450            } else {
13451                Some(self.parse_comma_separated(Parser::parse_group_by_expr)?)
13452            };
13453
13454            let mut modifiers = vec![];
13455            if self.dialect.supports_group_by_with_modifier() {
13456                loop {
13457                    if !self.parse_keyword(Keyword::WITH) {
13458                        break;
13459                    }
13460                    let keyword = self.expect_one_of_keywords(&[
13461                        Keyword::ROLLUP,
13462                        Keyword::CUBE,
13463                        Keyword::TOTALS,
13464                    ])?;
13465                    modifiers.push(match keyword {
13466                        Keyword::ROLLUP => GroupByWithModifier::Rollup,
13467                        Keyword::CUBE => GroupByWithModifier::Cube,
13468                        Keyword::TOTALS => GroupByWithModifier::Totals,
13469                        _ => {
13470                            return parser_err!(
13471                                "BUG: expected to match GroupBy modifier keyword",
13472                                self.peek_token_ref().span.start
13473                            )
13474                        }
13475                    });
13476                }
13477            }
13478            if self.parse_keywords(&[Keyword::GROUPING, Keyword::SETS]) {
13479                self.expect_token(&Token::LParen)?;
13480                let result = self.parse_comma_separated(|p| {
13481                    if p.peek_token_ref().token == Token::LParen {
13482                        p.parse_tuple(true, true)
13483                    } else {
13484                        Ok(vec![p.parse_expr()?])
13485                    }
13486                })?;
13487                self.expect_token(&Token::RParen)?;
13488                modifiers.push(GroupByWithModifier::GroupingSets(Expr::GroupingSets(
13489                    result,
13490                )));
13491            };
13492            let group_by = match expressions {
13493                None => GroupByExpr::All(modifiers),
13494                Some(exprs) => GroupByExpr::Expressions(exprs, modifiers),
13495            };
13496            Ok(Some(group_by))
13497        } else {
13498            Ok(None)
13499        }
13500    }
13501
13502    /// Parse an optional `ORDER BY` clause, returning `Some(OrderBy)` when present.
13503    pub fn parse_optional_order_by(&mut self) -> Result<Option<OrderBy>, ParserError> {
13504        if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
13505            let order_by =
13506                if self.dialect.supports_order_by_all() && self.parse_keyword(Keyword::ALL) {
13507                    let order_by_options = self.parse_order_by_options()?;
13508                    OrderBy {
13509                        kind: OrderByKind::All(order_by_options),
13510                        interpolate: None,
13511                    }
13512                } else {
13513                    let exprs = self.parse_comma_separated(Parser::parse_order_by_expr)?;
13514                    let interpolate = if self.dialect.supports_interpolate() {
13515                        self.parse_interpolations()?
13516                    } else {
13517                        None
13518                    };
13519                    OrderBy {
13520                        kind: OrderByKind::Expressions(exprs),
13521                        interpolate,
13522                    }
13523                };
13524            Ok(Some(order_by))
13525        } else {
13526            Ok(None)
13527        }
13528    }
13529
13530    fn parse_optional_limit_clause(&mut self) -> Result<Option<LimitClause>, ParserError> {
13531        let mut offset = if self.parse_keyword(Keyword::OFFSET) {
13532            Some(self.parse_offset()?)
13533        } else {
13534            None
13535        };
13536
13537        let (limit, limit_by) = if self.parse_keyword(Keyword::LIMIT) {
13538            let expr = self.parse_limit()?;
13539
13540            if self.dialect.supports_limit_comma()
13541                && offset.is_none()
13542                && expr.is_some() // ALL not supported with comma
13543                && self.consume_token(&Token::Comma)
13544            {
13545                let offset = expr.ok_or_else(|| {
13546                    ParserError::ParserError(
13547                        "Missing offset for LIMIT <offset>, <limit>".to_string(),
13548                    )
13549                })?;
13550                return Ok(Some(LimitClause::OffsetCommaLimit {
13551                    offset,
13552                    limit: self.parse_expr()?,
13553                }));
13554            }
13555
13556            let limit_by = if self.dialect.supports_limit_by() && self.parse_keyword(Keyword::BY) {
13557                Some(self.parse_comma_separated(Parser::parse_expr)?)
13558            } else {
13559                None
13560            };
13561
13562            (Some(expr), limit_by)
13563        } else {
13564            (None, None)
13565        };
13566
13567        if offset.is_none() && limit.is_some() && self.parse_keyword(Keyword::OFFSET) {
13568            offset = Some(self.parse_offset()?);
13569        }
13570
13571        if offset.is_some() || (limit.is_some() && limit != Some(None)) || limit_by.is_some() {
13572            Ok(Some(LimitClause::LimitOffset {
13573                limit: limit.unwrap_or_default(),
13574                offset,
13575                limit_by: limit_by.unwrap_or_default(),
13576            }))
13577        } else {
13578            Ok(None)
13579        }
13580    }
13581
13582    /// Parse a table object for insertion
13583    /// e.g. `some_database.some_table` or `FUNCTION some_table_func(...)`
13584    pub fn parse_table_object(&mut self) -> Result<TableObject, ParserError> {
13585        if self.dialect.supports_insert_table_function() && self.parse_keyword(Keyword::FUNCTION) {
13586            let fn_name = self.parse_object_name(false)?;
13587            self.parse_function_call(fn_name)
13588                .map(TableObject::TableFunction)
13589        } else if self.dialect.supports_insert_table_query() && self.peek_subquery_or_cte_start() {
13590            self.parse_parenthesized(|p| p.parse_query())
13591                .map(TableObject::TableQuery)
13592        } else {
13593            self.parse_object_name(false).map(TableObject::TableName)
13594        }
13595    }
13596
13597    /// Parse a possibly qualified, possibly quoted identifier, e.g.
13598    /// `foo` or `myschema."table"
13599    ///
13600    /// The `in_table_clause` parameter indicates whether the object name is a table in a FROM, JOIN,
13601    /// or similar table clause. Currently, this is used only to support unquoted hyphenated identifiers
13602    /// in this context on BigQuery.
13603    pub fn parse_object_name(&mut self, in_table_clause: bool) -> Result<ObjectName, ParserError> {
13604        self.parse_object_name_inner(in_table_clause, false)
13605    }
13606
13607    /// Parse a possibly qualified, possibly quoted identifier, e.g.
13608    /// `foo` or `myschema."table"
13609    ///
13610    /// The `in_table_clause` parameter indicates whether the object name is a table in a FROM, JOIN,
13611    /// or similar table clause. Currently, this is used only to support unquoted hyphenated identifiers
13612    /// in this context on BigQuery.
13613    ///
13614    /// The `allow_wildcards` parameter indicates whether to allow for wildcards in the object name
13615    /// e.g. *, *.*, `foo`.*, or "foo"."bar"
13616    fn parse_object_name_inner(
13617        &mut self,
13618        in_table_clause: bool,
13619        allow_wildcards: bool,
13620    ) -> Result<ObjectName, ParserError> {
13621        let mut parts = vec![];
13622        if dialect_of!(self is BigQueryDialect) && in_table_clause {
13623            loop {
13624                let (ident, end_with_period) = self.parse_unquoted_hyphenated_identifier()?;
13625                parts.push(ObjectNamePart::Identifier(ident));
13626                if !self.consume_token(&Token::Period) && !end_with_period {
13627                    break;
13628                }
13629            }
13630        } else {
13631            loop {
13632                if allow_wildcards && self.peek_token_ref().token == Token::Mul {
13633                    let span = self.next_token().span;
13634                    parts.push(ObjectNamePart::Identifier(Ident {
13635                        value: Token::Mul.to_string(),
13636                        quote_style: None,
13637                        span,
13638                    }));
13639                } else if dialect_of!(self is BigQueryDialect) && in_table_clause {
13640                    let (ident, end_with_period) = self.parse_unquoted_hyphenated_identifier()?;
13641                    parts.push(ObjectNamePart::Identifier(ident));
13642                    if !self.consume_token(&Token::Period) && !end_with_period {
13643                        break;
13644                    }
13645                } else if self.dialect.supports_object_name_double_dot_notation()
13646                    && parts.len() == 1
13647                    && matches!(self.peek_token_ref().token, Token::Period)
13648                {
13649                    // Empty string here means default schema
13650                    parts.push(ObjectNamePart::Identifier(Ident::new("")));
13651                } else {
13652                    let ident = self.parse_identifier()?;
13653                    let part = if self
13654                        .dialect
13655                        .is_identifier_generating_function_name(&ident, &parts)
13656                    {
13657                        self.expect_token(&Token::LParen)?;
13658                        let args: Vec<FunctionArg> =
13659                            self.parse_comma_separated0(Self::parse_function_args, Token::RParen)?;
13660                        self.expect_token(&Token::RParen)?;
13661                        ObjectNamePart::Function(ObjectNamePartFunction { name: ident, args })
13662                    } else {
13663                        ObjectNamePart::Identifier(ident)
13664                    };
13665                    parts.push(part);
13666                }
13667
13668                if !self.consume_token(&Token::Period) {
13669                    break;
13670                }
13671            }
13672        }
13673
13674        // BigQuery accepts any number of quoted identifiers of a table name.
13675        // https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#quoted_identifiers
13676        if dialect_of!(self is BigQueryDialect)
13677            && parts.iter().any(|part| {
13678                part.as_ident()
13679                    .is_some_and(|ident| ident.value.contains('.'))
13680            })
13681        {
13682            parts = parts
13683                .into_iter()
13684                .flat_map(|part| match part.as_ident() {
13685                    Some(ident) => ident
13686                        .value
13687                        .split('.')
13688                        .map(|value| {
13689                            ObjectNamePart::Identifier(Ident {
13690                                value: value.into(),
13691                                quote_style: ident.quote_style,
13692                                span: ident.span,
13693                            })
13694                        })
13695                        .collect::<Vec<_>>(),
13696                    None => vec![part],
13697                })
13698                .collect()
13699        }
13700
13701        Ok(ObjectName(parts))
13702    }
13703
13704    /// Parse identifiers
13705    pub fn parse_identifiers(&mut self) -> Result<Vec<Ident>, ParserError> {
13706        let mut idents = vec![];
13707        loop {
13708            let token = self.peek_token_ref();
13709            match &token.token {
13710                Token::Word(w) => {
13711                    idents.push(w.to_ident(token.span));
13712                }
13713                Token::EOF | Token::Eq | Token::SemiColon | Token::VerticalBarRightAngleBracket => {
13714                    break
13715                }
13716                _ => {}
13717            }
13718            self.advance_token();
13719        }
13720        Ok(idents)
13721    }
13722
13723    /// Parse identifiers of form ident1[.identN]*
13724    ///
13725    /// Similar in functionality to [parse_identifiers], with difference
13726    /// being this function is much more strict about parsing a valid multipart identifier, not
13727    /// allowing extraneous tokens to be parsed, otherwise it fails.
13728    ///
13729    /// For example:
13730    ///
13731    /// ```rust
13732    /// use sqlparser::ast::Ident;
13733    /// use sqlparser::dialect::GenericDialect;
13734    /// use sqlparser::parser::Parser;
13735    ///
13736    /// let dialect = GenericDialect {};
13737    /// let expected = vec![Ident::new("one"), Ident::new("two")];
13738    ///
13739    /// // expected usage
13740    /// let sql = "one.two";
13741    /// let mut parser = Parser::new(&dialect).try_with_sql(sql).unwrap();
13742    /// let actual = parser.parse_multipart_identifier().unwrap();
13743    /// assert_eq!(&actual, &expected);
13744    ///
13745    /// // parse_identifiers is more loose on what it allows, parsing successfully
13746    /// let sql = "one + two";
13747    /// let mut parser = Parser::new(&dialect).try_with_sql(sql).unwrap();
13748    /// let actual = parser.parse_identifiers().unwrap();
13749    /// assert_eq!(&actual, &expected);
13750    ///
13751    /// // expected to strictly fail due to + separator
13752    /// let sql = "one + two";
13753    /// let mut parser = Parser::new(&dialect).try_with_sql(sql).unwrap();
13754    /// let actual = parser.parse_multipart_identifier().unwrap_err();
13755    /// assert_eq!(
13756    ///     actual.to_string(),
13757    ///     "sql parser error: Unexpected token in identifier: +"
13758    /// );
13759    /// ```
13760    ///
13761    /// [parse_identifiers]: Parser::parse_identifiers
13762    pub fn parse_multipart_identifier(&mut self) -> Result<Vec<Ident>, ParserError> {
13763        let mut idents = vec![];
13764
13765        // expecting at least one word for identifier
13766        let next_token = self.next_token();
13767        match next_token.token {
13768            Token::Word(w) => idents.push(w.into_ident(next_token.span)),
13769            Token::EOF => {
13770                return Err(ParserError::ParserError(
13771                    "Empty input when parsing identifier".to_string(),
13772                ))?
13773            }
13774            token => {
13775                return Err(ParserError::ParserError(format!(
13776                    "Unexpected token in identifier: {token}"
13777                )))?
13778            }
13779        };
13780
13781        // parse optional next parts if exist
13782        loop {
13783            match self.next_token().token {
13784                // ensure that optional period is succeeded by another identifier
13785                Token::Period => {
13786                    let next_token = self.next_token();
13787                    match next_token.token {
13788                        Token::Word(w) => idents.push(w.into_ident(next_token.span)),
13789                        Token::EOF => {
13790                            return Err(ParserError::ParserError(
13791                                "Trailing period in identifier".to_string(),
13792                            ))?
13793                        }
13794                        token => {
13795                            return Err(ParserError::ParserError(format!(
13796                                "Unexpected token following period in identifier: {token}"
13797                            )))?
13798                        }
13799                    }
13800                }
13801                Token::EOF => break,
13802                token => {
13803                    return Err(ParserError::ParserError(format!(
13804                        "Unexpected token in identifier: {token}"
13805                    )))?;
13806                }
13807            }
13808        }
13809
13810        Ok(idents)
13811    }
13812
13813    /// Parse a simple one-word identifier (possibly quoted, possibly a keyword)
13814    pub fn parse_identifier(&mut self) -> Result<Ident, ParserError> {
13815        let next_token = self.next_token();
13816        match next_token.token {
13817            Token::Word(w) => Ok(w.into_ident(next_token.span)),
13818            Token::SingleQuotedString(s) => Ok(Ident::with_quote('\'', s)),
13819            Token::DoubleQuotedString(s) => Ok(Ident::with_quote('\"', s)),
13820            _ => self.expected("identifier", next_token),
13821        }
13822    }
13823
13824    /// On BigQuery, hyphens are permitted in unquoted identifiers inside of a FROM or
13825    /// TABLE clause.
13826    ///
13827    /// The first segment must be an ordinary unquoted identifier, e.g. it must not start
13828    /// with a digit. Subsequent segments are either must either be valid identifiers or
13829    /// integers, e.g. foo-123 is allowed, but foo-123a is not.
13830    ///
13831    /// [BigQuery-lexical](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical)
13832    ///
13833    /// Return a tuple of the identifier and a boolean indicating it ends with a period.
13834    fn parse_unquoted_hyphenated_identifier(&mut self) -> Result<(Ident, bool), ParserError> {
13835        match self.peek_token().token {
13836            Token::Word(w) => {
13837                let quote_style_is_none = w.quote_style.is_none();
13838                let mut requires_whitespace = false;
13839                let mut ident = w.into_ident(self.next_token().span);
13840                if quote_style_is_none {
13841                    while matches!(self.peek_token_no_skip().token, Token::Minus) {
13842                        self.next_token();
13843                        ident.value.push('-');
13844
13845                        let token = self
13846                            .next_token_no_skip()
13847                            .cloned()
13848                            .unwrap_or(TokenWithSpan::wrap(Token::EOF));
13849                        requires_whitespace = match token.token {
13850                            Token::Word(next_word) if next_word.quote_style.is_none() => {
13851                                ident.value.push_str(&next_word.value);
13852                                false
13853                            }
13854                            Token::Number(s, false) => {
13855                                // A number token can represent a decimal value ending with a period, e.g., `Number('123.')`.
13856                                // However, for an [ObjectName], it is part of a hyphenated identifier, e.g., `foo-123.bar`.
13857                                //
13858                                // If a number token is followed by a period, it is part of an [ObjectName].
13859                                // Return the identifier with `true` if the number token is followed by a period, indicating that
13860                                // parsing should continue for the next part of the hyphenated identifier.
13861                                if s.ends_with('.') {
13862                                    let Some(s) = s.split('.').next().filter(|s| {
13863                                        !s.is_empty() && s.chars().all(|c| c.is_ascii_digit())
13864                                    }) else {
13865                                        return self.expected(
13866                                            "continuation of hyphenated identifier",
13867                                            TokenWithSpan::new(Token::Number(s, false), token.span),
13868                                        );
13869                                    };
13870                                    ident.value.push_str(s);
13871                                    return Ok((ident, true));
13872                                } else {
13873                                    ident.value.push_str(&s);
13874                                }
13875                                // If next token is period, then it is part of an ObjectName and we don't expect whitespace
13876                                // after the number.
13877                                !matches!(self.peek_token_ref().token, Token::Period)
13878                            }
13879                            _ => {
13880                                return self
13881                                    .expected("continuation of hyphenated identifier", token);
13882                            }
13883                        }
13884                    }
13885
13886                    // If the last segment was a number, we must check that it's followed by whitespace,
13887                    // otherwise foo-123a will be parsed as `foo-123` with the alias `a`.
13888                    if requires_whitespace {
13889                        let token = self.next_token();
13890                        if !matches!(token.token, Token::EOF | Token::Whitespace(_)) {
13891                            return self
13892                                .expected("whitespace following hyphenated identifier", token);
13893                        }
13894                    }
13895                }
13896                Ok((ident, false))
13897            }
13898            _ => Ok((self.parse_identifier()?, false)),
13899        }
13900    }
13901
13902    /// Parses a parenthesized, comma-separated list of column definitions within a view.
13903    fn parse_view_columns(&mut self) -> Result<Vec<ViewColumnDef>, ParserError> {
13904        if self.consume_token(&Token::LParen) {
13905            if self.peek_token_ref().token == Token::RParen {
13906                self.next_token();
13907                Ok(vec![])
13908            } else {
13909                let cols = self.parse_comma_separated_with_trailing_commas(
13910                    Parser::parse_view_column,
13911                    self.dialect.supports_column_definition_trailing_commas(),
13912                    Self::is_reserved_for_column_alias,
13913                )?;
13914                self.expect_token(&Token::RParen)?;
13915                Ok(cols)
13916            }
13917        } else {
13918            Ok(vec![])
13919        }
13920    }
13921
13922    /// Parses a column definition within a view.
13923    fn parse_view_column(&mut self) -> Result<ViewColumnDef, ParserError> {
13924        let name = self.parse_identifier()?;
13925        let options = self.parse_view_column_options()?;
13926        let data_type = if dialect_of!(self is ClickHouseDialect) {
13927            Some(self.parse_data_type()?)
13928        } else {
13929            None
13930        };
13931        Ok(ViewColumnDef {
13932            name,
13933            data_type,
13934            options,
13935        })
13936    }
13937
13938    fn parse_view_column_options(&mut self) -> Result<Option<ColumnOptions>, ParserError> {
13939        let mut options = Vec::new();
13940        loop {
13941            let option = self.parse_optional_column_option()?;
13942            if let Some(option) = option {
13943                options.push(option);
13944            } else {
13945                break;
13946            }
13947        }
13948        if options.is_empty() {
13949            Ok(None)
13950        } else if self.dialect.supports_space_separated_column_options() {
13951            Ok(Some(ColumnOptions::SpaceSeparated(options)))
13952        } else {
13953            Ok(Some(ColumnOptions::CommaSeparated(options)))
13954        }
13955    }
13956
13957    /// Parses a parenthesized comma-separated list of unqualified, possibly quoted identifiers.
13958    /// For example: `(col1, "col 2", ...)`
13959    pub fn parse_parenthesized_column_list(
13960        &mut self,
13961        optional: IsOptional,
13962        allow_empty: bool,
13963    ) -> Result<Vec<Ident>, ParserError> {
13964        self.parse_parenthesized_column_list_inner(optional, allow_empty, |p| p.parse_identifier())
13965    }
13966
13967    /// Parse a parenthesized list of compound identifiers as expressions.
13968    pub fn parse_parenthesized_compound_identifier_list(
13969        &mut self,
13970        optional: IsOptional,
13971        allow_empty: bool,
13972    ) -> Result<Vec<Expr>, ParserError> {
13973        self.parse_parenthesized_column_list_inner(optional, allow_empty, |p| {
13974            Ok(Expr::CompoundIdentifier(
13975                p.parse_period_separated(|p| p.parse_identifier())?,
13976            ))
13977        })
13978    }
13979
13980    /// Parses a parenthesized comma-separated list of index columns, which can be arbitrary
13981    /// expressions with ordering information (and an opclass in some dialects).
13982    fn parse_parenthesized_index_column_list(&mut self) -> Result<Vec<IndexColumn>, ParserError> {
13983        self.parse_parenthesized_column_list_inner(Mandatory, false, |p| {
13984            p.parse_create_index_expr()
13985        })
13986    }
13987
13988    /// Parses a parenthesized comma-separated list of qualified, possibly quoted identifiers.
13989    /// For example: `(db1.sc1.tbl1.col1, db1.sc1.tbl1."col 2", ...)`
13990    pub fn parse_parenthesized_qualified_column_list(
13991        &mut self,
13992        optional: IsOptional,
13993        allow_empty: bool,
13994    ) -> Result<Vec<ObjectName>, ParserError> {
13995        self.parse_parenthesized_column_list_inner(optional, allow_empty, |p| {
13996            p.parse_object_name(true)
13997        })
13998    }
13999
14000    /// Parses a parenthesized comma-separated list of columns using
14001    /// the provided function to parse each element.
14002    fn parse_parenthesized_column_list_inner<F, T>(
14003        &mut self,
14004        optional: IsOptional,
14005        allow_empty: bool,
14006        mut f: F,
14007    ) -> Result<Vec<T>, ParserError>
14008    where
14009        F: FnMut(&mut Parser) -> Result<T, ParserError>,
14010    {
14011        if self.consume_token(&Token::LParen) {
14012            if allow_empty && self.peek_token_ref().token == Token::RParen {
14013                self.next_token();
14014                Ok(vec![])
14015            } else {
14016                let cols = self.parse_comma_separated(|p| f(p))?;
14017                self.expect_token(&Token::RParen)?;
14018                Ok(cols)
14019            }
14020        } else if optional == Optional {
14021            Ok(vec![])
14022        } else {
14023            self.expected_ref("a list of columns in parentheses", self.peek_token_ref())
14024        }
14025    }
14026
14027    /// Parses a parenthesized comma-separated list of table alias column definitions.
14028    fn parse_table_alias_column_defs(&mut self) -> Result<Vec<TableAliasColumnDef>, ParserError> {
14029        if self.consume_token(&Token::LParen) {
14030            let cols = self.parse_comma_separated(|p| {
14031                let name = p.parse_identifier()?;
14032                let data_type = p.maybe_parse(|p| p.parse_data_type())?;
14033                Ok(TableAliasColumnDef { name, data_type })
14034            })?;
14035            self.expect_token(&Token::RParen)?;
14036            Ok(cols)
14037        } else {
14038            Ok(vec![])
14039        }
14040    }
14041
14042    /// Parse an unsigned precision value enclosed in parentheses, e.g. `(10)`.
14043    pub fn parse_precision(&mut self) -> Result<u64, ParserError> {
14044        self.expect_token(&Token::LParen)?;
14045        let n = self.parse_literal_uint()?;
14046        self.expect_token(&Token::RParen)?;
14047        Ok(n)
14048    }
14049
14050    /// Parse an optional precision `(n)` and return it as `Some(n)` when present.
14051    pub fn parse_optional_precision(&mut self) -> Result<Option<u64>, ParserError> {
14052        if self.consume_token(&Token::LParen) {
14053            let n = self.parse_literal_uint()?;
14054            self.expect_token(&Token::RParen)?;
14055            Ok(Some(n))
14056        } else {
14057            Ok(None)
14058        }
14059    }
14060
14061    fn maybe_parse_optional_interval_fields(
14062        &mut self,
14063    ) -> Result<Option<IntervalFields>, ParserError> {
14064        match self.parse_one_of_keywords(&[
14065            // Can be followed by `TO` option
14066            Keyword::YEAR,
14067            Keyword::DAY,
14068            Keyword::HOUR,
14069            Keyword::MINUTE,
14070            // No `TO` option
14071            Keyword::MONTH,
14072            Keyword::SECOND,
14073        ]) {
14074            Some(Keyword::YEAR) => {
14075                if self.peek_keyword(Keyword::TO) {
14076                    self.expect_keyword(Keyword::TO)?;
14077                    self.expect_keyword(Keyword::MONTH)?;
14078                    Ok(Some(IntervalFields::YearToMonth))
14079                } else {
14080                    Ok(Some(IntervalFields::Year))
14081                }
14082            }
14083            Some(Keyword::DAY) => {
14084                if self.peek_keyword(Keyword::TO) {
14085                    self.expect_keyword(Keyword::TO)?;
14086                    match self.expect_one_of_keywords(&[
14087                        Keyword::HOUR,
14088                        Keyword::MINUTE,
14089                        Keyword::SECOND,
14090                    ])? {
14091                        Keyword::HOUR => Ok(Some(IntervalFields::DayToHour)),
14092                        Keyword::MINUTE => Ok(Some(IntervalFields::DayToMinute)),
14093                        Keyword::SECOND => Ok(Some(IntervalFields::DayToSecond)),
14094                        _ => {
14095                            self.prev_token();
14096                            self.expected_ref("HOUR, MINUTE, or SECOND", self.peek_token_ref())
14097                        }
14098                    }
14099                } else {
14100                    Ok(Some(IntervalFields::Day))
14101                }
14102            }
14103            Some(Keyword::HOUR) => {
14104                if self.peek_keyword(Keyword::TO) {
14105                    self.expect_keyword(Keyword::TO)?;
14106                    match self.expect_one_of_keywords(&[Keyword::MINUTE, Keyword::SECOND])? {
14107                        Keyword::MINUTE => Ok(Some(IntervalFields::HourToMinute)),
14108                        Keyword::SECOND => Ok(Some(IntervalFields::HourToSecond)),
14109                        _ => {
14110                            self.prev_token();
14111                            self.expected_ref("MINUTE or SECOND", self.peek_token_ref())
14112                        }
14113                    }
14114                } else {
14115                    Ok(Some(IntervalFields::Hour))
14116                }
14117            }
14118            Some(Keyword::MINUTE) => {
14119                if self.peek_keyword(Keyword::TO) {
14120                    self.expect_keyword(Keyword::TO)?;
14121                    self.expect_keyword(Keyword::SECOND)?;
14122                    Ok(Some(IntervalFields::MinuteToSecond))
14123                } else {
14124                    Ok(Some(IntervalFields::Minute))
14125                }
14126            }
14127            Some(Keyword::MONTH) => Ok(Some(IntervalFields::Month)),
14128            Some(Keyword::SECOND) => Ok(Some(IntervalFields::Second)),
14129            Some(_) => {
14130                self.prev_token();
14131                self.expected_ref(
14132                    "YEAR, MONTH, DAY, HOUR, MINUTE, or SECOND",
14133                    self.peek_token_ref(),
14134                )
14135            }
14136            None => Ok(None),
14137        }
14138    }
14139
14140    /// Parse datetime64 [1]
14141    /// Syntax
14142    /// ```sql
14143    /// DateTime64(precision[, timezone])
14144    /// ```
14145    ///
14146    /// [1]: https://clickhouse.com/docs/en/sql-reference/data-types/datetime64
14147    pub fn parse_datetime_64(&mut self) -> Result<(u64, Option<String>), ParserError> {
14148        self.expect_keyword_is(Keyword::DATETIME64)?;
14149        self.expect_token(&Token::LParen)?;
14150        let precision = self.parse_literal_uint()?;
14151        let time_zone = if self.consume_token(&Token::Comma) {
14152            Some(self.parse_literal_string()?)
14153        } else {
14154            None
14155        };
14156        self.expect_token(&Token::RParen)?;
14157        Ok((precision, time_zone))
14158    }
14159
14160    /// Parse an optional character length specification `(n | MAX [CHARACTERS|OCTETS])`.
14161    pub fn parse_optional_character_length(
14162        &mut self,
14163    ) -> Result<Option<CharacterLength>, ParserError> {
14164        if self.consume_token(&Token::LParen) {
14165            let character_length = self.parse_character_length()?;
14166            self.expect_token(&Token::RParen)?;
14167            Ok(Some(character_length))
14168        } else {
14169            Ok(None)
14170        }
14171    }
14172
14173    /// Parse an optional binary length specification like `(n)`.
14174    pub fn parse_optional_binary_length(&mut self) -> Result<Option<BinaryLength>, ParserError> {
14175        if self.consume_token(&Token::LParen) {
14176            let binary_length = self.parse_binary_length()?;
14177            self.expect_token(&Token::RParen)?;
14178            Ok(Some(binary_length))
14179        } else {
14180            Ok(None)
14181        }
14182    }
14183
14184    /// Parse a character length, handling `MAX` or integer lengths with optional units.
14185    pub fn parse_character_length(&mut self) -> Result<CharacterLength, ParserError> {
14186        if self.parse_keyword(Keyword::MAX) {
14187            return Ok(CharacterLength::Max);
14188        }
14189        let length = self.parse_literal_uint()?;
14190        let unit = if self.parse_keyword(Keyword::CHARACTERS) {
14191            Some(CharLengthUnits::Characters)
14192        } else if self.parse_keyword(Keyword::OCTETS) {
14193            Some(CharLengthUnits::Octets)
14194        } else {
14195            None
14196        };
14197        Ok(CharacterLength::IntegerLength { length, unit })
14198    }
14199
14200    /// Parse a binary length specification, returning `BinaryLength`.
14201    pub fn parse_binary_length(&mut self) -> Result<BinaryLength, ParserError> {
14202        if self.parse_keyword(Keyword::MAX) {
14203            return Ok(BinaryLength::Max);
14204        }
14205        let length = self.parse_literal_uint()?;
14206        Ok(BinaryLength::IntegerLength { length })
14207    }
14208
14209    /// Parse an optional `(precision[, scale])` and return `(Option<precision>, Option<scale>)`.
14210    pub fn parse_optional_precision_scale(
14211        &mut self,
14212    ) -> Result<(Option<u64>, Option<u64>), ParserError> {
14213        if self.consume_token(&Token::LParen) {
14214            let n = self.parse_literal_uint()?;
14215            let scale = if self.consume_token(&Token::Comma) {
14216                Some(self.parse_literal_uint()?)
14217            } else {
14218                None
14219            };
14220            self.expect_token(&Token::RParen)?;
14221            Ok((Some(n), scale))
14222        } else {
14223            Ok((None, None))
14224        }
14225    }
14226
14227    /// Parse exact-number precision/scale info like `(precision[, scale])` for decimal types.
14228    pub fn parse_exact_number_optional_precision_scale(
14229        &mut self,
14230    ) -> Result<ExactNumberInfo, ParserError> {
14231        if self.consume_token(&Token::LParen) {
14232            let precision = self.parse_literal_uint()?;
14233            let scale = if self.consume_token(&Token::Comma) {
14234                Some(self.parse_signed_integer()?)
14235            } else {
14236                None
14237            };
14238
14239            self.expect_token(&Token::RParen)?;
14240
14241            match scale {
14242                None => Ok(ExactNumberInfo::Precision(precision)),
14243                Some(scale) => Ok(ExactNumberInfo::PrecisionAndScale(precision, scale)),
14244            }
14245        } else {
14246            Ok(ExactNumberInfo::None)
14247        }
14248    }
14249
14250    /// Parse an optionally signed integer literal.
14251    fn parse_signed_integer(&mut self) -> Result<i64, ParserError> {
14252        let is_negative = self.consume_token(&Token::Minus);
14253
14254        if !is_negative {
14255            let _ = self.consume_token(&Token::Plus);
14256        }
14257
14258        let current_token = self.peek_token_ref();
14259        match &current_token.token {
14260            Token::Number(s, _) => {
14261                let s = s.clone();
14262                let span_start = current_token.span.start;
14263                self.advance_token();
14264                let value = Self::parse::<i64>(s, span_start)?;
14265                Ok(if is_negative { -value } else { value })
14266            }
14267            _ => self.expected_ref("number", current_token),
14268        }
14269    }
14270
14271    /// Parse optional type modifiers appearing in parentheses e.g. `(UNSIGNED, ZEROFILL)`.
14272    pub fn parse_optional_type_modifiers(&mut self) -> Result<Option<Vec<String>>, ParserError> {
14273        if self.consume_token(&Token::LParen) {
14274            let mut modifiers = Vec::new();
14275            loop {
14276                let next_token = self.next_token();
14277                match next_token.token {
14278                    Token::Word(w) => modifiers.push(w.to_string()),
14279                    Token::Number(n, _) => modifiers.push(n),
14280                    Token::SingleQuotedString(s) => modifiers.push(s),
14281
14282                    Token::Comma => {
14283                        continue;
14284                    }
14285                    Token::RParen => {
14286                        break;
14287                    }
14288                    _ => self.expected("type modifiers", next_token)?,
14289                }
14290            }
14291
14292            Ok(Some(modifiers))
14293        } else {
14294            Ok(None)
14295        }
14296    }
14297
14298    /// Parse a parenthesized sub data type
14299    fn parse_sub_type<F>(&mut self, parent_type: F) -> Result<DataType, ParserError>
14300    where
14301        F: FnOnce(Box<DataType>) -> DataType,
14302    {
14303        self.expect_token(&Token::LParen)?;
14304        let inside_type = self.parse_data_type()?;
14305        self.expect_token(&Token::RParen)?;
14306        Ok(parent_type(inside_type.into()))
14307    }
14308
14309    /// Parse a DELETE statement, returning a `Box`ed SetExpr
14310    ///
14311    /// This is used to reduce the size of the stack frames in debug builds
14312    fn parse_delete_setexpr_boxed(
14313        &mut self,
14314        delete_token: TokenWithSpan,
14315    ) -> Result<Box<SetExpr>, ParserError> {
14316        Ok(Box::new(SetExpr::Delete(self.parse_delete(delete_token)?)))
14317    }
14318
14319    /// Parse a `DELETE` statement and return `Statement::Delete`.
14320    pub fn parse_delete(&mut self, delete_token: TokenWithSpan) -> Result<Statement, ParserError> {
14321        let optimizer_hints = self.maybe_parse_optimizer_hints()?;
14322        let (tables, with_from_keyword) = if !self.parse_keyword(Keyword::FROM) {
14323            // `FROM` keyword is optional in BigQuery SQL.
14324            // https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#delete_statement
14325            if dialect_of!(self is BigQueryDialect | OracleDialect | GenericDialect) {
14326                (vec![], false)
14327            } else {
14328                let tables = self.parse_comma_separated(|p| p.parse_object_name(false))?;
14329                self.expect_keyword_is(Keyword::FROM)?;
14330                (tables, true)
14331            }
14332        } else {
14333            (vec![], true)
14334        };
14335
14336        let from = self.parse_comma_separated(Parser::parse_table_and_joins)?;
14337
14338        let output = self.maybe_parse_output_clause()?;
14339
14340        let using = if self.parse_keyword(Keyword::USING) {
14341            Some(self.parse_comma_separated(Parser::parse_table_and_joins)?)
14342        } else {
14343            None
14344        };
14345        let selection = if self.parse_keyword(Keyword::WHERE) {
14346            Some(self.parse_expr()?)
14347        } else {
14348            None
14349        };
14350        let returning = if self.parse_keyword(Keyword::RETURNING) {
14351            Some(self.parse_comma_separated(Parser::parse_select_item)?)
14352        } else {
14353            None
14354        };
14355        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
14356            self.parse_comma_separated(Parser::parse_order_by_expr)?
14357        } else {
14358            vec![]
14359        };
14360        let limit = if self.parse_keyword(Keyword::LIMIT) {
14361            self.parse_limit()?
14362        } else {
14363            None
14364        };
14365
14366        Ok(Statement::Delete(Delete {
14367            delete_token: delete_token.into(),
14368            optimizer_hints,
14369            tables,
14370            from: if with_from_keyword {
14371                FromTable::WithFromKeyword(from)
14372            } else {
14373                FromTable::WithoutKeyword(from)
14374            },
14375            using,
14376            selection,
14377            returning,
14378            output,
14379            order_by,
14380            limit,
14381        }))
14382    }
14383
14384    /// Parse a `KILL` statement, optionally specifying `CONNECTION`, `QUERY`, or `MUTATION`.
14385    /// KILL [CONNECTION | QUERY | MUTATION] processlist_id
14386    pub fn parse_kill(&mut self) -> Result<Statement, ParserError> {
14387        let modifier_keyword =
14388            self.parse_one_of_keywords(&[Keyword::CONNECTION, Keyword::QUERY, Keyword::MUTATION]);
14389
14390        let id = self.parse_literal_uint()?;
14391
14392        let modifier = match modifier_keyword {
14393            Some(Keyword::CONNECTION) => Some(KillType::Connection),
14394            Some(Keyword::QUERY) => Some(KillType::Query),
14395            Some(Keyword::MUTATION) => {
14396                if dialect_of!(self is ClickHouseDialect | GenericDialect) {
14397                    Some(KillType::Mutation)
14398                } else {
14399                    self.expected_ref(
14400                        "Unsupported type for KILL, allowed: CONNECTION | QUERY",
14401                        self.peek_token_ref(),
14402                    )?
14403                }
14404            }
14405            _ => None,
14406        };
14407
14408        Ok(Statement::Kill { modifier, id })
14409    }
14410
14411    /// Parse an `EXPLAIN` statement, handling dialect-specific options and modifiers.
14412    pub fn parse_explain(
14413        &mut self,
14414        describe_alias: DescribeAlias,
14415    ) -> Result<Statement, ParserError> {
14416        let mut analyze = false;
14417        let mut verbose = false;
14418        let mut query_plan = false;
14419        let mut estimate = false;
14420        let mut format = None;
14421        let mut options = None;
14422
14423        // Note: DuckDB is compatible with PostgreSQL syntax for this statement,
14424        // although not all features may be implemented.
14425        if describe_alias == DescribeAlias::Explain
14426            && self.dialect.supports_explain_with_utility_options()
14427            && self.peek_token_ref().token == Token::LParen
14428        {
14429            options = Some(self.parse_utility_options()?)
14430        } else if self.parse_keywords(&[Keyword::QUERY, Keyword::PLAN]) {
14431            query_plan = true;
14432        } else if self.parse_keyword(Keyword::ESTIMATE) {
14433            estimate = true;
14434        } else {
14435            analyze = self.parse_keyword(Keyword::ANALYZE);
14436            verbose = self.parse_keyword(Keyword::VERBOSE);
14437            if self.parse_keyword(Keyword::FORMAT) {
14438                format = Some(self.parse_analyze_format_kind()?);
14439            }
14440        }
14441
14442        match self.maybe_parse(|parser| parser.parse_statement())? {
14443            Some(Statement::Explain { .. }) | Some(Statement::ExplainTable { .. }) => Err(
14444                ParserError::ParserError("Explain must be root of the plan".to_string()),
14445            ),
14446            Some(statement) => Ok(Statement::Explain {
14447                describe_alias,
14448                analyze,
14449                verbose,
14450                query_plan,
14451                estimate,
14452                statement: Box::new(statement),
14453                format,
14454                options,
14455            }),
14456            _ => {
14457                let hive_format =
14458                    match self.parse_one_of_keywords(&[Keyword::EXTENDED, Keyword::FORMATTED]) {
14459                        Some(Keyword::EXTENDED) => Some(HiveDescribeFormat::Extended),
14460                        Some(Keyword::FORMATTED) => Some(HiveDescribeFormat::Formatted),
14461                        _ => None,
14462                    };
14463
14464                let has_table_keyword = if self.dialect.describe_requires_table_keyword() {
14465                    // only allow to use TABLE keyword for DESC|DESCRIBE statement
14466                    self.parse_keyword(Keyword::TABLE)
14467                } else {
14468                    false
14469                };
14470
14471                let table_name = self.parse_object_name(false)?;
14472                Ok(Statement::ExplainTable {
14473                    describe_alias,
14474                    hive_format,
14475                    has_table_keyword,
14476                    table_name,
14477                })
14478            }
14479        }
14480    }
14481
14482    /// Parse a query expression, i.e. a `SELECT` statement optionally
14483    /// preceded with some `WITH` CTE declarations and optionally followed
14484    /// by `ORDER BY`. Unlike some other parse_... methods, this one doesn't
14485    /// expect the initial keyword to be already consumed
14486    #[cfg_attr(feature = "recursive-protection", recursive::recursive)]
14487    pub fn parse_query(&mut self) -> Result<Box<Query>, ParserError> {
14488        let _guard = self.recursion_counter.try_decrease()?;
14489        let with = if self.parse_keyword(Keyword::WITH) {
14490            let with_token = self.get_current_token();
14491            Some(With {
14492                with_token: with_token.clone().into(),
14493                recursive: self.parse_keyword(Keyword::RECURSIVE),
14494                cte_tables: self.parse_comma_separated(Parser::parse_cte)?,
14495            })
14496        } else {
14497            None
14498        };
14499        if self.parse_keyword(Keyword::INSERT) {
14500            Ok(Query {
14501                with,
14502                body: self.parse_insert_setexpr_boxed(self.get_current_token().clone())?,
14503                order_by: None,
14504                limit_clause: None,
14505                fetch: None,
14506                locks: vec![],
14507                for_clause: None,
14508                settings: None,
14509                format_clause: None,
14510                pipe_operators: vec![],
14511            }
14512            .into())
14513        } else if self.parse_keyword(Keyword::UPDATE) {
14514            Ok(Query {
14515                with,
14516                body: self.parse_update_setexpr_boxed(self.get_current_token().clone())?,
14517                order_by: None,
14518                limit_clause: None,
14519                fetch: None,
14520                locks: vec![],
14521                for_clause: None,
14522                settings: None,
14523                format_clause: None,
14524                pipe_operators: vec![],
14525            }
14526            .into())
14527        } else if self.parse_keyword(Keyword::DELETE) {
14528            Ok(Query {
14529                with,
14530                body: self.parse_delete_setexpr_boxed(self.get_current_token().clone())?,
14531                limit_clause: None,
14532                order_by: None,
14533                fetch: None,
14534                locks: vec![],
14535                for_clause: None,
14536                settings: None,
14537                format_clause: None,
14538                pipe_operators: vec![],
14539            }
14540            .into())
14541        } else if self.parse_keyword(Keyword::MERGE) {
14542            Ok(Query {
14543                with,
14544                body: self.parse_merge_setexpr_boxed(self.get_current_token().clone())?,
14545                limit_clause: None,
14546                order_by: None,
14547                fetch: None,
14548                locks: vec![],
14549                for_clause: None,
14550                settings: None,
14551                format_clause: None,
14552                pipe_operators: vec![],
14553            }
14554            .into())
14555        } else {
14556            let body = self.parse_query_body(self.dialect.prec_unknown())?;
14557
14558            let order_by = self.parse_optional_order_by()?;
14559
14560            let limit_clause = self.parse_optional_limit_clause()?;
14561
14562            let settings = self.parse_settings()?;
14563
14564            let fetch = if self.parse_keyword(Keyword::FETCH) {
14565                Some(self.parse_fetch()?)
14566            } else {
14567                None
14568            };
14569
14570            let mut for_clause = None;
14571            let mut locks = Vec::new();
14572            while self.parse_keyword(Keyword::FOR) {
14573                if let Some(parsed_for_clause) = self.parse_for_clause()? {
14574                    for_clause = Some(parsed_for_clause);
14575                    break;
14576                } else {
14577                    locks.push(self.parse_lock()?);
14578                }
14579            }
14580            let format_clause =
14581                if self.dialect.supports_select_format() && self.parse_keyword(Keyword::FORMAT) {
14582                    if self.parse_keyword(Keyword::NULL) {
14583                        Some(FormatClause::Null)
14584                    } else {
14585                        let ident = self.parse_identifier()?;
14586                        Some(FormatClause::Identifier(ident))
14587                    }
14588                } else {
14589                    None
14590                };
14591
14592            let pipe_operators = if self.dialect.supports_pipe_operator() {
14593                self.parse_pipe_operators()?
14594            } else {
14595                Vec::new()
14596            };
14597
14598            Ok(Query {
14599                with,
14600                body,
14601                order_by,
14602                limit_clause,
14603                fetch,
14604                locks,
14605                for_clause,
14606                settings,
14607                format_clause,
14608                pipe_operators,
14609            }
14610            .into())
14611        }
14612    }
14613
14614    fn parse_pipe_operators(&mut self) -> Result<Vec<PipeOperator>, ParserError> {
14615        let mut pipe_operators = Vec::new();
14616
14617        while self.consume_token(&Token::VerticalBarRightAngleBracket) {
14618            let kw = self.expect_one_of_keywords(&[
14619                Keyword::SELECT,
14620                Keyword::EXTEND,
14621                Keyword::SET,
14622                Keyword::DROP,
14623                Keyword::AS,
14624                Keyword::WHERE,
14625                Keyword::LIMIT,
14626                Keyword::AGGREGATE,
14627                Keyword::ORDER,
14628                Keyword::TABLESAMPLE,
14629                Keyword::RENAME,
14630                Keyword::UNION,
14631                Keyword::INTERSECT,
14632                Keyword::EXCEPT,
14633                Keyword::CALL,
14634                Keyword::PIVOT,
14635                Keyword::UNPIVOT,
14636                Keyword::JOIN,
14637                Keyword::INNER,
14638                Keyword::LEFT,
14639                Keyword::RIGHT,
14640                Keyword::FULL,
14641                Keyword::CROSS,
14642            ])?;
14643            match kw {
14644                Keyword::SELECT => {
14645                    let exprs = self.parse_comma_separated(Parser::parse_select_item)?;
14646                    pipe_operators.push(PipeOperator::Select { exprs })
14647                }
14648                Keyword::EXTEND => {
14649                    let exprs = self.parse_comma_separated(Parser::parse_select_item)?;
14650                    pipe_operators.push(PipeOperator::Extend { exprs })
14651                }
14652                Keyword::SET => {
14653                    let assignments = self.parse_comma_separated(Parser::parse_assignment)?;
14654                    pipe_operators.push(PipeOperator::Set { assignments })
14655                }
14656                Keyword::DROP => {
14657                    let columns = self.parse_identifiers()?;
14658                    pipe_operators.push(PipeOperator::Drop { columns })
14659                }
14660                Keyword::AS => {
14661                    let alias = self.parse_identifier()?;
14662                    pipe_operators.push(PipeOperator::As { alias })
14663                }
14664                Keyword::WHERE => {
14665                    let expr = self.parse_expr()?;
14666                    pipe_operators.push(PipeOperator::Where { expr })
14667                }
14668                Keyword::LIMIT => {
14669                    let expr = self.parse_expr()?;
14670                    let offset = if self.parse_keyword(Keyword::OFFSET) {
14671                        Some(self.parse_expr()?)
14672                    } else {
14673                        None
14674                    };
14675                    pipe_operators.push(PipeOperator::Limit { expr, offset })
14676                }
14677                Keyword::AGGREGATE => {
14678                    let full_table_exprs = if self.peek_keyword(Keyword::GROUP) {
14679                        vec![]
14680                    } else {
14681                        self.parse_comma_separated(|parser| {
14682                            parser.parse_expr_with_alias_and_order_by()
14683                        })?
14684                    };
14685
14686                    let group_by_expr = if self.parse_keywords(&[Keyword::GROUP, Keyword::BY]) {
14687                        self.parse_comma_separated(|parser| {
14688                            parser.parse_expr_with_alias_and_order_by()
14689                        })?
14690                    } else {
14691                        vec![]
14692                    };
14693
14694                    pipe_operators.push(PipeOperator::Aggregate {
14695                        full_table_exprs,
14696                        group_by_expr,
14697                    })
14698                }
14699                Keyword::ORDER => {
14700                    self.expect_one_of_keywords(&[Keyword::BY])?;
14701                    let exprs = self.parse_comma_separated(Parser::parse_order_by_expr)?;
14702                    pipe_operators.push(PipeOperator::OrderBy { exprs })
14703                }
14704                Keyword::TABLESAMPLE => {
14705                    let sample = self.parse_table_sample(TableSampleModifier::TableSample)?;
14706                    pipe_operators.push(PipeOperator::TableSample { sample });
14707                }
14708                Keyword::RENAME => {
14709                    let mappings =
14710                        self.parse_comma_separated(Parser::parse_identifier_with_optional_alias)?;
14711                    pipe_operators.push(PipeOperator::Rename { mappings });
14712                }
14713                Keyword::UNION => {
14714                    let set_quantifier = self.parse_set_quantifier(&Some(SetOperator::Union));
14715                    let queries = self.parse_pipe_operator_queries()?;
14716                    pipe_operators.push(PipeOperator::Union {
14717                        set_quantifier,
14718                        queries,
14719                    });
14720                }
14721                Keyword::INTERSECT => {
14722                    let set_quantifier =
14723                        self.parse_distinct_required_set_quantifier("INTERSECT")?;
14724                    let queries = self.parse_pipe_operator_queries()?;
14725                    pipe_operators.push(PipeOperator::Intersect {
14726                        set_quantifier,
14727                        queries,
14728                    });
14729                }
14730                Keyword::EXCEPT => {
14731                    let set_quantifier = self.parse_distinct_required_set_quantifier("EXCEPT")?;
14732                    let queries = self.parse_pipe_operator_queries()?;
14733                    pipe_operators.push(PipeOperator::Except {
14734                        set_quantifier,
14735                        queries,
14736                    });
14737                }
14738                Keyword::CALL => {
14739                    let function_name = self.parse_object_name(false)?;
14740                    let function_expr = self.parse_function(function_name)?;
14741                    if let Expr::Function(function) = function_expr {
14742                        let alias = self.parse_identifier_optional_alias()?;
14743                        pipe_operators.push(PipeOperator::Call { function, alias });
14744                    } else {
14745                        return Err(ParserError::ParserError(
14746                            "Expected function call after CALL".to_string(),
14747                        ));
14748                    }
14749                }
14750                Keyword::PIVOT => {
14751                    self.expect_token(&Token::LParen)?;
14752                    let aggregate_functions =
14753                        self.parse_comma_separated(Self::parse_pivot_aggregate_function)?;
14754                    self.expect_keyword_is(Keyword::FOR)?;
14755                    let value_column = self.parse_period_separated(|p| p.parse_identifier())?;
14756                    self.expect_keyword_is(Keyword::IN)?;
14757
14758                    self.expect_token(&Token::LParen)?;
14759                    let value_source = if self.parse_keyword(Keyword::ANY) {
14760                        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
14761                            self.parse_comma_separated(Parser::parse_order_by_expr)?
14762                        } else {
14763                            vec![]
14764                        };
14765                        PivotValueSource::Any(order_by)
14766                    } else if self.peek_sub_query() {
14767                        PivotValueSource::Subquery(self.parse_query()?)
14768                    } else {
14769                        PivotValueSource::List(
14770                            self.parse_comma_separated(Self::parse_expr_with_alias)?,
14771                        )
14772                    };
14773                    self.expect_token(&Token::RParen)?;
14774                    self.expect_token(&Token::RParen)?;
14775
14776                    let alias = self.parse_identifier_optional_alias()?;
14777
14778                    pipe_operators.push(PipeOperator::Pivot {
14779                        aggregate_functions,
14780                        value_column,
14781                        value_source,
14782                        alias,
14783                    });
14784                }
14785                Keyword::UNPIVOT => {
14786                    self.expect_token(&Token::LParen)?;
14787                    let value_column = self.parse_identifier()?;
14788                    self.expect_keyword(Keyword::FOR)?;
14789                    let name_column = self.parse_identifier()?;
14790                    self.expect_keyword(Keyword::IN)?;
14791
14792                    self.expect_token(&Token::LParen)?;
14793                    let unpivot_columns = self.parse_comma_separated(Parser::parse_identifier)?;
14794                    self.expect_token(&Token::RParen)?;
14795
14796                    self.expect_token(&Token::RParen)?;
14797
14798                    let alias = self.parse_identifier_optional_alias()?;
14799
14800                    pipe_operators.push(PipeOperator::Unpivot {
14801                        value_column,
14802                        name_column,
14803                        unpivot_columns,
14804                        alias,
14805                    });
14806                }
14807                Keyword::JOIN
14808                | Keyword::INNER
14809                | Keyword::LEFT
14810                | Keyword::RIGHT
14811                | Keyword::FULL
14812                | Keyword::CROSS => {
14813                    self.prev_token();
14814                    let mut joins = self.parse_joins()?;
14815                    if joins.len() != 1 {
14816                        return Err(ParserError::ParserError(
14817                            "Join pipe operator must have a single join".to_string(),
14818                        ));
14819                    }
14820                    let join = joins.swap_remove(0);
14821                    pipe_operators.push(PipeOperator::Join(join))
14822                }
14823                unhandled => {
14824                    return Err(ParserError::ParserError(format!(
14825                    "`expect_one_of_keywords` further up allowed unhandled keyword: {unhandled:?}"
14826                )))
14827                }
14828            }
14829        }
14830        Ok(pipe_operators)
14831    }
14832
14833    fn parse_settings(&mut self) -> Result<Option<Vec<Setting>>, ParserError> {
14834        let settings = if self.dialect.supports_settings() && self.parse_keyword(Keyword::SETTINGS)
14835        {
14836            let key_values = self.parse_comma_separated(|p| {
14837                let key = p.parse_identifier()?;
14838                p.expect_token(&Token::Eq)?;
14839                let value = p.parse_expr()?;
14840                Ok(Setting { key, value })
14841            })?;
14842            Some(key_values)
14843        } else {
14844            None
14845        };
14846        Ok(settings)
14847    }
14848
14849    /// Parse a mssql `FOR [XML | JSON | BROWSE]` clause
14850    pub fn parse_for_clause(&mut self) -> Result<Option<ForClause>, ParserError> {
14851        if self.parse_keyword(Keyword::XML) {
14852            Ok(Some(self.parse_for_xml()?))
14853        } else if self.parse_keyword(Keyword::JSON) {
14854            Ok(Some(self.parse_for_json()?))
14855        } else if self.parse_keyword(Keyword::BROWSE) {
14856            Ok(Some(ForClause::Browse))
14857        } else {
14858            Ok(None)
14859        }
14860    }
14861
14862    /// Parse a mssql `FOR XML` clause
14863    pub fn parse_for_xml(&mut self) -> Result<ForClause, ParserError> {
14864        let for_xml = if self.parse_keyword(Keyword::RAW) {
14865            let mut element_name = None;
14866            if self.peek_token_ref().token == Token::LParen {
14867                self.expect_token(&Token::LParen)?;
14868                element_name = Some(self.parse_literal_string()?);
14869                self.expect_token(&Token::RParen)?;
14870            }
14871            ForXml::Raw(element_name)
14872        } else if self.parse_keyword(Keyword::AUTO) {
14873            ForXml::Auto
14874        } else if self.parse_keyword(Keyword::EXPLICIT) {
14875            ForXml::Explicit
14876        } else if self.parse_keyword(Keyword::PATH) {
14877            let mut element_name = None;
14878            if self.peek_token_ref().token == Token::LParen {
14879                self.expect_token(&Token::LParen)?;
14880                element_name = Some(self.parse_literal_string()?);
14881                self.expect_token(&Token::RParen)?;
14882            }
14883            ForXml::Path(element_name)
14884        } else {
14885            return Err(ParserError::ParserError(
14886                "Expected FOR XML [RAW | AUTO | EXPLICIT | PATH ]".to_string(),
14887            ));
14888        };
14889        let mut elements = false;
14890        let mut binary_base64 = false;
14891        let mut root = None;
14892        let mut r#type = false;
14893        while self.peek_token_ref().token == Token::Comma {
14894            self.next_token();
14895            if self.parse_keyword(Keyword::ELEMENTS) {
14896                elements = true;
14897            } else if self.parse_keyword(Keyword::BINARY) {
14898                self.expect_keyword_is(Keyword::BASE64)?;
14899                binary_base64 = true;
14900            } else if self.parse_keyword(Keyword::ROOT) {
14901                self.expect_token(&Token::LParen)?;
14902                root = Some(self.parse_literal_string()?);
14903                self.expect_token(&Token::RParen)?;
14904            } else if self.parse_keyword(Keyword::TYPE) {
14905                r#type = true;
14906            }
14907        }
14908        Ok(ForClause::Xml {
14909            for_xml,
14910            elements,
14911            binary_base64,
14912            root,
14913            r#type,
14914        })
14915    }
14916
14917    /// Parse a mssql `FOR JSON` clause
14918    pub fn parse_for_json(&mut self) -> Result<ForClause, ParserError> {
14919        let for_json = if self.parse_keyword(Keyword::AUTO) {
14920            ForJson::Auto
14921        } else if self.parse_keyword(Keyword::PATH) {
14922            ForJson::Path
14923        } else {
14924            return Err(ParserError::ParserError(
14925                "Expected FOR JSON [AUTO | PATH ]".to_string(),
14926            ));
14927        };
14928        let mut root = None;
14929        let mut include_null_values = false;
14930        let mut without_array_wrapper = false;
14931        while self.peek_token_ref().token == Token::Comma {
14932            self.next_token();
14933            if self.parse_keyword(Keyword::ROOT) {
14934                self.expect_token(&Token::LParen)?;
14935                root = Some(self.parse_literal_string()?);
14936                self.expect_token(&Token::RParen)?;
14937            } else if self.parse_keyword(Keyword::INCLUDE_NULL_VALUES) {
14938                include_null_values = true;
14939            } else if self.parse_keyword(Keyword::WITHOUT_ARRAY_WRAPPER) {
14940                without_array_wrapper = true;
14941            }
14942        }
14943        Ok(ForClause::Json {
14944            for_json,
14945            root,
14946            include_null_values,
14947            without_array_wrapper,
14948        })
14949    }
14950
14951    /// Parse a CTE (`alias [( col1, col2, ... )] [AS] (subquery)`)
14952    pub fn parse_cte(&mut self) -> Result<Cte, ParserError> {
14953        let name = self.parse_identifier()?;
14954
14955        let as_optional = self.dialect.supports_cte_without_as();
14956
14957        // If AS is optional, first try to parse `name (query)` directly
14958        if as_optional && !self.peek_keyword(Keyword::AS) {
14959            if let Some((query, closing_paren_token)) = self.maybe_parse(|p| {
14960                p.expect_token(&Token::LParen)?;
14961                let query = p.parse_query()?;
14962                let closing_paren_token = p.expect_token(&Token::RParen)?;
14963                Ok((query, closing_paren_token))
14964            })? {
14965                let mut cte = Cte {
14966                    alias: TableAlias {
14967                        explicit: false,
14968                        name,
14969                        columns: vec![],
14970                    },
14971                    query,
14972                    from: None,
14973                    materialized: None,
14974                    closing_paren_token: closing_paren_token.into(),
14975                };
14976                if self.parse_keyword(Keyword::FROM) {
14977                    cte.from = Some(self.parse_identifier()?);
14978                }
14979                return Ok(cte);
14980            }
14981        }
14982
14983        // Determine column definitions and consume AS
14984        let columns = if self.parse_keyword(Keyword::AS) {
14985            vec![]
14986        } else {
14987            let columns = self.parse_table_alias_column_defs()?;
14988            if as_optional {
14989                let _ = self.parse_keyword(Keyword::AS);
14990            } else {
14991                self.expect_keyword_is(Keyword::AS)?;
14992            }
14993            columns
14994        };
14995
14996        let mut is_materialized = None;
14997        if dialect_of!(self is PostgreSqlDialect) {
14998            if self.parse_keyword(Keyword::MATERIALIZED) {
14999                is_materialized = Some(CteAsMaterialized::Materialized);
15000            } else if self.parse_keywords(&[Keyword::NOT, Keyword::MATERIALIZED]) {
15001                is_materialized = Some(CteAsMaterialized::NotMaterialized);
15002            }
15003        }
15004
15005        self.expect_token(&Token::LParen)?;
15006        let query = self.parse_query()?;
15007        let closing_paren_token = self.expect_token(&Token::RParen)?;
15008
15009        let mut cte = Cte {
15010            alias: TableAlias {
15011                explicit: false,
15012                name,
15013                columns,
15014            },
15015            query,
15016            from: None,
15017            materialized: is_materialized,
15018            closing_paren_token: closing_paren_token.into(),
15019        };
15020        if self.dialect.supports_from_first_insert() && self.parse_keyword(Keyword::FROM) {
15021            cte.from = Some(self.parse_identifier()?);
15022        }
15023        Ok(cte)
15024    }
15025
15026    /// Parse a "query body", which is an expression with roughly the
15027    /// following grammar:
15028    /// ```sql
15029    ///   query_body ::= restricted_select | '(' subquery ')' | set_operation
15030    ///   restricted_select ::= 'SELECT' [expr_list] [ from ] [ where ] [ groupby_having ]
15031    ///   subquery ::= query_body [ order_by_limit ]
15032    ///   set_operation ::= query_body { 'UNION' | 'EXCEPT' | 'INTERSECT' } [ 'ALL' ] query_body
15033    /// ```
15034    pub fn parse_query_body(&mut self, precedence: u8) -> Result<Box<SetExpr>, ParserError> {
15035        // We parse the expression using a Pratt parser, as in `parse_expr()`.
15036        // Start by parsing a restricted SELECT or a `(subquery)`:
15037        let expr = if self.peek_keyword(Keyword::SELECT)
15038            || (self.peek_keyword(Keyword::FROM) && self.dialect.supports_from_first_select())
15039        {
15040            SetExpr::Select(self.parse_select().map(Box::new)?)
15041        } else if self.consume_token(&Token::LParen) {
15042            // CTEs are not allowed here, but the parser currently accepts them
15043            let subquery = self.parse_query()?;
15044            self.expect_token(&Token::RParen)?;
15045            SetExpr::Query(subquery)
15046        } else if self.parse_keyword(Keyword::VALUES) {
15047            let is_mysql = dialect_of!(self is MySqlDialect);
15048            SetExpr::Values(self.parse_values(is_mysql, false)?)
15049        } else if self.parse_keyword(Keyword::VALUE) {
15050            let is_mysql = dialect_of!(self is MySqlDialect);
15051            SetExpr::Values(self.parse_values(is_mysql, true)?)
15052        } else if self.parse_keyword(Keyword::TABLE) {
15053            SetExpr::Table(Box::new(self.parse_as_table()?))
15054        } else {
15055            return self.expected_ref(
15056                "SELECT, VALUES, or a subquery in the query body",
15057                self.peek_token_ref(),
15058            );
15059        };
15060
15061        self.parse_remaining_set_exprs(expr, precedence)
15062    }
15063
15064    /// Parse any extra set expressions that may be present in a query body
15065    ///
15066    /// (this is its own function to reduce required stack size in debug builds)
15067    fn parse_remaining_set_exprs(
15068        &mut self,
15069        mut expr: SetExpr,
15070        precedence: u8,
15071    ) -> Result<Box<SetExpr>, ParserError> {
15072        loop {
15073            // The query can be optionally followed by a set operator:
15074            let op = self.parse_set_operator(&self.peek_token().token);
15075            let next_precedence = match op {
15076                // UNION and EXCEPT have the same binding power and evaluate left-to-right
15077                Some(SetOperator::Union) | Some(SetOperator::Except) | Some(SetOperator::Minus) => {
15078                    10
15079                }
15080                // INTERSECT has higher precedence than UNION/EXCEPT
15081                Some(SetOperator::Intersect) => 20,
15082                // Unexpected token or EOF => stop parsing the query body
15083                None => break,
15084            };
15085            if precedence >= next_precedence {
15086                break;
15087            }
15088            self.next_token(); // skip past the set operator
15089            let set_quantifier = self.parse_set_quantifier(&op);
15090            expr = SetExpr::SetOperation {
15091                left: Box::new(expr),
15092                op: op.unwrap(),
15093                set_quantifier,
15094                right: self.parse_query_body(next_precedence)?,
15095            };
15096        }
15097
15098        Ok(expr.into())
15099    }
15100
15101    /// Parse a set operator token into its `SetOperator` variant.
15102    pub fn parse_set_operator(&mut self, token: &Token) -> Option<SetOperator> {
15103        match token {
15104            Token::Word(w) if w.keyword == Keyword::UNION => Some(SetOperator::Union),
15105            Token::Word(w) if w.keyword == Keyword::EXCEPT => Some(SetOperator::Except),
15106            Token::Word(w) if w.keyword == Keyword::INTERSECT => Some(SetOperator::Intersect),
15107            Token::Word(w) if w.keyword == Keyword::MINUS => Some(SetOperator::Minus),
15108            _ => None,
15109        }
15110    }
15111
15112    /// Parse a set quantifier (e.g., `ALL`, `DISTINCT BY NAME`) for the given set operator.
15113    pub fn parse_set_quantifier(&mut self, op: &Option<SetOperator>) -> SetQuantifier {
15114        match op {
15115            Some(
15116                SetOperator::Except
15117                | SetOperator::Intersect
15118                | SetOperator::Union
15119                | SetOperator::Minus,
15120            ) => {
15121                if self.parse_keywords(&[Keyword::DISTINCT, Keyword::BY, Keyword::NAME]) {
15122                    SetQuantifier::DistinctByName
15123                } else if self.parse_keywords(&[Keyword::BY, Keyword::NAME]) {
15124                    SetQuantifier::ByName
15125                } else if self.parse_keyword(Keyword::ALL) {
15126                    if self.parse_keywords(&[Keyword::BY, Keyword::NAME]) {
15127                        SetQuantifier::AllByName
15128                    } else {
15129                        SetQuantifier::All
15130                    }
15131                } else if self.parse_keyword(Keyword::DISTINCT) {
15132                    SetQuantifier::Distinct
15133                } else {
15134                    SetQuantifier::None
15135                }
15136            }
15137            _ => SetQuantifier::None,
15138        }
15139    }
15140
15141    /// Parse a restricted `SELECT` statement (no CTEs / `UNION` / `ORDER BY`)
15142    pub fn parse_select(&mut self) -> Result<Select, ParserError> {
15143        let mut from_first = None;
15144
15145        if self.dialect.supports_from_first_select() && self.peek_keyword(Keyword::FROM) {
15146            let from_token = self.expect_keyword(Keyword::FROM)?;
15147            let from = self.parse_table_with_joins()?;
15148            if !self.peek_keyword(Keyword::SELECT) {
15149                return Ok(Select {
15150                    select_token: AttachedToken(from_token),
15151                    optimizer_hints: vec![],
15152                    distinct: None,
15153                    select_modifiers: None,
15154                    top: None,
15155                    top_before_distinct: false,
15156                    projection: vec![],
15157                    exclude: None,
15158                    into: None,
15159                    from,
15160                    lateral_views: vec![],
15161                    prewhere: None,
15162                    selection: None,
15163                    group_by: GroupByExpr::Expressions(vec![], vec![]),
15164                    cluster_by: vec![],
15165                    distribute_by: vec![],
15166                    sort_by: vec![],
15167                    having: None,
15168                    named_window: vec![],
15169                    window_before_qualify: false,
15170                    qualify: None,
15171                    value_table_mode: None,
15172                    connect_by: vec![],
15173                    flavor: SelectFlavor::FromFirstNoSelect,
15174                });
15175            }
15176            from_first = Some(from);
15177        }
15178
15179        let select_token = self.expect_keyword(Keyword::SELECT)?;
15180        let optimizer_hints = self.maybe_parse_optimizer_hints()?;
15181        let value_table_mode = self.parse_value_table_mode()?;
15182
15183        let (select_modifiers, distinct_select_modifier) =
15184            if self.dialect.supports_select_modifiers() {
15185                self.parse_select_modifiers()?
15186            } else {
15187                (None, None)
15188            };
15189
15190        let mut top_before_distinct = false;
15191        let mut top = None;
15192        if self.dialect.supports_top_before_distinct() && self.parse_keyword(Keyword::TOP) {
15193            top = Some(self.parse_top()?);
15194            top_before_distinct = true;
15195        }
15196
15197        let distinct = if distinct_select_modifier.is_some() {
15198            distinct_select_modifier
15199        } else {
15200            self.parse_all_or_distinct()?
15201        };
15202
15203        if !self.dialect.supports_top_before_distinct() && self.parse_keyword(Keyword::TOP) {
15204            top = Some(self.parse_top()?);
15205        }
15206
15207        let projection =
15208            if self.dialect.supports_empty_projections() && self.peek_keyword(Keyword::FROM) {
15209                vec![]
15210            } else {
15211                self.parse_projection()?
15212            };
15213
15214        let exclude = if self.dialect.supports_select_exclude() {
15215            self.parse_optional_select_item_exclude()?
15216        } else {
15217            None
15218        };
15219
15220        let into = if self.parse_keyword(Keyword::INTO) {
15221            Some(self.parse_select_into()?)
15222        } else {
15223            None
15224        };
15225
15226        // Note that for keywords to be properly handled here, they need to be
15227        // added to `RESERVED_FOR_COLUMN_ALIAS` / `RESERVED_FOR_TABLE_ALIAS`,
15228        // otherwise they may be parsed as an alias as part of the `projection`
15229        // or `from`.
15230
15231        let (from, from_first) = if let Some(from) = from_first.take() {
15232            (from, true)
15233        } else if self.parse_keyword(Keyword::FROM) {
15234            (self.parse_table_with_joins()?, false)
15235        } else {
15236            (vec![], false)
15237        };
15238
15239        let mut lateral_views = vec![];
15240        loop {
15241            if self.parse_keywords(&[Keyword::LATERAL, Keyword::VIEW]) {
15242                let outer = self.parse_keyword(Keyword::OUTER);
15243                let lateral_view = self.parse_expr()?;
15244                let lateral_view_name = self.parse_object_name(false)?;
15245                let lateral_col_alias = self
15246                    .parse_comma_separated(|parser| {
15247                        parser.parse_optional_alias(&[
15248                            Keyword::WHERE,
15249                            Keyword::GROUP,
15250                            Keyword::CLUSTER,
15251                            Keyword::HAVING,
15252                            Keyword::LATERAL,
15253                        ]) // This couldn't possibly be a bad idea
15254                    })?
15255                    .into_iter()
15256                    .flatten()
15257                    .collect();
15258
15259                lateral_views.push(LateralView {
15260                    lateral_view,
15261                    lateral_view_name,
15262                    lateral_col_alias,
15263                    outer,
15264                });
15265            } else {
15266                break;
15267            }
15268        }
15269
15270        let prewhere = if self.dialect.supports_prewhere() && self.parse_keyword(Keyword::PREWHERE)
15271        {
15272            Some(self.parse_expr()?)
15273        } else {
15274            None
15275        };
15276
15277        let selection = if self.parse_keyword(Keyword::WHERE) {
15278            Some(self.parse_expr()?)
15279        } else {
15280            None
15281        };
15282
15283        let connect_by = self.maybe_parse_connect_by()?;
15284
15285        let group_by = self
15286            .parse_optional_group_by()?
15287            .unwrap_or_else(|| GroupByExpr::Expressions(vec![], vec![]));
15288
15289        let cluster_by = if self.parse_keywords(&[Keyword::CLUSTER, Keyword::BY]) {
15290            self.parse_comma_separated(Parser::parse_expr)?
15291        } else {
15292            vec![]
15293        };
15294
15295        let distribute_by = if self.parse_keywords(&[Keyword::DISTRIBUTE, Keyword::BY]) {
15296            self.parse_comma_separated(Parser::parse_expr)?
15297        } else {
15298            vec![]
15299        };
15300
15301        let sort_by = if self.parse_keywords(&[Keyword::SORT, Keyword::BY]) {
15302            self.parse_comma_separated(Parser::parse_order_by_expr)?
15303        } else {
15304            vec![]
15305        };
15306
15307        let having = if self.parse_keyword(Keyword::HAVING) {
15308            Some(self.parse_expr()?)
15309        } else {
15310            None
15311        };
15312
15313        // Accept QUALIFY and WINDOW in any order and flag accordingly.
15314        let (named_windows, qualify, window_before_qualify) = if self.parse_keyword(Keyword::WINDOW)
15315        {
15316            let named_windows = self.parse_comma_separated(Parser::parse_named_window)?;
15317            if self.parse_keyword(Keyword::QUALIFY) {
15318                (named_windows, Some(self.parse_expr()?), true)
15319            } else {
15320                (named_windows, None, true)
15321            }
15322        } else if self.parse_keyword(Keyword::QUALIFY) {
15323            let qualify = Some(self.parse_expr()?);
15324            if self.parse_keyword(Keyword::WINDOW) {
15325                (
15326                    self.parse_comma_separated(Parser::parse_named_window)?,
15327                    qualify,
15328                    false,
15329                )
15330            } else {
15331                (Default::default(), qualify, false)
15332            }
15333        } else {
15334            Default::default()
15335        };
15336
15337        Ok(Select {
15338            select_token: AttachedToken(select_token),
15339            optimizer_hints,
15340            distinct,
15341            select_modifiers,
15342            top,
15343            top_before_distinct,
15344            projection,
15345            exclude,
15346            into,
15347            from,
15348            lateral_views,
15349            prewhere,
15350            selection,
15351            group_by,
15352            cluster_by,
15353            distribute_by,
15354            sort_by,
15355            having,
15356            named_window: named_windows,
15357            window_before_qualify,
15358            qualify,
15359            value_table_mode,
15360            connect_by,
15361            flavor: if from_first {
15362                SelectFlavor::FromFirst
15363            } else {
15364                SelectFlavor::Standard
15365            },
15366        })
15367    }
15368
15369    /// Parses optimizer hints at the current token position.
15370    ///
15371    /// Collects all `/*prefix+...*/` and `--prefix+...` patterns.
15372    /// The `prefix` is any run of ASCII alphanumeric characters between the
15373    /// comment marker and `+` (e.g. `""` for `/*+...*/`, `"abc"` for `/*abc+...*/`).
15374    ///
15375    /// [MySQL](https://dev.mysql.com/doc/refman/8.4/en/optimizer-hints.html#optimizer-hints-overview)
15376    /// [Oracle](https://docs.oracle.com/en/database/oracle/oracle-database/21/sqlrf/Comments.html#GUID-D316D545-89E2-4D54-977F-FC97815CD62E)
15377    fn maybe_parse_optimizer_hints(&mut self) -> Result<Vec<OptimizerHint>, ParserError> {
15378        let supports_hints = self.dialect.supports_comment_optimizer_hint();
15379        if !supports_hints {
15380            return Ok(vec![]);
15381        }
15382        let mut hints = vec![];
15383        loop {
15384            let t = self.peek_nth_token_no_skip_ref(0);
15385            let Token::Whitespace(ws) = &t.token else {
15386                break;
15387            };
15388            match ws {
15389                Whitespace::SingleLineComment { comment, prefix } => {
15390                    if let Some((hint_prefix, text)) = Self::extract_hint_prefix_and_text(comment) {
15391                        hints.push(OptimizerHint {
15392                            prefix: hint_prefix,
15393                            text,
15394                            style: OptimizerHintStyle::SingleLine {
15395                                prefix: prefix.clone(),
15396                            },
15397                        });
15398                    }
15399                    self.next_token_no_skip();
15400                }
15401                Whitespace::MultiLineComment(comment) => {
15402                    if let Some((hint_prefix, text)) = Self::extract_hint_prefix_and_text(comment) {
15403                        hints.push(OptimizerHint {
15404                            prefix: hint_prefix,
15405                            text,
15406                            style: OptimizerHintStyle::MultiLine,
15407                        });
15408                    }
15409                    self.next_token_no_skip();
15410                }
15411                Whitespace::Space | Whitespace::Tab | Whitespace::Newline => {
15412                    self.next_token_no_skip();
15413                }
15414            }
15415        }
15416        Ok(hints)
15417    }
15418
15419    /// Checks if a comment's content starts with `[ASCII-alphanumeric]*+`
15420    /// and returns `(prefix, text_after_plus)` if so.
15421    fn extract_hint_prefix_and_text(comment: &str) -> Option<(String, String)> {
15422        let (before_plus, text) = comment.split_once('+')?;
15423        if before_plus.chars().all(|c| c.is_ascii_alphanumeric()) {
15424            Some((before_plus.to_string(), text.to_string()))
15425        } else {
15426            None
15427        }
15428    }
15429
15430    /// Parses MySQL SELECT modifiers and DISTINCT/ALL in any order.
15431    ///
15432    /// Manual testing shows odifiers can appear in any order, and modifiers other than DISTINCT/ALL
15433    /// can be repeated.
15434    ///
15435    /// <https://dev.mysql.com/doc/refman/8.4/en/select.html>
15436    fn parse_select_modifiers(
15437        &mut self,
15438    ) -> Result<(Option<SelectModifiers>, Option<Distinct>), ParserError> {
15439        let mut modifiers = SelectModifiers::default();
15440        let mut distinct = None;
15441
15442        let keywords = &[
15443            Keyword::ALL,
15444            Keyword::DISTINCT,
15445            Keyword::DISTINCTROW,
15446            Keyword::HIGH_PRIORITY,
15447            Keyword::STRAIGHT_JOIN,
15448            Keyword::SQL_SMALL_RESULT,
15449            Keyword::SQL_BIG_RESULT,
15450            Keyword::SQL_BUFFER_RESULT,
15451            Keyword::SQL_NO_CACHE,
15452            Keyword::SQL_CALC_FOUND_ROWS,
15453        ];
15454
15455        while let Some(keyword) = self.parse_one_of_keywords(keywords) {
15456            match keyword {
15457                Keyword::ALL | Keyword::DISTINCT if distinct.is_none() => {
15458                    self.prev_token();
15459                    distinct = self.parse_all_or_distinct()?;
15460                }
15461                // DISTINCTROW is a MySQL-specific legacy (but not deprecated) alias for DISTINCT
15462                Keyword::DISTINCTROW if distinct.is_none() => {
15463                    distinct = Some(Distinct::Distinct);
15464                }
15465                Keyword::HIGH_PRIORITY => modifiers.high_priority = true,
15466                Keyword::STRAIGHT_JOIN => modifiers.straight_join = true,
15467                Keyword::SQL_SMALL_RESULT => modifiers.sql_small_result = true,
15468                Keyword::SQL_BIG_RESULT => modifiers.sql_big_result = true,
15469                Keyword::SQL_BUFFER_RESULT => modifiers.sql_buffer_result = true,
15470                Keyword::SQL_NO_CACHE => modifiers.sql_no_cache = true,
15471                Keyword::SQL_CALC_FOUND_ROWS => modifiers.sql_calc_found_rows = true,
15472                _ => {
15473                    self.prev_token();
15474                    return self.expected_ref(
15475                        "HIGH_PRIORITY, STRAIGHT_JOIN, or other MySQL select modifier",
15476                        self.peek_token_ref(),
15477                    );
15478                }
15479            }
15480        }
15481
15482        // Avoid polluting the AST with `Some(SelectModifiers::default())` empty value unless there
15483        // actually were some modifiers set.
15484        let select_modifiers = if modifiers.is_any_set() {
15485            Some(modifiers)
15486        } else {
15487            None
15488        };
15489        Ok((select_modifiers, distinct))
15490    }
15491
15492    fn parse_value_table_mode(&mut self) -> Result<Option<ValueTableMode>, ParserError> {
15493        if !dialect_of!(self is BigQueryDialect) {
15494            return Ok(None);
15495        }
15496
15497        let mode = if self.parse_keywords(&[Keyword::DISTINCT, Keyword::AS, Keyword::VALUE]) {
15498            Some(ValueTableMode::DistinctAsValue)
15499        } else if self.parse_keywords(&[Keyword::DISTINCT, Keyword::AS, Keyword::STRUCT]) {
15500            Some(ValueTableMode::DistinctAsStruct)
15501        } else if self.parse_keywords(&[Keyword::AS, Keyword::VALUE])
15502            || self.parse_keywords(&[Keyword::ALL, Keyword::AS, Keyword::VALUE])
15503        {
15504            Some(ValueTableMode::AsValue)
15505        } else if self.parse_keywords(&[Keyword::AS, Keyword::STRUCT])
15506            || self.parse_keywords(&[Keyword::ALL, Keyword::AS, Keyword::STRUCT])
15507        {
15508            Some(ValueTableMode::AsStruct)
15509        } else if self.parse_keyword(Keyword::AS) {
15510            self.expected_ref("VALUE or STRUCT", self.peek_token_ref())?
15511        } else {
15512            None
15513        };
15514
15515        Ok(mode)
15516    }
15517
15518    /// Invoke `f` after first setting the parser's `ParserState` to `state`.
15519    ///
15520    /// Upon return, restores the parser's state to what it started at.
15521    fn with_state<T, F>(&mut self, state: ParserState, mut f: F) -> Result<T, ParserError>
15522    where
15523        F: FnMut(&mut Parser) -> Result<T, ParserError>,
15524    {
15525        let current_state = self.state;
15526        self.state = state;
15527        let res = f(self);
15528        self.state = current_state;
15529        res
15530    }
15531
15532    /// Parse a `CONNECT BY` clause (Oracle-style hierarchical query support).
15533    pub fn maybe_parse_connect_by(&mut self) -> Result<Vec<ConnectByKind>, ParserError> {
15534        let mut clauses = Vec::with_capacity(2);
15535        loop {
15536            if let Some(idx) = self.parse_keywords_indexed(&[Keyword::START, Keyword::WITH]) {
15537                clauses.push(ConnectByKind::StartWith {
15538                    start_token: self.token_at(idx).clone().into(),
15539                    condition: self.parse_expr()?.into(),
15540                });
15541            } else if let Some(idx) = self.parse_keywords_indexed(&[Keyword::CONNECT, Keyword::BY])
15542            {
15543                clauses.push(ConnectByKind::ConnectBy {
15544                    connect_token: self.token_at(idx).clone().into(),
15545                    nocycle: self.parse_keyword(Keyword::NOCYCLE),
15546                    relationships: self.with_state(ParserState::ConnectBy, |parser| {
15547                        parser.parse_comma_separated(Parser::parse_expr)
15548                    })?,
15549                });
15550            } else {
15551                break;
15552            }
15553        }
15554        Ok(clauses)
15555    }
15556
15557    /// Parse `CREATE TABLE x AS TABLE y`
15558    pub fn parse_as_table(&mut self) -> Result<Table, ParserError> {
15559        let token1 = self.next_token();
15560        let token2 = self.next_token();
15561        let token3 = self.next_token();
15562
15563        let table_name;
15564        let schema_name;
15565        if token2 == Token::Period {
15566            match token1.token {
15567                Token::Word(w) => {
15568                    schema_name = w.value;
15569                }
15570                _ => {
15571                    return self.expected("Schema name", token1);
15572                }
15573            }
15574            match token3.token {
15575                Token::Word(w) => {
15576                    table_name = w.value;
15577                }
15578                _ => {
15579                    return self.expected("Table name", token3);
15580                }
15581            }
15582            Ok(Table {
15583                table_name: Some(table_name),
15584                schema_name: Some(schema_name),
15585            })
15586        } else {
15587            match token1.token {
15588                Token::Word(w) => {
15589                    table_name = w.value;
15590                }
15591                _ => {
15592                    return self.expected("Table name", token1);
15593                }
15594            }
15595            Ok(Table {
15596                table_name: Some(table_name),
15597                schema_name: None,
15598            })
15599        }
15600    }
15601
15602    /// Parse a `SET ROLE` statement. Expects SET to be consumed already.
15603    fn parse_set_role(
15604        &mut self,
15605        modifier: Option<ContextModifier>,
15606    ) -> Result<Statement, ParserError> {
15607        self.expect_keyword_is(Keyword::ROLE)?;
15608
15609        let role_name = if self.parse_keyword(Keyword::NONE) {
15610            None
15611        } else {
15612            Some(self.parse_identifier()?)
15613        };
15614        Ok(Statement::Set(Set::SetRole {
15615            context_modifier: modifier,
15616            role_name,
15617        }))
15618    }
15619
15620    fn parse_set_values(
15621        &mut self,
15622        parenthesized_assignment: bool,
15623    ) -> Result<Vec<Expr>, ParserError> {
15624        let mut values = vec![];
15625
15626        if parenthesized_assignment {
15627            self.expect_token(&Token::LParen)?;
15628        }
15629
15630        loop {
15631            let value = if let Some(expr) = self.try_parse_expr_sub_query()? {
15632                expr
15633            } else if let Ok(expr) = self.parse_expr() {
15634                expr
15635            } else {
15636                self.expected_ref("variable value", self.peek_token_ref())?
15637            };
15638
15639            values.push(value);
15640            if self.consume_token(&Token::Comma) {
15641                continue;
15642            }
15643
15644            if parenthesized_assignment {
15645                self.expect_token(&Token::RParen)?;
15646            }
15647            return Ok(values);
15648        }
15649    }
15650
15651    fn parse_context_modifier(&mut self) -> Option<ContextModifier> {
15652        let modifier =
15653            self.parse_one_of_keywords(&[Keyword::SESSION, Keyword::LOCAL, Keyword::GLOBAL])?;
15654
15655        Self::keyword_to_modifier(modifier)
15656    }
15657
15658    /// Parse a single SET statement assignment `var = expr`.
15659    fn parse_set_assignment(&mut self) -> Result<SetAssignment, ParserError> {
15660        let scope = self.parse_context_modifier();
15661
15662        let name = if self.dialect.supports_parenthesized_set_variables()
15663            && self.consume_token(&Token::LParen)
15664        {
15665            // Parenthesized assignments are handled in the `parse_set` function after
15666            // trying to parse list of assignments using this function.
15667            // If a dialect supports both, and we find a LParen, we early exit from this function.
15668            self.expected_ref("Unparenthesized assignment", self.peek_token_ref())?
15669        } else {
15670            self.parse_object_name(false)?
15671        };
15672
15673        if !(self.consume_token(&Token::Eq) || self.parse_keyword(Keyword::TO)) {
15674            return self.expected_ref("assignment operator", self.peek_token_ref());
15675        }
15676
15677        let value = self.parse_expr()?;
15678
15679        Ok(SetAssignment { scope, name, value })
15680    }
15681
15682    fn parse_set(&mut self) -> Result<Statement, ParserError> {
15683        let hivevar = self.parse_keyword(Keyword::HIVEVAR);
15684
15685        // Modifier is either HIVEVAR: or a ContextModifier (LOCAL, SESSION, etc), not both
15686        let scope = if !hivevar {
15687            self.parse_context_modifier()
15688        } else {
15689            None
15690        };
15691
15692        if hivevar {
15693            self.expect_token(&Token::Colon)?;
15694        }
15695
15696        if let Some(set_role_stmt) = self.maybe_parse(|parser| parser.parse_set_role(scope))? {
15697            return Ok(set_role_stmt);
15698        }
15699
15700        // Handle special cases first
15701        if self.parse_keywords(&[Keyword::TIME, Keyword::ZONE])
15702            || self.parse_keyword(Keyword::TIMEZONE)
15703        {
15704            if self.consume_token(&Token::Eq) || self.parse_keyword(Keyword::TO) {
15705                return Ok(Set::SingleAssignment {
15706                    scope,
15707                    hivevar,
15708                    variable: ObjectName::from(vec!["TIMEZONE".into()]),
15709                    values: self.parse_set_values(false)?,
15710                }
15711                .into());
15712            } else {
15713                // A shorthand alias for SET TIME ZONE that doesn't require
15714                // the assignment operator. It's originally PostgreSQL specific,
15715                // but we allow it for all the dialects
15716                return Ok(Set::SetTimeZone {
15717                    local: scope == Some(ContextModifier::Local),
15718                    value: self.parse_expr()?,
15719                }
15720                .into());
15721            }
15722        } else if self.dialect.supports_set_names() && self.parse_keyword(Keyword::NAMES) {
15723            if self.parse_keyword(Keyword::DEFAULT) {
15724                return Ok(Set::SetNamesDefault {}.into());
15725            }
15726            let charset_name = self.parse_identifier()?;
15727            let collation_name = if self.parse_one_of_keywords(&[Keyword::COLLATE]).is_some() {
15728                Some(self.parse_literal_string()?)
15729            } else {
15730                None
15731            };
15732
15733            return Ok(Set::SetNames {
15734                charset_name,
15735                collation_name,
15736            }
15737            .into());
15738        } else if self.parse_keyword(Keyword::CHARACTERISTICS) {
15739            self.expect_keywords(&[Keyword::AS, Keyword::TRANSACTION])?;
15740            return Ok(Set::SetTransaction {
15741                modes: self.parse_transaction_modes()?,
15742                snapshot: None,
15743                session: true,
15744            }
15745            .into());
15746        } else if self.parse_keyword(Keyword::TRANSACTION) {
15747            if self.parse_keyword(Keyword::SNAPSHOT) {
15748                let snapshot_id = self.parse_value()?;
15749                return Ok(Set::SetTransaction {
15750                    modes: vec![],
15751                    snapshot: Some(snapshot_id),
15752                    session: false,
15753                }
15754                .into());
15755            }
15756            return Ok(Set::SetTransaction {
15757                modes: self.parse_transaction_modes()?,
15758                snapshot: None,
15759                session: false,
15760            }
15761            .into());
15762        } else if self.parse_keyword(Keyword::AUTHORIZATION) {
15763            let scope = match scope {
15764                Some(s) => s,
15765                None => {
15766                    return self.expected_at(
15767                        "SESSION, LOCAL, or other scope modifier before AUTHORIZATION",
15768                        self.get_current_index(),
15769                    )
15770                }
15771            };
15772            let auth_value = if self.parse_keyword(Keyword::DEFAULT) {
15773                SetSessionAuthorizationParamKind::Default
15774            } else {
15775                let value = self.parse_identifier()?;
15776                SetSessionAuthorizationParamKind::User(value)
15777            };
15778            return Ok(Set::SetSessionAuthorization(SetSessionAuthorizationParam {
15779                scope,
15780                kind: auth_value,
15781            })
15782            .into());
15783        }
15784
15785        if self.dialect.supports_comma_separated_set_assignments() {
15786            if scope.is_some() {
15787                self.prev_token();
15788            }
15789
15790            if let Some(assignments) = self
15791                .maybe_parse(|parser| parser.parse_comma_separated(Parser::parse_set_assignment))?
15792            {
15793                return if assignments.len() > 1 {
15794                    Ok(Set::MultipleAssignments { assignments }.into())
15795                } else {
15796                    let SetAssignment { scope, name, value } =
15797                        assignments.into_iter().next().ok_or_else(|| {
15798                            ParserError::ParserError("Expected at least one assignment".to_string())
15799                        })?;
15800
15801                    Ok(Set::SingleAssignment {
15802                        scope,
15803                        hivevar,
15804                        variable: name,
15805                        values: vec![value],
15806                    }
15807                    .into())
15808                };
15809            }
15810        }
15811
15812        let variables = if self.dialect.supports_parenthesized_set_variables()
15813            && self.consume_token(&Token::LParen)
15814        {
15815            let vars = OneOrManyWithParens::Many(
15816                self.parse_comma_separated(|parser: &mut Parser<'a>| parser.parse_identifier())?
15817                    .into_iter()
15818                    .map(|ident| ObjectName::from(vec![ident]))
15819                    .collect(),
15820            );
15821            self.expect_token(&Token::RParen)?;
15822            vars
15823        } else {
15824            OneOrManyWithParens::One(self.parse_object_name(false)?)
15825        };
15826
15827        if self.consume_token(&Token::Eq) || self.parse_keyword(Keyword::TO) {
15828            let stmt = match variables {
15829                OneOrManyWithParens::One(var) => Set::SingleAssignment {
15830                    scope,
15831                    hivevar,
15832                    variable: var,
15833                    values: self.parse_set_values(false)?,
15834                },
15835                OneOrManyWithParens::Many(vars) => Set::ParenthesizedAssignments {
15836                    variables: vars,
15837                    values: self.parse_set_values(true)?,
15838                },
15839            };
15840
15841            return Ok(stmt.into());
15842        }
15843
15844        if self.dialect.supports_set_stmt_without_operator() {
15845            self.prev_token();
15846            return self.parse_set_session_params();
15847        };
15848
15849        self.expected_ref("equals sign or TO", self.peek_token_ref())
15850    }
15851
15852    /// Parse session parameter assignments after `SET` when no `=` or `TO` is present.
15853    pub fn parse_set_session_params(&mut self) -> Result<Statement, ParserError> {
15854        if self.parse_keyword(Keyword::STATISTICS) {
15855            let topic = match self.parse_one_of_keywords(&[
15856                Keyword::IO,
15857                Keyword::PROFILE,
15858                Keyword::TIME,
15859                Keyword::XML,
15860            ]) {
15861                Some(Keyword::IO) => SessionParamStatsTopic::IO,
15862                Some(Keyword::PROFILE) => SessionParamStatsTopic::Profile,
15863                Some(Keyword::TIME) => SessionParamStatsTopic::Time,
15864                Some(Keyword::XML) => SessionParamStatsTopic::Xml,
15865                _ => return self.expected_ref("IO, PROFILE, TIME or XML", self.peek_token_ref()),
15866            };
15867            let value = self.parse_session_param_value()?;
15868            Ok(
15869                Set::SetSessionParam(SetSessionParamKind::Statistics(SetSessionParamStatistics {
15870                    topic,
15871                    value,
15872                }))
15873                .into(),
15874            )
15875        } else if self.parse_keyword(Keyword::IDENTITY_INSERT) {
15876            let obj = self.parse_object_name(false)?;
15877            let value = self.parse_session_param_value()?;
15878            Ok(Set::SetSessionParam(SetSessionParamKind::IdentityInsert(
15879                SetSessionParamIdentityInsert { obj, value },
15880            ))
15881            .into())
15882        } else if self.parse_keyword(Keyword::OFFSETS) {
15883            let keywords = self.parse_comma_separated(|parser| {
15884                let next_token = parser.next_token();
15885                match &next_token.token {
15886                    Token::Word(w) => Ok(w.to_string()),
15887                    _ => parser.expected("SQL keyword", next_token),
15888                }
15889            })?;
15890            let value = self.parse_session_param_value()?;
15891            Ok(
15892                Set::SetSessionParam(SetSessionParamKind::Offsets(SetSessionParamOffsets {
15893                    keywords,
15894                    value,
15895                }))
15896                .into(),
15897            )
15898        } else {
15899            let names = self.parse_comma_separated(|parser| {
15900                let next_token = parser.next_token();
15901                match next_token.token {
15902                    Token::Word(w) => Ok(w.to_string()),
15903                    _ => parser.expected("Session param name", next_token),
15904                }
15905            })?;
15906            let value = self.parse_expr()?.to_string();
15907            Ok(
15908                Set::SetSessionParam(SetSessionParamKind::Generic(SetSessionParamGeneric {
15909                    names,
15910                    value,
15911                }))
15912                .into(),
15913            )
15914        }
15915    }
15916
15917    fn parse_session_param_value(&mut self) -> Result<SessionParamValue, ParserError> {
15918        if self.parse_keyword(Keyword::ON) {
15919            Ok(SessionParamValue::On)
15920        } else if self.parse_keyword(Keyword::OFF) {
15921            Ok(SessionParamValue::Off)
15922        } else {
15923            self.expected_ref("ON or OFF", self.peek_token_ref())
15924        }
15925    }
15926
15927    /// Parse a `SHOW` statement and dispatch to specific SHOW handlers.
15928    pub fn parse_show(&mut self) -> Result<Statement, ParserError> {
15929        let terse = self.parse_keyword(Keyword::TERSE);
15930        let extended = self.parse_keyword(Keyword::EXTENDED);
15931        let full = self.parse_keyword(Keyword::FULL);
15932        let session = self.parse_keyword(Keyword::SESSION);
15933        let global = self.parse_keyword(Keyword::GLOBAL);
15934        let external = self.parse_keyword(Keyword::EXTERNAL);
15935        if self
15936            .parse_one_of_keywords(&[Keyword::COLUMNS, Keyword::FIELDS])
15937            .is_some()
15938        {
15939            Ok(self.parse_show_columns(extended, full)?)
15940        } else if self.parse_keyword(Keyword::TABLES) {
15941            Ok(self.parse_show_tables(terse, extended, full, external)?)
15942        } else if self.parse_keywords(&[Keyword::MATERIALIZED, Keyword::VIEWS]) {
15943            Ok(self.parse_show_views(terse, true)?)
15944        } else if self.parse_keyword(Keyword::VIEWS) {
15945            Ok(self.parse_show_views(terse, false)?)
15946        } else if self.parse_keyword(Keyword::FUNCTIONS) {
15947            Ok(self.parse_show_functions()?)
15948        } else if self.parse_keyword(Keyword::PROCESSLIST) {
15949            Ok(Statement::ShowProcessList { full })
15950        } else if extended || full {
15951            Err(ParserError::ParserError(
15952                "EXTENDED/FULL are not supported with this type of SHOW query".to_string(),
15953            ))
15954        } else if self.parse_one_of_keywords(&[Keyword::CREATE]).is_some() {
15955            Ok(self.parse_show_create()?)
15956        } else if self.parse_keyword(Keyword::COLLATION) {
15957            Ok(self.parse_show_collation()?)
15958        } else if self.parse_keyword(Keyword::VARIABLES)
15959            && dialect_of!(self is MySqlDialect | GenericDialect)
15960        {
15961            Ok(Statement::ShowVariables {
15962                filter: self.parse_show_statement_filter()?,
15963                session,
15964                global,
15965            })
15966        } else if self.parse_keyword(Keyword::STATUS)
15967            && dialect_of!(self is MySqlDialect | GenericDialect)
15968        {
15969            Ok(Statement::ShowStatus {
15970                filter: self.parse_show_statement_filter()?,
15971                session,
15972                global,
15973            })
15974        } else if self.parse_keyword(Keyword::CATALOGS) {
15975            self.parse_show_catalogs(terse)
15976        } else if self.parse_keyword(Keyword::DATABASES) {
15977            self.parse_show_databases(terse)
15978        } else if self.parse_keyword(Keyword::SCHEMAS) {
15979            self.parse_show_schemas(terse)
15980        } else if self.parse_keywords(&[Keyword::CHARACTER, Keyword::SET]) {
15981            self.parse_show_charset(false)
15982        } else if self.parse_keyword(Keyword::CHARSET) {
15983            self.parse_show_charset(true)
15984        } else {
15985            Ok(Statement::ShowVariable {
15986                variable: self.parse_identifiers()?,
15987            })
15988        }
15989    }
15990
15991    fn parse_show_charset(&mut self, is_shorthand: bool) -> Result<Statement, ParserError> {
15992        // parse one of keywords
15993        Ok(Statement::ShowCharset(ShowCharset {
15994            is_shorthand,
15995            filter: self.parse_show_statement_filter()?,
15996        }))
15997    }
15998
15999    fn parse_show_catalogs(&mut self, terse: bool) -> Result<Statement, ParserError> {
16000        let history = self.parse_keyword(Keyword::HISTORY);
16001        let show_options = self.parse_show_stmt_options()?;
16002        Ok(Statement::ShowCatalogs {
16003            terse,
16004            history,
16005            show_options,
16006        })
16007    }
16008
16009    fn parse_show_databases(&mut self, terse: bool) -> Result<Statement, ParserError> {
16010        let history = self.parse_keyword(Keyword::HISTORY);
16011        let show_options = self.parse_show_stmt_options()?;
16012        Ok(Statement::ShowDatabases {
16013            terse,
16014            history,
16015            show_options,
16016        })
16017    }
16018
16019    fn parse_show_schemas(&mut self, terse: bool) -> Result<Statement, ParserError> {
16020        let history = self.parse_keyword(Keyword::HISTORY);
16021        let show_options = self.parse_show_stmt_options()?;
16022        Ok(Statement::ShowSchemas {
16023            terse,
16024            history,
16025            show_options,
16026        })
16027    }
16028
16029    /// Parse `SHOW CREATE <object>` returning the corresponding `ShowCreate` statement.
16030    pub fn parse_show_create(&mut self) -> Result<Statement, ParserError> {
16031        let obj_type = match self.expect_one_of_keywords(&[
16032            Keyword::TABLE,
16033            Keyword::TRIGGER,
16034            Keyword::FUNCTION,
16035            Keyword::PROCEDURE,
16036            Keyword::EVENT,
16037            Keyword::VIEW,
16038        ])? {
16039            Keyword::TABLE => Ok(ShowCreateObject::Table),
16040            Keyword::TRIGGER => Ok(ShowCreateObject::Trigger),
16041            Keyword::FUNCTION => Ok(ShowCreateObject::Function),
16042            Keyword::PROCEDURE => Ok(ShowCreateObject::Procedure),
16043            Keyword::EVENT => Ok(ShowCreateObject::Event),
16044            Keyword::VIEW => Ok(ShowCreateObject::View),
16045            keyword => Err(ParserError::ParserError(format!(
16046                "Unable to map keyword to ShowCreateObject: {keyword:?}"
16047            ))),
16048        }?;
16049
16050        let obj_name = self.parse_object_name(false)?;
16051
16052        Ok(Statement::ShowCreate { obj_type, obj_name })
16053    }
16054
16055    /// Parse `SHOW COLUMNS`/`SHOW FIELDS` and return a `ShowColumns` statement.
16056    pub fn parse_show_columns(
16057        &mut self,
16058        extended: bool,
16059        full: bool,
16060    ) -> Result<Statement, ParserError> {
16061        let show_options = self.parse_show_stmt_options()?;
16062        Ok(Statement::ShowColumns {
16063            extended,
16064            full,
16065            show_options,
16066        })
16067    }
16068
16069    fn parse_show_tables(
16070        &mut self,
16071        terse: bool,
16072        extended: bool,
16073        full: bool,
16074        external: bool,
16075    ) -> Result<Statement, ParserError> {
16076        let history = !external && self.parse_keyword(Keyword::HISTORY);
16077        let show_options = self.parse_show_stmt_options()?;
16078        Ok(Statement::ShowTables {
16079            terse,
16080            history,
16081            extended,
16082            full,
16083            external,
16084            show_options,
16085        })
16086    }
16087
16088    fn parse_show_views(
16089        &mut self,
16090        terse: bool,
16091        materialized: bool,
16092    ) -> Result<Statement, ParserError> {
16093        let show_options = self.parse_show_stmt_options()?;
16094        Ok(Statement::ShowViews {
16095            materialized,
16096            terse,
16097            show_options,
16098        })
16099    }
16100
16101    /// Parse `SHOW FUNCTIONS` and optional filter.
16102    pub fn parse_show_functions(&mut self) -> Result<Statement, ParserError> {
16103        let filter = self.parse_show_statement_filter()?;
16104        Ok(Statement::ShowFunctions { filter })
16105    }
16106
16107    /// Parse `SHOW COLLATION` and optional filter.
16108    pub fn parse_show_collation(&mut self) -> Result<Statement, ParserError> {
16109        let filter = self.parse_show_statement_filter()?;
16110        Ok(Statement::ShowCollation { filter })
16111    }
16112
16113    /// Parse an optional filter used by `SHOW` statements (LIKE, ILIKE, WHERE, or literal).
16114    pub fn parse_show_statement_filter(
16115        &mut self,
16116    ) -> Result<Option<ShowStatementFilter>, ParserError> {
16117        if self.parse_keyword(Keyword::LIKE) {
16118            Ok(Some(ShowStatementFilter::Like(
16119                self.parse_literal_string()?,
16120            )))
16121        } else if self.parse_keyword(Keyword::ILIKE) {
16122            Ok(Some(ShowStatementFilter::ILike(
16123                self.parse_literal_string()?,
16124            )))
16125        } else if self.parse_keyword(Keyword::WHERE) {
16126            Ok(Some(ShowStatementFilter::Where(self.parse_expr()?)))
16127        } else {
16128            self.maybe_parse(|parser| -> Result<String, ParserError> {
16129                parser.parse_literal_string()
16130            })?
16131            .map_or(Ok(None), |filter| {
16132                Ok(Some(ShowStatementFilter::NoKeyword(filter)))
16133            })
16134        }
16135    }
16136
16137    /// Parse a `USE` statement (database/catalog/schema/warehouse/role selection).
16138    pub fn parse_use(&mut self) -> Result<Statement, ParserError> {
16139        // Determine which keywords are recognized by the current dialect
16140        let parsed_keyword = if dialect_of!(self is HiveDialect) {
16141            // HiveDialect accepts USE DEFAULT; statement without any db specified
16142            if self.parse_keyword(Keyword::DEFAULT) {
16143                return Ok(Statement::Use(Use::Default));
16144            }
16145            None // HiveDialect doesn't expect any other specific keyword after `USE`
16146        } else if dialect_of!(self is DatabricksDialect) {
16147            self.parse_one_of_keywords(&[Keyword::CATALOG, Keyword::DATABASE, Keyword::SCHEMA])
16148        } else if dialect_of!(self is SnowflakeDialect) {
16149            self.parse_one_of_keywords(&[
16150                Keyword::DATABASE,
16151                Keyword::SCHEMA,
16152                Keyword::WAREHOUSE,
16153                Keyword::ROLE,
16154                Keyword::SECONDARY,
16155            ])
16156        } else {
16157            None // No specific keywords for other dialects, including GenericDialect
16158        };
16159
16160        let result = if matches!(parsed_keyword, Some(Keyword::SECONDARY)) {
16161            self.parse_secondary_roles()?
16162        } else {
16163            let obj_name = self.parse_object_name(false)?;
16164            match parsed_keyword {
16165                Some(Keyword::CATALOG) => Use::Catalog(obj_name),
16166                Some(Keyword::DATABASE) => Use::Database(obj_name),
16167                Some(Keyword::SCHEMA) => Use::Schema(obj_name),
16168                Some(Keyword::WAREHOUSE) => Use::Warehouse(obj_name),
16169                Some(Keyword::ROLE) => Use::Role(obj_name),
16170                _ => Use::Object(obj_name),
16171            }
16172        };
16173
16174        Ok(Statement::Use(result))
16175    }
16176
16177    fn parse_secondary_roles(&mut self) -> Result<Use, ParserError> {
16178        self.expect_one_of_keywords(&[Keyword::ROLES, Keyword::ROLE])?;
16179        if self.parse_keyword(Keyword::NONE) {
16180            Ok(Use::SecondaryRoles(SecondaryRoles::None))
16181        } else if self.parse_keyword(Keyword::ALL) {
16182            Ok(Use::SecondaryRoles(SecondaryRoles::All))
16183        } else {
16184            let roles = self.parse_comma_separated(|parser| parser.parse_identifier())?;
16185            Ok(Use::SecondaryRoles(SecondaryRoles::List(roles)))
16186        }
16187    }
16188
16189    /// Parse a table factor followed by any join clauses, returning `TableWithJoins`.
16190    pub fn parse_table_and_joins(&mut self) -> Result<TableWithJoins, ParserError> {
16191        let relation = self.parse_table_factor()?;
16192        // Note that for keywords to be properly handled here, they need to be
16193        // added to `RESERVED_FOR_TABLE_ALIAS`, otherwise they may be parsed as
16194        // a table alias.
16195        let joins = self.parse_joins()?;
16196        Ok(TableWithJoins { relation, joins })
16197    }
16198
16199    fn parse_joins(&mut self) -> Result<Vec<Join>, ParserError> {
16200        let mut joins = vec![];
16201        loop {
16202            let global = self.parse_keyword(Keyword::GLOBAL);
16203            let join = if self.parse_keyword(Keyword::CROSS) {
16204                let join_operator = if self.parse_keyword(Keyword::JOIN) {
16205                    JoinOperator::CrossJoin(JoinConstraint::None)
16206                } else if self.parse_keyword(Keyword::APPLY) {
16207                    // MSSQL extension, similar to CROSS JOIN LATERAL
16208                    JoinOperator::CrossApply
16209                } else {
16210                    return self.expected_ref("JOIN or APPLY after CROSS", self.peek_token_ref());
16211                };
16212                let relation = self.parse_table_factor()?;
16213                let join_operator = if matches!(join_operator, JoinOperator::CrossJoin(_))
16214                    && self.dialect.supports_cross_join_constraint()
16215                {
16216                    let constraint = self.parse_join_constraint(false)?;
16217                    JoinOperator::CrossJoin(constraint)
16218                } else {
16219                    join_operator
16220                };
16221                Join {
16222                    relation,
16223                    global,
16224                    join_operator,
16225                }
16226            } else if self.parse_keyword(Keyword::OUTER) {
16227                // MSSQL extension, similar to LEFT JOIN LATERAL .. ON 1=1
16228                self.expect_keyword_is(Keyword::APPLY)?;
16229                Join {
16230                    relation: self.parse_table_factor()?,
16231                    global,
16232                    join_operator: JoinOperator::OuterApply,
16233                }
16234            } else if self.parse_keyword(Keyword::ASOF) {
16235                self.expect_keyword_is(Keyword::JOIN)?;
16236                let relation = self.parse_table_factor()?;
16237                self.expect_keyword_is(Keyword::MATCH_CONDITION)?;
16238                let match_condition = self.parse_parenthesized(Self::parse_expr)?;
16239                Join {
16240                    relation,
16241                    global,
16242                    join_operator: JoinOperator::AsOf {
16243                        match_condition,
16244                        constraint: self.parse_join_constraint(false)?,
16245                    },
16246                }
16247            } else {
16248                let natural = self.parse_keyword(Keyword::NATURAL);
16249                let peek_keyword = if let Token::Word(w) = &self.peek_token_ref().token {
16250                    w.keyword
16251                } else {
16252                    Keyword::NoKeyword
16253                };
16254
16255                let join_operator_type = match peek_keyword {
16256                    Keyword::INNER | Keyword::JOIN => {
16257                        let inner = self.parse_keyword(Keyword::INNER); // [ INNER ]
16258                        self.expect_keyword_is(Keyword::JOIN)?;
16259                        if inner {
16260                            JoinOperator::Inner
16261                        } else {
16262                            JoinOperator::Join
16263                        }
16264                    }
16265                    kw @ Keyword::LEFT | kw @ Keyword::RIGHT => {
16266                        let _ = self.next_token(); // consume LEFT/RIGHT
16267                        let is_left = kw == Keyword::LEFT;
16268                        let join_type = self.parse_one_of_keywords(&[
16269                            Keyword::OUTER,
16270                            Keyword::SEMI,
16271                            Keyword::ANTI,
16272                            Keyword::JOIN,
16273                        ]);
16274                        match join_type {
16275                            Some(Keyword::OUTER) => {
16276                                self.expect_keyword_is(Keyword::JOIN)?;
16277                                if is_left {
16278                                    JoinOperator::LeftOuter
16279                                } else {
16280                                    JoinOperator::RightOuter
16281                                }
16282                            }
16283                            Some(Keyword::SEMI) => {
16284                                self.expect_keyword_is(Keyword::JOIN)?;
16285                                if is_left {
16286                                    JoinOperator::LeftSemi
16287                                } else {
16288                                    JoinOperator::RightSemi
16289                                }
16290                            }
16291                            Some(Keyword::ANTI) => {
16292                                self.expect_keyword_is(Keyword::JOIN)?;
16293                                if is_left {
16294                                    JoinOperator::LeftAnti
16295                                } else {
16296                                    JoinOperator::RightAnti
16297                                }
16298                            }
16299                            Some(Keyword::JOIN) => {
16300                                if is_left {
16301                                    JoinOperator::Left
16302                                } else {
16303                                    JoinOperator::Right
16304                                }
16305                            }
16306                            _ => {
16307                                return Err(ParserError::ParserError(format!(
16308                                    "expected OUTER, SEMI, ANTI or JOIN after {kw:?}"
16309                                )))
16310                            }
16311                        }
16312                    }
16313                    Keyword::ANTI => {
16314                        let _ = self.next_token(); // consume ANTI
16315                        self.expect_keyword_is(Keyword::JOIN)?;
16316                        JoinOperator::Anti
16317                    }
16318                    Keyword::SEMI => {
16319                        let _ = self.next_token(); // consume SEMI
16320                        self.expect_keyword_is(Keyword::JOIN)?;
16321                        JoinOperator::Semi
16322                    }
16323                    Keyword::FULL => {
16324                        let _ = self.next_token(); // consume FULL
16325                        let _ = self.parse_keyword(Keyword::OUTER); // [ OUTER ]
16326                        self.expect_keyword_is(Keyword::JOIN)?;
16327                        JoinOperator::FullOuter
16328                    }
16329                    Keyword::OUTER => {
16330                        return self.expected_ref("LEFT, RIGHT, or FULL", self.peek_token_ref());
16331                    }
16332                    Keyword::STRAIGHT_JOIN => {
16333                        let _ = self.next_token(); // consume STRAIGHT_JOIN
16334                        JoinOperator::StraightJoin
16335                    }
16336                    _ if natural => {
16337                        return self
16338                            .expected_ref("a join type after NATURAL", self.peek_token_ref());
16339                    }
16340                    _ => break,
16341                };
16342                let mut relation = self.parse_table_factor()?;
16343
16344                if !self
16345                    .dialect
16346                    .supports_left_associative_joins_without_parens()
16347                    && self.peek_parens_less_nested_join()
16348                {
16349                    let joins = self.parse_joins()?;
16350                    relation = TableFactor::NestedJoin {
16351                        table_with_joins: Box::new(TableWithJoins { relation, joins }),
16352                        alias: None,
16353                    };
16354                }
16355
16356                let join_constraint = self.parse_join_constraint(natural)?;
16357                Join {
16358                    relation,
16359                    global,
16360                    join_operator: join_operator_type(join_constraint),
16361                }
16362            };
16363            joins.push(join);
16364        }
16365        Ok(joins)
16366    }
16367
16368    fn peek_parens_less_nested_join(&self) -> bool {
16369        matches!(
16370            self.peek_token_ref().token,
16371            Token::Word(Word {
16372                keyword: Keyword::JOIN
16373                    | Keyword::INNER
16374                    | Keyword::LEFT
16375                    | Keyword::RIGHT
16376                    | Keyword::FULL,
16377                ..
16378            })
16379        )
16380    }
16381
16382    /// A table name or a parenthesized subquery, followed by optional `[AS] alias`
16383    #[cfg_attr(feature = "recursive-protection", recursive::recursive)]
16384    pub fn parse_table_factor(&mut self) -> Result<TableFactor, ParserError> {
16385        let _guard = self.recursion_counter.try_decrease()?;
16386        if self.parse_keyword(Keyword::LATERAL) {
16387            // LATERAL must always be followed by a subquery or table function.
16388            if self.consume_token(&Token::LParen) {
16389                self.parse_derived_table_factor(Lateral)
16390            } else {
16391                let name = self.parse_object_name(false)?;
16392                self.expect_token(&Token::LParen)?;
16393                let args = self.parse_optional_args()?;
16394                let alias = self.maybe_parse_table_alias()?;
16395                Ok(TableFactor::Function {
16396                    lateral: true,
16397                    name,
16398                    args,
16399                    alias,
16400                })
16401            }
16402        } else if self.parse_keyword(Keyword::TABLE) {
16403            // parse table function (SELECT * FROM TABLE (<expr>) [ AS <alias> ])
16404            self.expect_token(&Token::LParen)?;
16405            let expr = self.parse_expr()?;
16406            self.expect_token(&Token::RParen)?;
16407            let alias = self.maybe_parse_table_alias()?;
16408            Ok(TableFactor::TableFunction { expr, alias })
16409        } else if self.consume_token(&Token::LParen) {
16410            // A left paren introduces either a derived table (i.e., a subquery)
16411            // or a nested join. It's nearly impossible to determine ahead of
16412            // time which it is... so we just try to parse both.
16413            //
16414            // Here's an example that demonstrates the complexity:
16415            //                     /-------------------------------------------------------\
16416            //                     | /-----------------------------------\                 |
16417            //     SELECT * FROM ( ( ( (SELECT 1) UNION (SELECT 2) ) AS t1 NATURAL JOIN t2 ) )
16418            //                   ^ ^ ^ ^
16419            //                   | | | |
16420            //                   | | | |
16421            //                   | | | (4) belongs to a SetExpr::Query inside the subquery
16422            //                   | | (3) starts a derived table (subquery)
16423            //                   | (2) starts a nested join
16424            //                   (1) an additional set of parens around a nested join
16425            //
16426
16427            // If the recently consumed '(' starts a derived table, the call to
16428            // `parse_derived_table_factor` below will return success after parsing the
16429            // subquery, followed by the closing ')', and the alias of the derived table.
16430            // In the example above this is case (3).
16431            if let Some(mut table) =
16432                self.maybe_parse(|parser| parser.parse_derived_table_factor(NotLateral))?
16433            {
16434                while let Some(kw) = self.parse_one_of_keywords(&[Keyword::PIVOT, Keyword::UNPIVOT])
16435                {
16436                    table = match kw {
16437                        Keyword::PIVOT => self.parse_pivot_table_factor(table)?,
16438                        Keyword::UNPIVOT => self.parse_unpivot_table_factor(table)?,
16439                        unexpected_keyword => return Err(ParserError::ParserError(
16440                            format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in pivot/unpivot"),
16441                        )),
16442                    }
16443                }
16444                return Ok(table);
16445            }
16446
16447            // A parsing error from `parse_derived_table_factor` indicates that the '(' we've
16448            // recently consumed does not start a derived table (cases 1, 2, or 4).
16449            // `maybe_parse` will ignore such an error and rewind to be after the opening '('.
16450
16451            // Inside the parentheses we expect to find an (A) table factor
16452            // followed by some joins or (B) another level of nesting.
16453            let mut table_and_joins = self.parse_table_and_joins()?;
16454
16455            #[allow(clippy::if_same_then_else)]
16456            if !table_and_joins.joins.is_empty() {
16457                self.expect_token(&Token::RParen)?;
16458                let alias = self.maybe_parse_table_alias()?;
16459                Ok(TableFactor::NestedJoin {
16460                    table_with_joins: Box::new(table_and_joins),
16461                    alias,
16462                }) // (A)
16463            } else if let TableFactor::NestedJoin {
16464                table_with_joins: _,
16465                alias: _,
16466            } = &table_and_joins.relation
16467            {
16468                // (B): `table_and_joins` (what we found inside the parentheses)
16469                // is a nested join `(foo JOIN bar)`, not followed by other joins.
16470                self.expect_token(&Token::RParen)?;
16471                let alias = self.maybe_parse_table_alias()?;
16472                Ok(TableFactor::NestedJoin {
16473                    table_with_joins: Box::new(table_and_joins),
16474                    alias,
16475                })
16476            } else if self.dialect.supports_parens_around_table_factor() {
16477                // Dialect-specific behavior: Snowflake diverges from the
16478                // standard and from most of the other implementations by
16479                // allowing extra parentheses not only around a join (B), but
16480                // around lone table names (e.g. `FROM (mytable [AS alias])`)
16481                // and around derived tables (e.g. `FROM ((SELECT ...)
16482                // [AS alias])`) as well.
16483                self.expect_token(&Token::RParen)?;
16484
16485                if let Some(outer_alias) = self.maybe_parse_table_alias()? {
16486                    // Snowflake also allows specifying an alias *after* parens
16487                    // e.g. `FROM (mytable) AS alias`
16488                    match &mut table_and_joins.relation {
16489                        TableFactor::Derived { alias, .. }
16490                        | TableFactor::Table { alias, .. }
16491                        | TableFactor::Function { alias, .. }
16492                        | TableFactor::UNNEST { alias, .. }
16493                        | TableFactor::JsonTable { alias, .. }
16494                        | TableFactor::XmlTable { alias, .. }
16495                        | TableFactor::OpenJsonTable { alias, .. }
16496                        | TableFactor::TableFunction { alias, .. }
16497                        | TableFactor::Pivot { alias, .. }
16498                        | TableFactor::Unpivot { alias, .. }
16499                        | TableFactor::MatchRecognize { alias, .. }
16500                        | TableFactor::SemanticView { alias, .. }
16501                        | TableFactor::NestedJoin { alias, .. } => {
16502                            // but not `FROM (mytable AS alias1) AS alias2`.
16503                            if let Some(inner_alias) = alias {
16504                                return Err(ParserError::ParserError(format!(
16505                                    "duplicate alias {inner_alias}"
16506                                )));
16507                            }
16508                            // Act as if the alias was specified normally next
16509                            // to the table name: `(mytable) AS alias` ->
16510                            // `(mytable AS alias)`
16511                            alias.replace(outer_alias);
16512                        }
16513                    };
16514                }
16515                // Do not store the extra set of parens in the AST
16516                Ok(table_and_joins.relation)
16517            } else {
16518                // The SQL spec prohibits derived tables and bare tables from
16519                // appearing alone in parentheses (e.g. `FROM (mytable)`)
16520                self.expected_ref("joined table", self.peek_token_ref())
16521            }
16522        } else if self.dialect.supports_values_as_table_factor()
16523            && matches!(
16524                self.peek_tokens(),
16525                [
16526                    Token::Word(Word {
16527                        keyword: Keyword::VALUES,
16528                        ..
16529                    }),
16530                    Token::LParen
16531                ]
16532            )
16533        {
16534            self.expect_keyword_is(Keyword::VALUES)?;
16535
16536            // Snowflake and Databricks allow syntax like below:
16537            // SELECT * FROM VALUES (1, 'a'), (2, 'b') AS t (col1, col2)
16538            // where there are no parentheses around the VALUES clause.
16539            let values = SetExpr::Values(self.parse_values(false, false)?);
16540            let alias = self.maybe_parse_table_alias()?;
16541            Ok(TableFactor::Derived {
16542                lateral: false,
16543                subquery: Box::new(Query {
16544                    with: None,
16545                    body: Box::new(values),
16546                    order_by: None,
16547                    limit_clause: None,
16548                    fetch: None,
16549                    locks: vec![],
16550                    for_clause: None,
16551                    settings: None,
16552                    format_clause: None,
16553                    pipe_operators: vec![],
16554                }),
16555                alias,
16556                sample: None,
16557            })
16558        } else if dialect_of!(self is BigQueryDialect | PostgreSqlDialect | GenericDialect)
16559            && self.parse_keyword(Keyword::UNNEST)
16560        {
16561            self.expect_token(&Token::LParen)?;
16562            let array_exprs = self.parse_comma_separated(Parser::parse_expr)?;
16563            self.expect_token(&Token::RParen)?;
16564
16565            let with_ordinality = self.parse_keywords(&[Keyword::WITH, Keyword::ORDINALITY]);
16566            let alias = match self.maybe_parse_table_alias() {
16567                Ok(Some(alias)) => Some(alias),
16568                Ok(None) => None,
16569                Err(e) => return Err(e),
16570            };
16571
16572            let with_offset = match self.expect_keywords(&[Keyword::WITH, Keyword::OFFSET]) {
16573                Ok(()) => true,
16574                Err(_) => false,
16575            };
16576
16577            let with_offset_alias = if with_offset {
16578                match self.parse_optional_alias(keywords::RESERVED_FOR_COLUMN_ALIAS) {
16579                    Ok(Some(alias)) => Some(alias),
16580                    Ok(None) => None,
16581                    Err(e) => return Err(e),
16582                }
16583            } else {
16584                None
16585            };
16586
16587            Ok(TableFactor::UNNEST {
16588                alias,
16589                array_exprs,
16590                with_offset,
16591                with_offset_alias,
16592                with_ordinality,
16593            })
16594        } else if self.parse_keyword_with_tokens(Keyword::JSON_TABLE, &[Token::LParen]) {
16595            let json_expr = self.parse_expr()?;
16596            self.expect_token(&Token::Comma)?;
16597            let json_path = self.parse_value()?;
16598            self.expect_keyword_is(Keyword::COLUMNS)?;
16599            self.expect_token(&Token::LParen)?;
16600            let columns = self.parse_comma_separated(Parser::parse_json_table_column_def)?;
16601            self.expect_token(&Token::RParen)?;
16602            self.expect_token(&Token::RParen)?;
16603            let alias = self.maybe_parse_table_alias()?;
16604            Ok(TableFactor::JsonTable {
16605                json_expr,
16606                json_path,
16607                columns,
16608                alias,
16609            })
16610        } else if self.parse_keyword_with_tokens(Keyword::OPENJSON, &[Token::LParen]) {
16611            self.prev_token();
16612            self.parse_open_json_table_factor()
16613        } else if self.parse_keyword_with_tokens(Keyword::XMLTABLE, &[Token::LParen]) {
16614            self.prev_token();
16615            self.parse_xml_table_factor()
16616        } else if self.dialect.supports_semantic_view_table_factor()
16617            && self.peek_keyword_with_tokens(Keyword::SEMANTIC_VIEW, &[Token::LParen])
16618        {
16619            self.parse_semantic_view_table_factor()
16620        } else if self.peek_token_ref().token == Token::AtSign {
16621            // Stage reference: @mystage or @namespace.stage (e.g. Snowflake)
16622            self.parse_snowflake_stage_table_factor()
16623        } else {
16624            let name = self.parse_object_name(true)?;
16625
16626            let json_path = match &self.peek_token_ref().token {
16627                Token::LBracket if self.dialect.supports_partiql() => Some(self.parse_json_path()?),
16628                _ => None,
16629            };
16630
16631            let partitions: Vec<Ident> = if dialect_of!(self is MySqlDialect | GenericDialect)
16632                && self.parse_keyword(Keyword::PARTITION)
16633            {
16634                self.parse_parenthesized_identifiers()?
16635            } else {
16636                vec![]
16637            };
16638
16639            // Parse potential version qualifier
16640            let version = self.maybe_parse_table_version()?;
16641
16642            // Postgres, MSSQL, ClickHouse: table-valued functions:
16643            let args = if self.consume_token(&Token::LParen) {
16644                Some(self.parse_table_function_args()?)
16645            } else {
16646                None
16647            };
16648
16649            let with_ordinality = self.parse_keywords(&[Keyword::WITH, Keyword::ORDINALITY]);
16650
16651            let mut sample = None;
16652            if self.dialect.supports_table_sample_before_alias() {
16653                if let Some(parsed_sample) = self.maybe_parse_table_sample()? {
16654                    sample = Some(TableSampleKind::BeforeTableAlias(parsed_sample));
16655                }
16656            }
16657
16658            let alias = self.maybe_parse_table_alias()?;
16659
16660            // MYSQL-specific table hints:
16661            let index_hints = if self.dialect.supports_table_hints() {
16662                self.maybe_parse(|p| p.parse_table_index_hints())?
16663                    .unwrap_or(vec![])
16664            } else {
16665                vec![]
16666            };
16667
16668            // MSSQL-specific table hints:
16669            let mut with_hints = vec![];
16670            if self.parse_keyword(Keyword::WITH) {
16671                if self.consume_token(&Token::LParen) {
16672                    with_hints = self.parse_comma_separated(Parser::parse_expr)?;
16673                    self.expect_token(&Token::RParen)?;
16674                } else {
16675                    // rewind, as WITH may belong to the next statement's CTE
16676                    self.prev_token();
16677                }
16678            };
16679
16680            if !self.dialect.supports_table_sample_before_alias() {
16681                if let Some(parsed_sample) = self.maybe_parse_table_sample()? {
16682                    sample = Some(TableSampleKind::AfterTableAlias(parsed_sample));
16683                }
16684            }
16685
16686            let mut table = TableFactor::Table {
16687                name,
16688                alias,
16689                args,
16690                with_hints,
16691                version,
16692                partitions,
16693                with_ordinality,
16694                json_path,
16695                sample,
16696                index_hints,
16697            };
16698
16699            while let Some(kw) = self.parse_one_of_keywords(&[Keyword::PIVOT, Keyword::UNPIVOT]) {
16700                table = match kw {
16701                    Keyword::PIVOT => self.parse_pivot_table_factor(table)?,
16702                    Keyword::UNPIVOT => self.parse_unpivot_table_factor(table)?,
16703                    unexpected_keyword => return Err(ParserError::ParserError(
16704                        format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in pivot/unpivot"),
16705                    )),
16706                }
16707            }
16708
16709            if self.dialect.supports_match_recognize()
16710                && self.parse_keyword(Keyword::MATCH_RECOGNIZE)
16711            {
16712                table = self.parse_match_recognize(table)?;
16713            }
16714
16715            Ok(table)
16716        }
16717    }
16718
16719    /// Parse a Snowflake stage reference as a table factor.
16720    /// Handles syntax like: `@mystage1 (file_format => 'myformat', pattern => '...')`
16721    ///
16722    /// See: <https://docs.snowflake.com/en/user-guide/querying-stage>
16723    fn parse_snowflake_stage_table_factor(&mut self) -> Result<TableFactor, ParserError> {
16724        // Parse the stage name starting with @
16725        let name = crate::dialect::parse_snowflake_stage_name(self)?;
16726
16727        // Parse optional stage options like (file_format => 'myformat', pattern => '...')
16728        let args = if self.consume_token(&Token::LParen) {
16729            Some(self.parse_table_function_args()?)
16730        } else {
16731            None
16732        };
16733
16734        let alias = self.maybe_parse_table_alias()?;
16735
16736        Ok(TableFactor::Table {
16737            name,
16738            alias,
16739            args,
16740            with_hints: vec![],
16741            version: None,
16742            partitions: vec![],
16743            with_ordinality: false,
16744            json_path: None,
16745            sample: None,
16746            index_hints: vec![],
16747        })
16748    }
16749
16750    fn maybe_parse_table_sample(&mut self) -> Result<Option<Box<TableSample>>, ParserError> {
16751        let modifier = if self.parse_keyword(Keyword::TABLESAMPLE) {
16752            TableSampleModifier::TableSample
16753        } else if self.parse_keyword(Keyword::SAMPLE) {
16754            TableSampleModifier::Sample
16755        } else {
16756            return Ok(None);
16757        };
16758        self.parse_table_sample(modifier).map(Some)
16759    }
16760
16761    fn parse_table_sample(
16762        &mut self,
16763        modifier: TableSampleModifier,
16764    ) -> Result<Box<TableSample>, ParserError> {
16765        let name = match self.parse_one_of_keywords(&[
16766            Keyword::BERNOULLI,
16767            Keyword::ROW,
16768            Keyword::SYSTEM,
16769            Keyword::BLOCK,
16770        ]) {
16771            Some(Keyword::BERNOULLI) => Some(TableSampleMethod::Bernoulli),
16772            Some(Keyword::ROW) => Some(TableSampleMethod::Row),
16773            Some(Keyword::SYSTEM) => Some(TableSampleMethod::System),
16774            Some(Keyword::BLOCK) => Some(TableSampleMethod::Block),
16775            _ => None,
16776        };
16777
16778        let parenthesized = self.consume_token(&Token::LParen);
16779
16780        let (quantity, bucket) = if parenthesized && self.parse_keyword(Keyword::BUCKET) {
16781            let selected_bucket = self.parse_number_value()?;
16782            self.expect_keywords(&[Keyword::OUT, Keyword::OF])?;
16783            let total = self.parse_number_value()?;
16784            let on = if self.parse_keyword(Keyword::ON) {
16785                Some(self.parse_expr()?)
16786            } else {
16787                None
16788            };
16789            (
16790                None,
16791                Some(TableSampleBucket {
16792                    bucket: selected_bucket,
16793                    total,
16794                    on,
16795                }),
16796            )
16797        } else {
16798            let value = match self.maybe_parse(|p| p.parse_expr())? {
16799                Some(num) => num,
16800                None => {
16801                    let next_token = self.next_token();
16802                    if let Token::Word(w) = next_token.token {
16803                        Expr::Value(Value::Placeholder(w.value).with_span(next_token.span))
16804                    } else {
16805                        return parser_err!(
16806                            "Expecting number or byte length e.g. 100M",
16807                            self.peek_token_ref().span.start
16808                        );
16809                    }
16810                }
16811            };
16812            let unit = if self.parse_keyword(Keyword::ROWS) {
16813                Some(TableSampleUnit::Rows)
16814            } else if self.parse_keyword(Keyword::PERCENT) {
16815                Some(TableSampleUnit::Percent)
16816            } else {
16817                None
16818            };
16819            (
16820                Some(TableSampleQuantity {
16821                    parenthesized,
16822                    value,
16823                    unit,
16824                }),
16825                None,
16826            )
16827        };
16828        if parenthesized {
16829            self.expect_token(&Token::RParen)?;
16830        }
16831
16832        let seed = if self.parse_keyword(Keyword::REPEATABLE) {
16833            Some(self.parse_table_sample_seed(TableSampleSeedModifier::Repeatable)?)
16834        } else if self.parse_keyword(Keyword::SEED) {
16835            Some(self.parse_table_sample_seed(TableSampleSeedModifier::Seed)?)
16836        } else {
16837            None
16838        };
16839
16840        let offset = if self.parse_keyword(Keyword::OFFSET) {
16841            Some(self.parse_expr()?)
16842        } else {
16843            None
16844        };
16845
16846        Ok(Box::new(TableSample {
16847            modifier,
16848            name,
16849            quantity,
16850            seed,
16851            bucket,
16852            offset,
16853        }))
16854    }
16855
16856    fn parse_table_sample_seed(
16857        &mut self,
16858        modifier: TableSampleSeedModifier,
16859    ) -> Result<TableSampleSeed, ParserError> {
16860        self.expect_token(&Token::LParen)?;
16861        let value = self.parse_number_value()?;
16862        self.expect_token(&Token::RParen)?;
16863        Ok(TableSampleSeed { modifier, value })
16864    }
16865
16866    /// Parses `OPENJSON( jsonExpression [ , path ] )  [ <with_clause> ]` clause,
16867    /// assuming the `OPENJSON` keyword was already consumed.
16868    fn parse_open_json_table_factor(&mut self) -> Result<TableFactor, ParserError> {
16869        self.expect_token(&Token::LParen)?;
16870        let json_expr = self.parse_expr()?;
16871        let json_path = if self.consume_token(&Token::Comma) {
16872            Some(self.parse_value()?)
16873        } else {
16874            None
16875        };
16876        self.expect_token(&Token::RParen)?;
16877        let columns = if self.parse_keyword(Keyword::WITH) {
16878            self.expect_token(&Token::LParen)?;
16879            let columns = self.parse_comma_separated(Parser::parse_openjson_table_column_def)?;
16880            self.expect_token(&Token::RParen)?;
16881            columns
16882        } else {
16883            Vec::new()
16884        };
16885        let alias = self.maybe_parse_table_alias()?;
16886        Ok(TableFactor::OpenJsonTable {
16887            json_expr,
16888            json_path,
16889            columns,
16890            alias,
16891        })
16892    }
16893
16894    fn parse_xml_table_factor(&mut self) -> Result<TableFactor, ParserError> {
16895        self.expect_token(&Token::LParen)?;
16896        let namespaces = if self.parse_keyword(Keyword::XMLNAMESPACES) {
16897            self.expect_token(&Token::LParen)?;
16898            let namespaces = self.parse_comma_separated(Parser::parse_xml_namespace_definition)?;
16899            self.expect_token(&Token::RParen)?;
16900            self.expect_token(&Token::Comma)?;
16901            namespaces
16902        } else {
16903            vec![]
16904        };
16905        let row_expression = self.parse_expr()?;
16906        let passing = self.parse_xml_passing_clause()?;
16907        self.expect_keyword_is(Keyword::COLUMNS)?;
16908        let columns = self.parse_comma_separated(Parser::parse_xml_table_column)?;
16909        self.expect_token(&Token::RParen)?;
16910        let alias = self.maybe_parse_table_alias()?;
16911        Ok(TableFactor::XmlTable {
16912            namespaces,
16913            row_expression,
16914            passing,
16915            columns,
16916            alias,
16917        })
16918    }
16919
16920    fn parse_xml_namespace_definition(&mut self) -> Result<XmlNamespaceDefinition, ParserError> {
16921        let uri = self.parse_expr()?;
16922        self.expect_keyword_is(Keyword::AS)?;
16923        let name = self.parse_identifier()?;
16924        Ok(XmlNamespaceDefinition { uri, name })
16925    }
16926
16927    fn parse_xml_table_column(&mut self) -> Result<XmlTableColumn, ParserError> {
16928        let name = self.parse_identifier()?;
16929
16930        let option = if self.parse_keyword(Keyword::FOR) {
16931            self.expect_keyword(Keyword::ORDINALITY)?;
16932            XmlTableColumnOption::ForOrdinality
16933        } else {
16934            let r#type = self.parse_data_type()?;
16935            let mut path = None;
16936            let mut default = None;
16937
16938            if self.parse_keyword(Keyword::PATH) {
16939                path = Some(self.parse_expr()?);
16940            }
16941
16942            if self.parse_keyword(Keyword::DEFAULT) {
16943                default = Some(self.parse_expr()?);
16944            }
16945
16946            let not_null = self.parse_keywords(&[Keyword::NOT, Keyword::NULL]);
16947            if !not_null {
16948                // NULL is the default but can be specified explicitly
16949                let _ = self.parse_keyword(Keyword::NULL);
16950            }
16951
16952            XmlTableColumnOption::NamedInfo {
16953                r#type,
16954                path,
16955                default,
16956                nullable: !not_null,
16957            }
16958        };
16959        Ok(XmlTableColumn { name, option })
16960    }
16961
16962    fn parse_xml_passing_clause(&mut self) -> Result<XmlPassingClause, ParserError> {
16963        let mut arguments = vec![];
16964        if self.parse_keyword(Keyword::PASSING) {
16965            loop {
16966                let by_value =
16967                    self.parse_keyword(Keyword::BY) && self.expect_keyword(Keyword::VALUE).is_ok();
16968                let expr = self.parse_expr()?;
16969                let alias = if self.parse_keyword(Keyword::AS) {
16970                    Some(self.parse_identifier()?)
16971                } else {
16972                    None
16973                };
16974                arguments.push(XmlPassingArgument {
16975                    expr,
16976                    alias,
16977                    by_value,
16978                });
16979                if !self.consume_token(&Token::Comma) {
16980                    break;
16981                }
16982            }
16983        }
16984        Ok(XmlPassingClause { arguments })
16985    }
16986
16987    /// Parse a [TableFactor::SemanticView]
16988    fn parse_semantic_view_table_factor(&mut self) -> Result<TableFactor, ParserError> {
16989        self.expect_keyword(Keyword::SEMANTIC_VIEW)?;
16990        self.expect_token(&Token::LParen)?;
16991
16992        let name = self.parse_object_name(true)?;
16993
16994        // Parse DIMENSIONS, METRICS, FACTS and WHERE clauses in flexible order
16995        let mut dimensions = Vec::new();
16996        let mut metrics = Vec::new();
16997        let mut facts = Vec::new();
16998        let mut where_clause = None;
16999
17000        while self.peek_token_ref().token != Token::RParen {
17001            if self.parse_keyword(Keyword::DIMENSIONS) {
17002                if !dimensions.is_empty() {
17003                    return Err(ParserError::ParserError(
17004                        "DIMENSIONS clause can only be specified once".to_string(),
17005                    ));
17006                }
17007                dimensions = self.parse_comma_separated(Parser::parse_wildcard_expr)?;
17008            } else if self.parse_keyword(Keyword::METRICS) {
17009                if !metrics.is_empty() {
17010                    return Err(ParserError::ParserError(
17011                        "METRICS clause can only be specified once".to_string(),
17012                    ));
17013                }
17014                metrics = self.parse_comma_separated(Parser::parse_wildcard_expr)?;
17015            } else if self.parse_keyword(Keyword::FACTS) {
17016                if !facts.is_empty() {
17017                    return Err(ParserError::ParserError(
17018                        "FACTS clause can only be specified once".to_string(),
17019                    ));
17020                }
17021                facts = self.parse_comma_separated(Parser::parse_wildcard_expr)?;
17022            } else if self.parse_keyword(Keyword::WHERE) {
17023                if where_clause.is_some() {
17024                    return Err(ParserError::ParserError(
17025                        "WHERE clause can only be specified once".to_string(),
17026                    ));
17027                }
17028                where_clause = Some(self.parse_expr()?);
17029            } else {
17030                let tok = self.peek_token_ref();
17031                return parser_err!(
17032                    format!(
17033                        "Expected one of DIMENSIONS, METRICS, FACTS or WHERE, got {}",
17034                        tok.token
17035                    ),
17036                    tok.span.start
17037                )?;
17038            }
17039        }
17040
17041        self.expect_token(&Token::RParen)?;
17042
17043        let alias = self.maybe_parse_table_alias()?;
17044
17045        Ok(TableFactor::SemanticView {
17046            name,
17047            dimensions,
17048            metrics,
17049            facts,
17050            where_clause,
17051            alias,
17052        })
17053    }
17054
17055    fn parse_match_recognize(&mut self, table: TableFactor) -> Result<TableFactor, ParserError> {
17056        self.expect_token(&Token::LParen)?;
17057
17058        let partition_by = if self.parse_keywords(&[Keyword::PARTITION, Keyword::BY]) {
17059            self.parse_comma_separated(Parser::parse_expr)?
17060        } else {
17061            vec![]
17062        };
17063
17064        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
17065            self.parse_comma_separated(Parser::parse_order_by_expr)?
17066        } else {
17067            vec![]
17068        };
17069
17070        let measures = if self.parse_keyword(Keyword::MEASURES) {
17071            self.parse_comma_separated(|p| {
17072                let expr = p.parse_expr()?;
17073                let _ = p.parse_keyword(Keyword::AS);
17074                let alias = p.parse_identifier()?;
17075                Ok(Measure { expr, alias })
17076            })?
17077        } else {
17078            vec![]
17079        };
17080
17081        let rows_per_match =
17082            if self.parse_keywords(&[Keyword::ONE, Keyword::ROW, Keyword::PER, Keyword::MATCH]) {
17083                Some(RowsPerMatch::OneRow)
17084            } else if self.parse_keywords(&[
17085                Keyword::ALL,
17086                Keyword::ROWS,
17087                Keyword::PER,
17088                Keyword::MATCH,
17089            ]) {
17090                Some(RowsPerMatch::AllRows(
17091                    if self.parse_keywords(&[Keyword::SHOW, Keyword::EMPTY, Keyword::MATCHES]) {
17092                        Some(EmptyMatchesMode::Show)
17093                    } else if self.parse_keywords(&[
17094                        Keyword::OMIT,
17095                        Keyword::EMPTY,
17096                        Keyword::MATCHES,
17097                    ]) {
17098                        Some(EmptyMatchesMode::Omit)
17099                    } else if self.parse_keywords(&[
17100                        Keyword::WITH,
17101                        Keyword::UNMATCHED,
17102                        Keyword::ROWS,
17103                    ]) {
17104                        Some(EmptyMatchesMode::WithUnmatched)
17105                    } else {
17106                        None
17107                    },
17108                ))
17109            } else {
17110                None
17111            };
17112
17113        let after_match_skip =
17114            if self.parse_keywords(&[Keyword::AFTER, Keyword::MATCH, Keyword::SKIP]) {
17115                if self.parse_keywords(&[Keyword::PAST, Keyword::LAST, Keyword::ROW]) {
17116                    Some(AfterMatchSkip::PastLastRow)
17117                } else if self.parse_keywords(&[Keyword::TO, Keyword::NEXT, Keyword::ROW]) {
17118                    Some(AfterMatchSkip::ToNextRow)
17119                } else if self.parse_keywords(&[Keyword::TO, Keyword::FIRST]) {
17120                    Some(AfterMatchSkip::ToFirst(self.parse_identifier()?))
17121                } else if self.parse_keywords(&[Keyword::TO, Keyword::LAST]) {
17122                    Some(AfterMatchSkip::ToLast(self.parse_identifier()?))
17123                } else {
17124                    let found = self.next_token();
17125                    return self.expected("after match skip option", found);
17126                }
17127            } else {
17128                None
17129            };
17130
17131        self.expect_keyword_is(Keyword::PATTERN)?;
17132        let pattern = self.parse_parenthesized(Self::parse_pattern)?;
17133
17134        self.expect_keyword_is(Keyword::DEFINE)?;
17135
17136        let symbols = self.parse_comma_separated(|p| {
17137            let symbol = p.parse_identifier()?;
17138            p.expect_keyword_is(Keyword::AS)?;
17139            let definition = p.parse_expr()?;
17140            Ok(SymbolDefinition { symbol, definition })
17141        })?;
17142
17143        self.expect_token(&Token::RParen)?;
17144
17145        let alias = self.maybe_parse_table_alias()?;
17146
17147        Ok(TableFactor::MatchRecognize {
17148            table: Box::new(table),
17149            partition_by,
17150            order_by,
17151            measures,
17152            rows_per_match,
17153            after_match_skip,
17154            pattern,
17155            symbols,
17156            alias,
17157        })
17158    }
17159
17160    fn parse_base_pattern(&mut self) -> Result<MatchRecognizePattern, ParserError> {
17161        match self.next_token().token {
17162            Token::Caret => Ok(MatchRecognizePattern::Symbol(MatchRecognizeSymbol::Start)),
17163            Token::Placeholder(s) if s == "$" => {
17164                Ok(MatchRecognizePattern::Symbol(MatchRecognizeSymbol::End))
17165            }
17166            Token::LBrace => {
17167                self.expect_token(&Token::Minus)?;
17168                let symbol = self.parse_identifier().map(MatchRecognizeSymbol::Named)?;
17169                self.expect_token(&Token::Minus)?;
17170                self.expect_token(&Token::RBrace)?;
17171                Ok(MatchRecognizePattern::Exclude(symbol))
17172            }
17173            Token::Word(Word {
17174                value,
17175                quote_style: None,
17176                ..
17177            }) if value == "PERMUTE" => {
17178                self.expect_token(&Token::LParen)?;
17179                let symbols = self.parse_comma_separated(|p| {
17180                    p.parse_identifier().map(MatchRecognizeSymbol::Named)
17181                })?;
17182                self.expect_token(&Token::RParen)?;
17183                Ok(MatchRecognizePattern::Permute(symbols))
17184            }
17185            Token::LParen => {
17186                let pattern = self.parse_pattern()?;
17187                self.expect_token(&Token::RParen)?;
17188                Ok(MatchRecognizePattern::Group(Box::new(pattern)))
17189            }
17190            _ => {
17191                self.prev_token();
17192                self.parse_identifier()
17193                    .map(MatchRecognizeSymbol::Named)
17194                    .map(MatchRecognizePattern::Symbol)
17195            }
17196        }
17197    }
17198
17199    fn parse_repetition_pattern(&mut self) -> Result<MatchRecognizePattern, ParserError> {
17200        let mut pattern = self.parse_base_pattern()?;
17201        loop {
17202            let token = self.next_token();
17203            let quantifier = match token.token {
17204                Token::Mul => RepetitionQuantifier::ZeroOrMore,
17205                Token::Plus => RepetitionQuantifier::OneOrMore,
17206                Token::Placeholder(s) if s == "?" => RepetitionQuantifier::AtMostOne,
17207                Token::LBrace => {
17208                    // quantifier is a range like {n} or {n,} or {,m} or {n,m}
17209                    let token = self.next_token();
17210                    match token.token {
17211                        Token::Comma => {
17212                            let next_token = self.next_token();
17213                            let Token::Number(n, _) = next_token.token else {
17214                                return self.expected("literal number", next_token);
17215                            };
17216                            self.expect_token(&Token::RBrace)?;
17217                            RepetitionQuantifier::AtMost(Self::parse(n, token.span.start)?)
17218                        }
17219                        Token::Number(n, _) if self.consume_token(&Token::Comma) => {
17220                            let next_token = self.next_token();
17221                            match next_token.token {
17222                                Token::Number(m, _) => {
17223                                    self.expect_token(&Token::RBrace)?;
17224                                    RepetitionQuantifier::Range(
17225                                        Self::parse(n, token.span.start)?,
17226                                        Self::parse(m, token.span.start)?,
17227                                    )
17228                                }
17229                                Token::RBrace => {
17230                                    RepetitionQuantifier::AtLeast(Self::parse(n, token.span.start)?)
17231                                }
17232                                _ => {
17233                                    return self.expected("} or upper bound", next_token);
17234                                }
17235                            }
17236                        }
17237                        Token::Number(n, _) => {
17238                            self.expect_token(&Token::RBrace)?;
17239                            RepetitionQuantifier::Exactly(Self::parse(n, token.span.start)?)
17240                        }
17241                        _ => return self.expected("quantifier range", token),
17242                    }
17243                }
17244                _ => {
17245                    self.prev_token();
17246                    break;
17247                }
17248            };
17249            pattern = MatchRecognizePattern::Repetition(Box::new(pattern), quantifier);
17250        }
17251        Ok(pattern)
17252    }
17253
17254    fn parse_concat_pattern(&mut self) -> Result<MatchRecognizePattern, ParserError> {
17255        let mut patterns = vec![self.parse_repetition_pattern()?];
17256        while !matches!(self.peek_token_ref().token, Token::RParen | Token::Pipe) {
17257            patterns.push(self.parse_repetition_pattern()?);
17258        }
17259        match <[MatchRecognizePattern; 1]>::try_from(patterns) {
17260            Ok([pattern]) => Ok(pattern),
17261            Err(patterns) => Ok(MatchRecognizePattern::Concat(patterns)),
17262        }
17263    }
17264
17265    fn parse_pattern(&mut self) -> Result<MatchRecognizePattern, ParserError> {
17266        let pattern = self.parse_concat_pattern()?;
17267        if self.consume_token(&Token::Pipe) {
17268            match self.parse_pattern()? {
17269                // flatten nested alternations
17270                MatchRecognizePattern::Alternation(mut patterns) => {
17271                    patterns.insert(0, pattern);
17272                    Ok(MatchRecognizePattern::Alternation(patterns))
17273                }
17274                next => Ok(MatchRecognizePattern::Alternation(vec![pattern, next])),
17275            }
17276        } else {
17277            Ok(pattern)
17278        }
17279    }
17280
17281    /// Parses a the timestamp version specifier (i.e. query historical data)
17282    pub fn maybe_parse_table_version(&mut self) -> Result<Option<TableVersion>, ParserError> {
17283        if self.dialect.supports_table_versioning() {
17284            if self.parse_keywords(&[Keyword::FOR, Keyword::SYSTEM_TIME, Keyword::AS, Keyword::OF])
17285            {
17286                let expr = self.parse_expr()?;
17287                return Ok(Some(TableVersion::ForSystemTimeAsOf(expr)));
17288            } else if self.peek_keyword(Keyword::CHANGES) {
17289                return self.parse_table_version_changes().map(Some);
17290            } else if self.peek_keyword(Keyword::AT) || self.peek_keyword(Keyword::BEFORE) {
17291                let func_name = self.parse_object_name(true)?;
17292                let func = self.parse_function(func_name)?;
17293                return Ok(Some(TableVersion::Function(func)));
17294            } else if self.parse_keywords(&[Keyword::TIMESTAMP, Keyword::AS, Keyword::OF]) {
17295                let expr = self.parse_expr()?;
17296                return Ok(Some(TableVersion::TimestampAsOf(expr)));
17297            } else if self.parse_keywords(&[Keyword::VERSION, Keyword::AS, Keyword::OF]) {
17298                let expr = Expr::Value(self.parse_number_value()?);
17299                return Ok(Some(TableVersion::VersionAsOf(expr)));
17300            }
17301        }
17302        Ok(None)
17303    }
17304
17305    /// Parses the Snowflake `CHANGES` clause for change tracking queries.
17306    ///
17307    /// Syntax:
17308    /// ```sql
17309    /// CHANGES (INFORMATION => DEFAULT)
17310    ///   AT (TIMESTAMP => <expr>)
17311    ///   [END (TIMESTAMP => <expr>)]
17312    /// ```
17313    ///
17314    /// <https://docs.snowflake.com/en/sql-reference/constructs/changes>
17315    fn parse_table_version_changes(&mut self) -> Result<TableVersion, ParserError> {
17316        let changes_name = self.parse_object_name(true)?;
17317        let changes = self.parse_function(changes_name)?;
17318        let at_name = self.parse_object_name(true)?;
17319        let at = self.parse_function(at_name)?;
17320        let end = if self.peek_keyword(Keyword::END) {
17321            let end_name = self.parse_object_name(true)?;
17322            Some(self.parse_function(end_name)?)
17323        } else {
17324            None
17325        };
17326        Ok(TableVersion::Changes { changes, at, end })
17327    }
17328
17329    /// Parses MySQL's JSON_TABLE column definition.
17330    /// For example: `id INT EXISTS PATH '$' DEFAULT '0' ON EMPTY ERROR ON ERROR`
17331    pub fn parse_json_table_column_def(&mut self) -> Result<JsonTableColumn, ParserError> {
17332        if self.parse_keyword(Keyword::NESTED) {
17333            let _has_path_keyword = self.parse_keyword(Keyword::PATH);
17334            let path = self.parse_value()?;
17335            self.expect_keyword_is(Keyword::COLUMNS)?;
17336            let columns = self.parse_parenthesized(|p| {
17337                p.parse_comma_separated(Self::parse_json_table_column_def)
17338            })?;
17339            return Ok(JsonTableColumn::Nested(JsonTableNestedColumn {
17340                path,
17341                columns,
17342            }));
17343        }
17344        let name = self.parse_identifier()?;
17345        if self.parse_keyword(Keyword::FOR) {
17346            self.expect_keyword_is(Keyword::ORDINALITY)?;
17347            return Ok(JsonTableColumn::ForOrdinality(name));
17348        }
17349        let r#type = self.parse_data_type()?;
17350        let exists = self.parse_keyword(Keyword::EXISTS);
17351        self.expect_keyword_is(Keyword::PATH)?;
17352        let path = self.parse_value()?;
17353        let mut on_empty = None;
17354        let mut on_error = None;
17355        while let Some(error_handling) = self.parse_json_table_column_error_handling()? {
17356            if self.parse_keyword(Keyword::EMPTY) {
17357                on_empty = Some(error_handling);
17358            } else {
17359                self.expect_keyword_is(Keyword::ERROR)?;
17360                on_error = Some(error_handling);
17361            }
17362        }
17363        Ok(JsonTableColumn::Named(JsonTableNamedColumn {
17364            name,
17365            r#type,
17366            path,
17367            exists,
17368            on_empty,
17369            on_error,
17370        }))
17371    }
17372
17373    /// Parses MSSQL's `OPENJSON WITH` column definition.
17374    ///
17375    /// ```sql
17376    /// colName type [ column_path ] [ AS JSON ]
17377    /// ```
17378    ///
17379    /// Reference: <https://learn.microsoft.com/en-us/sql/t-sql/functions/openjson-transact-sql?view=sql-server-ver16#syntax>
17380    pub fn parse_openjson_table_column_def(&mut self) -> Result<OpenJsonTableColumn, ParserError> {
17381        let name = self.parse_identifier()?;
17382        let r#type = self.parse_data_type()?;
17383        let path = if let Token::SingleQuotedString(path) = self.peek_token().token {
17384            self.next_token();
17385            Some(path)
17386        } else {
17387            None
17388        };
17389        let as_json = self.parse_keyword(Keyword::AS);
17390        if as_json {
17391            self.expect_keyword_is(Keyword::JSON)?;
17392        }
17393        Ok(OpenJsonTableColumn {
17394            name,
17395            r#type,
17396            path,
17397            as_json,
17398        })
17399    }
17400
17401    fn parse_json_table_column_error_handling(
17402        &mut self,
17403    ) -> Result<Option<JsonTableColumnErrorHandling>, ParserError> {
17404        let res = if self.parse_keyword(Keyword::NULL) {
17405            JsonTableColumnErrorHandling::Null
17406        } else if self.parse_keyword(Keyword::ERROR) {
17407            JsonTableColumnErrorHandling::Error
17408        } else if self.parse_keyword(Keyword::DEFAULT) {
17409            JsonTableColumnErrorHandling::Default(self.parse_value()?)
17410        } else {
17411            return Ok(None);
17412        };
17413        self.expect_keyword_is(Keyword::ON)?;
17414        Ok(Some(res))
17415    }
17416
17417    /// Parse a derived table factor (a parenthesized subquery), handling optional LATERAL.
17418    pub fn parse_derived_table_factor(
17419        &mut self,
17420        lateral: IsLateral,
17421    ) -> Result<TableFactor, ParserError> {
17422        let subquery = self.parse_query()?;
17423        self.expect_token(&Token::RParen)?;
17424        let alias = self.maybe_parse_table_alias()?;
17425
17426        // Parse optional SAMPLE clause after alias
17427        let sample = self
17428            .maybe_parse_table_sample()?
17429            .map(TableSampleKind::AfterTableAlias);
17430
17431        Ok(TableFactor::Derived {
17432            lateral: match lateral {
17433                Lateral => true,
17434                NotLateral => false,
17435            },
17436            subquery,
17437            alias,
17438            sample,
17439        })
17440    }
17441
17442    /// Parses an expression with an optional alias
17443    ///
17444    /// Examples:
17445    ///
17446    /// ```sql
17447    /// SUM(price) AS total_price
17448    /// ```
17449    /// ```sql
17450    /// SUM(price)
17451    /// ```
17452    ///
17453    /// Example
17454    /// ```
17455    /// # use sqlparser::parser::{Parser, ParserError};
17456    /// # use sqlparser::dialect::GenericDialect;
17457    /// # fn main() ->Result<(), ParserError> {
17458    /// let sql = r#"SUM("a") as "b""#;
17459    /// let mut parser = Parser::new(&GenericDialect).try_with_sql(sql)?;
17460    /// let expr_with_alias = parser.parse_expr_with_alias()?;
17461    /// assert_eq!(Some("b".to_string()), expr_with_alias.alias.map(|x|x.value));
17462    /// # Ok(())
17463    /// # }
17464    pub fn parse_expr_with_alias(&mut self) -> Result<ExprWithAlias, ParserError> {
17465        let expr = self.parse_expr()?;
17466        let alias = if self.parse_keyword(Keyword::AS) {
17467            Some(self.parse_identifier()?)
17468        } else {
17469            None
17470        };
17471
17472        Ok(ExprWithAlias { expr, alias })
17473    }
17474
17475    /// Parse an expression followed by an optional alias; Unlike
17476    /// [Self::parse_expr_with_alias] the "AS" keyword between the expression
17477    /// and the alias is optional.
17478    fn parse_expr_with_alias_optional_as_keyword(&mut self) -> Result<ExprWithAlias, ParserError> {
17479        let expr = self.parse_expr()?;
17480        let alias = self.parse_identifier_optional_alias()?;
17481        Ok(ExprWithAlias { expr, alias })
17482    }
17483
17484    /// Parses a plain function call with an optional alias for the `PIVOT` clause
17485    fn parse_pivot_aggregate_function(&mut self) -> Result<ExprWithAlias, ParserError> {
17486        let function_name = match self.next_token().token {
17487            Token::Word(w) => Ok(w.value),
17488            _ => self.expected_ref("a function identifier", self.peek_token_ref()),
17489        }?;
17490        let expr = self.parse_function(ObjectName::from(vec![Ident::new(function_name)]))?;
17491        let alias = {
17492            fn validator(explicit: bool, kw: &Keyword, parser: &mut Parser) -> bool {
17493                // ~ for a PIVOT aggregate function the alias must not be a "FOR"; in any dialect
17494                kw != &Keyword::FOR && parser.dialect.is_select_item_alias(explicit, kw, parser)
17495            }
17496            self.parse_optional_alias_inner(None, validator)?
17497        };
17498        Ok(ExprWithAlias { expr, alias })
17499    }
17500
17501    /// Parse a PIVOT table factor (ClickHouse/Oracle style pivot), returning a TableFactor.
17502    pub fn parse_pivot_table_factor(
17503        &mut self,
17504        table: TableFactor,
17505    ) -> Result<TableFactor, ParserError> {
17506        self.expect_token(&Token::LParen)?;
17507        let aggregate_functions =
17508            self.parse_comma_separated(Self::parse_pivot_aggregate_function)?;
17509        self.expect_keyword_is(Keyword::FOR)?;
17510        let value_column = if self.peek_token_ref().token == Token::LParen {
17511            self.parse_parenthesized_column_list_inner(Mandatory, false, |p| {
17512                p.parse_subexpr(self.dialect.prec_value(Precedence::Between))
17513            })?
17514        } else {
17515            vec![self.parse_subexpr(self.dialect.prec_value(Precedence::Between))?]
17516        };
17517        self.expect_keyword_is(Keyword::IN)?;
17518
17519        self.expect_token(&Token::LParen)?;
17520        let value_source = if self.parse_keyword(Keyword::ANY) {
17521            let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
17522                self.parse_comma_separated(Parser::parse_order_by_expr)?
17523            } else {
17524                vec![]
17525            };
17526            PivotValueSource::Any(order_by)
17527        } else if self.peek_sub_query() {
17528            PivotValueSource::Subquery(self.parse_query()?)
17529        } else {
17530            PivotValueSource::List(
17531                self.parse_comma_separated(Self::parse_expr_with_alias_optional_as_keyword)?,
17532            )
17533        };
17534        self.expect_token(&Token::RParen)?;
17535
17536        let default_on_null =
17537            if self.parse_keywords(&[Keyword::DEFAULT, Keyword::ON, Keyword::NULL]) {
17538                self.expect_token(&Token::LParen)?;
17539                let expr = self.parse_expr()?;
17540                self.expect_token(&Token::RParen)?;
17541                Some(expr)
17542            } else {
17543                None
17544            };
17545
17546        self.expect_token(&Token::RParen)?;
17547        let alias = self.maybe_parse_table_alias()?;
17548        Ok(TableFactor::Pivot {
17549            table: Box::new(table),
17550            aggregate_functions,
17551            value_column,
17552            value_source,
17553            default_on_null,
17554            alias,
17555        })
17556    }
17557
17558    /// Parse an UNPIVOT table factor, returning a TableFactor.
17559    pub fn parse_unpivot_table_factor(
17560        &mut self,
17561        table: TableFactor,
17562    ) -> Result<TableFactor, ParserError> {
17563        let null_inclusion = if self.parse_keyword(Keyword::INCLUDE) {
17564            self.expect_keyword_is(Keyword::NULLS)?;
17565            Some(NullInclusion::IncludeNulls)
17566        } else if self.parse_keyword(Keyword::EXCLUDE) {
17567            self.expect_keyword_is(Keyword::NULLS)?;
17568            Some(NullInclusion::ExcludeNulls)
17569        } else {
17570            None
17571        };
17572        self.expect_token(&Token::LParen)?;
17573        let value = self.parse_expr()?;
17574        self.expect_keyword_is(Keyword::FOR)?;
17575        let name = self.parse_identifier()?;
17576        self.expect_keyword_is(Keyword::IN)?;
17577        let columns = self.parse_parenthesized_column_list_inner(Mandatory, false, |p| {
17578            p.parse_expr_with_alias()
17579        })?;
17580        self.expect_token(&Token::RParen)?;
17581        let alias = self.maybe_parse_table_alias()?;
17582        Ok(TableFactor::Unpivot {
17583            table: Box::new(table),
17584            value,
17585            null_inclusion,
17586            name,
17587            columns,
17588            alias,
17589        })
17590    }
17591
17592    /// Parse a JOIN constraint (`NATURAL`, `ON <expr>`, `USING (...)`, or no constraint).
17593    pub fn parse_join_constraint(&mut self, natural: bool) -> Result<JoinConstraint, ParserError> {
17594        if natural {
17595            Ok(JoinConstraint::Natural)
17596        } else if self.parse_keyword(Keyword::ON) {
17597            let constraint = self.parse_expr()?;
17598            Ok(JoinConstraint::On(constraint))
17599        } else if self.parse_keyword(Keyword::USING) {
17600            let columns = self.parse_parenthesized_qualified_column_list(Mandatory, false)?;
17601            Ok(JoinConstraint::Using(columns))
17602        } else {
17603            Ok(JoinConstraint::None)
17604            //self.expected_ref("ON, or USING after JOIN", self.peek_token_ref())
17605        }
17606    }
17607
17608    /// Parse a GRANT statement.
17609    pub fn parse_grant(&mut self) -> Result<Grant, ParserError> {
17610        let (privileges, objects) = self.parse_grant_deny_revoke_privileges_objects()?;
17611
17612        self.expect_keyword_is(Keyword::TO)?;
17613        let grantees = self.parse_grantees()?;
17614
17615        let with_grant_option =
17616            self.parse_keywords(&[Keyword::WITH, Keyword::GRANT, Keyword::OPTION]);
17617
17618        let current_grants =
17619            if self.parse_keywords(&[Keyword::COPY, Keyword::CURRENT, Keyword::GRANTS]) {
17620                Some(CurrentGrantsKind::CopyCurrentGrants)
17621            } else if self.parse_keywords(&[Keyword::REVOKE, Keyword::CURRENT, Keyword::GRANTS]) {
17622                Some(CurrentGrantsKind::RevokeCurrentGrants)
17623            } else {
17624                None
17625            };
17626
17627        let as_grantor = if self.parse_keywords(&[Keyword::AS]) {
17628            Some(self.parse_identifier()?)
17629        } else {
17630            None
17631        };
17632
17633        let granted_by = if self.parse_keywords(&[Keyword::GRANTED, Keyword::BY]) {
17634            Some(self.parse_identifier()?)
17635        } else {
17636            None
17637        };
17638
17639        Ok(Grant {
17640            privileges,
17641            objects,
17642            grantees,
17643            with_grant_option,
17644            as_grantor,
17645            granted_by,
17646            current_grants,
17647        })
17648    }
17649
17650    fn parse_grantees(&mut self) -> Result<Vec<Grantee>, ParserError> {
17651        let mut values = vec![];
17652        let mut grantee_type = GranteesType::None;
17653        loop {
17654            let new_grantee_type = if self.parse_keyword(Keyword::ROLE) {
17655                GranteesType::Role
17656            } else if self.parse_keyword(Keyword::USER) {
17657                GranteesType::User
17658            } else if self.parse_keyword(Keyword::SHARE) {
17659                GranteesType::Share
17660            } else if self.parse_keyword(Keyword::GROUP) {
17661                GranteesType::Group
17662            } else if self.parse_keyword(Keyword::PUBLIC) {
17663                GranteesType::Public
17664            } else if self.parse_keywords(&[Keyword::DATABASE, Keyword::ROLE]) {
17665                GranteesType::DatabaseRole
17666            } else if self.parse_keywords(&[Keyword::APPLICATION, Keyword::ROLE]) {
17667                GranteesType::ApplicationRole
17668            } else if self.parse_keyword(Keyword::APPLICATION) {
17669                GranteesType::Application
17670            } else {
17671                grantee_type.clone() // keep from previous iteraton, if not specified
17672            };
17673
17674            if self
17675                .dialect
17676                .get_reserved_grantees_types()
17677                .contains(&new_grantee_type)
17678            {
17679                self.prev_token();
17680            } else {
17681                grantee_type = new_grantee_type;
17682            }
17683
17684            let grantee = if grantee_type == GranteesType::Public {
17685                Grantee {
17686                    grantee_type: grantee_type.clone(),
17687                    name: None,
17688                }
17689            } else {
17690                let mut name = self.parse_grantee_name()?;
17691                if self.consume_token(&Token::Colon) {
17692                    // Redshift supports namespace prefix for external users and groups:
17693                    // <Namespace>:<GroupName> or <Namespace>:<UserName>
17694                    // https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-native-idp.html
17695                    let ident = self.parse_identifier()?;
17696                    if let GranteeName::ObjectName(namespace) = name {
17697                        name = GranteeName::ObjectName(ObjectName::from(vec![Ident::new(
17698                            format!("{namespace}:{ident}"),
17699                        )]));
17700                    };
17701                }
17702                Grantee {
17703                    grantee_type: grantee_type.clone(),
17704                    name: Some(name),
17705                }
17706            };
17707
17708            values.push(grantee);
17709
17710            if !self.consume_token(&Token::Comma) {
17711                break;
17712            }
17713        }
17714
17715        Ok(values)
17716    }
17717
17718    /// Parse privileges and optional target objects for GRANT/DENY/REVOKE statements.
17719    pub fn parse_grant_deny_revoke_privileges_objects(
17720        &mut self,
17721    ) -> Result<(Privileges, Option<GrantObjects>), ParserError> {
17722        let privileges = if self.parse_keyword(Keyword::ALL) {
17723            Privileges::All {
17724                with_privileges_keyword: self.parse_keyword(Keyword::PRIVILEGES),
17725            }
17726        } else {
17727            let actions = self.parse_actions_list()?;
17728            Privileges::Actions(actions)
17729        };
17730
17731        let objects = if self.parse_keyword(Keyword::ON) {
17732            if self.parse_keywords(&[Keyword::ALL, Keyword::TABLES, Keyword::IN, Keyword::SCHEMA]) {
17733                Some(GrantObjects::AllTablesInSchema {
17734                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17735                })
17736            } else if self.parse_keywords(&[
17737                Keyword::ALL,
17738                Keyword::EXTERNAL,
17739                Keyword::TABLES,
17740                Keyword::IN,
17741                Keyword::SCHEMA,
17742            ]) {
17743                Some(GrantObjects::AllExternalTablesInSchema {
17744                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17745                })
17746            } else if self.parse_keywords(&[
17747                Keyword::ALL,
17748                Keyword::VIEWS,
17749                Keyword::IN,
17750                Keyword::SCHEMA,
17751            ]) {
17752                Some(GrantObjects::AllViewsInSchema {
17753                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17754                })
17755            } else if self.parse_keywords(&[
17756                Keyword::ALL,
17757                Keyword::MATERIALIZED,
17758                Keyword::VIEWS,
17759                Keyword::IN,
17760                Keyword::SCHEMA,
17761            ]) {
17762                Some(GrantObjects::AllMaterializedViewsInSchema {
17763                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17764                })
17765            } else if self.parse_keywords(&[
17766                Keyword::ALL,
17767                Keyword::FUNCTIONS,
17768                Keyword::IN,
17769                Keyword::SCHEMA,
17770            ]) {
17771                Some(GrantObjects::AllFunctionsInSchema {
17772                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17773                })
17774            } else if self.parse_keywords(&[
17775                Keyword::FUTURE,
17776                Keyword::SCHEMAS,
17777                Keyword::IN,
17778                Keyword::DATABASE,
17779            ]) {
17780                Some(GrantObjects::FutureSchemasInDatabase {
17781                    databases: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17782                })
17783            } else if self.parse_keywords(&[
17784                Keyword::FUTURE,
17785                Keyword::TABLES,
17786                Keyword::IN,
17787                Keyword::SCHEMA,
17788            ]) {
17789                Some(GrantObjects::FutureTablesInSchema {
17790                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17791                })
17792            } else if self.parse_keywords(&[
17793                Keyword::FUTURE,
17794                Keyword::EXTERNAL,
17795                Keyword::TABLES,
17796                Keyword::IN,
17797                Keyword::SCHEMA,
17798            ]) {
17799                Some(GrantObjects::FutureExternalTablesInSchema {
17800                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17801                })
17802            } else if self.parse_keywords(&[
17803                Keyword::FUTURE,
17804                Keyword::VIEWS,
17805                Keyword::IN,
17806                Keyword::SCHEMA,
17807            ]) {
17808                Some(GrantObjects::FutureViewsInSchema {
17809                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17810                })
17811            } else if self.parse_keywords(&[
17812                Keyword::FUTURE,
17813                Keyword::MATERIALIZED,
17814                Keyword::VIEWS,
17815                Keyword::IN,
17816                Keyword::SCHEMA,
17817            ]) {
17818                Some(GrantObjects::FutureMaterializedViewsInSchema {
17819                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17820                })
17821            } else if self.parse_keywords(&[
17822                Keyword::ALL,
17823                Keyword::SEQUENCES,
17824                Keyword::IN,
17825                Keyword::SCHEMA,
17826            ]) {
17827                Some(GrantObjects::AllSequencesInSchema {
17828                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17829                })
17830            } else if self.parse_keywords(&[
17831                Keyword::FUTURE,
17832                Keyword::SEQUENCES,
17833                Keyword::IN,
17834                Keyword::SCHEMA,
17835            ]) {
17836                Some(GrantObjects::FutureSequencesInSchema {
17837                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17838                })
17839            } else if self.parse_keywords(&[Keyword::RESOURCE, Keyword::MONITOR]) {
17840                Some(GrantObjects::ResourceMonitors(
17841                    self.parse_comma_separated(|p| p.parse_object_name(false))?,
17842                ))
17843            } else if self.parse_keywords(&[Keyword::COMPUTE, Keyword::POOL]) {
17844                Some(GrantObjects::ComputePools(
17845                    self.parse_comma_separated(|p| p.parse_object_name(false))?,
17846                ))
17847            } else if self.parse_keywords(&[Keyword::FAILOVER, Keyword::GROUP]) {
17848                Some(GrantObjects::FailoverGroup(
17849                    self.parse_comma_separated(|p| p.parse_object_name(false))?,
17850                ))
17851            } else if self.parse_keywords(&[Keyword::REPLICATION, Keyword::GROUP]) {
17852                Some(GrantObjects::ReplicationGroup(
17853                    self.parse_comma_separated(|p| p.parse_object_name(false))?,
17854                ))
17855            } else if self.parse_keywords(&[Keyword::EXTERNAL, Keyword::VOLUME]) {
17856                Some(GrantObjects::ExternalVolumes(
17857                    self.parse_comma_separated(|p| p.parse_object_name(false))?,
17858                ))
17859            } else {
17860                let object_type = self.parse_one_of_keywords(&[
17861                    Keyword::SEQUENCE,
17862                    Keyword::DATABASE,
17863                    Keyword::SCHEMA,
17864                    Keyword::TABLE,
17865                    Keyword::VIEW,
17866                    Keyword::WAREHOUSE,
17867                    Keyword::INTEGRATION,
17868                    Keyword::VIEW,
17869                    Keyword::WAREHOUSE,
17870                    Keyword::INTEGRATION,
17871                    Keyword::USER,
17872                    Keyword::CONNECTION,
17873                    Keyword::PROCEDURE,
17874                    Keyword::FUNCTION,
17875                ]);
17876                let objects =
17877                    self.parse_comma_separated(|p| p.parse_object_name_inner(false, true));
17878                match object_type {
17879                    Some(Keyword::DATABASE) => Some(GrantObjects::Databases(objects?)),
17880                    Some(Keyword::SCHEMA) => Some(GrantObjects::Schemas(objects?)),
17881                    Some(Keyword::SEQUENCE) => Some(GrantObjects::Sequences(objects?)),
17882                    Some(Keyword::WAREHOUSE) => Some(GrantObjects::Warehouses(objects?)),
17883                    Some(Keyword::INTEGRATION) => Some(GrantObjects::Integrations(objects?)),
17884                    Some(Keyword::VIEW) => Some(GrantObjects::Views(objects?)),
17885                    Some(Keyword::USER) => Some(GrantObjects::Users(objects?)),
17886                    Some(Keyword::CONNECTION) => Some(GrantObjects::Connections(objects?)),
17887                    kw @ (Some(Keyword::PROCEDURE) | Some(Keyword::FUNCTION)) => {
17888                        if let Some(name) = objects?.first() {
17889                            self.parse_grant_procedure_or_function(name, &kw)?
17890                        } else {
17891                            self.expected_ref("procedure or function name", self.peek_token_ref())?
17892                        }
17893                    }
17894                    Some(Keyword::TABLE) | None => Some(GrantObjects::Tables(objects?)),
17895                    Some(unexpected_keyword) => return Err(ParserError::ParserError(
17896                        format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in grant objects"),
17897                    )),
17898                }
17899            }
17900        } else {
17901            None
17902        };
17903
17904        Ok((privileges, objects))
17905    }
17906
17907    fn parse_grant_procedure_or_function(
17908        &mut self,
17909        name: &ObjectName,
17910        kw: &Option<Keyword>,
17911    ) -> Result<Option<GrantObjects>, ParserError> {
17912        let arg_types = if self.consume_token(&Token::LParen) {
17913            let list = self.parse_comma_separated0(Self::parse_data_type, Token::RParen)?;
17914            self.expect_token(&Token::RParen)?;
17915            list
17916        } else {
17917            vec![]
17918        };
17919        match kw {
17920            Some(Keyword::PROCEDURE) => Ok(Some(GrantObjects::Procedure {
17921                name: name.clone(),
17922                arg_types,
17923            })),
17924            Some(Keyword::FUNCTION) => Ok(Some(GrantObjects::Function {
17925                name: name.clone(),
17926                arg_types,
17927            })),
17928            _ => self.expected_ref("procedure or function keywords", self.peek_token_ref())?,
17929        }
17930    }
17931
17932    /// Parse a single grantable permission/action (used within GRANT statements).
17933    pub fn parse_grant_permission(&mut self) -> Result<Action, ParserError> {
17934        fn parse_columns(parser: &mut Parser) -> Result<Option<Vec<Ident>>, ParserError> {
17935            let columns = parser.parse_parenthesized_column_list(Optional, false)?;
17936            if columns.is_empty() {
17937                Ok(None)
17938            } else {
17939                Ok(Some(columns))
17940            }
17941        }
17942
17943        // Multi-word privileges
17944        if self.parse_keywords(&[Keyword::IMPORTED, Keyword::PRIVILEGES]) {
17945            Ok(Action::ImportedPrivileges)
17946        } else if self.parse_keywords(&[Keyword::ADD, Keyword::SEARCH, Keyword::OPTIMIZATION]) {
17947            Ok(Action::AddSearchOptimization)
17948        } else if self.parse_keywords(&[Keyword::ATTACH, Keyword::LISTING]) {
17949            Ok(Action::AttachListing)
17950        } else if self.parse_keywords(&[Keyword::ATTACH, Keyword::POLICY]) {
17951            Ok(Action::AttachPolicy)
17952        } else if self.parse_keywords(&[Keyword::BIND, Keyword::SERVICE, Keyword::ENDPOINT]) {
17953            Ok(Action::BindServiceEndpoint)
17954        } else if self.parse_keywords(&[Keyword::DATABASE, Keyword::ROLE]) {
17955            let role = self.parse_object_name(false)?;
17956            Ok(Action::DatabaseRole { role })
17957        } else if self.parse_keywords(&[Keyword::EVOLVE, Keyword::SCHEMA]) {
17958            Ok(Action::EvolveSchema)
17959        } else if self.parse_keywords(&[Keyword::IMPORT, Keyword::SHARE]) {
17960            Ok(Action::ImportShare)
17961        } else if self.parse_keywords(&[Keyword::MANAGE, Keyword::VERSIONS]) {
17962            Ok(Action::ManageVersions)
17963        } else if self.parse_keywords(&[Keyword::MANAGE, Keyword::RELEASES]) {
17964            Ok(Action::ManageReleases)
17965        } else if self.parse_keywords(&[Keyword::OVERRIDE, Keyword::SHARE, Keyword::RESTRICTIONS]) {
17966            Ok(Action::OverrideShareRestrictions)
17967        } else if self.parse_keywords(&[
17968            Keyword::PURCHASE,
17969            Keyword::DATA,
17970            Keyword::EXCHANGE,
17971            Keyword::LISTING,
17972        ]) {
17973            Ok(Action::PurchaseDataExchangeListing)
17974        } else if self.parse_keywords(&[Keyword::RESOLVE, Keyword::ALL]) {
17975            Ok(Action::ResolveAll)
17976        } else if self.parse_keywords(&[Keyword::READ, Keyword::SESSION]) {
17977            Ok(Action::ReadSession)
17978
17979        // Single-word privileges
17980        } else if self.parse_keyword(Keyword::APPLY) {
17981            let apply_type = self.parse_action_apply_type()?;
17982            Ok(Action::Apply { apply_type })
17983        } else if self.parse_keyword(Keyword::APPLYBUDGET) {
17984            Ok(Action::ApplyBudget)
17985        } else if self.parse_keyword(Keyword::AUDIT) {
17986            Ok(Action::Audit)
17987        } else if self.parse_keyword(Keyword::CONNECT) {
17988            Ok(Action::Connect)
17989        } else if self.parse_keyword(Keyword::CREATE) {
17990            let obj_type = self.maybe_parse_action_create_object_type();
17991            Ok(Action::Create { obj_type })
17992        } else if self.parse_keyword(Keyword::DELETE) {
17993            Ok(Action::Delete)
17994        } else if self.parse_keyword(Keyword::EXEC) {
17995            let obj_type = self.maybe_parse_action_execute_obj_type();
17996            Ok(Action::Exec { obj_type })
17997        } else if self.parse_keyword(Keyword::EXECUTE) {
17998            let obj_type = self.maybe_parse_action_execute_obj_type();
17999            Ok(Action::Execute { obj_type })
18000        } else if self.parse_keyword(Keyword::FAILOVER) {
18001            Ok(Action::Failover)
18002        } else if self.parse_keyword(Keyword::INSERT) {
18003            Ok(Action::Insert {
18004                columns: parse_columns(self)?,
18005            })
18006        } else if self.parse_keyword(Keyword::MANAGE) {
18007            let manage_type = self.parse_action_manage_type()?;
18008            Ok(Action::Manage { manage_type })
18009        } else if self.parse_keyword(Keyword::MODIFY) {
18010            let modify_type = self.parse_action_modify_type();
18011            Ok(Action::Modify { modify_type })
18012        } else if self.parse_keyword(Keyword::MONITOR) {
18013            let monitor_type = self.parse_action_monitor_type();
18014            Ok(Action::Monitor { monitor_type })
18015        } else if self.parse_keyword(Keyword::OPERATE) {
18016            Ok(Action::Operate)
18017        } else if self.parse_keyword(Keyword::REFERENCES) {
18018            Ok(Action::References {
18019                columns: parse_columns(self)?,
18020            })
18021        } else if self.parse_keyword(Keyword::READ) {
18022            Ok(Action::Read)
18023        } else if self.parse_keyword(Keyword::REPLICATE) {
18024            Ok(Action::Replicate)
18025        } else if self.parse_keyword(Keyword::ROLE) {
18026            let role = self.parse_object_name(false)?;
18027            Ok(Action::Role { role })
18028        } else if self.parse_keyword(Keyword::SELECT) {
18029            Ok(Action::Select {
18030                columns: parse_columns(self)?,
18031            })
18032        } else if self.parse_keyword(Keyword::TEMPORARY) {
18033            Ok(Action::Temporary)
18034        } else if self.parse_keyword(Keyword::TRIGGER) {
18035            Ok(Action::Trigger)
18036        } else if self.parse_keyword(Keyword::TRUNCATE) {
18037            Ok(Action::Truncate)
18038        } else if self.parse_keyword(Keyword::UPDATE) {
18039            Ok(Action::Update {
18040                columns: parse_columns(self)?,
18041            })
18042        } else if self.parse_keyword(Keyword::USAGE) {
18043            Ok(Action::Usage)
18044        } else if self.parse_keyword(Keyword::OWNERSHIP) {
18045            Ok(Action::Ownership)
18046        } else if self.parse_keyword(Keyword::DROP) {
18047            Ok(Action::Drop)
18048        } else {
18049            self.expected_ref("a privilege keyword", self.peek_token_ref())?
18050        }
18051    }
18052
18053    fn maybe_parse_action_create_object_type(&mut self) -> Option<ActionCreateObjectType> {
18054        // Multi-word object types
18055        if self.parse_keywords(&[Keyword::APPLICATION, Keyword::PACKAGE]) {
18056            Some(ActionCreateObjectType::ApplicationPackage)
18057        } else if self.parse_keywords(&[Keyword::COMPUTE, Keyword::POOL]) {
18058            Some(ActionCreateObjectType::ComputePool)
18059        } else if self.parse_keywords(&[Keyword::DATA, Keyword::EXCHANGE, Keyword::LISTING]) {
18060            Some(ActionCreateObjectType::DataExchangeListing)
18061        } else if self.parse_keywords(&[Keyword::EXTERNAL, Keyword::VOLUME]) {
18062            Some(ActionCreateObjectType::ExternalVolume)
18063        } else if self.parse_keywords(&[Keyword::FAILOVER, Keyword::GROUP]) {
18064            Some(ActionCreateObjectType::FailoverGroup)
18065        } else if self.parse_keywords(&[Keyword::NETWORK, Keyword::POLICY]) {
18066            Some(ActionCreateObjectType::NetworkPolicy)
18067        } else if self.parse_keywords(&[Keyword::ORGANIZATION, Keyword::LISTING]) {
18068            Some(ActionCreateObjectType::OrganiationListing)
18069        } else if self.parse_keywords(&[Keyword::REPLICATION, Keyword::GROUP]) {
18070            Some(ActionCreateObjectType::ReplicationGroup)
18071        }
18072        // Single-word object types
18073        else if self.parse_keyword(Keyword::ACCOUNT) {
18074            Some(ActionCreateObjectType::Account)
18075        } else if self.parse_keyword(Keyword::APPLICATION) {
18076            Some(ActionCreateObjectType::Application)
18077        } else if self.parse_keyword(Keyword::DATABASE) {
18078            Some(ActionCreateObjectType::Database)
18079        } else if self.parse_keyword(Keyword::INTEGRATION) {
18080            Some(ActionCreateObjectType::Integration)
18081        } else if self.parse_keyword(Keyword::ROLE) {
18082            Some(ActionCreateObjectType::Role)
18083        } else if self.parse_keyword(Keyword::SCHEMA) {
18084            Some(ActionCreateObjectType::Schema)
18085        } else if self.parse_keyword(Keyword::SHARE) {
18086            Some(ActionCreateObjectType::Share)
18087        } else if self.parse_keyword(Keyword::USER) {
18088            Some(ActionCreateObjectType::User)
18089        } else if self.parse_keyword(Keyword::WAREHOUSE) {
18090            Some(ActionCreateObjectType::Warehouse)
18091        } else {
18092            None
18093        }
18094    }
18095
18096    fn parse_action_apply_type(&mut self) -> Result<ActionApplyType, ParserError> {
18097        if self.parse_keywords(&[Keyword::AGGREGATION, Keyword::POLICY]) {
18098            Ok(ActionApplyType::AggregationPolicy)
18099        } else if self.parse_keywords(&[Keyword::AUTHENTICATION, Keyword::POLICY]) {
18100            Ok(ActionApplyType::AuthenticationPolicy)
18101        } else if self.parse_keywords(&[Keyword::JOIN, Keyword::POLICY]) {
18102            Ok(ActionApplyType::JoinPolicy)
18103        } else if self.parse_keywords(&[Keyword::MASKING, Keyword::POLICY]) {
18104            Ok(ActionApplyType::MaskingPolicy)
18105        } else if self.parse_keywords(&[Keyword::PACKAGES, Keyword::POLICY]) {
18106            Ok(ActionApplyType::PackagesPolicy)
18107        } else if self.parse_keywords(&[Keyword::PASSWORD, Keyword::POLICY]) {
18108            Ok(ActionApplyType::PasswordPolicy)
18109        } else if self.parse_keywords(&[Keyword::PROJECTION, Keyword::POLICY]) {
18110            Ok(ActionApplyType::ProjectionPolicy)
18111        } else if self.parse_keywords(&[Keyword::ROW, Keyword::ACCESS, Keyword::POLICY]) {
18112            Ok(ActionApplyType::RowAccessPolicy)
18113        } else if self.parse_keywords(&[Keyword::SESSION, Keyword::POLICY]) {
18114            Ok(ActionApplyType::SessionPolicy)
18115        } else if self.parse_keyword(Keyword::TAG) {
18116            Ok(ActionApplyType::Tag)
18117        } else {
18118            self.expected_ref("GRANT APPLY type", self.peek_token_ref())
18119        }
18120    }
18121
18122    fn maybe_parse_action_execute_obj_type(&mut self) -> Option<ActionExecuteObjectType> {
18123        if self.parse_keywords(&[Keyword::DATA, Keyword::METRIC, Keyword::FUNCTION]) {
18124            Some(ActionExecuteObjectType::DataMetricFunction)
18125        } else if self.parse_keywords(&[Keyword::MANAGED, Keyword::ALERT]) {
18126            Some(ActionExecuteObjectType::ManagedAlert)
18127        } else if self.parse_keywords(&[Keyword::MANAGED, Keyword::TASK]) {
18128            Some(ActionExecuteObjectType::ManagedTask)
18129        } else if self.parse_keyword(Keyword::ALERT) {
18130            Some(ActionExecuteObjectType::Alert)
18131        } else if self.parse_keyword(Keyword::TASK) {
18132            Some(ActionExecuteObjectType::Task)
18133        } else {
18134            None
18135        }
18136    }
18137
18138    fn parse_action_manage_type(&mut self) -> Result<ActionManageType, ParserError> {
18139        if self.parse_keywords(&[Keyword::ACCOUNT, Keyword::SUPPORT, Keyword::CASES]) {
18140            Ok(ActionManageType::AccountSupportCases)
18141        } else if self.parse_keywords(&[Keyword::EVENT, Keyword::SHARING]) {
18142            Ok(ActionManageType::EventSharing)
18143        } else if self.parse_keywords(&[Keyword::LISTING, Keyword::AUTO, Keyword::FULFILLMENT]) {
18144            Ok(ActionManageType::ListingAutoFulfillment)
18145        } else if self.parse_keywords(&[Keyword::ORGANIZATION, Keyword::SUPPORT, Keyword::CASES]) {
18146            Ok(ActionManageType::OrganizationSupportCases)
18147        } else if self.parse_keywords(&[Keyword::USER, Keyword::SUPPORT, Keyword::CASES]) {
18148            Ok(ActionManageType::UserSupportCases)
18149        } else if self.parse_keyword(Keyword::GRANTS) {
18150            Ok(ActionManageType::Grants)
18151        } else if self.parse_keyword(Keyword::WAREHOUSES) {
18152            Ok(ActionManageType::Warehouses)
18153        } else {
18154            self.expected_ref("GRANT MANAGE type", self.peek_token_ref())
18155        }
18156    }
18157
18158    fn parse_action_modify_type(&mut self) -> Option<ActionModifyType> {
18159        if self.parse_keywords(&[Keyword::LOG, Keyword::LEVEL]) {
18160            Some(ActionModifyType::LogLevel)
18161        } else if self.parse_keywords(&[Keyword::TRACE, Keyword::LEVEL]) {
18162            Some(ActionModifyType::TraceLevel)
18163        } else if self.parse_keywords(&[Keyword::SESSION, Keyword::LOG, Keyword::LEVEL]) {
18164            Some(ActionModifyType::SessionLogLevel)
18165        } else if self.parse_keywords(&[Keyword::SESSION, Keyword::TRACE, Keyword::LEVEL]) {
18166            Some(ActionModifyType::SessionTraceLevel)
18167        } else {
18168            None
18169        }
18170    }
18171
18172    fn parse_action_monitor_type(&mut self) -> Option<ActionMonitorType> {
18173        if self.parse_keyword(Keyword::EXECUTION) {
18174            Some(ActionMonitorType::Execution)
18175        } else if self.parse_keyword(Keyword::SECURITY) {
18176            Some(ActionMonitorType::Security)
18177        } else if self.parse_keyword(Keyword::USAGE) {
18178            Some(ActionMonitorType::Usage)
18179        } else {
18180            None
18181        }
18182    }
18183
18184    /// Parse a grantee name, possibly with a host qualifier (user@host).
18185    pub fn parse_grantee_name(&mut self) -> Result<GranteeName, ParserError> {
18186        let mut name = self.parse_object_name(false)?;
18187        if self.dialect.supports_user_host_grantee()
18188            && name.0.len() == 1
18189            && name.0[0].as_ident().is_some()
18190            && self.consume_token(&Token::AtSign)
18191        {
18192            let user = name.0.pop().unwrap().as_ident().unwrap().clone();
18193            let host = self.parse_identifier()?;
18194            Ok(GranteeName::UserHost { user, host })
18195        } else {
18196            Ok(GranteeName::ObjectName(name))
18197        }
18198    }
18199
18200    /// Parse [`Statement::Deny`]
18201    pub fn parse_deny(&mut self) -> Result<Statement, ParserError> {
18202        self.expect_keyword(Keyword::DENY)?;
18203
18204        let (privileges, objects) = self.parse_grant_deny_revoke_privileges_objects()?;
18205        let objects = match objects {
18206            Some(o) => o,
18207            None => {
18208                return parser_err!(
18209                    "DENY statements must specify an object",
18210                    self.peek_token_ref().span.start
18211                )
18212            }
18213        };
18214
18215        self.expect_keyword_is(Keyword::TO)?;
18216        let grantees = self.parse_grantees()?;
18217        let cascade = self.parse_cascade_option();
18218        let granted_by = if self.parse_keywords(&[Keyword::AS]) {
18219            Some(self.parse_identifier()?)
18220        } else {
18221            None
18222        };
18223
18224        Ok(Statement::Deny(DenyStatement {
18225            privileges,
18226            objects,
18227            grantees,
18228            cascade,
18229            granted_by,
18230        }))
18231    }
18232
18233    /// Parse a REVOKE statement
18234    pub fn parse_revoke(&mut self) -> Result<Revoke, ParserError> {
18235        let (privileges, objects) = self.parse_grant_deny_revoke_privileges_objects()?;
18236
18237        self.expect_keyword_is(Keyword::FROM)?;
18238        let grantees = self.parse_grantees()?;
18239
18240        let granted_by = if self.parse_keywords(&[Keyword::GRANTED, Keyword::BY]) {
18241            Some(self.parse_identifier()?)
18242        } else {
18243            None
18244        };
18245
18246        let cascade = self.parse_cascade_option();
18247
18248        Ok(Revoke {
18249            privileges,
18250            objects,
18251            grantees,
18252            granted_by,
18253            cascade,
18254        })
18255    }
18256
18257    /// Parse an REPLACE statement
18258    pub fn parse_replace(
18259        &mut self,
18260        replace_token: TokenWithSpan,
18261    ) -> Result<Statement, ParserError> {
18262        if !dialect_of!(self is MySqlDialect | GenericDialect) {
18263            return parser_err!(
18264                "Unsupported statement REPLACE",
18265                self.peek_token_ref().span.start
18266            );
18267        }
18268
18269        let mut insert = self.parse_insert(replace_token)?;
18270        if let Statement::Insert(Insert { replace_into, .. }) = &mut insert {
18271            *replace_into = true;
18272        }
18273
18274        Ok(insert)
18275    }
18276
18277    /// Parse an INSERT statement, returning a `Box`ed SetExpr
18278    ///
18279    /// This is used to reduce the size of the stack frames in debug builds
18280    fn parse_insert_setexpr_boxed(
18281        &mut self,
18282        insert_token: TokenWithSpan,
18283    ) -> Result<Box<SetExpr>, ParserError> {
18284        Ok(Box::new(SetExpr::Insert(self.parse_insert(insert_token)?)))
18285    }
18286
18287    /// Parse an INSERT statement
18288    pub fn parse_insert(&mut self, insert_token: TokenWithSpan) -> Result<Statement, ParserError> {
18289        let optimizer_hints = self.maybe_parse_optimizer_hints()?;
18290        let or = self.parse_conflict_clause();
18291        let priority = if !dialect_of!(self is MySqlDialect | GenericDialect) {
18292            None
18293        } else if self.parse_keyword(Keyword::LOW_PRIORITY) {
18294            Some(MysqlInsertPriority::LowPriority)
18295        } else if self.parse_keyword(Keyword::DELAYED) {
18296            Some(MysqlInsertPriority::Delayed)
18297        } else if self.parse_keyword(Keyword::HIGH_PRIORITY) {
18298            Some(MysqlInsertPriority::HighPriority)
18299        } else {
18300            None
18301        };
18302
18303        let ignore = dialect_of!(self is MySqlDialect | GenericDialect)
18304            && self.parse_keyword(Keyword::IGNORE);
18305
18306        let replace_into = false;
18307
18308        let overwrite = self.parse_keyword(Keyword::OVERWRITE);
18309        let into = self.parse_keyword(Keyword::INTO);
18310
18311        let local = self.parse_keyword(Keyword::LOCAL);
18312
18313        if self.parse_keyword(Keyword::DIRECTORY) {
18314            let path = self.parse_literal_string()?;
18315            let file_format = if self.parse_keywords(&[Keyword::STORED, Keyword::AS]) {
18316                Some(self.parse_file_format()?)
18317            } else {
18318                None
18319            };
18320            let source = self.parse_query()?;
18321            Ok(Statement::Directory {
18322                local,
18323                path,
18324                overwrite,
18325                file_format,
18326                source,
18327            })
18328        } else {
18329            // Hive lets you put table here regardless
18330            let table = self.parse_keyword(Keyword::TABLE);
18331            let table_object = self.parse_table_object()?;
18332
18333            let table_alias = if self.dialect.supports_insert_table_alias()
18334                && !self.peek_sub_query()
18335                && self
18336                    .peek_one_of_keywords(&[Keyword::DEFAULT, Keyword::VALUES])
18337                    .is_none()
18338            {
18339                if self.parse_keyword(Keyword::AS) {
18340                    Some(TableAliasWithoutColumns {
18341                        explicit: true,
18342                        alias: self.parse_identifier()?,
18343                    })
18344                } else {
18345                    self.maybe_parse(|parser| parser.parse_identifier())?
18346                        .map(|alias| TableAliasWithoutColumns {
18347                            explicit: false,
18348                            alias,
18349                        })
18350                }
18351            } else {
18352                None
18353            };
18354
18355            let is_mysql = dialect_of!(self is MySqlDialect);
18356
18357            let (columns, partitioned, after_columns, output, source, assignments) = if self
18358                .parse_keywords(&[Keyword::DEFAULT, Keyword::VALUES])
18359            {
18360                (vec![], None, vec![], None, None, vec![])
18361            } else {
18362                let (columns, partitioned, after_columns) = if !self.peek_subquery_start() {
18363                    let columns =
18364                        self.parse_parenthesized_qualified_column_list(Optional, is_mysql)?;
18365
18366                    let partitioned = self.parse_insert_partition()?;
18367                    // Hive allows you to specify columns after partitions as well if you want.
18368                    let after_columns = if dialect_of!(self is HiveDialect) {
18369                        self.parse_parenthesized_column_list(Optional, false)?
18370                    } else {
18371                        vec![]
18372                    };
18373                    (columns, partitioned, after_columns)
18374                } else {
18375                    Default::default()
18376                };
18377
18378                let output = self.maybe_parse_output_clause()?;
18379
18380                let (source, assignments) = if self.peek_keyword(Keyword::FORMAT)
18381                    || self.peek_keyword(Keyword::SETTINGS)
18382                {
18383                    (None, vec![])
18384                } else if self.dialect.supports_insert_set() && self.parse_keyword(Keyword::SET) {
18385                    (None, self.parse_comma_separated(Parser::parse_assignment)?)
18386                } else {
18387                    (Some(self.parse_query()?), vec![])
18388                };
18389
18390                (
18391                    columns,
18392                    partitioned,
18393                    after_columns,
18394                    output,
18395                    source,
18396                    assignments,
18397                )
18398            };
18399
18400            let (format_clause, settings) = if self.dialect.supports_insert_format() {
18401                // Settings always comes before `FORMAT` for ClickHouse:
18402                // <https://clickhouse.com/docs/en/sql-reference/statements/insert-into>
18403                let settings = self.parse_settings()?;
18404
18405                let format = if self.parse_keyword(Keyword::FORMAT) {
18406                    Some(self.parse_input_format_clause()?)
18407                } else {
18408                    None
18409                };
18410
18411                (format, settings)
18412            } else {
18413                Default::default()
18414            };
18415
18416            let insert_alias = if dialect_of!(self is MySqlDialect | GenericDialect)
18417                && self.parse_keyword(Keyword::AS)
18418            {
18419                let row_alias = self.parse_object_name(false)?;
18420                let col_aliases = Some(self.parse_parenthesized_column_list(Optional, false)?);
18421                Some(InsertAliases {
18422                    row_alias,
18423                    col_aliases,
18424                })
18425            } else {
18426                None
18427            };
18428
18429            let on = if self.parse_keyword(Keyword::ON) {
18430                if self.parse_keyword(Keyword::CONFLICT) {
18431                    let conflict_target =
18432                        if self.parse_keywords(&[Keyword::ON, Keyword::CONSTRAINT]) {
18433                            Some(ConflictTarget::OnConstraint(self.parse_object_name(false)?))
18434                        } else if self.peek_token_ref().token == Token::LParen {
18435                            Some(ConflictTarget::Columns(
18436                                self.parse_parenthesized_column_list(IsOptional::Mandatory, false)?,
18437                            ))
18438                        } else {
18439                            None
18440                        };
18441
18442                    self.expect_keyword_is(Keyword::DO)?;
18443                    let action = if self.parse_keyword(Keyword::NOTHING) {
18444                        OnConflictAction::DoNothing
18445                    } else {
18446                        self.expect_keyword_is(Keyword::UPDATE)?;
18447                        self.expect_keyword_is(Keyword::SET)?;
18448                        let assignments = self.parse_comma_separated(Parser::parse_assignment)?;
18449                        let selection = if self.parse_keyword(Keyword::WHERE) {
18450                            Some(self.parse_expr()?)
18451                        } else {
18452                            None
18453                        };
18454                        OnConflictAction::DoUpdate(DoUpdate {
18455                            assignments,
18456                            selection,
18457                        })
18458                    };
18459
18460                    Some(OnInsert::OnConflict(OnConflict {
18461                        conflict_target,
18462                        action,
18463                    }))
18464                } else {
18465                    self.expect_keyword_is(Keyword::DUPLICATE)?;
18466                    self.expect_keyword_is(Keyword::KEY)?;
18467                    self.expect_keyword_is(Keyword::UPDATE)?;
18468                    let l = self.parse_comma_separated(Parser::parse_assignment)?;
18469
18470                    Some(OnInsert::DuplicateKeyUpdate(l))
18471                }
18472            } else {
18473                None
18474            };
18475
18476            let returning = if self.parse_keyword(Keyword::RETURNING) {
18477                Some(self.parse_comma_separated(Parser::parse_select_item)?)
18478            } else {
18479                None
18480            };
18481
18482            Ok(Insert {
18483                insert_token: insert_token.into(),
18484                optimizer_hints,
18485                or,
18486                table: table_object,
18487                table_alias,
18488                ignore,
18489                into,
18490                overwrite,
18491                partitioned,
18492                columns,
18493                after_columns,
18494                source,
18495                assignments,
18496                has_table_keyword: table,
18497                on,
18498                returning,
18499                output,
18500                replace_into,
18501                priority,
18502                insert_alias,
18503                settings,
18504                format_clause,
18505                multi_table_insert_type: None,
18506                multi_table_into_clauses: vec![],
18507                multi_table_when_clauses: vec![],
18508                multi_table_else_clause: None,
18509            }
18510            .into())
18511        }
18512    }
18513
18514    /// Parses input format clause used for ClickHouse.
18515    ///
18516    /// <https://clickhouse.com/docs/en/interfaces/formats>
18517    pub fn parse_input_format_clause(&mut self) -> Result<InputFormatClause, ParserError> {
18518        let ident = self.parse_identifier()?;
18519        let values = self
18520            .maybe_parse(|p| p.parse_comma_separated(|p| p.parse_expr()))?
18521            .unwrap_or_default();
18522
18523        Ok(InputFormatClause { ident, values })
18524    }
18525
18526    /// Returns true if the immediate tokens look like the
18527    /// beginning of a subquery. `(SELECT ...`
18528    fn peek_subquery_start(&mut self) -> bool {
18529        matches!(
18530            self.peek_tokens_ref(),
18531            [
18532                TokenWithSpan {
18533                    token: Token::LParen,
18534                    ..
18535                },
18536                TokenWithSpan {
18537                    token: Token::Word(Word {
18538                        keyword: Keyword::SELECT,
18539                        ..
18540                    }),
18541                    ..
18542                },
18543            ]
18544        )
18545    }
18546
18547    /// Returns true if the immediate tokens look like the
18548    /// beginning of a subquery possibly preceded by CTEs;
18549    /// i.e. `(WITH ...` or `(SELECT ...`.
18550    fn peek_subquery_or_cte_start(&mut self) -> bool {
18551        matches!(
18552            self.peek_tokens_ref(),
18553            [
18554                TokenWithSpan {
18555                    token: Token::LParen,
18556                    ..
18557                },
18558                TokenWithSpan {
18559                    token: Token::Word(Word {
18560                        keyword: Keyword::SELECT | Keyword::WITH,
18561                        ..
18562                    }),
18563                    ..
18564                },
18565            ]
18566        )
18567    }
18568
18569    fn parse_conflict_clause(&mut self) -> Option<SqliteOnConflict> {
18570        if self.parse_keywords(&[Keyword::OR, Keyword::REPLACE]) {
18571            Some(SqliteOnConflict::Replace)
18572        } else if self.parse_keywords(&[Keyword::OR, Keyword::ROLLBACK]) {
18573            Some(SqliteOnConflict::Rollback)
18574        } else if self.parse_keywords(&[Keyword::OR, Keyword::ABORT]) {
18575            Some(SqliteOnConflict::Abort)
18576        } else if self.parse_keywords(&[Keyword::OR, Keyword::FAIL]) {
18577            Some(SqliteOnConflict::Fail)
18578        } else if self.parse_keywords(&[Keyword::OR, Keyword::IGNORE]) {
18579            Some(SqliteOnConflict::Ignore)
18580        } else if self.parse_keyword(Keyword::REPLACE) {
18581            Some(SqliteOnConflict::Replace)
18582        } else {
18583            None
18584        }
18585    }
18586
18587    /// Parse an optional `PARTITION (...)` clause for INSERT statements.
18588    pub fn parse_insert_partition(&mut self) -> Result<Option<Vec<Expr>>, ParserError> {
18589        if self.parse_keyword(Keyword::PARTITION) {
18590            self.expect_token(&Token::LParen)?;
18591            let partition_cols = Some(self.parse_comma_separated(Parser::parse_expr)?);
18592            self.expect_token(&Token::RParen)?;
18593            Ok(partition_cols)
18594        } else {
18595            Ok(None)
18596        }
18597    }
18598
18599    /// Parse optional Hive `INPUTFORMAT ... SERDE ...` clause used by LOAD DATA.
18600    pub fn parse_load_data_table_format(
18601        &mut self,
18602    ) -> Result<Option<HiveLoadDataFormat>, ParserError> {
18603        if self.parse_keyword(Keyword::INPUTFORMAT) {
18604            let input_format = self.parse_expr()?;
18605            self.expect_keyword_is(Keyword::SERDE)?;
18606            let serde = self.parse_expr()?;
18607            Ok(Some(HiveLoadDataFormat {
18608                input_format,
18609                serde,
18610            }))
18611        } else {
18612            Ok(None)
18613        }
18614    }
18615
18616    /// Parse an UPDATE statement, returning a `Box`ed SetExpr
18617    ///
18618    /// This is used to reduce the size of the stack frames in debug builds
18619    fn parse_update_setexpr_boxed(
18620        &mut self,
18621        update_token: TokenWithSpan,
18622    ) -> Result<Box<SetExpr>, ParserError> {
18623        Ok(Box::new(SetExpr::Update(self.parse_update(update_token)?)))
18624    }
18625
18626    /// Parse an `UPDATE` statement and return `Statement::Update`.
18627    pub fn parse_update(&mut self, update_token: TokenWithSpan) -> Result<Statement, ParserError> {
18628        let optimizer_hints = self.maybe_parse_optimizer_hints()?;
18629        let or = self.parse_conflict_clause();
18630        let table = self.parse_table_and_joins()?;
18631        let from_before_set = if self.parse_keyword(Keyword::FROM) {
18632            Some(UpdateTableFromKind::BeforeSet(
18633                self.parse_table_with_joins()?,
18634            ))
18635        } else {
18636            None
18637        };
18638        self.expect_keyword(Keyword::SET)?;
18639        let assignments = self.parse_comma_separated(Parser::parse_assignment)?;
18640
18641        let output = self.maybe_parse_output_clause()?;
18642
18643        let from = if from_before_set.is_none() && self.parse_keyword(Keyword::FROM) {
18644            Some(UpdateTableFromKind::AfterSet(
18645                self.parse_table_with_joins()?,
18646            ))
18647        } else {
18648            from_before_set
18649        };
18650        let selection = if self.parse_keyword(Keyword::WHERE) {
18651            Some(self.parse_expr()?)
18652        } else {
18653            None
18654        };
18655        let returning = if self.parse_keyword(Keyword::RETURNING) {
18656            Some(self.parse_comma_separated(Parser::parse_select_item)?)
18657        } else {
18658            None
18659        };
18660        let order_by = if self.dialect.supports_update_order_by()
18661            && self.parse_keywords(&[Keyword::ORDER, Keyword::BY])
18662        {
18663            self.parse_comma_separated(Parser::parse_order_by_expr)?
18664        } else {
18665            vec![]
18666        };
18667        let limit = if self.parse_keyword(Keyword::LIMIT) {
18668            Some(self.parse_expr()?)
18669        } else {
18670            None
18671        };
18672        Ok(Update {
18673            update_token: update_token.into(),
18674            optimizer_hints,
18675            table,
18676            assignments,
18677            from,
18678            selection,
18679            returning,
18680            output,
18681            or,
18682            order_by,
18683            limit,
18684        }
18685        .into())
18686    }
18687
18688    /// Parse a `var = expr` assignment, used in an UPDATE statement
18689    pub fn parse_assignment(&mut self) -> Result<Assignment, ParserError> {
18690        let target = self.parse_assignment_target()?;
18691        self.expect_token(&Token::Eq)?;
18692        let value = self.parse_expr()?;
18693        Ok(Assignment { target, value })
18694    }
18695
18696    /// Parse the left-hand side of an assignment, used in an UPDATE statement
18697    pub fn parse_assignment_target(&mut self) -> Result<AssignmentTarget, ParserError> {
18698        if self.consume_token(&Token::LParen) {
18699            let columns = self.parse_comma_separated(|p| p.parse_object_name(false))?;
18700            self.expect_token(&Token::RParen)?;
18701            Ok(AssignmentTarget::Tuple(columns))
18702        } else {
18703            let column = self.parse_object_name(false)?;
18704            Ok(AssignmentTarget::ColumnName(column))
18705        }
18706    }
18707
18708    /// Parse a single function argument, handling named and unnamed variants.
18709    pub fn parse_function_args(&mut self) -> Result<FunctionArg, ParserError> {
18710        let arg = if self.dialect.supports_named_fn_args_with_expr_name() {
18711            self.maybe_parse(|p| {
18712                let name = p.parse_expr()?;
18713                let operator = p.parse_function_named_arg_operator()?;
18714                let arg = p.parse_wildcard_expr()?.into();
18715                Ok(FunctionArg::ExprNamed {
18716                    name,
18717                    arg,
18718                    operator,
18719                })
18720            })?
18721        } else {
18722            self.maybe_parse(|p| {
18723                let name = p.parse_identifier()?;
18724                let operator = p.parse_function_named_arg_operator()?;
18725                let arg = p.parse_wildcard_expr()?.into();
18726                Ok(FunctionArg::Named {
18727                    name,
18728                    arg,
18729                    operator,
18730                })
18731            })?
18732        };
18733        if let Some(arg) = arg {
18734            return Ok(arg);
18735        }
18736        let wildcard_expr = self.parse_wildcard_expr()?;
18737        let arg_expr: FunctionArgExpr = match wildcard_expr {
18738            Expr::Wildcard(ref token) if self.dialect.supports_select_wildcard_exclude() => {
18739                // Support `* EXCLUDE(col1, col2, ...)` inside function calls (e.g. Snowflake's
18740                // `HASH(* EXCLUDE(col))`).  Parse the options the same way SELECT items do.
18741                let opts = self.parse_wildcard_additional_options(token.0.clone())?;
18742                if opts.opt_exclude.is_some()
18743                    || opts.opt_except.is_some()
18744                    || opts.opt_replace.is_some()
18745                    || opts.opt_rename.is_some()
18746                    || opts.opt_ilike.is_some()
18747                {
18748                    FunctionArgExpr::WildcardWithOptions(opts)
18749                } else {
18750                    wildcard_expr.into()
18751                }
18752            }
18753            other => other.into(),
18754        };
18755        Ok(FunctionArg::Unnamed(arg_expr))
18756    }
18757
18758    fn parse_function_named_arg_operator(&mut self) -> Result<FunctionArgOperator, ParserError> {
18759        if self.parse_keyword(Keyword::VALUE) {
18760            return Ok(FunctionArgOperator::Value);
18761        }
18762        let tok = self.next_token();
18763        match tok.token {
18764            Token::RArrow if self.dialect.supports_named_fn_args_with_rarrow_operator() => {
18765                Ok(FunctionArgOperator::RightArrow)
18766            }
18767            Token::Eq if self.dialect.supports_named_fn_args_with_eq_operator() => {
18768                Ok(FunctionArgOperator::Equals)
18769            }
18770            Token::Assignment
18771                if self
18772                    .dialect
18773                    .supports_named_fn_args_with_assignment_operator() =>
18774            {
18775                Ok(FunctionArgOperator::Assignment)
18776            }
18777            Token::Colon if self.dialect.supports_named_fn_args_with_colon_operator() => {
18778                Ok(FunctionArgOperator::Colon)
18779            }
18780            _ => {
18781                self.prev_token();
18782                self.expected("argument operator", tok)
18783            }
18784        }
18785    }
18786
18787    /// Parse an optional, comma-separated list of function arguments (consumes closing paren).
18788    pub fn parse_optional_args(&mut self) -> Result<Vec<FunctionArg>, ParserError> {
18789        if self.consume_token(&Token::RParen) {
18790            Ok(vec![])
18791        } else {
18792            let args = self.parse_comma_separated(Parser::parse_function_args)?;
18793            self.expect_token(&Token::RParen)?;
18794            Ok(args)
18795        }
18796    }
18797
18798    fn parse_table_function_args(&mut self) -> Result<TableFunctionArgs, ParserError> {
18799        if self.consume_token(&Token::RParen) {
18800            return Ok(TableFunctionArgs {
18801                args: vec![],
18802                settings: None,
18803            });
18804        }
18805        let mut args = vec![];
18806        let settings = loop {
18807            if let Some(settings) = self.parse_settings()? {
18808                break Some(settings);
18809            }
18810            args.push(self.parse_function_args()?);
18811            if self.is_parse_comma_separated_end() {
18812                break None;
18813            }
18814        };
18815        self.expect_token(&Token::RParen)?;
18816        Ok(TableFunctionArgs { args, settings })
18817    }
18818
18819    /// Parses a potentially empty list of arguments to a function
18820    /// (including the closing parenthesis).
18821    ///
18822    /// Examples:
18823    /// ```sql
18824    /// FIRST_VALUE(x ORDER BY 1,2,3);
18825    /// FIRST_VALUE(x IGNORE NULL);
18826    /// ```
18827    fn parse_function_argument_list(&mut self) -> Result<FunctionArgumentList, ParserError> {
18828        let mut clauses = vec![];
18829
18830        // Handle clauses that may exist with an empty argument list
18831
18832        if let Some(null_clause) = self.parse_json_null_clause() {
18833            clauses.push(FunctionArgumentClause::JsonNullClause(null_clause));
18834        }
18835
18836        if let Some(json_returning_clause) = self.maybe_parse_json_returning_clause()? {
18837            clauses.push(FunctionArgumentClause::JsonReturningClause(
18838                json_returning_clause,
18839            ));
18840        }
18841
18842        if self.consume_token(&Token::RParen) {
18843            return Ok(FunctionArgumentList {
18844                duplicate_treatment: None,
18845                args: vec![],
18846                clauses,
18847            });
18848        }
18849
18850        let duplicate_treatment = self.parse_duplicate_treatment()?;
18851        let args = self.parse_comma_separated(Parser::parse_function_args)?;
18852
18853        if self.dialect.supports_window_function_null_treatment_arg() {
18854            if let Some(null_treatment) = self.parse_null_treatment()? {
18855                clauses.push(FunctionArgumentClause::IgnoreOrRespectNulls(null_treatment));
18856            }
18857        }
18858
18859        if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
18860            clauses.push(FunctionArgumentClause::OrderBy(
18861                self.parse_comma_separated(Parser::parse_order_by_expr)?,
18862            ));
18863        }
18864
18865        if self.parse_keyword(Keyword::LIMIT) {
18866            clauses.push(FunctionArgumentClause::Limit(self.parse_expr()?));
18867        }
18868
18869        if dialect_of!(self is GenericDialect | BigQueryDialect)
18870            && self.parse_keyword(Keyword::HAVING)
18871        {
18872            let kind = match self.expect_one_of_keywords(&[Keyword::MIN, Keyword::MAX])? {
18873                Keyword::MIN => HavingBoundKind::Min,
18874                Keyword::MAX => HavingBoundKind::Max,
18875                unexpected_keyword => return Err(ParserError::ParserError(
18876                    format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in having bound"),
18877                )),
18878            };
18879            clauses.push(FunctionArgumentClause::Having(HavingBound(
18880                kind,
18881                self.parse_expr()?,
18882            )))
18883        }
18884
18885        if dialect_of!(self is GenericDialect | MySqlDialect)
18886            && self.parse_keyword(Keyword::SEPARATOR)
18887        {
18888            clauses.push(FunctionArgumentClause::Separator(self.parse_value()?));
18889        }
18890
18891        if let Some(on_overflow) = self.parse_listagg_on_overflow()? {
18892            clauses.push(FunctionArgumentClause::OnOverflow(on_overflow));
18893        }
18894
18895        if let Some(null_clause) = self.parse_json_null_clause() {
18896            clauses.push(FunctionArgumentClause::JsonNullClause(null_clause));
18897        }
18898
18899        if let Some(json_returning_clause) = self.maybe_parse_json_returning_clause()? {
18900            clauses.push(FunctionArgumentClause::JsonReturningClause(
18901                json_returning_clause,
18902            ));
18903        }
18904
18905        self.expect_token(&Token::RParen)?;
18906        Ok(FunctionArgumentList {
18907            duplicate_treatment,
18908            args,
18909            clauses,
18910        })
18911    }
18912
18913    fn parse_json_null_clause(&mut self) -> Option<JsonNullClause> {
18914        if self.parse_keywords(&[Keyword::ABSENT, Keyword::ON, Keyword::NULL]) {
18915            Some(JsonNullClause::AbsentOnNull)
18916        } else if self.parse_keywords(&[Keyword::NULL, Keyword::ON, Keyword::NULL]) {
18917            Some(JsonNullClause::NullOnNull)
18918        } else {
18919            None
18920        }
18921    }
18922
18923    fn maybe_parse_json_returning_clause(
18924        &mut self,
18925    ) -> Result<Option<JsonReturningClause>, ParserError> {
18926        if self.parse_keyword(Keyword::RETURNING) {
18927            let data_type = self.parse_data_type()?;
18928            Ok(Some(JsonReturningClause { data_type }))
18929        } else {
18930            Ok(None)
18931        }
18932    }
18933
18934    fn parse_duplicate_treatment(&mut self) -> Result<Option<DuplicateTreatment>, ParserError> {
18935        let loc = self.peek_token_ref().span.start;
18936        match (
18937            self.parse_keyword(Keyword::ALL),
18938            self.parse_keyword(Keyword::DISTINCT),
18939        ) {
18940            (true, false) => Ok(Some(DuplicateTreatment::All)),
18941            (false, true) => Ok(Some(DuplicateTreatment::Distinct)),
18942            (false, false) => Ok(None),
18943            (true, true) => parser_err!("Cannot specify both ALL and DISTINCT".to_string(), loc),
18944        }
18945    }
18946
18947    /// Parse a comma-delimited list of projections after SELECT
18948    pub fn parse_select_item(&mut self) -> Result<SelectItem, ParserError> {
18949        let prefix = self
18950            .parse_one_of_keywords(
18951                self.dialect
18952                    .get_reserved_keywords_for_select_item_operator(),
18953            )
18954            .map(|keyword| Ident::new(format!("{keyword:?}")));
18955
18956        match self.parse_wildcard_expr()? {
18957            Expr::QualifiedWildcard(prefix, token) => Ok(SelectItem::QualifiedWildcard(
18958                SelectItemQualifiedWildcardKind::ObjectName(prefix),
18959                self.parse_wildcard_additional_options(token.0)?,
18960            )),
18961            Expr::Wildcard(token) => Ok(SelectItem::Wildcard(
18962                self.parse_wildcard_additional_options(token.0)?,
18963            )),
18964            Expr::Identifier(v) if v.value.to_lowercase() == "from" && v.quote_style.is_none() => {
18965                parser_err!(
18966                    format!("Expected an expression, found: {}", v),
18967                    self.peek_token_ref().span.start
18968                )
18969            }
18970            Expr::BinaryOp {
18971                left,
18972                op: BinaryOperator::Eq,
18973                right,
18974            } if self.dialect.supports_eq_alias_assignment()
18975                && matches!(left.as_ref(), Expr::Identifier(_)) =>
18976            {
18977                let Expr::Identifier(alias) = *left else {
18978                    return parser_err!(
18979                        "BUG: expected identifier expression as alias",
18980                        self.peek_token_ref().span.start
18981                    );
18982                };
18983                Ok(SelectItem::ExprWithAlias {
18984                    expr: *right,
18985                    alias,
18986                })
18987            }
18988            expr if self.dialect.supports_select_expr_star()
18989                && self.consume_tokens(&[Token::Period, Token::Mul]) =>
18990            {
18991                let wildcard_token = self.get_previous_token().clone();
18992                Ok(SelectItem::QualifiedWildcard(
18993                    SelectItemQualifiedWildcardKind::Expr(expr),
18994                    self.parse_wildcard_additional_options(wildcard_token)?,
18995                ))
18996            }
18997            expr if self.dialect.supports_select_item_multi_column_alias()
18998                && self.peek_keyword(Keyword::AS)
18999                && self.peek_nth_token(1).token == Token::LParen =>
19000            {
19001                self.expect_keyword(Keyword::AS)?;
19002                self.expect_token(&Token::LParen)?;
19003                let aliases = self.parse_comma_separated(|p| p.parse_identifier())?;
19004                self.expect_token(&Token::RParen)?;
19005                Ok(SelectItem::ExprWithAliases {
19006                    expr: maybe_prefixed_expr(expr, prefix),
19007                    aliases,
19008                })
19009            }
19010            expr => self
19011                .maybe_parse_select_item_alias()
19012                .map(|alias| match alias {
19013                    Some(alias) => SelectItem::ExprWithAlias {
19014                        expr: maybe_prefixed_expr(expr, prefix),
19015                        alias,
19016                    },
19017                    None => SelectItem::UnnamedExpr(maybe_prefixed_expr(expr, prefix)),
19018                }),
19019        }
19020    }
19021
19022    /// Parse an [`WildcardAdditionalOptions`] information for wildcard select items.
19023    ///
19024    /// If it is not possible to parse it, will return an option.
19025    pub fn parse_wildcard_additional_options(
19026        &mut self,
19027        wildcard_token: TokenWithSpan,
19028    ) -> Result<WildcardAdditionalOptions, ParserError> {
19029        let opt_ilike = if self.dialect.supports_select_wildcard_ilike() {
19030            self.parse_optional_select_item_ilike()?
19031        } else {
19032            None
19033        };
19034        let opt_exclude = if opt_ilike.is_none() && self.dialect.supports_select_wildcard_exclude()
19035        {
19036            self.parse_optional_select_item_exclude()?
19037        } else {
19038            None
19039        };
19040        let opt_except = if self.dialect.supports_select_wildcard_except() {
19041            self.parse_optional_select_item_except()?
19042        } else {
19043            None
19044        };
19045        let opt_replace = if self.dialect.supports_select_wildcard_replace() {
19046            self.parse_optional_select_item_replace()?
19047        } else {
19048            None
19049        };
19050        let opt_rename = if self.dialect.supports_select_wildcard_rename() {
19051            self.parse_optional_select_item_rename()?
19052        } else {
19053            None
19054        };
19055
19056        let opt_alias = if self.dialect.supports_select_wildcard_with_alias() {
19057            self.maybe_parse_select_item_alias()?
19058        } else {
19059            None
19060        };
19061
19062        Ok(WildcardAdditionalOptions {
19063            wildcard_token: wildcard_token.into(),
19064            opt_ilike,
19065            opt_exclude,
19066            opt_except,
19067            opt_rename,
19068            opt_replace,
19069            opt_alias,
19070        })
19071    }
19072
19073    /// Parse an [`Ilike`](IlikeSelectItem) information for wildcard select items.
19074    ///
19075    /// If it is not possible to parse it, will return an option.
19076    pub fn parse_optional_select_item_ilike(
19077        &mut self,
19078    ) -> Result<Option<IlikeSelectItem>, ParserError> {
19079        let opt_ilike = if self.parse_keyword(Keyword::ILIKE) {
19080            let next_token = self.next_token();
19081            let pattern = match next_token.token {
19082                Token::SingleQuotedString(s) => s,
19083                _ => return self.expected("ilike pattern", next_token),
19084            };
19085            Some(IlikeSelectItem { pattern })
19086        } else {
19087            None
19088        };
19089        Ok(opt_ilike)
19090    }
19091
19092    /// Parse an [`Exclude`](ExcludeSelectItem) information for wildcard select items.
19093    ///
19094    /// If it is not possible to parse it, will return an option.
19095    pub fn parse_optional_select_item_exclude(
19096        &mut self,
19097    ) -> Result<Option<ExcludeSelectItem>, ParserError> {
19098        let opt_exclude = if self.parse_keyword(Keyword::EXCLUDE) {
19099            if self.consume_token(&Token::LParen) {
19100                let columns =
19101                    self.parse_comma_separated(|parser| parser.parse_object_name(false))?;
19102                self.expect_token(&Token::RParen)?;
19103                Some(ExcludeSelectItem::Multiple(columns))
19104            } else {
19105                let column = self.parse_object_name(false)?;
19106                Some(ExcludeSelectItem::Single(column))
19107            }
19108        } else {
19109            None
19110        };
19111
19112        Ok(opt_exclude)
19113    }
19114
19115    /// Parse an [`Except`](ExceptSelectItem) information for wildcard select items.
19116    ///
19117    /// If it is not possible to parse it, will return an option.
19118    pub fn parse_optional_select_item_except(
19119        &mut self,
19120    ) -> Result<Option<ExceptSelectItem>, ParserError> {
19121        let opt_except = if self.parse_keyword(Keyword::EXCEPT) {
19122            if self.peek_token_ref().token == Token::LParen {
19123                let idents = self.parse_parenthesized_column_list(Mandatory, false)?;
19124                match &idents[..] {
19125                    [] => {
19126                        return self.expected_ref(
19127                            "at least one column should be parsed by the expect clause",
19128                            self.peek_token_ref(),
19129                        )?;
19130                    }
19131                    [first, idents @ ..] => Some(ExceptSelectItem {
19132                        first_element: first.clone(),
19133                        additional_elements: idents.to_vec(),
19134                    }),
19135                }
19136            } else {
19137                // Clickhouse allows EXCEPT column_name
19138                let ident = self.parse_identifier()?;
19139                Some(ExceptSelectItem {
19140                    first_element: ident,
19141                    additional_elements: vec![],
19142                })
19143            }
19144        } else {
19145            None
19146        };
19147
19148        Ok(opt_except)
19149    }
19150
19151    /// Parse a [`Rename`](RenameSelectItem) information for wildcard select items.
19152    pub fn parse_optional_select_item_rename(
19153        &mut self,
19154    ) -> Result<Option<RenameSelectItem>, ParserError> {
19155        let opt_rename = if self.parse_keyword(Keyword::RENAME) {
19156            if self.consume_token(&Token::LParen) {
19157                let idents =
19158                    self.parse_comma_separated(|parser| parser.parse_identifier_with_alias())?;
19159                self.expect_token(&Token::RParen)?;
19160                Some(RenameSelectItem::Multiple(idents))
19161            } else {
19162                let ident = self.parse_identifier_with_alias()?;
19163                Some(RenameSelectItem::Single(ident))
19164            }
19165        } else {
19166            None
19167        };
19168
19169        Ok(opt_rename)
19170    }
19171
19172    /// Parse a [`Replace`](ReplaceSelectItem) information for wildcard select items.
19173    pub fn parse_optional_select_item_replace(
19174        &mut self,
19175    ) -> Result<Option<ReplaceSelectItem>, ParserError> {
19176        let opt_replace = if self.parse_keyword(Keyword::REPLACE) {
19177            if self.consume_token(&Token::LParen) {
19178                let items = self.parse_comma_separated(|parser| {
19179                    Ok(Box::new(parser.parse_replace_elements()?))
19180                })?;
19181                self.expect_token(&Token::RParen)?;
19182                Some(ReplaceSelectItem { items })
19183            } else {
19184                let tok = self.next_token();
19185                return self.expected("( after REPLACE but", tok);
19186            }
19187        } else {
19188            None
19189        };
19190
19191        Ok(opt_replace)
19192    }
19193    /// Parse a single element of a `REPLACE (...)` select-item clause.
19194    pub fn parse_replace_elements(&mut self) -> Result<ReplaceSelectElement, ParserError> {
19195        let expr = self.parse_expr()?;
19196        let as_keyword = self.parse_keyword(Keyword::AS);
19197        let ident = self.parse_identifier()?;
19198        Ok(ReplaceSelectElement {
19199            expr,
19200            column_name: ident,
19201            as_keyword,
19202        })
19203    }
19204
19205    /// Parse ASC or DESC, returns an Option with true if ASC, false of DESC or `None` if none of
19206    /// them.
19207    pub fn parse_asc_desc(&mut self) -> Option<bool> {
19208        if self.parse_keyword(Keyword::ASC) {
19209            Some(true)
19210        } else if self.parse_keyword(Keyword::DESC) {
19211            Some(false)
19212        } else {
19213            None
19214        }
19215    }
19216
19217    /// Parse an [OrderByExpr] expression.
19218    pub fn parse_order_by_expr(&mut self) -> Result<OrderByExpr, ParserError> {
19219        self.parse_order_by_expr_inner(false)
19220            .map(|(order_by, _)| order_by)
19221    }
19222
19223    /// Parse an [IndexColumn].
19224    pub fn parse_create_index_expr(&mut self) -> Result<IndexColumn, ParserError> {
19225        self.parse_order_by_expr_inner(true)
19226            .map(|(column, operator_class)| IndexColumn {
19227                column,
19228                operator_class,
19229            })
19230    }
19231
19232    fn parse_order_by_expr_inner(
19233        &mut self,
19234        with_operator_class: bool,
19235    ) -> Result<(OrderByExpr, Option<ObjectName>), ParserError> {
19236        let expr = self.parse_expr()?;
19237
19238        let operator_class: Option<ObjectName> = if with_operator_class {
19239            // We check that if non of the following keywords are present, then we parse an
19240            // identifier as operator class.
19241            if self
19242                .peek_one_of_keywords(&[Keyword::ASC, Keyword::DESC, Keyword::NULLS, Keyword::WITH])
19243                .is_some()
19244            {
19245                None
19246            } else {
19247                self.maybe_parse(|parser| parser.parse_object_name(false))?
19248            }
19249        } else {
19250            None
19251        };
19252
19253        let options = self.parse_order_by_options()?;
19254
19255        let with_fill = if self.dialect.supports_with_fill()
19256            && self.parse_keywords(&[Keyword::WITH, Keyword::FILL])
19257        {
19258            Some(self.parse_with_fill()?)
19259        } else {
19260            None
19261        };
19262
19263        Ok((
19264            OrderByExpr {
19265                expr,
19266                options,
19267                with_fill,
19268            },
19269            operator_class,
19270        ))
19271    }
19272
19273    fn parse_order_by_options(&mut self) -> Result<OrderByOptions, ParserError> {
19274        let asc = self.parse_asc_desc();
19275
19276        let nulls_first = if self.parse_keywords(&[Keyword::NULLS, Keyword::FIRST]) {
19277            Some(true)
19278        } else if self.parse_keywords(&[Keyword::NULLS, Keyword::LAST]) {
19279            Some(false)
19280        } else {
19281            None
19282        };
19283
19284        Ok(OrderByOptions { asc, nulls_first })
19285    }
19286
19287    // Parse a WITH FILL clause (ClickHouse dialect)
19288    // that follow the WITH FILL keywords in a ORDER BY clause
19289    /// Parse a `WITH FILL` clause used in ORDER BY (ClickHouse dialect).
19290    pub fn parse_with_fill(&mut self) -> Result<WithFill, ParserError> {
19291        let from = if self.parse_keyword(Keyword::FROM) {
19292            Some(self.parse_expr()?)
19293        } else {
19294            None
19295        };
19296
19297        let to = if self.parse_keyword(Keyword::TO) {
19298            Some(self.parse_expr()?)
19299        } else {
19300            None
19301        };
19302
19303        let step = if self.parse_keyword(Keyword::STEP) {
19304            Some(self.parse_expr()?)
19305        } else {
19306            None
19307        };
19308
19309        Ok(WithFill { from, to, step })
19310    }
19311
19312    /// Parse a set of comma separated INTERPOLATE expressions (ClickHouse dialect)
19313    /// that follow the INTERPOLATE keyword in an ORDER BY clause with the WITH FILL modifier
19314    pub fn parse_interpolations(&mut self) -> Result<Option<Interpolate>, ParserError> {
19315        if !self.parse_keyword(Keyword::INTERPOLATE) {
19316            return Ok(None);
19317        }
19318
19319        if self.consume_token(&Token::LParen) {
19320            let interpolations =
19321                self.parse_comma_separated0(|p| p.parse_interpolation(), Token::RParen)?;
19322            self.expect_token(&Token::RParen)?;
19323            // INTERPOLATE () and INTERPOLATE ( ... ) variants
19324            return Ok(Some(Interpolate {
19325                exprs: Some(interpolations),
19326            }));
19327        }
19328
19329        // INTERPOLATE
19330        Ok(Some(Interpolate { exprs: None }))
19331    }
19332
19333    /// Parse a INTERPOLATE expression (ClickHouse dialect)
19334    pub fn parse_interpolation(&mut self) -> Result<InterpolateExpr, ParserError> {
19335        let column = self.parse_identifier()?;
19336        let expr = if self.parse_keyword(Keyword::AS) {
19337            Some(self.parse_expr()?)
19338        } else {
19339            None
19340        };
19341        Ok(InterpolateExpr { column, expr })
19342    }
19343
19344    /// Parse a TOP clause, MSSQL equivalent of LIMIT,
19345    /// that follows after `SELECT [DISTINCT]`.
19346    pub fn parse_top(&mut self) -> Result<Top, ParserError> {
19347        let quantity = if self.consume_token(&Token::LParen) {
19348            let quantity = self.parse_expr()?;
19349            self.expect_token(&Token::RParen)?;
19350            Some(TopQuantity::Expr(quantity))
19351        } else {
19352            let next_token = self.next_token();
19353            let quantity = match next_token.token {
19354                Token::Number(s, _) => Self::parse::<u64>(s, next_token.span.start)?,
19355                _ => self.expected("literal int", next_token)?,
19356            };
19357            Some(TopQuantity::Constant(quantity))
19358        };
19359
19360        let percent = self.parse_keyword(Keyword::PERCENT);
19361
19362        let with_ties = self.parse_keywords(&[Keyword::WITH, Keyword::TIES]);
19363
19364        Ok(Top {
19365            with_ties,
19366            percent,
19367            quantity,
19368        })
19369    }
19370
19371    /// Parse a LIMIT clause
19372    pub fn parse_limit(&mut self) -> Result<Option<Expr>, ParserError> {
19373        if self.parse_keyword(Keyword::ALL) {
19374            Ok(None)
19375        } else {
19376            Ok(Some(self.parse_expr()?))
19377        }
19378    }
19379
19380    /// Parse an OFFSET clause
19381    pub fn parse_offset(&mut self) -> Result<Offset, ParserError> {
19382        let value = self.parse_expr()?;
19383        let rows = if self.parse_keyword(Keyword::ROW) {
19384            OffsetRows::Row
19385        } else if self.parse_keyword(Keyword::ROWS) {
19386            OffsetRows::Rows
19387        } else {
19388            OffsetRows::None
19389        };
19390        Ok(Offset { value, rows })
19391    }
19392
19393    /// Parse a FETCH clause
19394    pub fn parse_fetch(&mut self) -> Result<Fetch, ParserError> {
19395        let _ = self.parse_one_of_keywords(&[Keyword::FIRST, Keyword::NEXT]);
19396
19397        let (quantity, percent) = if self
19398            .parse_one_of_keywords(&[Keyword::ROW, Keyword::ROWS])
19399            .is_some()
19400        {
19401            (None, false)
19402        } else {
19403            let quantity = Expr::Value(self.parse_value()?);
19404            let percent = self.parse_keyword(Keyword::PERCENT);
19405            let _ = self.parse_one_of_keywords(&[Keyword::ROW, Keyword::ROWS]);
19406            (Some(quantity), percent)
19407        };
19408
19409        let with_ties = if self.parse_keyword(Keyword::ONLY) {
19410            false
19411        } else {
19412            self.parse_keywords(&[Keyword::WITH, Keyword::TIES])
19413        };
19414
19415        Ok(Fetch {
19416            with_ties,
19417            percent,
19418            quantity,
19419        })
19420    }
19421
19422    /// Parse a FOR UPDATE/FOR SHARE clause
19423    pub fn parse_lock(&mut self) -> Result<LockClause, ParserError> {
19424        let lock_type = match self.expect_one_of_keywords(&[Keyword::UPDATE, Keyword::SHARE])? {
19425            Keyword::UPDATE => LockType::Update,
19426            Keyword::SHARE => LockType::Share,
19427            unexpected_keyword => return Err(ParserError::ParserError(
19428                format!("Internal parser error: expected any of {{UPDATE, SHARE}}, got {unexpected_keyword:?}"),
19429            )),
19430        };
19431        let of = if self.parse_keyword(Keyword::OF) {
19432            Some(self.parse_object_name(false)?)
19433        } else {
19434            None
19435        };
19436        let nonblock = if self.parse_keyword(Keyword::NOWAIT) {
19437            Some(NonBlock::Nowait)
19438        } else if self.parse_keywords(&[Keyword::SKIP, Keyword::LOCKED]) {
19439            Some(NonBlock::SkipLocked)
19440        } else {
19441            None
19442        };
19443        Ok(LockClause {
19444            lock_type,
19445            of,
19446            nonblock,
19447        })
19448    }
19449
19450    /// Parse a PostgreSQL `LOCK` statement.
19451    pub fn parse_lock_statement(&mut self) -> Result<Lock, ParserError> {
19452        self.expect_keyword(Keyword::LOCK)?;
19453
19454        if self.peek_keyword(Keyword::TABLES) {
19455            return self.expected_ref("TABLE or a table name", self.peek_token_ref());
19456        }
19457
19458        let _ = self.parse_keyword(Keyword::TABLE);
19459        let tables = self.parse_comma_separated(Parser::parse_lock_table_target)?;
19460        let lock_mode = if self.parse_keyword(Keyword::IN) {
19461            let lock_mode = self.parse_lock_table_mode()?;
19462            self.expect_keyword(Keyword::MODE)?;
19463            Some(lock_mode)
19464        } else {
19465            None
19466        };
19467        let nowait = self.parse_keyword(Keyword::NOWAIT);
19468
19469        Ok(Lock {
19470            tables,
19471            lock_mode,
19472            nowait,
19473        })
19474    }
19475
19476    fn parse_lock_table_target(&mut self) -> Result<LockTableTarget, ParserError> {
19477        let only = self.parse_keyword(Keyword::ONLY);
19478        let name = self.parse_object_name(false)?;
19479        let has_asterisk = self.consume_token(&Token::Mul);
19480
19481        Ok(LockTableTarget {
19482            name,
19483            only,
19484            has_asterisk,
19485        })
19486    }
19487
19488    fn parse_lock_table_mode(&mut self) -> Result<LockTableMode, ParserError> {
19489        if self.parse_keywords(&[Keyword::ACCESS, Keyword::SHARE]) {
19490            Ok(LockTableMode::AccessShare)
19491        } else if self.parse_keywords(&[Keyword::ACCESS, Keyword::EXCLUSIVE]) {
19492            Ok(LockTableMode::AccessExclusive)
19493        } else if self.parse_keywords(&[Keyword::ROW, Keyword::SHARE]) {
19494            Ok(LockTableMode::RowShare)
19495        } else if self.parse_keywords(&[Keyword::ROW, Keyword::EXCLUSIVE]) {
19496            Ok(LockTableMode::RowExclusive)
19497        } else if self.parse_keywords(&[Keyword::SHARE, Keyword::UPDATE, Keyword::EXCLUSIVE]) {
19498            Ok(LockTableMode::ShareUpdateExclusive)
19499        } else if self.parse_keywords(&[Keyword::SHARE, Keyword::ROW, Keyword::EXCLUSIVE]) {
19500            Ok(LockTableMode::ShareRowExclusive)
19501        } else if self.parse_keyword(Keyword::SHARE) {
19502            Ok(LockTableMode::Share)
19503        } else if self.parse_keyword(Keyword::EXCLUSIVE) {
19504            Ok(LockTableMode::Exclusive)
19505        } else {
19506            self.expected_ref("a PostgreSQL LOCK TABLE mode", self.peek_token_ref())
19507        }
19508    }
19509
19510    /// Parse a VALUES clause
19511    pub fn parse_values(
19512        &mut self,
19513        allow_empty: bool,
19514        value_keyword: bool,
19515    ) -> Result<Values, ParserError> {
19516        let mut explicit_row = false;
19517
19518        let rows = self.parse_comma_separated(|parser| {
19519            if parser.parse_keyword(Keyword::ROW) {
19520                explicit_row = true;
19521            }
19522
19523            parser.expect_token(&Token::LParen)?;
19524            if allow_empty && parser.peek_token().token == Token::RParen {
19525                parser.next_token();
19526                Ok(vec![])
19527            } else {
19528                let exprs = parser.parse_comma_separated(Parser::parse_expr)?;
19529                parser.expect_token(&Token::RParen)?;
19530                Ok(exprs)
19531            }
19532        })?;
19533        Ok(Values {
19534            explicit_row,
19535            rows,
19536            value_keyword,
19537        })
19538    }
19539
19540    /// Parse a 'START TRANSACTION' statement
19541    pub fn parse_start_transaction(&mut self) -> Result<Statement, ParserError> {
19542        self.expect_keyword_is(Keyword::TRANSACTION)?;
19543        Ok(Statement::StartTransaction {
19544            modes: self.parse_transaction_modes()?,
19545            begin: false,
19546            transaction: Some(BeginTransactionKind::Transaction),
19547            modifier: None,
19548            statements: vec![],
19549            exception: None,
19550            has_end_keyword: false,
19551        })
19552    }
19553
19554    /// Parse a transaction modifier keyword that can follow a `BEGIN` statement.
19555    pub(crate) fn parse_transaction_modifier(&mut self) -> Option<TransactionModifier> {
19556        if !self.dialect.supports_start_transaction_modifier() {
19557            None
19558        } else if self.parse_keyword(Keyword::DEFERRED) {
19559            Some(TransactionModifier::Deferred)
19560        } else if self.parse_keyword(Keyword::IMMEDIATE) {
19561            Some(TransactionModifier::Immediate)
19562        } else if self.parse_keyword(Keyword::EXCLUSIVE) {
19563            Some(TransactionModifier::Exclusive)
19564        } else if self.parse_keyword(Keyword::TRY) {
19565            Some(TransactionModifier::Try)
19566        } else if self.parse_keyword(Keyword::CATCH) {
19567            Some(TransactionModifier::Catch)
19568        } else {
19569            None
19570        }
19571    }
19572
19573    /// Parse a 'BEGIN' statement
19574    pub fn parse_begin(&mut self) -> Result<Statement, ParserError> {
19575        let modifier = self.parse_transaction_modifier();
19576        let transaction =
19577            match self.parse_one_of_keywords(&[Keyword::TRANSACTION, Keyword::WORK, Keyword::TRAN])
19578            {
19579                Some(Keyword::TRANSACTION) => Some(BeginTransactionKind::Transaction),
19580                Some(Keyword::WORK) => Some(BeginTransactionKind::Work),
19581                Some(Keyword::TRAN) => Some(BeginTransactionKind::Tran),
19582                _ => None,
19583            };
19584        Ok(Statement::StartTransaction {
19585            modes: self.parse_transaction_modes()?,
19586            begin: true,
19587            transaction,
19588            modifier,
19589            statements: vec![],
19590            exception: None,
19591            has_end_keyword: false,
19592        })
19593    }
19594
19595    /// Parse a 'BEGIN ... EXCEPTION ... END' block
19596    pub fn parse_begin_exception_end(&mut self) -> Result<Statement, ParserError> {
19597        let statements = self.parse_statement_list(&[Keyword::EXCEPTION, Keyword::END])?;
19598
19599        let exception = if self.parse_keyword(Keyword::EXCEPTION) {
19600            let mut when = Vec::new();
19601
19602            // We can have multiple `WHEN` arms so we consume all cases until `END`
19603            while !self.peek_keyword(Keyword::END) {
19604                self.expect_keyword(Keyword::WHEN)?;
19605
19606                // Each `WHEN` case can have one or more conditions, e.g.
19607                // WHEN EXCEPTION_1 [OR EXCEPTION_2] THEN
19608                // So we parse identifiers until the `THEN` keyword.
19609                let mut idents = Vec::new();
19610
19611                while !self.parse_keyword(Keyword::THEN) {
19612                    let ident = self.parse_identifier()?;
19613                    idents.push(ident);
19614
19615                    self.maybe_parse(|p| p.expect_keyword(Keyword::OR))?;
19616                }
19617
19618                let statements = self.parse_statement_list(&[Keyword::WHEN, Keyword::END])?;
19619
19620                when.push(ExceptionWhen { idents, statements });
19621            }
19622
19623            Some(when)
19624        } else {
19625            None
19626        };
19627
19628        self.expect_keyword(Keyword::END)?;
19629
19630        Ok(Statement::StartTransaction {
19631            begin: true,
19632            statements,
19633            exception,
19634            has_end_keyword: true,
19635            transaction: None,
19636            modifier: None,
19637            modes: Default::default(),
19638        })
19639    }
19640
19641    /// Parse an 'END' statement
19642    pub fn parse_end(&mut self) -> Result<Statement, ParserError> {
19643        let modifier = if !self.dialect.supports_end_transaction_modifier() {
19644            None
19645        } else if self.parse_keyword(Keyword::TRY) {
19646            Some(TransactionModifier::Try)
19647        } else if self.parse_keyword(Keyword::CATCH) {
19648            Some(TransactionModifier::Catch)
19649        } else {
19650            None
19651        };
19652        Ok(Statement::Commit {
19653            chain: self.parse_commit_rollback_chain()?,
19654            end: true,
19655            modifier,
19656        })
19657    }
19658
19659    /// Parse a list of transaction modes
19660    pub fn parse_transaction_modes(&mut self) -> Result<Vec<TransactionMode>, ParserError> {
19661        let mut modes = vec![];
19662        let mut required = false;
19663        loop {
19664            let mode = if self.parse_keywords(&[Keyword::ISOLATION, Keyword::LEVEL]) {
19665                let iso_level = if self.parse_keywords(&[Keyword::READ, Keyword::UNCOMMITTED]) {
19666                    TransactionIsolationLevel::ReadUncommitted
19667                } else if self.parse_keywords(&[Keyword::READ, Keyword::COMMITTED]) {
19668                    TransactionIsolationLevel::ReadCommitted
19669                } else if self.parse_keywords(&[Keyword::REPEATABLE, Keyword::READ]) {
19670                    TransactionIsolationLevel::RepeatableRead
19671                } else if self.parse_keyword(Keyword::SERIALIZABLE) {
19672                    TransactionIsolationLevel::Serializable
19673                } else if self.parse_keyword(Keyword::SNAPSHOT) {
19674                    TransactionIsolationLevel::Snapshot
19675                } else {
19676                    self.expected_ref("isolation level", self.peek_token_ref())?
19677                };
19678                TransactionMode::IsolationLevel(iso_level)
19679            } else if self.parse_keywords(&[Keyword::READ, Keyword::ONLY]) {
19680                TransactionMode::AccessMode(TransactionAccessMode::ReadOnly)
19681            } else if self.parse_keywords(&[Keyword::READ, Keyword::WRITE]) {
19682                TransactionMode::AccessMode(TransactionAccessMode::ReadWrite)
19683            } else if required {
19684                self.expected_ref("transaction mode", self.peek_token_ref())?
19685            } else {
19686                break;
19687            };
19688            modes.push(mode);
19689            // ANSI requires a comma after each transaction mode, but
19690            // PostgreSQL, for historical reasons, does not. We follow
19691            // PostgreSQL in making the comma optional, since that is strictly
19692            // more general.
19693            required = self.consume_token(&Token::Comma);
19694        }
19695        Ok(modes)
19696    }
19697
19698    /// Parse a 'COMMIT' statement
19699    pub fn parse_commit(&mut self) -> Result<Statement, ParserError> {
19700        Ok(Statement::Commit {
19701            chain: self.parse_commit_rollback_chain()?,
19702            end: false,
19703            modifier: None,
19704        })
19705    }
19706
19707    /// Parse a 'ROLLBACK' statement
19708    pub fn parse_rollback(&mut self) -> Result<Statement, ParserError> {
19709        let chain = self.parse_commit_rollback_chain()?;
19710        let savepoint = self.parse_rollback_savepoint()?;
19711
19712        Ok(Statement::Rollback { chain, savepoint })
19713    }
19714
19715    /// Parse an optional `AND [NO] CHAIN` clause for `COMMIT` and `ROLLBACK` statements
19716    pub fn parse_commit_rollback_chain(&mut self) -> Result<bool, ParserError> {
19717        let _ = self.parse_one_of_keywords(&[Keyword::TRANSACTION, Keyword::WORK, Keyword::TRAN]);
19718        if self.parse_keyword(Keyword::AND) {
19719            let chain = !self.parse_keyword(Keyword::NO);
19720            self.expect_keyword_is(Keyword::CHAIN)?;
19721            Ok(chain)
19722        } else {
19723            Ok(false)
19724        }
19725    }
19726
19727    /// Parse an optional 'TO SAVEPOINT savepoint_name' clause for ROLLBACK statements
19728    pub fn parse_rollback_savepoint(&mut self) -> Result<Option<Ident>, ParserError> {
19729        if self.parse_keyword(Keyword::TO) {
19730            let _ = self.parse_keyword(Keyword::SAVEPOINT);
19731            let savepoint = self.parse_identifier()?;
19732
19733            Ok(Some(savepoint))
19734        } else {
19735            Ok(None)
19736        }
19737    }
19738
19739    /// Parse a 'RAISERROR' statement
19740    pub fn parse_raiserror(&mut self) -> Result<Statement, ParserError> {
19741        self.expect_token(&Token::LParen)?;
19742        let message = Box::new(self.parse_expr()?);
19743        self.expect_token(&Token::Comma)?;
19744        let severity = Box::new(self.parse_expr()?);
19745        self.expect_token(&Token::Comma)?;
19746        let state = Box::new(self.parse_expr()?);
19747        let arguments = if self.consume_token(&Token::Comma) {
19748            self.parse_comma_separated(Parser::parse_expr)?
19749        } else {
19750            vec![]
19751        };
19752        self.expect_token(&Token::RParen)?;
19753        let options = if self.parse_keyword(Keyword::WITH) {
19754            self.parse_comma_separated(Parser::parse_raiserror_option)?
19755        } else {
19756            vec![]
19757        };
19758        Ok(Statement::RaisError {
19759            message,
19760            severity,
19761            state,
19762            arguments,
19763            options,
19764        })
19765    }
19766
19767    /// Parse a single `RAISERROR` option
19768    pub fn parse_raiserror_option(&mut self) -> Result<RaisErrorOption, ParserError> {
19769        match self.expect_one_of_keywords(&[Keyword::LOG, Keyword::NOWAIT, Keyword::SETERROR])? {
19770            Keyword::LOG => Ok(RaisErrorOption::Log),
19771            Keyword::NOWAIT => Ok(RaisErrorOption::NoWait),
19772            Keyword::SETERROR => Ok(RaisErrorOption::SetError),
19773            _ => self.expected_ref(
19774                "LOG, NOWAIT OR SETERROR raiserror option",
19775                self.peek_token_ref(),
19776            ),
19777        }
19778    }
19779
19780    /// Parse a MSSQL `THROW` statement.
19781    ///
19782    /// See [Statement::Throw]
19783    pub fn parse_throw(&mut self) -> Result<ThrowStatement, ParserError> {
19784        self.expect_keyword_is(Keyword::THROW)?;
19785
19786        let error_number = self.maybe_parse(|p| p.parse_expr().map(Box::new))?;
19787        let (message, state) = if error_number.is_some() {
19788            self.expect_token(&Token::Comma)?;
19789            let message = Box::new(self.parse_expr()?);
19790            self.expect_token(&Token::Comma)?;
19791            let state = Box::new(self.parse_expr()?);
19792            (Some(message), Some(state))
19793        } else {
19794            (None, None)
19795        };
19796
19797        Ok(ThrowStatement {
19798            error_number,
19799            message,
19800            state,
19801        })
19802    }
19803
19804    /// Parse a SQL `DEALLOCATE` statement
19805    pub fn parse_deallocate(&mut self) -> Result<Statement, ParserError> {
19806        let prepare = self.parse_keyword(Keyword::PREPARE);
19807        let name = self.parse_identifier()?;
19808        Ok(Statement::Deallocate { name, prepare })
19809    }
19810
19811    /// Parse a SQL `EXECUTE` statement
19812    pub fn parse_execute(&mut self) -> Result<Statement, ParserError> {
19813        let immediate =
19814            self.dialect.supports_execute_immediate() && self.parse_keyword(Keyword::IMMEDIATE);
19815
19816        // When `EXEC` is immediately followed by `(`, the content is a dynamic-SQL
19817        // expression — e.g. `EXEC (@sql)`, `EXEC ('SELECT ...')`, or
19818        // `EXEC ('SELECT ... FROM ' + @tbl + ' WHERE ...')`.
19819        // Skip name parsing; the expression ends up in `parameters` via the
19820        // `has_parentheses` path below, consistent with `EXECUTE IMMEDIATE <expr>`.
19821        let name = if immediate || matches!(self.peek_token_ref().token, Token::LParen) {
19822            None
19823        } else {
19824            Some(self.parse_object_name(false)?)
19825        };
19826
19827        let has_parentheses = self.consume_token(&Token::LParen);
19828
19829        let end_kws = &[Keyword::USING, Keyword::OUTPUT, Keyword::DEFAULT];
19830        let end_token = match (has_parentheses, self.peek_token().token) {
19831            (true, _) => Token::RParen,
19832            (false, Token::EOF) => Token::EOF,
19833            (false, Token::Word(w)) if end_kws.contains(&w.keyword) => Token::Word(w),
19834            (false, _) => Token::SemiColon,
19835        };
19836
19837        let parameters = self.parse_comma_separated0(Parser::parse_expr, end_token)?;
19838
19839        if has_parentheses {
19840            self.expect_token(&Token::RParen)?;
19841        }
19842
19843        let into = if self.parse_keyword(Keyword::INTO) {
19844            self.parse_comma_separated(Self::parse_identifier)?
19845        } else {
19846            vec![]
19847        };
19848
19849        let using = if self.parse_keyword(Keyword::USING) {
19850            self.parse_comma_separated(Self::parse_expr_with_alias)?
19851        } else {
19852            vec![]
19853        };
19854
19855        let output = self.parse_keyword(Keyword::OUTPUT);
19856
19857        let default = self.parse_keyword(Keyword::DEFAULT);
19858
19859        Ok(Statement::Execute {
19860            immediate,
19861            name,
19862            parameters,
19863            has_parentheses,
19864            into,
19865            using,
19866            output,
19867            default,
19868        })
19869    }
19870
19871    /// Parse a SQL `PREPARE` statement
19872    pub fn parse_prepare(&mut self) -> Result<Statement, ParserError> {
19873        let name = self.parse_identifier()?;
19874
19875        let mut data_types = vec![];
19876        if self.consume_token(&Token::LParen) {
19877            data_types = self.parse_comma_separated(Parser::parse_data_type)?;
19878            self.expect_token(&Token::RParen)?;
19879        }
19880
19881        self.expect_keyword_is(Keyword::AS)?;
19882        let statement = Box::new(self.parse_statement()?);
19883        Ok(Statement::Prepare {
19884            name,
19885            data_types,
19886            statement,
19887        })
19888    }
19889
19890    /// Parse a SQL `UNLOAD` statement
19891    pub fn parse_unload(&mut self) -> Result<Statement, ParserError> {
19892        self.expect_keyword(Keyword::UNLOAD)?;
19893        self.expect_token(&Token::LParen)?;
19894        let (query, query_text) =
19895            if matches!(self.peek_token_ref().token, Token::SingleQuotedString(_)) {
19896                (None, Some(self.parse_literal_string()?))
19897            } else {
19898                (Some(self.parse_query()?), None)
19899            };
19900        self.expect_token(&Token::RParen)?;
19901
19902        self.expect_keyword_is(Keyword::TO)?;
19903        let to = self.parse_identifier()?;
19904        let auth = if self.parse_keyword(Keyword::IAM_ROLE) {
19905            Some(self.parse_iam_role_kind()?)
19906        } else {
19907            None
19908        };
19909        let with = self.parse_options(Keyword::WITH)?;
19910        let mut options = vec![];
19911        while let Some(opt) = self.maybe_parse(|parser| parser.parse_copy_legacy_option())? {
19912            options.push(opt);
19913        }
19914        Ok(Statement::Unload {
19915            query,
19916            query_text,
19917            to,
19918            auth,
19919            with,
19920            options,
19921        })
19922    }
19923
19924    fn parse_select_into(&mut self) -> Result<SelectInto, ParserError> {
19925        let temporary = self
19926            .parse_one_of_keywords(&[Keyword::TEMP, Keyword::TEMPORARY])
19927            .is_some();
19928        let unlogged = self.parse_keyword(Keyword::UNLOGGED);
19929        let table = self.parse_keyword(Keyword::TABLE);
19930        let name = self.parse_object_name(false)?;
19931
19932        Ok(SelectInto {
19933            temporary,
19934            unlogged,
19935            table,
19936            name,
19937        })
19938    }
19939
19940    fn parse_pragma_value(&mut self) -> Result<ValueWithSpan, ParserError> {
19941        let v = self.parse_value()?;
19942        match &v.value {
19943            Value::SingleQuotedString(_) => Ok(v),
19944            Value::DoubleQuotedString(_) => Ok(v),
19945            Value::Number(_, _) => Ok(v),
19946            Value::Placeholder(_) => Ok(v),
19947            _ => {
19948                self.prev_token();
19949                self.expected_ref("number or string or ? placeholder", self.peek_token_ref())
19950            }
19951        }
19952    }
19953
19954    /// PRAGMA [schema-name '.'] pragma-name [('=' pragma-value) | '(' pragma-value ')']
19955    pub fn parse_pragma(&mut self) -> Result<Statement, ParserError> {
19956        let name = self.parse_object_name(false)?;
19957        if self.consume_token(&Token::LParen) {
19958            let value = self.parse_pragma_value()?;
19959            self.expect_token(&Token::RParen)?;
19960            Ok(Statement::Pragma {
19961                name,
19962                value: Some(value),
19963                is_eq: false,
19964            })
19965        } else if self.consume_token(&Token::Eq) {
19966            Ok(Statement::Pragma {
19967                name,
19968                value: Some(self.parse_pragma_value()?),
19969                is_eq: true,
19970            })
19971        } else {
19972            Ok(Statement::Pragma {
19973                name,
19974                value: None,
19975                is_eq: false,
19976            })
19977        }
19978    }
19979
19980    /// `INSTALL [extension_name]`
19981    pub fn parse_install(&mut self) -> Result<Statement, ParserError> {
19982        let extension_name = self.parse_identifier()?;
19983
19984        Ok(Statement::Install { extension_name })
19985    }
19986
19987    /// Parse a SQL LOAD statement
19988    pub fn parse_load(&mut self) -> Result<Statement, ParserError> {
19989        if self.dialect.supports_load_extension() {
19990            let extension_name = self.parse_identifier()?;
19991            Ok(Statement::Load { extension_name })
19992        } else if self.parse_keyword(Keyword::DATA) && self.dialect.supports_load_data() {
19993            let local = self.parse_one_of_keywords(&[Keyword::LOCAL]).is_some();
19994            self.expect_keyword_is(Keyword::INPATH)?;
19995            let inpath = self.parse_literal_string()?;
19996            let overwrite = self.parse_one_of_keywords(&[Keyword::OVERWRITE]).is_some();
19997            self.expect_keyword_is(Keyword::INTO)?;
19998            self.expect_keyword_is(Keyword::TABLE)?;
19999            let table_name = self.parse_object_name(false)?;
20000            let partitioned = self.parse_insert_partition()?;
20001            let table_format = self.parse_load_data_table_format()?;
20002            Ok(Statement::LoadData {
20003                local,
20004                inpath,
20005                overwrite,
20006                table_name,
20007                partitioned,
20008                table_format,
20009            })
20010        } else {
20011            self.expected_ref(
20012                "`DATA` or an extension name after `LOAD`",
20013                self.peek_token_ref(),
20014            )
20015        }
20016    }
20017
20018    /// ClickHouse:
20019    /// ```sql
20020    /// OPTIMIZE TABLE [db.]name [ON CLUSTER cluster] [PARTITION partition | PARTITION ID 'partition_id'] [FINAL] [DEDUPLICATE [BY expression]]
20021    /// ```
20022    /// [ClickHouse](https://clickhouse.com/docs/en/sql-reference/statements/optimize)
20023    ///
20024    /// Databricks:
20025    /// ```sql
20026    /// OPTIMIZE table_name [WHERE predicate] [ZORDER BY (col_name1 [, ...])]
20027    /// ```
20028    /// [Databricks](https://docs.databricks.com/en/sql/language-manual/delta-optimize.html)
20029    pub fn parse_optimize_table(&mut self) -> Result<Statement, ParserError> {
20030        let has_table_keyword = self.parse_keyword(Keyword::TABLE);
20031
20032        let name = self.parse_object_name(false)?;
20033
20034        // ClickHouse-specific options
20035        let on_cluster = self.parse_optional_on_cluster()?;
20036
20037        let partition = if self.parse_keyword(Keyword::PARTITION) {
20038            if self.parse_keyword(Keyword::ID) {
20039                Some(Partition::Identifier(self.parse_identifier()?))
20040            } else {
20041                Some(Partition::Expr(self.parse_expr()?))
20042            }
20043        } else {
20044            None
20045        };
20046
20047        let include_final = self.parse_keyword(Keyword::FINAL);
20048
20049        let deduplicate = if self.parse_keyword(Keyword::DEDUPLICATE) {
20050            if self.parse_keyword(Keyword::BY) {
20051                Some(Deduplicate::ByExpression(self.parse_expr()?))
20052            } else {
20053                Some(Deduplicate::All)
20054            }
20055        } else {
20056            None
20057        };
20058
20059        // Databricks-specific options
20060        let predicate = if self.parse_keyword(Keyword::WHERE) {
20061            Some(self.parse_expr()?)
20062        } else {
20063            None
20064        };
20065
20066        let zorder = if self.parse_keywords(&[Keyword::ZORDER, Keyword::BY]) {
20067            self.expect_token(&Token::LParen)?;
20068            let columns = self.parse_comma_separated(|p| p.parse_expr())?;
20069            self.expect_token(&Token::RParen)?;
20070            Some(columns)
20071        } else {
20072            None
20073        };
20074
20075        Ok(Statement::OptimizeTable {
20076            name,
20077            has_table_keyword,
20078            on_cluster,
20079            partition,
20080            include_final,
20081            deduplicate,
20082            predicate,
20083            zorder,
20084        })
20085    }
20086
20087    /// ```sql
20088    /// CREATE [ { TEMPORARY | TEMP } ] SEQUENCE [ IF NOT EXISTS ] <sequence_name>
20089    /// ```
20090    ///
20091    /// See [Postgres docs](https://www.postgresql.org/docs/current/sql-createsequence.html) for more details.
20092    pub fn parse_create_sequence(&mut self, temporary: bool) -> Result<Statement, ParserError> {
20093        //[ IF NOT EXISTS ]
20094        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
20095        //name
20096        let name = self.parse_object_name(false)?;
20097        //[ AS data_type ]
20098        let mut data_type: Option<DataType> = None;
20099        if self.parse_keywords(&[Keyword::AS]) {
20100            data_type = Some(self.parse_data_type()?)
20101        }
20102        let sequence_options = self.parse_create_sequence_options()?;
20103        // [ OWNED BY { table_name.column_name | NONE } ]
20104        let owned_by = if self.parse_keywords(&[Keyword::OWNED, Keyword::BY]) {
20105            if self.parse_keywords(&[Keyword::NONE]) {
20106                Some(ObjectName::from(vec![Ident::new("NONE")]))
20107            } else {
20108                Some(self.parse_object_name(false)?)
20109            }
20110        } else {
20111            None
20112        };
20113        Ok(Statement::CreateSequence {
20114            temporary,
20115            if_not_exists,
20116            name,
20117            data_type,
20118            sequence_options,
20119            owned_by,
20120        })
20121    }
20122
20123    fn parse_create_sequence_options(&mut self) -> Result<Vec<SequenceOptions>, ParserError> {
20124        let mut sequence_options = vec![];
20125        //[ INCREMENT [ BY ] increment ]
20126        if self.parse_keywords(&[Keyword::INCREMENT]) {
20127            if self.parse_keywords(&[Keyword::BY]) {
20128                sequence_options.push(SequenceOptions::IncrementBy(self.parse_number()?, true));
20129            } else {
20130                sequence_options.push(SequenceOptions::IncrementBy(self.parse_number()?, false));
20131            }
20132        }
20133        //[ MINVALUE minvalue | NO MINVALUE ]
20134        if self.parse_keyword(Keyword::MINVALUE) {
20135            sequence_options.push(SequenceOptions::MinValue(Some(self.parse_number()?)));
20136        } else if self.parse_keywords(&[Keyword::NO, Keyword::MINVALUE]) {
20137            sequence_options.push(SequenceOptions::MinValue(None));
20138        }
20139        //[ MAXVALUE maxvalue | NO MAXVALUE ]
20140        if self.parse_keywords(&[Keyword::MAXVALUE]) {
20141            sequence_options.push(SequenceOptions::MaxValue(Some(self.parse_number()?)));
20142        } else if self.parse_keywords(&[Keyword::NO, Keyword::MAXVALUE]) {
20143            sequence_options.push(SequenceOptions::MaxValue(None));
20144        }
20145
20146        //[ START [ WITH ] start ]
20147        if self.parse_keywords(&[Keyword::START]) {
20148            if self.parse_keywords(&[Keyword::WITH]) {
20149                sequence_options.push(SequenceOptions::StartWith(self.parse_number()?, true));
20150            } else {
20151                sequence_options.push(SequenceOptions::StartWith(self.parse_number()?, false));
20152            }
20153        }
20154        //[ CACHE cache ]
20155        if self.parse_keywords(&[Keyword::CACHE]) {
20156            sequence_options.push(SequenceOptions::Cache(self.parse_number()?));
20157        }
20158        // [ [ NO ] CYCLE ]
20159        if self.parse_keywords(&[Keyword::NO, Keyword::CYCLE]) {
20160            sequence_options.push(SequenceOptions::Cycle(true));
20161        } else if self.parse_keywords(&[Keyword::CYCLE]) {
20162            sequence_options.push(SequenceOptions::Cycle(false));
20163        }
20164
20165        Ok(sequence_options)
20166    }
20167
20168    ///   Parse a `CREATE SERVER` statement.
20169    ///
20170    ///  See [Statement::CreateServer]
20171    pub fn parse_pg_create_server(&mut self) -> Result<Statement, ParserError> {
20172        let ine = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
20173        let name = self.parse_object_name(false)?;
20174
20175        let server_type = if self.parse_keyword(Keyword::TYPE) {
20176            Some(self.parse_identifier()?)
20177        } else {
20178            None
20179        };
20180
20181        let version = if self.parse_keyword(Keyword::VERSION) {
20182            Some(self.parse_identifier()?)
20183        } else {
20184            None
20185        };
20186
20187        self.expect_keywords(&[Keyword::FOREIGN, Keyword::DATA, Keyword::WRAPPER])?;
20188        let foreign_data_wrapper = self.parse_object_name(false)?;
20189
20190        let mut options = None;
20191        if self.parse_keyword(Keyword::OPTIONS) {
20192            self.expect_token(&Token::LParen)?;
20193            options = Some(self.parse_comma_separated(|p| {
20194                let key = p.parse_identifier()?;
20195                let value = p.parse_identifier()?;
20196                Ok(CreateServerOption { key, value })
20197            })?);
20198            self.expect_token(&Token::RParen)?;
20199        }
20200
20201        Ok(Statement::CreateServer(CreateServerStatement {
20202            name,
20203            if_not_exists: ine,
20204            server_type,
20205            version,
20206            foreign_data_wrapper,
20207            options,
20208        }))
20209    }
20210
20211    /// Parse a `CREATE FOREIGN DATA WRAPPER` statement.
20212    ///
20213    /// See <https://www.postgresql.org/docs/current/sql-createforeigndatawrapper.html>
20214    pub fn parse_create_foreign_data_wrapper(
20215        &mut self,
20216    ) -> Result<CreateForeignDataWrapper, ParserError> {
20217        let name = self.parse_identifier()?;
20218
20219        let handler = if self.parse_keyword(Keyword::HANDLER) {
20220            Some(FdwRoutineClause::Function(self.parse_object_name(false)?))
20221        } else if self.parse_keywords(&[Keyword::NO, Keyword::HANDLER]) {
20222            Some(FdwRoutineClause::NoFunction)
20223        } else {
20224            None
20225        };
20226
20227        let validator = if self.parse_keyword(Keyword::VALIDATOR) {
20228            Some(FdwRoutineClause::Function(self.parse_object_name(false)?))
20229        } else if self.parse_keywords(&[Keyword::NO, Keyword::VALIDATOR]) {
20230            Some(FdwRoutineClause::NoFunction)
20231        } else {
20232            None
20233        };
20234
20235        let options = if self.parse_keyword(Keyword::OPTIONS) {
20236            self.expect_token(&Token::LParen)?;
20237            let opts = self.parse_comma_separated(|p| {
20238                let key = p.parse_identifier()?;
20239                let value = p.parse_identifier()?;
20240                Ok(CreateServerOption { key, value })
20241            })?;
20242            self.expect_token(&Token::RParen)?;
20243            Some(opts)
20244        } else {
20245            None
20246        };
20247
20248        Ok(CreateForeignDataWrapper {
20249            name,
20250            handler,
20251            validator,
20252            options,
20253        })
20254    }
20255
20256    /// Parse a `CREATE FOREIGN TABLE` statement.
20257    ///
20258    /// See <https://www.postgresql.org/docs/current/sql-createforeigntable.html>
20259    pub fn parse_create_foreign_table(
20260        &mut self,
20261    ) -> Result<CreateForeignTable, ParserError> {
20262        let if_not_exists =
20263            self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
20264        let name = self.parse_object_name(false)?;
20265        let (columns, _constraints) = self.parse_columns()?;
20266        self.expect_keyword_is(Keyword::SERVER)?;
20267        let server_name = self.parse_identifier()?;
20268
20269        let options = if self.parse_keyword(Keyword::OPTIONS) {
20270            self.expect_token(&Token::LParen)?;
20271            let opts = self.parse_comma_separated(|p| {
20272                let key = p.parse_identifier()?;
20273                let value = p.parse_identifier()?;
20274                Ok(CreateServerOption { key, value })
20275            })?;
20276            self.expect_token(&Token::RParen)?;
20277            Some(opts)
20278        } else {
20279            None
20280        };
20281
20282        Ok(CreateForeignTable {
20283            name,
20284            if_not_exists,
20285            columns,
20286            server_name,
20287            options,
20288        })
20289    }
20290
20291    /// Parse a `CREATE PUBLICATION` statement.
20292    ///
20293    /// See <https://www.postgresql.org/docs/current/sql-createpublication.html>
20294    pub fn parse_create_publication(&mut self) -> Result<CreatePublication, ParserError> {
20295        let name = self.parse_identifier()?;
20296
20297        let target = if self.parse_keyword(Keyword::FOR) {
20298            if self.parse_keywords(&[Keyword::ALL, Keyword::TABLES]) {
20299                Some(PublicationTarget::AllTables)
20300            } else if self.parse_keyword(Keyword::TABLE) {
20301                let tables = self.parse_comma_separated(|p| p.parse_object_name(false))?;
20302                Some(PublicationTarget::Tables(tables))
20303            } else if self.parse_keywords(&[Keyword::TABLES, Keyword::IN, Keyword::SCHEMA]) {
20304                let schemas = self.parse_comma_separated(|p| p.parse_identifier())?;
20305                Some(PublicationTarget::TablesInSchema(schemas))
20306            } else {
20307                return self.expected_ref(
20308                    "ALL TABLES, TABLE, or TABLES IN SCHEMA after FOR",
20309                    self.peek_token_ref(),
20310                );
20311            }
20312        } else {
20313            None
20314        };
20315
20316        let with_options = self.parse_options(Keyword::WITH)?;
20317
20318        Ok(CreatePublication {
20319            name,
20320            target,
20321            with_options,
20322        })
20323    }
20324
20325    /// Parse a `CREATE SUBSCRIPTION` statement.
20326    ///
20327    /// See <https://www.postgresql.org/docs/current/sql-createsubscription.html>
20328    pub fn parse_create_subscription(&mut self) -> Result<CreateSubscription, ParserError> {
20329        let name = self.parse_identifier()?;
20330        self.expect_keyword_is(Keyword::CONNECTION)?;
20331        let connection = self.parse_value()?.value;
20332        self.expect_keyword_is(Keyword::PUBLICATION)?;
20333        let publications = self.parse_comma_separated(|p| p.parse_identifier())?;
20334        let with_options = self.parse_options(Keyword::WITH)?;
20335
20336        Ok(CreateSubscription {
20337            name,
20338            connection,
20339            publications,
20340            with_options,
20341        })
20342    }
20343
20344    /// Parse a `CREATE CAST` statement.
20345    ///
20346    /// See <https://www.postgresql.org/docs/current/sql-createcast.html>
20347    pub fn parse_create_cast(&mut self) -> Result<CreateCast, ParserError> {
20348        self.expect_token(&Token::LParen)?;
20349        let source_type = self.parse_data_type()?;
20350        self.expect_keyword_is(Keyword::AS)?;
20351        let target_type = self.parse_data_type()?;
20352        self.expect_token(&Token::RParen)?;
20353
20354        let function_kind = if self.parse_keywords(&[Keyword::WITHOUT, Keyword::FUNCTION]) {
20355            CastFunctionKind::WithoutFunction
20356        } else if self.parse_keywords(&[Keyword::WITH, Keyword::INOUT]) {
20357            CastFunctionKind::WithInout
20358        } else if self.parse_keywords(&[Keyword::WITH, Keyword::FUNCTION]) {
20359            let function_name = self.parse_object_name(false)?;
20360            let argument_types = if self.peek_token_ref().token == Token::LParen {
20361                self.expect_token(&Token::LParen)?;
20362                let types = if self.peek_token_ref().token == Token::RParen {
20363                    vec![]
20364                } else {
20365                    self.parse_comma_separated(|p| p.parse_data_type())?
20366                };
20367                self.expect_token(&Token::RParen)?;
20368                types
20369            } else {
20370                vec![]
20371            };
20372            CastFunctionKind::WithFunction {
20373                function_name,
20374                argument_types,
20375            }
20376        } else {
20377            return self.expected_ref(
20378                "WITH FUNCTION, WITHOUT FUNCTION, or WITH INOUT",
20379                self.peek_token_ref(),
20380            );
20381        };
20382
20383        let cast_context = if self.parse_keyword(Keyword::AS) {
20384            if self.parse_keyword(Keyword::ASSIGNMENT) {
20385                CastContext::Assignment
20386            } else if self.parse_keyword(Keyword::IMPLICIT) {
20387                CastContext::Implicit
20388            } else {
20389                return self.expected_ref("ASSIGNMENT or IMPLICIT after AS", self.peek_token_ref());
20390            }
20391        } else {
20392            CastContext::Explicit
20393        };
20394
20395        Ok(CreateCast {
20396            source_type,
20397            target_type,
20398            function_kind,
20399            cast_context,
20400        })
20401    }
20402
20403    /// Parse a `CREATE [DEFAULT] CONVERSION` statement.
20404    ///
20405    /// See <https://www.postgresql.org/docs/current/sql-createconversion.html>
20406    pub fn parse_create_conversion(
20407        &mut self,
20408        is_default: bool,
20409    ) -> Result<CreateConversion, ParserError> {
20410        let name = self.parse_object_name(false)?;
20411        self.expect_keyword_is(Keyword::FOR)?;
20412        let source_encoding = self.parse_literal_string()?;
20413        self.expect_keyword_is(Keyword::TO)?;
20414        let destination_encoding = self.parse_literal_string()?;
20415        self.expect_keyword_is(Keyword::FROM)?;
20416        let function_name = self.parse_object_name(false)?;
20417
20418        Ok(CreateConversion {
20419            name,
20420            is_default,
20421            source_encoding,
20422            destination_encoding,
20423            function_name,
20424        })
20425    }
20426
20427    /// Parse a `CREATE [OR REPLACE] [TRUSTED] [PROCEDURAL] LANGUAGE` statement.
20428    ///
20429    /// See <https://www.postgresql.org/docs/current/sql-createlanguage.html>
20430    pub fn parse_create_language(
20431        &mut self,
20432        or_replace: bool,
20433        trusted: bool,
20434        procedural: bool,
20435    ) -> Result<CreateLanguage, ParserError> {
20436        let name = self.parse_identifier()?;
20437
20438        let handler = if self.parse_keyword(Keyword::HANDLER) {
20439            Some(self.parse_object_name(false)?)
20440        } else {
20441            None
20442        };
20443
20444        let inline_handler = if self.parse_keyword(Keyword::INLINE) {
20445            Some(self.parse_object_name(false)?)
20446        } else {
20447            None
20448        };
20449
20450        let validator = if self.parse_keywords(&[Keyword::NO, Keyword::VALIDATOR]) {
20451            None
20452        } else if self.parse_keyword(Keyword::VALIDATOR) {
20453            Some(self.parse_object_name(false)?)
20454        } else {
20455            None
20456        };
20457
20458        Ok(CreateLanguage {
20459            name,
20460            or_replace,
20461            trusted,
20462            procedural,
20463            handler,
20464            inline_handler,
20465            validator,
20466        })
20467    }
20468
20469    /// Parse a `CREATE RULE` statement.
20470    ///
20471    /// See <https://www.postgresql.org/docs/current/sql-createrule.html>
20472    pub fn parse_create_rule(&mut self) -> Result<CreateRule, ParserError> {
20473        let name = self.parse_identifier()?;
20474        self.expect_keyword_is(Keyword::AS)?;
20475        self.expect_keyword_is(Keyword::ON)?;
20476
20477        let event = if self.parse_keyword(Keyword::SELECT) {
20478            RuleEvent::Select
20479        } else if self.parse_keyword(Keyword::INSERT) {
20480            RuleEvent::Insert
20481        } else if self.parse_keyword(Keyword::UPDATE) {
20482            RuleEvent::Update
20483        } else if self.parse_keyword(Keyword::DELETE) {
20484            RuleEvent::Delete
20485        } else {
20486            return self.expected_ref(
20487                "SELECT, INSERT, UPDATE, or DELETE after ON",
20488                self.peek_token_ref(),
20489            );
20490        };
20491
20492        self.expect_keyword_is(Keyword::TO)?;
20493        let table = self.parse_object_name(false)?;
20494
20495        let condition = if self.parse_keyword(Keyword::WHERE) {
20496            Some(self.parse_expr()?)
20497        } else {
20498            None
20499        };
20500
20501        self.expect_keyword_is(Keyword::DO)?;
20502
20503        let instead = if self.parse_keyword(Keyword::INSTEAD) {
20504            true
20505        } else if self.parse_keyword(Keyword::ALSO) {
20506            false
20507        } else {
20508            false
20509        };
20510
20511        let action = if self.parse_keyword(Keyword::NOTHING) {
20512            RuleAction::Nothing
20513        } else if self.peek_token_ref().token == Token::LParen {
20514            self.expect_token(&Token::LParen)?;
20515            let mut stmts = Vec::new();
20516            loop {
20517                stmts.push(self.parse_statement()?);
20518                if !self.consume_token(&Token::SemiColon) {
20519                    break;
20520                }
20521                if self.peek_token_ref().token == Token::RParen {
20522                    break;
20523                }
20524            }
20525            self.expect_token(&Token::RParen)?;
20526            RuleAction::Statements(stmts)
20527        } else {
20528            let stmt = self.parse_statement()?;
20529            RuleAction::Statements(vec![stmt])
20530        };
20531
20532        Ok(CreateRule {
20533            name,
20534            event,
20535            table,
20536            condition,
20537            instead,
20538            action,
20539        })
20540    }
20541
20542    /// Parse a `CREATE STATISTICS` statement.
20543    ///
20544    /// See <https://www.postgresql.org/docs/current/sql-createstatistics.html>
20545    pub fn parse_create_statistics(&mut self) -> Result<CreateStatistics, ParserError> {
20546        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
20547        let name = self.parse_object_name(false)?;
20548
20549        let kinds = if self.consume_token(&Token::LParen) {
20550            let kinds = self.parse_comma_separated(|p| {
20551                let ident = p.parse_identifier()?;
20552                match ident.value.to_lowercase().as_str() {
20553                    "ndistinct" => Ok(StatisticsKind::NDistinct),
20554                    "dependencies" => Ok(StatisticsKind::Dependencies),
20555                    "mcv" => Ok(StatisticsKind::Mcv),
20556                    other => Err(ParserError::ParserError(format!(
20557                        "Unknown statistics kind: {other}"
20558                    ))),
20559                }
20560            })?;
20561            self.expect_token(&Token::RParen)?;
20562            kinds
20563        } else {
20564            vec![]
20565        };
20566
20567        self.expect_keyword_is(Keyword::ON)?;
20568        let on = self.parse_comma_separated(Parser::parse_expr)?;
20569        self.expect_keyword_is(Keyword::FROM)?;
20570        let from = self.parse_object_name(false)?;
20571
20572        Ok(CreateStatistics {
20573            if_not_exists,
20574            name,
20575            kinds,
20576            on,
20577            from,
20578        })
20579    }
20580
20581    /// Parse a `CREATE ACCESS METHOD` statement.
20582    ///
20583    /// See <https://www.postgresql.org/docs/current/sql-create-access-method.html>
20584    pub fn parse_create_access_method(&mut self) -> Result<CreateAccessMethod, ParserError> {
20585        let name = self.parse_identifier()?;
20586        self.expect_keyword_is(Keyword::TYPE)?;
20587        let method_type = if self.parse_keyword(Keyword::INDEX) {
20588            AccessMethodType::Index
20589        } else if self.parse_keyword(Keyword::TABLE) {
20590            AccessMethodType::Table
20591        } else {
20592            return self.expected_ref("INDEX or TABLE after TYPE", self.peek_token_ref());
20593        };
20594        self.expect_keyword_is(Keyword::HANDLER)?;
20595        let handler = self.parse_object_name(false)?;
20596
20597        Ok(CreateAccessMethod {
20598            name,
20599            method_type,
20600            handler,
20601        })
20602    }
20603
20604    /// Parse a `CREATE EVENT TRIGGER` statement.
20605    ///
20606    /// See <https://www.postgresql.org/docs/current/sql-createeventtrigger.html>
20607    pub fn parse_create_event_trigger(&mut self) -> Result<CreateEventTrigger, ParserError> {
20608        let name = self.parse_identifier()?;
20609        self.expect_keyword_is(Keyword::ON)?;
20610        let event_ident = self.parse_identifier()?;
20611        let event = match event_ident.value.to_lowercase().as_str() {
20612            "ddl_command_start" => EventTriggerEvent::DdlCommandStart,
20613            "ddl_command_end" => EventTriggerEvent::DdlCommandEnd,
20614            "table_rewrite" => EventTriggerEvent::TableRewrite,
20615            "sql_drop" => EventTriggerEvent::SqlDrop,
20616            other => {
20617                return Err(ParserError::ParserError(format!(
20618                    "Unknown event trigger event: {other}"
20619                )))
20620            }
20621        };
20622
20623        let when_tags = if self.parse_keyword(Keyword::WHEN) {
20624            self.expect_keyword_is(Keyword::TAG)?;
20625            self.expect_keyword_is(Keyword::IN)?;
20626            self.expect_token(&Token::LParen)?;
20627            let tags = self.parse_comma_separated(|p| p.parse_value().map(|v| v.value))?;
20628            self.expect_token(&Token::RParen)?;
20629            Some(tags)
20630        } else {
20631            None
20632        };
20633
20634        self.expect_keyword_is(Keyword::EXECUTE)?;
20635        let is_procedure = if self.parse_keyword(Keyword::FUNCTION) {
20636            false
20637        } else if self.parse_keyword(Keyword::PROCEDURE) {
20638            true
20639        } else {
20640            return self.expected_ref("FUNCTION or PROCEDURE after EXECUTE", self.peek_token_ref());
20641        };
20642        let execute = self.parse_object_name(false)?;
20643        self.expect_token(&Token::LParen)?;
20644        self.expect_token(&Token::RParen)?;
20645
20646        Ok(CreateEventTrigger {
20647            name,
20648            event,
20649            when_tags,
20650            execute,
20651            is_procedure,
20652        })
20653    }
20654
20655    /// Parse a `CREATE [OR REPLACE] TRANSFORM` statement.
20656    ///
20657    /// See <https://www.postgresql.org/docs/current/sql-createtransform.html>
20658    pub fn parse_create_transform(&mut self, or_replace: bool) -> Result<CreateTransform, ParserError> {
20659        self.expect_keyword_is(Keyword::FOR)?;
20660        let type_name = self.parse_data_type()?;
20661        self.expect_keyword_is(Keyword::LANGUAGE)?;
20662        let language = self.parse_identifier()?;
20663        self.expect_token(&Token::LParen)?;
20664        let elements = self.parse_comma_separated(|p| {
20665            let is_from = if p.parse_keyword(Keyword::FROM) {
20666                true
20667            } else {
20668                p.expect_keyword_is(Keyword::TO)?;
20669                false
20670            };
20671            p.expect_keyword_is(Keyword::SQL)?;
20672            p.expect_keyword_is(Keyword::WITH)?;
20673            p.expect_keyword_is(Keyword::FUNCTION)?;
20674            let function = p.parse_object_name(false)?;
20675            p.expect_token(&Token::LParen)?;
20676            let arg_types = if p.peek_token().token == Token::RParen {
20677                vec![]
20678            } else {
20679                p.parse_comma_separated(|p| p.parse_data_type())?
20680            };
20681            p.expect_token(&Token::RParen)?;
20682            Ok(TransformElement {
20683                is_from,
20684                function,
20685                arg_types,
20686            })
20687        })?;
20688        self.expect_token(&Token::RParen)?;
20689
20690        Ok(CreateTransform {
20691            or_replace,
20692            type_name,
20693            language,
20694            elements,
20695        })
20696    }
20697
20698
20699    /// Parse a `SECURITY LABEL` statement.
20700    ///
20701    /// See <https://www.postgresql.org/docs/current/sql-securitylabel.html>
20702    pub fn parse_security_label(&mut self) -> Result<SecurityLabel, ParserError> {
20703        self.expect_keyword_is(Keyword::LABEL)?;
20704
20705        let provider = if self.parse_keyword(Keyword::FOR) {
20706            Some(self.parse_identifier()?)
20707        } else {
20708            None
20709        };
20710
20711        self.expect_keyword_is(Keyword::ON)?;
20712
20713        let object_kind = if self.parse_keywords(&[Keyword::MATERIALIZED, Keyword::VIEW]) {
20714            SecurityLabelObjectKind::MaterializedView
20715        } else if self.parse_keyword(Keyword::TABLE) {
20716            SecurityLabelObjectKind::Table
20717        } else if self.parse_keyword(Keyword::COLUMN) {
20718            SecurityLabelObjectKind::Column
20719        } else if self.parse_keyword(Keyword::DATABASE) {
20720            SecurityLabelObjectKind::Database
20721        } else if self.parse_keyword(Keyword::DOMAIN) {
20722            SecurityLabelObjectKind::Domain
20723        } else if self.parse_keyword(Keyword::FUNCTION) {
20724            SecurityLabelObjectKind::Function
20725        } else if self.parse_keyword(Keyword::ROLE) {
20726            SecurityLabelObjectKind::Role
20727        } else if self.parse_keyword(Keyword::SCHEMA) {
20728            SecurityLabelObjectKind::Schema
20729        } else if self.parse_keyword(Keyword::SEQUENCE) {
20730            SecurityLabelObjectKind::Sequence
20731        } else if self.parse_keyword(Keyword::TYPE) {
20732            SecurityLabelObjectKind::Type
20733        } else if self.parse_keyword(Keyword::VIEW) {
20734            SecurityLabelObjectKind::View
20735        } else {
20736            return self.expected_ref(
20737                "TABLE, COLUMN, DATABASE, DOMAIN, FUNCTION, MATERIALIZED VIEW, ROLE, SCHEMA, SEQUENCE, TYPE, or VIEW after ON",
20738                self.peek_token_ref(),
20739            );
20740        };
20741
20742        let object_name = self.parse_object_name(false)?;
20743
20744        self.expect_keyword_is(Keyword::IS)?;
20745
20746        let label = if self.parse_keyword(Keyword::NULL) {
20747            None
20748        } else {
20749            Some(self.parse_value()?.value)
20750        };
20751
20752        Ok(SecurityLabel {
20753            provider,
20754            object_kind,
20755            object_name,
20756            label,
20757        })
20758    }
20759
20760    /// Parse a `CREATE USER MAPPING` statement.
20761    ///
20762    /// See <https://www.postgresql.org/docs/current/sql-createusermapping.html>
20763    pub fn parse_create_user_mapping(&mut self) -> Result<CreateUserMapping, ParserError> {
20764        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
20765
20766        self.expect_keyword_is(Keyword::FOR)?;
20767
20768        let user = if self.parse_keyword(Keyword::CURRENT_ROLE) {
20769            UserMappingUser::CurrentRole
20770        } else if self.parse_keyword(Keyword::CURRENT_USER) {
20771            UserMappingUser::CurrentUser
20772        } else if self.parse_keyword(Keyword::PUBLIC) {
20773            UserMappingUser::Public
20774        } else if self.parse_keyword(Keyword::USER) {
20775            UserMappingUser::User
20776        } else {
20777            UserMappingUser::Ident(self.parse_identifier()?)
20778        };
20779
20780        self.expect_keyword_is(Keyword::SERVER)?;
20781        let server_name = self.parse_identifier()?;
20782
20783        let options = if self.parse_keyword(Keyword::OPTIONS) {
20784            self.expect_token(&Token::LParen)?;
20785            let opts = self.parse_comma_separated(|p| {
20786                let key = p.parse_identifier()?;
20787                let value = p.parse_identifier()?;
20788                Ok(CreateServerOption { key, value })
20789            })?;
20790            self.expect_token(&Token::RParen)?;
20791            Some(opts)
20792        } else {
20793            None
20794        };
20795
20796        Ok(CreateUserMapping {
20797            if_not_exists,
20798            user,
20799            server_name,
20800            options,
20801        })
20802    }
20803
20804    /// Parse a `CREATE TABLESPACE` statement.
20805    ///
20806    /// See <https://www.postgresql.org/docs/current/sql-createtablespace.html>
20807    pub fn parse_create_tablespace(&mut self) -> Result<CreateTablespace, ParserError> {
20808        let name = self.parse_identifier()?;
20809
20810        let owner = if self.parse_keyword(Keyword::OWNER) {
20811            Some(self.parse_identifier()?)
20812        } else {
20813            None
20814        };
20815
20816        self.expect_keyword_is(Keyword::LOCATION)?;
20817        let location = self.parse_value()?.value;
20818
20819        let with_options = self.parse_options(Keyword::WITH)?;
20820
20821        Ok(CreateTablespace {
20822            name,
20823            owner,
20824            location,
20825            with_options,
20826        })
20827    }
20828
20829    /// The index of the first unprocessed token.
20830    pub fn index(&self) -> usize {
20831        self.index
20832    }
20833
20834    /// Parse a named window definition.
20835    pub fn parse_named_window(&mut self) -> Result<NamedWindowDefinition, ParserError> {
20836        let ident = self.parse_identifier()?;
20837        self.expect_keyword_is(Keyword::AS)?;
20838
20839        let window_expr = if self.consume_token(&Token::LParen) {
20840            NamedWindowExpr::WindowSpec(self.parse_window_spec()?)
20841        } else if self.dialect.supports_window_clause_named_window_reference() {
20842            NamedWindowExpr::NamedWindow(self.parse_identifier()?)
20843        } else {
20844            return self.expected_ref("(", self.peek_token_ref());
20845        };
20846
20847        Ok(NamedWindowDefinition(ident, window_expr))
20848    }
20849
20850    /// Parse `CREATE PROCEDURE` statement.
20851    pub fn parse_create_procedure(&mut self, or_alter: bool) -> Result<Statement, ParserError> {
20852        let name = self.parse_object_name(false)?;
20853        let params = self.parse_optional_procedure_parameters()?;
20854
20855        let language = if self.parse_keyword(Keyword::LANGUAGE) {
20856            Some(self.parse_identifier()?)
20857        } else {
20858            None
20859        };
20860
20861        self.expect_keyword_is(Keyword::AS)?;
20862
20863        let body = self.parse_conditional_statements(&[Keyword::END])?;
20864
20865        Ok(Statement::CreateProcedure {
20866            name,
20867            or_alter,
20868            params,
20869            language,
20870            body,
20871        })
20872    }
20873
20874    /// Parse a window specification.
20875    pub fn parse_window_spec(&mut self) -> Result<WindowSpec, ParserError> {
20876        let window_name = match &self.peek_token_ref().token {
20877            Token::Word(word) if word.keyword == Keyword::NoKeyword => {
20878                self.parse_optional_ident()?
20879            }
20880            _ => None,
20881        };
20882
20883        let partition_by = if self.parse_keywords(&[Keyword::PARTITION, Keyword::BY]) {
20884            self.parse_comma_separated(Parser::parse_expr)?
20885        } else {
20886            vec![]
20887        };
20888        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
20889            self.parse_comma_separated(Parser::parse_order_by_expr)?
20890        } else {
20891            vec![]
20892        };
20893
20894        let window_frame = if !self.consume_token(&Token::RParen) {
20895            let window_frame = self.parse_window_frame()?;
20896            self.expect_token(&Token::RParen)?;
20897            Some(window_frame)
20898        } else {
20899            None
20900        };
20901        Ok(WindowSpec {
20902            window_name,
20903            partition_by,
20904            order_by,
20905            window_frame,
20906        })
20907    }
20908
20909    /// Parse `CREATE TYPE` statement.
20910    pub fn parse_create_type(&mut self) -> Result<Statement, ParserError> {
20911        let name = self.parse_object_name(false)?;
20912
20913        // Check if we have AS keyword
20914        let has_as = self.parse_keyword(Keyword::AS);
20915
20916        if !has_as {
20917            // Two cases: CREATE TYPE name; or CREATE TYPE name (options);
20918            if self.consume_token(&Token::LParen) {
20919                // CREATE TYPE name (options) - SQL definition without AS
20920                let options = self.parse_create_type_sql_definition_options()?;
20921                self.expect_token(&Token::RParen)?;
20922                return Ok(Statement::CreateType {
20923                    name,
20924                    representation: Some(UserDefinedTypeRepresentation::SqlDefinition { options }),
20925                });
20926            }
20927
20928            // CREATE TYPE name; - no representation
20929            return Ok(Statement::CreateType {
20930                name,
20931                representation: None,
20932            });
20933        }
20934
20935        // We have AS keyword
20936        if self.parse_keyword(Keyword::ENUM) {
20937            // CREATE TYPE name AS ENUM (labels)
20938            self.parse_create_type_enum(name)
20939        } else if self.parse_keyword(Keyword::RANGE) {
20940            // CREATE TYPE name AS RANGE (options)
20941            self.parse_create_type_range(name)
20942        } else if self.consume_token(&Token::LParen) {
20943            // CREATE TYPE name AS (attributes) - Composite
20944            self.parse_create_type_composite(name)
20945        } else {
20946            self.expected_ref("ENUM, RANGE, or '(' after AS", self.peek_token_ref())
20947        }
20948    }
20949
20950    /// Parse remainder of `CREATE TYPE AS (attributes)` statement (composite type)
20951    ///
20952    /// See [PostgreSQL](https://www.postgresql.org/docs/current/sql-createtype.html)
20953    fn parse_create_type_composite(&mut self, name: ObjectName) -> Result<Statement, ParserError> {
20954        if self.consume_token(&Token::RParen) {
20955            // Empty composite type
20956            return Ok(Statement::CreateType {
20957                name,
20958                representation: Some(UserDefinedTypeRepresentation::Composite {
20959                    attributes: vec![],
20960                }),
20961            });
20962        }
20963
20964        let mut attributes = vec![];
20965        loop {
20966            let attr_name = self.parse_identifier()?;
20967            let attr_data_type = self.parse_data_type()?;
20968            let attr_collation = if self.parse_keyword(Keyword::COLLATE) {
20969                Some(self.parse_object_name(false)?)
20970            } else {
20971                None
20972            };
20973            attributes.push(UserDefinedTypeCompositeAttributeDef {
20974                name: attr_name,
20975                data_type: attr_data_type,
20976                collation: attr_collation,
20977            });
20978
20979            if !self.consume_token(&Token::Comma) {
20980                break;
20981            }
20982        }
20983        self.expect_token(&Token::RParen)?;
20984
20985        Ok(Statement::CreateType {
20986            name,
20987            representation: Some(UserDefinedTypeRepresentation::Composite { attributes }),
20988        })
20989    }
20990
20991    /// Parse remainder of `CREATE TYPE AS ENUM` statement (see [Statement::CreateType] and [Self::parse_create_type])
20992    ///
20993    /// See [PostgreSQL](https://www.postgresql.org/docs/current/sql-createtype.html)
20994    pub fn parse_create_type_enum(&mut self, name: ObjectName) -> Result<Statement, ParserError> {
20995        self.expect_token(&Token::LParen)?;
20996        let labels = self.parse_comma_separated0(|p| p.parse_identifier(), Token::RParen)?;
20997        self.expect_token(&Token::RParen)?;
20998
20999        Ok(Statement::CreateType {
21000            name,
21001            representation: Some(UserDefinedTypeRepresentation::Enum { labels }),
21002        })
21003    }
21004
21005    /// Parse remainder of `CREATE TYPE AS RANGE` statement
21006    ///
21007    /// See [PostgreSQL](https://www.postgresql.org/docs/current/sql-createtype.html)
21008    fn parse_create_type_range(&mut self, name: ObjectName) -> Result<Statement, ParserError> {
21009        self.expect_token(&Token::LParen)?;
21010        let options = self.parse_comma_separated0(|p| p.parse_range_option(), Token::RParen)?;
21011        self.expect_token(&Token::RParen)?;
21012
21013        Ok(Statement::CreateType {
21014            name,
21015            representation: Some(UserDefinedTypeRepresentation::Range { options }),
21016        })
21017    }
21018
21019    /// Parse a single range option for a `CREATE TYPE AS RANGE` statement
21020    fn parse_range_option(&mut self) -> Result<UserDefinedTypeRangeOption, ParserError> {
21021        let keyword = self.parse_one_of_keywords(&[
21022            Keyword::SUBTYPE,
21023            Keyword::SUBTYPE_OPCLASS,
21024            Keyword::COLLATION,
21025            Keyword::CANONICAL,
21026            Keyword::SUBTYPE_DIFF,
21027            Keyword::MULTIRANGE_TYPE_NAME,
21028        ]);
21029
21030        match keyword {
21031            Some(Keyword::SUBTYPE) => {
21032                self.expect_token(&Token::Eq)?;
21033                let data_type = self.parse_data_type()?;
21034                Ok(UserDefinedTypeRangeOption::Subtype(data_type))
21035            }
21036            Some(Keyword::SUBTYPE_OPCLASS) => {
21037                self.expect_token(&Token::Eq)?;
21038                let name = self.parse_object_name(false)?;
21039                Ok(UserDefinedTypeRangeOption::SubtypeOpClass(name))
21040            }
21041            Some(Keyword::COLLATION) => {
21042                self.expect_token(&Token::Eq)?;
21043                let name = self.parse_object_name(false)?;
21044                Ok(UserDefinedTypeRangeOption::Collation(name))
21045            }
21046            Some(Keyword::CANONICAL) => {
21047                self.expect_token(&Token::Eq)?;
21048                let name = self.parse_object_name(false)?;
21049                Ok(UserDefinedTypeRangeOption::Canonical(name))
21050            }
21051            Some(Keyword::SUBTYPE_DIFF) => {
21052                self.expect_token(&Token::Eq)?;
21053                let name = self.parse_object_name(false)?;
21054                Ok(UserDefinedTypeRangeOption::SubtypeDiff(name))
21055            }
21056            Some(Keyword::MULTIRANGE_TYPE_NAME) => {
21057                self.expect_token(&Token::Eq)?;
21058                let name = self.parse_object_name(false)?;
21059                Ok(UserDefinedTypeRangeOption::MultirangeTypeName(name))
21060            }
21061            _ => self.expected_ref("range option keyword", self.peek_token_ref()),
21062        }
21063    }
21064
21065    /// Parse SQL definition options for CREATE TYPE (options)
21066    fn parse_create_type_sql_definition_options(
21067        &mut self,
21068    ) -> Result<Vec<UserDefinedTypeSqlDefinitionOption>, ParserError> {
21069        self.parse_comma_separated0(|p| p.parse_sql_definition_option(), Token::RParen)
21070    }
21071
21072    /// Parse a single SQL definition option for CREATE TYPE (options)
21073    fn parse_sql_definition_option(
21074        &mut self,
21075    ) -> Result<UserDefinedTypeSqlDefinitionOption, ParserError> {
21076        let keyword = self.parse_one_of_keywords(&[
21077            Keyword::INPUT,
21078            Keyword::OUTPUT,
21079            Keyword::RECEIVE,
21080            Keyword::SEND,
21081            Keyword::TYPMOD_IN,
21082            Keyword::TYPMOD_OUT,
21083            Keyword::ANALYZE,
21084            Keyword::SUBSCRIPT,
21085            Keyword::INTERNALLENGTH,
21086            Keyword::PASSEDBYVALUE,
21087            Keyword::ALIGNMENT,
21088            Keyword::STORAGE,
21089            Keyword::LIKE,
21090            Keyword::CATEGORY,
21091            Keyword::PREFERRED,
21092            Keyword::DEFAULT,
21093            Keyword::ELEMENT,
21094            Keyword::DELIMITER,
21095            Keyword::COLLATABLE,
21096        ]);
21097
21098        match keyword {
21099            Some(Keyword::INPUT) => {
21100                self.expect_token(&Token::Eq)?;
21101                let name = self.parse_object_name(false)?;
21102                Ok(UserDefinedTypeSqlDefinitionOption::Input(name))
21103            }
21104            Some(Keyword::OUTPUT) => {
21105                self.expect_token(&Token::Eq)?;
21106                let name = self.parse_object_name(false)?;
21107                Ok(UserDefinedTypeSqlDefinitionOption::Output(name))
21108            }
21109            Some(Keyword::RECEIVE) => {
21110                self.expect_token(&Token::Eq)?;
21111                let name = self.parse_object_name(false)?;
21112                Ok(UserDefinedTypeSqlDefinitionOption::Receive(name))
21113            }
21114            Some(Keyword::SEND) => {
21115                self.expect_token(&Token::Eq)?;
21116                let name = self.parse_object_name(false)?;
21117                Ok(UserDefinedTypeSqlDefinitionOption::Send(name))
21118            }
21119            Some(Keyword::TYPMOD_IN) => {
21120                self.expect_token(&Token::Eq)?;
21121                let name = self.parse_object_name(false)?;
21122                Ok(UserDefinedTypeSqlDefinitionOption::TypmodIn(name))
21123            }
21124            Some(Keyword::TYPMOD_OUT) => {
21125                self.expect_token(&Token::Eq)?;
21126                let name = self.parse_object_name(false)?;
21127                Ok(UserDefinedTypeSqlDefinitionOption::TypmodOut(name))
21128            }
21129            Some(Keyword::ANALYZE) => {
21130                self.expect_token(&Token::Eq)?;
21131                let name = self.parse_object_name(false)?;
21132                Ok(UserDefinedTypeSqlDefinitionOption::Analyze(name))
21133            }
21134            Some(Keyword::SUBSCRIPT) => {
21135                self.expect_token(&Token::Eq)?;
21136                let name = self.parse_object_name(false)?;
21137                Ok(UserDefinedTypeSqlDefinitionOption::Subscript(name))
21138            }
21139            Some(Keyword::INTERNALLENGTH) => {
21140                self.expect_token(&Token::Eq)?;
21141                if self.parse_keyword(Keyword::VARIABLE) {
21142                    Ok(UserDefinedTypeSqlDefinitionOption::InternalLength(
21143                        UserDefinedTypeInternalLength::Variable,
21144                    ))
21145                } else {
21146                    let value = self.parse_literal_uint()?;
21147                    Ok(UserDefinedTypeSqlDefinitionOption::InternalLength(
21148                        UserDefinedTypeInternalLength::Fixed(value),
21149                    ))
21150                }
21151            }
21152            Some(Keyword::PASSEDBYVALUE) => Ok(UserDefinedTypeSqlDefinitionOption::PassedByValue),
21153            Some(Keyword::ALIGNMENT) => {
21154                self.expect_token(&Token::Eq)?;
21155                let align_keyword = self.parse_one_of_keywords(&[
21156                    Keyword::CHAR,
21157                    Keyword::INT2,
21158                    Keyword::INT4,
21159                    Keyword::DOUBLE,
21160                ]);
21161                match align_keyword {
21162                    Some(Keyword::CHAR) => Ok(UserDefinedTypeSqlDefinitionOption::Alignment(
21163                        Alignment::Char,
21164                    )),
21165                    Some(Keyword::INT2) => Ok(UserDefinedTypeSqlDefinitionOption::Alignment(
21166                        Alignment::Int2,
21167                    )),
21168                    Some(Keyword::INT4) => Ok(UserDefinedTypeSqlDefinitionOption::Alignment(
21169                        Alignment::Int4,
21170                    )),
21171                    Some(Keyword::DOUBLE) => Ok(UserDefinedTypeSqlDefinitionOption::Alignment(
21172                        Alignment::Double,
21173                    )),
21174                    _ => self.expected_ref(
21175                        "alignment value (char, int2, int4, or double)",
21176                        self.peek_token_ref(),
21177                    ),
21178                }
21179            }
21180            Some(Keyword::STORAGE) => {
21181                self.expect_token(&Token::Eq)?;
21182                let storage_keyword = self.parse_one_of_keywords(&[
21183                    Keyword::PLAIN,
21184                    Keyword::EXTERNAL,
21185                    Keyword::EXTENDED,
21186                    Keyword::MAIN,
21187                ]);
21188                match storage_keyword {
21189                    Some(Keyword::PLAIN) => Ok(UserDefinedTypeSqlDefinitionOption::Storage(
21190                        UserDefinedTypeStorage::Plain,
21191                    )),
21192                    Some(Keyword::EXTERNAL) => Ok(UserDefinedTypeSqlDefinitionOption::Storage(
21193                        UserDefinedTypeStorage::External,
21194                    )),
21195                    Some(Keyword::EXTENDED) => Ok(UserDefinedTypeSqlDefinitionOption::Storage(
21196                        UserDefinedTypeStorage::Extended,
21197                    )),
21198                    Some(Keyword::MAIN) => Ok(UserDefinedTypeSqlDefinitionOption::Storage(
21199                        UserDefinedTypeStorage::Main,
21200                    )),
21201                    _ => self.expected_ref(
21202                        "storage value (plain, external, extended, or main)",
21203                        self.peek_token_ref(),
21204                    ),
21205                }
21206            }
21207            Some(Keyword::LIKE) => {
21208                self.expect_token(&Token::Eq)?;
21209                let name = self.parse_object_name(false)?;
21210                Ok(UserDefinedTypeSqlDefinitionOption::Like(name))
21211            }
21212            Some(Keyword::CATEGORY) => {
21213                self.expect_token(&Token::Eq)?;
21214                let category_str = self.parse_literal_string()?;
21215                let category_char = category_str.chars().next().ok_or_else(|| {
21216                    ParserError::ParserError(
21217                        "CATEGORY value must be a single character".to_string(),
21218                    )
21219                })?;
21220                Ok(UserDefinedTypeSqlDefinitionOption::Category(category_char))
21221            }
21222            Some(Keyword::PREFERRED) => {
21223                self.expect_token(&Token::Eq)?;
21224                let value =
21225                    self.parse_keyword(Keyword::TRUE) || !self.parse_keyword(Keyword::FALSE);
21226                Ok(UserDefinedTypeSqlDefinitionOption::Preferred(value))
21227            }
21228            Some(Keyword::DEFAULT) => {
21229                self.expect_token(&Token::Eq)?;
21230                let expr = self.parse_expr()?;
21231                Ok(UserDefinedTypeSqlDefinitionOption::Default(expr))
21232            }
21233            Some(Keyword::ELEMENT) => {
21234                self.expect_token(&Token::Eq)?;
21235                let data_type = self.parse_data_type()?;
21236                Ok(UserDefinedTypeSqlDefinitionOption::Element(data_type))
21237            }
21238            Some(Keyword::DELIMITER) => {
21239                self.expect_token(&Token::Eq)?;
21240                let delimiter = self.parse_literal_string()?;
21241                Ok(UserDefinedTypeSqlDefinitionOption::Delimiter(delimiter))
21242            }
21243            Some(Keyword::COLLATABLE) => {
21244                self.expect_token(&Token::Eq)?;
21245                let value =
21246                    self.parse_keyword(Keyword::TRUE) || !self.parse_keyword(Keyword::FALSE);
21247                Ok(UserDefinedTypeSqlDefinitionOption::Collatable(value))
21248            }
21249            _ => self.expected_ref("SQL definition option keyword", self.peek_token_ref()),
21250        }
21251    }
21252
21253    fn parse_parenthesized_identifiers(&mut self) -> Result<Vec<Ident>, ParserError> {
21254        self.expect_token(&Token::LParen)?;
21255        let idents = self.parse_comma_separated0(|p| p.parse_identifier(), Token::RParen)?;
21256        self.expect_token(&Token::RParen)?;
21257        Ok(idents)
21258    }
21259
21260    fn parse_column_position(&mut self) -> Result<Option<MySQLColumnPosition>, ParserError> {
21261        if dialect_of!(self is MySqlDialect | GenericDialect) {
21262            if self.parse_keyword(Keyword::FIRST) {
21263                Ok(Some(MySQLColumnPosition::First))
21264            } else if self.parse_keyword(Keyword::AFTER) {
21265                let ident = self.parse_identifier()?;
21266                Ok(Some(MySQLColumnPosition::After(ident)))
21267            } else {
21268                Ok(None)
21269            }
21270        } else {
21271            Ok(None)
21272        }
21273    }
21274
21275    /// Parse [Statement::Print]
21276    fn parse_print(&mut self) -> Result<Statement, ParserError> {
21277        Ok(Statement::Print(PrintStatement {
21278            message: Box::new(self.parse_expr()?),
21279        }))
21280    }
21281
21282    /// Parse [Statement::WaitFor]
21283    ///
21284    /// See: <https://learn.microsoft.com/en-us/sql/t-sql/language-elements/waitfor-transact-sql>
21285    fn parse_waitfor(&mut self) -> Result<Statement, ParserError> {
21286        let wait_type = if self.parse_keyword(Keyword::DELAY) {
21287            WaitForType::Delay
21288        } else if self.parse_keyword(Keyword::TIME) {
21289            WaitForType::Time
21290        } else {
21291            return self.expected_ref("DELAY or TIME", self.peek_token_ref());
21292        };
21293        let expr = self.parse_expr()?;
21294        Ok(Statement::WaitFor(WaitForStatement { wait_type, expr }))
21295    }
21296
21297    /// Parse [Statement::Return]
21298    fn parse_return(&mut self) -> Result<Statement, ParserError> {
21299        match self.maybe_parse(|p| p.parse_expr())? {
21300            Some(expr) => Ok(Statement::Return(ReturnStatement {
21301                value: Some(ReturnStatementValue::Expr(expr)),
21302            })),
21303            None => Ok(Statement::Return(ReturnStatement { value: None })),
21304        }
21305    }
21306
21307    /// /// Parse a `EXPORT DATA` statement.
21308    ///
21309    /// See [Statement::ExportData]
21310    fn parse_export_data(&mut self) -> Result<Statement, ParserError> {
21311        self.expect_keywords(&[Keyword::EXPORT, Keyword::DATA])?;
21312
21313        let connection = if self.parse_keywords(&[Keyword::WITH, Keyword::CONNECTION]) {
21314            Some(self.parse_object_name(false)?)
21315        } else {
21316            None
21317        };
21318        self.expect_keyword(Keyword::OPTIONS)?;
21319        self.expect_token(&Token::LParen)?;
21320        let options = self.parse_comma_separated(|p| p.parse_sql_option())?;
21321        self.expect_token(&Token::RParen)?;
21322        self.expect_keyword(Keyword::AS)?;
21323        let query = self.parse_query()?;
21324        Ok(Statement::ExportData(ExportData {
21325            options,
21326            query,
21327            connection,
21328        }))
21329    }
21330
21331    fn parse_vacuum(&mut self) -> Result<Statement, ParserError> {
21332        self.expect_keyword(Keyword::VACUUM)?;
21333        let full = self.parse_keyword(Keyword::FULL);
21334        let sort_only = self.parse_keywords(&[Keyword::SORT, Keyword::ONLY]);
21335        let delete_only = self.parse_keywords(&[Keyword::DELETE, Keyword::ONLY]);
21336        let reindex = self.parse_keyword(Keyword::REINDEX);
21337        let recluster = self.parse_keyword(Keyword::RECLUSTER);
21338        let (table_name, threshold, boost) =
21339            match self.maybe_parse(|p| p.parse_object_name(false))? {
21340                Some(table_name) => {
21341                    let threshold = if self.parse_keyword(Keyword::TO) {
21342                        let value = self.parse_value()?;
21343                        self.expect_keyword(Keyword::PERCENT)?;
21344                        Some(value)
21345                    } else {
21346                        None
21347                    };
21348                    let boost = self.parse_keyword(Keyword::BOOST);
21349                    (Some(table_name), threshold, boost)
21350                }
21351                _ => (None, None, false),
21352            };
21353        Ok(Statement::Vacuum(VacuumStatement {
21354            full,
21355            sort_only,
21356            delete_only,
21357            reindex,
21358            recluster,
21359            table_name,
21360            threshold,
21361            boost,
21362        }))
21363    }
21364
21365    /// Consume the parser and return its underlying token buffer
21366    pub fn into_tokens(self) -> Vec<TokenWithSpan> {
21367        self.tokens
21368    }
21369
21370    /// Returns true if the next keyword indicates a sub query, i.e. SELECT or WITH
21371    fn peek_sub_query(&mut self) -> bool {
21372        self.peek_one_of_keywords(&[Keyword::SELECT, Keyword::WITH])
21373            .is_some()
21374    }
21375
21376    pub(crate) fn parse_show_stmt_options(&mut self) -> Result<ShowStatementOptions, ParserError> {
21377        let show_in;
21378        let mut filter_position = None;
21379        if self.dialect.supports_show_like_before_in() {
21380            if let Some(filter) = self.parse_show_statement_filter()? {
21381                filter_position = Some(ShowStatementFilterPosition::Infix(filter));
21382            }
21383            show_in = self.maybe_parse_show_stmt_in()?;
21384        } else {
21385            show_in = self.maybe_parse_show_stmt_in()?;
21386            if let Some(filter) = self.parse_show_statement_filter()? {
21387                filter_position = Some(ShowStatementFilterPosition::Suffix(filter));
21388            }
21389        }
21390        let starts_with = self.maybe_parse_show_stmt_starts_with()?;
21391        let limit = self.maybe_parse_show_stmt_limit()?;
21392        let from = self.maybe_parse_show_stmt_from()?;
21393        Ok(ShowStatementOptions {
21394            filter_position,
21395            show_in,
21396            starts_with,
21397            limit,
21398            limit_from: from,
21399        })
21400    }
21401
21402    fn maybe_parse_show_stmt_in(&mut self) -> Result<Option<ShowStatementIn>, ParserError> {
21403        let clause = match self.parse_one_of_keywords(&[Keyword::FROM, Keyword::IN]) {
21404            Some(Keyword::FROM) => ShowStatementInClause::FROM,
21405            Some(Keyword::IN) => ShowStatementInClause::IN,
21406            None => return Ok(None),
21407            _ => return self.expected_ref("FROM or IN", self.peek_token_ref()),
21408        };
21409
21410        let (parent_type, parent_name) = match self.parse_one_of_keywords(&[
21411            Keyword::ACCOUNT,
21412            Keyword::DATABASE,
21413            Keyword::SCHEMA,
21414            Keyword::TABLE,
21415            Keyword::VIEW,
21416        ]) {
21417            // If we see these next keywords it means we don't have a parent name
21418            Some(Keyword::DATABASE)
21419                if self.peek_keywords(&[Keyword::STARTS, Keyword::WITH])
21420                    | self.peek_keyword(Keyword::LIMIT) =>
21421            {
21422                (Some(ShowStatementInParentType::Database), None)
21423            }
21424            Some(Keyword::SCHEMA)
21425                if self.peek_keywords(&[Keyword::STARTS, Keyword::WITH])
21426                    | self.peek_keyword(Keyword::LIMIT) =>
21427            {
21428                (Some(ShowStatementInParentType::Schema), None)
21429            }
21430            Some(parent_kw) => {
21431                // The parent name here is still optional, for example:
21432                // SHOW TABLES IN ACCOUNT, so parsing the object name
21433                // may fail because the statement ends.
21434                let parent_name = self.maybe_parse(|p| p.parse_object_name(false))?;
21435                match parent_kw {
21436                    Keyword::ACCOUNT => (Some(ShowStatementInParentType::Account), parent_name),
21437                    Keyword::DATABASE => (Some(ShowStatementInParentType::Database), parent_name),
21438                    Keyword::SCHEMA => (Some(ShowStatementInParentType::Schema), parent_name),
21439                    Keyword::TABLE => (Some(ShowStatementInParentType::Table), parent_name),
21440                    Keyword::VIEW => (Some(ShowStatementInParentType::View), parent_name),
21441                    _ => {
21442                        return self.expected_ref(
21443                            "one of ACCOUNT, DATABASE, SCHEMA, TABLE or VIEW",
21444                            self.peek_token_ref(),
21445                        )
21446                    }
21447                }
21448            }
21449            None => {
21450                // Parsing MySQL style FROM tbl_name FROM db_name
21451                // which is equivalent to FROM tbl_name.db_name
21452                let mut parent_name = self.parse_object_name(false)?;
21453                if self
21454                    .parse_one_of_keywords(&[Keyword::FROM, Keyword::IN])
21455                    .is_some()
21456                {
21457                    parent_name
21458                        .0
21459                        .insert(0, ObjectNamePart::Identifier(self.parse_identifier()?));
21460                }
21461                (None, Some(parent_name))
21462            }
21463        };
21464
21465        Ok(Some(ShowStatementIn {
21466            clause,
21467            parent_type,
21468            parent_name,
21469        }))
21470    }
21471
21472    fn maybe_parse_show_stmt_starts_with(&mut self) -> Result<Option<ValueWithSpan>, ParserError> {
21473        if self.parse_keywords(&[Keyword::STARTS, Keyword::WITH]) {
21474            Ok(Some(self.parse_value()?))
21475        } else {
21476            Ok(None)
21477        }
21478    }
21479
21480    fn maybe_parse_show_stmt_limit(&mut self) -> Result<Option<Expr>, ParserError> {
21481        if self.parse_keyword(Keyword::LIMIT) {
21482            Ok(self.parse_limit()?)
21483        } else {
21484            Ok(None)
21485        }
21486    }
21487
21488    fn maybe_parse_show_stmt_from(&mut self) -> Result<Option<ValueWithSpan>, ParserError> {
21489        if self.parse_keyword(Keyword::FROM) {
21490            Ok(Some(self.parse_value()?))
21491        } else {
21492            Ok(None)
21493        }
21494    }
21495
21496    pub(crate) fn in_column_definition_state(&self) -> bool {
21497        matches!(self.state, ColumnDefinition)
21498    }
21499
21500    /// Parses options provided in key-value format.
21501    ///
21502    /// * `parenthesized` - true if the options are enclosed in parenthesis
21503    /// * `end_words` - a list of keywords that any of them indicates the end of the options section
21504    pub(crate) fn parse_key_value_options(
21505        &mut self,
21506        parenthesized: bool,
21507        end_words: &[Keyword],
21508    ) -> Result<KeyValueOptions, ParserError> {
21509        let mut options: Vec<KeyValueOption> = Vec::new();
21510        let mut delimiter = KeyValueOptionsDelimiter::Space;
21511        if parenthesized {
21512            self.expect_token(&Token::LParen)?;
21513        }
21514        loop {
21515            match self.next_token().token {
21516                Token::RParen => {
21517                    if parenthesized {
21518                        break;
21519                    } else {
21520                        return self.expected_ref(" another option or EOF", self.peek_token_ref());
21521                    }
21522                }
21523                Token::EOF | Token::SemiColon => break,
21524                Token::Comma => {
21525                    delimiter = KeyValueOptionsDelimiter::Comma;
21526                    continue;
21527                }
21528                Token::Word(w) if !end_words.contains(&w.keyword) => {
21529                    options.push(self.parse_key_value_option(&w)?)
21530                }
21531                Token::Word(w) if end_words.contains(&w.keyword) => {
21532                    self.prev_token();
21533                    break;
21534                }
21535                _ => {
21536                    return self.expected_ref(
21537                        "another option, EOF, SemiColon, Comma or ')'",
21538                        self.peek_token_ref(),
21539                    )
21540                }
21541            };
21542        }
21543
21544        Ok(KeyValueOptions { delimiter, options })
21545    }
21546
21547    /// Parses a `KEY = VALUE` construct based on the specified key
21548    pub(crate) fn parse_key_value_option(
21549        &mut self,
21550        key: &Word,
21551    ) -> Result<KeyValueOption, ParserError> {
21552        self.expect_token(&Token::Eq)?;
21553        let peeked_token = self.peek_token();
21554        match peeked_token.token {
21555            Token::SingleQuotedString(_) => Ok(KeyValueOption {
21556                option_name: key.value.clone(),
21557                option_value: KeyValueOptionKind::Single(self.parse_value()?),
21558            }),
21559            Token::Word(word)
21560                if word.keyword == Keyword::TRUE || word.keyword == Keyword::FALSE =>
21561            {
21562                Ok(KeyValueOption {
21563                    option_name: key.value.clone(),
21564                    option_value: KeyValueOptionKind::Single(self.parse_value()?),
21565                })
21566            }
21567            Token::Number(..) => Ok(KeyValueOption {
21568                option_name: key.value.clone(),
21569                option_value: KeyValueOptionKind::Single(self.parse_value()?),
21570            }),
21571            Token::Word(word) => {
21572                self.next_token();
21573                Ok(KeyValueOption {
21574                    option_name: key.value.clone(),
21575                    option_value: KeyValueOptionKind::Single(
21576                        Value::Placeholder(word.value.clone()).with_span(peeked_token.span),
21577                    ),
21578                })
21579            }
21580            Token::LParen => {
21581                // Can be a list of values or a list of key value properties.
21582                // Try to parse a list of values and if that fails, try to parse
21583                // a list of key-value properties.
21584                match self.maybe_parse(|parser| {
21585                    parser.expect_token(&Token::LParen)?;
21586                    let values = parser.parse_comma_separated0(|p| p.parse_value(), Token::RParen);
21587                    parser.expect_token(&Token::RParen)?;
21588                    values
21589                })? {
21590                    Some(values) => Ok(KeyValueOption {
21591                        option_name: key.value.clone(),
21592                        option_value: KeyValueOptionKind::Multi(values),
21593                    }),
21594                    None => Ok(KeyValueOption {
21595                        option_name: key.value.clone(),
21596                        option_value: KeyValueOptionKind::KeyValueOptions(Box::new(
21597                            self.parse_key_value_options(true, &[])?,
21598                        )),
21599                    }),
21600                }
21601            }
21602            _ => self.expected_ref("expected option value", self.peek_token_ref()),
21603        }
21604    }
21605
21606    /// Parses a RESET statement
21607    fn parse_reset(&mut self) -> Result<ResetStatement, ParserError> {
21608        if self.parse_keyword(Keyword::ALL) {
21609            return Ok(ResetStatement { reset: Reset::ALL });
21610        }
21611
21612        let obj = self.parse_object_name(false)?;
21613        Ok(ResetStatement {
21614            reset: Reset::ConfigurationParameter(obj),
21615        })
21616    }
21617}
21618
21619fn maybe_prefixed_expr(expr: Expr, prefix: Option<Ident>) -> Expr {
21620    if let Some(prefix) = prefix {
21621        Expr::Prefixed {
21622            prefix,
21623            value: Box::new(expr),
21624        }
21625    } else {
21626        expr
21627    }
21628}
21629
21630impl Word {
21631    /// Convert a reference to this word into an [`Ident`] by cloning the value.
21632    ///
21633    /// Use this method when you need to keep the original `Word` around.
21634    /// If you can consume the `Word`, prefer [`into_ident`](Self::into_ident) instead
21635    /// to avoid cloning.
21636    pub fn to_ident(&self, span: Span) -> Ident {
21637        Ident {
21638            value: self.value.clone(),
21639            quote_style: self.quote_style,
21640            span,
21641        }
21642    }
21643
21644    /// Convert this word into an [`Ident`] identifier, consuming the `Word`.
21645    ///
21646    /// This avoids cloning the string value. If you need to keep the original
21647    /// `Word`, use [`to_ident`](Self::to_ident) instead.
21648    pub fn into_ident(self, span: Span) -> Ident {
21649        Ident {
21650            value: self.value,
21651            quote_style: self.quote_style,
21652            span,
21653        }
21654    }
21655}
21656
21657#[cfg(test)]
21658mod tests {
21659    use crate::test_utils::{all_dialects, TestedDialects};
21660
21661    use super::*;
21662
21663    #[test]
21664    fn test_prev_index() {
21665        let sql = "SELECT version";
21666        all_dialects().run_parser_method(sql, |parser| {
21667            assert_eq!(parser.peek_token(), Token::make_keyword("SELECT"));
21668            assert_eq!(parser.next_token(), Token::make_keyword("SELECT"));
21669            parser.prev_token();
21670            assert_eq!(parser.next_token(), Token::make_keyword("SELECT"));
21671            assert_eq!(parser.next_token(), Token::make_word("version", None));
21672            parser.prev_token();
21673            assert_eq!(parser.peek_token(), Token::make_word("version", None));
21674            assert_eq!(parser.next_token(), Token::make_word("version", None));
21675            assert_eq!(parser.peek_token(), Token::EOF);
21676            parser.prev_token();
21677            assert_eq!(parser.next_token(), Token::make_word("version", None));
21678            assert_eq!(parser.next_token(), Token::EOF);
21679            assert_eq!(parser.next_token(), Token::EOF);
21680            parser.prev_token();
21681        });
21682    }
21683
21684    #[test]
21685    fn test_peek_tokens() {
21686        all_dialects().run_parser_method("SELECT foo AS bar FROM baz", |parser| {
21687            assert!(matches!(
21688                parser.peek_tokens(),
21689                [Token::Word(Word {
21690                    keyword: Keyword::SELECT,
21691                    ..
21692                })]
21693            ));
21694
21695            assert!(matches!(
21696                parser.peek_tokens(),
21697                [
21698                    Token::Word(Word {
21699                        keyword: Keyword::SELECT,
21700                        ..
21701                    }),
21702                    Token::Word(_),
21703                    Token::Word(Word {
21704                        keyword: Keyword::AS,
21705                        ..
21706                    }),
21707                ]
21708            ));
21709
21710            for _ in 0..4 {
21711                parser.next_token();
21712            }
21713
21714            assert!(matches!(
21715                parser.peek_tokens(),
21716                [
21717                    Token::Word(Word {
21718                        keyword: Keyword::FROM,
21719                        ..
21720                    }),
21721                    Token::Word(_),
21722                    Token::EOF,
21723                    Token::EOF,
21724                ]
21725            ))
21726        })
21727    }
21728
21729    #[cfg(test)]
21730    mod test_parse_data_type {
21731        use crate::ast::{
21732            CharLengthUnits, CharacterLength, DataType, ExactNumberInfo, ObjectName, TimezoneInfo,
21733        };
21734        use crate::dialect::{AnsiDialect, GenericDialect, PostgreSqlDialect};
21735        use crate::test_utils::TestedDialects;
21736
21737        macro_rules! test_parse_data_type {
21738            ($dialect:expr, $input:expr, $expected_type:expr $(,)?) => {{
21739                $dialect.run_parser_method(&*$input, |parser| {
21740                    let data_type = parser.parse_data_type().unwrap();
21741                    assert_eq!($expected_type, data_type);
21742                    assert_eq!($input.to_string(), data_type.to_string());
21743                });
21744            }};
21745        }
21746
21747        #[test]
21748        fn test_ansii_character_string_types() {
21749            // Character string types: <https://jakewheat.github.io/sql-overview/sql-2016-foundation-grammar.html#character-string-type>
21750            let dialect =
21751                TestedDialects::new(vec![Box::new(GenericDialect {}), Box::new(AnsiDialect {})]);
21752
21753            test_parse_data_type!(dialect, "CHARACTER", DataType::Character(None));
21754
21755            test_parse_data_type!(
21756                dialect,
21757                "CHARACTER(20)",
21758                DataType::Character(Some(CharacterLength::IntegerLength {
21759                    length: 20,
21760                    unit: None
21761                }))
21762            );
21763
21764            test_parse_data_type!(
21765                dialect,
21766                "CHARACTER(20 CHARACTERS)",
21767                DataType::Character(Some(CharacterLength::IntegerLength {
21768                    length: 20,
21769                    unit: Some(CharLengthUnits::Characters)
21770                }))
21771            );
21772
21773            test_parse_data_type!(
21774                dialect,
21775                "CHARACTER(20 OCTETS)",
21776                DataType::Character(Some(CharacterLength::IntegerLength {
21777                    length: 20,
21778                    unit: Some(CharLengthUnits::Octets)
21779                }))
21780            );
21781
21782            test_parse_data_type!(dialect, "CHAR", DataType::Char(None));
21783
21784            test_parse_data_type!(
21785                dialect,
21786                "CHAR(20)",
21787                DataType::Char(Some(CharacterLength::IntegerLength {
21788                    length: 20,
21789                    unit: None
21790                }))
21791            );
21792
21793            test_parse_data_type!(
21794                dialect,
21795                "CHAR(20 CHARACTERS)",
21796                DataType::Char(Some(CharacterLength::IntegerLength {
21797                    length: 20,
21798                    unit: Some(CharLengthUnits::Characters)
21799                }))
21800            );
21801
21802            test_parse_data_type!(
21803                dialect,
21804                "CHAR(20 OCTETS)",
21805                DataType::Char(Some(CharacterLength::IntegerLength {
21806                    length: 20,
21807                    unit: Some(CharLengthUnits::Octets)
21808                }))
21809            );
21810
21811            test_parse_data_type!(
21812                dialect,
21813                "CHARACTER VARYING(20)",
21814                DataType::CharacterVarying(Some(CharacterLength::IntegerLength {
21815                    length: 20,
21816                    unit: None
21817                }))
21818            );
21819
21820            test_parse_data_type!(
21821                dialect,
21822                "CHARACTER VARYING(20 CHARACTERS)",
21823                DataType::CharacterVarying(Some(CharacterLength::IntegerLength {
21824                    length: 20,
21825                    unit: Some(CharLengthUnits::Characters)
21826                }))
21827            );
21828
21829            test_parse_data_type!(
21830                dialect,
21831                "CHARACTER VARYING(20 OCTETS)",
21832                DataType::CharacterVarying(Some(CharacterLength::IntegerLength {
21833                    length: 20,
21834                    unit: Some(CharLengthUnits::Octets)
21835                }))
21836            );
21837
21838            test_parse_data_type!(
21839                dialect,
21840                "CHAR VARYING(20)",
21841                DataType::CharVarying(Some(CharacterLength::IntegerLength {
21842                    length: 20,
21843                    unit: None
21844                }))
21845            );
21846
21847            test_parse_data_type!(
21848                dialect,
21849                "CHAR VARYING(20 CHARACTERS)",
21850                DataType::CharVarying(Some(CharacterLength::IntegerLength {
21851                    length: 20,
21852                    unit: Some(CharLengthUnits::Characters)
21853                }))
21854            );
21855
21856            test_parse_data_type!(
21857                dialect,
21858                "CHAR VARYING(20 OCTETS)",
21859                DataType::CharVarying(Some(CharacterLength::IntegerLength {
21860                    length: 20,
21861                    unit: Some(CharLengthUnits::Octets)
21862                }))
21863            );
21864
21865            test_parse_data_type!(
21866                dialect,
21867                "VARCHAR(20)",
21868                DataType::Varchar(Some(CharacterLength::IntegerLength {
21869                    length: 20,
21870                    unit: None
21871                }))
21872            );
21873        }
21874
21875        #[test]
21876        fn test_ansii_character_large_object_types() {
21877            // Character large object types: <https://jakewheat.github.io/sql-overview/sql-2016-foundation-grammar.html#character-large-object-length>
21878            let dialect =
21879                TestedDialects::new(vec![Box::new(GenericDialect {}), Box::new(AnsiDialect {})]);
21880
21881            test_parse_data_type!(
21882                dialect,
21883                "CHARACTER LARGE OBJECT",
21884                DataType::CharacterLargeObject(None)
21885            );
21886            test_parse_data_type!(
21887                dialect,
21888                "CHARACTER LARGE OBJECT(20)",
21889                DataType::CharacterLargeObject(Some(20))
21890            );
21891
21892            test_parse_data_type!(
21893                dialect,
21894                "CHAR LARGE OBJECT",
21895                DataType::CharLargeObject(None)
21896            );
21897            test_parse_data_type!(
21898                dialect,
21899                "CHAR LARGE OBJECT(20)",
21900                DataType::CharLargeObject(Some(20))
21901            );
21902
21903            test_parse_data_type!(dialect, "CLOB", DataType::Clob(None));
21904            test_parse_data_type!(dialect, "CLOB(20)", DataType::Clob(Some(20)));
21905        }
21906
21907        #[test]
21908        fn test_parse_custom_types() {
21909            let dialect =
21910                TestedDialects::new(vec![Box::new(GenericDialect {}), Box::new(AnsiDialect {})]);
21911
21912            test_parse_data_type!(
21913                dialect,
21914                "GEOMETRY",
21915                DataType::Custom(ObjectName::from(vec!["GEOMETRY".into()]), vec![])
21916            );
21917
21918            test_parse_data_type!(
21919                dialect,
21920                "GEOMETRY(POINT)",
21921                DataType::Custom(
21922                    ObjectName::from(vec!["GEOMETRY".into()]),
21923                    vec!["POINT".to_string()]
21924                )
21925            );
21926
21927            test_parse_data_type!(
21928                dialect,
21929                "GEOMETRY(POINT, 4326)",
21930                DataType::Custom(
21931                    ObjectName::from(vec!["GEOMETRY".into()]),
21932                    vec!["POINT".to_string(), "4326".to_string()]
21933                )
21934            );
21935        }
21936
21937        #[test]
21938        fn test_ansii_exact_numeric_types() {
21939            // Exact numeric types: <https://jakewheat.github.io/sql-overview/sql-2016-foundation-grammar.html#exact-numeric-type>
21940            let dialect = TestedDialects::new(vec![
21941                Box::new(GenericDialect {}),
21942                Box::new(AnsiDialect {}),
21943                Box::new(PostgreSqlDialect {}),
21944            ]);
21945
21946            test_parse_data_type!(dialect, "NUMERIC", DataType::Numeric(ExactNumberInfo::None));
21947
21948            test_parse_data_type!(
21949                dialect,
21950                "NUMERIC(2)",
21951                DataType::Numeric(ExactNumberInfo::Precision(2))
21952            );
21953
21954            test_parse_data_type!(
21955                dialect,
21956                "NUMERIC(2,10)",
21957                DataType::Numeric(ExactNumberInfo::PrecisionAndScale(2, 10))
21958            );
21959
21960            test_parse_data_type!(dialect, "DECIMAL", DataType::Decimal(ExactNumberInfo::None));
21961
21962            test_parse_data_type!(
21963                dialect,
21964                "DECIMAL(2)",
21965                DataType::Decimal(ExactNumberInfo::Precision(2))
21966            );
21967
21968            test_parse_data_type!(
21969                dialect,
21970                "DECIMAL(2,10)",
21971                DataType::Decimal(ExactNumberInfo::PrecisionAndScale(2, 10))
21972            );
21973
21974            test_parse_data_type!(dialect, "DEC", DataType::Dec(ExactNumberInfo::None));
21975
21976            test_parse_data_type!(
21977                dialect,
21978                "DEC(2)",
21979                DataType::Dec(ExactNumberInfo::Precision(2))
21980            );
21981
21982            test_parse_data_type!(
21983                dialect,
21984                "DEC(2,10)",
21985                DataType::Dec(ExactNumberInfo::PrecisionAndScale(2, 10))
21986            );
21987
21988            // Test negative scale values.
21989            test_parse_data_type!(
21990                dialect,
21991                "NUMERIC(10,-2)",
21992                DataType::Numeric(ExactNumberInfo::PrecisionAndScale(10, -2))
21993            );
21994
21995            test_parse_data_type!(
21996                dialect,
21997                "DECIMAL(1000,-10)",
21998                DataType::Decimal(ExactNumberInfo::PrecisionAndScale(1000, -10))
21999            );
22000
22001            test_parse_data_type!(
22002                dialect,
22003                "DEC(5,-1000)",
22004                DataType::Dec(ExactNumberInfo::PrecisionAndScale(5, -1000))
22005            );
22006
22007            test_parse_data_type!(
22008                dialect,
22009                "NUMERIC(10,-5)",
22010                DataType::Numeric(ExactNumberInfo::PrecisionAndScale(10, -5))
22011            );
22012
22013            test_parse_data_type!(
22014                dialect,
22015                "DECIMAL(20,-10)",
22016                DataType::Decimal(ExactNumberInfo::PrecisionAndScale(20, -10))
22017            );
22018
22019            test_parse_data_type!(
22020                dialect,
22021                "DEC(5,-2)",
22022                DataType::Dec(ExactNumberInfo::PrecisionAndScale(5, -2))
22023            );
22024
22025            dialect.run_parser_method("NUMERIC(10,+5)", |parser| {
22026                let data_type = parser.parse_data_type().unwrap();
22027                assert_eq!(
22028                    DataType::Numeric(ExactNumberInfo::PrecisionAndScale(10, 5)),
22029                    data_type
22030                );
22031                // Note: Explicit '+' sign is not preserved in output, which is correct
22032                assert_eq!("NUMERIC(10,5)", data_type.to_string());
22033            });
22034        }
22035
22036        #[test]
22037        fn test_ansii_date_type() {
22038            // Datetime types: <https://jakewheat.github.io/sql-overview/sql-2016-foundation-grammar.html#datetime-type>
22039            let dialect =
22040                TestedDialects::new(vec![Box::new(GenericDialect {}), Box::new(AnsiDialect {})]);
22041
22042            test_parse_data_type!(dialect, "DATE", DataType::Date);
22043
22044            test_parse_data_type!(dialect, "TIME", DataType::Time(None, TimezoneInfo::None));
22045
22046            test_parse_data_type!(
22047                dialect,
22048                "TIME(6)",
22049                DataType::Time(Some(6), TimezoneInfo::None)
22050            );
22051
22052            test_parse_data_type!(
22053                dialect,
22054                "TIME WITH TIME ZONE",
22055                DataType::Time(None, TimezoneInfo::WithTimeZone)
22056            );
22057
22058            test_parse_data_type!(
22059                dialect,
22060                "TIME(6) WITH TIME ZONE",
22061                DataType::Time(Some(6), TimezoneInfo::WithTimeZone)
22062            );
22063
22064            test_parse_data_type!(
22065                dialect,
22066                "TIME WITHOUT TIME ZONE",
22067                DataType::Time(None, TimezoneInfo::WithoutTimeZone)
22068            );
22069
22070            test_parse_data_type!(
22071                dialect,
22072                "TIME(6) WITHOUT TIME ZONE",
22073                DataType::Time(Some(6), TimezoneInfo::WithoutTimeZone)
22074            );
22075
22076            test_parse_data_type!(
22077                dialect,
22078                "TIMESTAMP",
22079                DataType::Timestamp(None, TimezoneInfo::None)
22080            );
22081
22082            test_parse_data_type!(
22083                dialect,
22084                "TIMESTAMP(22)",
22085                DataType::Timestamp(Some(22), TimezoneInfo::None)
22086            );
22087
22088            test_parse_data_type!(
22089                dialect,
22090                "TIMESTAMP(22) WITH TIME ZONE",
22091                DataType::Timestamp(Some(22), TimezoneInfo::WithTimeZone)
22092            );
22093
22094            test_parse_data_type!(
22095                dialect,
22096                "TIMESTAMP(33) WITHOUT TIME ZONE",
22097                DataType::Timestamp(Some(33), TimezoneInfo::WithoutTimeZone)
22098            );
22099        }
22100    }
22101
22102    #[test]
22103    fn test_parse_schema_name() {
22104        // The expected name should be identical as the input name, that's why I don't receive both
22105        macro_rules! test_parse_schema_name {
22106            ($input:expr, $expected_name:expr $(,)?) => {{
22107                all_dialects().run_parser_method(&*$input, |parser| {
22108                    let schema_name = parser.parse_schema_name().unwrap();
22109                    // Validate that the structure is the same as expected
22110                    assert_eq!(schema_name, $expected_name);
22111                    // Validate that the input and the expected structure serialization are the same
22112                    assert_eq!(schema_name.to_string(), $input.to_string());
22113                });
22114            }};
22115        }
22116
22117        let dummy_name = ObjectName::from(vec![Ident::new("dummy_name")]);
22118        let dummy_authorization = Ident::new("dummy_authorization");
22119
22120        test_parse_schema_name!(
22121            format!("{dummy_name}"),
22122            SchemaName::Simple(dummy_name.clone())
22123        );
22124
22125        test_parse_schema_name!(
22126            format!("AUTHORIZATION {dummy_authorization}"),
22127            SchemaName::UnnamedAuthorization(dummy_authorization.clone()),
22128        );
22129        test_parse_schema_name!(
22130            format!("{dummy_name} AUTHORIZATION {dummy_authorization}"),
22131            SchemaName::NamedAuthorization(dummy_name.clone(), dummy_authorization.clone()),
22132        );
22133    }
22134
22135    #[test]
22136    fn mysql_parse_index_table_constraint() {
22137        macro_rules! test_parse_table_constraint {
22138            ($dialect:expr, $input:expr, $expected:expr $(,)?) => {{
22139                $dialect.run_parser_method(&*$input, |parser| {
22140                    let constraint = parser.parse_optional_table_constraint().unwrap().unwrap();
22141                    // Validate that the structure is the same as expected
22142                    assert_eq!(constraint, $expected);
22143                    // Validate that the input and the expected structure serialization are the same
22144                    assert_eq!(constraint.to_string(), $input.to_string());
22145                });
22146            }};
22147        }
22148
22149        fn mk_expected_col(name: &str) -> IndexColumn {
22150            IndexColumn {
22151                column: OrderByExpr {
22152                    expr: Expr::Identifier(name.into()),
22153                    options: OrderByOptions {
22154                        asc: None,
22155                        nulls_first: None,
22156                    },
22157                    with_fill: None,
22158                },
22159                operator_class: None,
22160            }
22161        }
22162
22163        let dialect =
22164            TestedDialects::new(vec![Box::new(GenericDialect {}), Box::new(MySqlDialect {})]);
22165
22166        test_parse_table_constraint!(
22167            dialect,
22168            "INDEX (c1)",
22169            IndexConstraint {
22170                display_as_key: false,
22171                name: None,
22172                index_type: None,
22173                columns: vec![mk_expected_col("c1")],
22174                index_options: vec![],
22175            }
22176            .into()
22177        );
22178
22179        test_parse_table_constraint!(
22180            dialect,
22181            "KEY (c1)",
22182            IndexConstraint {
22183                display_as_key: true,
22184                name: None,
22185                index_type: None,
22186                columns: vec![mk_expected_col("c1")],
22187                index_options: vec![],
22188            }
22189            .into()
22190        );
22191
22192        test_parse_table_constraint!(
22193            dialect,
22194            "INDEX 'index' (c1, c2)",
22195            TableConstraint::Index(IndexConstraint {
22196                display_as_key: false,
22197                name: Some(Ident::with_quote('\'', "index")),
22198                index_type: None,
22199                columns: vec![mk_expected_col("c1"), mk_expected_col("c2")],
22200                index_options: vec![],
22201            })
22202        );
22203
22204        test_parse_table_constraint!(
22205            dialect,
22206            "INDEX USING BTREE (c1)",
22207            IndexConstraint {
22208                display_as_key: false,
22209                name: None,
22210                index_type: Some(IndexType::BTree),
22211                columns: vec![mk_expected_col("c1")],
22212                index_options: vec![],
22213            }
22214            .into()
22215        );
22216
22217        test_parse_table_constraint!(
22218            dialect,
22219            "INDEX USING HASH (c1)",
22220            IndexConstraint {
22221                display_as_key: false,
22222                name: None,
22223                index_type: Some(IndexType::Hash),
22224                columns: vec![mk_expected_col("c1")],
22225                index_options: vec![],
22226            }
22227            .into()
22228        );
22229
22230        test_parse_table_constraint!(
22231            dialect,
22232            "INDEX idx_name USING BTREE (c1)",
22233            IndexConstraint {
22234                display_as_key: false,
22235                name: Some(Ident::new("idx_name")),
22236                index_type: Some(IndexType::BTree),
22237                columns: vec![mk_expected_col("c1")],
22238                index_options: vec![],
22239            }
22240            .into()
22241        );
22242
22243        test_parse_table_constraint!(
22244            dialect,
22245            "INDEX idx_name USING HASH (c1)",
22246            IndexConstraint {
22247                display_as_key: false,
22248                name: Some(Ident::new("idx_name")),
22249                index_type: Some(IndexType::Hash),
22250                columns: vec![mk_expected_col("c1")],
22251                index_options: vec![],
22252            }
22253            .into()
22254        );
22255    }
22256
22257    #[test]
22258    fn test_tokenizer_error_loc() {
22259        let sql = "foo '";
22260        let ast = Parser::parse_sql(&GenericDialect, sql);
22261        assert_eq!(
22262            ast,
22263            Err(ParserError::TokenizerError(
22264                "Unterminated string literal at Line: 1, Column: 5".to_string()
22265            ))
22266        );
22267    }
22268
22269    #[test]
22270    fn test_parser_error_loc() {
22271        let sql = "SELECT this is a syntax error";
22272        let ast = Parser::parse_sql(&GenericDialect, sql);
22273        assert_eq!(
22274            ast,
22275            Err(ParserError::ParserError(
22276                "Expected: [NOT] NULL | TRUE | FALSE | DISTINCT | [form] NORMALIZED FROM after IS, found: a at Line: 1, Column: 16"
22277                    .to_string()
22278            ))
22279        );
22280    }
22281
22282    #[test]
22283    fn test_nested_explain_error() {
22284        let sql = "EXPLAIN EXPLAIN SELECT 1";
22285        let ast = Parser::parse_sql(&GenericDialect, sql);
22286        assert_eq!(
22287            ast,
22288            Err(ParserError::ParserError(
22289                "Explain must be root of the plan".to_string()
22290            ))
22291        );
22292    }
22293
22294    #[test]
22295    fn test_parse_multipart_identifier_positive() {
22296        let dialect = TestedDialects::new(vec![Box::new(GenericDialect {})]);
22297
22298        // parse multipart with quotes
22299        let expected = vec![
22300            Ident {
22301                value: "CATALOG".to_string(),
22302                quote_style: None,
22303                span: Span::empty(),
22304            },
22305            Ident {
22306                value: "F(o)o. \"bar".to_string(),
22307                quote_style: Some('"'),
22308                span: Span::empty(),
22309            },
22310            Ident {
22311                value: "table".to_string(),
22312                quote_style: None,
22313                span: Span::empty(),
22314            },
22315        ];
22316        dialect.run_parser_method(r#"CATALOG."F(o)o. ""bar".table"#, |parser| {
22317            let actual = parser.parse_multipart_identifier().unwrap();
22318            assert_eq!(expected, actual);
22319        });
22320
22321        // allow whitespace between ident parts
22322        let expected = vec![
22323            Ident {
22324                value: "CATALOG".to_string(),
22325                quote_style: None,
22326                span: Span::empty(),
22327            },
22328            Ident {
22329                value: "table".to_string(),
22330                quote_style: None,
22331                span: Span::empty(),
22332            },
22333        ];
22334        dialect.run_parser_method("CATALOG . table", |parser| {
22335            let actual = parser.parse_multipart_identifier().unwrap();
22336            assert_eq!(expected, actual);
22337        });
22338    }
22339
22340    #[test]
22341    fn test_parse_multipart_identifier_negative() {
22342        macro_rules! test_parse_multipart_identifier_error {
22343            ($input:expr, $expected_err:expr $(,)?) => {{
22344                all_dialects().run_parser_method(&*$input, |parser| {
22345                    let actual_err = parser.parse_multipart_identifier().unwrap_err();
22346                    assert_eq!(actual_err.to_string(), $expected_err);
22347                });
22348            }};
22349        }
22350
22351        test_parse_multipart_identifier_error!(
22352            "",
22353            "sql parser error: Empty input when parsing identifier",
22354        );
22355
22356        test_parse_multipart_identifier_error!(
22357            "*schema.table",
22358            "sql parser error: Unexpected token in identifier: *",
22359        );
22360
22361        test_parse_multipart_identifier_error!(
22362            "schema.table*",
22363            "sql parser error: Unexpected token in identifier: *",
22364        );
22365
22366        test_parse_multipart_identifier_error!(
22367            "schema.table.",
22368            "sql parser error: Trailing period in identifier",
22369        );
22370
22371        test_parse_multipart_identifier_error!(
22372            "schema.*",
22373            "sql parser error: Unexpected token following period in identifier: *",
22374        );
22375    }
22376
22377    #[test]
22378    fn test_mysql_partition_selection() {
22379        let sql = "SELECT * FROM employees PARTITION (p0, p2)";
22380        let expected = vec!["p0", "p2"];
22381
22382        let ast: Vec<Statement> = Parser::parse_sql(&MySqlDialect {}, sql).unwrap();
22383        assert_eq!(ast.len(), 1);
22384        if let Statement::Query(v) = &ast[0] {
22385            if let SetExpr::Select(select) = &*v.body {
22386                assert_eq!(select.from.len(), 1);
22387                let from: &TableWithJoins = &select.from[0];
22388                let table_factor = &from.relation;
22389                if let TableFactor::Table { partitions, .. } = table_factor {
22390                    let actual: Vec<&str> = partitions
22391                        .iter()
22392                        .map(|ident| ident.value.as_str())
22393                        .collect();
22394                    assert_eq!(expected, actual);
22395                }
22396            }
22397        } else {
22398            panic!("fail to parse mysql partition selection");
22399        }
22400    }
22401
22402    #[test]
22403    fn test_replace_into_placeholders() {
22404        let sql = "REPLACE INTO t (a) VALUES (&a)";
22405
22406        assert!(Parser::parse_sql(&GenericDialect {}, sql).is_err());
22407    }
22408
22409    #[test]
22410    fn test_replace_into_set_placeholder() {
22411        let sql = "REPLACE INTO t SET ?";
22412
22413        assert!(Parser::parse_sql(&GenericDialect {}, sql).is_err());
22414    }
22415
22416    #[test]
22417    fn test_replace_incomplete() {
22418        let sql = r#"REPLACE"#;
22419
22420        assert!(Parser::parse_sql(&MySqlDialect {}, sql).is_err());
22421    }
22422
22423    #[test]
22424    fn test_placeholder_invalid_whitespace() {
22425        for w in ["  ", "/*invalid*/"] {
22426            let sql = format!("\nSELECT\n  :{w}fooBar");
22427            assert!(Parser::parse_sql(&GenericDialect, &sql).is_err());
22428        }
22429    }
22430}