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 ClickHouseDialect|GenericDialect)
10902            && self.parse_keyword(Keyword::ATTACH)
10903        {
10904            AlterTableOperation::AttachPartition {
10905                partition: self.parse_part_or_partition()?,
10906            }
10907        } else if dialect_of!(self is ClickHouseDialect|GenericDialect)
10908            && self.parse_keyword(Keyword::DETACH)
10909        {
10910            AlterTableOperation::DetachPartition {
10911                partition: self.parse_part_or_partition()?,
10912            }
10913        } else if dialect_of!(self is ClickHouseDialect|GenericDialect)
10914            && self.parse_keyword(Keyword::FREEZE)
10915        {
10916            let partition = self.parse_part_or_partition()?;
10917            let with_name = if self.parse_keyword(Keyword::WITH) {
10918                self.expect_keyword_is(Keyword::NAME)?;
10919                Some(self.parse_identifier()?)
10920            } else {
10921                None
10922            };
10923            AlterTableOperation::FreezePartition {
10924                partition,
10925                with_name,
10926            }
10927        } else if dialect_of!(self is ClickHouseDialect|GenericDialect)
10928            && self.parse_keyword(Keyword::UNFREEZE)
10929        {
10930            let partition = self.parse_part_or_partition()?;
10931            let with_name = if self.parse_keyword(Keyword::WITH) {
10932                self.expect_keyword_is(Keyword::NAME)?;
10933                Some(self.parse_identifier()?)
10934            } else {
10935                None
10936            };
10937            AlterTableOperation::UnfreezePartition {
10938                partition,
10939                with_name,
10940            }
10941        } else if self.parse_keywords(&[Keyword::CLUSTER, Keyword::BY]) {
10942            self.expect_token(&Token::LParen)?;
10943            let exprs = self.parse_comma_separated(|parser| parser.parse_expr())?;
10944            self.expect_token(&Token::RParen)?;
10945            AlterTableOperation::ClusterBy { exprs }
10946        } else if self.parse_keywords(&[Keyword::SUSPEND, Keyword::RECLUSTER]) {
10947            AlterTableOperation::SuspendRecluster
10948        } else if self.parse_keywords(&[Keyword::RESUME, Keyword::RECLUSTER]) {
10949            AlterTableOperation::ResumeRecluster
10950        } else if self.parse_keyword(Keyword::LOCK) {
10951            let equals = self.consume_token(&Token::Eq);
10952            let lock = match self.parse_one_of_keywords(&[
10953                Keyword::DEFAULT,
10954                Keyword::EXCLUSIVE,
10955                Keyword::NONE,
10956                Keyword::SHARED,
10957            ]) {
10958                Some(Keyword::DEFAULT) => AlterTableLock::Default,
10959                Some(Keyword::EXCLUSIVE) => AlterTableLock::Exclusive,
10960                Some(Keyword::NONE) => AlterTableLock::None,
10961                Some(Keyword::SHARED) => AlterTableLock::Shared,
10962                _ => self.expected_ref(
10963                    "DEFAULT, EXCLUSIVE, NONE or SHARED after LOCK [=]",
10964                    self.peek_token_ref(),
10965                )?,
10966            };
10967            AlterTableOperation::Lock { equals, lock }
10968        } else if self.parse_keyword(Keyword::ALGORITHM) {
10969            let equals = self.consume_token(&Token::Eq);
10970            let algorithm = match self.parse_one_of_keywords(&[
10971                Keyword::DEFAULT,
10972                Keyword::INSTANT,
10973                Keyword::INPLACE,
10974                Keyword::COPY,
10975            ]) {
10976                Some(Keyword::DEFAULT) => AlterTableAlgorithm::Default,
10977                Some(Keyword::INSTANT) => AlterTableAlgorithm::Instant,
10978                Some(Keyword::INPLACE) => AlterTableAlgorithm::Inplace,
10979                Some(Keyword::COPY) => AlterTableAlgorithm::Copy,
10980                _ => self.expected_ref(
10981                    "DEFAULT, INSTANT, INPLACE, or COPY after ALGORITHM [=]",
10982                    self.peek_token_ref(),
10983                )?,
10984            };
10985            AlterTableOperation::Algorithm { equals, algorithm }
10986        } else if self.parse_keyword(Keyword::AUTO_INCREMENT) {
10987            let equals = self.consume_token(&Token::Eq);
10988            let value = self.parse_number_value()?;
10989            AlterTableOperation::AutoIncrement { equals, value }
10990        } else if self.parse_keywords(&[Keyword::REPLICA, Keyword::IDENTITY]) {
10991            let identity = if self.parse_keyword(Keyword::NOTHING) {
10992                ReplicaIdentity::Nothing
10993            } else if self.parse_keyword(Keyword::FULL) {
10994                ReplicaIdentity::Full
10995            } else if self.parse_keyword(Keyword::DEFAULT) {
10996                ReplicaIdentity::Default
10997            } else if self.parse_keywords(&[Keyword::USING, Keyword::INDEX]) {
10998                ReplicaIdentity::Index(self.parse_identifier()?)
10999            } else {
11000                return self.expected_ref(
11001                    "NOTHING, FULL, DEFAULT, or USING INDEX index_name after REPLICA IDENTITY",
11002                    self.peek_token_ref(),
11003                );
11004            };
11005
11006            AlterTableOperation::ReplicaIdentity { identity }
11007        } else if self.parse_keywords(&[Keyword::VALIDATE, Keyword::CONSTRAINT]) {
11008            let name = self.parse_identifier()?;
11009            AlterTableOperation::ValidateConstraint { name }
11010        } else if self.parse_keywords(&[Keyword::SET, Keyword::TABLESPACE]) {
11011            let tablespace_name = self.parse_identifier()?;
11012            AlterTableOperation::SetTablespace { tablespace_name }
11013        } else {
11014            let mut options =
11015                self.parse_options_with_keywords(&[Keyword::SET, Keyword::TBLPROPERTIES])?;
11016            if !options.is_empty() {
11017                AlterTableOperation::SetTblProperties {
11018                    table_properties: options,
11019                }
11020            } else {
11021                options = self.parse_options(Keyword::SET)?;
11022                if !options.is_empty() {
11023                    AlterTableOperation::SetOptionsParens { options }
11024                } else {
11025                    return self.expected_ref(
11026                    "ADD, RENAME, PARTITION, SWAP, DROP, REPLICA IDENTITY, SET, or SET TBLPROPERTIES after ALTER TABLE",
11027                    self.peek_token_ref(),
11028                  );
11029                }
11030            }
11031        };
11032        Ok(operation)
11033    }
11034
11035    fn parse_set_data_type(&mut self, had_set: bool) -> Result<AlterColumnOperation, ParserError> {
11036        let data_type = self.parse_data_type()?;
11037        let using = if self.dialect.supports_alter_column_type_using()
11038            && self.parse_keyword(Keyword::USING)
11039        {
11040            Some(self.parse_expr()?)
11041        } else {
11042            None
11043        };
11044        Ok(AlterColumnOperation::SetDataType {
11045            data_type,
11046            using,
11047            had_set,
11048        })
11049    }
11050
11051    fn parse_part_or_partition(&mut self) -> Result<Partition, ParserError> {
11052        let keyword = self.expect_one_of_keywords(&[Keyword::PART, Keyword::PARTITION])?;
11053        match keyword {
11054            Keyword::PART => Ok(Partition::Part(self.parse_expr()?)),
11055            Keyword::PARTITION => Ok(Partition::Expr(self.parse_expr()?)),
11056            // unreachable because expect_one_of_keywords used above
11057            unexpected_keyword => Err(ParserError::ParserError(
11058                format!("Internal parser error: expected any of {{PART, PARTITION}}, got {unexpected_keyword:?}"),
11059            )),
11060        }
11061    }
11062
11063    /// Parse an `ALTER <object>` statement and dispatch to the appropriate alter handler.
11064    pub fn parse_alter(&mut self) -> Result<Statement, ParserError> {
11065        let object_type = self.expect_one_of_keywords(&[
11066            Keyword::VIEW,
11067            Keyword::TYPE,
11068            Keyword::COLLATION,
11069            Keyword::TABLE,
11070            Keyword::INDEX,
11071            Keyword::FUNCTION,
11072            Keyword::AGGREGATE,
11073            Keyword::ROLE,
11074            Keyword::POLICY,
11075            Keyword::CONNECTOR,
11076            Keyword::ICEBERG,
11077            Keyword::SCHEMA,
11078            Keyword::USER,
11079            Keyword::OPERATOR,
11080            Keyword::DOMAIN,
11081            Keyword::TRIGGER,
11082            Keyword::EXTENSION,
11083            Keyword::PROCEDURE,
11084        ])?;
11085        match object_type {
11086            Keyword::SCHEMA => {
11087                self.prev_token();
11088                self.prev_token();
11089                self.parse_alter_schema()
11090            }
11091            Keyword::VIEW => self.parse_alter_view(),
11092            Keyword::TYPE => self.parse_alter_type(),
11093            Keyword::COLLATION => self.parse_alter_collation().map(Into::into),
11094            Keyword::TABLE => self.parse_alter_table(false),
11095            Keyword::ICEBERG => {
11096                self.expect_keyword(Keyword::TABLE)?;
11097                self.parse_alter_table(true)
11098            }
11099            Keyword::INDEX => {
11100                let index_name = self.parse_object_name(false)?;
11101                let operation = if self.parse_keyword(Keyword::RENAME) {
11102                    if self.parse_keyword(Keyword::TO) {
11103                        let index_name = self.parse_object_name(false)?;
11104                        AlterIndexOperation::RenameIndex { index_name }
11105                    } else {
11106                        return self.expected_ref("TO after RENAME", self.peek_token_ref());
11107                    }
11108                } else if self.parse_keywords(&[Keyword::SET, Keyword::TABLESPACE]) {
11109                    let tablespace_name = self.parse_identifier()?;
11110                    AlterIndexOperation::SetTablespace { tablespace_name }
11111                } else {
11112                    return self.expected_ref(
11113                        "RENAME or SET TABLESPACE after ALTER INDEX",
11114                        self.peek_token_ref(),
11115                    );
11116                };
11117
11118                Ok(Statement::AlterIndex {
11119                    name: index_name,
11120                    operation,
11121                })
11122            }
11123            Keyword::FUNCTION => self.parse_alter_function(AlterFunctionKind::Function),
11124            Keyword::AGGREGATE => self.parse_alter_function(AlterFunctionKind::Aggregate),
11125            Keyword::PROCEDURE => self.parse_alter_function(AlterFunctionKind::Procedure),
11126            Keyword::OPERATOR => {
11127                if self.parse_keyword(Keyword::FAMILY) {
11128                    self.parse_alter_operator_family().map(Into::into)
11129                } else if self.parse_keyword(Keyword::CLASS) {
11130                    self.parse_alter_operator_class().map(Into::into)
11131                } else {
11132                    self.parse_alter_operator().map(Into::into)
11133                }
11134            }
11135            Keyword::ROLE => self.parse_alter_role(),
11136            Keyword::POLICY => self.parse_alter_policy().map(Into::into),
11137            Keyword::CONNECTOR => self.parse_alter_connector(),
11138            Keyword::USER => self.parse_alter_user().map(Into::into),
11139            Keyword::DOMAIN => self.parse_alter_domain(),
11140            Keyword::TRIGGER => self.parse_alter_trigger(),
11141            Keyword::EXTENSION => self.parse_alter_extension(),
11142            // unreachable because expect_one_of_keywords used above
11143            unexpected_keyword => Err(ParserError::ParserError(
11144                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:?}"),
11145            )),
11146        }
11147    }
11148
11149    fn parse_alter_aggregate_signature(
11150        &mut self,
11151    ) -> Result<(FunctionDesc, bool, Option<Vec<OperateFunctionArg>>), ParserError> {
11152        let name = self.parse_object_name(false)?;
11153        self.expect_token(&Token::LParen)?;
11154
11155        if self.consume_token(&Token::Mul) {
11156            self.expect_token(&Token::RParen)?;
11157            return Ok((
11158                FunctionDesc {
11159                    name,
11160                    args: Some(vec![]),
11161                },
11162                true,
11163                None,
11164            ));
11165        }
11166
11167        let args =
11168            if self.peek_keyword(Keyword::ORDER) || self.peek_token_ref().token == Token::RParen {
11169                vec![]
11170            } else {
11171                self.parse_comma_separated(Parser::parse_aggregate_function_arg)?
11172            };
11173
11174        let aggregate_order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
11175            Some(self.parse_comma_separated(Parser::parse_aggregate_function_arg)?)
11176        } else {
11177            None
11178        };
11179
11180        self.expect_token(&Token::RParen)?;
11181        Ok((
11182            FunctionDesc {
11183                name,
11184                args: Some(args),
11185            },
11186            false,
11187            aggregate_order_by,
11188        ))
11189    }
11190
11191    fn parse_alter_function_action(&mut self) -> Result<Option<AlterFunctionAction>, ParserError> {
11192        let action = if self.parse_keywords(&[
11193            Keyword::CALLED,
11194            Keyword::ON,
11195            Keyword::NULL,
11196            Keyword::INPUT,
11197        ]) {
11198            Some(AlterFunctionAction::CalledOnNull(
11199                FunctionCalledOnNull::CalledOnNullInput,
11200            ))
11201        } else if self.parse_keywords(&[
11202            Keyword::RETURNS,
11203            Keyword::NULL,
11204            Keyword::ON,
11205            Keyword::NULL,
11206            Keyword::INPUT,
11207        ]) {
11208            Some(AlterFunctionAction::CalledOnNull(
11209                FunctionCalledOnNull::ReturnsNullOnNullInput,
11210            ))
11211        } else if self.parse_keyword(Keyword::STRICT) {
11212            Some(AlterFunctionAction::CalledOnNull(
11213                FunctionCalledOnNull::Strict,
11214            ))
11215        } else if self.parse_keyword(Keyword::IMMUTABLE) {
11216            Some(AlterFunctionAction::Behavior(FunctionBehavior::Immutable))
11217        } else if self.parse_keyword(Keyword::STABLE) {
11218            Some(AlterFunctionAction::Behavior(FunctionBehavior::Stable))
11219        } else if self.parse_keyword(Keyword::VOLATILE) {
11220            Some(AlterFunctionAction::Behavior(FunctionBehavior::Volatile))
11221        } else if self.parse_keyword(Keyword::NOT) {
11222            self.expect_keyword(Keyword::LEAKPROOF)?;
11223            Some(AlterFunctionAction::Leakproof(false))
11224        } else if self.parse_keyword(Keyword::LEAKPROOF) {
11225            Some(AlterFunctionAction::Leakproof(true))
11226        } else if self.parse_keyword(Keyword::EXTERNAL) {
11227            self.expect_keyword(Keyword::SECURITY)?;
11228            let security = if self.parse_keyword(Keyword::DEFINER) {
11229                FunctionSecurity::Definer
11230            } else if self.parse_keyword(Keyword::INVOKER) {
11231                FunctionSecurity::Invoker
11232            } else {
11233                return self.expected_ref("DEFINER or INVOKER", self.peek_token_ref());
11234            };
11235            Some(AlterFunctionAction::Security {
11236                external: true,
11237                security,
11238            })
11239        } else if self.parse_keyword(Keyword::SECURITY) {
11240            let security = if self.parse_keyword(Keyword::DEFINER) {
11241                FunctionSecurity::Definer
11242            } else if self.parse_keyword(Keyword::INVOKER) {
11243                FunctionSecurity::Invoker
11244            } else {
11245                return self.expected_ref("DEFINER or INVOKER", self.peek_token_ref());
11246            };
11247            Some(AlterFunctionAction::Security {
11248                external: false,
11249                security,
11250            })
11251        } else if self.parse_keyword(Keyword::PARALLEL) {
11252            let parallel = if self.parse_keyword(Keyword::UNSAFE) {
11253                FunctionParallel::Unsafe
11254            } else if self.parse_keyword(Keyword::RESTRICTED) {
11255                FunctionParallel::Restricted
11256            } else if self.parse_keyword(Keyword::SAFE) {
11257                FunctionParallel::Safe
11258            } else {
11259                return self
11260                    .expected_ref("one of UNSAFE | RESTRICTED | SAFE", self.peek_token_ref());
11261            };
11262            Some(AlterFunctionAction::Parallel(parallel))
11263        } else if self.parse_keyword(Keyword::COST) {
11264            Some(AlterFunctionAction::Cost(self.parse_number()?))
11265        } else if self.parse_keyword(Keyword::ROWS) {
11266            Some(AlterFunctionAction::Rows(self.parse_number()?))
11267        } else if self.parse_keyword(Keyword::SUPPORT) {
11268            Some(AlterFunctionAction::Support(self.parse_object_name(false)?))
11269        } else if self.parse_keyword(Keyword::SET) {
11270            let name = self.parse_object_name(false)?;
11271            let value = if self.parse_keywords(&[Keyword::FROM, Keyword::CURRENT]) {
11272                FunctionSetValue::FromCurrent
11273            } else {
11274                if !self.consume_token(&Token::Eq) && !self.parse_keyword(Keyword::TO) {
11275                    return self.expected_ref("= or TO", self.peek_token_ref());
11276                }
11277                if self.parse_keyword(Keyword::DEFAULT) {
11278                    FunctionSetValue::Default
11279                } else {
11280                    FunctionSetValue::Values(self.parse_comma_separated(Parser::parse_expr)?)
11281                }
11282            };
11283            Some(AlterFunctionAction::Set(FunctionDefinitionSetParam {
11284                name,
11285                value,
11286            }))
11287        } else if self.parse_keyword(Keyword::RESET) {
11288            let reset_config = if self.parse_keyword(Keyword::ALL) {
11289                ResetConfig::ALL
11290            } else {
11291                ResetConfig::ConfigName(self.parse_object_name(false)?)
11292            };
11293            Some(AlterFunctionAction::Reset(reset_config))
11294        } else {
11295            None
11296        };
11297
11298        Ok(action)
11299    }
11300
11301    fn parse_alter_function_actions(
11302        &mut self,
11303    ) -> Result<(Vec<AlterFunctionAction>, bool), ParserError> {
11304        let mut actions = vec![];
11305        while let Some(action) = self.parse_alter_function_action()? {
11306            actions.push(action);
11307        }
11308        if actions.is_empty() {
11309            return self.expected_ref("at least one ALTER FUNCTION action", self.peek_token_ref());
11310        }
11311        let restrict = self.parse_keyword(Keyword::RESTRICT);
11312        Ok((actions, restrict))
11313    }
11314
11315    /// Parse an `ALTER FUNCTION` or `ALTER AGGREGATE` statement.
11316    pub fn parse_alter_function(
11317        &mut self,
11318        kind: AlterFunctionKind,
11319    ) -> Result<Statement, ParserError> {
11320        let (function, aggregate_star, aggregate_order_by) = match kind {
11321            AlterFunctionKind::Function | AlterFunctionKind::Procedure => {
11322                (self.parse_function_desc()?, false, None)
11323            }
11324            AlterFunctionKind::Aggregate => self.parse_alter_aggregate_signature()?,
11325        };
11326
11327        let operation = if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11328            let new_name = self.parse_identifier()?;
11329            AlterFunctionOperation::RenameTo { new_name }
11330        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11331            AlterFunctionOperation::OwnerTo(self.parse_owner()?)
11332        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11333            AlterFunctionOperation::SetSchema {
11334                schema_name: self.parse_object_name(false)?,
11335            }
11336        } else if matches!(kind, AlterFunctionKind::Function | AlterFunctionKind::Procedure)
11337            && self.parse_keyword(Keyword::NO)
11338        {
11339            if !self.parse_keyword(Keyword::DEPENDS) {
11340                return self.expected_ref("DEPENDS after NO", self.peek_token_ref());
11341            }
11342            self.expect_keywords(&[Keyword::ON, Keyword::EXTENSION])?;
11343            AlterFunctionOperation::DependsOnExtension {
11344                no: true,
11345                extension_name: self.parse_object_name(false)?,
11346            }
11347        } else if matches!(kind, AlterFunctionKind::Function | AlterFunctionKind::Procedure)
11348            && self.parse_keyword(Keyword::DEPENDS)
11349        {
11350            self.expect_keywords(&[Keyword::ON, Keyword::EXTENSION])?;
11351            AlterFunctionOperation::DependsOnExtension {
11352                no: false,
11353                extension_name: self.parse_object_name(false)?,
11354            }
11355        } else if matches!(kind, AlterFunctionKind::Function | AlterFunctionKind::Procedure) {
11356            let (actions, restrict) = self.parse_alter_function_actions()?;
11357            AlterFunctionOperation::Actions { actions, restrict }
11358        } else {
11359            return self.expected_ref(
11360                "RENAME TO, OWNER TO, or SET SCHEMA after ALTER AGGREGATE",
11361                self.peek_token_ref(),
11362            );
11363        };
11364
11365        Ok(Statement::AlterFunction(AlterFunction {
11366            kind,
11367            function,
11368            aggregate_order_by,
11369            aggregate_star,
11370            operation,
11371        }))
11372    }
11373
11374    /// Parse an `ALTER DOMAIN` statement.
11375    pub fn parse_alter_domain(&mut self) -> Result<Statement, ParserError> {
11376        let name = self.parse_object_name(false)?;
11377
11378        let operation = if self.parse_keyword(Keyword::ADD) {
11379            if let Some(constraint) = self.parse_optional_table_constraint()? {
11380                let not_valid = self.parse_keywords(&[Keyword::NOT, Keyword::VALID]);
11381                AlterDomainOperation::AddConstraint {
11382                    constraint,
11383                    not_valid,
11384                }
11385            } else {
11386                return self.expected_ref("constraint after ADD", self.peek_token_ref());
11387            }
11388        } else if self.parse_keywords(&[Keyword::DROP, Keyword::CONSTRAINT]) {
11389            let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
11390            let name = self.parse_identifier()?;
11391            let drop_behavior = self.parse_optional_drop_behavior();
11392            AlterDomainOperation::DropConstraint {
11393                if_exists,
11394                name,
11395                drop_behavior,
11396            }
11397        } else if self.parse_keywords(&[Keyword::DROP, Keyword::DEFAULT]) {
11398            AlterDomainOperation::DropDefault
11399        } else if self.parse_keywords(&[Keyword::RENAME, Keyword::CONSTRAINT]) {
11400            let old_name = self.parse_identifier()?;
11401            self.expect_keyword_is(Keyword::TO)?;
11402            let new_name = self.parse_identifier()?;
11403            AlterDomainOperation::RenameConstraint { old_name, new_name }
11404        } else if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11405            let new_name = self.parse_identifier()?;
11406            AlterDomainOperation::RenameTo { new_name }
11407        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11408            AlterDomainOperation::OwnerTo(self.parse_owner()?)
11409        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11410            AlterDomainOperation::SetSchema {
11411                schema_name: self.parse_object_name(false)?,
11412            }
11413        } else if self.parse_keywords(&[Keyword::SET, Keyword::DEFAULT]) {
11414            AlterDomainOperation::SetDefault {
11415                default: self.parse_expr()?,
11416            }
11417        } else if self.parse_keywords(&[Keyword::VALIDATE, Keyword::CONSTRAINT]) {
11418            let name = self.parse_identifier()?;
11419            AlterDomainOperation::ValidateConstraint { name }
11420        } else {
11421            return self.expected_ref(
11422                "ADD, DROP, RENAME, OWNER TO, SET, VALIDATE after ALTER DOMAIN",
11423                self.peek_token_ref(),
11424            );
11425        };
11426
11427        Ok(AlterDomain { name, operation }.into())
11428    }
11429
11430    /// Parse an `ALTER TRIGGER` statement.
11431    pub fn parse_alter_trigger(&mut self) -> Result<Statement, ParserError> {
11432        let name = self.parse_identifier()?;
11433        self.expect_keyword_is(Keyword::ON)?;
11434        let table_name = self.parse_object_name(false)?;
11435
11436        let operation = if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11437            let new_name = self.parse_identifier()?;
11438            AlterTriggerOperation::RenameTo { new_name }
11439        } else {
11440            return self.expected_ref("RENAME TO after ALTER TRIGGER ... ON ...", self.peek_token_ref());
11441        };
11442
11443        Ok(AlterTrigger {
11444            name,
11445            table_name,
11446            operation,
11447        }
11448        .into())
11449    }
11450
11451    /// Parse an `ALTER EXTENSION` statement.
11452    pub fn parse_alter_extension(&mut self) -> Result<Statement, ParserError> {
11453        let name = self.parse_identifier()?;
11454
11455        let operation = if self.parse_keyword(Keyword::UPDATE) {
11456            let version = if self.parse_keyword(Keyword::TO) {
11457                Some(self.parse_identifier()?)
11458            } else {
11459                None
11460            };
11461            AlterExtensionOperation::UpdateTo { version }
11462        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11463            AlterExtensionOperation::SetSchema {
11464                schema_name: self.parse_object_name(false)?,
11465            }
11466        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11467            AlterExtensionOperation::OwnerTo(self.parse_owner()?)
11468        } else if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11469            let new_name = self.parse_identifier()?;
11470            AlterExtensionOperation::RenameTo { new_name }
11471        } else {
11472            return self.expected_ref(
11473                "UPDATE, SET SCHEMA, OWNER TO, or RENAME TO after ALTER EXTENSION",
11474                self.peek_token_ref(),
11475            );
11476        };
11477
11478        Ok(AlterExtension { name, operation }.into())
11479    }
11480
11481    /// Parse a [Statement::AlterTable]
11482    pub fn parse_alter_table(&mut self, iceberg: bool) -> Result<Statement, ParserError> {
11483        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
11484        let only = self.parse_keyword(Keyword::ONLY); // [ ONLY ]
11485        let table_name = self.parse_object_name(false)?;
11486        let on_cluster = self.parse_optional_on_cluster()?;
11487        let operations = self.parse_comma_separated(Parser::parse_alter_table_operation)?;
11488
11489        let mut location = None;
11490        if self.parse_keyword(Keyword::LOCATION) {
11491            location = Some(HiveSetLocation {
11492                has_set: false,
11493                location: self.parse_identifier()?,
11494            });
11495        } else if self.parse_keywords(&[Keyword::SET, Keyword::LOCATION]) {
11496            location = Some(HiveSetLocation {
11497                has_set: true,
11498                location: self.parse_identifier()?,
11499            });
11500        }
11501
11502        let end_token = if self.peek_token_ref().token == Token::SemiColon {
11503            self.peek_token_ref().clone()
11504        } else {
11505            self.get_current_token().clone()
11506        };
11507
11508        Ok(AlterTable {
11509            name: table_name,
11510            if_exists,
11511            only,
11512            operations,
11513            location,
11514            on_cluster,
11515            table_type: if iceberg {
11516                Some(AlterTableType::Iceberg)
11517            } else {
11518                None
11519            },
11520            end_token: AttachedToken(end_token),
11521        }
11522        .into())
11523    }
11524
11525    /// Parse an `ALTER VIEW` statement.
11526    pub fn parse_alter_view(&mut self) -> Result<Statement, ParserError> {
11527        let name = self.parse_object_name(false)?;
11528        let columns = self.parse_parenthesized_column_list(Optional, false)?;
11529
11530        let with_options = self.parse_options(Keyword::WITH)?;
11531
11532        self.expect_keyword_is(Keyword::AS)?;
11533        let query = self.parse_query()?;
11534
11535        Ok(Statement::AlterView {
11536            name,
11537            columns,
11538            query,
11539            with_options,
11540        })
11541    }
11542
11543    /// Parse a [Statement::AlterType]
11544    pub fn parse_alter_type(&mut self) -> Result<Statement, ParserError> {
11545        let name = self.parse_object_name(false)?;
11546
11547        if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11548            let new_name = self.parse_identifier()?;
11549            Ok(Statement::AlterType(AlterType {
11550                name,
11551                operation: AlterTypeOperation::Rename(AlterTypeRename { new_name }),
11552            }))
11553        } else if self.parse_keywords(&[Keyword::ADD, Keyword::VALUE]) {
11554            let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
11555            let new_enum_value = self.parse_identifier()?;
11556            let position = if self.parse_keyword(Keyword::BEFORE) {
11557                Some(AlterTypeAddValuePosition::Before(self.parse_identifier()?))
11558            } else if self.parse_keyword(Keyword::AFTER) {
11559                Some(AlterTypeAddValuePosition::After(self.parse_identifier()?))
11560            } else {
11561                None
11562            };
11563
11564            Ok(Statement::AlterType(AlterType {
11565                name,
11566                operation: AlterTypeOperation::AddValue(AlterTypeAddValue {
11567                    if_not_exists,
11568                    value: new_enum_value,
11569                    position,
11570                }),
11571            }))
11572        } else if self.parse_keywords(&[Keyword::RENAME, Keyword::VALUE]) {
11573            let existing_enum_value = self.parse_identifier()?;
11574            self.expect_keyword(Keyword::TO)?;
11575            let new_enum_value = self.parse_identifier()?;
11576
11577            Ok(Statement::AlterType(AlterType {
11578                name,
11579                operation: AlterTypeOperation::RenameValue(AlterTypeRenameValue {
11580                    from: existing_enum_value,
11581                    to: new_enum_value,
11582                }),
11583            }))
11584        } else {
11585            self.expected_ref(
11586                "{RENAME TO | { RENAME | ADD } VALUE}",
11587                self.peek_token_ref(),
11588            )
11589        }
11590    }
11591
11592    /// Parse a [Statement::AlterCollation].
11593    ///
11594    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-altercollation.html)
11595    pub fn parse_alter_collation(&mut self) -> Result<AlterCollation, ParserError> {
11596        let name = self.parse_object_name(false)?;
11597        let operation = if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11598            AlterCollationOperation::RenameTo {
11599                new_name: self.parse_identifier()?,
11600            }
11601        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11602            AlterCollationOperation::OwnerTo(self.parse_owner()?)
11603        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11604            AlterCollationOperation::SetSchema {
11605                schema_name: self.parse_object_name(false)?,
11606            }
11607        } else if self.parse_keywords(&[Keyword::REFRESH, Keyword::VERSION]) {
11608            AlterCollationOperation::RefreshVersion
11609        } else {
11610            return self.expected_ref(
11611                "RENAME TO, OWNER TO, SET SCHEMA, or REFRESH VERSION after ALTER COLLATION",
11612                self.peek_token_ref(),
11613            );
11614        };
11615
11616        Ok(AlterCollation { name, operation })
11617    }
11618
11619    /// Parse a [Statement::AlterOperator]
11620    ///
11621    /// [PostgreSQL Documentation](https://www.postgresql.org/docs/current/sql-alteroperator.html)
11622    pub fn parse_alter_operator(&mut self) -> Result<AlterOperator, ParserError> {
11623        let name = self.parse_operator_name()?;
11624
11625        // Parse (left_type, right_type)
11626        self.expect_token(&Token::LParen)?;
11627
11628        let left_type = if self.parse_keyword(Keyword::NONE) {
11629            None
11630        } else {
11631            Some(self.parse_data_type()?)
11632        };
11633
11634        self.expect_token(&Token::Comma)?;
11635        let right_type = self.parse_data_type()?;
11636        self.expect_token(&Token::RParen)?;
11637
11638        // Parse the operation
11639        let operation = if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11640            let owner = if self.parse_keyword(Keyword::CURRENT_ROLE) {
11641                Owner::CurrentRole
11642            } else if self.parse_keyword(Keyword::CURRENT_USER) {
11643                Owner::CurrentUser
11644            } else if self.parse_keyword(Keyword::SESSION_USER) {
11645                Owner::SessionUser
11646            } else {
11647                Owner::Ident(self.parse_identifier()?)
11648            };
11649            AlterOperatorOperation::OwnerTo(owner)
11650        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11651            let schema_name = self.parse_object_name(false)?;
11652            AlterOperatorOperation::SetSchema { schema_name }
11653        } else if self.parse_keyword(Keyword::SET) {
11654            self.expect_token(&Token::LParen)?;
11655
11656            let mut options = Vec::new();
11657            loop {
11658                let keyword = self.expect_one_of_keywords(&[
11659                    Keyword::RESTRICT,
11660                    Keyword::JOIN,
11661                    Keyword::COMMUTATOR,
11662                    Keyword::NEGATOR,
11663                    Keyword::HASHES,
11664                    Keyword::MERGES,
11665                ])?;
11666
11667                match keyword {
11668                    Keyword::RESTRICT => {
11669                        self.expect_token(&Token::Eq)?;
11670                        let proc_name = if self.parse_keyword(Keyword::NONE) {
11671                            None
11672                        } else {
11673                            Some(self.parse_object_name(false)?)
11674                        };
11675                        options.push(OperatorOption::Restrict(proc_name));
11676                    }
11677                    Keyword::JOIN => {
11678                        self.expect_token(&Token::Eq)?;
11679                        let proc_name = if self.parse_keyword(Keyword::NONE) {
11680                            None
11681                        } else {
11682                            Some(self.parse_object_name(false)?)
11683                        };
11684                        options.push(OperatorOption::Join(proc_name));
11685                    }
11686                    Keyword::COMMUTATOR => {
11687                        self.expect_token(&Token::Eq)?;
11688                        let op_name = self.parse_operator_name()?;
11689                        options.push(OperatorOption::Commutator(op_name));
11690                    }
11691                    Keyword::NEGATOR => {
11692                        self.expect_token(&Token::Eq)?;
11693                        let op_name = self.parse_operator_name()?;
11694                        options.push(OperatorOption::Negator(op_name));
11695                    }
11696                    Keyword::HASHES => {
11697                        options.push(OperatorOption::Hashes);
11698                    }
11699                    Keyword::MERGES => {
11700                        options.push(OperatorOption::Merges);
11701                    }
11702                    unexpected_keyword => return Err(ParserError::ParserError(
11703                        format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in operator option"),
11704                    )),
11705                }
11706
11707                if !self.consume_token(&Token::Comma) {
11708                    break;
11709                }
11710            }
11711
11712            self.expect_token(&Token::RParen)?;
11713            AlterOperatorOperation::Set { options }
11714        } else {
11715            return self.expected_ref(
11716                "OWNER TO, SET SCHEMA, or SET after ALTER OPERATOR",
11717                self.peek_token_ref(),
11718            );
11719        };
11720
11721        Ok(AlterOperator {
11722            name,
11723            left_type,
11724            right_type,
11725            operation,
11726        })
11727    }
11728
11729    /// Parse an operator item for ALTER OPERATOR FAMILY ADD operations
11730    fn parse_operator_family_add_operator(&mut self) -> Result<OperatorFamilyItem, ParserError> {
11731        let strategy_number = self.parse_literal_uint()?;
11732        let operator_name = self.parse_operator_name()?;
11733
11734        // Operator argument types (required for ALTER OPERATOR FAMILY)
11735        self.expect_token(&Token::LParen)?;
11736        let op_types = self.parse_comma_separated(Parser::parse_data_type)?;
11737        self.expect_token(&Token::RParen)?;
11738
11739        // Optional purpose
11740        let purpose = if self.parse_keyword(Keyword::FOR) {
11741            if self.parse_keyword(Keyword::SEARCH) {
11742                Some(OperatorPurpose::ForSearch)
11743            } else if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
11744                let sort_family = self.parse_object_name(false)?;
11745                Some(OperatorPurpose::ForOrderBy { sort_family })
11746            } else {
11747                return self.expected_ref("SEARCH or ORDER BY after FOR", self.peek_token_ref());
11748            }
11749        } else {
11750            None
11751        };
11752
11753        Ok(OperatorFamilyItem::Operator {
11754            strategy_number,
11755            operator_name,
11756            op_types,
11757            purpose,
11758        })
11759    }
11760
11761    /// Parse a function item for ALTER OPERATOR FAMILY ADD operations
11762    fn parse_operator_family_add_function(&mut self) -> Result<OperatorFamilyItem, ParserError> {
11763        let support_number = self.parse_literal_uint()?;
11764
11765        // Optional operator types
11766        let op_types =
11767            if self.consume_token(&Token::LParen) && self.peek_token_ref().token != Token::RParen {
11768                let types = self.parse_comma_separated(Parser::parse_data_type)?;
11769                self.expect_token(&Token::RParen)?;
11770                Some(types)
11771            } else if self.consume_token(&Token::LParen) {
11772                self.expect_token(&Token::RParen)?;
11773                Some(vec![])
11774            } else {
11775                None
11776            };
11777
11778        let function_name = self.parse_object_name(false)?;
11779
11780        // Function argument types
11781        let argument_types = if self.consume_token(&Token::LParen) {
11782            if self.peek_token_ref().token == Token::RParen {
11783                self.expect_token(&Token::RParen)?;
11784                vec![]
11785            } else {
11786                let types = self.parse_comma_separated(Parser::parse_data_type)?;
11787                self.expect_token(&Token::RParen)?;
11788                types
11789            }
11790        } else {
11791            vec![]
11792        };
11793
11794        Ok(OperatorFamilyItem::Function {
11795            support_number,
11796            op_types,
11797            function_name,
11798            argument_types,
11799        })
11800    }
11801
11802    /// Parse an operator item for ALTER OPERATOR FAMILY DROP operations
11803    fn parse_operator_family_drop_operator(
11804        &mut self,
11805    ) -> Result<OperatorFamilyDropItem, ParserError> {
11806        let strategy_number = self.parse_literal_uint()?;
11807
11808        // Operator argument types (required for DROP)
11809        self.expect_token(&Token::LParen)?;
11810        let op_types = self.parse_comma_separated(Parser::parse_data_type)?;
11811        self.expect_token(&Token::RParen)?;
11812
11813        Ok(OperatorFamilyDropItem::Operator {
11814            strategy_number,
11815            op_types,
11816        })
11817    }
11818
11819    /// Parse a function item for ALTER OPERATOR FAMILY DROP operations
11820    fn parse_operator_family_drop_function(
11821        &mut self,
11822    ) -> Result<OperatorFamilyDropItem, ParserError> {
11823        let support_number = self.parse_literal_uint()?;
11824
11825        // Operator types (required for DROP)
11826        self.expect_token(&Token::LParen)?;
11827        let op_types = self.parse_comma_separated(Parser::parse_data_type)?;
11828        self.expect_token(&Token::RParen)?;
11829
11830        Ok(OperatorFamilyDropItem::Function {
11831            support_number,
11832            op_types,
11833        })
11834    }
11835
11836    /// Parse an operator family item for ADD operations (dispatches to operator or function parsing)
11837    fn parse_operator_family_add_item(&mut self) -> Result<OperatorFamilyItem, ParserError> {
11838        if self.parse_keyword(Keyword::OPERATOR) {
11839            self.parse_operator_family_add_operator()
11840        } else if self.parse_keyword(Keyword::FUNCTION) {
11841            self.parse_operator_family_add_function()
11842        } else {
11843            self.expected_ref("OPERATOR or FUNCTION", self.peek_token_ref())
11844        }
11845    }
11846
11847    /// Parse an operator family item for DROP operations (dispatches to operator or function parsing)
11848    fn parse_operator_family_drop_item(&mut self) -> Result<OperatorFamilyDropItem, ParserError> {
11849        if self.parse_keyword(Keyword::OPERATOR) {
11850            self.parse_operator_family_drop_operator()
11851        } else if self.parse_keyword(Keyword::FUNCTION) {
11852            self.parse_operator_family_drop_function()
11853        } else {
11854            self.expected_ref("OPERATOR or FUNCTION", self.peek_token_ref())
11855        }
11856    }
11857
11858    /// Parse a [Statement::AlterOperatorFamily]
11859    /// See <https://www.postgresql.org/docs/current/sql-alteropfamily.html>
11860    pub fn parse_alter_operator_family(&mut self) -> Result<AlterOperatorFamily, ParserError> {
11861        let name = self.parse_object_name(false)?;
11862        self.expect_keyword(Keyword::USING)?;
11863        let using = self.parse_identifier()?;
11864
11865        let operation = if self.parse_keyword(Keyword::ADD) {
11866            let items = self.parse_comma_separated(Parser::parse_operator_family_add_item)?;
11867            AlterOperatorFamilyOperation::Add { items }
11868        } else if self.parse_keyword(Keyword::DROP) {
11869            let items = self.parse_comma_separated(Parser::parse_operator_family_drop_item)?;
11870            AlterOperatorFamilyOperation::Drop { items }
11871        } else if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11872            let new_name = self.parse_object_name(false)?;
11873            AlterOperatorFamilyOperation::RenameTo { new_name }
11874        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11875            let owner = self.parse_owner()?;
11876            AlterOperatorFamilyOperation::OwnerTo(owner)
11877        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11878            let schema_name = self.parse_object_name(false)?;
11879            AlterOperatorFamilyOperation::SetSchema { schema_name }
11880        } else {
11881            return self.expected_ref(
11882                "ADD, DROP, RENAME TO, OWNER TO, or SET SCHEMA after ALTER OPERATOR FAMILY",
11883                self.peek_token_ref(),
11884            );
11885        };
11886
11887        Ok(AlterOperatorFamily {
11888            name,
11889            using,
11890            operation,
11891        })
11892    }
11893
11894    /// Parse an `ALTER OPERATOR CLASS` statement.
11895    ///
11896    /// Handles operations like `RENAME TO`, `OWNER TO`, and `SET SCHEMA`.
11897    pub fn parse_alter_operator_class(&mut self) -> Result<AlterOperatorClass, ParserError> {
11898        let name = self.parse_object_name(false)?;
11899        self.expect_keyword(Keyword::USING)?;
11900        let using = self.parse_identifier()?;
11901
11902        let operation = if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11903            let new_name = self.parse_object_name(false)?;
11904            AlterOperatorClassOperation::RenameTo { new_name }
11905        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11906            let owner = self.parse_owner()?;
11907            AlterOperatorClassOperation::OwnerTo(owner)
11908        } else if self.parse_keywords(&[Keyword::SET, Keyword::SCHEMA]) {
11909            let schema_name = self.parse_object_name(false)?;
11910            AlterOperatorClassOperation::SetSchema { schema_name }
11911        } else {
11912            return self.expected_ref(
11913                "RENAME TO, OWNER TO, or SET SCHEMA after ALTER OPERATOR CLASS",
11914                self.peek_token_ref(),
11915            );
11916        };
11917
11918        Ok(AlterOperatorClass {
11919            name,
11920            using,
11921            operation,
11922        })
11923    }
11924
11925    /// Parse an `ALTER SCHEMA` statement.
11926    ///
11927    /// Supports operations such as setting options, renaming, adding/dropping replicas, and changing owner.
11928    pub fn parse_alter_schema(&mut self) -> Result<Statement, ParserError> {
11929        self.expect_keywords(&[Keyword::ALTER, Keyword::SCHEMA])?;
11930        let if_exists = self.parse_keywords(&[Keyword::IF, Keyword::EXISTS]);
11931        let name = self.parse_object_name(false)?;
11932        let operation = if self.parse_keywords(&[Keyword::SET, Keyword::OPTIONS]) {
11933            self.prev_token();
11934            let options = self.parse_options(Keyword::OPTIONS)?;
11935            AlterSchemaOperation::SetOptionsParens { options }
11936        } else if self.parse_keywords(&[Keyword::SET, Keyword::DEFAULT, Keyword::COLLATE]) {
11937            let collate = self.parse_expr()?;
11938            AlterSchemaOperation::SetDefaultCollate { collate }
11939        } else if self.parse_keywords(&[Keyword::ADD, Keyword::REPLICA]) {
11940            let replica = self.parse_identifier()?;
11941            let options = if self.peek_keyword(Keyword::OPTIONS) {
11942                Some(self.parse_options(Keyword::OPTIONS)?)
11943            } else {
11944                None
11945            };
11946            AlterSchemaOperation::AddReplica { replica, options }
11947        } else if self.parse_keywords(&[Keyword::DROP, Keyword::REPLICA]) {
11948            let replica = self.parse_identifier()?;
11949            AlterSchemaOperation::DropReplica { replica }
11950        } else if self.parse_keywords(&[Keyword::RENAME, Keyword::TO]) {
11951            let new_name = self.parse_object_name(false)?;
11952            AlterSchemaOperation::Rename { name: new_name }
11953        } else if self.parse_keywords(&[Keyword::OWNER, Keyword::TO]) {
11954            let owner = self.parse_owner()?;
11955            AlterSchemaOperation::OwnerTo { owner }
11956        } else {
11957            return self.expected_ref("ALTER SCHEMA operation", self.peek_token_ref());
11958        };
11959        Ok(Statement::AlterSchema(AlterSchema {
11960            name,
11961            if_exists,
11962            operations: vec![operation],
11963        }))
11964    }
11965
11966    /// Parse a `CALL procedure_name(arg1, arg2, ...)`
11967    /// or `CALL procedure_name` statement
11968    pub fn parse_call(&mut self) -> Result<Statement, ParserError> {
11969        let object_name = self.parse_object_name(false)?;
11970        if self.peek_token_ref().token == Token::LParen {
11971            match self.parse_function(object_name)? {
11972                Expr::Function(f) => Ok(Statement::Call(f)),
11973                other => parser_err!(
11974                    format!("Expected a simple procedure call but found: {other}"),
11975                    self.peek_token_ref().span.start
11976                ),
11977            }
11978        } else {
11979            Ok(Statement::Call(Function {
11980                name: object_name,
11981                uses_odbc_syntax: false,
11982                parameters: FunctionArguments::None,
11983                args: FunctionArguments::None,
11984                over: None,
11985                filter: None,
11986                null_treatment: None,
11987                within_group: vec![],
11988            }))
11989        }
11990    }
11991
11992    /// Parse a copy statement
11993    pub fn parse_copy(&mut self) -> Result<Statement, ParserError> {
11994        let source;
11995        if self.consume_token(&Token::LParen) {
11996            source = CopySource::Query(self.parse_query()?);
11997            self.expect_token(&Token::RParen)?;
11998        } else {
11999            let table_name = self.parse_object_name(false)?;
12000            let columns = self.parse_parenthesized_column_list(Optional, false)?;
12001            source = CopySource::Table {
12002                table_name,
12003                columns,
12004            };
12005        }
12006        let to = match self.parse_one_of_keywords(&[Keyword::FROM, Keyword::TO]) {
12007            Some(Keyword::FROM) => false,
12008            Some(Keyword::TO) => true,
12009            _ => self.expected_ref("FROM or TO", self.peek_token_ref())?,
12010        };
12011        if !to {
12012            // Use a separate if statement to prevent Rust compiler from complaining about
12013            // "if statement in this position is unstable: https://github.com/rust-lang/rust/issues/53667"
12014            if let CopySource::Query(_) = source {
12015                return Err(ParserError::ParserError(
12016                    "COPY ... FROM does not support query as a source".to_string(),
12017                ));
12018            }
12019        }
12020        let target = if self.parse_keyword(Keyword::STDIN) {
12021            CopyTarget::Stdin
12022        } else if self.parse_keyword(Keyword::STDOUT) {
12023            CopyTarget::Stdout
12024        } else if self.parse_keyword(Keyword::PROGRAM) {
12025            CopyTarget::Program {
12026                command: self.parse_literal_string()?,
12027            }
12028        } else {
12029            CopyTarget::File {
12030                filename: self.parse_literal_string()?,
12031            }
12032        };
12033        let _ = self.parse_keyword(Keyword::WITH); // [ WITH ]
12034        let mut options = vec![];
12035        if self.consume_token(&Token::LParen) {
12036            options = self.parse_comma_separated(Parser::parse_copy_option)?;
12037            self.expect_token(&Token::RParen)?;
12038        }
12039        let mut legacy_options = vec![];
12040        while let Some(opt) = self.maybe_parse(|parser| parser.parse_copy_legacy_option())? {
12041            legacy_options.push(opt);
12042        }
12043        let values =
12044            if matches!(target, CopyTarget::Stdin) && self.peek_token_ref().token != Token::EOF {
12045                self.expect_token(&Token::SemiColon)?;
12046                self.parse_tsv()
12047            } else {
12048                vec![]
12049            };
12050        Ok(Statement::Copy {
12051            source,
12052            to,
12053            target,
12054            options,
12055            legacy_options,
12056            values,
12057        })
12058    }
12059
12060    /// Parse [Statement::Open]
12061    fn parse_open(&mut self) -> Result<Statement, ParserError> {
12062        self.expect_keyword(Keyword::OPEN)?;
12063        Ok(Statement::Open(OpenStatement {
12064            cursor_name: self.parse_identifier()?,
12065        }))
12066    }
12067
12068    /// Parse a `CLOSE` cursor statement.
12069    pub fn parse_close(&mut self) -> Result<Statement, ParserError> {
12070        let cursor = if self.parse_keyword(Keyword::ALL) {
12071            CloseCursor::All
12072        } else {
12073            let name = self.parse_identifier()?;
12074
12075            CloseCursor::Specific { name }
12076        };
12077
12078        Ok(Statement::Close { cursor })
12079    }
12080
12081    fn parse_copy_option(&mut self) -> Result<CopyOption, ParserError> {
12082        let ret = match self.parse_one_of_keywords(&[
12083            Keyword::FORMAT,
12084            Keyword::FREEZE,
12085            Keyword::DELIMITER,
12086            Keyword::NULL,
12087            Keyword::HEADER,
12088            Keyword::QUOTE,
12089            Keyword::ESCAPE,
12090            Keyword::FORCE_QUOTE,
12091            Keyword::FORCE_NOT_NULL,
12092            Keyword::FORCE_NULL,
12093            Keyword::ENCODING,
12094        ]) {
12095            Some(Keyword::FORMAT) => CopyOption::Format(self.parse_identifier()?),
12096            Some(Keyword::FREEZE) => CopyOption::Freeze(!matches!(
12097                self.parse_one_of_keywords(&[Keyword::TRUE, Keyword::FALSE]),
12098                Some(Keyword::FALSE)
12099            )),
12100            Some(Keyword::DELIMITER) => CopyOption::Delimiter(self.parse_literal_char()?),
12101            Some(Keyword::NULL) => CopyOption::Null(self.parse_literal_string()?),
12102            Some(Keyword::HEADER) => CopyOption::Header(!matches!(
12103                self.parse_one_of_keywords(&[Keyword::TRUE, Keyword::FALSE]),
12104                Some(Keyword::FALSE)
12105            )),
12106            Some(Keyword::QUOTE) => CopyOption::Quote(self.parse_literal_char()?),
12107            Some(Keyword::ESCAPE) => CopyOption::Escape(self.parse_literal_char()?),
12108            Some(Keyword::FORCE_QUOTE) => {
12109                CopyOption::ForceQuote(self.parse_parenthesized_column_list(Mandatory, false)?)
12110            }
12111            Some(Keyword::FORCE_NOT_NULL) => {
12112                CopyOption::ForceNotNull(self.parse_parenthesized_column_list(Mandatory, false)?)
12113            }
12114            Some(Keyword::FORCE_NULL) => {
12115                CopyOption::ForceNull(self.parse_parenthesized_column_list(Mandatory, false)?)
12116            }
12117            Some(Keyword::ENCODING) => CopyOption::Encoding(self.parse_literal_string()?),
12118            _ => self.expected_ref("option", self.peek_token_ref())?,
12119        };
12120        Ok(ret)
12121    }
12122
12123    fn parse_copy_legacy_option(&mut self) -> Result<CopyLegacyOption, ParserError> {
12124        // FORMAT \[ AS \] is optional
12125        if self.parse_keyword(Keyword::FORMAT) {
12126            let _ = self.parse_keyword(Keyword::AS);
12127        }
12128
12129        let ret = match self.parse_one_of_keywords(&[
12130            Keyword::ACCEPTANYDATE,
12131            Keyword::ACCEPTINVCHARS,
12132            Keyword::ADDQUOTES,
12133            Keyword::ALLOWOVERWRITE,
12134            Keyword::BINARY,
12135            Keyword::BLANKSASNULL,
12136            Keyword::BZIP2,
12137            Keyword::CLEANPATH,
12138            Keyword::COMPUPDATE,
12139            Keyword::CREDENTIALS,
12140            Keyword::CSV,
12141            Keyword::DATEFORMAT,
12142            Keyword::DELIMITER,
12143            Keyword::EMPTYASNULL,
12144            Keyword::ENCRYPTED,
12145            Keyword::ESCAPE,
12146            Keyword::EXTENSION,
12147            Keyword::FIXEDWIDTH,
12148            Keyword::GZIP,
12149            Keyword::HEADER,
12150            Keyword::IAM_ROLE,
12151            Keyword::IGNOREHEADER,
12152            Keyword::JSON,
12153            Keyword::MANIFEST,
12154            Keyword::MAXFILESIZE,
12155            Keyword::NULL,
12156            Keyword::PARALLEL,
12157            Keyword::PARQUET,
12158            Keyword::PARTITION,
12159            Keyword::REGION,
12160            Keyword::REMOVEQUOTES,
12161            Keyword::ROWGROUPSIZE,
12162            Keyword::STATUPDATE,
12163            Keyword::TIMEFORMAT,
12164            Keyword::TRUNCATECOLUMNS,
12165            Keyword::ZSTD,
12166        ]) {
12167            Some(Keyword::ACCEPTANYDATE) => CopyLegacyOption::AcceptAnyDate,
12168            Some(Keyword::ACCEPTINVCHARS) => {
12169                let _ = self.parse_keyword(Keyword::AS); // [ AS ]
12170                let ch = if matches!(self.peek_token_ref().token, Token::SingleQuotedString(_)) {
12171                    Some(self.parse_literal_string()?)
12172                } else {
12173                    None
12174                };
12175                CopyLegacyOption::AcceptInvChars(ch)
12176            }
12177            Some(Keyword::ADDQUOTES) => CopyLegacyOption::AddQuotes,
12178            Some(Keyword::ALLOWOVERWRITE) => CopyLegacyOption::AllowOverwrite,
12179            Some(Keyword::BINARY) => CopyLegacyOption::Binary,
12180            Some(Keyword::BLANKSASNULL) => CopyLegacyOption::BlankAsNull,
12181            Some(Keyword::BZIP2) => CopyLegacyOption::Bzip2,
12182            Some(Keyword::CLEANPATH) => CopyLegacyOption::CleanPath,
12183            Some(Keyword::COMPUPDATE) => {
12184                let preset = self.parse_keyword(Keyword::PRESET);
12185                let enabled = match self.parse_one_of_keywords(&[
12186                    Keyword::TRUE,
12187                    Keyword::FALSE,
12188                    Keyword::ON,
12189                    Keyword::OFF,
12190                ]) {
12191                    Some(Keyword::TRUE) | Some(Keyword::ON) => Some(true),
12192                    Some(Keyword::FALSE) | Some(Keyword::OFF) => Some(false),
12193                    _ => None,
12194                };
12195                CopyLegacyOption::CompUpdate { preset, enabled }
12196            }
12197            Some(Keyword::CREDENTIALS) => {
12198                CopyLegacyOption::Credentials(self.parse_literal_string()?)
12199            }
12200            Some(Keyword::CSV) => CopyLegacyOption::Csv({
12201                let mut opts = vec![];
12202                while let Some(opt) =
12203                    self.maybe_parse(|parser| parser.parse_copy_legacy_csv_option())?
12204                {
12205                    opts.push(opt);
12206                }
12207                opts
12208            }),
12209            Some(Keyword::DATEFORMAT) => {
12210                let _ = self.parse_keyword(Keyword::AS);
12211                let fmt = if matches!(self.peek_token_ref().token, Token::SingleQuotedString(_)) {
12212                    Some(self.parse_literal_string()?)
12213                } else {
12214                    None
12215                };
12216                CopyLegacyOption::DateFormat(fmt)
12217            }
12218            Some(Keyword::DELIMITER) => {
12219                let _ = self.parse_keyword(Keyword::AS);
12220                CopyLegacyOption::Delimiter(self.parse_literal_char()?)
12221            }
12222            Some(Keyword::EMPTYASNULL) => CopyLegacyOption::EmptyAsNull,
12223            Some(Keyword::ENCRYPTED) => {
12224                let auto = self.parse_keyword(Keyword::AUTO);
12225                CopyLegacyOption::Encrypted { auto }
12226            }
12227            Some(Keyword::ESCAPE) => CopyLegacyOption::Escape,
12228            Some(Keyword::EXTENSION) => {
12229                let ext = self.parse_literal_string()?;
12230                CopyLegacyOption::Extension(ext)
12231            }
12232            Some(Keyword::FIXEDWIDTH) => {
12233                let spec = self.parse_literal_string()?;
12234                CopyLegacyOption::FixedWidth(spec)
12235            }
12236            Some(Keyword::GZIP) => CopyLegacyOption::Gzip,
12237            Some(Keyword::HEADER) => CopyLegacyOption::Header,
12238            Some(Keyword::IAM_ROLE) => CopyLegacyOption::IamRole(self.parse_iam_role_kind()?),
12239            Some(Keyword::IGNOREHEADER) => {
12240                let _ = self.parse_keyword(Keyword::AS);
12241                let num_rows = self.parse_literal_uint()?;
12242                CopyLegacyOption::IgnoreHeader(num_rows)
12243            }
12244            Some(Keyword::JSON) => {
12245                let _ = self.parse_keyword(Keyword::AS);
12246                let fmt = if matches!(self.peek_token_ref().token, Token::SingleQuotedString(_)) {
12247                    Some(self.parse_literal_string()?)
12248                } else {
12249                    None
12250                };
12251                CopyLegacyOption::Json(fmt)
12252            }
12253            Some(Keyword::MANIFEST) => {
12254                let verbose = self.parse_keyword(Keyword::VERBOSE);
12255                CopyLegacyOption::Manifest { verbose }
12256            }
12257            Some(Keyword::MAXFILESIZE) => {
12258                let _ = self.parse_keyword(Keyword::AS);
12259                let size = self.parse_number_value()?;
12260                let unit = match self.parse_one_of_keywords(&[Keyword::MB, Keyword::GB]) {
12261                    Some(Keyword::MB) => Some(FileSizeUnit::MB),
12262                    Some(Keyword::GB) => Some(FileSizeUnit::GB),
12263                    _ => None,
12264                };
12265                CopyLegacyOption::MaxFileSize(FileSize { size, unit })
12266            }
12267            Some(Keyword::NULL) => {
12268                let _ = self.parse_keyword(Keyword::AS);
12269                CopyLegacyOption::Null(self.parse_literal_string()?)
12270            }
12271            Some(Keyword::PARALLEL) => {
12272                let enabled = match self.parse_one_of_keywords(&[
12273                    Keyword::TRUE,
12274                    Keyword::FALSE,
12275                    Keyword::ON,
12276                    Keyword::OFF,
12277                ]) {
12278                    Some(Keyword::TRUE) | Some(Keyword::ON) => Some(true),
12279                    Some(Keyword::FALSE) | Some(Keyword::OFF) => Some(false),
12280                    _ => None,
12281                };
12282                CopyLegacyOption::Parallel(enabled)
12283            }
12284            Some(Keyword::PARQUET) => CopyLegacyOption::Parquet,
12285            Some(Keyword::PARTITION) => {
12286                self.expect_keyword(Keyword::BY)?;
12287                let columns = self.parse_parenthesized_column_list(IsOptional::Mandatory, false)?;
12288                let include = self.parse_keyword(Keyword::INCLUDE);
12289                CopyLegacyOption::PartitionBy(UnloadPartitionBy { columns, include })
12290            }
12291            Some(Keyword::REGION) => {
12292                let _ = self.parse_keyword(Keyword::AS);
12293                let region = self.parse_literal_string()?;
12294                CopyLegacyOption::Region(region)
12295            }
12296            Some(Keyword::REMOVEQUOTES) => CopyLegacyOption::RemoveQuotes,
12297            Some(Keyword::ROWGROUPSIZE) => {
12298                let _ = self.parse_keyword(Keyword::AS);
12299                let file_size = self.parse_file_size()?;
12300                CopyLegacyOption::RowGroupSize(file_size)
12301            }
12302            Some(Keyword::STATUPDATE) => {
12303                let enabled = match self.parse_one_of_keywords(&[
12304                    Keyword::TRUE,
12305                    Keyword::FALSE,
12306                    Keyword::ON,
12307                    Keyword::OFF,
12308                ]) {
12309                    Some(Keyword::TRUE) | Some(Keyword::ON) => Some(true),
12310                    Some(Keyword::FALSE) | Some(Keyword::OFF) => Some(false),
12311                    _ => None,
12312                };
12313                CopyLegacyOption::StatUpdate(enabled)
12314            }
12315            Some(Keyword::TIMEFORMAT) => {
12316                let _ = self.parse_keyword(Keyword::AS);
12317                let fmt = if matches!(self.peek_token_ref().token, Token::SingleQuotedString(_)) {
12318                    Some(self.parse_literal_string()?)
12319                } else {
12320                    None
12321                };
12322                CopyLegacyOption::TimeFormat(fmt)
12323            }
12324            Some(Keyword::TRUNCATECOLUMNS) => CopyLegacyOption::TruncateColumns,
12325            Some(Keyword::ZSTD) => CopyLegacyOption::Zstd,
12326            _ => self.expected_ref("option", self.peek_token_ref())?,
12327        };
12328        Ok(ret)
12329    }
12330
12331    fn parse_file_size(&mut self) -> Result<FileSize, ParserError> {
12332        let size = self.parse_number_value()?;
12333        let unit = self.maybe_parse_file_size_unit();
12334        Ok(FileSize { size, unit })
12335    }
12336
12337    fn maybe_parse_file_size_unit(&mut self) -> Option<FileSizeUnit> {
12338        match self.parse_one_of_keywords(&[Keyword::MB, Keyword::GB]) {
12339            Some(Keyword::MB) => Some(FileSizeUnit::MB),
12340            Some(Keyword::GB) => Some(FileSizeUnit::GB),
12341            _ => None,
12342        }
12343    }
12344
12345    fn parse_iam_role_kind(&mut self) -> Result<IamRoleKind, ParserError> {
12346        if self.parse_keyword(Keyword::DEFAULT) {
12347            Ok(IamRoleKind::Default)
12348        } else {
12349            let arn = self.parse_literal_string()?;
12350            Ok(IamRoleKind::Arn(arn))
12351        }
12352    }
12353
12354    fn parse_copy_legacy_csv_option(&mut self) -> Result<CopyLegacyCsvOption, ParserError> {
12355        let ret = match self.parse_one_of_keywords(&[
12356            Keyword::HEADER,
12357            Keyword::QUOTE,
12358            Keyword::ESCAPE,
12359            Keyword::FORCE,
12360        ]) {
12361            Some(Keyword::HEADER) => CopyLegacyCsvOption::Header,
12362            Some(Keyword::QUOTE) => {
12363                let _ = self.parse_keyword(Keyword::AS); // [ AS ]
12364                CopyLegacyCsvOption::Quote(self.parse_literal_char()?)
12365            }
12366            Some(Keyword::ESCAPE) => {
12367                let _ = self.parse_keyword(Keyword::AS); // [ AS ]
12368                CopyLegacyCsvOption::Escape(self.parse_literal_char()?)
12369            }
12370            Some(Keyword::FORCE) if self.parse_keywords(&[Keyword::NOT, Keyword::NULL]) => {
12371                CopyLegacyCsvOption::ForceNotNull(
12372                    self.parse_comma_separated(|p| p.parse_identifier())?,
12373                )
12374            }
12375            Some(Keyword::FORCE) if self.parse_keywords(&[Keyword::QUOTE]) => {
12376                CopyLegacyCsvOption::ForceQuote(
12377                    self.parse_comma_separated(|p| p.parse_identifier())?,
12378                )
12379            }
12380            _ => self.expected_ref("csv option", self.peek_token_ref())?,
12381        };
12382        Ok(ret)
12383    }
12384
12385    fn parse_literal_char(&mut self) -> Result<char, ParserError> {
12386        let s = self.parse_literal_string()?;
12387        if s.len() != 1 {
12388            let loc = self
12389                .tokens
12390                .get(self.index - 1)
12391                .map_or(Location { line: 0, column: 0 }, |t| t.span.start);
12392            return parser_err!(format!("Expect a char, found {s:?}"), loc);
12393        }
12394        Ok(s.chars().next().unwrap())
12395    }
12396
12397    /// Parse a tab separated values in
12398    /// COPY payload
12399    pub fn parse_tsv(&mut self) -> Vec<Option<String>> {
12400        self.parse_tab_value()
12401    }
12402
12403    /// Parse a single tab-separated value row used by `COPY` payload parsing.
12404    pub fn parse_tab_value(&mut self) -> Vec<Option<String>> {
12405        let mut values = vec![];
12406        let mut content = String::new();
12407        while let Some(t) = self.next_token_no_skip().map(|t| &t.token) {
12408            match t {
12409                Token::Whitespace(Whitespace::Tab) => {
12410                    values.push(Some(core::mem::take(&mut content)));
12411                }
12412                Token::Whitespace(Whitespace::Newline) => {
12413                    values.push(Some(core::mem::take(&mut content)));
12414                }
12415                Token::Backslash => {
12416                    if self.consume_token(&Token::Period) {
12417                        return values;
12418                    }
12419                    if let Token::Word(w) = self.next_token().token {
12420                        if w.value == "N" {
12421                            values.push(None);
12422                        }
12423                    }
12424                }
12425                _ => {
12426                    content.push_str(&t.to_string());
12427                }
12428            }
12429        }
12430        values
12431    }
12432
12433    /// Parse a literal value (numbers, strings, date/time, booleans)
12434    pub fn parse_value(&mut self) -> Result<ValueWithSpan, ParserError> {
12435        let next_token = self.next_token();
12436        let span = next_token.span;
12437        let ok_value = |value: Value| Ok(value.with_span(span));
12438        match next_token.token {
12439            Token::Word(w) => match w.keyword {
12440                Keyword::TRUE if self.dialect.supports_boolean_literals() => {
12441                    ok_value(Value::Boolean(true))
12442                }
12443                Keyword::FALSE if self.dialect.supports_boolean_literals() => {
12444                    ok_value(Value::Boolean(false))
12445                }
12446                Keyword::NULL => ok_value(Value::Null),
12447                Keyword::NoKeyword if w.quote_style.is_some() => match w.quote_style {
12448                    Some('"') => ok_value(Value::DoubleQuotedString(w.value)),
12449                    Some('\'') => ok_value(Value::SingleQuotedString(w.value)),
12450                    _ => self.expected(
12451                        "A value?",
12452                        TokenWithSpan {
12453                            token: Token::Word(w),
12454                            span,
12455                        },
12456                    )?,
12457                },
12458                _ => self.expected(
12459                    "a concrete value",
12460                    TokenWithSpan {
12461                        token: Token::Word(w),
12462                        span,
12463                    },
12464                ),
12465            },
12466            // The call to n.parse() returns a bigdecimal when the
12467            // bigdecimal feature is enabled, and is otherwise a no-op
12468            // (i.e., it returns the input string).
12469            Token::Number(n, l) => ok_value(Value::Number(Self::parse(n, span.start)?, l)),
12470            Token::SingleQuotedString(ref s) => ok_value(Value::SingleQuotedString(
12471                self.maybe_concat_string_literal(s.to_string()),
12472            )),
12473            Token::DoubleQuotedString(ref s) => ok_value(Value::DoubleQuotedString(
12474                self.maybe_concat_string_literal(s.to_string()),
12475            )),
12476            Token::TripleSingleQuotedString(ref s) => {
12477                ok_value(Value::TripleSingleQuotedString(s.to_string()))
12478            }
12479            Token::TripleDoubleQuotedString(ref s) => {
12480                ok_value(Value::TripleDoubleQuotedString(s.to_string()))
12481            }
12482            Token::DollarQuotedString(ref s) => ok_value(Value::DollarQuotedString(s.clone())),
12483            Token::SingleQuotedByteStringLiteral(ref s) => {
12484                ok_value(Value::SingleQuotedByteStringLiteral(s.clone()))
12485            }
12486            Token::DoubleQuotedByteStringLiteral(ref s) => {
12487                ok_value(Value::DoubleQuotedByteStringLiteral(s.clone()))
12488            }
12489            Token::TripleSingleQuotedByteStringLiteral(ref s) => {
12490                ok_value(Value::TripleSingleQuotedByteStringLiteral(s.clone()))
12491            }
12492            Token::TripleDoubleQuotedByteStringLiteral(ref s) => {
12493                ok_value(Value::TripleDoubleQuotedByteStringLiteral(s.clone()))
12494            }
12495            Token::SingleQuotedRawStringLiteral(ref s) => {
12496                ok_value(Value::SingleQuotedRawStringLiteral(s.clone()))
12497            }
12498            Token::DoubleQuotedRawStringLiteral(ref s) => {
12499                ok_value(Value::DoubleQuotedRawStringLiteral(s.clone()))
12500            }
12501            Token::TripleSingleQuotedRawStringLiteral(ref s) => {
12502                ok_value(Value::TripleSingleQuotedRawStringLiteral(s.clone()))
12503            }
12504            Token::TripleDoubleQuotedRawStringLiteral(ref s) => {
12505                ok_value(Value::TripleDoubleQuotedRawStringLiteral(s.clone()))
12506            }
12507            Token::NationalStringLiteral(ref s) => {
12508                ok_value(Value::NationalStringLiteral(s.to_string()))
12509            }
12510            Token::QuoteDelimitedStringLiteral(v) => {
12511                ok_value(Value::QuoteDelimitedStringLiteral(v))
12512            }
12513            Token::NationalQuoteDelimitedStringLiteral(v) => {
12514                ok_value(Value::NationalQuoteDelimitedStringLiteral(v))
12515            }
12516            Token::EscapedStringLiteral(ref s) => {
12517                ok_value(Value::EscapedStringLiteral(s.to_string()))
12518            }
12519            Token::UnicodeStringLiteral(ref s) => {
12520                ok_value(Value::UnicodeStringLiteral(s.to_string()))
12521            }
12522            Token::HexStringLiteral(ref s) => ok_value(Value::HexStringLiteral(s.to_string())),
12523            Token::Placeholder(ref s) => ok_value(Value::Placeholder(s.to_string())),
12524            tok @ Token::Colon | tok @ Token::AtSign => {
12525                // 1. Not calling self.parse_identifier(false)?
12526                //    because only in placeholder we want to check
12527                //    numbers as idfentifies.  This because snowflake
12528                //    allows numbers as placeholders
12529                // 2. Not calling self.next_token() to enforce `tok`
12530                //    be followed immediately by a word/number, ie.
12531                //    without any whitespace in between
12532                let next_token = self.next_token_no_skip().unwrap_or(&EOF_TOKEN).clone();
12533                let ident = match next_token.token {
12534                    Token::Word(w) => Ok(w.into_ident(next_token.span)),
12535                    Token::Number(w, false) => Ok(Ident::with_span(next_token.span, w)),
12536                    _ => self.expected("placeholder", next_token),
12537                }?;
12538                Ok(Value::Placeholder(format!("{tok}{}", ident.value))
12539                    .with_span(Span::new(span.start, ident.span.end)))
12540            }
12541            unexpected => self.expected(
12542                "a value",
12543                TokenWithSpan {
12544                    token: unexpected,
12545                    span,
12546                },
12547            ),
12548        }
12549    }
12550
12551    fn maybe_concat_string_literal(&mut self, mut str: String) -> String {
12552        if self.dialect.supports_string_literal_concatenation() {
12553            while let Token::SingleQuotedString(ref s) | Token::DoubleQuotedString(ref s) =
12554                self.peek_token_ref().token
12555            {
12556                str.push_str(s);
12557                self.advance_token();
12558            }
12559        } else if self
12560            .dialect
12561            .supports_string_literal_concatenation_with_newline()
12562        {
12563            // We are iterating over tokens including whitespaces, to identify
12564            // string literals separated by newlines so we can concatenate them.
12565            let mut after_newline = false;
12566            loop {
12567                match self.peek_token_no_skip().token {
12568                    Token::Whitespace(Whitespace::Newline) => {
12569                        after_newline = true;
12570                        self.next_token_no_skip();
12571                    }
12572                    Token::Whitespace(_) => {
12573                        self.next_token_no_skip();
12574                    }
12575                    Token::SingleQuotedString(ref s) | Token::DoubleQuotedString(ref s)
12576                        if after_newline =>
12577                    {
12578                        str.push_str(s.clone().as_str());
12579                        self.next_token_no_skip();
12580                        after_newline = false;
12581                    }
12582                    _ => break,
12583                }
12584            }
12585        }
12586
12587        str
12588    }
12589
12590    /// Parse an unsigned numeric literal
12591    pub fn parse_number_value(&mut self) -> Result<ValueWithSpan, ParserError> {
12592        let value_wrapper = self.parse_value()?;
12593        match &value_wrapper.value {
12594            Value::Number(_, _) => Ok(value_wrapper),
12595            Value::Placeholder(_) => Ok(value_wrapper),
12596            _ => {
12597                self.prev_token();
12598                self.expected_ref("literal number", self.peek_token_ref())
12599            }
12600        }
12601    }
12602
12603    /// Parse a numeric literal as an expression. Returns a [`Expr::UnaryOp`] if the number is signed,
12604    /// otherwise returns a [`Expr::Value`]
12605    pub fn parse_number(&mut self) -> Result<Expr, ParserError> {
12606        let next_token = self.next_token();
12607        match next_token.token {
12608            Token::Plus => Ok(Expr::UnaryOp {
12609                op: UnaryOperator::Plus,
12610                expr: Box::new(Expr::Value(self.parse_number_value()?)),
12611            }),
12612            Token::Minus => Ok(Expr::UnaryOp {
12613                op: UnaryOperator::Minus,
12614                expr: Box::new(Expr::Value(self.parse_number_value()?)),
12615            }),
12616            _ => {
12617                self.prev_token();
12618                Ok(Expr::Value(self.parse_number_value()?))
12619            }
12620        }
12621    }
12622
12623    fn parse_introduced_string_expr(&mut self) -> Result<Expr, ParserError> {
12624        let next_token = self.next_token();
12625        let span = next_token.span;
12626        match next_token.token {
12627            Token::SingleQuotedString(ref s) => Ok(Expr::Value(
12628                Value::SingleQuotedString(s.to_string()).with_span(span),
12629            )),
12630            Token::DoubleQuotedString(ref s) => Ok(Expr::Value(
12631                Value::DoubleQuotedString(s.to_string()).with_span(span),
12632            )),
12633            Token::HexStringLiteral(ref s) => Ok(Expr::Value(
12634                Value::HexStringLiteral(s.to_string()).with_span(span),
12635            )),
12636            unexpected => self.expected(
12637                "a string value",
12638                TokenWithSpan {
12639                    token: unexpected,
12640                    span,
12641                },
12642            ),
12643        }
12644    }
12645
12646    /// Parse an unsigned literal integer/long
12647    pub fn parse_literal_uint(&mut self) -> Result<u64, ParserError> {
12648        let next_token = self.next_token();
12649        match next_token.token {
12650            Token::Number(s, _) => Self::parse::<u64>(s, next_token.span.start),
12651            _ => self.expected("literal int", next_token),
12652        }
12653    }
12654
12655    /// Parse the body of a `CREATE FUNCTION` specified as a string.
12656    /// e.g. `CREATE FUNCTION ... AS $$ body $$`.
12657    fn parse_create_function_body_string(&mut self) -> Result<CreateFunctionBody, ParserError> {
12658        let parse_string_expr = |parser: &mut Parser| -> Result<Expr, ParserError> {
12659            let peek_token = parser.peek_token();
12660            let span = peek_token.span;
12661            match peek_token.token {
12662                Token::DollarQuotedString(s) if dialect_of!(parser is PostgreSqlDialect | GenericDialect) =>
12663                {
12664                    parser.next_token();
12665                    Ok(Expr::Value(Value::DollarQuotedString(s).with_span(span)))
12666                }
12667                _ => Ok(Expr::Value(
12668                    Value::SingleQuotedString(parser.parse_literal_string()?).with_span(span),
12669                )),
12670            }
12671        };
12672
12673        Ok(CreateFunctionBody::AsBeforeOptions {
12674            body: parse_string_expr(self)?,
12675            link_symbol: if self.consume_token(&Token::Comma) {
12676                Some(parse_string_expr(self)?)
12677            } else {
12678                None
12679            },
12680        })
12681    }
12682
12683    /// Parse a literal string
12684    pub fn parse_literal_string(&mut self) -> Result<String, ParserError> {
12685        let next_token = self.next_token();
12686        match next_token.token {
12687            Token::Word(Word {
12688                value,
12689                keyword: Keyword::NoKeyword,
12690                ..
12691            }) => Ok(value),
12692            Token::SingleQuotedString(s) => Ok(s),
12693            Token::DoubleQuotedString(s) => Ok(s),
12694            Token::EscapedStringLiteral(s) if dialect_of!(self is PostgreSqlDialect | GenericDialect) => {
12695                Ok(s)
12696            }
12697            Token::UnicodeStringLiteral(s) => Ok(s),
12698            _ => self.expected("literal string", next_token),
12699        }
12700    }
12701
12702    /// Parse a boolean string
12703    pub(crate) fn parse_boolean_string(&mut self) -> Result<bool, ParserError> {
12704        match self.parse_one_of_keywords(&[Keyword::TRUE, Keyword::FALSE]) {
12705            Some(Keyword::TRUE) => Ok(true),
12706            Some(Keyword::FALSE) => Ok(false),
12707            _ => self.expected_ref("TRUE or FALSE", self.peek_token_ref()),
12708        }
12709    }
12710
12711    /// Parse a literal unicode normalization clause
12712    pub fn parse_unicode_is_normalized(&mut self, expr: Expr) -> Result<Expr, ParserError> {
12713        let neg = self.parse_keyword(Keyword::NOT);
12714        let normalized_form = self.maybe_parse(|parser| {
12715            match parser.parse_one_of_keywords(&[
12716                Keyword::NFC,
12717                Keyword::NFD,
12718                Keyword::NFKC,
12719                Keyword::NFKD,
12720            ]) {
12721                Some(Keyword::NFC) => Ok(NormalizationForm::NFC),
12722                Some(Keyword::NFD) => Ok(NormalizationForm::NFD),
12723                Some(Keyword::NFKC) => Ok(NormalizationForm::NFKC),
12724                Some(Keyword::NFKD) => Ok(NormalizationForm::NFKD),
12725                _ => parser.expected_ref("unicode normalization form", parser.peek_token_ref()),
12726            }
12727        })?;
12728        if self.parse_keyword(Keyword::NORMALIZED) {
12729            return Ok(Expr::IsNormalized {
12730                expr: Box::new(expr),
12731                form: normalized_form,
12732                negated: neg,
12733            });
12734        }
12735        self.expected_ref("unicode normalization form", self.peek_token_ref())
12736    }
12737
12738    /// Parse parenthesized enum members, used with `ENUM(...)` type definitions.
12739    pub fn parse_enum_values(&mut self) -> Result<Vec<EnumMember>, ParserError> {
12740        self.expect_token(&Token::LParen)?;
12741        let values = self.parse_comma_separated(|parser| {
12742            let name = parser.parse_literal_string()?;
12743            let e = if parser.consume_token(&Token::Eq) {
12744                let value = parser.parse_number()?;
12745                EnumMember::NamedValue(name, value)
12746            } else {
12747                EnumMember::Name(name)
12748            };
12749            Ok(e)
12750        })?;
12751        self.expect_token(&Token::RParen)?;
12752
12753        Ok(values)
12754    }
12755
12756    /// Parse a SQL datatype (in the context of a CREATE TABLE statement for example)
12757    pub fn parse_data_type(&mut self) -> Result<DataType, ParserError> {
12758        let (ty, trailing_bracket) = self.parse_data_type_helper()?;
12759        if trailing_bracket.0 {
12760            return parser_err!(
12761                format!("unmatched > after parsing data type {ty}"),
12762                self.peek_token_ref()
12763            );
12764        }
12765
12766        Ok(ty)
12767    }
12768
12769    fn parse_data_type_helper(
12770        &mut self,
12771    ) -> Result<(DataType, MatchedTrailingBracket), ParserError> {
12772        let dialect = self.dialect;
12773        self.advance_token();
12774        let next_token = self.get_current_token();
12775        let next_token_index = self.get_current_index();
12776
12777        let mut trailing_bracket: MatchedTrailingBracket = false.into();
12778        let mut data = match &next_token.token {
12779            Token::Word(w) => match w.keyword {
12780                Keyword::BOOLEAN => Ok(DataType::Boolean),
12781                Keyword::BOOL => Ok(DataType::Bool),
12782                Keyword::FLOAT => {
12783                    let precision = self.parse_exact_number_optional_precision_scale()?;
12784
12785                    if self.parse_keyword(Keyword::UNSIGNED) {
12786                        Ok(DataType::FloatUnsigned(precision))
12787                    } else {
12788                        Ok(DataType::Float(precision))
12789                    }
12790                }
12791                Keyword::REAL => {
12792                    if self.parse_keyword(Keyword::UNSIGNED) {
12793                        Ok(DataType::RealUnsigned)
12794                    } else {
12795                        Ok(DataType::Real)
12796                    }
12797                }
12798                Keyword::FLOAT4 => Ok(DataType::Float4),
12799                Keyword::FLOAT32 => Ok(DataType::Float32),
12800                Keyword::FLOAT64 => Ok(DataType::Float64),
12801                Keyword::FLOAT8 => Ok(DataType::Float8),
12802                Keyword::DOUBLE => {
12803                    if self.parse_keyword(Keyword::PRECISION) {
12804                        if self.parse_keyword(Keyword::UNSIGNED) {
12805                            Ok(DataType::DoublePrecisionUnsigned)
12806                        } else {
12807                            Ok(DataType::DoublePrecision)
12808                        }
12809                    } else {
12810                        let precision = self.parse_exact_number_optional_precision_scale()?;
12811
12812                        if self.parse_keyword(Keyword::UNSIGNED) {
12813                            Ok(DataType::DoubleUnsigned(precision))
12814                        } else {
12815                            Ok(DataType::Double(precision))
12816                        }
12817                    }
12818                }
12819                Keyword::TINYINT => {
12820                    let optional_precision = self.parse_optional_precision();
12821                    if self.parse_keyword(Keyword::UNSIGNED) {
12822                        Ok(DataType::TinyIntUnsigned(optional_precision?))
12823                    } else {
12824                        if dialect.supports_data_type_signed_suffix() {
12825                            let _ = self.parse_keyword(Keyword::SIGNED);
12826                        }
12827                        Ok(DataType::TinyInt(optional_precision?))
12828                    }
12829                }
12830                Keyword::INT2 => {
12831                    let optional_precision = self.parse_optional_precision();
12832                    if self.parse_keyword(Keyword::UNSIGNED) {
12833                        Ok(DataType::Int2Unsigned(optional_precision?))
12834                    } else {
12835                        Ok(DataType::Int2(optional_precision?))
12836                    }
12837                }
12838                Keyword::SMALLINT => {
12839                    let optional_precision = self.parse_optional_precision();
12840                    if self.parse_keyword(Keyword::UNSIGNED) {
12841                        Ok(DataType::SmallIntUnsigned(optional_precision?))
12842                    } else {
12843                        if dialect.supports_data_type_signed_suffix() {
12844                            let _ = self.parse_keyword(Keyword::SIGNED);
12845                        }
12846                        Ok(DataType::SmallInt(optional_precision?))
12847                    }
12848                }
12849                Keyword::MEDIUMINT => {
12850                    let optional_precision = self.parse_optional_precision();
12851                    if self.parse_keyword(Keyword::UNSIGNED) {
12852                        Ok(DataType::MediumIntUnsigned(optional_precision?))
12853                    } else {
12854                        if dialect.supports_data_type_signed_suffix() {
12855                            let _ = self.parse_keyword(Keyword::SIGNED);
12856                        }
12857                        Ok(DataType::MediumInt(optional_precision?))
12858                    }
12859                }
12860                Keyword::INT => {
12861                    let optional_precision = self.parse_optional_precision();
12862                    if self.parse_keyword(Keyword::UNSIGNED) {
12863                        Ok(DataType::IntUnsigned(optional_precision?))
12864                    } else {
12865                        if dialect.supports_data_type_signed_suffix() {
12866                            let _ = self.parse_keyword(Keyword::SIGNED);
12867                        }
12868                        Ok(DataType::Int(optional_precision?))
12869                    }
12870                }
12871                Keyword::INT4 => {
12872                    let optional_precision = self.parse_optional_precision();
12873                    if self.parse_keyword(Keyword::UNSIGNED) {
12874                        Ok(DataType::Int4Unsigned(optional_precision?))
12875                    } else {
12876                        Ok(DataType::Int4(optional_precision?))
12877                    }
12878                }
12879                Keyword::INT8 => {
12880                    let optional_precision = self.parse_optional_precision();
12881                    if self.parse_keyword(Keyword::UNSIGNED) {
12882                        Ok(DataType::Int8Unsigned(optional_precision?))
12883                    } else {
12884                        Ok(DataType::Int8(optional_precision?))
12885                    }
12886                }
12887                Keyword::INT16 => Ok(DataType::Int16),
12888                Keyword::INT32 => Ok(DataType::Int32),
12889                Keyword::INT64 => Ok(DataType::Int64),
12890                Keyword::INT128 => Ok(DataType::Int128),
12891                Keyword::INT256 => Ok(DataType::Int256),
12892                Keyword::INTEGER => {
12893                    let optional_precision = self.parse_optional_precision();
12894                    if self.parse_keyword(Keyword::UNSIGNED) {
12895                        Ok(DataType::IntegerUnsigned(optional_precision?))
12896                    } else {
12897                        if dialect.supports_data_type_signed_suffix() {
12898                            let _ = self.parse_keyword(Keyword::SIGNED);
12899                        }
12900                        Ok(DataType::Integer(optional_precision?))
12901                    }
12902                }
12903                Keyword::BIGINT => {
12904                    let optional_precision = self.parse_optional_precision();
12905                    if self.parse_keyword(Keyword::UNSIGNED) {
12906                        Ok(DataType::BigIntUnsigned(optional_precision?))
12907                    } else {
12908                        if dialect.supports_data_type_signed_suffix() {
12909                            let _ = self.parse_keyword(Keyword::SIGNED);
12910                        }
12911                        Ok(DataType::BigInt(optional_precision?))
12912                    }
12913                }
12914                Keyword::HUGEINT => Ok(DataType::HugeInt),
12915                Keyword::UBIGINT => Ok(DataType::UBigInt),
12916                Keyword::UHUGEINT => Ok(DataType::UHugeInt),
12917                Keyword::USMALLINT => Ok(DataType::USmallInt),
12918                Keyword::UTINYINT => Ok(DataType::UTinyInt),
12919                Keyword::UINT8 => Ok(DataType::UInt8),
12920                Keyword::UINT16 => Ok(DataType::UInt16),
12921                Keyword::UINT32 => Ok(DataType::UInt32),
12922                Keyword::UINT64 => Ok(DataType::UInt64),
12923                Keyword::UINT128 => Ok(DataType::UInt128),
12924                Keyword::UINT256 => Ok(DataType::UInt256),
12925                Keyword::VARCHAR => Ok(DataType::Varchar(self.parse_optional_character_length()?)),
12926                Keyword::NVARCHAR => {
12927                    Ok(DataType::Nvarchar(self.parse_optional_character_length()?))
12928                }
12929                Keyword::CHARACTER => {
12930                    if self.parse_keyword(Keyword::VARYING) {
12931                        Ok(DataType::CharacterVarying(
12932                            self.parse_optional_character_length()?,
12933                        ))
12934                    } else if self.parse_keywords(&[Keyword::LARGE, Keyword::OBJECT]) {
12935                        Ok(DataType::CharacterLargeObject(
12936                            self.parse_optional_precision()?,
12937                        ))
12938                    } else {
12939                        Ok(DataType::Character(self.parse_optional_character_length()?))
12940                    }
12941                }
12942                Keyword::CHAR => {
12943                    if self.parse_keyword(Keyword::VARYING) {
12944                        Ok(DataType::CharVarying(
12945                            self.parse_optional_character_length()?,
12946                        ))
12947                    } else if self.parse_keywords(&[Keyword::LARGE, Keyword::OBJECT]) {
12948                        Ok(DataType::CharLargeObject(self.parse_optional_precision()?))
12949                    } else {
12950                        Ok(DataType::Char(self.parse_optional_character_length()?))
12951                    }
12952                }
12953                Keyword::CLOB => Ok(DataType::Clob(self.parse_optional_precision()?)),
12954                Keyword::BINARY => Ok(DataType::Binary(self.parse_optional_precision()?)),
12955                Keyword::VARBINARY => Ok(DataType::Varbinary(self.parse_optional_binary_length()?)),
12956                Keyword::BLOB => Ok(DataType::Blob(self.parse_optional_precision()?)),
12957                Keyword::TINYBLOB => Ok(DataType::TinyBlob),
12958                Keyword::MEDIUMBLOB => Ok(DataType::MediumBlob),
12959                Keyword::LONGBLOB => Ok(DataType::LongBlob),
12960                Keyword::BYTES => Ok(DataType::Bytes(self.parse_optional_precision()?)),
12961                Keyword::BIT => {
12962                    if self.parse_keyword(Keyword::VARYING) {
12963                        Ok(DataType::BitVarying(self.parse_optional_precision()?))
12964                    } else {
12965                        Ok(DataType::Bit(self.parse_optional_precision()?))
12966                    }
12967                }
12968                Keyword::VARBIT => Ok(DataType::VarBit(self.parse_optional_precision()?)),
12969                Keyword::UUID => Ok(DataType::Uuid),
12970                Keyword::DATE => Ok(DataType::Date),
12971                Keyword::DATE32 => Ok(DataType::Date32),
12972                Keyword::DATETIME => Ok(DataType::Datetime(self.parse_optional_precision()?)),
12973                Keyword::DATETIME64 => {
12974                    self.prev_token();
12975                    let (precision, time_zone) = self.parse_datetime_64()?;
12976                    Ok(DataType::Datetime64(precision, time_zone))
12977                }
12978                Keyword::TIMESTAMP => {
12979                    let precision = self.parse_optional_precision()?;
12980                    let tz = if self.parse_keyword(Keyword::WITH) {
12981                        self.expect_keywords(&[Keyword::TIME, Keyword::ZONE])?;
12982                        TimezoneInfo::WithTimeZone
12983                    } else if self.parse_keyword(Keyword::WITHOUT) {
12984                        self.expect_keywords(&[Keyword::TIME, Keyword::ZONE])?;
12985                        TimezoneInfo::WithoutTimeZone
12986                    } else {
12987                        TimezoneInfo::None
12988                    };
12989                    Ok(DataType::Timestamp(precision, tz))
12990                }
12991                Keyword::TIMESTAMPTZ => Ok(DataType::Timestamp(
12992                    self.parse_optional_precision()?,
12993                    TimezoneInfo::Tz,
12994                )),
12995                Keyword::TIMESTAMP_NTZ => {
12996                    Ok(DataType::TimestampNtz(self.parse_optional_precision()?))
12997                }
12998                Keyword::TIME => {
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::Time(precision, tz))
13010                }
13011                Keyword::TIMETZ => Ok(DataType::Time(
13012                    self.parse_optional_precision()?,
13013                    TimezoneInfo::Tz,
13014                )),
13015                Keyword::INTERVAL => {
13016                    if self.dialect.supports_interval_options() {
13017                        let fields = self.maybe_parse_optional_interval_fields()?;
13018                        let precision = self.parse_optional_precision()?;
13019                        Ok(DataType::Interval { fields, precision })
13020                    } else {
13021                        Ok(DataType::Interval {
13022                            fields: None,
13023                            precision: None,
13024                        })
13025                    }
13026                }
13027                Keyword::JSON => Ok(DataType::JSON),
13028                Keyword::JSONB => Ok(DataType::JSONB),
13029                Keyword::REGCLASS => Ok(DataType::Regclass),
13030                Keyword::STRING => Ok(DataType::String(self.parse_optional_precision()?)),
13031                Keyword::FIXEDSTRING => {
13032                    self.expect_token(&Token::LParen)?;
13033                    let character_length = self.parse_literal_uint()?;
13034                    self.expect_token(&Token::RParen)?;
13035                    Ok(DataType::FixedString(character_length))
13036                }
13037                Keyword::TEXT => Ok(DataType::Text),
13038                Keyword::TINYTEXT => Ok(DataType::TinyText),
13039                Keyword::MEDIUMTEXT => Ok(DataType::MediumText),
13040                Keyword::LONGTEXT => Ok(DataType::LongText),
13041                Keyword::BYTEA => Ok(DataType::Bytea),
13042                Keyword::NUMERIC => Ok(DataType::Numeric(
13043                    self.parse_exact_number_optional_precision_scale()?,
13044                )),
13045                Keyword::DECIMAL => {
13046                    let precision = self.parse_exact_number_optional_precision_scale()?;
13047
13048                    if self.parse_keyword(Keyword::UNSIGNED) {
13049                        Ok(DataType::DecimalUnsigned(precision))
13050                    } else {
13051                        Ok(DataType::Decimal(precision))
13052                    }
13053                }
13054                Keyword::DEC => {
13055                    let precision = self.parse_exact_number_optional_precision_scale()?;
13056
13057                    if self.parse_keyword(Keyword::UNSIGNED) {
13058                        Ok(DataType::DecUnsigned(precision))
13059                    } else {
13060                        Ok(DataType::Dec(precision))
13061                    }
13062                }
13063                Keyword::BIGNUMERIC => Ok(DataType::BigNumeric(
13064                    self.parse_exact_number_optional_precision_scale()?,
13065                )),
13066                Keyword::BIGDECIMAL => Ok(DataType::BigDecimal(
13067                    self.parse_exact_number_optional_precision_scale()?,
13068                )),
13069                Keyword::ENUM => Ok(DataType::Enum(self.parse_enum_values()?, None)),
13070                Keyword::ENUM8 => Ok(DataType::Enum(self.parse_enum_values()?, Some(8))),
13071                Keyword::ENUM16 => Ok(DataType::Enum(self.parse_enum_values()?, Some(16))),
13072                Keyword::SET => Ok(DataType::Set(self.parse_string_values()?)),
13073                Keyword::ARRAY => {
13074                    if self.dialect.supports_array_typedef_without_element_type() {
13075                        Ok(DataType::Array(ArrayElemTypeDef::None))
13076                    } else if dialect_of!(self is ClickHouseDialect) {
13077                        Ok(self.parse_sub_type(|internal_type| {
13078                            DataType::Array(ArrayElemTypeDef::Parenthesis(internal_type))
13079                        })?)
13080                    } else {
13081                        self.expect_token(&Token::Lt)?;
13082                        let (inside_type, _trailing_bracket) = self.parse_data_type_helper()?;
13083                        trailing_bracket = self.expect_closing_angle_bracket(_trailing_bracket)?;
13084                        Ok(DataType::Array(ArrayElemTypeDef::AngleBracket(Box::new(
13085                            inside_type,
13086                        ))))
13087                    }
13088                }
13089                Keyword::STRUCT if dialect_is!(dialect is DuckDbDialect) => {
13090                    self.prev_token();
13091                    let field_defs = self.parse_duckdb_struct_type_def()?;
13092                    Ok(DataType::Struct(field_defs, StructBracketKind::Parentheses))
13093                }
13094                Keyword::STRUCT if dialect_is!(dialect is BigQueryDialect | DatabricksDialect | GenericDialect) =>
13095                {
13096                    self.prev_token();
13097                    let (field_defs, _trailing_bracket) =
13098                        self.parse_struct_type_def(Self::parse_struct_field_def)?;
13099                    trailing_bracket = _trailing_bracket;
13100                    Ok(DataType::Struct(
13101                        field_defs,
13102                        StructBracketKind::AngleBrackets,
13103                    ))
13104                }
13105                Keyword::UNION if dialect_is!(dialect is DuckDbDialect | GenericDialect) => {
13106                    self.prev_token();
13107                    let fields = self.parse_union_type_def()?;
13108                    Ok(DataType::Union(fields))
13109                }
13110                Keyword::NULLABLE if dialect_is!(dialect is ClickHouseDialect | GenericDialect) => {
13111                    Ok(self.parse_sub_type(DataType::Nullable)?)
13112                }
13113                Keyword::LOWCARDINALITY if dialect_is!(dialect is ClickHouseDialect | GenericDialect) => {
13114                    Ok(self.parse_sub_type(DataType::LowCardinality)?)
13115                }
13116                Keyword::MAP if dialect_is!(dialect is ClickHouseDialect | GenericDialect) => {
13117                    self.prev_token();
13118                    let (key_data_type, value_data_type) = self.parse_click_house_map_def()?;
13119                    Ok(DataType::Map(
13120                        Box::new(key_data_type),
13121                        Box::new(value_data_type),
13122                    ))
13123                }
13124                Keyword::NESTED if dialect_is!(dialect is ClickHouseDialect | GenericDialect) => {
13125                    self.expect_token(&Token::LParen)?;
13126                    let field_defs = self.parse_comma_separated(Parser::parse_column_def)?;
13127                    self.expect_token(&Token::RParen)?;
13128                    Ok(DataType::Nested(field_defs))
13129                }
13130                Keyword::TUPLE if dialect_is!(dialect is ClickHouseDialect | GenericDialect) => {
13131                    self.prev_token();
13132                    let field_defs = self.parse_click_house_tuple_def()?;
13133                    Ok(DataType::Tuple(field_defs))
13134                }
13135                Keyword::TRIGGER => Ok(DataType::Trigger),
13136                Keyword::SETOF => {
13137                    let inner = self.parse_data_type()?;
13138                    Ok(DataType::SetOf(Box::new(inner)))
13139                }
13140                Keyword::ANY if self.peek_keyword(Keyword::TYPE) => {
13141                    let _ = self.parse_keyword(Keyword::TYPE);
13142                    Ok(DataType::AnyType)
13143                }
13144                Keyword::TABLE => {
13145                    // an LParen after the TABLE keyword indicates that table columns are being defined
13146                    // whereas no LParen indicates an anonymous table expression will be returned
13147                    if self.peek_token_ref().token == Token::LParen {
13148                        let columns = self.parse_returns_table_columns()?;
13149                        Ok(DataType::Table(Some(columns)))
13150                    } else {
13151                        Ok(DataType::Table(None))
13152                    }
13153                }
13154                Keyword::SIGNED => {
13155                    if self.parse_keyword(Keyword::INTEGER) {
13156                        Ok(DataType::SignedInteger)
13157                    } else {
13158                        Ok(DataType::Signed)
13159                    }
13160                }
13161                Keyword::UNSIGNED => {
13162                    if self.parse_keyword(Keyword::INTEGER) {
13163                        Ok(DataType::UnsignedInteger)
13164                    } else {
13165                        Ok(DataType::Unsigned)
13166                    }
13167                }
13168                Keyword::TSVECTOR if dialect_is!(dialect is PostgreSqlDialect | GenericDialect) => {
13169                    Ok(DataType::TsVector)
13170                }
13171                Keyword::TSQUERY if dialect_is!(dialect is PostgreSqlDialect | GenericDialect) => {
13172                    Ok(DataType::TsQuery)
13173                }
13174                _ => {
13175                    self.prev_token();
13176                    let type_name = self.parse_object_name(false)?;
13177                    if let Some(modifiers) = self.parse_optional_type_modifiers()? {
13178                        Ok(DataType::Custom(type_name, modifiers))
13179                    } else {
13180                        Ok(DataType::Custom(type_name, vec![]))
13181                    }
13182                }
13183            },
13184            _ => self.expected_at("a data type name", next_token_index),
13185        }?;
13186
13187        if self.dialect.supports_array_typedef_with_brackets() {
13188            while self.consume_token(&Token::LBracket) {
13189                // Parse optional array data type size
13190                let size = self.maybe_parse(|p| p.parse_literal_uint())?;
13191                self.expect_token(&Token::RBracket)?;
13192                data = DataType::Array(ArrayElemTypeDef::SquareBracket(Box::new(data), size))
13193            }
13194        }
13195        Ok((data, trailing_bracket))
13196    }
13197
13198    fn parse_returns_table_column(&mut self) -> Result<ColumnDef, ParserError> {
13199        self.parse_column_def()
13200    }
13201
13202    fn parse_returns_table_columns(&mut self) -> Result<Vec<ColumnDef>, ParserError> {
13203        self.expect_token(&Token::LParen)?;
13204        let columns = self.parse_comma_separated(Parser::parse_returns_table_column)?;
13205        self.expect_token(&Token::RParen)?;
13206        Ok(columns)
13207    }
13208
13209    /// Parse a parenthesized, comma-separated list of single-quoted strings.
13210    pub fn parse_string_values(&mut self) -> Result<Vec<String>, ParserError> {
13211        self.expect_token(&Token::LParen)?;
13212        let mut values = Vec::new();
13213        loop {
13214            let next_token = self.next_token();
13215            match next_token.token {
13216                Token::SingleQuotedString(value) => values.push(value),
13217                _ => self.expected("a string", next_token)?,
13218            }
13219            let next_token = self.next_token();
13220            match next_token.token {
13221                Token::Comma => (),
13222                Token::RParen => break,
13223                _ => self.expected(", or }", next_token)?,
13224            }
13225        }
13226        Ok(values)
13227    }
13228
13229    /// Strictly parse `identifier AS identifier`
13230    pub fn parse_identifier_with_alias(&mut self) -> Result<IdentWithAlias, ParserError> {
13231        let ident = self.parse_identifier()?;
13232        self.expect_keyword_is(Keyword::AS)?;
13233        let alias = self.parse_identifier()?;
13234        Ok(IdentWithAlias { ident, alias })
13235    }
13236
13237    /// Parse `identifier [AS] identifier` where the AS keyword is optional
13238    fn parse_identifier_with_optional_alias(&mut self) -> Result<IdentWithAlias, ParserError> {
13239        let ident = self.parse_identifier()?;
13240        let _after_as = self.parse_keyword(Keyword::AS);
13241        let alias = self.parse_identifier()?;
13242        Ok(IdentWithAlias { ident, alias })
13243    }
13244
13245    /// Parse comma-separated list of parenthesized queries for pipe operators
13246    fn parse_pipe_operator_queries(&mut self) -> Result<Vec<Query>, ParserError> {
13247        self.parse_comma_separated(|parser| {
13248            parser.expect_token(&Token::LParen)?;
13249            let query = parser.parse_query()?;
13250            parser.expect_token(&Token::RParen)?;
13251            Ok(*query)
13252        })
13253    }
13254
13255    /// Parse set quantifier for pipe operators that require DISTINCT. E.g. INTERSECT and EXCEPT
13256    fn parse_distinct_required_set_quantifier(
13257        &mut self,
13258        operator_name: &str,
13259    ) -> Result<SetQuantifier, ParserError> {
13260        let quantifier = self.parse_set_quantifier(&Some(SetOperator::Intersect));
13261        match quantifier {
13262            SetQuantifier::Distinct | SetQuantifier::DistinctByName => Ok(quantifier),
13263            _ => Err(ParserError::ParserError(format!(
13264                "{operator_name} pipe operator requires DISTINCT modifier",
13265            ))),
13266        }
13267    }
13268
13269    /// Parse optional identifier alias (with or without AS keyword)
13270    fn parse_identifier_optional_alias(&mut self) -> Result<Option<Ident>, ParserError> {
13271        if self.parse_keyword(Keyword::AS) {
13272            Ok(Some(self.parse_identifier()?))
13273        } else {
13274            // Check if the next token is an identifier (implicit alias)
13275            self.maybe_parse(|parser| parser.parse_identifier())
13276        }
13277    }
13278
13279    /// Optionally parses an alias for a select list item
13280    fn maybe_parse_select_item_alias(&mut self) -> Result<Option<Ident>, ParserError> {
13281        fn validator(explicit: bool, kw: &Keyword, parser: &mut Parser) -> bool {
13282            parser.dialect.is_select_item_alias(explicit, kw, parser)
13283        }
13284        self.parse_optional_alias_inner(None, validator)
13285    }
13286
13287    /// Optionally parses an alias for a table like in `... FROM generate_series(1, 10) AS t (col)`.
13288    /// In this case, the alias is allowed to optionally name the columns in the table, in
13289    /// addition to the table itself.
13290    pub fn maybe_parse_table_alias(&mut self) -> Result<Option<TableAlias>, ParserError> {
13291        fn validator(explicit: bool, kw: &Keyword, parser: &mut Parser) -> bool {
13292            parser.dialect.is_table_factor_alias(explicit, kw, parser)
13293        }
13294        let explicit = self.peek_keyword(Keyword::AS);
13295        match self.parse_optional_alias_inner(None, validator)? {
13296            Some(name) => {
13297                let columns = self.parse_table_alias_column_defs()?;
13298                Ok(Some(TableAlias {
13299                    explicit,
13300                    name,
13301                    columns,
13302                }))
13303            }
13304            None => Ok(None),
13305        }
13306    }
13307
13308    fn parse_table_index_hints(&mut self) -> Result<Vec<TableIndexHints>, ParserError> {
13309        let mut hints = vec![];
13310        while let Some(hint_type) =
13311            self.parse_one_of_keywords(&[Keyword::USE, Keyword::IGNORE, Keyword::FORCE])
13312        {
13313            let hint_type = match hint_type {
13314                Keyword::USE => TableIndexHintType::Use,
13315                Keyword::IGNORE => TableIndexHintType::Ignore,
13316                Keyword::FORCE => TableIndexHintType::Force,
13317                _ => {
13318                    return self.expected_ref(
13319                        "expected to match USE/IGNORE/FORCE keyword",
13320                        self.peek_token_ref(),
13321                    )
13322                }
13323            };
13324            let index_type = match self.parse_one_of_keywords(&[Keyword::INDEX, Keyword::KEY]) {
13325                Some(Keyword::INDEX) => TableIndexType::Index,
13326                Some(Keyword::KEY) => TableIndexType::Key,
13327                _ => {
13328                    return self
13329                        .expected_ref("expected to match INDEX/KEY keyword", self.peek_token_ref())
13330                }
13331            };
13332            let for_clause = if self.parse_keyword(Keyword::FOR) {
13333                let clause = if self.parse_keyword(Keyword::JOIN) {
13334                    TableIndexHintForClause::Join
13335                } else if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
13336                    TableIndexHintForClause::OrderBy
13337                } else if self.parse_keywords(&[Keyword::GROUP, Keyword::BY]) {
13338                    TableIndexHintForClause::GroupBy
13339                } else {
13340                    return self.expected_ref(
13341                        "expected to match FOR/ORDER BY/GROUP BY table hint in for clause",
13342                        self.peek_token_ref(),
13343                    );
13344                };
13345                Some(clause)
13346            } else {
13347                None
13348            };
13349
13350            self.expect_token(&Token::LParen)?;
13351            let index_names = if self.peek_token_ref().token != Token::RParen {
13352                self.parse_comma_separated(Parser::parse_identifier)?
13353            } else {
13354                vec![]
13355            };
13356            self.expect_token(&Token::RParen)?;
13357            hints.push(TableIndexHints {
13358                hint_type,
13359                index_type,
13360                for_clause,
13361                index_names,
13362            });
13363        }
13364        Ok(hints)
13365    }
13366
13367    /// Wrapper for parse_optional_alias_inner, left for backwards-compatibility
13368    /// but new flows should use the context-specific methods such as `maybe_parse_select_item_alias`
13369    /// and `maybe_parse_table_alias`.
13370    pub fn parse_optional_alias(
13371        &mut self,
13372        reserved_kwds: &[Keyword],
13373    ) -> Result<Option<Ident>, ParserError> {
13374        fn validator(_explicit: bool, _kw: &Keyword, _parser: &mut Parser) -> bool {
13375            false
13376        }
13377        self.parse_optional_alias_inner(Some(reserved_kwds), validator)
13378    }
13379
13380    /// Parses an optional alias after a SQL element such as a select list item
13381    /// or a table name.
13382    ///
13383    /// This method accepts an optional list of reserved keywords or a function
13384    /// to call to validate if a keyword should be parsed as an alias, to allow
13385    /// callers to customize the parsing logic based on their context.
13386    fn parse_optional_alias_inner<F>(
13387        &mut self,
13388        reserved_kwds: Option<&[Keyword]>,
13389        validator: F,
13390    ) -> Result<Option<Ident>, ParserError>
13391    where
13392        F: Fn(bool, &Keyword, &mut Parser) -> bool,
13393    {
13394        let after_as = self.parse_keyword(Keyword::AS);
13395
13396        let next_token = self.next_token();
13397        match next_token.token {
13398            // Accepts a keyword as an alias if the AS keyword explicitly indicate an alias or if the
13399            // caller provided a list of reserved keywords and the keyword is not on that list.
13400            Token::Word(w)
13401                if reserved_kwds.is_some()
13402                    && (after_as || reserved_kwds.is_some_and(|x| !x.contains(&w.keyword))) =>
13403            {
13404                Ok(Some(w.into_ident(next_token.span)))
13405            }
13406            // Accepts a keyword as alias based on the caller's context, such as to what SQL element
13407            // this word is a potential alias of using the validator call-back. This allows for
13408            // dialect-specific logic.
13409            Token::Word(w) if validator(after_as, &w.keyword, self) => {
13410                Ok(Some(w.into_ident(next_token.span)))
13411            }
13412            // For backwards-compatibility, we accept quoted strings as aliases regardless of the context.
13413            Token::SingleQuotedString(s) => Ok(Some(Ident::with_quote('\'', s))),
13414            Token::DoubleQuotedString(s) => Ok(Some(Ident::with_quote('\"', s))),
13415            _ => {
13416                if after_as {
13417                    return self.expected("an identifier after AS", next_token);
13418                }
13419                self.prev_token();
13420                Ok(None) // no alias found
13421            }
13422        }
13423    }
13424
13425    /// Parse an optional `GROUP BY` clause, returning `Some(GroupByExpr)` when present.
13426    pub fn parse_optional_group_by(&mut self) -> Result<Option<GroupByExpr>, ParserError> {
13427        if self.parse_keywords(&[Keyword::GROUP, Keyword::BY]) {
13428            let expressions = if self.parse_keyword(Keyword::ALL) {
13429                None
13430            } else {
13431                Some(self.parse_comma_separated(Parser::parse_group_by_expr)?)
13432            };
13433
13434            let mut modifiers = vec![];
13435            if self.dialect.supports_group_by_with_modifier() {
13436                loop {
13437                    if !self.parse_keyword(Keyword::WITH) {
13438                        break;
13439                    }
13440                    let keyword = self.expect_one_of_keywords(&[
13441                        Keyword::ROLLUP,
13442                        Keyword::CUBE,
13443                        Keyword::TOTALS,
13444                    ])?;
13445                    modifiers.push(match keyword {
13446                        Keyword::ROLLUP => GroupByWithModifier::Rollup,
13447                        Keyword::CUBE => GroupByWithModifier::Cube,
13448                        Keyword::TOTALS => GroupByWithModifier::Totals,
13449                        _ => {
13450                            return parser_err!(
13451                                "BUG: expected to match GroupBy modifier keyword",
13452                                self.peek_token_ref().span.start
13453                            )
13454                        }
13455                    });
13456                }
13457            }
13458            if self.parse_keywords(&[Keyword::GROUPING, Keyword::SETS]) {
13459                self.expect_token(&Token::LParen)?;
13460                let result = self.parse_comma_separated(|p| {
13461                    if p.peek_token_ref().token == Token::LParen {
13462                        p.parse_tuple(true, true)
13463                    } else {
13464                        Ok(vec![p.parse_expr()?])
13465                    }
13466                })?;
13467                self.expect_token(&Token::RParen)?;
13468                modifiers.push(GroupByWithModifier::GroupingSets(Expr::GroupingSets(
13469                    result,
13470                )));
13471            };
13472            let group_by = match expressions {
13473                None => GroupByExpr::All(modifiers),
13474                Some(exprs) => GroupByExpr::Expressions(exprs, modifiers),
13475            };
13476            Ok(Some(group_by))
13477        } else {
13478            Ok(None)
13479        }
13480    }
13481
13482    /// Parse an optional `ORDER BY` clause, returning `Some(OrderBy)` when present.
13483    pub fn parse_optional_order_by(&mut self) -> Result<Option<OrderBy>, ParserError> {
13484        if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
13485            let order_by =
13486                if self.dialect.supports_order_by_all() && self.parse_keyword(Keyword::ALL) {
13487                    let order_by_options = self.parse_order_by_options()?;
13488                    OrderBy {
13489                        kind: OrderByKind::All(order_by_options),
13490                        interpolate: None,
13491                    }
13492                } else {
13493                    let exprs = self.parse_comma_separated(Parser::parse_order_by_expr)?;
13494                    let interpolate = if self.dialect.supports_interpolate() {
13495                        self.parse_interpolations()?
13496                    } else {
13497                        None
13498                    };
13499                    OrderBy {
13500                        kind: OrderByKind::Expressions(exprs),
13501                        interpolate,
13502                    }
13503                };
13504            Ok(Some(order_by))
13505        } else {
13506            Ok(None)
13507        }
13508    }
13509
13510    fn parse_optional_limit_clause(&mut self) -> Result<Option<LimitClause>, ParserError> {
13511        let mut offset = if self.parse_keyword(Keyword::OFFSET) {
13512            Some(self.parse_offset()?)
13513        } else {
13514            None
13515        };
13516
13517        let (limit, limit_by) = if self.parse_keyword(Keyword::LIMIT) {
13518            let expr = self.parse_limit()?;
13519
13520            if self.dialect.supports_limit_comma()
13521                && offset.is_none()
13522                && expr.is_some() // ALL not supported with comma
13523                && self.consume_token(&Token::Comma)
13524            {
13525                let offset = expr.ok_or_else(|| {
13526                    ParserError::ParserError(
13527                        "Missing offset for LIMIT <offset>, <limit>".to_string(),
13528                    )
13529                })?;
13530                return Ok(Some(LimitClause::OffsetCommaLimit {
13531                    offset,
13532                    limit: self.parse_expr()?,
13533                }));
13534            }
13535
13536            let limit_by = if self.dialect.supports_limit_by() && self.parse_keyword(Keyword::BY) {
13537                Some(self.parse_comma_separated(Parser::parse_expr)?)
13538            } else {
13539                None
13540            };
13541
13542            (Some(expr), limit_by)
13543        } else {
13544            (None, None)
13545        };
13546
13547        if offset.is_none() && limit.is_some() && self.parse_keyword(Keyword::OFFSET) {
13548            offset = Some(self.parse_offset()?);
13549        }
13550
13551        if offset.is_some() || (limit.is_some() && limit != Some(None)) || limit_by.is_some() {
13552            Ok(Some(LimitClause::LimitOffset {
13553                limit: limit.unwrap_or_default(),
13554                offset,
13555                limit_by: limit_by.unwrap_or_default(),
13556            }))
13557        } else {
13558            Ok(None)
13559        }
13560    }
13561
13562    /// Parse a table object for insertion
13563    /// e.g. `some_database.some_table` or `FUNCTION some_table_func(...)`
13564    pub fn parse_table_object(&mut self) -> Result<TableObject, ParserError> {
13565        if self.dialect.supports_insert_table_function() && self.parse_keyword(Keyword::FUNCTION) {
13566            let fn_name = self.parse_object_name(false)?;
13567            self.parse_function_call(fn_name)
13568                .map(TableObject::TableFunction)
13569        } else if self.dialect.supports_insert_table_query() && self.peek_subquery_or_cte_start() {
13570            self.parse_parenthesized(|p| p.parse_query())
13571                .map(TableObject::TableQuery)
13572        } else {
13573            self.parse_object_name(false).map(TableObject::TableName)
13574        }
13575    }
13576
13577    /// Parse a possibly qualified, possibly quoted identifier, e.g.
13578    /// `foo` or `myschema."table"
13579    ///
13580    /// The `in_table_clause` parameter indicates whether the object name is a table in a FROM, JOIN,
13581    /// or similar table clause. Currently, this is used only to support unquoted hyphenated identifiers
13582    /// in this context on BigQuery.
13583    pub fn parse_object_name(&mut self, in_table_clause: bool) -> Result<ObjectName, ParserError> {
13584        self.parse_object_name_inner(in_table_clause, false)
13585    }
13586
13587    /// Parse a possibly qualified, possibly quoted identifier, e.g.
13588    /// `foo` or `myschema."table"
13589    ///
13590    /// The `in_table_clause` parameter indicates whether the object name is a table in a FROM, JOIN,
13591    /// or similar table clause. Currently, this is used only to support unquoted hyphenated identifiers
13592    /// in this context on BigQuery.
13593    ///
13594    /// The `allow_wildcards` parameter indicates whether to allow for wildcards in the object name
13595    /// e.g. *, *.*, `foo`.*, or "foo"."bar"
13596    fn parse_object_name_inner(
13597        &mut self,
13598        in_table_clause: bool,
13599        allow_wildcards: bool,
13600    ) -> Result<ObjectName, ParserError> {
13601        let mut parts = vec![];
13602        if dialect_of!(self is BigQueryDialect) && in_table_clause {
13603            loop {
13604                let (ident, end_with_period) = self.parse_unquoted_hyphenated_identifier()?;
13605                parts.push(ObjectNamePart::Identifier(ident));
13606                if !self.consume_token(&Token::Period) && !end_with_period {
13607                    break;
13608                }
13609            }
13610        } else {
13611            loop {
13612                if allow_wildcards && self.peek_token_ref().token == Token::Mul {
13613                    let span = self.next_token().span;
13614                    parts.push(ObjectNamePart::Identifier(Ident {
13615                        value: Token::Mul.to_string(),
13616                        quote_style: None,
13617                        span,
13618                    }));
13619                } else if dialect_of!(self is BigQueryDialect) && in_table_clause {
13620                    let (ident, end_with_period) = self.parse_unquoted_hyphenated_identifier()?;
13621                    parts.push(ObjectNamePart::Identifier(ident));
13622                    if !self.consume_token(&Token::Period) && !end_with_period {
13623                        break;
13624                    }
13625                } else if self.dialect.supports_object_name_double_dot_notation()
13626                    && parts.len() == 1
13627                    && matches!(self.peek_token_ref().token, Token::Period)
13628                {
13629                    // Empty string here means default schema
13630                    parts.push(ObjectNamePart::Identifier(Ident::new("")));
13631                } else {
13632                    let ident = self.parse_identifier()?;
13633                    let part = if self
13634                        .dialect
13635                        .is_identifier_generating_function_name(&ident, &parts)
13636                    {
13637                        self.expect_token(&Token::LParen)?;
13638                        let args: Vec<FunctionArg> =
13639                            self.parse_comma_separated0(Self::parse_function_args, Token::RParen)?;
13640                        self.expect_token(&Token::RParen)?;
13641                        ObjectNamePart::Function(ObjectNamePartFunction { name: ident, args })
13642                    } else {
13643                        ObjectNamePart::Identifier(ident)
13644                    };
13645                    parts.push(part);
13646                }
13647
13648                if !self.consume_token(&Token::Period) {
13649                    break;
13650                }
13651            }
13652        }
13653
13654        // BigQuery accepts any number of quoted identifiers of a table name.
13655        // https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#quoted_identifiers
13656        if dialect_of!(self is BigQueryDialect)
13657            && parts.iter().any(|part| {
13658                part.as_ident()
13659                    .is_some_and(|ident| ident.value.contains('.'))
13660            })
13661        {
13662            parts = parts
13663                .into_iter()
13664                .flat_map(|part| match part.as_ident() {
13665                    Some(ident) => ident
13666                        .value
13667                        .split('.')
13668                        .map(|value| {
13669                            ObjectNamePart::Identifier(Ident {
13670                                value: value.into(),
13671                                quote_style: ident.quote_style,
13672                                span: ident.span,
13673                            })
13674                        })
13675                        .collect::<Vec<_>>(),
13676                    None => vec![part],
13677                })
13678                .collect()
13679        }
13680
13681        Ok(ObjectName(parts))
13682    }
13683
13684    /// Parse identifiers
13685    pub fn parse_identifiers(&mut self) -> Result<Vec<Ident>, ParserError> {
13686        let mut idents = vec![];
13687        loop {
13688            let token = self.peek_token_ref();
13689            match &token.token {
13690                Token::Word(w) => {
13691                    idents.push(w.to_ident(token.span));
13692                }
13693                Token::EOF | Token::Eq | Token::SemiColon | Token::VerticalBarRightAngleBracket => {
13694                    break
13695                }
13696                _ => {}
13697            }
13698            self.advance_token();
13699        }
13700        Ok(idents)
13701    }
13702
13703    /// Parse identifiers of form ident1[.identN]*
13704    ///
13705    /// Similar in functionality to [parse_identifiers], with difference
13706    /// being this function is much more strict about parsing a valid multipart identifier, not
13707    /// allowing extraneous tokens to be parsed, otherwise it fails.
13708    ///
13709    /// For example:
13710    ///
13711    /// ```rust
13712    /// use sqlparser::ast::Ident;
13713    /// use sqlparser::dialect::GenericDialect;
13714    /// use sqlparser::parser::Parser;
13715    ///
13716    /// let dialect = GenericDialect {};
13717    /// let expected = vec![Ident::new("one"), Ident::new("two")];
13718    ///
13719    /// // expected usage
13720    /// let sql = "one.two";
13721    /// let mut parser = Parser::new(&dialect).try_with_sql(sql).unwrap();
13722    /// let actual = parser.parse_multipart_identifier().unwrap();
13723    /// assert_eq!(&actual, &expected);
13724    ///
13725    /// // parse_identifiers is more loose on what it allows, parsing successfully
13726    /// let sql = "one + two";
13727    /// let mut parser = Parser::new(&dialect).try_with_sql(sql).unwrap();
13728    /// let actual = parser.parse_identifiers().unwrap();
13729    /// assert_eq!(&actual, &expected);
13730    ///
13731    /// // expected to strictly fail due to + separator
13732    /// let sql = "one + two";
13733    /// let mut parser = Parser::new(&dialect).try_with_sql(sql).unwrap();
13734    /// let actual = parser.parse_multipart_identifier().unwrap_err();
13735    /// assert_eq!(
13736    ///     actual.to_string(),
13737    ///     "sql parser error: Unexpected token in identifier: +"
13738    /// );
13739    /// ```
13740    ///
13741    /// [parse_identifiers]: Parser::parse_identifiers
13742    pub fn parse_multipart_identifier(&mut self) -> Result<Vec<Ident>, ParserError> {
13743        let mut idents = vec![];
13744
13745        // expecting at least one word for identifier
13746        let next_token = self.next_token();
13747        match next_token.token {
13748            Token::Word(w) => idents.push(w.into_ident(next_token.span)),
13749            Token::EOF => {
13750                return Err(ParserError::ParserError(
13751                    "Empty input when parsing identifier".to_string(),
13752                ))?
13753            }
13754            token => {
13755                return Err(ParserError::ParserError(format!(
13756                    "Unexpected token in identifier: {token}"
13757                )))?
13758            }
13759        };
13760
13761        // parse optional next parts if exist
13762        loop {
13763            match self.next_token().token {
13764                // ensure that optional period is succeeded by another identifier
13765                Token::Period => {
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                                "Trailing period in identifier".to_string(),
13772                            ))?
13773                        }
13774                        token => {
13775                            return Err(ParserError::ParserError(format!(
13776                                "Unexpected token following period in identifier: {token}"
13777                            )))?
13778                        }
13779                    }
13780                }
13781                Token::EOF => break,
13782                token => {
13783                    return Err(ParserError::ParserError(format!(
13784                        "Unexpected token in identifier: {token}"
13785                    )))?;
13786                }
13787            }
13788        }
13789
13790        Ok(idents)
13791    }
13792
13793    /// Parse a simple one-word identifier (possibly quoted, possibly a keyword)
13794    pub fn parse_identifier(&mut self) -> Result<Ident, ParserError> {
13795        let next_token = self.next_token();
13796        match next_token.token {
13797            Token::Word(w) => Ok(w.into_ident(next_token.span)),
13798            Token::SingleQuotedString(s) => Ok(Ident::with_quote('\'', s)),
13799            Token::DoubleQuotedString(s) => Ok(Ident::with_quote('\"', s)),
13800            _ => self.expected("identifier", next_token),
13801        }
13802    }
13803
13804    /// On BigQuery, hyphens are permitted in unquoted identifiers inside of a FROM or
13805    /// TABLE clause.
13806    ///
13807    /// The first segment must be an ordinary unquoted identifier, e.g. it must not start
13808    /// with a digit. Subsequent segments are either must either be valid identifiers or
13809    /// integers, e.g. foo-123 is allowed, but foo-123a is not.
13810    ///
13811    /// [BigQuery-lexical](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical)
13812    ///
13813    /// Return a tuple of the identifier and a boolean indicating it ends with a period.
13814    fn parse_unquoted_hyphenated_identifier(&mut self) -> Result<(Ident, bool), ParserError> {
13815        match self.peek_token().token {
13816            Token::Word(w) => {
13817                let quote_style_is_none = w.quote_style.is_none();
13818                let mut requires_whitespace = false;
13819                let mut ident = w.into_ident(self.next_token().span);
13820                if quote_style_is_none {
13821                    while matches!(self.peek_token_no_skip().token, Token::Minus) {
13822                        self.next_token();
13823                        ident.value.push('-');
13824
13825                        let token = self
13826                            .next_token_no_skip()
13827                            .cloned()
13828                            .unwrap_or(TokenWithSpan::wrap(Token::EOF));
13829                        requires_whitespace = match token.token {
13830                            Token::Word(next_word) if next_word.quote_style.is_none() => {
13831                                ident.value.push_str(&next_word.value);
13832                                false
13833                            }
13834                            Token::Number(s, false) => {
13835                                // A number token can represent a decimal value ending with a period, e.g., `Number('123.')`.
13836                                // However, for an [ObjectName], it is part of a hyphenated identifier, e.g., `foo-123.bar`.
13837                                //
13838                                // If a number token is followed by a period, it is part of an [ObjectName].
13839                                // Return the identifier with `true` if the number token is followed by a period, indicating that
13840                                // parsing should continue for the next part of the hyphenated identifier.
13841                                if s.ends_with('.') {
13842                                    let Some(s) = s.split('.').next().filter(|s| {
13843                                        !s.is_empty() && s.chars().all(|c| c.is_ascii_digit())
13844                                    }) else {
13845                                        return self.expected(
13846                                            "continuation of hyphenated identifier",
13847                                            TokenWithSpan::new(Token::Number(s, false), token.span),
13848                                        );
13849                                    };
13850                                    ident.value.push_str(s);
13851                                    return Ok((ident, true));
13852                                } else {
13853                                    ident.value.push_str(&s);
13854                                }
13855                                // If next token is period, then it is part of an ObjectName and we don't expect whitespace
13856                                // after the number.
13857                                !matches!(self.peek_token_ref().token, Token::Period)
13858                            }
13859                            _ => {
13860                                return self
13861                                    .expected("continuation of hyphenated identifier", token);
13862                            }
13863                        }
13864                    }
13865
13866                    // If the last segment was a number, we must check that it's followed by whitespace,
13867                    // otherwise foo-123a will be parsed as `foo-123` with the alias `a`.
13868                    if requires_whitespace {
13869                        let token = self.next_token();
13870                        if !matches!(token.token, Token::EOF | Token::Whitespace(_)) {
13871                            return self
13872                                .expected("whitespace following hyphenated identifier", token);
13873                        }
13874                    }
13875                }
13876                Ok((ident, false))
13877            }
13878            _ => Ok((self.parse_identifier()?, false)),
13879        }
13880    }
13881
13882    /// Parses a parenthesized, comma-separated list of column definitions within a view.
13883    fn parse_view_columns(&mut self) -> Result<Vec<ViewColumnDef>, ParserError> {
13884        if self.consume_token(&Token::LParen) {
13885            if self.peek_token_ref().token == Token::RParen {
13886                self.next_token();
13887                Ok(vec![])
13888            } else {
13889                let cols = self.parse_comma_separated_with_trailing_commas(
13890                    Parser::parse_view_column,
13891                    self.dialect.supports_column_definition_trailing_commas(),
13892                    Self::is_reserved_for_column_alias,
13893                )?;
13894                self.expect_token(&Token::RParen)?;
13895                Ok(cols)
13896            }
13897        } else {
13898            Ok(vec![])
13899        }
13900    }
13901
13902    /// Parses a column definition within a view.
13903    fn parse_view_column(&mut self) -> Result<ViewColumnDef, ParserError> {
13904        let name = self.parse_identifier()?;
13905        let options = self.parse_view_column_options()?;
13906        let data_type = if dialect_of!(self is ClickHouseDialect) {
13907            Some(self.parse_data_type()?)
13908        } else {
13909            None
13910        };
13911        Ok(ViewColumnDef {
13912            name,
13913            data_type,
13914            options,
13915        })
13916    }
13917
13918    fn parse_view_column_options(&mut self) -> Result<Option<ColumnOptions>, ParserError> {
13919        let mut options = Vec::new();
13920        loop {
13921            let option = self.parse_optional_column_option()?;
13922            if let Some(option) = option {
13923                options.push(option);
13924            } else {
13925                break;
13926            }
13927        }
13928        if options.is_empty() {
13929            Ok(None)
13930        } else if self.dialect.supports_space_separated_column_options() {
13931            Ok(Some(ColumnOptions::SpaceSeparated(options)))
13932        } else {
13933            Ok(Some(ColumnOptions::CommaSeparated(options)))
13934        }
13935    }
13936
13937    /// Parses a parenthesized comma-separated list of unqualified, possibly quoted identifiers.
13938    /// For example: `(col1, "col 2", ...)`
13939    pub fn parse_parenthesized_column_list(
13940        &mut self,
13941        optional: IsOptional,
13942        allow_empty: bool,
13943    ) -> Result<Vec<Ident>, ParserError> {
13944        self.parse_parenthesized_column_list_inner(optional, allow_empty, |p| p.parse_identifier())
13945    }
13946
13947    /// Parse a parenthesized list of compound identifiers as expressions.
13948    pub fn parse_parenthesized_compound_identifier_list(
13949        &mut self,
13950        optional: IsOptional,
13951        allow_empty: bool,
13952    ) -> Result<Vec<Expr>, ParserError> {
13953        self.parse_parenthesized_column_list_inner(optional, allow_empty, |p| {
13954            Ok(Expr::CompoundIdentifier(
13955                p.parse_period_separated(|p| p.parse_identifier())?,
13956            ))
13957        })
13958    }
13959
13960    /// Parses a parenthesized comma-separated list of index columns, which can be arbitrary
13961    /// expressions with ordering information (and an opclass in some dialects).
13962    fn parse_parenthesized_index_column_list(&mut self) -> Result<Vec<IndexColumn>, ParserError> {
13963        self.parse_parenthesized_column_list_inner(Mandatory, false, |p| {
13964            p.parse_create_index_expr()
13965        })
13966    }
13967
13968    /// Parses a parenthesized comma-separated list of qualified, possibly quoted identifiers.
13969    /// For example: `(db1.sc1.tbl1.col1, db1.sc1.tbl1."col 2", ...)`
13970    pub fn parse_parenthesized_qualified_column_list(
13971        &mut self,
13972        optional: IsOptional,
13973        allow_empty: bool,
13974    ) -> Result<Vec<ObjectName>, ParserError> {
13975        self.parse_parenthesized_column_list_inner(optional, allow_empty, |p| {
13976            p.parse_object_name(true)
13977        })
13978    }
13979
13980    /// Parses a parenthesized comma-separated list of columns using
13981    /// the provided function to parse each element.
13982    fn parse_parenthesized_column_list_inner<F, T>(
13983        &mut self,
13984        optional: IsOptional,
13985        allow_empty: bool,
13986        mut f: F,
13987    ) -> Result<Vec<T>, ParserError>
13988    where
13989        F: FnMut(&mut Parser) -> Result<T, ParserError>,
13990    {
13991        if self.consume_token(&Token::LParen) {
13992            if allow_empty && self.peek_token_ref().token == Token::RParen {
13993                self.next_token();
13994                Ok(vec![])
13995            } else {
13996                let cols = self.parse_comma_separated(|p| f(p))?;
13997                self.expect_token(&Token::RParen)?;
13998                Ok(cols)
13999            }
14000        } else if optional == Optional {
14001            Ok(vec![])
14002        } else {
14003            self.expected_ref("a list of columns in parentheses", self.peek_token_ref())
14004        }
14005    }
14006
14007    /// Parses a parenthesized comma-separated list of table alias column definitions.
14008    fn parse_table_alias_column_defs(&mut self) -> Result<Vec<TableAliasColumnDef>, ParserError> {
14009        if self.consume_token(&Token::LParen) {
14010            let cols = self.parse_comma_separated(|p| {
14011                let name = p.parse_identifier()?;
14012                let data_type = p.maybe_parse(|p| p.parse_data_type())?;
14013                Ok(TableAliasColumnDef { name, data_type })
14014            })?;
14015            self.expect_token(&Token::RParen)?;
14016            Ok(cols)
14017        } else {
14018            Ok(vec![])
14019        }
14020    }
14021
14022    /// Parse an unsigned precision value enclosed in parentheses, e.g. `(10)`.
14023    pub fn parse_precision(&mut self) -> Result<u64, ParserError> {
14024        self.expect_token(&Token::LParen)?;
14025        let n = self.parse_literal_uint()?;
14026        self.expect_token(&Token::RParen)?;
14027        Ok(n)
14028    }
14029
14030    /// Parse an optional precision `(n)` and return it as `Some(n)` when present.
14031    pub fn parse_optional_precision(&mut self) -> Result<Option<u64>, ParserError> {
14032        if self.consume_token(&Token::LParen) {
14033            let n = self.parse_literal_uint()?;
14034            self.expect_token(&Token::RParen)?;
14035            Ok(Some(n))
14036        } else {
14037            Ok(None)
14038        }
14039    }
14040
14041    fn maybe_parse_optional_interval_fields(
14042        &mut self,
14043    ) -> Result<Option<IntervalFields>, ParserError> {
14044        match self.parse_one_of_keywords(&[
14045            // Can be followed by `TO` option
14046            Keyword::YEAR,
14047            Keyword::DAY,
14048            Keyword::HOUR,
14049            Keyword::MINUTE,
14050            // No `TO` option
14051            Keyword::MONTH,
14052            Keyword::SECOND,
14053        ]) {
14054            Some(Keyword::YEAR) => {
14055                if self.peek_keyword(Keyword::TO) {
14056                    self.expect_keyword(Keyword::TO)?;
14057                    self.expect_keyword(Keyword::MONTH)?;
14058                    Ok(Some(IntervalFields::YearToMonth))
14059                } else {
14060                    Ok(Some(IntervalFields::Year))
14061                }
14062            }
14063            Some(Keyword::DAY) => {
14064                if self.peek_keyword(Keyword::TO) {
14065                    self.expect_keyword(Keyword::TO)?;
14066                    match self.expect_one_of_keywords(&[
14067                        Keyword::HOUR,
14068                        Keyword::MINUTE,
14069                        Keyword::SECOND,
14070                    ])? {
14071                        Keyword::HOUR => Ok(Some(IntervalFields::DayToHour)),
14072                        Keyword::MINUTE => Ok(Some(IntervalFields::DayToMinute)),
14073                        Keyword::SECOND => Ok(Some(IntervalFields::DayToSecond)),
14074                        _ => {
14075                            self.prev_token();
14076                            self.expected_ref("HOUR, MINUTE, or SECOND", self.peek_token_ref())
14077                        }
14078                    }
14079                } else {
14080                    Ok(Some(IntervalFields::Day))
14081                }
14082            }
14083            Some(Keyword::HOUR) => {
14084                if self.peek_keyword(Keyword::TO) {
14085                    self.expect_keyword(Keyword::TO)?;
14086                    match self.expect_one_of_keywords(&[Keyword::MINUTE, Keyword::SECOND])? {
14087                        Keyword::MINUTE => Ok(Some(IntervalFields::HourToMinute)),
14088                        Keyword::SECOND => Ok(Some(IntervalFields::HourToSecond)),
14089                        _ => {
14090                            self.prev_token();
14091                            self.expected_ref("MINUTE or SECOND", self.peek_token_ref())
14092                        }
14093                    }
14094                } else {
14095                    Ok(Some(IntervalFields::Hour))
14096                }
14097            }
14098            Some(Keyword::MINUTE) => {
14099                if self.peek_keyword(Keyword::TO) {
14100                    self.expect_keyword(Keyword::TO)?;
14101                    self.expect_keyword(Keyword::SECOND)?;
14102                    Ok(Some(IntervalFields::MinuteToSecond))
14103                } else {
14104                    Ok(Some(IntervalFields::Minute))
14105                }
14106            }
14107            Some(Keyword::MONTH) => Ok(Some(IntervalFields::Month)),
14108            Some(Keyword::SECOND) => Ok(Some(IntervalFields::Second)),
14109            Some(_) => {
14110                self.prev_token();
14111                self.expected_ref(
14112                    "YEAR, MONTH, DAY, HOUR, MINUTE, or SECOND",
14113                    self.peek_token_ref(),
14114                )
14115            }
14116            None => Ok(None),
14117        }
14118    }
14119
14120    /// Parse datetime64 [1]
14121    /// Syntax
14122    /// ```sql
14123    /// DateTime64(precision[, timezone])
14124    /// ```
14125    ///
14126    /// [1]: https://clickhouse.com/docs/en/sql-reference/data-types/datetime64
14127    pub fn parse_datetime_64(&mut self) -> Result<(u64, Option<String>), ParserError> {
14128        self.expect_keyword_is(Keyword::DATETIME64)?;
14129        self.expect_token(&Token::LParen)?;
14130        let precision = self.parse_literal_uint()?;
14131        let time_zone = if self.consume_token(&Token::Comma) {
14132            Some(self.parse_literal_string()?)
14133        } else {
14134            None
14135        };
14136        self.expect_token(&Token::RParen)?;
14137        Ok((precision, time_zone))
14138    }
14139
14140    /// Parse an optional character length specification `(n | MAX [CHARACTERS|OCTETS])`.
14141    pub fn parse_optional_character_length(
14142        &mut self,
14143    ) -> Result<Option<CharacterLength>, ParserError> {
14144        if self.consume_token(&Token::LParen) {
14145            let character_length = self.parse_character_length()?;
14146            self.expect_token(&Token::RParen)?;
14147            Ok(Some(character_length))
14148        } else {
14149            Ok(None)
14150        }
14151    }
14152
14153    /// Parse an optional binary length specification like `(n)`.
14154    pub fn parse_optional_binary_length(&mut self) -> Result<Option<BinaryLength>, ParserError> {
14155        if self.consume_token(&Token::LParen) {
14156            let binary_length = self.parse_binary_length()?;
14157            self.expect_token(&Token::RParen)?;
14158            Ok(Some(binary_length))
14159        } else {
14160            Ok(None)
14161        }
14162    }
14163
14164    /// Parse a character length, handling `MAX` or integer lengths with optional units.
14165    pub fn parse_character_length(&mut self) -> Result<CharacterLength, ParserError> {
14166        if self.parse_keyword(Keyword::MAX) {
14167            return Ok(CharacterLength::Max);
14168        }
14169        let length = self.parse_literal_uint()?;
14170        let unit = if self.parse_keyword(Keyword::CHARACTERS) {
14171            Some(CharLengthUnits::Characters)
14172        } else if self.parse_keyword(Keyword::OCTETS) {
14173            Some(CharLengthUnits::Octets)
14174        } else {
14175            None
14176        };
14177        Ok(CharacterLength::IntegerLength { length, unit })
14178    }
14179
14180    /// Parse a binary length specification, returning `BinaryLength`.
14181    pub fn parse_binary_length(&mut self) -> Result<BinaryLength, ParserError> {
14182        if self.parse_keyword(Keyword::MAX) {
14183            return Ok(BinaryLength::Max);
14184        }
14185        let length = self.parse_literal_uint()?;
14186        Ok(BinaryLength::IntegerLength { length })
14187    }
14188
14189    /// Parse an optional `(precision[, scale])` and return `(Option<precision>, Option<scale>)`.
14190    pub fn parse_optional_precision_scale(
14191        &mut self,
14192    ) -> Result<(Option<u64>, Option<u64>), ParserError> {
14193        if self.consume_token(&Token::LParen) {
14194            let n = self.parse_literal_uint()?;
14195            let scale = if self.consume_token(&Token::Comma) {
14196                Some(self.parse_literal_uint()?)
14197            } else {
14198                None
14199            };
14200            self.expect_token(&Token::RParen)?;
14201            Ok((Some(n), scale))
14202        } else {
14203            Ok((None, None))
14204        }
14205    }
14206
14207    /// Parse exact-number precision/scale info like `(precision[, scale])` for decimal types.
14208    pub fn parse_exact_number_optional_precision_scale(
14209        &mut self,
14210    ) -> Result<ExactNumberInfo, ParserError> {
14211        if self.consume_token(&Token::LParen) {
14212            let precision = self.parse_literal_uint()?;
14213            let scale = if self.consume_token(&Token::Comma) {
14214                Some(self.parse_signed_integer()?)
14215            } else {
14216                None
14217            };
14218
14219            self.expect_token(&Token::RParen)?;
14220
14221            match scale {
14222                None => Ok(ExactNumberInfo::Precision(precision)),
14223                Some(scale) => Ok(ExactNumberInfo::PrecisionAndScale(precision, scale)),
14224            }
14225        } else {
14226            Ok(ExactNumberInfo::None)
14227        }
14228    }
14229
14230    /// Parse an optionally signed integer literal.
14231    fn parse_signed_integer(&mut self) -> Result<i64, ParserError> {
14232        let is_negative = self.consume_token(&Token::Minus);
14233
14234        if !is_negative {
14235            let _ = self.consume_token(&Token::Plus);
14236        }
14237
14238        let current_token = self.peek_token_ref();
14239        match &current_token.token {
14240            Token::Number(s, _) => {
14241                let s = s.clone();
14242                let span_start = current_token.span.start;
14243                self.advance_token();
14244                let value = Self::parse::<i64>(s, span_start)?;
14245                Ok(if is_negative { -value } else { value })
14246            }
14247            _ => self.expected_ref("number", current_token),
14248        }
14249    }
14250
14251    /// Parse optional type modifiers appearing in parentheses e.g. `(UNSIGNED, ZEROFILL)`.
14252    pub fn parse_optional_type_modifiers(&mut self) -> Result<Option<Vec<String>>, ParserError> {
14253        if self.consume_token(&Token::LParen) {
14254            let mut modifiers = Vec::new();
14255            loop {
14256                let next_token = self.next_token();
14257                match next_token.token {
14258                    Token::Word(w) => modifiers.push(w.to_string()),
14259                    Token::Number(n, _) => modifiers.push(n),
14260                    Token::SingleQuotedString(s) => modifiers.push(s),
14261
14262                    Token::Comma => {
14263                        continue;
14264                    }
14265                    Token::RParen => {
14266                        break;
14267                    }
14268                    _ => self.expected("type modifiers", next_token)?,
14269                }
14270            }
14271
14272            Ok(Some(modifiers))
14273        } else {
14274            Ok(None)
14275        }
14276    }
14277
14278    /// Parse a parenthesized sub data type
14279    fn parse_sub_type<F>(&mut self, parent_type: F) -> Result<DataType, ParserError>
14280    where
14281        F: FnOnce(Box<DataType>) -> DataType,
14282    {
14283        self.expect_token(&Token::LParen)?;
14284        let inside_type = self.parse_data_type()?;
14285        self.expect_token(&Token::RParen)?;
14286        Ok(parent_type(inside_type.into()))
14287    }
14288
14289    /// Parse a DELETE statement, returning a `Box`ed SetExpr
14290    ///
14291    /// This is used to reduce the size of the stack frames in debug builds
14292    fn parse_delete_setexpr_boxed(
14293        &mut self,
14294        delete_token: TokenWithSpan,
14295    ) -> Result<Box<SetExpr>, ParserError> {
14296        Ok(Box::new(SetExpr::Delete(self.parse_delete(delete_token)?)))
14297    }
14298
14299    /// Parse a `DELETE` statement and return `Statement::Delete`.
14300    pub fn parse_delete(&mut self, delete_token: TokenWithSpan) -> Result<Statement, ParserError> {
14301        let optimizer_hints = self.maybe_parse_optimizer_hints()?;
14302        let (tables, with_from_keyword) = if !self.parse_keyword(Keyword::FROM) {
14303            // `FROM` keyword is optional in BigQuery SQL.
14304            // https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#delete_statement
14305            if dialect_of!(self is BigQueryDialect | OracleDialect | GenericDialect) {
14306                (vec![], false)
14307            } else {
14308                let tables = self.parse_comma_separated(|p| p.parse_object_name(false))?;
14309                self.expect_keyword_is(Keyword::FROM)?;
14310                (tables, true)
14311            }
14312        } else {
14313            (vec![], true)
14314        };
14315
14316        let from = self.parse_comma_separated(Parser::parse_table_and_joins)?;
14317
14318        let output = self.maybe_parse_output_clause()?;
14319
14320        let using = if self.parse_keyword(Keyword::USING) {
14321            Some(self.parse_comma_separated(Parser::parse_table_and_joins)?)
14322        } else {
14323            None
14324        };
14325        let selection = if self.parse_keyword(Keyword::WHERE) {
14326            Some(self.parse_expr()?)
14327        } else {
14328            None
14329        };
14330        let returning = if self.parse_keyword(Keyword::RETURNING) {
14331            Some(self.parse_comma_separated(Parser::parse_select_item)?)
14332        } else {
14333            None
14334        };
14335        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
14336            self.parse_comma_separated(Parser::parse_order_by_expr)?
14337        } else {
14338            vec![]
14339        };
14340        let limit = if self.parse_keyword(Keyword::LIMIT) {
14341            self.parse_limit()?
14342        } else {
14343            None
14344        };
14345
14346        Ok(Statement::Delete(Delete {
14347            delete_token: delete_token.into(),
14348            optimizer_hints,
14349            tables,
14350            from: if with_from_keyword {
14351                FromTable::WithFromKeyword(from)
14352            } else {
14353                FromTable::WithoutKeyword(from)
14354            },
14355            using,
14356            selection,
14357            returning,
14358            output,
14359            order_by,
14360            limit,
14361        }))
14362    }
14363
14364    /// Parse a `KILL` statement, optionally specifying `CONNECTION`, `QUERY`, or `MUTATION`.
14365    /// KILL [CONNECTION | QUERY | MUTATION] processlist_id
14366    pub fn parse_kill(&mut self) -> Result<Statement, ParserError> {
14367        let modifier_keyword =
14368            self.parse_one_of_keywords(&[Keyword::CONNECTION, Keyword::QUERY, Keyword::MUTATION]);
14369
14370        let id = self.parse_literal_uint()?;
14371
14372        let modifier = match modifier_keyword {
14373            Some(Keyword::CONNECTION) => Some(KillType::Connection),
14374            Some(Keyword::QUERY) => Some(KillType::Query),
14375            Some(Keyword::MUTATION) => {
14376                if dialect_of!(self is ClickHouseDialect | GenericDialect) {
14377                    Some(KillType::Mutation)
14378                } else {
14379                    self.expected_ref(
14380                        "Unsupported type for KILL, allowed: CONNECTION | QUERY",
14381                        self.peek_token_ref(),
14382                    )?
14383                }
14384            }
14385            _ => None,
14386        };
14387
14388        Ok(Statement::Kill { modifier, id })
14389    }
14390
14391    /// Parse an `EXPLAIN` statement, handling dialect-specific options and modifiers.
14392    pub fn parse_explain(
14393        &mut self,
14394        describe_alias: DescribeAlias,
14395    ) -> Result<Statement, ParserError> {
14396        let mut analyze = false;
14397        let mut verbose = false;
14398        let mut query_plan = false;
14399        let mut estimate = false;
14400        let mut format = None;
14401        let mut options = None;
14402
14403        // Note: DuckDB is compatible with PostgreSQL syntax for this statement,
14404        // although not all features may be implemented.
14405        if describe_alias == DescribeAlias::Explain
14406            && self.dialect.supports_explain_with_utility_options()
14407            && self.peek_token_ref().token == Token::LParen
14408        {
14409            options = Some(self.parse_utility_options()?)
14410        } else if self.parse_keywords(&[Keyword::QUERY, Keyword::PLAN]) {
14411            query_plan = true;
14412        } else if self.parse_keyword(Keyword::ESTIMATE) {
14413            estimate = true;
14414        } else {
14415            analyze = self.parse_keyword(Keyword::ANALYZE);
14416            verbose = self.parse_keyword(Keyword::VERBOSE);
14417            if self.parse_keyword(Keyword::FORMAT) {
14418                format = Some(self.parse_analyze_format_kind()?);
14419            }
14420        }
14421
14422        match self.maybe_parse(|parser| parser.parse_statement())? {
14423            Some(Statement::Explain { .. }) | Some(Statement::ExplainTable { .. }) => Err(
14424                ParserError::ParserError("Explain must be root of the plan".to_string()),
14425            ),
14426            Some(statement) => Ok(Statement::Explain {
14427                describe_alias,
14428                analyze,
14429                verbose,
14430                query_plan,
14431                estimate,
14432                statement: Box::new(statement),
14433                format,
14434                options,
14435            }),
14436            _ => {
14437                let hive_format =
14438                    match self.parse_one_of_keywords(&[Keyword::EXTENDED, Keyword::FORMATTED]) {
14439                        Some(Keyword::EXTENDED) => Some(HiveDescribeFormat::Extended),
14440                        Some(Keyword::FORMATTED) => Some(HiveDescribeFormat::Formatted),
14441                        _ => None,
14442                    };
14443
14444                let has_table_keyword = if self.dialect.describe_requires_table_keyword() {
14445                    // only allow to use TABLE keyword for DESC|DESCRIBE statement
14446                    self.parse_keyword(Keyword::TABLE)
14447                } else {
14448                    false
14449                };
14450
14451                let table_name = self.parse_object_name(false)?;
14452                Ok(Statement::ExplainTable {
14453                    describe_alias,
14454                    hive_format,
14455                    has_table_keyword,
14456                    table_name,
14457                })
14458            }
14459        }
14460    }
14461
14462    /// Parse a query expression, i.e. a `SELECT` statement optionally
14463    /// preceded with some `WITH` CTE declarations and optionally followed
14464    /// by `ORDER BY`. Unlike some other parse_... methods, this one doesn't
14465    /// expect the initial keyword to be already consumed
14466    #[cfg_attr(feature = "recursive-protection", recursive::recursive)]
14467    pub fn parse_query(&mut self) -> Result<Box<Query>, ParserError> {
14468        let _guard = self.recursion_counter.try_decrease()?;
14469        let with = if self.parse_keyword(Keyword::WITH) {
14470            let with_token = self.get_current_token();
14471            Some(With {
14472                with_token: with_token.clone().into(),
14473                recursive: self.parse_keyword(Keyword::RECURSIVE),
14474                cte_tables: self.parse_comma_separated(Parser::parse_cte)?,
14475            })
14476        } else {
14477            None
14478        };
14479        if self.parse_keyword(Keyword::INSERT) {
14480            Ok(Query {
14481                with,
14482                body: self.parse_insert_setexpr_boxed(self.get_current_token().clone())?,
14483                order_by: None,
14484                limit_clause: None,
14485                fetch: None,
14486                locks: vec![],
14487                for_clause: None,
14488                settings: None,
14489                format_clause: None,
14490                pipe_operators: vec![],
14491            }
14492            .into())
14493        } else if self.parse_keyword(Keyword::UPDATE) {
14494            Ok(Query {
14495                with,
14496                body: self.parse_update_setexpr_boxed(self.get_current_token().clone())?,
14497                order_by: None,
14498                limit_clause: None,
14499                fetch: None,
14500                locks: vec![],
14501                for_clause: None,
14502                settings: None,
14503                format_clause: None,
14504                pipe_operators: vec![],
14505            }
14506            .into())
14507        } else if self.parse_keyword(Keyword::DELETE) {
14508            Ok(Query {
14509                with,
14510                body: self.parse_delete_setexpr_boxed(self.get_current_token().clone())?,
14511                limit_clause: None,
14512                order_by: None,
14513                fetch: None,
14514                locks: vec![],
14515                for_clause: None,
14516                settings: None,
14517                format_clause: None,
14518                pipe_operators: vec![],
14519            }
14520            .into())
14521        } else if self.parse_keyword(Keyword::MERGE) {
14522            Ok(Query {
14523                with,
14524                body: self.parse_merge_setexpr_boxed(self.get_current_token().clone())?,
14525                limit_clause: None,
14526                order_by: None,
14527                fetch: None,
14528                locks: vec![],
14529                for_clause: None,
14530                settings: None,
14531                format_clause: None,
14532                pipe_operators: vec![],
14533            }
14534            .into())
14535        } else {
14536            let body = self.parse_query_body(self.dialect.prec_unknown())?;
14537
14538            let order_by = self.parse_optional_order_by()?;
14539
14540            let limit_clause = self.parse_optional_limit_clause()?;
14541
14542            let settings = self.parse_settings()?;
14543
14544            let fetch = if self.parse_keyword(Keyword::FETCH) {
14545                Some(self.parse_fetch()?)
14546            } else {
14547                None
14548            };
14549
14550            let mut for_clause = None;
14551            let mut locks = Vec::new();
14552            while self.parse_keyword(Keyword::FOR) {
14553                if let Some(parsed_for_clause) = self.parse_for_clause()? {
14554                    for_clause = Some(parsed_for_clause);
14555                    break;
14556                } else {
14557                    locks.push(self.parse_lock()?);
14558                }
14559            }
14560            let format_clause =
14561                if self.dialect.supports_select_format() && self.parse_keyword(Keyword::FORMAT) {
14562                    if self.parse_keyword(Keyword::NULL) {
14563                        Some(FormatClause::Null)
14564                    } else {
14565                        let ident = self.parse_identifier()?;
14566                        Some(FormatClause::Identifier(ident))
14567                    }
14568                } else {
14569                    None
14570                };
14571
14572            let pipe_operators = if self.dialect.supports_pipe_operator() {
14573                self.parse_pipe_operators()?
14574            } else {
14575                Vec::new()
14576            };
14577
14578            Ok(Query {
14579                with,
14580                body,
14581                order_by,
14582                limit_clause,
14583                fetch,
14584                locks,
14585                for_clause,
14586                settings,
14587                format_clause,
14588                pipe_operators,
14589            }
14590            .into())
14591        }
14592    }
14593
14594    fn parse_pipe_operators(&mut self) -> Result<Vec<PipeOperator>, ParserError> {
14595        let mut pipe_operators = Vec::new();
14596
14597        while self.consume_token(&Token::VerticalBarRightAngleBracket) {
14598            let kw = self.expect_one_of_keywords(&[
14599                Keyword::SELECT,
14600                Keyword::EXTEND,
14601                Keyword::SET,
14602                Keyword::DROP,
14603                Keyword::AS,
14604                Keyword::WHERE,
14605                Keyword::LIMIT,
14606                Keyword::AGGREGATE,
14607                Keyword::ORDER,
14608                Keyword::TABLESAMPLE,
14609                Keyword::RENAME,
14610                Keyword::UNION,
14611                Keyword::INTERSECT,
14612                Keyword::EXCEPT,
14613                Keyword::CALL,
14614                Keyword::PIVOT,
14615                Keyword::UNPIVOT,
14616                Keyword::JOIN,
14617                Keyword::INNER,
14618                Keyword::LEFT,
14619                Keyword::RIGHT,
14620                Keyword::FULL,
14621                Keyword::CROSS,
14622            ])?;
14623            match kw {
14624                Keyword::SELECT => {
14625                    let exprs = self.parse_comma_separated(Parser::parse_select_item)?;
14626                    pipe_operators.push(PipeOperator::Select { exprs })
14627                }
14628                Keyword::EXTEND => {
14629                    let exprs = self.parse_comma_separated(Parser::parse_select_item)?;
14630                    pipe_operators.push(PipeOperator::Extend { exprs })
14631                }
14632                Keyword::SET => {
14633                    let assignments = self.parse_comma_separated(Parser::parse_assignment)?;
14634                    pipe_operators.push(PipeOperator::Set { assignments })
14635                }
14636                Keyword::DROP => {
14637                    let columns = self.parse_identifiers()?;
14638                    pipe_operators.push(PipeOperator::Drop { columns })
14639                }
14640                Keyword::AS => {
14641                    let alias = self.parse_identifier()?;
14642                    pipe_operators.push(PipeOperator::As { alias })
14643                }
14644                Keyword::WHERE => {
14645                    let expr = self.parse_expr()?;
14646                    pipe_operators.push(PipeOperator::Where { expr })
14647                }
14648                Keyword::LIMIT => {
14649                    let expr = self.parse_expr()?;
14650                    let offset = if self.parse_keyword(Keyword::OFFSET) {
14651                        Some(self.parse_expr()?)
14652                    } else {
14653                        None
14654                    };
14655                    pipe_operators.push(PipeOperator::Limit { expr, offset })
14656                }
14657                Keyword::AGGREGATE => {
14658                    let full_table_exprs = if self.peek_keyword(Keyword::GROUP) {
14659                        vec![]
14660                    } else {
14661                        self.parse_comma_separated(|parser| {
14662                            parser.parse_expr_with_alias_and_order_by()
14663                        })?
14664                    };
14665
14666                    let group_by_expr = if self.parse_keywords(&[Keyword::GROUP, Keyword::BY]) {
14667                        self.parse_comma_separated(|parser| {
14668                            parser.parse_expr_with_alias_and_order_by()
14669                        })?
14670                    } else {
14671                        vec![]
14672                    };
14673
14674                    pipe_operators.push(PipeOperator::Aggregate {
14675                        full_table_exprs,
14676                        group_by_expr,
14677                    })
14678                }
14679                Keyword::ORDER => {
14680                    self.expect_one_of_keywords(&[Keyword::BY])?;
14681                    let exprs = self.parse_comma_separated(Parser::parse_order_by_expr)?;
14682                    pipe_operators.push(PipeOperator::OrderBy { exprs })
14683                }
14684                Keyword::TABLESAMPLE => {
14685                    let sample = self.parse_table_sample(TableSampleModifier::TableSample)?;
14686                    pipe_operators.push(PipeOperator::TableSample { sample });
14687                }
14688                Keyword::RENAME => {
14689                    let mappings =
14690                        self.parse_comma_separated(Parser::parse_identifier_with_optional_alias)?;
14691                    pipe_operators.push(PipeOperator::Rename { mappings });
14692                }
14693                Keyword::UNION => {
14694                    let set_quantifier = self.parse_set_quantifier(&Some(SetOperator::Union));
14695                    let queries = self.parse_pipe_operator_queries()?;
14696                    pipe_operators.push(PipeOperator::Union {
14697                        set_quantifier,
14698                        queries,
14699                    });
14700                }
14701                Keyword::INTERSECT => {
14702                    let set_quantifier =
14703                        self.parse_distinct_required_set_quantifier("INTERSECT")?;
14704                    let queries = self.parse_pipe_operator_queries()?;
14705                    pipe_operators.push(PipeOperator::Intersect {
14706                        set_quantifier,
14707                        queries,
14708                    });
14709                }
14710                Keyword::EXCEPT => {
14711                    let set_quantifier = self.parse_distinct_required_set_quantifier("EXCEPT")?;
14712                    let queries = self.parse_pipe_operator_queries()?;
14713                    pipe_operators.push(PipeOperator::Except {
14714                        set_quantifier,
14715                        queries,
14716                    });
14717                }
14718                Keyword::CALL => {
14719                    let function_name = self.parse_object_name(false)?;
14720                    let function_expr = self.parse_function(function_name)?;
14721                    if let Expr::Function(function) = function_expr {
14722                        let alias = self.parse_identifier_optional_alias()?;
14723                        pipe_operators.push(PipeOperator::Call { function, alias });
14724                    } else {
14725                        return Err(ParserError::ParserError(
14726                            "Expected function call after CALL".to_string(),
14727                        ));
14728                    }
14729                }
14730                Keyword::PIVOT => {
14731                    self.expect_token(&Token::LParen)?;
14732                    let aggregate_functions =
14733                        self.parse_comma_separated(Self::parse_pivot_aggregate_function)?;
14734                    self.expect_keyword_is(Keyword::FOR)?;
14735                    let value_column = self.parse_period_separated(|p| p.parse_identifier())?;
14736                    self.expect_keyword_is(Keyword::IN)?;
14737
14738                    self.expect_token(&Token::LParen)?;
14739                    let value_source = if self.parse_keyword(Keyword::ANY) {
14740                        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
14741                            self.parse_comma_separated(Parser::parse_order_by_expr)?
14742                        } else {
14743                            vec![]
14744                        };
14745                        PivotValueSource::Any(order_by)
14746                    } else if self.peek_sub_query() {
14747                        PivotValueSource::Subquery(self.parse_query()?)
14748                    } else {
14749                        PivotValueSource::List(
14750                            self.parse_comma_separated(Self::parse_expr_with_alias)?,
14751                        )
14752                    };
14753                    self.expect_token(&Token::RParen)?;
14754                    self.expect_token(&Token::RParen)?;
14755
14756                    let alias = self.parse_identifier_optional_alias()?;
14757
14758                    pipe_operators.push(PipeOperator::Pivot {
14759                        aggregate_functions,
14760                        value_column,
14761                        value_source,
14762                        alias,
14763                    });
14764                }
14765                Keyword::UNPIVOT => {
14766                    self.expect_token(&Token::LParen)?;
14767                    let value_column = self.parse_identifier()?;
14768                    self.expect_keyword(Keyword::FOR)?;
14769                    let name_column = self.parse_identifier()?;
14770                    self.expect_keyword(Keyword::IN)?;
14771
14772                    self.expect_token(&Token::LParen)?;
14773                    let unpivot_columns = self.parse_comma_separated(Parser::parse_identifier)?;
14774                    self.expect_token(&Token::RParen)?;
14775
14776                    self.expect_token(&Token::RParen)?;
14777
14778                    let alias = self.parse_identifier_optional_alias()?;
14779
14780                    pipe_operators.push(PipeOperator::Unpivot {
14781                        value_column,
14782                        name_column,
14783                        unpivot_columns,
14784                        alias,
14785                    });
14786                }
14787                Keyword::JOIN
14788                | Keyword::INNER
14789                | Keyword::LEFT
14790                | Keyword::RIGHT
14791                | Keyword::FULL
14792                | Keyword::CROSS => {
14793                    self.prev_token();
14794                    let mut joins = self.parse_joins()?;
14795                    if joins.len() != 1 {
14796                        return Err(ParserError::ParserError(
14797                            "Join pipe operator must have a single join".to_string(),
14798                        ));
14799                    }
14800                    let join = joins.swap_remove(0);
14801                    pipe_operators.push(PipeOperator::Join(join))
14802                }
14803                unhandled => {
14804                    return Err(ParserError::ParserError(format!(
14805                    "`expect_one_of_keywords` further up allowed unhandled keyword: {unhandled:?}"
14806                )))
14807                }
14808            }
14809        }
14810        Ok(pipe_operators)
14811    }
14812
14813    fn parse_settings(&mut self) -> Result<Option<Vec<Setting>>, ParserError> {
14814        let settings = if self.dialect.supports_settings() && self.parse_keyword(Keyword::SETTINGS)
14815        {
14816            let key_values = self.parse_comma_separated(|p| {
14817                let key = p.parse_identifier()?;
14818                p.expect_token(&Token::Eq)?;
14819                let value = p.parse_expr()?;
14820                Ok(Setting { key, value })
14821            })?;
14822            Some(key_values)
14823        } else {
14824            None
14825        };
14826        Ok(settings)
14827    }
14828
14829    /// Parse a mssql `FOR [XML | JSON | BROWSE]` clause
14830    pub fn parse_for_clause(&mut self) -> Result<Option<ForClause>, ParserError> {
14831        if self.parse_keyword(Keyword::XML) {
14832            Ok(Some(self.parse_for_xml()?))
14833        } else if self.parse_keyword(Keyword::JSON) {
14834            Ok(Some(self.parse_for_json()?))
14835        } else if self.parse_keyword(Keyword::BROWSE) {
14836            Ok(Some(ForClause::Browse))
14837        } else {
14838            Ok(None)
14839        }
14840    }
14841
14842    /// Parse a mssql `FOR XML` clause
14843    pub fn parse_for_xml(&mut self) -> Result<ForClause, ParserError> {
14844        let for_xml = if self.parse_keyword(Keyword::RAW) {
14845            let mut element_name = None;
14846            if self.peek_token_ref().token == Token::LParen {
14847                self.expect_token(&Token::LParen)?;
14848                element_name = Some(self.parse_literal_string()?);
14849                self.expect_token(&Token::RParen)?;
14850            }
14851            ForXml::Raw(element_name)
14852        } else if self.parse_keyword(Keyword::AUTO) {
14853            ForXml::Auto
14854        } else if self.parse_keyword(Keyword::EXPLICIT) {
14855            ForXml::Explicit
14856        } else if self.parse_keyword(Keyword::PATH) {
14857            let mut element_name = None;
14858            if self.peek_token_ref().token == Token::LParen {
14859                self.expect_token(&Token::LParen)?;
14860                element_name = Some(self.parse_literal_string()?);
14861                self.expect_token(&Token::RParen)?;
14862            }
14863            ForXml::Path(element_name)
14864        } else {
14865            return Err(ParserError::ParserError(
14866                "Expected FOR XML [RAW | AUTO | EXPLICIT | PATH ]".to_string(),
14867            ));
14868        };
14869        let mut elements = false;
14870        let mut binary_base64 = false;
14871        let mut root = None;
14872        let mut r#type = false;
14873        while self.peek_token_ref().token == Token::Comma {
14874            self.next_token();
14875            if self.parse_keyword(Keyword::ELEMENTS) {
14876                elements = true;
14877            } else if self.parse_keyword(Keyword::BINARY) {
14878                self.expect_keyword_is(Keyword::BASE64)?;
14879                binary_base64 = true;
14880            } else if self.parse_keyword(Keyword::ROOT) {
14881                self.expect_token(&Token::LParen)?;
14882                root = Some(self.parse_literal_string()?);
14883                self.expect_token(&Token::RParen)?;
14884            } else if self.parse_keyword(Keyword::TYPE) {
14885                r#type = true;
14886            }
14887        }
14888        Ok(ForClause::Xml {
14889            for_xml,
14890            elements,
14891            binary_base64,
14892            root,
14893            r#type,
14894        })
14895    }
14896
14897    /// Parse a mssql `FOR JSON` clause
14898    pub fn parse_for_json(&mut self) -> Result<ForClause, ParserError> {
14899        let for_json = if self.parse_keyword(Keyword::AUTO) {
14900            ForJson::Auto
14901        } else if self.parse_keyword(Keyword::PATH) {
14902            ForJson::Path
14903        } else {
14904            return Err(ParserError::ParserError(
14905                "Expected FOR JSON [AUTO | PATH ]".to_string(),
14906            ));
14907        };
14908        let mut root = None;
14909        let mut include_null_values = false;
14910        let mut without_array_wrapper = false;
14911        while self.peek_token_ref().token == Token::Comma {
14912            self.next_token();
14913            if self.parse_keyword(Keyword::ROOT) {
14914                self.expect_token(&Token::LParen)?;
14915                root = Some(self.parse_literal_string()?);
14916                self.expect_token(&Token::RParen)?;
14917            } else if self.parse_keyword(Keyword::INCLUDE_NULL_VALUES) {
14918                include_null_values = true;
14919            } else if self.parse_keyword(Keyword::WITHOUT_ARRAY_WRAPPER) {
14920                without_array_wrapper = true;
14921            }
14922        }
14923        Ok(ForClause::Json {
14924            for_json,
14925            root,
14926            include_null_values,
14927            without_array_wrapper,
14928        })
14929    }
14930
14931    /// Parse a CTE (`alias [( col1, col2, ... )] [AS] (subquery)`)
14932    pub fn parse_cte(&mut self) -> Result<Cte, ParserError> {
14933        let name = self.parse_identifier()?;
14934
14935        let as_optional = self.dialect.supports_cte_without_as();
14936
14937        // If AS is optional, first try to parse `name (query)` directly
14938        if as_optional && !self.peek_keyword(Keyword::AS) {
14939            if let Some((query, closing_paren_token)) = self.maybe_parse(|p| {
14940                p.expect_token(&Token::LParen)?;
14941                let query = p.parse_query()?;
14942                let closing_paren_token = p.expect_token(&Token::RParen)?;
14943                Ok((query, closing_paren_token))
14944            })? {
14945                let mut cte = Cte {
14946                    alias: TableAlias {
14947                        explicit: false,
14948                        name,
14949                        columns: vec![],
14950                    },
14951                    query,
14952                    from: None,
14953                    materialized: None,
14954                    closing_paren_token: closing_paren_token.into(),
14955                };
14956                if self.parse_keyword(Keyword::FROM) {
14957                    cte.from = Some(self.parse_identifier()?);
14958                }
14959                return Ok(cte);
14960            }
14961        }
14962
14963        // Determine column definitions and consume AS
14964        let columns = if self.parse_keyword(Keyword::AS) {
14965            vec![]
14966        } else {
14967            let columns = self.parse_table_alias_column_defs()?;
14968            if as_optional {
14969                let _ = self.parse_keyword(Keyword::AS);
14970            } else {
14971                self.expect_keyword_is(Keyword::AS)?;
14972            }
14973            columns
14974        };
14975
14976        let mut is_materialized = None;
14977        if dialect_of!(self is PostgreSqlDialect) {
14978            if self.parse_keyword(Keyword::MATERIALIZED) {
14979                is_materialized = Some(CteAsMaterialized::Materialized);
14980            } else if self.parse_keywords(&[Keyword::NOT, Keyword::MATERIALIZED]) {
14981                is_materialized = Some(CteAsMaterialized::NotMaterialized);
14982            }
14983        }
14984
14985        self.expect_token(&Token::LParen)?;
14986        let query = self.parse_query()?;
14987        let closing_paren_token = self.expect_token(&Token::RParen)?;
14988
14989        let mut cte = Cte {
14990            alias: TableAlias {
14991                explicit: false,
14992                name,
14993                columns,
14994            },
14995            query,
14996            from: None,
14997            materialized: is_materialized,
14998            closing_paren_token: closing_paren_token.into(),
14999        };
15000        if self.dialect.supports_from_first_insert() && self.parse_keyword(Keyword::FROM) {
15001            cte.from = Some(self.parse_identifier()?);
15002        }
15003        Ok(cte)
15004    }
15005
15006    /// Parse a "query body", which is an expression with roughly the
15007    /// following grammar:
15008    /// ```sql
15009    ///   query_body ::= restricted_select | '(' subquery ')' | set_operation
15010    ///   restricted_select ::= 'SELECT' [expr_list] [ from ] [ where ] [ groupby_having ]
15011    ///   subquery ::= query_body [ order_by_limit ]
15012    ///   set_operation ::= query_body { 'UNION' | 'EXCEPT' | 'INTERSECT' } [ 'ALL' ] query_body
15013    /// ```
15014    pub fn parse_query_body(&mut self, precedence: u8) -> Result<Box<SetExpr>, ParserError> {
15015        // We parse the expression using a Pratt parser, as in `parse_expr()`.
15016        // Start by parsing a restricted SELECT or a `(subquery)`:
15017        let expr = if self.peek_keyword(Keyword::SELECT)
15018            || (self.peek_keyword(Keyword::FROM) && self.dialect.supports_from_first_select())
15019        {
15020            SetExpr::Select(self.parse_select().map(Box::new)?)
15021        } else if self.consume_token(&Token::LParen) {
15022            // CTEs are not allowed here, but the parser currently accepts them
15023            let subquery = self.parse_query()?;
15024            self.expect_token(&Token::RParen)?;
15025            SetExpr::Query(subquery)
15026        } else if self.parse_keyword(Keyword::VALUES) {
15027            let is_mysql = dialect_of!(self is MySqlDialect);
15028            SetExpr::Values(self.parse_values(is_mysql, false)?)
15029        } else if self.parse_keyword(Keyword::VALUE) {
15030            let is_mysql = dialect_of!(self is MySqlDialect);
15031            SetExpr::Values(self.parse_values(is_mysql, true)?)
15032        } else if self.parse_keyword(Keyword::TABLE) {
15033            SetExpr::Table(Box::new(self.parse_as_table()?))
15034        } else {
15035            return self.expected_ref(
15036                "SELECT, VALUES, or a subquery in the query body",
15037                self.peek_token_ref(),
15038            );
15039        };
15040
15041        self.parse_remaining_set_exprs(expr, precedence)
15042    }
15043
15044    /// Parse any extra set expressions that may be present in a query body
15045    ///
15046    /// (this is its own function to reduce required stack size in debug builds)
15047    fn parse_remaining_set_exprs(
15048        &mut self,
15049        mut expr: SetExpr,
15050        precedence: u8,
15051    ) -> Result<Box<SetExpr>, ParserError> {
15052        loop {
15053            // The query can be optionally followed by a set operator:
15054            let op = self.parse_set_operator(&self.peek_token().token);
15055            let next_precedence = match op {
15056                // UNION and EXCEPT have the same binding power and evaluate left-to-right
15057                Some(SetOperator::Union) | Some(SetOperator::Except) | Some(SetOperator::Minus) => {
15058                    10
15059                }
15060                // INTERSECT has higher precedence than UNION/EXCEPT
15061                Some(SetOperator::Intersect) => 20,
15062                // Unexpected token or EOF => stop parsing the query body
15063                None => break,
15064            };
15065            if precedence >= next_precedence {
15066                break;
15067            }
15068            self.next_token(); // skip past the set operator
15069            let set_quantifier = self.parse_set_quantifier(&op);
15070            expr = SetExpr::SetOperation {
15071                left: Box::new(expr),
15072                op: op.unwrap(),
15073                set_quantifier,
15074                right: self.parse_query_body(next_precedence)?,
15075            };
15076        }
15077
15078        Ok(expr.into())
15079    }
15080
15081    /// Parse a set operator token into its `SetOperator` variant.
15082    pub fn parse_set_operator(&mut self, token: &Token) -> Option<SetOperator> {
15083        match token {
15084            Token::Word(w) if w.keyword == Keyword::UNION => Some(SetOperator::Union),
15085            Token::Word(w) if w.keyword == Keyword::EXCEPT => Some(SetOperator::Except),
15086            Token::Word(w) if w.keyword == Keyword::INTERSECT => Some(SetOperator::Intersect),
15087            Token::Word(w) if w.keyword == Keyword::MINUS => Some(SetOperator::Minus),
15088            _ => None,
15089        }
15090    }
15091
15092    /// Parse a set quantifier (e.g., `ALL`, `DISTINCT BY NAME`) for the given set operator.
15093    pub fn parse_set_quantifier(&mut self, op: &Option<SetOperator>) -> SetQuantifier {
15094        match op {
15095            Some(
15096                SetOperator::Except
15097                | SetOperator::Intersect
15098                | SetOperator::Union
15099                | SetOperator::Minus,
15100            ) => {
15101                if self.parse_keywords(&[Keyword::DISTINCT, Keyword::BY, Keyword::NAME]) {
15102                    SetQuantifier::DistinctByName
15103                } else if self.parse_keywords(&[Keyword::BY, Keyword::NAME]) {
15104                    SetQuantifier::ByName
15105                } else if self.parse_keyword(Keyword::ALL) {
15106                    if self.parse_keywords(&[Keyword::BY, Keyword::NAME]) {
15107                        SetQuantifier::AllByName
15108                    } else {
15109                        SetQuantifier::All
15110                    }
15111                } else if self.parse_keyword(Keyword::DISTINCT) {
15112                    SetQuantifier::Distinct
15113                } else {
15114                    SetQuantifier::None
15115                }
15116            }
15117            _ => SetQuantifier::None,
15118        }
15119    }
15120
15121    /// Parse a restricted `SELECT` statement (no CTEs / `UNION` / `ORDER BY`)
15122    pub fn parse_select(&mut self) -> Result<Select, ParserError> {
15123        let mut from_first = None;
15124
15125        if self.dialect.supports_from_first_select() && self.peek_keyword(Keyword::FROM) {
15126            let from_token = self.expect_keyword(Keyword::FROM)?;
15127            let from = self.parse_table_with_joins()?;
15128            if !self.peek_keyword(Keyword::SELECT) {
15129                return Ok(Select {
15130                    select_token: AttachedToken(from_token),
15131                    optimizer_hints: vec![],
15132                    distinct: None,
15133                    select_modifiers: None,
15134                    top: None,
15135                    top_before_distinct: false,
15136                    projection: vec![],
15137                    exclude: None,
15138                    into: None,
15139                    from,
15140                    lateral_views: vec![],
15141                    prewhere: None,
15142                    selection: None,
15143                    group_by: GroupByExpr::Expressions(vec![], vec![]),
15144                    cluster_by: vec![],
15145                    distribute_by: vec![],
15146                    sort_by: vec![],
15147                    having: None,
15148                    named_window: vec![],
15149                    window_before_qualify: false,
15150                    qualify: None,
15151                    value_table_mode: None,
15152                    connect_by: vec![],
15153                    flavor: SelectFlavor::FromFirstNoSelect,
15154                });
15155            }
15156            from_first = Some(from);
15157        }
15158
15159        let select_token = self.expect_keyword(Keyword::SELECT)?;
15160        let optimizer_hints = self.maybe_parse_optimizer_hints()?;
15161        let value_table_mode = self.parse_value_table_mode()?;
15162
15163        let (select_modifiers, distinct_select_modifier) =
15164            if self.dialect.supports_select_modifiers() {
15165                self.parse_select_modifiers()?
15166            } else {
15167                (None, None)
15168            };
15169
15170        let mut top_before_distinct = false;
15171        let mut top = None;
15172        if self.dialect.supports_top_before_distinct() && self.parse_keyword(Keyword::TOP) {
15173            top = Some(self.parse_top()?);
15174            top_before_distinct = true;
15175        }
15176
15177        let distinct = if distinct_select_modifier.is_some() {
15178            distinct_select_modifier
15179        } else {
15180            self.parse_all_or_distinct()?
15181        };
15182
15183        if !self.dialect.supports_top_before_distinct() && self.parse_keyword(Keyword::TOP) {
15184            top = Some(self.parse_top()?);
15185        }
15186
15187        let projection =
15188            if self.dialect.supports_empty_projections() && self.peek_keyword(Keyword::FROM) {
15189                vec![]
15190            } else {
15191                self.parse_projection()?
15192            };
15193
15194        let exclude = if self.dialect.supports_select_exclude() {
15195            self.parse_optional_select_item_exclude()?
15196        } else {
15197            None
15198        };
15199
15200        let into = if self.parse_keyword(Keyword::INTO) {
15201            Some(self.parse_select_into()?)
15202        } else {
15203            None
15204        };
15205
15206        // Note that for keywords to be properly handled here, they need to be
15207        // added to `RESERVED_FOR_COLUMN_ALIAS` / `RESERVED_FOR_TABLE_ALIAS`,
15208        // otherwise they may be parsed as an alias as part of the `projection`
15209        // or `from`.
15210
15211        let (from, from_first) = if let Some(from) = from_first.take() {
15212            (from, true)
15213        } else if self.parse_keyword(Keyword::FROM) {
15214            (self.parse_table_with_joins()?, false)
15215        } else {
15216            (vec![], false)
15217        };
15218
15219        let mut lateral_views = vec![];
15220        loop {
15221            if self.parse_keywords(&[Keyword::LATERAL, Keyword::VIEW]) {
15222                let outer = self.parse_keyword(Keyword::OUTER);
15223                let lateral_view = self.parse_expr()?;
15224                let lateral_view_name = self.parse_object_name(false)?;
15225                let lateral_col_alias = self
15226                    .parse_comma_separated(|parser| {
15227                        parser.parse_optional_alias(&[
15228                            Keyword::WHERE,
15229                            Keyword::GROUP,
15230                            Keyword::CLUSTER,
15231                            Keyword::HAVING,
15232                            Keyword::LATERAL,
15233                        ]) // This couldn't possibly be a bad idea
15234                    })?
15235                    .into_iter()
15236                    .flatten()
15237                    .collect();
15238
15239                lateral_views.push(LateralView {
15240                    lateral_view,
15241                    lateral_view_name,
15242                    lateral_col_alias,
15243                    outer,
15244                });
15245            } else {
15246                break;
15247            }
15248        }
15249
15250        let prewhere = if self.dialect.supports_prewhere() && self.parse_keyword(Keyword::PREWHERE)
15251        {
15252            Some(self.parse_expr()?)
15253        } else {
15254            None
15255        };
15256
15257        let selection = if self.parse_keyword(Keyword::WHERE) {
15258            Some(self.parse_expr()?)
15259        } else {
15260            None
15261        };
15262
15263        let connect_by = self.maybe_parse_connect_by()?;
15264
15265        let group_by = self
15266            .parse_optional_group_by()?
15267            .unwrap_or_else(|| GroupByExpr::Expressions(vec![], vec![]));
15268
15269        let cluster_by = if self.parse_keywords(&[Keyword::CLUSTER, Keyword::BY]) {
15270            self.parse_comma_separated(Parser::parse_expr)?
15271        } else {
15272            vec![]
15273        };
15274
15275        let distribute_by = if self.parse_keywords(&[Keyword::DISTRIBUTE, Keyword::BY]) {
15276            self.parse_comma_separated(Parser::parse_expr)?
15277        } else {
15278            vec![]
15279        };
15280
15281        let sort_by = if self.parse_keywords(&[Keyword::SORT, Keyword::BY]) {
15282            self.parse_comma_separated(Parser::parse_order_by_expr)?
15283        } else {
15284            vec![]
15285        };
15286
15287        let having = if self.parse_keyword(Keyword::HAVING) {
15288            Some(self.parse_expr()?)
15289        } else {
15290            None
15291        };
15292
15293        // Accept QUALIFY and WINDOW in any order and flag accordingly.
15294        let (named_windows, qualify, window_before_qualify) = if self.parse_keyword(Keyword::WINDOW)
15295        {
15296            let named_windows = self.parse_comma_separated(Parser::parse_named_window)?;
15297            if self.parse_keyword(Keyword::QUALIFY) {
15298                (named_windows, Some(self.parse_expr()?), true)
15299            } else {
15300                (named_windows, None, true)
15301            }
15302        } else if self.parse_keyword(Keyword::QUALIFY) {
15303            let qualify = Some(self.parse_expr()?);
15304            if self.parse_keyword(Keyword::WINDOW) {
15305                (
15306                    self.parse_comma_separated(Parser::parse_named_window)?,
15307                    qualify,
15308                    false,
15309                )
15310            } else {
15311                (Default::default(), qualify, false)
15312            }
15313        } else {
15314            Default::default()
15315        };
15316
15317        Ok(Select {
15318            select_token: AttachedToken(select_token),
15319            optimizer_hints,
15320            distinct,
15321            select_modifiers,
15322            top,
15323            top_before_distinct,
15324            projection,
15325            exclude,
15326            into,
15327            from,
15328            lateral_views,
15329            prewhere,
15330            selection,
15331            group_by,
15332            cluster_by,
15333            distribute_by,
15334            sort_by,
15335            having,
15336            named_window: named_windows,
15337            window_before_qualify,
15338            qualify,
15339            value_table_mode,
15340            connect_by,
15341            flavor: if from_first {
15342                SelectFlavor::FromFirst
15343            } else {
15344                SelectFlavor::Standard
15345            },
15346        })
15347    }
15348
15349    /// Parses optimizer hints at the current token position.
15350    ///
15351    /// Collects all `/*prefix+...*/` and `--prefix+...` patterns.
15352    /// The `prefix` is any run of ASCII alphanumeric characters between the
15353    /// comment marker and `+` (e.g. `""` for `/*+...*/`, `"abc"` for `/*abc+...*/`).
15354    ///
15355    /// [MySQL](https://dev.mysql.com/doc/refman/8.4/en/optimizer-hints.html#optimizer-hints-overview)
15356    /// [Oracle](https://docs.oracle.com/en/database/oracle/oracle-database/21/sqlrf/Comments.html#GUID-D316D545-89E2-4D54-977F-FC97815CD62E)
15357    fn maybe_parse_optimizer_hints(&mut self) -> Result<Vec<OptimizerHint>, ParserError> {
15358        let supports_hints = self.dialect.supports_comment_optimizer_hint();
15359        if !supports_hints {
15360            return Ok(vec![]);
15361        }
15362        let mut hints = vec![];
15363        loop {
15364            let t = self.peek_nth_token_no_skip_ref(0);
15365            let Token::Whitespace(ws) = &t.token else {
15366                break;
15367            };
15368            match ws {
15369                Whitespace::SingleLineComment { comment, prefix } => {
15370                    if let Some((hint_prefix, text)) = Self::extract_hint_prefix_and_text(comment) {
15371                        hints.push(OptimizerHint {
15372                            prefix: hint_prefix,
15373                            text,
15374                            style: OptimizerHintStyle::SingleLine {
15375                                prefix: prefix.clone(),
15376                            },
15377                        });
15378                    }
15379                    self.next_token_no_skip();
15380                }
15381                Whitespace::MultiLineComment(comment) => {
15382                    if let Some((hint_prefix, text)) = Self::extract_hint_prefix_and_text(comment) {
15383                        hints.push(OptimizerHint {
15384                            prefix: hint_prefix,
15385                            text,
15386                            style: OptimizerHintStyle::MultiLine,
15387                        });
15388                    }
15389                    self.next_token_no_skip();
15390                }
15391                Whitespace::Space | Whitespace::Tab | Whitespace::Newline => {
15392                    self.next_token_no_skip();
15393                }
15394            }
15395        }
15396        Ok(hints)
15397    }
15398
15399    /// Checks if a comment's content starts with `[ASCII-alphanumeric]*+`
15400    /// and returns `(prefix, text_after_plus)` if so.
15401    fn extract_hint_prefix_and_text(comment: &str) -> Option<(String, String)> {
15402        let (before_plus, text) = comment.split_once('+')?;
15403        if before_plus.chars().all(|c| c.is_ascii_alphanumeric()) {
15404            Some((before_plus.to_string(), text.to_string()))
15405        } else {
15406            None
15407        }
15408    }
15409
15410    /// Parses MySQL SELECT modifiers and DISTINCT/ALL in any order.
15411    ///
15412    /// Manual testing shows odifiers can appear in any order, and modifiers other than DISTINCT/ALL
15413    /// can be repeated.
15414    ///
15415    /// <https://dev.mysql.com/doc/refman/8.4/en/select.html>
15416    fn parse_select_modifiers(
15417        &mut self,
15418    ) -> Result<(Option<SelectModifiers>, Option<Distinct>), ParserError> {
15419        let mut modifiers = SelectModifiers::default();
15420        let mut distinct = None;
15421
15422        let keywords = &[
15423            Keyword::ALL,
15424            Keyword::DISTINCT,
15425            Keyword::DISTINCTROW,
15426            Keyword::HIGH_PRIORITY,
15427            Keyword::STRAIGHT_JOIN,
15428            Keyword::SQL_SMALL_RESULT,
15429            Keyword::SQL_BIG_RESULT,
15430            Keyword::SQL_BUFFER_RESULT,
15431            Keyword::SQL_NO_CACHE,
15432            Keyword::SQL_CALC_FOUND_ROWS,
15433        ];
15434
15435        while let Some(keyword) = self.parse_one_of_keywords(keywords) {
15436            match keyword {
15437                Keyword::ALL | Keyword::DISTINCT if distinct.is_none() => {
15438                    self.prev_token();
15439                    distinct = self.parse_all_or_distinct()?;
15440                }
15441                // DISTINCTROW is a MySQL-specific legacy (but not deprecated) alias for DISTINCT
15442                Keyword::DISTINCTROW if distinct.is_none() => {
15443                    distinct = Some(Distinct::Distinct);
15444                }
15445                Keyword::HIGH_PRIORITY => modifiers.high_priority = true,
15446                Keyword::STRAIGHT_JOIN => modifiers.straight_join = true,
15447                Keyword::SQL_SMALL_RESULT => modifiers.sql_small_result = true,
15448                Keyword::SQL_BIG_RESULT => modifiers.sql_big_result = true,
15449                Keyword::SQL_BUFFER_RESULT => modifiers.sql_buffer_result = true,
15450                Keyword::SQL_NO_CACHE => modifiers.sql_no_cache = true,
15451                Keyword::SQL_CALC_FOUND_ROWS => modifiers.sql_calc_found_rows = true,
15452                _ => {
15453                    self.prev_token();
15454                    return self.expected_ref(
15455                        "HIGH_PRIORITY, STRAIGHT_JOIN, or other MySQL select modifier",
15456                        self.peek_token_ref(),
15457                    );
15458                }
15459            }
15460        }
15461
15462        // Avoid polluting the AST with `Some(SelectModifiers::default())` empty value unless there
15463        // actually were some modifiers set.
15464        let select_modifiers = if modifiers.is_any_set() {
15465            Some(modifiers)
15466        } else {
15467            None
15468        };
15469        Ok((select_modifiers, distinct))
15470    }
15471
15472    fn parse_value_table_mode(&mut self) -> Result<Option<ValueTableMode>, ParserError> {
15473        if !dialect_of!(self is BigQueryDialect) {
15474            return Ok(None);
15475        }
15476
15477        let mode = if self.parse_keywords(&[Keyword::DISTINCT, Keyword::AS, Keyword::VALUE]) {
15478            Some(ValueTableMode::DistinctAsValue)
15479        } else if self.parse_keywords(&[Keyword::DISTINCT, Keyword::AS, Keyword::STRUCT]) {
15480            Some(ValueTableMode::DistinctAsStruct)
15481        } else if self.parse_keywords(&[Keyword::AS, Keyword::VALUE])
15482            || self.parse_keywords(&[Keyword::ALL, Keyword::AS, Keyword::VALUE])
15483        {
15484            Some(ValueTableMode::AsValue)
15485        } else if self.parse_keywords(&[Keyword::AS, Keyword::STRUCT])
15486            || self.parse_keywords(&[Keyword::ALL, Keyword::AS, Keyword::STRUCT])
15487        {
15488            Some(ValueTableMode::AsStruct)
15489        } else if self.parse_keyword(Keyword::AS) {
15490            self.expected_ref("VALUE or STRUCT", self.peek_token_ref())?
15491        } else {
15492            None
15493        };
15494
15495        Ok(mode)
15496    }
15497
15498    /// Invoke `f` after first setting the parser's `ParserState` to `state`.
15499    ///
15500    /// Upon return, restores the parser's state to what it started at.
15501    fn with_state<T, F>(&mut self, state: ParserState, mut f: F) -> Result<T, ParserError>
15502    where
15503        F: FnMut(&mut Parser) -> Result<T, ParserError>,
15504    {
15505        let current_state = self.state;
15506        self.state = state;
15507        let res = f(self);
15508        self.state = current_state;
15509        res
15510    }
15511
15512    /// Parse a `CONNECT BY` clause (Oracle-style hierarchical query support).
15513    pub fn maybe_parse_connect_by(&mut self) -> Result<Vec<ConnectByKind>, ParserError> {
15514        let mut clauses = Vec::with_capacity(2);
15515        loop {
15516            if let Some(idx) = self.parse_keywords_indexed(&[Keyword::START, Keyword::WITH]) {
15517                clauses.push(ConnectByKind::StartWith {
15518                    start_token: self.token_at(idx).clone().into(),
15519                    condition: self.parse_expr()?.into(),
15520                });
15521            } else if let Some(idx) = self.parse_keywords_indexed(&[Keyword::CONNECT, Keyword::BY])
15522            {
15523                clauses.push(ConnectByKind::ConnectBy {
15524                    connect_token: self.token_at(idx).clone().into(),
15525                    nocycle: self.parse_keyword(Keyword::NOCYCLE),
15526                    relationships: self.with_state(ParserState::ConnectBy, |parser| {
15527                        parser.parse_comma_separated(Parser::parse_expr)
15528                    })?,
15529                });
15530            } else {
15531                break;
15532            }
15533        }
15534        Ok(clauses)
15535    }
15536
15537    /// Parse `CREATE TABLE x AS TABLE y`
15538    pub fn parse_as_table(&mut self) -> Result<Table, ParserError> {
15539        let token1 = self.next_token();
15540        let token2 = self.next_token();
15541        let token3 = self.next_token();
15542
15543        let table_name;
15544        let schema_name;
15545        if token2 == Token::Period {
15546            match token1.token {
15547                Token::Word(w) => {
15548                    schema_name = w.value;
15549                }
15550                _ => {
15551                    return self.expected("Schema name", token1);
15552                }
15553            }
15554            match token3.token {
15555                Token::Word(w) => {
15556                    table_name = w.value;
15557                }
15558                _ => {
15559                    return self.expected("Table name", token3);
15560                }
15561            }
15562            Ok(Table {
15563                table_name: Some(table_name),
15564                schema_name: Some(schema_name),
15565            })
15566        } else {
15567            match token1.token {
15568                Token::Word(w) => {
15569                    table_name = w.value;
15570                }
15571                _ => {
15572                    return self.expected("Table name", token1);
15573                }
15574            }
15575            Ok(Table {
15576                table_name: Some(table_name),
15577                schema_name: None,
15578            })
15579        }
15580    }
15581
15582    /// Parse a `SET ROLE` statement. Expects SET to be consumed already.
15583    fn parse_set_role(
15584        &mut self,
15585        modifier: Option<ContextModifier>,
15586    ) -> Result<Statement, ParserError> {
15587        self.expect_keyword_is(Keyword::ROLE)?;
15588
15589        let role_name = if self.parse_keyword(Keyword::NONE) {
15590            None
15591        } else {
15592            Some(self.parse_identifier()?)
15593        };
15594        Ok(Statement::Set(Set::SetRole {
15595            context_modifier: modifier,
15596            role_name,
15597        }))
15598    }
15599
15600    fn parse_set_values(
15601        &mut self,
15602        parenthesized_assignment: bool,
15603    ) -> Result<Vec<Expr>, ParserError> {
15604        let mut values = vec![];
15605
15606        if parenthesized_assignment {
15607            self.expect_token(&Token::LParen)?;
15608        }
15609
15610        loop {
15611            let value = if let Some(expr) = self.try_parse_expr_sub_query()? {
15612                expr
15613            } else if let Ok(expr) = self.parse_expr() {
15614                expr
15615            } else {
15616                self.expected_ref("variable value", self.peek_token_ref())?
15617            };
15618
15619            values.push(value);
15620            if self.consume_token(&Token::Comma) {
15621                continue;
15622            }
15623
15624            if parenthesized_assignment {
15625                self.expect_token(&Token::RParen)?;
15626            }
15627            return Ok(values);
15628        }
15629    }
15630
15631    fn parse_context_modifier(&mut self) -> Option<ContextModifier> {
15632        let modifier =
15633            self.parse_one_of_keywords(&[Keyword::SESSION, Keyword::LOCAL, Keyword::GLOBAL])?;
15634
15635        Self::keyword_to_modifier(modifier)
15636    }
15637
15638    /// Parse a single SET statement assignment `var = expr`.
15639    fn parse_set_assignment(&mut self) -> Result<SetAssignment, ParserError> {
15640        let scope = self.parse_context_modifier();
15641
15642        let name = if self.dialect.supports_parenthesized_set_variables()
15643            && self.consume_token(&Token::LParen)
15644        {
15645            // Parenthesized assignments are handled in the `parse_set` function after
15646            // trying to parse list of assignments using this function.
15647            // If a dialect supports both, and we find a LParen, we early exit from this function.
15648            self.expected_ref("Unparenthesized assignment", self.peek_token_ref())?
15649        } else {
15650            self.parse_object_name(false)?
15651        };
15652
15653        if !(self.consume_token(&Token::Eq) || self.parse_keyword(Keyword::TO)) {
15654            return self.expected_ref("assignment operator", self.peek_token_ref());
15655        }
15656
15657        let value = self.parse_expr()?;
15658
15659        Ok(SetAssignment { scope, name, value })
15660    }
15661
15662    fn parse_set(&mut self) -> Result<Statement, ParserError> {
15663        let hivevar = self.parse_keyword(Keyword::HIVEVAR);
15664
15665        // Modifier is either HIVEVAR: or a ContextModifier (LOCAL, SESSION, etc), not both
15666        let scope = if !hivevar {
15667            self.parse_context_modifier()
15668        } else {
15669            None
15670        };
15671
15672        if hivevar {
15673            self.expect_token(&Token::Colon)?;
15674        }
15675
15676        if let Some(set_role_stmt) = self.maybe_parse(|parser| parser.parse_set_role(scope))? {
15677            return Ok(set_role_stmt);
15678        }
15679
15680        // Handle special cases first
15681        if self.parse_keywords(&[Keyword::TIME, Keyword::ZONE])
15682            || self.parse_keyword(Keyword::TIMEZONE)
15683        {
15684            if self.consume_token(&Token::Eq) || self.parse_keyword(Keyword::TO) {
15685                return Ok(Set::SingleAssignment {
15686                    scope,
15687                    hivevar,
15688                    variable: ObjectName::from(vec!["TIMEZONE".into()]),
15689                    values: self.parse_set_values(false)?,
15690                }
15691                .into());
15692            } else {
15693                // A shorthand alias for SET TIME ZONE that doesn't require
15694                // the assignment operator. It's originally PostgreSQL specific,
15695                // but we allow it for all the dialects
15696                return Ok(Set::SetTimeZone {
15697                    local: scope == Some(ContextModifier::Local),
15698                    value: self.parse_expr()?,
15699                }
15700                .into());
15701            }
15702        } else if self.dialect.supports_set_names() && self.parse_keyword(Keyword::NAMES) {
15703            if self.parse_keyword(Keyword::DEFAULT) {
15704                return Ok(Set::SetNamesDefault {}.into());
15705            }
15706            let charset_name = self.parse_identifier()?;
15707            let collation_name = if self.parse_one_of_keywords(&[Keyword::COLLATE]).is_some() {
15708                Some(self.parse_literal_string()?)
15709            } else {
15710                None
15711            };
15712
15713            return Ok(Set::SetNames {
15714                charset_name,
15715                collation_name,
15716            }
15717            .into());
15718        } else if self.parse_keyword(Keyword::CHARACTERISTICS) {
15719            self.expect_keywords(&[Keyword::AS, Keyword::TRANSACTION])?;
15720            return Ok(Set::SetTransaction {
15721                modes: self.parse_transaction_modes()?,
15722                snapshot: None,
15723                session: true,
15724            }
15725            .into());
15726        } else if self.parse_keyword(Keyword::TRANSACTION) {
15727            if self.parse_keyword(Keyword::SNAPSHOT) {
15728                let snapshot_id = self.parse_value()?;
15729                return Ok(Set::SetTransaction {
15730                    modes: vec![],
15731                    snapshot: Some(snapshot_id),
15732                    session: false,
15733                }
15734                .into());
15735            }
15736            return Ok(Set::SetTransaction {
15737                modes: self.parse_transaction_modes()?,
15738                snapshot: None,
15739                session: false,
15740            }
15741            .into());
15742        } else if self.parse_keyword(Keyword::AUTHORIZATION) {
15743            let scope = match scope {
15744                Some(s) => s,
15745                None => {
15746                    return self.expected_at(
15747                        "SESSION, LOCAL, or other scope modifier before AUTHORIZATION",
15748                        self.get_current_index(),
15749                    )
15750                }
15751            };
15752            let auth_value = if self.parse_keyword(Keyword::DEFAULT) {
15753                SetSessionAuthorizationParamKind::Default
15754            } else {
15755                let value = self.parse_identifier()?;
15756                SetSessionAuthorizationParamKind::User(value)
15757            };
15758            return Ok(Set::SetSessionAuthorization(SetSessionAuthorizationParam {
15759                scope,
15760                kind: auth_value,
15761            })
15762            .into());
15763        }
15764
15765        if self.dialect.supports_comma_separated_set_assignments() {
15766            if scope.is_some() {
15767                self.prev_token();
15768            }
15769
15770            if let Some(assignments) = self
15771                .maybe_parse(|parser| parser.parse_comma_separated(Parser::parse_set_assignment))?
15772            {
15773                return if assignments.len() > 1 {
15774                    Ok(Set::MultipleAssignments { assignments }.into())
15775                } else {
15776                    let SetAssignment { scope, name, value } =
15777                        assignments.into_iter().next().ok_or_else(|| {
15778                            ParserError::ParserError("Expected at least one assignment".to_string())
15779                        })?;
15780
15781                    Ok(Set::SingleAssignment {
15782                        scope,
15783                        hivevar,
15784                        variable: name,
15785                        values: vec![value],
15786                    }
15787                    .into())
15788                };
15789            }
15790        }
15791
15792        let variables = if self.dialect.supports_parenthesized_set_variables()
15793            && self.consume_token(&Token::LParen)
15794        {
15795            let vars = OneOrManyWithParens::Many(
15796                self.parse_comma_separated(|parser: &mut Parser<'a>| parser.parse_identifier())?
15797                    .into_iter()
15798                    .map(|ident| ObjectName::from(vec![ident]))
15799                    .collect(),
15800            );
15801            self.expect_token(&Token::RParen)?;
15802            vars
15803        } else {
15804            OneOrManyWithParens::One(self.parse_object_name(false)?)
15805        };
15806
15807        if self.consume_token(&Token::Eq) || self.parse_keyword(Keyword::TO) {
15808            let stmt = match variables {
15809                OneOrManyWithParens::One(var) => Set::SingleAssignment {
15810                    scope,
15811                    hivevar,
15812                    variable: var,
15813                    values: self.parse_set_values(false)?,
15814                },
15815                OneOrManyWithParens::Many(vars) => Set::ParenthesizedAssignments {
15816                    variables: vars,
15817                    values: self.parse_set_values(true)?,
15818                },
15819            };
15820
15821            return Ok(stmt.into());
15822        }
15823
15824        if self.dialect.supports_set_stmt_without_operator() {
15825            self.prev_token();
15826            return self.parse_set_session_params();
15827        };
15828
15829        self.expected_ref("equals sign or TO", self.peek_token_ref())
15830    }
15831
15832    /// Parse session parameter assignments after `SET` when no `=` or `TO` is present.
15833    pub fn parse_set_session_params(&mut self) -> Result<Statement, ParserError> {
15834        if self.parse_keyword(Keyword::STATISTICS) {
15835            let topic = match self.parse_one_of_keywords(&[
15836                Keyword::IO,
15837                Keyword::PROFILE,
15838                Keyword::TIME,
15839                Keyword::XML,
15840            ]) {
15841                Some(Keyword::IO) => SessionParamStatsTopic::IO,
15842                Some(Keyword::PROFILE) => SessionParamStatsTopic::Profile,
15843                Some(Keyword::TIME) => SessionParamStatsTopic::Time,
15844                Some(Keyword::XML) => SessionParamStatsTopic::Xml,
15845                _ => return self.expected_ref("IO, PROFILE, TIME or XML", self.peek_token_ref()),
15846            };
15847            let value = self.parse_session_param_value()?;
15848            Ok(
15849                Set::SetSessionParam(SetSessionParamKind::Statistics(SetSessionParamStatistics {
15850                    topic,
15851                    value,
15852                }))
15853                .into(),
15854            )
15855        } else if self.parse_keyword(Keyword::IDENTITY_INSERT) {
15856            let obj = self.parse_object_name(false)?;
15857            let value = self.parse_session_param_value()?;
15858            Ok(Set::SetSessionParam(SetSessionParamKind::IdentityInsert(
15859                SetSessionParamIdentityInsert { obj, value },
15860            ))
15861            .into())
15862        } else if self.parse_keyword(Keyword::OFFSETS) {
15863            let keywords = self.parse_comma_separated(|parser| {
15864                let next_token = parser.next_token();
15865                match &next_token.token {
15866                    Token::Word(w) => Ok(w.to_string()),
15867                    _ => parser.expected("SQL keyword", next_token),
15868                }
15869            })?;
15870            let value = self.parse_session_param_value()?;
15871            Ok(
15872                Set::SetSessionParam(SetSessionParamKind::Offsets(SetSessionParamOffsets {
15873                    keywords,
15874                    value,
15875                }))
15876                .into(),
15877            )
15878        } else {
15879            let names = self.parse_comma_separated(|parser| {
15880                let next_token = parser.next_token();
15881                match next_token.token {
15882                    Token::Word(w) => Ok(w.to_string()),
15883                    _ => parser.expected("Session param name", next_token),
15884                }
15885            })?;
15886            let value = self.parse_expr()?.to_string();
15887            Ok(
15888                Set::SetSessionParam(SetSessionParamKind::Generic(SetSessionParamGeneric {
15889                    names,
15890                    value,
15891                }))
15892                .into(),
15893            )
15894        }
15895    }
15896
15897    fn parse_session_param_value(&mut self) -> Result<SessionParamValue, ParserError> {
15898        if self.parse_keyword(Keyword::ON) {
15899            Ok(SessionParamValue::On)
15900        } else if self.parse_keyword(Keyword::OFF) {
15901            Ok(SessionParamValue::Off)
15902        } else {
15903            self.expected_ref("ON or OFF", self.peek_token_ref())
15904        }
15905    }
15906
15907    /// Parse a `SHOW` statement and dispatch to specific SHOW handlers.
15908    pub fn parse_show(&mut self) -> Result<Statement, ParserError> {
15909        let terse = self.parse_keyword(Keyword::TERSE);
15910        let extended = self.parse_keyword(Keyword::EXTENDED);
15911        let full = self.parse_keyword(Keyword::FULL);
15912        let session = self.parse_keyword(Keyword::SESSION);
15913        let global = self.parse_keyword(Keyword::GLOBAL);
15914        let external = self.parse_keyword(Keyword::EXTERNAL);
15915        if self
15916            .parse_one_of_keywords(&[Keyword::COLUMNS, Keyword::FIELDS])
15917            .is_some()
15918        {
15919            Ok(self.parse_show_columns(extended, full)?)
15920        } else if self.parse_keyword(Keyword::TABLES) {
15921            Ok(self.parse_show_tables(terse, extended, full, external)?)
15922        } else if self.parse_keywords(&[Keyword::MATERIALIZED, Keyword::VIEWS]) {
15923            Ok(self.parse_show_views(terse, true)?)
15924        } else if self.parse_keyword(Keyword::VIEWS) {
15925            Ok(self.parse_show_views(terse, false)?)
15926        } else if self.parse_keyword(Keyword::FUNCTIONS) {
15927            Ok(self.parse_show_functions()?)
15928        } else if self.parse_keyword(Keyword::PROCESSLIST) {
15929            Ok(Statement::ShowProcessList { full })
15930        } else if extended || full {
15931            Err(ParserError::ParserError(
15932                "EXTENDED/FULL are not supported with this type of SHOW query".to_string(),
15933            ))
15934        } else if self.parse_one_of_keywords(&[Keyword::CREATE]).is_some() {
15935            Ok(self.parse_show_create()?)
15936        } else if self.parse_keyword(Keyword::COLLATION) {
15937            Ok(self.parse_show_collation()?)
15938        } else if self.parse_keyword(Keyword::VARIABLES)
15939            && dialect_of!(self is MySqlDialect | GenericDialect)
15940        {
15941            Ok(Statement::ShowVariables {
15942                filter: self.parse_show_statement_filter()?,
15943                session,
15944                global,
15945            })
15946        } else if self.parse_keyword(Keyword::STATUS)
15947            && dialect_of!(self is MySqlDialect | GenericDialect)
15948        {
15949            Ok(Statement::ShowStatus {
15950                filter: self.parse_show_statement_filter()?,
15951                session,
15952                global,
15953            })
15954        } else if self.parse_keyword(Keyword::CATALOGS) {
15955            self.parse_show_catalogs(terse)
15956        } else if self.parse_keyword(Keyword::DATABASES) {
15957            self.parse_show_databases(terse)
15958        } else if self.parse_keyword(Keyword::SCHEMAS) {
15959            self.parse_show_schemas(terse)
15960        } else if self.parse_keywords(&[Keyword::CHARACTER, Keyword::SET]) {
15961            self.parse_show_charset(false)
15962        } else if self.parse_keyword(Keyword::CHARSET) {
15963            self.parse_show_charset(true)
15964        } else {
15965            Ok(Statement::ShowVariable {
15966                variable: self.parse_identifiers()?,
15967            })
15968        }
15969    }
15970
15971    fn parse_show_charset(&mut self, is_shorthand: bool) -> Result<Statement, ParserError> {
15972        // parse one of keywords
15973        Ok(Statement::ShowCharset(ShowCharset {
15974            is_shorthand,
15975            filter: self.parse_show_statement_filter()?,
15976        }))
15977    }
15978
15979    fn parse_show_catalogs(&mut self, terse: bool) -> Result<Statement, ParserError> {
15980        let history = self.parse_keyword(Keyword::HISTORY);
15981        let show_options = self.parse_show_stmt_options()?;
15982        Ok(Statement::ShowCatalogs {
15983            terse,
15984            history,
15985            show_options,
15986        })
15987    }
15988
15989    fn parse_show_databases(&mut self, terse: bool) -> Result<Statement, ParserError> {
15990        let history = self.parse_keyword(Keyword::HISTORY);
15991        let show_options = self.parse_show_stmt_options()?;
15992        Ok(Statement::ShowDatabases {
15993            terse,
15994            history,
15995            show_options,
15996        })
15997    }
15998
15999    fn parse_show_schemas(&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::ShowSchemas {
16003            terse,
16004            history,
16005            show_options,
16006        })
16007    }
16008
16009    /// Parse `SHOW CREATE <object>` returning the corresponding `ShowCreate` statement.
16010    pub fn parse_show_create(&mut self) -> Result<Statement, ParserError> {
16011        let obj_type = match self.expect_one_of_keywords(&[
16012            Keyword::TABLE,
16013            Keyword::TRIGGER,
16014            Keyword::FUNCTION,
16015            Keyword::PROCEDURE,
16016            Keyword::EVENT,
16017            Keyword::VIEW,
16018        ])? {
16019            Keyword::TABLE => Ok(ShowCreateObject::Table),
16020            Keyword::TRIGGER => Ok(ShowCreateObject::Trigger),
16021            Keyword::FUNCTION => Ok(ShowCreateObject::Function),
16022            Keyword::PROCEDURE => Ok(ShowCreateObject::Procedure),
16023            Keyword::EVENT => Ok(ShowCreateObject::Event),
16024            Keyword::VIEW => Ok(ShowCreateObject::View),
16025            keyword => Err(ParserError::ParserError(format!(
16026                "Unable to map keyword to ShowCreateObject: {keyword:?}"
16027            ))),
16028        }?;
16029
16030        let obj_name = self.parse_object_name(false)?;
16031
16032        Ok(Statement::ShowCreate { obj_type, obj_name })
16033    }
16034
16035    /// Parse `SHOW COLUMNS`/`SHOW FIELDS` and return a `ShowColumns` statement.
16036    pub fn parse_show_columns(
16037        &mut self,
16038        extended: bool,
16039        full: bool,
16040    ) -> Result<Statement, ParserError> {
16041        let show_options = self.parse_show_stmt_options()?;
16042        Ok(Statement::ShowColumns {
16043            extended,
16044            full,
16045            show_options,
16046        })
16047    }
16048
16049    fn parse_show_tables(
16050        &mut self,
16051        terse: bool,
16052        extended: bool,
16053        full: bool,
16054        external: bool,
16055    ) -> Result<Statement, ParserError> {
16056        let history = !external && self.parse_keyword(Keyword::HISTORY);
16057        let show_options = self.parse_show_stmt_options()?;
16058        Ok(Statement::ShowTables {
16059            terse,
16060            history,
16061            extended,
16062            full,
16063            external,
16064            show_options,
16065        })
16066    }
16067
16068    fn parse_show_views(
16069        &mut self,
16070        terse: bool,
16071        materialized: bool,
16072    ) -> Result<Statement, ParserError> {
16073        let show_options = self.parse_show_stmt_options()?;
16074        Ok(Statement::ShowViews {
16075            materialized,
16076            terse,
16077            show_options,
16078        })
16079    }
16080
16081    /// Parse `SHOW FUNCTIONS` and optional filter.
16082    pub fn parse_show_functions(&mut self) -> Result<Statement, ParserError> {
16083        let filter = self.parse_show_statement_filter()?;
16084        Ok(Statement::ShowFunctions { filter })
16085    }
16086
16087    /// Parse `SHOW COLLATION` and optional filter.
16088    pub fn parse_show_collation(&mut self) -> Result<Statement, ParserError> {
16089        let filter = self.parse_show_statement_filter()?;
16090        Ok(Statement::ShowCollation { filter })
16091    }
16092
16093    /// Parse an optional filter used by `SHOW` statements (LIKE, ILIKE, WHERE, or literal).
16094    pub fn parse_show_statement_filter(
16095        &mut self,
16096    ) -> Result<Option<ShowStatementFilter>, ParserError> {
16097        if self.parse_keyword(Keyword::LIKE) {
16098            Ok(Some(ShowStatementFilter::Like(
16099                self.parse_literal_string()?,
16100            )))
16101        } else if self.parse_keyword(Keyword::ILIKE) {
16102            Ok(Some(ShowStatementFilter::ILike(
16103                self.parse_literal_string()?,
16104            )))
16105        } else if self.parse_keyword(Keyword::WHERE) {
16106            Ok(Some(ShowStatementFilter::Where(self.parse_expr()?)))
16107        } else {
16108            self.maybe_parse(|parser| -> Result<String, ParserError> {
16109                parser.parse_literal_string()
16110            })?
16111            .map_or(Ok(None), |filter| {
16112                Ok(Some(ShowStatementFilter::NoKeyword(filter)))
16113            })
16114        }
16115    }
16116
16117    /// Parse a `USE` statement (database/catalog/schema/warehouse/role selection).
16118    pub fn parse_use(&mut self) -> Result<Statement, ParserError> {
16119        // Determine which keywords are recognized by the current dialect
16120        let parsed_keyword = if dialect_of!(self is HiveDialect) {
16121            // HiveDialect accepts USE DEFAULT; statement without any db specified
16122            if self.parse_keyword(Keyword::DEFAULT) {
16123                return Ok(Statement::Use(Use::Default));
16124            }
16125            None // HiveDialect doesn't expect any other specific keyword after `USE`
16126        } else if dialect_of!(self is DatabricksDialect) {
16127            self.parse_one_of_keywords(&[Keyword::CATALOG, Keyword::DATABASE, Keyword::SCHEMA])
16128        } else if dialect_of!(self is SnowflakeDialect) {
16129            self.parse_one_of_keywords(&[
16130                Keyword::DATABASE,
16131                Keyword::SCHEMA,
16132                Keyword::WAREHOUSE,
16133                Keyword::ROLE,
16134                Keyword::SECONDARY,
16135            ])
16136        } else {
16137            None // No specific keywords for other dialects, including GenericDialect
16138        };
16139
16140        let result = if matches!(parsed_keyword, Some(Keyword::SECONDARY)) {
16141            self.parse_secondary_roles()?
16142        } else {
16143            let obj_name = self.parse_object_name(false)?;
16144            match parsed_keyword {
16145                Some(Keyword::CATALOG) => Use::Catalog(obj_name),
16146                Some(Keyword::DATABASE) => Use::Database(obj_name),
16147                Some(Keyword::SCHEMA) => Use::Schema(obj_name),
16148                Some(Keyword::WAREHOUSE) => Use::Warehouse(obj_name),
16149                Some(Keyword::ROLE) => Use::Role(obj_name),
16150                _ => Use::Object(obj_name),
16151            }
16152        };
16153
16154        Ok(Statement::Use(result))
16155    }
16156
16157    fn parse_secondary_roles(&mut self) -> Result<Use, ParserError> {
16158        self.expect_one_of_keywords(&[Keyword::ROLES, Keyword::ROLE])?;
16159        if self.parse_keyword(Keyword::NONE) {
16160            Ok(Use::SecondaryRoles(SecondaryRoles::None))
16161        } else if self.parse_keyword(Keyword::ALL) {
16162            Ok(Use::SecondaryRoles(SecondaryRoles::All))
16163        } else {
16164            let roles = self.parse_comma_separated(|parser| parser.parse_identifier())?;
16165            Ok(Use::SecondaryRoles(SecondaryRoles::List(roles)))
16166        }
16167    }
16168
16169    /// Parse a table factor followed by any join clauses, returning `TableWithJoins`.
16170    pub fn parse_table_and_joins(&mut self) -> Result<TableWithJoins, ParserError> {
16171        let relation = self.parse_table_factor()?;
16172        // Note that for keywords to be properly handled here, they need to be
16173        // added to `RESERVED_FOR_TABLE_ALIAS`, otherwise they may be parsed as
16174        // a table alias.
16175        let joins = self.parse_joins()?;
16176        Ok(TableWithJoins { relation, joins })
16177    }
16178
16179    fn parse_joins(&mut self) -> Result<Vec<Join>, ParserError> {
16180        let mut joins = vec![];
16181        loop {
16182            let global = self.parse_keyword(Keyword::GLOBAL);
16183            let join = if self.parse_keyword(Keyword::CROSS) {
16184                let join_operator = if self.parse_keyword(Keyword::JOIN) {
16185                    JoinOperator::CrossJoin(JoinConstraint::None)
16186                } else if self.parse_keyword(Keyword::APPLY) {
16187                    // MSSQL extension, similar to CROSS JOIN LATERAL
16188                    JoinOperator::CrossApply
16189                } else {
16190                    return self.expected_ref("JOIN or APPLY after CROSS", self.peek_token_ref());
16191                };
16192                let relation = self.parse_table_factor()?;
16193                let join_operator = if matches!(join_operator, JoinOperator::CrossJoin(_))
16194                    && self.dialect.supports_cross_join_constraint()
16195                {
16196                    let constraint = self.parse_join_constraint(false)?;
16197                    JoinOperator::CrossJoin(constraint)
16198                } else {
16199                    join_operator
16200                };
16201                Join {
16202                    relation,
16203                    global,
16204                    join_operator,
16205                }
16206            } else if self.parse_keyword(Keyword::OUTER) {
16207                // MSSQL extension, similar to LEFT JOIN LATERAL .. ON 1=1
16208                self.expect_keyword_is(Keyword::APPLY)?;
16209                Join {
16210                    relation: self.parse_table_factor()?,
16211                    global,
16212                    join_operator: JoinOperator::OuterApply,
16213                }
16214            } else if self.parse_keyword(Keyword::ASOF) {
16215                self.expect_keyword_is(Keyword::JOIN)?;
16216                let relation = self.parse_table_factor()?;
16217                self.expect_keyword_is(Keyword::MATCH_CONDITION)?;
16218                let match_condition = self.parse_parenthesized(Self::parse_expr)?;
16219                Join {
16220                    relation,
16221                    global,
16222                    join_operator: JoinOperator::AsOf {
16223                        match_condition,
16224                        constraint: self.parse_join_constraint(false)?,
16225                    },
16226                }
16227            } else {
16228                let natural = self.parse_keyword(Keyword::NATURAL);
16229                let peek_keyword = if let Token::Word(w) = &self.peek_token_ref().token {
16230                    w.keyword
16231                } else {
16232                    Keyword::NoKeyword
16233                };
16234
16235                let join_operator_type = match peek_keyword {
16236                    Keyword::INNER | Keyword::JOIN => {
16237                        let inner = self.parse_keyword(Keyword::INNER); // [ INNER ]
16238                        self.expect_keyword_is(Keyword::JOIN)?;
16239                        if inner {
16240                            JoinOperator::Inner
16241                        } else {
16242                            JoinOperator::Join
16243                        }
16244                    }
16245                    kw @ Keyword::LEFT | kw @ Keyword::RIGHT => {
16246                        let _ = self.next_token(); // consume LEFT/RIGHT
16247                        let is_left = kw == Keyword::LEFT;
16248                        let join_type = self.parse_one_of_keywords(&[
16249                            Keyword::OUTER,
16250                            Keyword::SEMI,
16251                            Keyword::ANTI,
16252                            Keyword::JOIN,
16253                        ]);
16254                        match join_type {
16255                            Some(Keyword::OUTER) => {
16256                                self.expect_keyword_is(Keyword::JOIN)?;
16257                                if is_left {
16258                                    JoinOperator::LeftOuter
16259                                } else {
16260                                    JoinOperator::RightOuter
16261                                }
16262                            }
16263                            Some(Keyword::SEMI) => {
16264                                self.expect_keyword_is(Keyword::JOIN)?;
16265                                if is_left {
16266                                    JoinOperator::LeftSemi
16267                                } else {
16268                                    JoinOperator::RightSemi
16269                                }
16270                            }
16271                            Some(Keyword::ANTI) => {
16272                                self.expect_keyword_is(Keyword::JOIN)?;
16273                                if is_left {
16274                                    JoinOperator::LeftAnti
16275                                } else {
16276                                    JoinOperator::RightAnti
16277                                }
16278                            }
16279                            Some(Keyword::JOIN) => {
16280                                if is_left {
16281                                    JoinOperator::Left
16282                                } else {
16283                                    JoinOperator::Right
16284                                }
16285                            }
16286                            _ => {
16287                                return Err(ParserError::ParserError(format!(
16288                                    "expected OUTER, SEMI, ANTI or JOIN after {kw:?}"
16289                                )))
16290                            }
16291                        }
16292                    }
16293                    Keyword::ANTI => {
16294                        let _ = self.next_token(); // consume ANTI
16295                        self.expect_keyword_is(Keyword::JOIN)?;
16296                        JoinOperator::Anti
16297                    }
16298                    Keyword::SEMI => {
16299                        let _ = self.next_token(); // consume SEMI
16300                        self.expect_keyword_is(Keyword::JOIN)?;
16301                        JoinOperator::Semi
16302                    }
16303                    Keyword::FULL => {
16304                        let _ = self.next_token(); // consume FULL
16305                        let _ = self.parse_keyword(Keyword::OUTER); // [ OUTER ]
16306                        self.expect_keyword_is(Keyword::JOIN)?;
16307                        JoinOperator::FullOuter
16308                    }
16309                    Keyword::OUTER => {
16310                        return self.expected_ref("LEFT, RIGHT, or FULL", self.peek_token_ref());
16311                    }
16312                    Keyword::STRAIGHT_JOIN => {
16313                        let _ = self.next_token(); // consume STRAIGHT_JOIN
16314                        JoinOperator::StraightJoin
16315                    }
16316                    _ if natural => {
16317                        return self
16318                            .expected_ref("a join type after NATURAL", self.peek_token_ref());
16319                    }
16320                    _ => break,
16321                };
16322                let mut relation = self.parse_table_factor()?;
16323
16324                if !self
16325                    .dialect
16326                    .supports_left_associative_joins_without_parens()
16327                    && self.peek_parens_less_nested_join()
16328                {
16329                    let joins = self.parse_joins()?;
16330                    relation = TableFactor::NestedJoin {
16331                        table_with_joins: Box::new(TableWithJoins { relation, joins }),
16332                        alias: None,
16333                    };
16334                }
16335
16336                let join_constraint = self.parse_join_constraint(natural)?;
16337                Join {
16338                    relation,
16339                    global,
16340                    join_operator: join_operator_type(join_constraint),
16341                }
16342            };
16343            joins.push(join);
16344        }
16345        Ok(joins)
16346    }
16347
16348    fn peek_parens_less_nested_join(&self) -> bool {
16349        matches!(
16350            self.peek_token_ref().token,
16351            Token::Word(Word {
16352                keyword: Keyword::JOIN
16353                    | Keyword::INNER
16354                    | Keyword::LEFT
16355                    | Keyword::RIGHT
16356                    | Keyword::FULL,
16357                ..
16358            })
16359        )
16360    }
16361
16362    /// A table name or a parenthesized subquery, followed by optional `[AS] alias`
16363    #[cfg_attr(feature = "recursive-protection", recursive::recursive)]
16364    pub fn parse_table_factor(&mut self) -> Result<TableFactor, ParserError> {
16365        let _guard = self.recursion_counter.try_decrease()?;
16366        if self.parse_keyword(Keyword::LATERAL) {
16367            // LATERAL must always be followed by a subquery or table function.
16368            if self.consume_token(&Token::LParen) {
16369                self.parse_derived_table_factor(Lateral)
16370            } else {
16371                let name = self.parse_object_name(false)?;
16372                self.expect_token(&Token::LParen)?;
16373                let args = self.parse_optional_args()?;
16374                let alias = self.maybe_parse_table_alias()?;
16375                Ok(TableFactor::Function {
16376                    lateral: true,
16377                    name,
16378                    args,
16379                    alias,
16380                })
16381            }
16382        } else if self.parse_keyword(Keyword::TABLE) {
16383            // parse table function (SELECT * FROM TABLE (<expr>) [ AS <alias> ])
16384            self.expect_token(&Token::LParen)?;
16385            let expr = self.parse_expr()?;
16386            self.expect_token(&Token::RParen)?;
16387            let alias = self.maybe_parse_table_alias()?;
16388            Ok(TableFactor::TableFunction { expr, alias })
16389        } else if self.consume_token(&Token::LParen) {
16390            // A left paren introduces either a derived table (i.e., a subquery)
16391            // or a nested join. It's nearly impossible to determine ahead of
16392            // time which it is... so we just try to parse both.
16393            //
16394            // Here's an example that demonstrates the complexity:
16395            //                     /-------------------------------------------------------\
16396            //                     | /-----------------------------------\                 |
16397            //     SELECT * FROM ( ( ( (SELECT 1) UNION (SELECT 2) ) AS t1 NATURAL JOIN t2 ) )
16398            //                   ^ ^ ^ ^
16399            //                   | | | |
16400            //                   | | | |
16401            //                   | | | (4) belongs to a SetExpr::Query inside the subquery
16402            //                   | | (3) starts a derived table (subquery)
16403            //                   | (2) starts a nested join
16404            //                   (1) an additional set of parens around a nested join
16405            //
16406
16407            // If the recently consumed '(' starts a derived table, the call to
16408            // `parse_derived_table_factor` below will return success after parsing the
16409            // subquery, followed by the closing ')', and the alias of the derived table.
16410            // In the example above this is case (3).
16411            if let Some(mut table) =
16412                self.maybe_parse(|parser| parser.parse_derived_table_factor(NotLateral))?
16413            {
16414                while let Some(kw) = self.parse_one_of_keywords(&[Keyword::PIVOT, Keyword::UNPIVOT])
16415                {
16416                    table = match kw {
16417                        Keyword::PIVOT => self.parse_pivot_table_factor(table)?,
16418                        Keyword::UNPIVOT => self.parse_unpivot_table_factor(table)?,
16419                        unexpected_keyword => return Err(ParserError::ParserError(
16420                            format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in pivot/unpivot"),
16421                        )),
16422                    }
16423                }
16424                return Ok(table);
16425            }
16426
16427            // A parsing error from `parse_derived_table_factor` indicates that the '(' we've
16428            // recently consumed does not start a derived table (cases 1, 2, or 4).
16429            // `maybe_parse` will ignore such an error and rewind to be after the opening '('.
16430
16431            // Inside the parentheses we expect to find an (A) table factor
16432            // followed by some joins or (B) another level of nesting.
16433            let mut table_and_joins = self.parse_table_and_joins()?;
16434
16435            #[allow(clippy::if_same_then_else)]
16436            if !table_and_joins.joins.is_empty() {
16437                self.expect_token(&Token::RParen)?;
16438                let alias = self.maybe_parse_table_alias()?;
16439                Ok(TableFactor::NestedJoin {
16440                    table_with_joins: Box::new(table_and_joins),
16441                    alias,
16442                }) // (A)
16443            } else if let TableFactor::NestedJoin {
16444                table_with_joins: _,
16445                alias: _,
16446            } = &table_and_joins.relation
16447            {
16448                // (B): `table_and_joins` (what we found inside the parentheses)
16449                // is a nested join `(foo JOIN bar)`, not followed by other joins.
16450                self.expect_token(&Token::RParen)?;
16451                let alias = self.maybe_parse_table_alias()?;
16452                Ok(TableFactor::NestedJoin {
16453                    table_with_joins: Box::new(table_and_joins),
16454                    alias,
16455                })
16456            } else if self.dialect.supports_parens_around_table_factor() {
16457                // Dialect-specific behavior: Snowflake diverges from the
16458                // standard and from most of the other implementations by
16459                // allowing extra parentheses not only around a join (B), but
16460                // around lone table names (e.g. `FROM (mytable [AS alias])`)
16461                // and around derived tables (e.g. `FROM ((SELECT ...)
16462                // [AS alias])`) as well.
16463                self.expect_token(&Token::RParen)?;
16464
16465                if let Some(outer_alias) = self.maybe_parse_table_alias()? {
16466                    // Snowflake also allows specifying an alias *after* parens
16467                    // e.g. `FROM (mytable) AS alias`
16468                    match &mut table_and_joins.relation {
16469                        TableFactor::Derived { alias, .. }
16470                        | TableFactor::Table { alias, .. }
16471                        | TableFactor::Function { alias, .. }
16472                        | TableFactor::UNNEST { alias, .. }
16473                        | TableFactor::JsonTable { alias, .. }
16474                        | TableFactor::XmlTable { alias, .. }
16475                        | TableFactor::OpenJsonTable { alias, .. }
16476                        | TableFactor::TableFunction { alias, .. }
16477                        | TableFactor::Pivot { alias, .. }
16478                        | TableFactor::Unpivot { alias, .. }
16479                        | TableFactor::MatchRecognize { alias, .. }
16480                        | TableFactor::SemanticView { alias, .. }
16481                        | TableFactor::NestedJoin { alias, .. } => {
16482                            // but not `FROM (mytable AS alias1) AS alias2`.
16483                            if let Some(inner_alias) = alias {
16484                                return Err(ParserError::ParserError(format!(
16485                                    "duplicate alias {inner_alias}"
16486                                )));
16487                            }
16488                            // Act as if the alias was specified normally next
16489                            // to the table name: `(mytable) AS alias` ->
16490                            // `(mytable AS alias)`
16491                            alias.replace(outer_alias);
16492                        }
16493                    };
16494                }
16495                // Do not store the extra set of parens in the AST
16496                Ok(table_and_joins.relation)
16497            } else {
16498                // The SQL spec prohibits derived tables and bare tables from
16499                // appearing alone in parentheses (e.g. `FROM (mytable)`)
16500                self.expected_ref("joined table", self.peek_token_ref())
16501            }
16502        } else if self.dialect.supports_values_as_table_factor()
16503            && matches!(
16504                self.peek_tokens(),
16505                [
16506                    Token::Word(Word {
16507                        keyword: Keyword::VALUES,
16508                        ..
16509                    }),
16510                    Token::LParen
16511                ]
16512            )
16513        {
16514            self.expect_keyword_is(Keyword::VALUES)?;
16515
16516            // Snowflake and Databricks allow syntax like below:
16517            // SELECT * FROM VALUES (1, 'a'), (2, 'b') AS t (col1, col2)
16518            // where there are no parentheses around the VALUES clause.
16519            let values = SetExpr::Values(self.parse_values(false, false)?);
16520            let alias = self.maybe_parse_table_alias()?;
16521            Ok(TableFactor::Derived {
16522                lateral: false,
16523                subquery: Box::new(Query {
16524                    with: None,
16525                    body: Box::new(values),
16526                    order_by: None,
16527                    limit_clause: None,
16528                    fetch: None,
16529                    locks: vec![],
16530                    for_clause: None,
16531                    settings: None,
16532                    format_clause: None,
16533                    pipe_operators: vec![],
16534                }),
16535                alias,
16536                sample: None,
16537            })
16538        } else if dialect_of!(self is BigQueryDialect | PostgreSqlDialect | GenericDialect)
16539            && self.parse_keyword(Keyword::UNNEST)
16540        {
16541            self.expect_token(&Token::LParen)?;
16542            let array_exprs = self.parse_comma_separated(Parser::parse_expr)?;
16543            self.expect_token(&Token::RParen)?;
16544
16545            let with_ordinality = self.parse_keywords(&[Keyword::WITH, Keyword::ORDINALITY]);
16546            let alias = match self.maybe_parse_table_alias() {
16547                Ok(Some(alias)) => Some(alias),
16548                Ok(None) => None,
16549                Err(e) => return Err(e),
16550            };
16551
16552            let with_offset = match self.expect_keywords(&[Keyword::WITH, Keyword::OFFSET]) {
16553                Ok(()) => true,
16554                Err(_) => false,
16555            };
16556
16557            let with_offset_alias = if with_offset {
16558                match self.parse_optional_alias(keywords::RESERVED_FOR_COLUMN_ALIAS) {
16559                    Ok(Some(alias)) => Some(alias),
16560                    Ok(None) => None,
16561                    Err(e) => return Err(e),
16562                }
16563            } else {
16564                None
16565            };
16566
16567            Ok(TableFactor::UNNEST {
16568                alias,
16569                array_exprs,
16570                with_offset,
16571                with_offset_alias,
16572                with_ordinality,
16573            })
16574        } else if self.parse_keyword_with_tokens(Keyword::JSON_TABLE, &[Token::LParen]) {
16575            let json_expr = self.parse_expr()?;
16576            self.expect_token(&Token::Comma)?;
16577            let json_path = self.parse_value()?;
16578            self.expect_keyword_is(Keyword::COLUMNS)?;
16579            self.expect_token(&Token::LParen)?;
16580            let columns = self.parse_comma_separated(Parser::parse_json_table_column_def)?;
16581            self.expect_token(&Token::RParen)?;
16582            self.expect_token(&Token::RParen)?;
16583            let alias = self.maybe_parse_table_alias()?;
16584            Ok(TableFactor::JsonTable {
16585                json_expr,
16586                json_path,
16587                columns,
16588                alias,
16589            })
16590        } else if self.parse_keyword_with_tokens(Keyword::OPENJSON, &[Token::LParen]) {
16591            self.prev_token();
16592            self.parse_open_json_table_factor()
16593        } else if self.parse_keyword_with_tokens(Keyword::XMLTABLE, &[Token::LParen]) {
16594            self.prev_token();
16595            self.parse_xml_table_factor()
16596        } else if self.dialect.supports_semantic_view_table_factor()
16597            && self.peek_keyword_with_tokens(Keyword::SEMANTIC_VIEW, &[Token::LParen])
16598        {
16599            self.parse_semantic_view_table_factor()
16600        } else if self.peek_token_ref().token == Token::AtSign {
16601            // Stage reference: @mystage or @namespace.stage (e.g. Snowflake)
16602            self.parse_snowflake_stage_table_factor()
16603        } else {
16604            let name = self.parse_object_name(true)?;
16605
16606            let json_path = match &self.peek_token_ref().token {
16607                Token::LBracket if self.dialect.supports_partiql() => Some(self.parse_json_path()?),
16608                _ => None,
16609            };
16610
16611            let partitions: Vec<Ident> = if dialect_of!(self is MySqlDialect | GenericDialect)
16612                && self.parse_keyword(Keyword::PARTITION)
16613            {
16614                self.parse_parenthesized_identifiers()?
16615            } else {
16616                vec![]
16617            };
16618
16619            // Parse potential version qualifier
16620            let version = self.maybe_parse_table_version()?;
16621
16622            // Postgres, MSSQL, ClickHouse: table-valued functions:
16623            let args = if self.consume_token(&Token::LParen) {
16624                Some(self.parse_table_function_args()?)
16625            } else {
16626                None
16627            };
16628
16629            let with_ordinality = self.parse_keywords(&[Keyword::WITH, Keyword::ORDINALITY]);
16630
16631            let mut sample = None;
16632            if self.dialect.supports_table_sample_before_alias() {
16633                if let Some(parsed_sample) = self.maybe_parse_table_sample()? {
16634                    sample = Some(TableSampleKind::BeforeTableAlias(parsed_sample));
16635                }
16636            }
16637
16638            let alias = self.maybe_parse_table_alias()?;
16639
16640            // MYSQL-specific table hints:
16641            let index_hints = if self.dialect.supports_table_hints() {
16642                self.maybe_parse(|p| p.parse_table_index_hints())?
16643                    .unwrap_or(vec![])
16644            } else {
16645                vec![]
16646            };
16647
16648            // MSSQL-specific table hints:
16649            let mut with_hints = vec![];
16650            if self.parse_keyword(Keyword::WITH) {
16651                if self.consume_token(&Token::LParen) {
16652                    with_hints = self.parse_comma_separated(Parser::parse_expr)?;
16653                    self.expect_token(&Token::RParen)?;
16654                } else {
16655                    // rewind, as WITH may belong to the next statement's CTE
16656                    self.prev_token();
16657                }
16658            };
16659
16660            if !self.dialect.supports_table_sample_before_alias() {
16661                if let Some(parsed_sample) = self.maybe_parse_table_sample()? {
16662                    sample = Some(TableSampleKind::AfterTableAlias(parsed_sample));
16663                }
16664            }
16665
16666            let mut table = TableFactor::Table {
16667                name,
16668                alias,
16669                args,
16670                with_hints,
16671                version,
16672                partitions,
16673                with_ordinality,
16674                json_path,
16675                sample,
16676                index_hints,
16677            };
16678
16679            while let Some(kw) = self.parse_one_of_keywords(&[Keyword::PIVOT, Keyword::UNPIVOT]) {
16680                table = match kw {
16681                    Keyword::PIVOT => self.parse_pivot_table_factor(table)?,
16682                    Keyword::UNPIVOT => self.parse_unpivot_table_factor(table)?,
16683                    unexpected_keyword => return Err(ParserError::ParserError(
16684                        format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in pivot/unpivot"),
16685                    )),
16686                }
16687            }
16688
16689            if self.dialect.supports_match_recognize()
16690                && self.parse_keyword(Keyword::MATCH_RECOGNIZE)
16691            {
16692                table = self.parse_match_recognize(table)?;
16693            }
16694
16695            Ok(table)
16696        }
16697    }
16698
16699    /// Parse a Snowflake stage reference as a table factor.
16700    /// Handles syntax like: `@mystage1 (file_format => 'myformat', pattern => '...')`
16701    ///
16702    /// See: <https://docs.snowflake.com/en/user-guide/querying-stage>
16703    fn parse_snowflake_stage_table_factor(&mut self) -> Result<TableFactor, ParserError> {
16704        // Parse the stage name starting with @
16705        let name = crate::dialect::parse_snowflake_stage_name(self)?;
16706
16707        // Parse optional stage options like (file_format => 'myformat', pattern => '...')
16708        let args = if self.consume_token(&Token::LParen) {
16709            Some(self.parse_table_function_args()?)
16710        } else {
16711            None
16712        };
16713
16714        let alias = self.maybe_parse_table_alias()?;
16715
16716        Ok(TableFactor::Table {
16717            name,
16718            alias,
16719            args,
16720            with_hints: vec![],
16721            version: None,
16722            partitions: vec![],
16723            with_ordinality: false,
16724            json_path: None,
16725            sample: None,
16726            index_hints: vec![],
16727        })
16728    }
16729
16730    fn maybe_parse_table_sample(&mut self) -> Result<Option<Box<TableSample>>, ParserError> {
16731        let modifier = if self.parse_keyword(Keyword::TABLESAMPLE) {
16732            TableSampleModifier::TableSample
16733        } else if self.parse_keyword(Keyword::SAMPLE) {
16734            TableSampleModifier::Sample
16735        } else {
16736            return Ok(None);
16737        };
16738        self.parse_table_sample(modifier).map(Some)
16739    }
16740
16741    fn parse_table_sample(
16742        &mut self,
16743        modifier: TableSampleModifier,
16744    ) -> Result<Box<TableSample>, ParserError> {
16745        let name = match self.parse_one_of_keywords(&[
16746            Keyword::BERNOULLI,
16747            Keyword::ROW,
16748            Keyword::SYSTEM,
16749            Keyword::BLOCK,
16750        ]) {
16751            Some(Keyword::BERNOULLI) => Some(TableSampleMethod::Bernoulli),
16752            Some(Keyword::ROW) => Some(TableSampleMethod::Row),
16753            Some(Keyword::SYSTEM) => Some(TableSampleMethod::System),
16754            Some(Keyword::BLOCK) => Some(TableSampleMethod::Block),
16755            _ => None,
16756        };
16757
16758        let parenthesized = self.consume_token(&Token::LParen);
16759
16760        let (quantity, bucket) = if parenthesized && self.parse_keyword(Keyword::BUCKET) {
16761            let selected_bucket = self.parse_number_value()?;
16762            self.expect_keywords(&[Keyword::OUT, Keyword::OF])?;
16763            let total = self.parse_number_value()?;
16764            let on = if self.parse_keyword(Keyword::ON) {
16765                Some(self.parse_expr()?)
16766            } else {
16767                None
16768            };
16769            (
16770                None,
16771                Some(TableSampleBucket {
16772                    bucket: selected_bucket,
16773                    total,
16774                    on,
16775                }),
16776            )
16777        } else {
16778            let value = match self.maybe_parse(|p| p.parse_expr())? {
16779                Some(num) => num,
16780                None => {
16781                    let next_token = self.next_token();
16782                    if let Token::Word(w) = next_token.token {
16783                        Expr::Value(Value::Placeholder(w.value).with_span(next_token.span))
16784                    } else {
16785                        return parser_err!(
16786                            "Expecting number or byte length e.g. 100M",
16787                            self.peek_token_ref().span.start
16788                        );
16789                    }
16790                }
16791            };
16792            let unit = if self.parse_keyword(Keyword::ROWS) {
16793                Some(TableSampleUnit::Rows)
16794            } else if self.parse_keyword(Keyword::PERCENT) {
16795                Some(TableSampleUnit::Percent)
16796            } else {
16797                None
16798            };
16799            (
16800                Some(TableSampleQuantity {
16801                    parenthesized,
16802                    value,
16803                    unit,
16804                }),
16805                None,
16806            )
16807        };
16808        if parenthesized {
16809            self.expect_token(&Token::RParen)?;
16810        }
16811
16812        let seed = if self.parse_keyword(Keyword::REPEATABLE) {
16813            Some(self.parse_table_sample_seed(TableSampleSeedModifier::Repeatable)?)
16814        } else if self.parse_keyword(Keyword::SEED) {
16815            Some(self.parse_table_sample_seed(TableSampleSeedModifier::Seed)?)
16816        } else {
16817            None
16818        };
16819
16820        let offset = if self.parse_keyword(Keyword::OFFSET) {
16821            Some(self.parse_expr()?)
16822        } else {
16823            None
16824        };
16825
16826        Ok(Box::new(TableSample {
16827            modifier,
16828            name,
16829            quantity,
16830            seed,
16831            bucket,
16832            offset,
16833        }))
16834    }
16835
16836    fn parse_table_sample_seed(
16837        &mut self,
16838        modifier: TableSampleSeedModifier,
16839    ) -> Result<TableSampleSeed, ParserError> {
16840        self.expect_token(&Token::LParen)?;
16841        let value = self.parse_number_value()?;
16842        self.expect_token(&Token::RParen)?;
16843        Ok(TableSampleSeed { modifier, value })
16844    }
16845
16846    /// Parses `OPENJSON( jsonExpression [ , path ] )  [ <with_clause> ]` clause,
16847    /// assuming the `OPENJSON` keyword was already consumed.
16848    fn parse_open_json_table_factor(&mut self) -> Result<TableFactor, ParserError> {
16849        self.expect_token(&Token::LParen)?;
16850        let json_expr = self.parse_expr()?;
16851        let json_path = if self.consume_token(&Token::Comma) {
16852            Some(self.parse_value()?)
16853        } else {
16854            None
16855        };
16856        self.expect_token(&Token::RParen)?;
16857        let columns = if self.parse_keyword(Keyword::WITH) {
16858            self.expect_token(&Token::LParen)?;
16859            let columns = self.parse_comma_separated(Parser::parse_openjson_table_column_def)?;
16860            self.expect_token(&Token::RParen)?;
16861            columns
16862        } else {
16863            Vec::new()
16864        };
16865        let alias = self.maybe_parse_table_alias()?;
16866        Ok(TableFactor::OpenJsonTable {
16867            json_expr,
16868            json_path,
16869            columns,
16870            alias,
16871        })
16872    }
16873
16874    fn parse_xml_table_factor(&mut self) -> Result<TableFactor, ParserError> {
16875        self.expect_token(&Token::LParen)?;
16876        let namespaces = if self.parse_keyword(Keyword::XMLNAMESPACES) {
16877            self.expect_token(&Token::LParen)?;
16878            let namespaces = self.parse_comma_separated(Parser::parse_xml_namespace_definition)?;
16879            self.expect_token(&Token::RParen)?;
16880            self.expect_token(&Token::Comma)?;
16881            namespaces
16882        } else {
16883            vec![]
16884        };
16885        let row_expression = self.parse_expr()?;
16886        let passing = self.parse_xml_passing_clause()?;
16887        self.expect_keyword_is(Keyword::COLUMNS)?;
16888        let columns = self.parse_comma_separated(Parser::parse_xml_table_column)?;
16889        self.expect_token(&Token::RParen)?;
16890        let alias = self.maybe_parse_table_alias()?;
16891        Ok(TableFactor::XmlTable {
16892            namespaces,
16893            row_expression,
16894            passing,
16895            columns,
16896            alias,
16897        })
16898    }
16899
16900    fn parse_xml_namespace_definition(&mut self) -> Result<XmlNamespaceDefinition, ParserError> {
16901        let uri = self.parse_expr()?;
16902        self.expect_keyword_is(Keyword::AS)?;
16903        let name = self.parse_identifier()?;
16904        Ok(XmlNamespaceDefinition { uri, name })
16905    }
16906
16907    fn parse_xml_table_column(&mut self) -> Result<XmlTableColumn, ParserError> {
16908        let name = self.parse_identifier()?;
16909
16910        let option = if self.parse_keyword(Keyword::FOR) {
16911            self.expect_keyword(Keyword::ORDINALITY)?;
16912            XmlTableColumnOption::ForOrdinality
16913        } else {
16914            let r#type = self.parse_data_type()?;
16915            let mut path = None;
16916            let mut default = None;
16917
16918            if self.parse_keyword(Keyword::PATH) {
16919                path = Some(self.parse_expr()?);
16920            }
16921
16922            if self.parse_keyword(Keyword::DEFAULT) {
16923                default = Some(self.parse_expr()?);
16924            }
16925
16926            let not_null = self.parse_keywords(&[Keyword::NOT, Keyword::NULL]);
16927            if !not_null {
16928                // NULL is the default but can be specified explicitly
16929                let _ = self.parse_keyword(Keyword::NULL);
16930            }
16931
16932            XmlTableColumnOption::NamedInfo {
16933                r#type,
16934                path,
16935                default,
16936                nullable: !not_null,
16937            }
16938        };
16939        Ok(XmlTableColumn { name, option })
16940    }
16941
16942    fn parse_xml_passing_clause(&mut self) -> Result<XmlPassingClause, ParserError> {
16943        let mut arguments = vec![];
16944        if self.parse_keyword(Keyword::PASSING) {
16945            loop {
16946                let by_value =
16947                    self.parse_keyword(Keyword::BY) && self.expect_keyword(Keyword::VALUE).is_ok();
16948                let expr = self.parse_expr()?;
16949                let alias = if self.parse_keyword(Keyword::AS) {
16950                    Some(self.parse_identifier()?)
16951                } else {
16952                    None
16953                };
16954                arguments.push(XmlPassingArgument {
16955                    expr,
16956                    alias,
16957                    by_value,
16958                });
16959                if !self.consume_token(&Token::Comma) {
16960                    break;
16961                }
16962            }
16963        }
16964        Ok(XmlPassingClause { arguments })
16965    }
16966
16967    /// Parse a [TableFactor::SemanticView]
16968    fn parse_semantic_view_table_factor(&mut self) -> Result<TableFactor, ParserError> {
16969        self.expect_keyword(Keyword::SEMANTIC_VIEW)?;
16970        self.expect_token(&Token::LParen)?;
16971
16972        let name = self.parse_object_name(true)?;
16973
16974        // Parse DIMENSIONS, METRICS, FACTS and WHERE clauses in flexible order
16975        let mut dimensions = Vec::new();
16976        let mut metrics = Vec::new();
16977        let mut facts = Vec::new();
16978        let mut where_clause = None;
16979
16980        while self.peek_token_ref().token != Token::RParen {
16981            if self.parse_keyword(Keyword::DIMENSIONS) {
16982                if !dimensions.is_empty() {
16983                    return Err(ParserError::ParserError(
16984                        "DIMENSIONS clause can only be specified once".to_string(),
16985                    ));
16986                }
16987                dimensions = self.parse_comma_separated(Parser::parse_wildcard_expr)?;
16988            } else if self.parse_keyword(Keyword::METRICS) {
16989                if !metrics.is_empty() {
16990                    return Err(ParserError::ParserError(
16991                        "METRICS clause can only be specified once".to_string(),
16992                    ));
16993                }
16994                metrics = self.parse_comma_separated(Parser::parse_wildcard_expr)?;
16995            } else if self.parse_keyword(Keyword::FACTS) {
16996                if !facts.is_empty() {
16997                    return Err(ParserError::ParserError(
16998                        "FACTS clause can only be specified once".to_string(),
16999                    ));
17000                }
17001                facts = self.parse_comma_separated(Parser::parse_wildcard_expr)?;
17002            } else if self.parse_keyword(Keyword::WHERE) {
17003                if where_clause.is_some() {
17004                    return Err(ParserError::ParserError(
17005                        "WHERE clause can only be specified once".to_string(),
17006                    ));
17007                }
17008                where_clause = Some(self.parse_expr()?);
17009            } else {
17010                let tok = self.peek_token_ref();
17011                return parser_err!(
17012                    format!(
17013                        "Expected one of DIMENSIONS, METRICS, FACTS or WHERE, got {}",
17014                        tok.token
17015                    ),
17016                    tok.span.start
17017                )?;
17018            }
17019        }
17020
17021        self.expect_token(&Token::RParen)?;
17022
17023        let alias = self.maybe_parse_table_alias()?;
17024
17025        Ok(TableFactor::SemanticView {
17026            name,
17027            dimensions,
17028            metrics,
17029            facts,
17030            where_clause,
17031            alias,
17032        })
17033    }
17034
17035    fn parse_match_recognize(&mut self, table: TableFactor) -> Result<TableFactor, ParserError> {
17036        self.expect_token(&Token::LParen)?;
17037
17038        let partition_by = if self.parse_keywords(&[Keyword::PARTITION, Keyword::BY]) {
17039            self.parse_comma_separated(Parser::parse_expr)?
17040        } else {
17041            vec![]
17042        };
17043
17044        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
17045            self.parse_comma_separated(Parser::parse_order_by_expr)?
17046        } else {
17047            vec![]
17048        };
17049
17050        let measures = if self.parse_keyword(Keyword::MEASURES) {
17051            self.parse_comma_separated(|p| {
17052                let expr = p.parse_expr()?;
17053                let _ = p.parse_keyword(Keyword::AS);
17054                let alias = p.parse_identifier()?;
17055                Ok(Measure { expr, alias })
17056            })?
17057        } else {
17058            vec![]
17059        };
17060
17061        let rows_per_match =
17062            if self.parse_keywords(&[Keyword::ONE, Keyword::ROW, Keyword::PER, Keyword::MATCH]) {
17063                Some(RowsPerMatch::OneRow)
17064            } else if self.parse_keywords(&[
17065                Keyword::ALL,
17066                Keyword::ROWS,
17067                Keyword::PER,
17068                Keyword::MATCH,
17069            ]) {
17070                Some(RowsPerMatch::AllRows(
17071                    if self.parse_keywords(&[Keyword::SHOW, Keyword::EMPTY, Keyword::MATCHES]) {
17072                        Some(EmptyMatchesMode::Show)
17073                    } else if self.parse_keywords(&[
17074                        Keyword::OMIT,
17075                        Keyword::EMPTY,
17076                        Keyword::MATCHES,
17077                    ]) {
17078                        Some(EmptyMatchesMode::Omit)
17079                    } else if self.parse_keywords(&[
17080                        Keyword::WITH,
17081                        Keyword::UNMATCHED,
17082                        Keyword::ROWS,
17083                    ]) {
17084                        Some(EmptyMatchesMode::WithUnmatched)
17085                    } else {
17086                        None
17087                    },
17088                ))
17089            } else {
17090                None
17091            };
17092
17093        let after_match_skip =
17094            if self.parse_keywords(&[Keyword::AFTER, Keyword::MATCH, Keyword::SKIP]) {
17095                if self.parse_keywords(&[Keyword::PAST, Keyword::LAST, Keyword::ROW]) {
17096                    Some(AfterMatchSkip::PastLastRow)
17097                } else if self.parse_keywords(&[Keyword::TO, Keyword::NEXT, Keyword::ROW]) {
17098                    Some(AfterMatchSkip::ToNextRow)
17099                } else if self.parse_keywords(&[Keyword::TO, Keyword::FIRST]) {
17100                    Some(AfterMatchSkip::ToFirst(self.parse_identifier()?))
17101                } else if self.parse_keywords(&[Keyword::TO, Keyword::LAST]) {
17102                    Some(AfterMatchSkip::ToLast(self.parse_identifier()?))
17103                } else {
17104                    let found = self.next_token();
17105                    return self.expected("after match skip option", found);
17106                }
17107            } else {
17108                None
17109            };
17110
17111        self.expect_keyword_is(Keyword::PATTERN)?;
17112        let pattern = self.parse_parenthesized(Self::parse_pattern)?;
17113
17114        self.expect_keyword_is(Keyword::DEFINE)?;
17115
17116        let symbols = self.parse_comma_separated(|p| {
17117            let symbol = p.parse_identifier()?;
17118            p.expect_keyword_is(Keyword::AS)?;
17119            let definition = p.parse_expr()?;
17120            Ok(SymbolDefinition { symbol, definition })
17121        })?;
17122
17123        self.expect_token(&Token::RParen)?;
17124
17125        let alias = self.maybe_parse_table_alias()?;
17126
17127        Ok(TableFactor::MatchRecognize {
17128            table: Box::new(table),
17129            partition_by,
17130            order_by,
17131            measures,
17132            rows_per_match,
17133            after_match_skip,
17134            pattern,
17135            symbols,
17136            alias,
17137        })
17138    }
17139
17140    fn parse_base_pattern(&mut self) -> Result<MatchRecognizePattern, ParserError> {
17141        match self.next_token().token {
17142            Token::Caret => Ok(MatchRecognizePattern::Symbol(MatchRecognizeSymbol::Start)),
17143            Token::Placeholder(s) if s == "$" => {
17144                Ok(MatchRecognizePattern::Symbol(MatchRecognizeSymbol::End))
17145            }
17146            Token::LBrace => {
17147                self.expect_token(&Token::Minus)?;
17148                let symbol = self.parse_identifier().map(MatchRecognizeSymbol::Named)?;
17149                self.expect_token(&Token::Minus)?;
17150                self.expect_token(&Token::RBrace)?;
17151                Ok(MatchRecognizePattern::Exclude(symbol))
17152            }
17153            Token::Word(Word {
17154                value,
17155                quote_style: None,
17156                ..
17157            }) if value == "PERMUTE" => {
17158                self.expect_token(&Token::LParen)?;
17159                let symbols = self.parse_comma_separated(|p| {
17160                    p.parse_identifier().map(MatchRecognizeSymbol::Named)
17161                })?;
17162                self.expect_token(&Token::RParen)?;
17163                Ok(MatchRecognizePattern::Permute(symbols))
17164            }
17165            Token::LParen => {
17166                let pattern = self.parse_pattern()?;
17167                self.expect_token(&Token::RParen)?;
17168                Ok(MatchRecognizePattern::Group(Box::new(pattern)))
17169            }
17170            _ => {
17171                self.prev_token();
17172                self.parse_identifier()
17173                    .map(MatchRecognizeSymbol::Named)
17174                    .map(MatchRecognizePattern::Symbol)
17175            }
17176        }
17177    }
17178
17179    fn parse_repetition_pattern(&mut self) -> Result<MatchRecognizePattern, ParserError> {
17180        let mut pattern = self.parse_base_pattern()?;
17181        loop {
17182            let token = self.next_token();
17183            let quantifier = match token.token {
17184                Token::Mul => RepetitionQuantifier::ZeroOrMore,
17185                Token::Plus => RepetitionQuantifier::OneOrMore,
17186                Token::Placeholder(s) if s == "?" => RepetitionQuantifier::AtMostOne,
17187                Token::LBrace => {
17188                    // quantifier is a range like {n} or {n,} or {,m} or {n,m}
17189                    let token = self.next_token();
17190                    match token.token {
17191                        Token::Comma => {
17192                            let next_token = self.next_token();
17193                            let Token::Number(n, _) = next_token.token else {
17194                                return self.expected("literal number", next_token);
17195                            };
17196                            self.expect_token(&Token::RBrace)?;
17197                            RepetitionQuantifier::AtMost(Self::parse(n, token.span.start)?)
17198                        }
17199                        Token::Number(n, _) if self.consume_token(&Token::Comma) => {
17200                            let next_token = self.next_token();
17201                            match next_token.token {
17202                                Token::Number(m, _) => {
17203                                    self.expect_token(&Token::RBrace)?;
17204                                    RepetitionQuantifier::Range(
17205                                        Self::parse(n, token.span.start)?,
17206                                        Self::parse(m, token.span.start)?,
17207                                    )
17208                                }
17209                                Token::RBrace => {
17210                                    RepetitionQuantifier::AtLeast(Self::parse(n, token.span.start)?)
17211                                }
17212                                _ => {
17213                                    return self.expected("} or upper bound", next_token);
17214                                }
17215                            }
17216                        }
17217                        Token::Number(n, _) => {
17218                            self.expect_token(&Token::RBrace)?;
17219                            RepetitionQuantifier::Exactly(Self::parse(n, token.span.start)?)
17220                        }
17221                        _ => return self.expected("quantifier range", token),
17222                    }
17223                }
17224                _ => {
17225                    self.prev_token();
17226                    break;
17227                }
17228            };
17229            pattern = MatchRecognizePattern::Repetition(Box::new(pattern), quantifier);
17230        }
17231        Ok(pattern)
17232    }
17233
17234    fn parse_concat_pattern(&mut self) -> Result<MatchRecognizePattern, ParserError> {
17235        let mut patterns = vec![self.parse_repetition_pattern()?];
17236        while !matches!(self.peek_token_ref().token, Token::RParen | Token::Pipe) {
17237            patterns.push(self.parse_repetition_pattern()?);
17238        }
17239        match <[MatchRecognizePattern; 1]>::try_from(patterns) {
17240            Ok([pattern]) => Ok(pattern),
17241            Err(patterns) => Ok(MatchRecognizePattern::Concat(patterns)),
17242        }
17243    }
17244
17245    fn parse_pattern(&mut self) -> Result<MatchRecognizePattern, ParserError> {
17246        let pattern = self.parse_concat_pattern()?;
17247        if self.consume_token(&Token::Pipe) {
17248            match self.parse_pattern()? {
17249                // flatten nested alternations
17250                MatchRecognizePattern::Alternation(mut patterns) => {
17251                    patterns.insert(0, pattern);
17252                    Ok(MatchRecognizePattern::Alternation(patterns))
17253                }
17254                next => Ok(MatchRecognizePattern::Alternation(vec![pattern, next])),
17255            }
17256        } else {
17257            Ok(pattern)
17258        }
17259    }
17260
17261    /// Parses a the timestamp version specifier (i.e. query historical data)
17262    pub fn maybe_parse_table_version(&mut self) -> Result<Option<TableVersion>, ParserError> {
17263        if self.dialect.supports_table_versioning() {
17264            if self.parse_keywords(&[Keyword::FOR, Keyword::SYSTEM_TIME, Keyword::AS, Keyword::OF])
17265            {
17266                let expr = self.parse_expr()?;
17267                return Ok(Some(TableVersion::ForSystemTimeAsOf(expr)));
17268            } else if self.peek_keyword(Keyword::CHANGES) {
17269                return self.parse_table_version_changes().map(Some);
17270            } else if self.peek_keyword(Keyword::AT) || self.peek_keyword(Keyword::BEFORE) {
17271                let func_name = self.parse_object_name(true)?;
17272                let func = self.parse_function(func_name)?;
17273                return Ok(Some(TableVersion::Function(func)));
17274            } else if self.parse_keywords(&[Keyword::TIMESTAMP, Keyword::AS, Keyword::OF]) {
17275                let expr = self.parse_expr()?;
17276                return Ok(Some(TableVersion::TimestampAsOf(expr)));
17277            } else if self.parse_keywords(&[Keyword::VERSION, Keyword::AS, Keyword::OF]) {
17278                let expr = Expr::Value(self.parse_number_value()?);
17279                return Ok(Some(TableVersion::VersionAsOf(expr)));
17280            }
17281        }
17282        Ok(None)
17283    }
17284
17285    /// Parses the Snowflake `CHANGES` clause for change tracking queries.
17286    ///
17287    /// Syntax:
17288    /// ```sql
17289    /// CHANGES (INFORMATION => DEFAULT)
17290    ///   AT (TIMESTAMP => <expr>)
17291    ///   [END (TIMESTAMP => <expr>)]
17292    /// ```
17293    ///
17294    /// <https://docs.snowflake.com/en/sql-reference/constructs/changes>
17295    fn parse_table_version_changes(&mut self) -> Result<TableVersion, ParserError> {
17296        let changes_name = self.parse_object_name(true)?;
17297        let changes = self.parse_function(changes_name)?;
17298        let at_name = self.parse_object_name(true)?;
17299        let at = self.parse_function(at_name)?;
17300        let end = if self.peek_keyword(Keyword::END) {
17301            let end_name = self.parse_object_name(true)?;
17302            Some(self.parse_function(end_name)?)
17303        } else {
17304            None
17305        };
17306        Ok(TableVersion::Changes { changes, at, end })
17307    }
17308
17309    /// Parses MySQL's JSON_TABLE column definition.
17310    /// For example: `id INT EXISTS PATH '$' DEFAULT '0' ON EMPTY ERROR ON ERROR`
17311    pub fn parse_json_table_column_def(&mut self) -> Result<JsonTableColumn, ParserError> {
17312        if self.parse_keyword(Keyword::NESTED) {
17313            let _has_path_keyword = self.parse_keyword(Keyword::PATH);
17314            let path = self.parse_value()?;
17315            self.expect_keyword_is(Keyword::COLUMNS)?;
17316            let columns = self.parse_parenthesized(|p| {
17317                p.parse_comma_separated(Self::parse_json_table_column_def)
17318            })?;
17319            return Ok(JsonTableColumn::Nested(JsonTableNestedColumn {
17320                path,
17321                columns,
17322            }));
17323        }
17324        let name = self.parse_identifier()?;
17325        if self.parse_keyword(Keyword::FOR) {
17326            self.expect_keyword_is(Keyword::ORDINALITY)?;
17327            return Ok(JsonTableColumn::ForOrdinality(name));
17328        }
17329        let r#type = self.parse_data_type()?;
17330        let exists = self.parse_keyword(Keyword::EXISTS);
17331        self.expect_keyword_is(Keyword::PATH)?;
17332        let path = self.parse_value()?;
17333        let mut on_empty = None;
17334        let mut on_error = None;
17335        while let Some(error_handling) = self.parse_json_table_column_error_handling()? {
17336            if self.parse_keyword(Keyword::EMPTY) {
17337                on_empty = Some(error_handling);
17338            } else {
17339                self.expect_keyword_is(Keyword::ERROR)?;
17340                on_error = Some(error_handling);
17341            }
17342        }
17343        Ok(JsonTableColumn::Named(JsonTableNamedColumn {
17344            name,
17345            r#type,
17346            path,
17347            exists,
17348            on_empty,
17349            on_error,
17350        }))
17351    }
17352
17353    /// Parses MSSQL's `OPENJSON WITH` column definition.
17354    ///
17355    /// ```sql
17356    /// colName type [ column_path ] [ AS JSON ]
17357    /// ```
17358    ///
17359    /// Reference: <https://learn.microsoft.com/en-us/sql/t-sql/functions/openjson-transact-sql?view=sql-server-ver16#syntax>
17360    pub fn parse_openjson_table_column_def(&mut self) -> Result<OpenJsonTableColumn, ParserError> {
17361        let name = self.parse_identifier()?;
17362        let r#type = self.parse_data_type()?;
17363        let path = if let Token::SingleQuotedString(path) = self.peek_token().token {
17364            self.next_token();
17365            Some(path)
17366        } else {
17367            None
17368        };
17369        let as_json = self.parse_keyword(Keyword::AS);
17370        if as_json {
17371            self.expect_keyword_is(Keyword::JSON)?;
17372        }
17373        Ok(OpenJsonTableColumn {
17374            name,
17375            r#type,
17376            path,
17377            as_json,
17378        })
17379    }
17380
17381    fn parse_json_table_column_error_handling(
17382        &mut self,
17383    ) -> Result<Option<JsonTableColumnErrorHandling>, ParserError> {
17384        let res = if self.parse_keyword(Keyword::NULL) {
17385            JsonTableColumnErrorHandling::Null
17386        } else if self.parse_keyword(Keyword::ERROR) {
17387            JsonTableColumnErrorHandling::Error
17388        } else if self.parse_keyword(Keyword::DEFAULT) {
17389            JsonTableColumnErrorHandling::Default(self.parse_value()?)
17390        } else {
17391            return Ok(None);
17392        };
17393        self.expect_keyword_is(Keyword::ON)?;
17394        Ok(Some(res))
17395    }
17396
17397    /// Parse a derived table factor (a parenthesized subquery), handling optional LATERAL.
17398    pub fn parse_derived_table_factor(
17399        &mut self,
17400        lateral: IsLateral,
17401    ) -> Result<TableFactor, ParserError> {
17402        let subquery = self.parse_query()?;
17403        self.expect_token(&Token::RParen)?;
17404        let alias = self.maybe_parse_table_alias()?;
17405
17406        // Parse optional SAMPLE clause after alias
17407        let sample = self
17408            .maybe_parse_table_sample()?
17409            .map(TableSampleKind::AfterTableAlias);
17410
17411        Ok(TableFactor::Derived {
17412            lateral: match lateral {
17413                Lateral => true,
17414                NotLateral => false,
17415            },
17416            subquery,
17417            alias,
17418            sample,
17419        })
17420    }
17421
17422    /// Parses an expression with an optional alias
17423    ///
17424    /// Examples:
17425    ///
17426    /// ```sql
17427    /// SUM(price) AS total_price
17428    /// ```
17429    /// ```sql
17430    /// SUM(price)
17431    /// ```
17432    ///
17433    /// Example
17434    /// ```
17435    /// # use sqlparser::parser::{Parser, ParserError};
17436    /// # use sqlparser::dialect::GenericDialect;
17437    /// # fn main() ->Result<(), ParserError> {
17438    /// let sql = r#"SUM("a") as "b""#;
17439    /// let mut parser = Parser::new(&GenericDialect).try_with_sql(sql)?;
17440    /// let expr_with_alias = parser.parse_expr_with_alias()?;
17441    /// assert_eq!(Some("b".to_string()), expr_with_alias.alias.map(|x|x.value));
17442    /// # Ok(())
17443    /// # }
17444    pub fn parse_expr_with_alias(&mut self) -> Result<ExprWithAlias, ParserError> {
17445        let expr = self.parse_expr()?;
17446        let alias = if self.parse_keyword(Keyword::AS) {
17447            Some(self.parse_identifier()?)
17448        } else {
17449            None
17450        };
17451
17452        Ok(ExprWithAlias { expr, alias })
17453    }
17454
17455    /// Parse an expression followed by an optional alias; Unlike
17456    /// [Self::parse_expr_with_alias] the "AS" keyword between the expression
17457    /// and the alias is optional.
17458    fn parse_expr_with_alias_optional_as_keyword(&mut self) -> Result<ExprWithAlias, ParserError> {
17459        let expr = self.parse_expr()?;
17460        let alias = self.parse_identifier_optional_alias()?;
17461        Ok(ExprWithAlias { expr, alias })
17462    }
17463
17464    /// Parses a plain function call with an optional alias for the `PIVOT` clause
17465    fn parse_pivot_aggregate_function(&mut self) -> Result<ExprWithAlias, ParserError> {
17466        let function_name = match self.next_token().token {
17467            Token::Word(w) => Ok(w.value),
17468            _ => self.expected_ref("a function identifier", self.peek_token_ref()),
17469        }?;
17470        let expr = self.parse_function(ObjectName::from(vec![Ident::new(function_name)]))?;
17471        let alias = {
17472            fn validator(explicit: bool, kw: &Keyword, parser: &mut Parser) -> bool {
17473                // ~ for a PIVOT aggregate function the alias must not be a "FOR"; in any dialect
17474                kw != &Keyword::FOR && parser.dialect.is_select_item_alias(explicit, kw, parser)
17475            }
17476            self.parse_optional_alias_inner(None, validator)?
17477        };
17478        Ok(ExprWithAlias { expr, alias })
17479    }
17480
17481    /// Parse a PIVOT table factor (ClickHouse/Oracle style pivot), returning a TableFactor.
17482    pub fn parse_pivot_table_factor(
17483        &mut self,
17484        table: TableFactor,
17485    ) -> Result<TableFactor, ParserError> {
17486        self.expect_token(&Token::LParen)?;
17487        let aggregate_functions =
17488            self.parse_comma_separated(Self::parse_pivot_aggregate_function)?;
17489        self.expect_keyword_is(Keyword::FOR)?;
17490        let value_column = if self.peek_token_ref().token == Token::LParen {
17491            self.parse_parenthesized_column_list_inner(Mandatory, false, |p| {
17492                p.parse_subexpr(self.dialect.prec_value(Precedence::Between))
17493            })?
17494        } else {
17495            vec![self.parse_subexpr(self.dialect.prec_value(Precedence::Between))?]
17496        };
17497        self.expect_keyword_is(Keyword::IN)?;
17498
17499        self.expect_token(&Token::LParen)?;
17500        let value_source = if self.parse_keyword(Keyword::ANY) {
17501            let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
17502                self.parse_comma_separated(Parser::parse_order_by_expr)?
17503            } else {
17504                vec![]
17505            };
17506            PivotValueSource::Any(order_by)
17507        } else if self.peek_sub_query() {
17508            PivotValueSource::Subquery(self.parse_query()?)
17509        } else {
17510            PivotValueSource::List(
17511                self.parse_comma_separated(Self::parse_expr_with_alias_optional_as_keyword)?,
17512            )
17513        };
17514        self.expect_token(&Token::RParen)?;
17515
17516        let default_on_null =
17517            if self.parse_keywords(&[Keyword::DEFAULT, Keyword::ON, Keyword::NULL]) {
17518                self.expect_token(&Token::LParen)?;
17519                let expr = self.parse_expr()?;
17520                self.expect_token(&Token::RParen)?;
17521                Some(expr)
17522            } else {
17523                None
17524            };
17525
17526        self.expect_token(&Token::RParen)?;
17527        let alias = self.maybe_parse_table_alias()?;
17528        Ok(TableFactor::Pivot {
17529            table: Box::new(table),
17530            aggregate_functions,
17531            value_column,
17532            value_source,
17533            default_on_null,
17534            alias,
17535        })
17536    }
17537
17538    /// Parse an UNPIVOT table factor, returning a TableFactor.
17539    pub fn parse_unpivot_table_factor(
17540        &mut self,
17541        table: TableFactor,
17542    ) -> Result<TableFactor, ParserError> {
17543        let null_inclusion = if self.parse_keyword(Keyword::INCLUDE) {
17544            self.expect_keyword_is(Keyword::NULLS)?;
17545            Some(NullInclusion::IncludeNulls)
17546        } else if self.parse_keyword(Keyword::EXCLUDE) {
17547            self.expect_keyword_is(Keyword::NULLS)?;
17548            Some(NullInclusion::ExcludeNulls)
17549        } else {
17550            None
17551        };
17552        self.expect_token(&Token::LParen)?;
17553        let value = self.parse_expr()?;
17554        self.expect_keyword_is(Keyword::FOR)?;
17555        let name = self.parse_identifier()?;
17556        self.expect_keyword_is(Keyword::IN)?;
17557        let columns = self.parse_parenthesized_column_list_inner(Mandatory, false, |p| {
17558            p.parse_expr_with_alias()
17559        })?;
17560        self.expect_token(&Token::RParen)?;
17561        let alias = self.maybe_parse_table_alias()?;
17562        Ok(TableFactor::Unpivot {
17563            table: Box::new(table),
17564            value,
17565            null_inclusion,
17566            name,
17567            columns,
17568            alias,
17569        })
17570    }
17571
17572    /// Parse a JOIN constraint (`NATURAL`, `ON <expr>`, `USING (...)`, or no constraint).
17573    pub fn parse_join_constraint(&mut self, natural: bool) -> Result<JoinConstraint, ParserError> {
17574        if natural {
17575            Ok(JoinConstraint::Natural)
17576        } else if self.parse_keyword(Keyword::ON) {
17577            let constraint = self.parse_expr()?;
17578            Ok(JoinConstraint::On(constraint))
17579        } else if self.parse_keyword(Keyword::USING) {
17580            let columns = self.parse_parenthesized_qualified_column_list(Mandatory, false)?;
17581            Ok(JoinConstraint::Using(columns))
17582        } else {
17583            Ok(JoinConstraint::None)
17584            //self.expected_ref("ON, or USING after JOIN", self.peek_token_ref())
17585        }
17586    }
17587
17588    /// Parse a GRANT statement.
17589    pub fn parse_grant(&mut self) -> Result<Grant, ParserError> {
17590        let (privileges, objects) = self.parse_grant_deny_revoke_privileges_objects()?;
17591
17592        self.expect_keyword_is(Keyword::TO)?;
17593        let grantees = self.parse_grantees()?;
17594
17595        let with_grant_option =
17596            self.parse_keywords(&[Keyword::WITH, Keyword::GRANT, Keyword::OPTION]);
17597
17598        let current_grants =
17599            if self.parse_keywords(&[Keyword::COPY, Keyword::CURRENT, Keyword::GRANTS]) {
17600                Some(CurrentGrantsKind::CopyCurrentGrants)
17601            } else if self.parse_keywords(&[Keyword::REVOKE, Keyword::CURRENT, Keyword::GRANTS]) {
17602                Some(CurrentGrantsKind::RevokeCurrentGrants)
17603            } else {
17604                None
17605            };
17606
17607        let as_grantor = if self.parse_keywords(&[Keyword::AS]) {
17608            Some(self.parse_identifier()?)
17609        } else {
17610            None
17611        };
17612
17613        let granted_by = if self.parse_keywords(&[Keyword::GRANTED, Keyword::BY]) {
17614            Some(self.parse_identifier()?)
17615        } else {
17616            None
17617        };
17618
17619        Ok(Grant {
17620            privileges,
17621            objects,
17622            grantees,
17623            with_grant_option,
17624            as_grantor,
17625            granted_by,
17626            current_grants,
17627        })
17628    }
17629
17630    fn parse_grantees(&mut self) -> Result<Vec<Grantee>, ParserError> {
17631        let mut values = vec![];
17632        let mut grantee_type = GranteesType::None;
17633        loop {
17634            let new_grantee_type = if self.parse_keyword(Keyword::ROLE) {
17635                GranteesType::Role
17636            } else if self.parse_keyword(Keyword::USER) {
17637                GranteesType::User
17638            } else if self.parse_keyword(Keyword::SHARE) {
17639                GranteesType::Share
17640            } else if self.parse_keyword(Keyword::GROUP) {
17641                GranteesType::Group
17642            } else if self.parse_keyword(Keyword::PUBLIC) {
17643                GranteesType::Public
17644            } else if self.parse_keywords(&[Keyword::DATABASE, Keyword::ROLE]) {
17645                GranteesType::DatabaseRole
17646            } else if self.parse_keywords(&[Keyword::APPLICATION, Keyword::ROLE]) {
17647                GranteesType::ApplicationRole
17648            } else if self.parse_keyword(Keyword::APPLICATION) {
17649                GranteesType::Application
17650            } else {
17651                grantee_type.clone() // keep from previous iteraton, if not specified
17652            };
17653
17654            if self
17655                .dialect
17656                .get_reserved_grantees_types()
17657                .contains(&new_grantee_type)
17658            {
17659                self.prev_token();
17660            } else {
17661                grantee_type = new_grantee_type;
17662            }
17663
17664            let grantee = if grantee_type == GranteesType::Public {
17665                Grantee {
17666                    grantee_type: grantee_type.clone(),
17667                    name: None,
17668                }
17669            } else {
17670                let mut name = self.parse_grantee_name()?;
17671                if self.consume_token(&Token::Colon) {
17672                    // Redshift supports namespace prefix for external users and groups:
17673                    // <Namespace>:<GroupName> or <Namespace>:<UserName>
17674                    // https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-native-idp.html
17675                    let ident = self.parse_identifier()?;
17676                    if let GranteeName::ObjectName(namespace) = name {
17677                        name = GranteeName::ObjectName(ObjectName::from(vec![Ident::new(
17678                            format!("{namespace}:{ident}"),
17679                        )]));
17680                    };
17681                }
17682                Grantee {
17683                    grantee_type: grantee_type.clone(),
17684                    name: Some(name),
17685                }
17686            };
17687
17688            values.push(grantee);
17689
17690            if !self.consume_token(&Token::Comma) {
17691                break;
17692            }
17693        }
17694
17695        Ok(values)
17696    }
17697
17698    /// Parse privileges and optional target objects for GRANT/DENY/REVOKE statements.
17699    pub fn parse_grant_deny_revoke_privileges_objects(
17700        &mut self,
17701    ) -> Result<(Privileges, Option<GrantObjects>), ParserError> {
17702        let privileges = if self.parse_keyword(Keyword::ALL) {
17703            Privileges::All {
17704                with_privileges_keyword: self.parse_keyword(Keyword::PRIVILEGES),
17705            }
17706        } else {
17707            let actions = self.parse_actions_list()?;
17708            Privileges::Actions(actions)
17709        };
17710
17711        let objects = if self.parse_keyword(Keyword::ON) {
17712            if self.parse_keywords(&[Keyword::ALL, Keyword::TABLES, Keyword::IN, Keyword::SCHEMA]) {
17713                Some(GrantObjects::AllTablesInSchema {
17714                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17715                })
17716            } else if self.parse_keywords(&[
17717                Keyword::ALL,
17718                Keyword::EXTERNAL,
17719                Keyword::TABLES,
17720                Keyword::IN,
17721                Keyword::SCHEMA,
17722            ]) {
17723                Some(GrantObjects::AllExternalTablesInSchema {
17724                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17725                })
17726            } else if self.parse_keywords(&[
17727                Keyword::ALL,
17728                Keyword::VIEWS,
17729                Keyword::IN,
17730                Keyword::SCHEMA,
17731            ]) {
17732                Some(GrantObjects::AllViewsInSchema {
17733                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17734                })
17735            } else if self.parse_keywords(&[
17736                Keyword::ALL,
17737                Keyword::MATERIALIZED,
17738                Keyword::VIEWS,
17739                Keyword::IN,
17740                Keyword::SCHEMA,
17741            ]) {
17742                Some(GrantObjects::AllMaterializedViewsInSchema {
17743                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17744                })
17745            } else if self.parse_keywords(&[
17746                Keyword::ALL,
17747                Keyword::FUNCTIONS,
17748                Keyword::IN,
17749                Keyword::SCHEMA,
17750            ]) {
17751                Some(GrantObjects::AllFunctionsInSchema {
17752                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17753                })
17754            } else if self.parse_keywords(&[
17755                Keyword::FUTURE,
17756                Keyword::SCHEMAS,
17757                Keyword::IN,
17758                Keyword::DATABASE,
17759            ]) {
17760                Some(GrantObjects::FutureSchemasInDatabase {
17761                    databases: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17762                })
17763            } else if self.parse_keywords(&[
17764                Keyword::FUTURE,
17765                Keyword::TABLES,
17766                Keyword::IN,
17767                Keyword::SCHEMA,
17768            ]) {
17769                Some(GrantObjects::FutureTablesInSchema {
17770                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17771                })
17772            } else if self.parse_keywords(&[
17773                Keyword::FUTURE,
17774                Keyword::EXTERNAL,
17775                Keyword::TABLES,
17776                Keyword::IN,
17777                Keyword::SCHEMA,
17778            ]) {
17779                Some(GrantObjects::FutureExternalTablesInSchema {
17780                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17781                })
17782            } else if self.parse_keywords(&[
17783                Keyword::FUTURE,
17784                Keyword::VIEWS,
17785                Keyword::IN,
17786                Keyword::SCHEMA,
17787            ]) {
17788                Some(GrantObjects::FutureViewsInSchema {
17789                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17790                })
17791            } else if self.parse_keywords(&[
17792                Keyword::FUTURE,
17793                Keyword::MATERIALIZED,
17794                Keyword::VIEWS,
17795                Keyword::IN,
17796                Keyword::SCHEMA,
17797            ]) {
17798                Some(GrantObjects::FutureMaterializedViewsInSchema {
17799                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17800                })
17801            } else if self.parse_keywords(&[
17802                Keyword::ALL,
17803                Keyword::SEQUENCES,
17804                Keyword::IN,
17805                Keyword::SCHEMA,
17806            ]) {
17807                Some(GrantObjects::AllSequencesInSchema {
17808                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17809                })
17810            } else if self.parse_keywords(&[
17811                Keyword::FUTURE,
17812                Keyword::SEQUENCES,
17813                Keyword::IN,
17814                Keyword::SCHEMA,
17815            ]) {
17816                Some(GrantObjects::FutureSequencesInSchema {
17817                    schemas: self.parse_comma_separated(|p| p.parse_object_name(false))?,
17818                })
17819            } else if self.parse_keywords(&[Keyword::RESOURCE, Keyword::MONITOR]) {
17820                Some(GrantObjects::ResourceMonitors(
17821                    self.parse_comma_separated(|p| p.parse_object_name(false))?,
17822                ))
17823            } else if self.parse_keywords(&[Keyword::COMPUTE, Keyword::POOL]) {
17824                Some(GrantObjects::ComputePools(
17825                    self.parse_comma_separated(|p| p.parse_object_name(false))?,
17826                ))
17827            } else if self.parse_keywords(&[Keyword::FAILOVER, Keyword::GROUP]) {
17828                Some(GrantObjects::FailoverGroup(
17829                    self.parse_comma_separated(|p| p.parse_object_name(false))?,
17830                ))
17831            } else if self.parse_keywords(&[Keyword::REPLICATION, Keyword::GROUP]) {
17832                Some(GrantObjects::ReplicationGroup(
17833                    self.parse_comma_separated(|p| p.parse_object_name(false))?,
17834                ))
17835            } else if self.parse_keywords(&[Keyword::EXTERNAL, Keyword::VOLUME]) {
17836                Some(GrantObjects::ExternalVolumes(
17837                    self.parse_comma_separated(|p| p.parse_object_name(false))?,
17838                ))
17839            } else {
17840                let object_type = self.parse_one_of_keywords(&[
17841                    Keyword::SEQUENCE,
17842                    Keyword::DATABASE,
17843                    Keyword::SCHEMA,
17844                    Keyword::TABLE,
17845                    Keyword::VIEW,
17846                    Keyword::WAREHOUSE,
17847                    Keyword::INTEGRATION,
17848                    Keyword::VIEW,
17849                    Keyword::WAREHOUSE,
17850                    Keyword::INTEGRATION,
17851                    Keyword::USER,
17852                    Keyword::CONNECTION,
17853                    Keyword::PROCEDURE,
17854                    Keyword::FUNCTION,
17855                ]);
17856                let objects =
17857                    self.parse_comma_separated(|p| p.parse_object_name_inner(false, true));
17858                match object_type {
17859                    Some(Keyword::DATABASE) => Some(GrantObjects::Databases(objects?)),
17860                    Some(Keyword::SCHEMA) => Some(GrantObjects::Schemas(objects?)),
17861                    Some(Keyword::SEQUENCE) => Some(GrantObjects::Sequences(objects?)),
17862                    Some(Keyword::WAREHOUSE) => Some(GrantObjects::Warehouses(objects?)),
17863                    Some(Keyword::INTEGRATION) => Some(GrantObjects::Integrations(objects?)),
17864                    Some(Keyword::VIEW) => Some(GrantObjects::Views(objects?)),
17865                    Some(Keyword::USER) => Some(GrantObjects::Users(objects?)),
17866                    Some(Keyword::CONNECTION) => Some(GrantObjects::Connections(objects?)),
17867                    kw @ (Some(Keyword::PROCEDURE) | Some(Keyword::FUNCTION)) => {
17868                        if let Some(name) = objects?.first() {
17869                            self.parse_grant_procedure_or_function(name, &kw)?
17870                        } else {
17871                            self.expected_ref("procedure or function name", self.peek_token_ref())?
17872                        }
17873                    }
17874                    Some(Keyword::TABLE) | None => Some(GrantObjects::Tables(objects?)),
17875                    Some(unexpected_keyword) => return Err(ParserError::ParserError(
17876                        format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in grant objects"),
17877                    )),
17878                }
17879            }
17880        } else {
17881            None
17882        };
17883
17884        Ok((privileges, objects))
17885    }
17886
17887    fn parse_grant_procedure_or_function(
17888        &mut self,
17889        name: &ObjectName,
17890        kw: &Option<Keyword>,
17891    ) -> Result<Option<GrantObjects>, ParserError> {
17892        let arg_types = if self.consume_token(&Token::LParen) {
17893            let list = self.parse_comma_separated0(Self::parse_data_type, Token::RParen)?;
17894            self.expect_token(&Token::RParen)?;
17895            list
17896        } else {
17897            vec![]
17898        };
17899        match kw {
17900            Some(Keyword::PROCEDURE) => Ok(Some(GrantObjects::Procedure {
17901                name: name.clone(),
17902                arg_types,
17903            })),
17904            Some(Keyword::FUNCTION) => Ok(Some(GrantObjects::Function {
17905                name: name.clone(),
17906                arg_types,
17907            })),
17908            _ => self.expected_ref("procedure or function keywords", self.peek_token_ref())?,
17909        }
17910    }
17911
17912    /// Parse a single grantable permission/action (used within GRANT statements).
17913    pub fn parse_grant_permission(&mut self) -> Result<Action, ParserError> {
17914        fn parse_columns(parser: &mut Parser) -> Result<Option<Vec<Ident>>, ParserError> {
17915            let columns = parser.parse_parenthesized_column_list(Optional, false)?;
17916            if columns.is_empty() {
17917                Ok(None)
17918            } else {
17919                Ok(Some(columns))
17920            }
17921        }
17922
17923        // Multi-word privileges
17924        if self.parse_keywords(&[Keyword::IMPORTED, Keyword::PRIVILEGES]) {
17925            Ok(Action::ImportedPrivileges)
17926        } else if self.parse_keywords(&[Keyword::ADD, Keyword::SEARCH, Keyword::OPTIMIZATION]) {
17927            Ok(Action::AddSearchOptimization)
17928        } else if self.parse_keywords(&[Keyword::ATTACH, Keyword::LISTING]) {
17929            Ok(Action::AttachListing)
17930        } else if self.parse_keywords(&[Keyword::ATTACH, Keyword::POLICY]) {
17931            Ok(Action::AttachPolicy)
17932        } else if self.parse_keywords(&[Keyword::BIND, Keyword::SERVICE, Keyword::ENDPOINT]) {
17933            Ok(Action::BindServiceEndpoint)
17934        } else if self.parse_keywords(&[Keyword::DATABASE, Keyword::ROLE]) {
17935            let role = self.parse_object_name(false)?;
17936            Ok(Action::DatabaseRole { role })
17937        } else if self.parse_keywords(&[Keyword::EVOLVE, Keyword::SCHEMA]) {
17938            Ok(Action::EvolveSchema)
17939        } else if self.parse_keywords(&[Keyword::IMPORT, Keyword::SHARE]) {
17940            Ok(Action::ImportShare)
17941        } else if self.parse_keywords(&[Keyword::MANAGE, Keyword::VERSIONS]) {
17942            Ok(Action::ManageVersions)
17943        } else if self.parse_keywords(&[Keyword::MANAGE, Keyword::RELEASES]) {
17944            Ok(Action::ManageReleases)
17945        } else if self.parse_keywords(&[Keyword::OVERRIDE, Keyword::SHARE, Keyword::RESTRICTIONS]) {
17946            Ok(Action::OverrideShareRestrictions)
17947        } else if self.parse_keywords(&[
17948            Keyword::PURCHASE,
17949            Keyword::DATA,
17950            Keyword::EXCHANGE,
17951            Keyword::LISTING,
17952        ]) {
17953            Ok(Action::PurchaseDataExchangeListing)
17954        } else if self.parse_keywords(&[Keyword::RESOLVE, Keyword::ALL]) {
17955            Ok(Action::ResolveAll)
17956        } else if self.parse_keywords(&[Keyword::READ, Keyword::SESSION]) {
17957            Ok(Action::ReadSession)
17958
17959        // Single-word privileges
17960        } else if self.parse_keyword(Keyword::APPLY) {
17961            let apply_type = self.parse_action_apply_type()?;
17962            Ok(Action::Apply { apply_type })
17963        } else if self.parse_keyword(Keyword::APPLYBUDGET) {
17964            Ok(Action::ApplyBudget)
17965        } else if self.parse_keyword(Keyword::AUDIT) {
17966            Ok(Action::Audit)
17967        } else if self.parse_keyword(Keyword::CONNECT) {
17968            Ok(Action::Connect)
17969        } else if self.parse_keyword(Keyword::CREATE) {
17970            let obj_type = self.maybe_parse_action_create_object_type();
17971            Ok(Action::Create { obj_type })
17972        } else if self.parse_keyword(Keyword::DELETE) {
17973            Ok(Action::Delete)
17974        } else if self.parse_keyword(Keyword::EXEC) {
17975            let obj_type = self.maybe_parse_action_execute_obj_type();
17976            Ok(Action::Exec { obj_type })
17977        } else if self.parse_keyword(Keyword::EXECUTE) {
17978            let obj_type = self.maybe_parse_action_execute_obj_type();
17979            Ok(Action::Execute { obj_type })
17980        } else if self.parse_keyword(Keyword::FAILOVER) {
17981            Ok(Action::Failover)
17982        } else if self.parse_keyword(Keyword::INSERT) {
17983            Ok(Action::Insert {
17984                columns: parse_columns(self)?,
17985            })
17986        } else if self.parse_keyword(Keyword::MANAGE) {
17987            let manage_type = self.parse_action_manage_type()?;
17988            Ok(Action::Manage { manage_type })
17989        } else if self.parse_keyword(Keyword::MODIFY) {
17990            let modify_type = self.parse_action_modify_type();
17991            Ok(Action::Modify { modify_type })
17992        } else if self.parse_keyword(Keyword::MONITOR) {
17993            let monitor_type = self.parse_action_monitor_type();
17994            Ok(Action::Monitor { monitor_type })
17995        } else if self.parse_keyword(Keyword::OPERATE) {
17996            Ok(Action::Operate)
17997        } else if self.parse_keyword(Keyword::REFERENCES) {
17998            Ok(Action::References {
17999                columns: parse_columns(self)?,
18000            })
18001        } else if self.parse_keyword(Keyword::READ) {
18002            Ok(Action::Read)
18003        } else if self.parse_keyword(Keyword::REPLICATE) {
18004            Ok(Action::Replicate)
18005        } else if self.parse_keyword(Keyword::ROLE) {
18006            let role = self.parse_object_name(false)?;
18007            Ok(Action::Role { role })
18008        } else if self.parse_keyword(Keyword::SELECT) {
18009            Ok(Action::Select {
18010                columns: parse_columns(self)?,
18011            })
18012        } else if self.parse_keyword(Keyword::TEMPORARY) {
18013            Ok(Action::Temporary)
18014        } else if self.parse_keyword(Keyword::TRIGGER) {
18015            Ok(Action::Trigger)
18016        } else if self.parse_keyword(Keyword::TRUNCATE) {
18017            Ok(Action::Truncate)
18018        } else if self.parse_keyword(Keyword::UPDATE) {
18019            Ok(Action::Update {
18020                columns: parse_columns(self)?,
18021            })
18022        } else if self.parse_keyword(Keyword::USAGE) {
18023            Ok(Action::Usage)
18024        } else if self.parse_keyword(Keyword::OWNERSHIP) {
18025            Ok(Action::Ownership)
18026        } else if self.parse_keyword(Keyword::DROP) {
18027            Ok(Action::Drop)
18028        } else {
18029            self.expected_ref("a privilege keyword", self.peek_token_ref())?
18030        }
18031    }
18032
18033    fn maybe_parse_action_create_object_type(&mut self) -> Option<ActionCreateObjectType> {
18034        // Multi-word object types
18035        if self.parse_keywords(&[Keyword::APPLICATION, Keyword::PACKAGE]) {
18036            Some(ActionCreateObjectType::ApplicationPackage)
18037        } else if self.parse_keywords(&[Keyword::COMPUTE, Keyword::POOL]) {
18038            Some(ActionCreateObjectType::ComputePool)
18039        } else if self.parse_keywords(&[Keyword::DATA, Keyword::EXCHANGE, Keyword::LISTING]) {
18040            Some(ActionCreateObjectType::DataExchangeListing)
18041        } else if self.parse_keywords(&[Keyword::EXTERNAL, Keyword::VOLUME]) {
18042            Some(ActionCreateObjectType::ExternalVolume)
18043        } else if self.parse_keywords(&[Keyword::FAILOVER, Keyword::GROUP]) {
18044            Some(ActionCreateObjectType::FailoverGroup)
18045        } else if self.parse_keywords(&[Keyword::NETWORK, Keyword::POLICY]) {
18046            Some(ActionCreateObjectType::NetworkPolicy)
18047        } else if self.parse_keywords(&[Keyword::ORGANIZATION, Keyword::LISTING]) {
18048            Some(ActionCreateObjectType::OrganiationListing)
18049        } else if self.parse_keywords(&[Keyword::REPLICATION, Keyword::GROUP]) {
18050            Some(ActionCreateObjectType::ReplicationGroup)
18051        }
18052        // Single-word object types
18053        else if self.parse_keyword(Keyword::ACCOUNT) {
18054            Some(ActionCreateObjectType::Account)
18055        } else if self.parse_keyword(Keyword::APPLICATION) {
18056            Some(ActionCreateObjectType::Application)
18057        } else if self.parse_keyword(Keyword::DATABASE) {
18058            Some(ActionCreateObjectType::Database)
18059        } else if self.parse_keyword(Keyword::INTEGRATION) {
18060            Some(ActionCreateObjectType::Integration)
18061        } else if self.parse_keyword(Keyword::ROLE) {
18062            Some(ActionCreateObjectType::Role)
18063        } else if self.parse_keyword(Keyword::SCHEMA) {
18064            Some(ActionCreateObjectType::Schema)
18065        } else if self.parse_keyword(Keyword::SHARE) {
18066            Some(ActionCreateObjectType::Share)
18067        } else if self.parse_keyword(Keyword::USER) {
18068            Some(ActionCreateObjectType::User)
18069        } else if self.parse_keyword(Keyword::WAREHOUSE) {
18070            Some(ActionCreateObjectType::Warehouse)
18071        } else {
18072            None
18073        }
18074    }
18075
18076    fn parse_action_apply_type(&mut self) -> Result<ActionApplyType, ParserError> {
18077        if self.parse_keywords(&[Keyword::AGGREGATION, Keyword::POLICY]) {
18078            Ok(ActionApplyType::AggregationPolicy)
18079        } else if self.parse_keywords(&[Keyword::AUTHENTICATION, Keyword::POLICY]) {
18080            Ok(ActionApplyType::AuthenticationPolicy)
18081        } else if self.parse_keywords(&[Keyword::JOIN, Keyword::POLICY]) {
18082            Ok(ActionApplyType::JoinPolicy)
18083        } else if self.parse_keywords(&[Keyword::MASKING, Keyword::POLICY]) {
18084            Ok(ActionApplyType::MaskingPolicy)
18085        } else if self.parse_keywords(&[Keyword::PACKAGES, Keyword::POLICY]) {
18086            Ok(ActionApplyType::PackagesPolicy)
18087        } else if self.parse_keywords(&[Keyword::PASSWORD, Keyword::POLICY]) {
18088            Ok(ActionApplyType::PasswordPolicy)
18089        } else if self.parse_keywords(&[Keyword::PROJECTION, Keyword::POLICY]) {
18090            Ok(ActionApplyType::ProjectionPolicy)
18091        } else if self.parse_keywords(&[Keyword::ROW, Keyword::ACCESS, Keyword::POLICY]) {
18092            Ok(ActionApplyType::RowAccessPolicy)
18093        } else if self.parse_keywords(&[Keyword::SESSION, Keyword::POLICY]) {
18094            Ok(ActionApplyType::SessionPolicy)
18095        } else if self.parse_keyword(Keyword::TAG) {
18096            Ok(ActionApplyType::Tag)
18097        } else {
18098            self.expected_ref("GRANT APPLY type", self.peek_token_ref())
18099        }
18100    }
18101
18102    fn maybe_parse_action_execute_obj_type(&mut self) -> Option<ActionExecuteObjectType> {
18103        if self.parse_keywords(&[Keyword::DATA, Keyword::METRIC, Keyword::FUNCTION]) {
18104            Some(ActionExecuteObjectType::DataMetricFunction)
18105        } else if self.parse_keywords(&[Keyword::MANAGED, Keyword::ALERT]) {
18106            Some(ActionExecuteObjectType::ManagedAlert)
18107        } else if self.parse_keywords(&[Keyword::MANAGED, Keyword::TASK]) {
18108            Some(ActionExecuteObjectType::ManagedTask)
18109        } else if self.parse_keyword(Keyword::ALERT) {
18110            Some(ActionExecuteObjectType::Alert)
18111        } else if self.parse_keyword(Keyword::TASK) {
18112            Some(ActionExecuteObjectType::Task)
18113        } else {
18114            None
18115        }
18116    }
18117
18118    fn parse_action_manage_type(&mut self) -> Result<ActionManageType, ParserError> {
18119        if self.parse_keywords(&[Keyword::ACCOUNT, Keyword::SUPPORT, Keyword::CASES]) {
18120            Ok(ActionManageType::AccountSupportCases)
18121        } else if self.parse_keywords(&[Keyword::EVENT, Keyword::SHARING]) {
18122            Ok(ActionManageType::EventSharing)
18123        } else if self.parse_keywords(&[Keyword::LISTING, Keyword::AUTO, Keyword::FULFILLMENT]) {
18124            Ok(ActionManageType::ListingAutoFulfillment)
18125        } else if self.parse_keywords(&[Keyword::ORGANIZATION, Keyword::SUPPORT, Keyword::CASES]) {
18126            Ok(ActionManageType::OrganizationSupportCases)
18127        } else if self.parse_keywords(&[Keyword::USER, Keyword::SUPPORT, Keyword::CASES]) {
18128            Ok(ActionManageType::UserSupportCases)
18129        } else if self.parse_keyword(Keyword::GRANTS) {
18130            Ok(ActionManageType::Grants)
18131        } else if self.parse_keyword(Keyword::WAREHOUSES) {
18132            Ok(ActionManageType::Warehouses)
18133        } else {
18134            self.expected_ref("GRANT MANAGE type", self.peek_token_ref())
18135        }
18136    }
18137
18138    fn parse_action_modify_type(&mut self) -> Option<ActionModifyType> {
18139        if self.parse_keywords(&[Keyword::LOG, Keyword::LEVEL]) {
18140            Some(ActionModifyType::LogLevel)
18141        } else if self.parse_keywords(&[Keyword::TRACE, Keyword::LEVEL]) {
18142            Some(ActionModifyType::TraceLevel)
18143        } else if self.parse_keywords(&[Keyword::SESSION, Keyword::LOG, Keyword::LEVEL]) {
18144            Some(ActionModifyType::SessionLogLevel)
18145        } else if self.parse_keywords(&[Keyword::SESSION, Keyword::TRACE, Keyword::LEVEL]) {
18146            Some(ActionModifyType::SessionTraceLevel)
18147        } else {
18148            None
18149        }
18150    }
18151
18152    fn parse_action_monitor_type(&mut self) -> Option<ActionMonitorType> {
18153        if self.parse_keyword(Keyword::EXECUTION) {
18154            Some(ActionMonitorType::Execution)
18155        } else if self.parse_keyword(Keyword::SECURITY) {
18156            Some(ActionMonitorType::Security)
18157        } else if self.parse_keyword(Keyword::USAGE) {
18158            Some(ActionMonitorType::Usage)
18159        } else {
18160            None
18161        }
18162    }
18163
18164    /// Parse a grantee name, possibly with a host qualifier (user@host).
18165    pub fn parse_grantee_name(&mut self) -> Result<GranteeName, ParserError> {
18166        let mut name = self.parse_object_name(false)?;
18167        if self.dialect.supports_user_host_grantee()
18168            && name.0.len() == 1
18169            && name.0[0].as_ident().is_some()
18170            && self.consume_token(&Token::AtSign)
18171        {
18172            let user = name.0.pop().unwrap().as_ident().unwrap().clone();
18173            let host = self.parse_identifier()?;
18174            Ok(GranteeName::UserHost { user, host })
18175        } else {
18176            Ok(GranteeName::ObjectName(name))
18177        }
18178    }
18179
18180    /// Parse [`Statement::Deny`]
18181    pub fn parse_deny(&mut self) -> Result<Statement, ParserError> {
18182        self.expect_keyword(Keyword::DENY)?;
18183
18184        let (privileges, objects) = self.parse_grant_deny_revoke_privileges_objects()?;
18185        let objects = match objects {
18186            Some(o) => o,
18187            None => {
18188                return parser_err!(
18189                    "DENY statements must specify an object",
18190                    self.peek_token_ref().span.start
18191                )
18192            }
18193        };
18194
18195        self.expect_keyword_is(Keyword::TO)?;
18196        let grantees = self.parse_grantees()?;
18197        let cascade = self.parse_cascade_option();
18198        let granted_by = if self.parse_keywords(&[Keyword::AS]) {
18199            Some(self.parse_identifier()?)
18200        } else {
18201            None
18202        };
18203
18204        Ok(Statement::Deny(DenyStatement {
18205            privileges,
18206            objects,
18207            grantees,
18208            cascade,
18209            granted_by,
18210        }))
18211    }
18212
18213    /// Parse a REVOKE statement
18214    pub fn parse_revoke(&mut self) -> Result<Revoke, ParserError> {
18215        let (privileges, objects) = self.parse_grant_deny_revoke_privileges_objects()?;
18216
18217        self.expect_keyword_is(Keyword::FROM)?;
18218        let grantees = self.parse_grantees()?;
18219
18220        let granted_by = if self.parse_keywords(&[Keyword::GRANTED, Keyword::BY]) {
18221            Some(self.parse_identifier()?)
18222        } else {
18223            None
18224        };
18225
18226        let cascade = self.parse_cascade_option();
18227
18228        Ok(Revoke {
18229            privileges,
18230            objects,
18231            grantees,
18232            granted_by,
18233            cascade,
18234        })
18235    }
18236
18237    /// Parse an REPLACE statement
18238    pub fn parse_replace(
18239        &mut self,
18240        replace_token: TokenWithSpan,
18241    ) -> Result<Statement, ParserError> {
18242        if !dialect_of!(self is MySqlDialect | GenericDialect) {
18243            return parser_err!(
18244                "Unsupported statement REPLACE",
18245                self.peek_token_ref().span.start
18246            );
18247        }
18248
18249        let mut insert = self.parse_insert(replace_token)?;
18250        if let Statement::Insert(Insert { replace_into, .. }) = &mut insert {
18251            *replace_into = true;
18252        }
18253
18254        Ok(insert)
18255    }
18256
18257    /// Parse an INSERT statement, returning a `Box`ed SetExpr
18258    ///
18259    /// This is used to reduce the size of the stack frames in debug builds
18260    fn parse_insert_setexpr_boxed(
18261        &mut self,
18262        insert_token: TokenWithSpan,
18263    ) -> Result<Box<SetExpr>, ParserError> {
18264        Ok(Box::new(SetExpr::Insert(self.parse_insert(insert_token)?)))
18265    }
18266
18267    /// Parse an INSERT statement
18268    pub fn parse_insert(&mut self, insert_token: TokenWithSpan) -> Result<Statement, ParserError> {
18269        let optimizer_hints = self.maybe_parse_optimizer_hints()?;
18270        let or = self.parse_conflict_clause();
18271        let priority = if !dialect_of!(self is MySqlDialect | GenericDialect) {
18272            None
18273        } else if self.parse_keyword(Keyword::LOW_PRIORITY) {
18274            Some(MysqlInsertPriority::LowPriority)
18275        } else if self.parse_keyword(Keyword::DELAYED) {
18276            Some(MysqlInsertPriority::Delayed)
18277        } else if self.parse_keyword(Keyword::HIGH_PRIORITY) {
18278            Some(MysqlInsertPriority::HighPriority)
18279        } else {
18280            None
18281        };
18282
18283        let ignore = dialect_of!(self is MySqlDialect | GenericDialect)
18284            && self.parse_keyword(Keyword::IGNORE);
18285
18286        let replace_into = false;
18287
18288        let overwrite = self.parse_keyword(Keyword::OVERWRITE);
18289        let into = self.parse_keyword(Keyword::INTO);
18290
18291        let local = self.parse_keyword(Keyword::LOCAL);
18292
18293        if self.parse_keyword(Keyword::DIRECTORY) {
18294            let path = self.parse_literal_string()?;
18295            let file_format = if self.parse_keywords(&[Keyword::STORED, Keyword::AS]) {
18296                Some(self.parse_file_format()?)
18297            } else {
18298                None
18299            };
18300            let source = self.parse_query()?;
18301            Ok(Statement::Directory {
18302                local,
18303                path,
18304                overwrite,
18305                file_format,
18306                source,
18307            })
18308        } else {
18309            // Hive lets you put table here regardless
18310            let table = self.parse_keyword(Keyword::TABLE);
18311            let table_object = self.parse_table_object()?;
18312
18313            let table_alias = if self.dialect.supports_insert_table_alias()
18314                && !self.peek_sub_query()
18315                && self
18316                    .peek_one_of_keywords(&[Keyword::DEFAULT, Keyword::VALUES])
18317                    .is_none()
18318            {
18319                if self.parse_keyword(Keyword::AS) {
18320                    Some(TableAliasWithoutColumns {
18321                        explicit: true,
18322                        alias: self.parse_identifier()?,
18323                    })
18324                } else {
18325                    self.maybe_parse(|parser| parser.parse_identifier())?
18326                        .map(|alias| TableAliasWithoutColumns {
18327                            explicit: false,
18328                            alias,
18329                        })
18330                }
18331            } else {
18332                None
18333            };
18334
18335            let is_mysql = dialect_of!(self is MySqlDialect);
18336
18337            let (columns, partitioned, after_columns, output, source, assignments) = if self
18338                .parse_keywords(&[Keyword::DEFAULT, Keyword::VALUES])
18339            {
18340                (vec![], None, vec![], None, None, vec![])
18341            } else {
18342                let (columns, partitioned, after_columns) = if !self.peek_subquery_start() {
18343                    let columns =
18344                        self.parse_parenthesized_qualified_column_list(Optional, is_mysql)?;
18345
18346                    let partitioned = self.parse_insert_partition()?;
18347                    // Hive allows you to specify columns after partitions as well if you want.
18348                    let after_columns = if dialect_of!(self is HiveDialect) {
18349                        self.parse_parenthesized_column_list(Optional, false)?
18350                    } else {
18351                        vec![]
18352                    };
18353                    (columns, partitioned, after_columns)
18354                } else {
18355                    Default::default()
18356                };
18357
18358                let output = self.maybe_parse_output_clause()?;
18359
18360                let (source, assignments) = if self.peek_keyword(Keyword::FORMAT)
18361                    || self.peek_keyword(Keyword::SETTINGS)
18362                {
18363                    (None, vec![])
18364                } else if self.dialect.supports_insert_set() && self.parse_keyword(Keyword::SET) {
18365                    (None, self.parse_comma_separated(Parser::parse_assignment)?)
18366                } else {
18367                    (Some(self.parse_query()?), vec![])
18368                };
18369
18370                (
18371                    columns,
18372                    partitioned,
18373                    after_columns,
18374                    output,
18375                    source,
18376                    assignments,
18377                )
18378            };
18379
18380            let (format_clause, settings) = if self.dialect.supports_insert_format() {
18381                // Settings always comes before `FORMAT` for ClickHouse:
18382                // <https://clickhouse.com/docs/en/sql-reference/statements/insert-into>
18383                let settings = self.parse_settings()?;
18384
18385                let format = if self.parse_keyword(Keyword::FORMAT) {
18386                    Some(self.parse_input_format_clause()?)
18387                } else {
18388                    None
18389                };
18390
18391                (format, settings)
18392            } else {
18393                Default::default()
18394            };
18395
18396            let insert_alias = if dialect_of!(self is MySqlDialect | GenericDialect)
18397                && self.parse_keyword(Keyword::AS)
18398            {
18399                let row_alias = self.parse_object_name(false)?;
18400                let col_aliases = Some(self.parse_parenthesized_column_list(Optional, false)?);
18401                Some(InsertAliases {
18402                    row_alias,
18403                    col_aliases,
18404                })
18405            } else {
18406                None
18407            };
18408
18409            let on = if self.parse_keyword(Keyword::ON) {
18410                if self.parse_keyword(Keyword::CONFLICT) {
18411                    let conflict_target =
18412                        if self.parse_keywords(&[Keyword::ON, Keyword::CONSTRAINT]) {
18413                            Some(ConflictTarget::OnConstraint(self.parse_object_name(false)?))
18414                        } else if self.peek_token_ref().token == Token::LParen {
18415                            Some(ConflictTarget::Columns(
18416                                self.parse_parenthesized_column_list(IsOptional::Mandatory, false)?,
18417                            ))
18418                        } else {
18419                            None
18420                        };
18421
18422                    self.expect_keyword_is(Keyword::DO)?;
18423                    let action = if self.parse_keyword(Keyword::NOTHING) {
18424                        OnConflictAction::DoNothing
18425                    } else {
18426                        self.expect_keyword_is(Keyword::UPDATE)?;
18427                        self.expect_keyword_is(Keyword::SET)?;
18428                        let assignments = self.parse_comma_separated(Parser::parse_assignment)?;
18429                        let selection = if self.parse_keyword(Keyword::WHERE) {
18430                            Some(self.parse_expr()?)
18431                        } else {
18432                            None
18433                        };
18434                        OnConflictAction::DoUpdate(DoUpdate {
18435                            assignments,
18436                            selection,
18437                        })
18438                    };
18439
18440                    Some(OnInsert::OnConflict(OnConflict {
18441                        conflict_target,
18442                        action,
18443                    }))
18444                } else {
18445                    self.expect_keyword_is(Keyword::DUPLICATE)?;
18446                    self.expect_keyword_is(Keyword::KEY)?;
18447                    self.expect_keyword_is(Keyword::UPDATE)?;
18448                    let l = self.parse_comma_separated(Parser::parse_assignment)?;
18449
18450                    Some(OnInsert::DuplicateKeyUpdate(l))
18451                }
18452            } else {
18453                None
18454            };
18455
18456            let returning = if self.parse_keyword(Keyword::RETURNING) {
18457                Some(self.parse_comma_separated(Parser::parse_select_item)?)
18458            } else {
18459                None
18460            };
18461
18462            Ok(Insert {
18463                insert_token: insert_token.into(),
18464                optimizer_hints,
18465                or,
18466                table: table_object,
18467                table_alias,
18468                ignore,
18469                into,
18470                overwrite,
18471                partitioned,
18472                columns,
18473                after_columns,
18474                source,
18475                assignments,
18476                has_table_keyword: table,
18477                on,
18478                returning,
18479                output,
18480                replace_into,
18481                priority,
18482                insert_alias,
18483                settings,
18484                format_clause,
18485                multi_table_insert_type: None,
18486                multi_table_into_clauses: vec![],
18487                multi_table_when_clauses: vec![],
18488                multi_table_else_clause: None,
18489            }
18490            .into())
18491        }
18492    }
18493
18494    /// Parses input format clause used for ClickHouse.
18495    ///
18496    /// <https://clickhouse.com/docs/en/interfaces/formats>
18497    pub fn parse_input_format_clause(&mut self) -> Result<InputFormatClause, ParserError> {
18498        let ident = self.parse_identifier()?;
18499        let values = self
18500            .maybe_parse(|p| p.parse_comma_separated(|p| p.parse_expr()))?
18501            .unwrap_or_default();
18502
18503        Ok(InputFormatClause { ident, values })
18504    }
18505
18506    /// Returns true if the immediate tokens look like the
18507    /// beginning of a subquery. `(SELECT ...`
18508    fn peek_subquery_start(&mut self) -> bool {
18509        matches!(
18510            self.peek_tokens_ref(),
18511            [
18512                TokenWithSpan {
18513                    token: Token::LParen,
18514                    ..
18515                },
18516                TokenWithSpan {
18517                    token: Token::Word(Word {
18518                        keyword: Keyword::SELECT,
18519                        ..
18520                    }),
18521                    ..
18522                },
18523            ]
18524        )
18525    }
18526
18527    /// Returns true if the immediate tokens look like the
18528    /// beginning of a subquery possibly preceded by CTEs;
18529    /// i.e. `(WITH ...` or `(SELECT ...`.
18530    fn peek_subquery_or_cte_start(&mut self) -> bool {
18531        matches!(
18532            self.peek_tokens_ref(),
18533            [
18534                TokenWithSpan {
18535                    token: Token::LParen,
18536                    ..
18537                },
18538                TokenWithSpan {
18539                    token: Token::Word(Word {
18540                        keyword: Keyword::SELECT | Keyword::WITH,
18541                        ..
18542                    }),
18543                    ..
18544                },
18545            ]
18546        )
18547    }
18548
18549    fn parse_conflict_clause(&mut self) -> Option<SqliteOnConflict> {
18550        if self.parse_keywords(&[Keyword::OR, Keyword::REPLACE]) {
18551            Some(SqliteOnConflict::Replace)
18552        } else if self.parse_keywords(&[Keyword::OR, Keyword::ROLLBACK]) {
18553            Some(SqliteOnConflict::Rollback)
18554        } else if self.parse_keywords(&[Keyword::OR, Keyword::ABORT]) {
18555            Some(SqliteOnConflict::Abort)
18556        } else if self.parse_keywords(&[Keyword::OR, Keyword::FAIL]) {
18557            Some(SqliteOnConflict::Fail)
18558        } else if self.parse_keywords(&[Keyword::OR, Keyword::IGNORE]) {
18559            Some(SqliteOnConflict::Ignore)
18560        } else if self.parse_keyword(Keyword::REPLACE) {
18561            Some(SqliteOnConflict::Replace)
18562        } else {
18563            None
18564        }
18565    }
18566
18567    /// Parse an optional `PARTITION (...)` clause for INSERT statements.
18568    pub fn parse_insert_partition(&mut self) -> Result<Option<Vec<Expr>>, ParserError> {
18569        if self.parse_keyword(Keyword::PARTITION) {
18570            self.expect_token(&Token::LParen)?;
18571            let partition_cols = Some(self.parse_comma_separated(Parser::parse_expr)?);
18572            self.expect_token(&Token::RParen)?;
18573            Ok(partition_cols)
18574        } else {
18575            Ok(None)
18576        }
18577    }
18578
18579    /// Parse optional Hive `INPUTFORMAT ... SERDE ...` clause used by LOAD DATA.
18580    pub fn parse_load_data_table_format(
18581        &mut self,
18582    ) -> Result<Option<HiveLoadDataFormat>, ParserError> {
18583        if self.parse_keyword(Keyword::INPUTFORMAT) {
18584            let input_format = self.parse_expr()?;
18585            self.expect_keyword_is(Keyword::SERDE)?;
18586            let serde = self.parse_expr()?;
18587            Ok(Some(HiveLoadDataFormat {
18588                input_format,
18589                serde,
18590            }))
18591        } else {
18592            Ok(None)
18593        }
18594    }
18595
18596    /// Parse an UPDATE statement, returning a `Box`ed SetExpr
18597    ///
18598    /// This is used to reduce the size of the stack frames in debug builds
18599    fn parse_update_setexpr_boxed(
18600        &mut self,
18601        update_token: TokenWithSpan,
18602    ) -> Result<Box<SetExpr>, ParserError> {
18603        Ok(Box::new(SetExpr::Update(self.parse_update(update_token)?)))
18604    }
18605
18606    /// Parse an `UPDATE` statement and return `Statement::Update`.
18607    pub fn parse_update(&mut self, update_token: TokenWithSpan) -> Result<Statement, ParserError> {
18608        let optimizer_hints = self.maybe_parse_optimizer_hints()?;
18609        let or = self.parse_conflict_clause();
18610        let table = self.parse_table_and_joins()?;
18611        let from_before_set = if self.parse_keyword(Keyword::FROM) {
18612            Some(UpdateTableFromKind::BeforeSet(
18613                self.parse_table_with_joins()?,
18614            ))
18615        } else {
18616            None
18617        };
18618        self.expect_keyword(Keyword::SET)?;
18619        let assignments = self.parse_comma_separated(Parser::parse_assignment)?;
18620
18621        let output = self.maybe_parse_output_clause()?;
18622
18623        let from = if from_before_set.is_none() && self.parse_keyword(Keyword::FROM) {
18624            Some(UpdateTableFromKind::AfterSet(
18625                self.parse_table_with_joins()?,
18626            ))
18627        } else {
18628            from_before_set
18629        };
18630        let selection = if self.parse_keyword(Keyword::WHERE) {
18631            Some(self.parse_expr()?)
18632        } else {
18633            None
18634        };
18635        let returning = if self.parse_keyword(Keyword::RETURNING) {
18636            Some(self.parse_comma_separated(Parser::parse_select_item)?)
18637        } else {
18638            None
18639        };
18640        let order_by = if self.dialect.supports_update_order_by()
18641            && self.parse_keywords(&[Keyword::ORDER, Keyword::BY])
18642        {
18643            self.parse_comma_separated(Parser::parse_order_by_expr)?
18644        } else {
18645            vec![]
18646        };
18647        let limit = if self.parse_keyword(Keyword::LIMIT) {
18648            Some(self.parse_expr()?)
18649        } else {
18650            None
18651        };
18652        Ok(Update {
18653            update_token: update_token.into(),
18654            optimizer_hints,
18655            table,
18656            assignments,
18657            from,
18658            selection,
18659            returning,
18660            output,
18661            or,
18662            order_by,
18663            limit,
18664        }
18665        .into())
18666    }
18667
18668    /// Parse a `var = expr` assignment, used in an UPDATE statement
18669    pub fn parse_assignment(&mut self) -> Result<Assignment, ParserError> {
18670        let target = self.parse_assignment_target()?;
18671        self.expect_token(&Token::Eq)?;
18672        let value = self.parse_expr()?;
18673        Ok(Assignment { target, value })
18674    }
18675
18676    /// Parse the left-hand side of an assignment, used in an UPDATE statement
18677    pub fn parse_assignment_target(&mut self) -> Result<AssignmentTarget, ParserError> {
18678        if self.consume_token(&Token::LParen) {
18679            let columns = self.parse_comma_separated(|p| p.parse_object_name(false))?;
18680            self.expect_token(&Token::RParen)?;
18681            Ok(AssignmentTarget::Tuple(columns))
18682        } else {
18683            let column = self.parse_object_name(false)?;
18684            Ok(AssignmentTarget::ColumnName(column))
18685        }
18686    }
18687
18688    /// Parse a single function argument, handling named and unnamed variants.
18689    pub fn parse_function_args(&mut self) -> Result<FunctionArg, ParserError> {
18690        let arg = if self.dialect.supports_named_fn_args_with_expr_name() {
18691            self.maybe_parse(|p| {
18692                let name = p.parse_expr()?;
18693                let operator = p.parse_function_named_arg_operator()?;
18694                let arg = p.parse_wildcard_expr()?.into();
18695                Ok(FunctionArg::ExprNamed {
18696                    name,
18697                    arg,
18698                    operator,
18699                })
18700            })?
18701        } else {
18702            self.maybe_parse(|p| {
18703                let name = p.parse_identifier()?;
18704                let operator = p.parse_function_named_arg_operator()?;
18705                let arg = p.parse_wildcard_expr()?.into();
18706                Ok(FunctionArg::Named {
18707                    name,
18708                    arg,
18709                    operator,
18710                })
18711            })?
18712        };
18713        if let Some(arg) = arg {
18714            return Ok(arg);
18715        }
18716        let wildcard_expr = self.parse_wildcard_expr()?;
18717        let arg_expr: FunctionArgExpr = match wildcard_expr {
18718            Expr::Wildcard(ref token) if self.dialect.supports_select_wildcard_exclude() => {
18719                // Support `* EXCLUDE(col1, col2, ...)` inside function calls (e.g. Snowflake's
18720                // `HASH(* EXCLUDE(col))`).  Parse the options the same way SELECT items do.
18721                let opts = self.parse_wildcard_additional_options(token.0.clone())?;
18722                if opts.opt_exclude.is_some()
18723                    || opts.opt_except.is_some()
18724                    || opts.opt_replace.is_some()
18725                    || opts.opt_rename.is_some()
18726                    || opts.opt_ilike.is_some()
18727                {
18728                    FunctionArgExpr::WildcardWithOptions(opts)
18729                } else {
18730                    wildcard_expr.into()
18731                }
18732            }
18733            other => other.into(),
18734        };
18735        Ok(FunctionArg::Unnamed(arg_expr))
18736    }
18737
18738    fn parse_function_named_arg_operator(&mut self) -> Result<FunctionArgOperator, ParserError> {
18739        if self.parse_keyword(Keyword::VALUE) {
18740            return Ok(FunctionArgOperator::Value);
18741        }
18742        let tok = self.next_token();
18743        match tok.token {
18744            Token::RArrow if self.dialect.supports_named_fn_args_with_rarrow_operator() => {
18745                Ok(FunctionArgOperator::RightArrow)
18746            }
18747            Token::Eq if self.dialect.supports_named_fn_args_with_eq_operator() => {
18748                Ok(FunctionArgOperator::Equals)
18749            }
18750            Token::Assignment
18751                if self
18752                    .dialect
18753                    .supports_named_fn_args_with_assignment_operator() =>
18754            {
18755                Ok(FunctionArgOperator::Assignment)
18756            }
18757            Token::Colon if self.dialect.supports_named_fn_args_with_colon_operator() => {
18758                Ok(FunctionArgOperator::Colon)
18759            }
18760            _ => {
18761                self.prev_token();
18762                self.expected("argument operator", tok)
18763            }
18764        }
18765    }
18766
18767    /// Parse an optional, comma-separated list of function arguments (consumes closing paren).
18768    pub fn parse_optional_args(&mut self) -> Result<Vec<FunctionArg>, ParserError> {
18769        if self.consume_token(&Token::RParen) {
18770            Ok(vec![])
18771        } else {
18772            let args = self.parse_comma_separated(Parser::parse_function_args)?;
18773            self.expect_token(&Token::RParen)?;
18774            Ok(args)
18775        }
18776    }
18777
18778    fn parse_table_function_args(&mut self) -> Result<TableFunctionArgs, ParserError> {
18779        if self.consume_token(&Token::RParen) {
18780            return Ok(TableFunctionArgs {
18781                args: vec![],
18782                settings: None,
18783            });
18784        }
18785        let mut args = vec![];
18786        let settings = loop {
18787            if let Some(settings) = self.parse_settings()? {
18788                break Some(settings);
18789            }
18790            args.push(self.parse_function_args()?);
18791            if self.is_parse_comma_separated_end() {
18792                break None;
18793            }
18794        };
18795        self.expect_token(&Token::RParen)?;
18796        Ok(TableFunctionArgs { args, settings })
18797    }
18798
18799    /// Parses a potentially empty list of arguments to a function
18800    /// (including the closing parenthesis).
18801    ///
18802    /// Examples:
18803    /// ```sql
18804    /// FIRST_VALUE(x ORDER BY 1,2,3);
18805    /// FIRST_VALUE(x IGNORE NULL);
18806    /// ```
18807    fn parse_function_argument_list(&mut self) -> Result<FunctionArgumentList, ParserError> {
18808        let mut clauses = vec![];
18809
18810        // Handle clauses that may exist with an empty argument list
18811
18812        if let Some(null_clause) = self.parse_json_null_clause() {
18813            clauses.push(FunctionArgumentClause::JsonNullClause(null_clause));
18814        }
18815
18816        if let Some(json_returning_clause) = self.maybe_parse_json_returning_clause()? {
18817            clauses.push(FunctionArgumentClause::JsonReturningClause(
18818                json_returning_clause,
18819            ));
18820        }
18821
18822        if self.consume_token(&Token::RParen) {
18823            return Ok(FunctionArgumentList {
18824                duplicate_treatment: None,
18825                args: vec![],
18826                clauses,
18827            });
18828        }
18829
18830        let duplicate_treatment = self.parse_duplicate_treatment()?;
18831        let args = self.parse_comma_separated(Parser::parse_function_args)?;
18832
18833        if self.dialect.supports_window_function_null_treatment_arg() {
18834            if let Some(null_treatment) = self.parse_null_treatment()? {
18835                clauses.push(FunctionArgumentClause::IgnoreOrRespectNulls(null_treatment));
18836            }
18837        }
18838
18839        if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
18840            clauses.push(FunctionArgumentClause::OrderBy(
18841                self.parse_comma_separated(Parser::parse_order_by_expr)?,
18842            ));
18843        }
18844
18845        if self.parse_keyword(Keyword::LIMIT) {
18846            clauses.push(FunctionArgumentClause::Limit(self.parse_expr()?));
18847        }
18848
18849        if dialect_of!(self is GenericDialect | BigQueryDialect)
18850            && self.parse_keyword(Keyword::HAVING)
18851        {
18852            let kind = match self.expect_one_of_keywords(&[Keyword::MIN, Keyword::MAX])? {
18853                Keyword::MIN => HavingBoundKind::Min,
18854                Keyword::MAX => HavingBoundKind::Max,
18855                unexpected_keyword => return Err(ParserError::ParserError(
18856                    format!("Internal parser error: unexpected keyword `{unexpected_keyword}` in having bound"),
18857                )),
18858            };
18859            clauses.push(FunctionArgumentClause::Having(HavingBound(
18860                kind,
18861                self.parse_expr()?,
18862            )))
18863        }
18864
18865        if dialect_of!(self is GenericDialect | MySqlDialect)
18866            && self.parse_keyword(Keyword::SEPARATOR)
18867        {
18868            clauses.push(FunctionArgumentClause::Separator(self.parse_value()?));
18869        }
18870
18871        if let Some(on_overflow) = self.parse_listagg_on_overflow()? {
18872            clauses.push(FunctionArgumentClause::OnOverflow(on_overflow));
18873        }
18874
18875        if let Some(null_clause) = self.parse_json_null_clause() {
18876            clauses.push(FunctionArgumentClause::JsonNullClause(null_clause));
18877        }
18878
18879        if let Some(json_returning_clause) = self.maybe_parse_json_returning_clause()? {
18880            clauses.push(FunctionArgumentClause::JsonReturningClause(
18881                json_returning_clause,
18882            ));
18883        }
18884
18885        self.expect_token(&Token::RParen)?;
18886        Ok(FunctionArgumentList {
18887            duplicate_treatment,
18888            args,
18889            clauses,
18890        })
18891    }
18892
18893    fn parse_json_null_clause(&mut self) -> Option<JsonNullClause> {
18894        if self.parse_keywords(&[Keyword::ABSENT, Keyword::ON, Keyword::NULL]) {
18895            Some(JsonNullClause::AbsentOnNull)
18896        } else if self.parse_keywords(&[Keyword::NULL, Keyword::ON, Keyword::NULL]) {
18897            Some(JsonNullClause::NullOnNull)
18898        } else {
18899            None
18900        }
18901    }
18902
18903    fn maybe_parse_json_returning_clause(
18904        &mut self,
18905    ) -> Result<Option<JsonReturningClause>, ParserError> {
18906        if self.parse_keyword(Keyword::RETURNING) {
18907            let data_type = self.parse_data_type()?;
18908            Ok(Some(JsonReturningClause { data_type }))
18909        } else {
18910            Ok(None)
18911        }
18912    }
18913
18914    fn parse_duplicate_treatment(&mut self) -> Result<Option<DuplicateTreatment>, ParserError> {
18915        let loc = self.peek_token_ref().span.start;
18916        match (
18917            self.parse_keyword(Keyword::ALL),
18918            self.parse_keyword(Keyword::DISTINCT),
18919        ) {
18920            (true, false) => Ok(Some(DuplicateTreatment::All)),
18921            (false, true) => Ok(Some(DuplicateTreatment::Distinct)),
18922            (false, false) => Ok(None),
18923            (true, true) => parser_err!("Cannot specify both ALL and DISTINCT".to_string(), loc),
18924        }
18925    }
18926
18927    /// Parse a comma-delimited list of projections after SELECT
18928    pub fn parse_select_item(&mut self) -> Result<SelectItem, ParserError> {
18929        let prefix = self
18930            .parse_one_of_keywords(
18931                self.dialect
18932                    .get_reserved_keywords_for_select_item_operator(),
18933            )
18934            .map(|keyword| Ident::new(format!("{keyword:?}")));
18935
18936        match self.parse_wildcard_expr()? {
18937            Expr::QualifiedWildcard(prefix, token) => Ok(SelectItem::QualifiedWildcard(
18938                SelectItemQualifiedWildcardKind::ObjectName(prefix),
18939                self.parse_wildcard_additional_options(token.0)?,
18940            )),
18941            Expr::Wildcard(token) => Ok(SelectItem::Wildcard(
18942                self.parse_wildcard_additional_options(token.0)?,
18943            )),
18944            Expr::Identifier(v) if v.value.to_lowercase() == "from" && v.quote_style.is_none() => {
18945                parser_err!(
18946                    format!("Expected an expression, found: {}", v),
18947                    self.peek_token_ref().span.start
18948                )
18949            }
18950            Expr::BinaryOp {
18951                left,
18952                op: BinaryOperator::Eq,
18953                right,
18954            } if self.dialect.supports_eq_alias_assignment()
18955                && matches!(left.as_ref(), Expr::Identifier(_)) =>
18956            {
18957                let Expr::Identifier(alias) = *left else {
18958                    return parser_err!(
18959                        "BUG: expected identifier expression as alias",
18960                        self.peek_token_ref().span.start
18961                    );
18962                };
18963                Ok(SelectItem::ExprWithAlias {
18964                    expr: *right,
18965                    alias,
18966                })
18967            }
18968            expr if self.dialect.supports_select_expr_star()
18969                && self.consume_tokens(&[Token::Period, Token::Mul]) =>
18970            {
18971                let wildcard_token = self.get_previous_token().clone();
18972                Ok(SelectItem::QualifiedWildcard(
18973                    SelectItemQualifiedWildcardKind::Expr(expr),
18974                    self.parse_wildcard_additional_options(wildcard_token)?,
18975                ))
18976            }
18977            expr if self.dialect.supports_select_item_multi_column_alias()
18978                && self.peek_keyword(Keyword::AS)
18979                && self.peek_nth_token(1).token == Token::LParen =>
18980            {
18981                self.expect_keyword(Keyword::AS)?;
18982                self.expect_token(&Token::LParen)?;
18983                let aliases = self.parse_comma_separated(|p| p.parse_identifier())?;
18984                self.expect_token(&Token::RParen)?;
18985                Ok(SelectItem::ExprWithAliases {
18986                    expr: maybe_prefixed_expr(expr, prefix),
18987                    aliases,
18988                })
18989            }
18990            expr => self
18991                .maybe_parse_select_item_alias()
18992                .map(|alias| match alias {
18993                    Some(alias) => SelectItem::ExprWithAlias {
18994                        expr: maybe_prefixed_expr(expr, prefix),
18995                        alias,
18996                    },
18997                    None => SelectItem::UnnamedExpr(maybe_prefixed_expr(expr, prefix)),
18998                }),
18999        }
19000    }
19001
19002    /// Parse an [`WildcardAdditionalOptions`] information for wildcard select items.
19003    ///
19004    /// If it is not possible to parse it, will return an option.
19005    pub fn parse_wildcard_additional_options(
19006        &mut self,
19007        wildcard_token: TokenWithSpan,
19008    ) -> Result<WildcardAdditionalOptions, ParserError> {
19009        let opt_ilike = if self.dialect.supports_select_wildcard_ilike() {
19010            self.parse_optional_select_item_ilike()?
19011        } else {
19012            None
19013        };
19014        let opt_exclude = if opt_ilike.is_none() && self.dialect.supports_select_wildcard_exclude()
19015        {
19016            self.parse_optional_select_item_exclude()?
19017        } else {
19018            None
19019        };
19020        let opt_except = if self.dialect.supports_select_wildcard_except() {
19021            self.parse_optional_select_item_except()?
19022        } else {
19023            None
19024        };
19025        let opt_replace = if self.dialect.supports_select_wildcard_replace() {
19026            self.parse_optional_select_item_replace()?
19027        } else {
19028            None
19029        };
19030        let opt_rename = if self.dialect.supports_select_wildcard_rename() {
19031            self.parse_optional_select_item_rename()?
19032        } else {
19033            None
19034        };
19035
19036        let opt_alias = if self.dialect.supports_select_wildcard_with_alias() {
19037            self.maybe_parse_select_item_alias()?
19038        } else {
19039            None
19040        };
19041
19042        Ok(WildcardAdditionalOptions {
19043            wildcard_token: wildcard_token.into(),
19044            opt_ilike,
19045            opt_exclude,
19046            opt_except,
19047            opt_rename,
19048            opt_replace,
19049            opt_alias,
19050        })
19051    }
19052
19053    /// Parse an [`Ilike`](IlikeSelectItem) information for wildcard select items.
19054    ///
19055    /// If it is not possible to parse it, will return an option.
19056    pub fn parse_optional_select_item_ilike(
19057        &mut self,
19058    ) -> Result<Option<IlikeSelectItem>, ParserError> {
19059        let opt_ilike = if self.parse_keyword(Keyword::ILIKE) {
19060            let next_token = self.next_token();
19061            let pattern = match next_token.token {
19062                Token::SingleQuotedString(s) => s,
19063                _ => return self.expected("ilike pattern", next_token),
19064            };
19065            Some(IlikeSelectItem { pattern })
19066        } else {
19067            None
19068        };
19069        Ok(opt_ilike)
19070    }
19071
19072    /// Parse an [`Exclude`](ExcludeSelectItem) information for wildcard select items.
19073    ///
19074    /// If it is not possible to parse it, will return an option.
19075    pub fn parse_optional_select_item_exclude(
19076        &mut self,
19077    ) -> Result<Option<ExcludeSelectItem>, ParserError> {
19078        let opt_exclude = if self.parse_keyword(Keyword::EXCLUDE) {
19079            if self.consume_token(&Token::LParen) {
19080                let columns =
19081                    self.parse_comma_separated(|parser| parser.parse_object_name(false))?;
19082                self.expect_token(&Token::RParen)?;
19083                Some(ExcludeSelectItem::Multiple(columns))
19084            } else {
19085                let column = self.parse_object_name(false)?;
19086                Some(ExcludeSelectItem::Single(column))
19087            }
19088        } else {
19089            None
19090        };
19091
19092        Ok(opt_exclude)
19093    }
19094
19095    /// Parse an [`Except`](ExceptSelectItem) information for wildcard select items.
19096    ///
19097    /// If it is not possible to parse it, will return an option.
19098    pub fn parse_optional_select_item_except(
19099        &mut self,
19100    ) -> Result<Option<ExceptSelectItem>, ParserError> {
19101        let opt_except = if self.parse_keyword(Keyword::EXCEPT) {
19102            if self.peek_token_ref().token == Token::LParen {
19103                let idents = self.parse_parenthesized_column_list(Mandatory, false)?;
19104                match &idents[..] {
19105                    [] => {
19106                        return self.expected_ref(
19107                            "at least one column should be parsed by the expect clause",
19108                            self.peek_token_ref(),
19109                        )?;
19110                    }
19111                    [first, idents @ ..] => Some(ExceptSelectItem {
19112                        first_element: first.clone(),
19113                        additional_elements: idents.to_vec(),
19114                    }),
19115                }
19116            } else {
19117                // Clickhouse allows EXCEPT column_name
19118                let ident = self.parse_identifier()?;
19119                Some(ExceptSelectItem {
19120                    first_element: ident,
19121                    additional_elements: vec![],
19122                })
19123            }
19124        } else {
19125            None
19126        };
19127
19128        Ok(opt_except)
19129    }
19130
19131    /// Parse a [`Rename`](RenameSelectItem) information for wildcard select items.
19132    pub fn parse_optional_select_item_rename(
19133        &mut self,
19134    ) -> Result<Option<RenameSelectItem>, ParserError> {
19135        let opt_rename = if self.parse_keyword(Keyword::RENAME) {
19136            if self.consume_token(&Token::LParen) {
19137                let idents =
19138                    self.parse_comma_separated(|parser| parser.parse_identifier_with_alias())?;
19139                self.expect_token(&Token::RParen)?;
19140                Some(RenameSelectItem::Multiple(idents))
19141            } else {
19142                let ident = self.parse_identifier_with_alias()?;
19143                Some(RenameSelectItem::Single(ident))
19144            }
19145        } else {
19146            None
19147        };
19148
19149        Ok(opt_rename)
19150    }
19151
19152    /// Parse a [`Replace`](ReplaceSelectItem) information for wildcard select items.
19153    pub fn parse_optional_select_item_replace(
19154        &mut self,
19155    ) -> Result<Option<ReplaceSelectItem>, ParserError> {
19156        let opt_replace = if self.parse_keyword(Keyword::REPLACE) {
19157            if self.consume_token(&Token::LParen) {
19158                let items = self.parse_comma_separated(|parser| {
19159                    Ok(Box::new(parser.parse_replace_elements()?))
19160                })?;
19161                self.expect_token(&Token::RParen)?;
19162                Some(ReplaceSelectItem { items })
19163            } else {
19164                let tok = self.next_token();
19165                return self.expected("( after REPLACE but", tok);
19166            }
19167        } else {
19168            None
19169        };
19170
19171        Ok(opt_replace)
19172    }
19173    /// Parse a single element of a `REPLACE (...)` select-item clause.
19174    pub fn parse_replace_elements(&mut self) -> Result<ReplaceSelectElement, ParserError> {
19175        let expr = self.parse_expr()?;
19176        let as_keyword = self.parse_keyword(Keyword::AS);
19177        let ident = self.parse_identifier()?;
19178        Ok(ReplaceSelectElement {
19179            expr,
19180            column_name: ident,
19181            as_keyword,
19182        })
19183    }
19184
19185    /// Parse ASC or DESC, returns an Option with true if ASC, false of DESC or `None` if none of
19186    /// them.
19187    pub fn parse_asc_desc(&mut self) -> Option<bool> {
19188        if self.parse_keyword(Keyword::ASC) {
19189            Some(true)
19190        } else if self.parse_keyword(Keyword::DESC) {
19191            Some(false)
19192        } else {
19193            None
19194        }
19195    }
19196
19197    /// Parse an [OrderByExpr] expression.
19198    pub fn parse_order_by_expr(&mut self) -> Result<OrderByExpr, ParserError> {
19199        self.parse_order_by_expr_inner(false)
19200            .map(|(order_by, _)| order_by)
19201    }
19202
19203    /// Parse an [IndexColumn].
19204    pub fn parse_create_index_expr(&mut self) -> Result<IndexColumn, ParserError> {
19205        self.parse_order_by_expr_inner(true)
19206            .map(|(column, operator_class)| IndexColumn {
19207                column,
19208                operator_class,
19209            })
19210    }
19211
19212    fn parse_order_by_expr_inner(
19213        &mut self,
19214        with_operator_class: bool,
19215    ) -> Result<(OrderByExpr, Option<ObjectName>), ParserError> {
19216        let expr = self.parse_expr()?;
19217
19218        let operator_class: Option<ObjectName> = if with_operator_class {
19219            // We check that if non of the following keywords are present, then we parse an
19220            // identifier as operator class.
19221            if self
19222                .peek_one_of_keywords(&[Keyword::ASC, Keyword::DESC, Keyword::NULLS, Keyword::WITH])
19223                .is_some()
19224            {
19225                None
19226            } else {
19227                self.maybe_parse(|parser| parser.parse_object_name(false))?
19228            }
19229        } else {
19230            None
19231        };
19232
19233        let options = self.parse_order_by_options()?;
19234
19235        let with_fill = if self.dialect.supports_with_fill()
19236            && self.parse_keywords(&[Keyword::WITH, Keyword::FILL])
19237        {
19238            Some(self.parse_with_fill()?)
19239        } else {
19240            None
19241        };
19242
19243        Ok((
19244            OrderByExpr {
19245                expr,
19246                options,
19247                with_fill,
19248            },
19249            operator_class,
19250        ))
19251    }
19252
19253    fn parse_order_by_options(&mut self) -> Result<OrderByOptions, ParserError> {
19254        let asc = self.parse_asc_desc();
19255
19256        let nulls_first = if self.parse_keywords(&[Keyword::NULLS, Keyword::FIRST]) {
19257            Some(true)
19258        } else if self.parse_keywords(&[Keyword::NULLS, Keyword::LAST]) {
19259            Some(false)
19260        } else {
19261            None
19262        };
19263
19264        Ok(OrderByOptions { asc, nulls_first })
19265    }
19266
19267    // Parse a WITH FILL clause (ClickHouse dialect)
19268    // that follow the WITH FILL keywords in a ORDER BY clause
19269    /// Parse a `WITH FILL` clause used in ORDER BY (ClickHouse dialect).
19270    pub fn parse_with_fill(&mut self) -> Result<WithFill, ParserError> {
19271        let from = if self.parse_keyword(Keyword::FROM) {
19272            Some(self.parse_expr()?)
19273        } else {
19274            None
19275        };
19276
19277        let to = if self.parse_keyword(Keyword::TO) {
19278            Some(self.parse_expr()?)
19279        } else {
19280            None
19281        };
19282
19283        let step = if self.parse_keyword(Keyword::STEP) {
19284            Some(self.parse_expr()?)
19285        } else {
19286            None
19287        };
19288
19289        Ok(WithFill { from, to, step })
19290    }
19291
19292    /// Parse a set of comma separated INTERPOLATE expressions (ClickHouse dialect)
19293    /// that follow the INTERPOLATE keyword in an ORDER BY clause with the WITH FILL modifier
19294    pub fn parse_interpolations(&mut self) -> Result<Option<Interpolate>, ParserError> {
19295        if !self.parse_keyword(Keyword::INTERPOLATE) {
19296            return Ok(None);
19297        }
19298
19299        if self.consume_token(&Token::LParen) {
19300            let interpolations =
19301                self.parse_comma_separated0(|p| p.parse_interpolation(), Token::RParen)?;
19302            self.expect_token(&Token::RParen)?;
19303            // INTERPOLATE () and INTERPOLATE ( ... ) variants
19304            return Ok(Some(Interpolate {
19305                exprs: Some(interpolations),
19306            }));
19307        }
19308
19309        // INTERPOLATE
19310        Ok(Some(Interpolate { exprs: None }))
19311    }
19312
19313    /// Parse a INTERPOLATE expression (ClickHouse dialect)
19314    pub fn parse_interpolation(&mut self) -> Result<InterpolateExpr, ParserError> {
19315        let column = self.parse_identifier()?;
19316        let expr = if self.parse_keyword(Keyword::AS) {
19317            Some(self.parse_expr()?)
19318        } else {
19319            None
19320        };
19321        Ok(InterpolateExpr { column, expr })
19322    }
19323
19324    /// Parse a TOP clause, MSSQL equivalent of LIMIT,
19325    /// that follows after `SELECT [DISTINCT]`.
19326    pub fn parse_top(&mut self) -> Result<Top, ParserError> {
19327        let quantity = if self.consume_token(&Token::LParen) {
19328            let quantity = self.parse_expr()?;
19329            self.expect_token(&Token::RParen)?;
19330            Some(TopQuantity::Expr(quantity))
19331        } else {
19332            let next_token = self.next_token();
19333            let quantity = match next_token.token {
19334                Token::Number(s, _) => Self::parse::<u64>(s, next_token.span.start)?,
19335                _ => self.expected("literal int", next_token)?,
19336            };
19337            Some(TopQuantity::Constant(quantity))
19338        };
19339
19340        let percent = self.parse_keyword(Keyword::PERCENT);
19341
19342        let with_ties = self.parse_keywords(&[Keyword::WITH, Keyword::TIES]);
19343
19344        Ok(Top {
19345            with_ties,
19346            percent,
19347            quantity,
19348        })
19349    }
19350
19351    /// Parse a LIMIT clause
19352    pub fn parse_limit(&mut self) -> Result<Option<Expr>, ParserError> {
19353        if self.parse_keyword(Keyword::ALL) {
19354            Ok(None)
19355        } else {
19356            Ok(Some(self.parse_expr()?))
19357        }
19358    }
19359
19360    /// Parse an OFFSET clause
19361    pub fn parse_offset(&mut self) -> Result<Offset, ParserError> {
19362        let value = self.parse_expr()?;
19363        let rows = if self.parse_keyword(Keyword::ROW) {
19364            OffsetRows::Row
19365        } else if self.parse_keyword(Keyword::ROWS) {
19366            OffsetRows::Rows
19367        } else {
19368            OffsetRows::None
19369        };
19370        Ok(Offset { value, rows })
19371    }
19372
19373    /// Parse a FETCH clause
19374    pub fn parse_fetch(&mut self) -> Result<Fetch, ParserError> {
19375        let _ = self.parse_one_of_keywords(&[Keyword::FIRST, Keyword::NEXT]);
19376
19377        let (quantity, percent) = if self
19378            .parse_one_of_keywords(&[Keyword::ROW, Keyword::ROWS])
19379            .is_some()
19380        {
19381            (None, false)
19382        } else {
19383            let quantity = Expr::Value(self.parse_value()?);
19384            let percent = self.parse_keyword(Keyword::PERCENT);
19385            let _ = self.parse_one_of_keywords(&[Keyword::ROW, Keyword::ROWS]);
19386            (Some(quantity), percent)
19387        };
19388
19389        let with_ties = if self.parse_keyword(Keyword::ONLY) {
19390            false
19391        } else {
19392            self.parse_keywords(&[Keyword::WITH, Keyword::TIES])
19393        };
19394
19395        Ok(Fetch {
19396            with_ties,
19397            percent,
19398            quantity,
19399        })
19400    }
19401
19402    /// Parse a FOR UPDATE/FOR SHARE clause
19403    pub fn parse_lock(&mut self) -> Result<LockClause, ParserError> {
19404        let lock_type = match self.expect_one_of_keywords(&[Keyword::UPDATE, Keyword::SHARE])? {
19405            Keyword::UPDATE => LockType::Update,
19406            Keyword::SHARE => LockType::Share,
19407            unexpected_keyword => return Err(ParserError::ParserError(
19408                format!("Internal parser error: expected any of {{UPDATE, SHARE}}, got {unexpected_keyword:?}"),
19409            )),
19410        };
19411        let of = if self.parse_keyword(Keyword::OF) {
19412            Some(self.parse_object_name(false)?)
19413        } else {
19414            None
19415        };
19416        let nonblock = if self.parse_keyword(Keyword::NOWAIT) {
19417            Some(NonBlock::Nowait)
19418        } else if self.parse_keywords(&[Keyword::SKIP, Keyword::LOCKED]) {
19419            Some(NonBlock::SkipLocked)
19420        } else {
19421            None
19422        };
19423        Ok(LockClause {
19424            lock_type,
19425            of,
19426            nonblock,
19427        })
19428    }
19429
19430    /// Parse a PostgreSQL `LOCK` statement.
19431    pub fn parse_lock_statement(&mut self) -> Result<Lock, ParserError> {
19432        self.expect_keyword(Keyword::LOCK)?;
19433
19434        if self.peek_keyword(Keyword::TABLES) {
19435            return self.expected_ref("TABLE or a table name", self.peek_token_ref());
19436        }
19437
19438        let _ = self.parse_keyword(Keyword::TABLE);
19439        let tables = self.parse_comma_separated(Parser::parse_lock_table_target)?;
19440        let lock_mode = if self.parse_keyword(Keyword::IN) {
19441            let lock_mode = self.parse_lock_table_mode()?;
19442            self.expect_keyword(Keyword::MODE)?;
19443            Some(lock_mode)
19444        } else {
19445            None
19446        };
19447        let nowait = self.parse_keyword(Keyword::NOWAIT);
19448
19449        Ok(Lock {
19450            tables,
19451            lock_mode,
19452            nowait,
19453        })
19454    }
19455
19456    fn parse_lock_table_target(&mut self) -> Result<LockTableTarget, ParserError> {
19457        let only = self.parse_keyword(Keyword::ONLY);
19458        let name = self.parse_object_name(false)?;
19459        let has_asterisk = self.consume_token(&Token::Mul);
19460
19461        Ok(LockTableTarget {
19462            name,
19463            only,
19464            has_asterisk,
19465        })
19466    }
19467
19468    fn parse_lock_table_mode(&mut self) -> Result<LockTableMode, ParserError> {
19469        if self.parse_keywords(&[Keyword::ACCESS, Keyword::SHARE]) {
19470            Ok(LockTableMode::AccessShare)
19471        } else if self.parse_keywords(&[Keyword::ACCESS, Keyword::EXCLUSIVE]) {
19472            Ok(LockTableMode::AccessExclusive)
19473        } else if self.parse_keywords(&[Keyword::ROW, Keyword::SHARE]) {
19474            Ok(LockTableMode::RowShare)
19475        } else if self.parse_keywords(&[Keyword::ROW, Keyword::EXCLUSIVE]) {
19476            Ok(LockTableMode::RowExclusive)
19477        } else if self.parse_keywords(&[Keyword::SHARE, Keyword::UPDATE, Keyword::EXCLUSIVE]) {
19478            Ok(LockTableMode::ShareUpdateExclusive)
19479        } else if self.parse_keywords(&[Keyword::SHARE, Keyword::ROW, Keyword::EXCLUSIVE]) {
19480            Ok(LockTableMode::ShareRowExclusive)
19481        } else if self.parse_keyword(Keyword::SHARE) {
19482            Ok(LockTableMode::Share)
19483        } else if self.parse_keyword(Keyword::EXCLUSIVE) {
19484            Ok(LockTableMode::Exclusive)
19485        } else {
19486            self.expected_ref("a PostgreSQL LOCK TABLE mode", self.peek_token_ref())
19487        }
19488    }
19489
19490    /// Parse a VALUES clause
19491    pub fn parse_values(
19492        &mut self,
19493        allow_empty: bool,
19494        value_keyword: bool,
19495    ) -> Result<Values, ParserError> {
19496        let mut explicit_row = false;
19497
19498        let rows = self.parse_comma_separated(|parser| {
19499            if parser.parse_keyword(Keyword::ROW) {
19500                explicit_row = true;
19501            }
19502
19503            parser.expect_token(&Token::LParen)?;
19504            if allow_empty && parser.peek_token().token == Token::RParen {
19505                parser.next_token();
19506                Ok(vec![])
19507            } else {
19508                let exprs = parser.parse_comma_separated(Parser::parse_expr)?;
19509                parser.expect_token(&Token::RParen)?;
19510                Ok(exprs)
19511            }
19512        })?;
19513        Ok(Values {
19514            explicit_row,
19515            rows,
19516            value_keyword,
19517        })
19518    }
19519
19520    /// Parse a 'START TRANSACTION' statement
19521    pub fn parse_start_transaction(&mut self) -> Result<Statement, ParserError> {
19522        self.expect_keyword_is(Keyword::TRANSACTION)?;
19523        Ok(Statement::StartTransaction {
19524            modes: self.parse_transaction_modes()?,
19525            begin: false,
19526            transaction: Some(BeginTransactionKind::Transaction),
19527            modifier: None,
19528            statements: vec![],
19529            exception: None,
19530            has_end_keyword: false,
19531        })
19532    }
19533
19534    /// Parse a transaction modifier keyword that can follow a `BEGIN` statement.
19535    pub(crate) fn parse_transaction_modifier(&mut self) -> Option<TransactionModifier> {
19536        if !self.dialect.supports_start_transaction_modifier() {
19537            None
19538        } else if self.parse_keyword(Keyword::DEFERRED) {
19539            Some(TransactionModifier::Deferred)
19540        } else if self.parse_keyword(Keyword::IMMEDIATE) {
19541            Some(TransactionModifier::Immediate)
19542        } else if self.parse_keyword(Keyword::EXCLUSIVE) {
19543            Some(TransactionModifier::Exclusive)
19544        } else if self.parse_keyword(Keyword::TRY) {
19545            Some(TransactionModifier::Try)
19546        } else if self.parse_keyword(Keyword::CATCH) {
19547            Some(TransactionModifier::Catch)
19548        } else {
19549            None
19550        }
19551    }
19552
19553    /// Parse a 'BEGIN' statement
19554    pub fn parse_begin(&mut self) -> Result<Statement, ParserError> {
19555        let modifier = self.parse_transaction_modifier();
19556        let transaction =
19557            match self.parse_one_of_keywords(&[Keyword::TRANSACTION, Keyword::WORK, Keyword::TRAN])
19558            {
19559                Some(Keyword::TRANSACTION) => Some(BeginTransactionKind::Transaction),
19560                Some(Keyword::WORK) => Some(BeginTransactionKind::Work),
19561                Some(Keyword::TRAN) => Some(BeginTransactionKind::Tran),
19562                _ => None,
19563            };
19564        Ok(Statement::StartTransaction {
19565            modes: self.parse_transaction_modes()?,
19566            begin: true,
19567            transaction,
19568            modifier,
19569            statements: vec![],
19570            exception: None,
19571            has_end_keyword: false,
19572        })
19573    }
19574
19575    /// Parse a 'BEGIN ... EXCEPTION ... END' block
19576    pub fn parse_begin_exception_end(&mut self) -> Result<Statement, ParserError> {
19577        let statements = self.parse_statement_list(&[Keyword::EXCEPTION, Keyword::END])?;
19578
19579        let exception = if self.parse_keyword(Keyword::EXCEPTION) {
19580            let mut when = Vec::new();
19581
19582            // We can have multiple `WHEN` arms so we consume all cases until `END`
19583            while !self.peek_keyword(Keyword::END) {
19584                self.expect_keyword(Keyword::WHEN)?;
19585
19586                // Each `WHEN` case can have one or more conditions, e.g.
19587                // WHEN EXCEPTION_1 [OR EXCEPTION_2] THEN
19588                // So we parse identifiers until the `THEN` keyword.
19589                let mut idents = Vec::new();
19590
19591                while !self.parse_keyword(Keyword::THEN) {
19592                    let ident = self.parse_identifier()?;
19593                    idents.push(ident);
19594
19595                    self.maybe_parse(|p| p.expect_keyword(Keyword::OR))?;
19596                }
19597
19598                let statements = self.parse_statement_list(&[Keyword::WHEN, Keyword::END])?;
19599
19600                when.push(ExceptionWhen { idents, statements });
19601            }
19602
19603            Some(when)
19604        } else {
19605            None
19606        };
19607
19608        self.expect_keyword(Keyword::END)?;
19609
19610        Ok(Statement::StartTransaction {
19611            begin: true,
19612            statements,
19613            exception,
19614            has_end_keyword: true,
19615            transaction: None,
19616            modifier: None,
19617            modes: Default::default(),
19618        })
19619    }
19620
19621    /// Parse an 'END' statement
19622    pub fn parse_end(&mut self) -> Result<Statement, ParserError> {
19623        let modifier = if !self.dialect.supports_end_transaction_modifier() {
19624            None
19625        } else if self.parse_keyword(Keyword::TRY) {
19626            Some(TransactionModifier::Try)
19627        } else if self.parse_keyword(Keyword::CATCH) {
19628            Some(TransactionModifier::Catch)
19629        } else {
19630            None
19631        };
19632        Ok(Statement::Commit {
19633            chain: self.parse_commit_rollback_chain()?,
19634            end: true,
19635            modifier,
19636        })
19637    }
19638
19639    /// Parse a list of transaction modes
19640    pub fn parse_transaction_modes(&mut self) -> Result<Vec<TransactionMode>, ParserError> {
19641        let mut modes = vec![];
19642        let mut required = false;
19643        loop {
19644            let mode = if self.parse_keywords(&[Keyword::ISOLATION, Keyword::LEVEL]) {
19645                let iso_level = if self.parse_keywords(&[Keyword::READ, Keyword::UNCOMMITTED]) {
19646                    TransactionIsolationLevel::ReadUncommitted
19647                } else if self.parse_keywords(&[Keyword::READ, Keyword::COMMITTED]) {
19648                    TransactionIsolationLevel::ReadCommitted
19649                } else if self.parse_keywords(&[Keyword::REPEATABLE, Keyword::READ]) {
19650                    TransactionIsolationLevel::RepeatableRead
19651                } else if self.parse_keyword(Keyword::SERIALIZABLE) {
19652                    TransactionIsolationLevel::Serializable
19653                } else if self.parse_keyword(Keyword::SNAPSHOT) {
19654                    TransactionIsolationLevel::Snapshot
19655                } else {
19656                    self.expected_ref("isolation level", self.peek_token_ref())?
19657                };
19658                TransactionMode::IsolationLevel(iso_level)
19659            } else if self.parse_keywords(&[Keyword::READ, Keyword::ONLY]) {
19660                TransactionMode::AccessMode(TransactionAccessMode::ReadOnly)
19661            } else if self.parse_keywords(&[Keyword::READ, Keyword::WRITE]) {
19662                TransactionMode::AccessMode(TransactionAccessMode::ReadWrite)
19663            } else if required {
19664                self.expected_ref("transaction mode", self.peek_token_ref())?
19665            } else {
19666                break;
19667            };
19668            modes.push(mode);
19669            // ANSI requires a comma after each transaction mode, but
19670            // PostgreSQL, for historical reasons, does not. We follow
19671            // PostgreSQL in making the comma optional, since that is strictly
19672            // more general.
19673            required = self.consume_token(&Token::Comma);
19674        }
19675        Ok(modes)
19676    }
19677
19678    /// Parse a 'COMMIT' statement
19679    pub fn parse_commit(&mut self) -> Result<Statement, ParserError> {
19680        Ok(Statement::Commit {
19681            chain: self.parse_commit_rollback_chain()?,
19682            end: false,
19683            modifier: None,
19684        })
19685    }
19686
19687    /// Parse a 'ROLLBACK' statement
19688    pub fn parse_rollback(&mut self) -> Result<Statement, ParserError> {
19689        let chain = self.parse_commit_rollback_chain()?;
19690        let savepoint = self.parse_rollback_savepoint()?;
19691
19692        Ok(Statement::Rollback { chain, savepoint })
19693    }
19694
19695    /// Parse an optional `AND [NO] CHAIN` clause for `COMMIT` and `ROLLBACK` statements
19696    pub fn parse_commit_rollback_chain(&mut self) -> Result<bool, ParserError> {
19697        let _ = self.parse_one_of_keywords(&[Keyword::TRANSACTION, Keyword::WORK, Keyword::TRAN]);
19698        if self.parse_keyword(Keyword::AND) {
19699            let chain = !self.parse_keyword(Keyword::NO);
19700            self.expect_keyword_is(Keyword::CHAIN)?;
19701            Ok(chain)
19702        } else {
19703            Ok(false)
19704        }
19705    }
19706
19707    /// Parse an optional 'TO SAVEPOINT savepoint_name' clause for ROLLBACK statements
19708    pub fn parse_rollback_savepoint(&mut self) -> Result<Option<Ident>, ParserError> {
19709        if self.parse_keyword(Keyword::TO) {
19710            let _ = self.parse_keyword(Keyword::SAVEPOINT);
19711            let savepoint = self.parse_identifier()?;
19712
19713            Ok(Some(savepoint))
19714        } else {
19715            Ok(None)
19716        }
19717    }
19718
19719    /// Parse a 'RAISERROR' statement
19720    pub fn parse_raiserror(&mut self) -> Result<Statement, ParserError> {
19721        self.expect_token(&Token::LParen)?;
19722        let message = Box::new(self.parse_expr()?);
19723        self.expect_token(&Token::Comma)?;
19724        let severity = Box::new(self.parse_expr()?);
19725        self.expect_token(&Token::Comma)?;
19726        let state = Box::new(self.parse_expr()?);
19727        let arguments = if self.consume_token(&Token::Comma) {
19728            self.parse_comma_separated(Parser::parse_expr)?
19729        } else {
19730            vec![]
19731        };
19732        self.expect_token(&Token::RParen)?;
19733        let options = if self.parse_keyword(Keyword::WITH) {
19734            self.parse_comma_separated(Parser::parse_raiserror_option)?
19735        } else {
19736            vec![]
19737        };
19738        Ok(Statement::RaisError {
19739            message,
19740            severity,
19741            state,
19742            arguments,
19743            options,
19744        })
19745    }
19746
19747    /// Parse a single `RAISERROR` option
19748    pub fn parse_raiserror_option(&mut self) -> Result<RaisErrorOption, ParserError> {
19749        match self.expect_one_of_keywords(&[Keyword::LOG, Keyword::NOWAIT, Keyword::SETERROR])? {
19750            Keyword::LOG => Ok(RaisErrorOption::Log),
19751            Keyword::NOWAIT => Ok(RaisErrorOption::NoWait),
19752            Keyword::SETERROR => Ok(RaisErrorOption::SetError),
19753            _ => self.expected_ref(
19754                "LOG, NOWAIT OR SETERROR raiserror option",
19755                self.peek_token_ref(),
19756            ),
19757        }
19758    }
19759
19760    /// Parse a MSSQL `THROW` statement.
19761    ///
19762    /// See [Statement::Throw]
19763    pub fn parse_throw(&mut self) -> Result<ThrowStatement, ParserError> {
19764        self.expect_keyword_is(Keyword::THROW)?;
19765
19766        let error_number = self.maybe_parse(|p| p.parse_expr().map(Box::new))?;
19767        let (message, state) = if error_number.is_some() {
19768            self.expect_token(&Token::Comma)?;
19769            let message = Box::new(self.parse_expr()?);
19770            self.expect_token(&Token::Comma)?;
19771            let state = Box::new(self.parse_expr()?);
19772            (Some(message), Some(state))
19773        } else {
19774            (None, None)
19775        };
19776
19777        Ok(ThrowStatement {
19778            error_number,
19779            message,
19780            state,
19781        })
19782    }
19783
19784    /// Parse a SQL `DEALLOCATE` statement
19785    pub fn parse_deallocate(&mut self) -> Result<Statement, ParserError> {
19786        let prepare = self.parse_keyword(Keyword::PREPARE);
19787        let name = self.parse_identifier()?;
19788        Ok(Statement::Deallocate { name, prepare })
19789    }
19790
19791    /// Parse a SQL `EXECUTE` statement
19792    pub fn parse_execute(&mut self) -> Result<Statement, ParserError> {
19793        let immediate =
19794            self.dialect.supports_execute_immediate() && self.parse_keyword(Keyword::IMMEDIATE);
19795
19796        // When `EXEC` is immediately followed by `(`, the content is a dynamic-SQL
19797        // expression — e.g. `EXEC (@sql)`, `EXEC ('SELECT ...')`, or
19798        // `EXEC ('SELECT ... FROM ' + @tbl + ' WHERE ...')`.
19799        // Skip name parsing; the expression ends up in `parameters` via the
19800        // `has_parentheses` path below, consistent with `EXECUTE IMMEDIATE <expr>`.
19801        let name = if immediate || matches!(self.peek_token_ref().token, Token::LParen) {
19802            None
19803        } else {
19804            Some(self.parse_object_name(false)?)
19805        };
19806
19807        let has_parentheses = self.consume_token(&Token::LParen);
19808
19809        let end_kws = &[Keyword::USING, Keyword::OUTPUT, Keyword::DEFAULT];
19810        let end_token = match (has_parentheses, self.peek_token().token) {
19811            (true, _) => Token::RParen,
19812            (false, Token::EOF) => Token::EOF,
19813            (false, Token::Word(w)) if end_kws.contains(&w.keyword) => Token::Word(w),
19814            (false, _) => Token::SemiColon,
19815        };
19816
19817        let parameters = self.parse_comma_separated0(Parser::parse_expr, end_token)?;
19818
19819        if has_parentheses {
19820            self.expect_token(&Token::RParen)?;
19821        }
19822
19823        let into = if self.parse_keyword(Keyword::INTO) {
19824            self.parse_comma_separated(Self::parse_identifier)?
19825        } else {
19826            vec![]
19827        };
19828
19829        let using = if self.parse_keyword(Keyword::USING) {
19830            self.parse_comma_separated(Self::parse_expr_with_alias)?
19831        } else {
19832            vec![]
19833        };
19834
19835        let output = self.parse_keyword(Keyword::OUTPUT);
19836
19837        let default = self.parse_keyword(Keyword::DEFAULT);
19838
19839        Ok(Statement::Execute {
19840            immediate,
19841            name,
19842            parameters,
19843            has_parentheses,
19844            into,
19845            using,
19846            output,
19847            default,
19848        })
19849    }
19850
19851    /// Parse a SQL `PREPARE` statement
19852    pub fn parse_prepare(&mut self) -> Result<Statement, ParserError> {
19853        let name = self.parse_identifier()?;
19854
19855        let mut data_types = vec![];
19856        if self.consume_token(&Token::LParen) {
19857            data_types = self.parse_comma_separated(Parser::parse_data_type)?;
19858            self.expect_token(&Token::RParen)?;
19859        }
19860
19861        self.expect_keyword_is(Keyword::AS)?;
19862        let statement = Box::new(self.parse_statement()?);
19863        Ok(Statement::Prepare {
19864            name,
19865            data_types,
19866            statement,
19867        })
19868    }
19869
19870    /// Parse a SQL `UNLOAD` statement
19871    pub fn parse_unload(&mut self) -> Result<Statement, ParserError> {
19872        self.expect_keyword(Keyword::UNLOAD)?;
19873        self.expect_token(&Token::LParen)?;
19874        let (query, query_text) =
19875            if matches!(self.peek_token_ref().token, Token::SingleQuotedString(_)) {
19876                (None, Some(self.parse_literal_string()?))
19877            } else {
19878                (Some(self.parse_query()?), None)
19879            };
19880        self.expect_token(&Token::RParen)?;
19881
19882        self.expect_keyword_is(Keyword::TO)?;
19883        let to = self.parse_identifier()?;
19884        let auth = if self.parse_keyword(Keyword::IAM_ROLE) {
19885            Some(self.parse_iam_role_kind()?)
19886        } else {
19887            None
19888        };
19889        let with = self.parse_options(Keyword::WITH)?;
19890        let mut options = vec![];
19891        while let Some(opt) = self.maybe_parse(|parser| parser.parse_copy_legacy_option())? {
19892            options.push(opt);
19893        }
19894        Ok(Statement::Unload {
19895            query,
19896            query_text,
19897            to,
19898            auth,
19899            with,
19900            options,
19901        })
19902    }
19903
19904    fn parse_select_into(&mut self) -> Result<SelectInto, ParserError> {
19905        let temporary = self
19906            .parse_one_of_keywords(&[Keyword::TEMP, Keyword::TEMPORARY])
19907            .is_some();
19908        let unlogged = self.parse_keyword(Keyword::UNLOGGED);
19909        let table = self.parse_keyword(Keyword::TABLE);
19910        let name = self.parse_object_name(false)?;
19911
19912        Ok(SelectInto {
19913            temporary,
19914            unlogged,
19915            table,
19916            name,
19917        })
19918    }
19919
19920    fn parse_pragma_value(&mut self) -> Result<ValueWithSpan, ParserError> {
19921        let v = self.parse_value()?;
19922        match &v.value {
19923            Value::SingleQuotedString(_) => Ok(v),
19924            Value::DoubleQuotedString(_) => Ok(v),
19925            Value::Number(_, _) => Ok(v),
19926            Value::Placeholder(_) => Ok(v),
19927            _ => {
19928                self.prev_token();
19929                self.expected_ref("number or string or ? placeholder", self.peek_token_ref())
19930            }
19931        }
19932    }
19933
19934    /// PRAGMA [schema-name '.'] pragma-name [('=' pragma-value) | '(' pragma-value ')']
19935    pub fn parse_pragma(&mut self) -> Result<Statement, ParserError> {
19936        let name = self.parse_object_name(false)?;
19937        if self.consume_token(&Token::LParen) {
19938            let value = self.parse_pragma_value()?;
19939            self.expect_token(&Token::RParen)?;
19940            Ok(Statement::Pragma {
19941                name,
19942                value: Some(value),
19943                is_eq: false,
19944            })
19945        } else if self.consume_token(&Token::Eq) {
19946            Ok(Statement::Pragma {
19947                name,
19948                value: Some(self.parse_pragma_value()?),
19949                is_eq: true,
19950            })
19951        } else {
19952            Ok(Statement::Pragma {
19953                name,
19954                value: None,
19955                is_eq: false,
19956            })
19957        }
19958    }
19959
19960    /// `INSTALL [extension_name]`
19961    pub fn parse_install(&mut self) -> Result<Statement, ParserError> {
19962        let extension_name = self.parse_identifier()?;
19963
19964        Ok(Statement::Install { extension_name })
19965    }
19966
19967    /// Parse a SQL LOAD statement
19968    pub fn parse_load(&mut self) -> Result<Statement, ParserError> {
19969        if self.dialect.supports_load_extension() {
19970            let extension_name = self.parse_identifier()?;
19971            Ok(Statement::Load { extension_name })
19972        } else if self.parse_keyword(Keyword::DATA) && self.dialect.supports_load_data() {
19973            let local = self.parse_one_of_keywords(&[Keyword::LOCAL]).is_some();
19974            self.expect_keyword_is(Keyword::INPATH)?;
19975            let inpath = self.parse_literal_string()?;
19976            let overwrite = self.parse_one_of_keywords(&[Keyword::OVERWRITE]).is_some();
19977            self.expect_keyword_is(Keyword::INTO)?;
19978            self.expect_keyword_is(Keyword::TABLE)?;
19979            let table_name = self.parse_object_name(false)?;
19980            let partitioned = self.parse_insert_partition()?;
19981            let table_format = self.parse_load_data_table_format()?;
19982            Ok(Statement::LoadData {
19983                local,
19984                inpath,
19985                overwrite,
19986                table_name,
19987                partitioned,
19988                table_format,
19989            })
19990        } else {
19991            self.expected_ref(
19992                "`DATA` or an extension name after `LOAD`",
19993                self.peek_token_ref(),
19994            )
19995        }
19996    }
19997
19998    /// ClickHouse:
19999    /// ```sql
20000    /// OPTIMIZE TABLE [db.]name [ON CLUSTER cluster] [PARTITION partition | PARTITION ID 'partition_id'] [FINAL] [DEDUPLICATE [BY expression]]
20001    /// ```
20002    /// [ClickHouse](https://clickhouse.com/docs/en/sql-reference/statements/optimize)
20003    ///
20004    /// Databricks:
20005    /// ```sql
20006    /// OPTIMIZE table_name [WHERE predicate] [ZORDER BY (col_name1 [, ...])]
20007    /// ```
20008    /// [Databricks](https://docs.databricks.com/en/sql/language-manual/delta-optimize.html)
20009    pub fn parse_optimize_table(&mut self) -> Result<Statement, ParserError> {
20010        let has_table_keyword = self.parse_keyword(Keyword::TABLE);
20011
20012        let name = self.parse_object_name(false)?;
20013
20014        // ClickHouse-specific options
20015        let on_cluster = self.parse_optional_on_cluster()?;
20016
20017        let partition = if self.parse_keyword(Keyword::PARTITION) {
20018            if self.parse_keyword(Keyword::ID) {
20019                Some(Partition::Identifier(self.parse_identifier()?))
20020            } else {
20021                Some(Partition::Expr(self.parse_expr()?))
20022            }
20023        } else {
20024            None
20025        };
20026
20027        let include_final = self.parse_keyword(Keyword::FINAL);
20028
20029        let deduplicate = if self.parse_keyword(Keyword::DEDUPLICATE) {
20030            if self.parse_keyword(Keyword::BY) {
20031                Some(Deduplicate::ByExpression(self.parse_expr()?))
20032            } else {
20033                Some(Deduplicate::All)
20034            }
20035        } else {
20036            None
20037        };
20038
20039        // Databricks-specific options
20040        let predicate = if self.parse_keyword(Keyword::WHERE) {
20041            Some(self.parse_expr()?)
20042        } else {
20043            None
20044        };
20045
20046        let zorder = if self.parse_keywords(&[Keyword::ZORDER, Keyword::BY]) {
20047            self.expect_token(&Token::LParen)?;
20048            let columns = self.parse_comma_separated(|p| p.parse_expr())?;
20049            self.expect_token(&Token::RParen)?;
20050            Some(columns)
20051        } else {
20052            None
20053        };
20054
20055        Ok(Statement::OptimizeTable {
20056            name,
20057            has_table_keyword,
20058            on_cluster,
20059            partition,
20060            include_final,
20061            deduplicate,
20062            predicate,
20063            zorder,
20064        })
20065    }
20066
20067    /// ```sql
20068    /// CREATE [ { TEMPORARY | TEMP } ] SEQUENCE [ IF NOT EXISTS ] <sequence_name>
20069    /// ```
20070    ///
20071    /// See [Postgres docs](https://www.postgresql.org/docs/current/sql-createsequence.html) for more details.
20072    pub fn parse_create_sequence(&mut self, temporary: bool) -> Result<Statement, ParserError> {
20073        //[ IF NOT EXISTS ]
20074        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
20075        //name
20076        let name = self.parse_object_name(false)?;
20077        //[ AS data_type ]
20078        let mut data_type: Option<DataType> = None;
20079        if self.parse_keywords(&[Keyword::AS]) {
20080            data_type = Some(self.parse_data_type()?)
20081        }
20082        let sequence_options = self.parse_create_sequence_options()?;
20083        // [ OWNED BY { table_name.column_name | NONE } ]
20084        let owned_by = if self.parse_keywords(&[Keyword::OWNED, Keyword::BY]) {
20085            if self.parse_keywords(&[Keyword::NONE]) {
20086                Some(ObjectName::from(vec![Ident::new("NONE")]))
20087            } else {
20088                Some(self.parse_object_name(false)?)
20089            }
20090        } else {
20091            None
20092        };
20093        Ok(Statement::CreateSequence {
20094            temporary,
20095            if_not_exists,
20096            name,
20097            data_type,
20098            sequence_options,
20099            owned_by,
20100        })
20101    }
20102
20103    fn parse_create_sequence_options(&mut self) -> Result<Vec<SequenceOptions>, ParserError> {
20104        let mut sequence_options = vec![];
20105        //[ INCREMENT [ BY ] increment ]
20106        if self.parse_keywords(&[Keyword::INCREMENT]) {
20107            if self.parse_keywords(&[Keyword::BY]) {
20108                sequence_options.push(SequenceOptions::IncrementBy(self.parse_number()?, true));
20109            } else {
20110                sequence_options.push(SequenceOptions::IncrementBy(self.parse_number()?, false));
20111            }
20112        }
20113        //[ MINVALUE minvalue | NO MINVALUE ]
20114        if self.parse_keyword(Keyword::MINVALUE) {
20115            sequence_options.push(SequenceOptions::MinValue(Some(self.parse_number()?)));
20116        } else if self.parse_keywords(&[Keyword::NO, Keyword::MINVALUE]) {
20117            sequence_options.push(SequenceOptions::MinValue(None));
20118        }
20119        //[ MAXVALUE maxvalue | NO MAXVALUE ]
20120        if self.parse_keywords(&[Keyword::MAXVALUE]) {
20121            sequence_options.push(SequenceOptions::MaxValue(Some(self.parse_number()?)));
20122        } else if self.parse_keywords(&[Keyword::NO, Keyword::MAXVALUE]) {
20123            sequence_options.push(SequenceOptions::MaxValue(None));
20124        }
20125
20126        //[ START [ WITH ] start ]
20127        if self.parse_keywords(&[Keyword::START]) {
20128            if self.parse_keywords(&[Keyword::WITH]) {
20129                sequence_options.push(SequenceOptions::StartWith(self.parse_number()?, true));
20130            } else {
20131                sequence_options.push(SequenceOptions::StartWith(self.parse_number()?, false));
20132            }
20133        }
20134        //[ CACHE cache ]
20135        if self.parse_keywords(&[Keyword::CACHE]) {
20136            sequence_options.push(SequenceOptions::Cache(self.parse_number()?));
20137        }
20138        // [ [ NO ] CYCLE ]
20139        if self.parse_keywords(&[Keyword::NO, Keyword::CYCLE]) {
20140            sequence_options.push(SequenceOptions::Cycle(true));
20141        } else if self.parse_keywords(&[Keyword::CYCLE]) {
20142            sequence_options.push(SequenceOptions::Cycle(false));
20143        }
20144
20145        Ok(sequence_options)
20146    }
20147
20148    ///   Parse a `CREATE SERVER` statement.
20149    ///
20150    ///  See [Statement::CreateServer]
20151    pub fn parse_pg_create_server(&mut self) -> Result<Statement, ParserError> {
20152        let ine = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
20153        let name = self.parse_object_name(false)?;
20154
20155        let server_type = if self.parse_keyword(Keyword::TYPE) {
20156            Some(self.parse_identifier()?)
20157        } else {
20158            None
20159        };
20160
20161        let version = if self.parse_keyword(Keyword::VERSION) {
20162            Some(self.parse_identifier()?)
20163        } else {
20164            None
20165        };
20166
20167        self.expect_keywords(&[Keyword::FOREIGN, Keyword::DATA, Keyword::WRAPPER])?;
20168        let foreign_data_wrapper = self.parse_object_name(false)?;
20169
20170        let mut options = None;
20171        if self.parse_keyword(Keyword::OPTIONS) {
20172            self.expect_token(&Token::LParen)?;
20173            options = Some(self.parse_comma_separated(|p| {
20174                let key = p.parse_identifier()?;
20175                let value = p.parse_identifier()?;
20176                Ok(CreateServerOption { key, value })
20177            })?);
20178            self.expect_token(&Token::RParen)?;
20179        }
20180
20181        Ok(Statement::CreateServer(CreateServerStatement {
20182            name,
20183            if_not_exists: ine,
20184            server_type,
20185            version,
20186            foreign_data_wrapper,
20187            options,
20188        }))
20189    }
20190
20191    /// Parse a `CREATE FOREIGN DATA WRAPPER` statement.
20192    ///
20193    /// See <https://www.postgresql.org/docs/current/sql-createforeigndatawrapper.html>
20194    pub fn parse_create_foreign_data_wrapper(
20195        &mut self,
20196    ) -> Result<CreateForeignDataWrapper, ParserError> {
20197        let name = self.parse_identifier()?;
20198
20199        let handler = if self.parse_keyword(Keyword::HANDLER) {
20200            Some(FdwRoutineClause::Function(self.parse_object_name(false)?))
20201        } else if self.parse_keywords(&[Keyword::NO, Keyword::HANDLER]) {
20202            Some(FdwRoutineClause::NoFunction)
20203        } else {
20204            None
20205        };
20206
20207        let validator = if self.parse_keyword(Keyword::VALIDATOR) {
20208            Some(FdwRoutineClause::Function(self.parse_object_name(false)?))
20209        } else if self.parse_keywords(&[Keyword::NO, Keyword::VALIDATOR]) {
20210            Some(FdwRoutineClause::NoFunction)
20211        } else {
20212            None
20213        };
20214
20215        let options = if self.parse_keyword(Keyword::OPTIONS) {
20216            self.expect_token(&Token::LParen)?;
20217            let opts = self.parse_comma_separated(|p| {
20218                let key = p.parse_identifier()?;
20219                let value = p.parse_identifier()?;
20220                Ok(CreateServerOption { key, value })
20221            })?;
20222            self.expect_token(&Token::RParen)?;
20223            Some(opts)
20224        } else {
20225            None
20226        };
20227
20228        Ok(CreateForeignDataWrapper {
20229            name,
20230            handler,
20231            validator,
20232            options,
20233        })
20234    }
20235
20236    /// Parse a `CREATE FOREIGN TABLE` statement.
20237    ///
20238    /// See <https://www.postgresql.org/docs/current/sql-createforeigntable.html>
20239    pub fn parse_create_foreign_table(
20240        &mut self,
20241    ) -> Result<CreateForeignTable, ParserError> {
20242        let if_not_exists =
20243            self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
20244        let name = self.parse_object_name(false)?;
20245        let (columns, _constraints) = self.parse_columns()?;
20246        self.expect_keyword_is(Keyword::SERVER)?;
20247        let server_name = self.parse_identifier()?;
20248
20249        let options = if self.parse_keyword(Keyword::OPTIONS) {
20250            self.expect_token(&Token::LParen)?;
20251            let opts = self.parse_comma_separated(|p| {
20252                let key = p.parse_identifier()?;
20253                let value = p.parse_identifier()?;
20254                Ok(CreateServerOption { key, value })
20255            })?;
20256            self.expect_token(&Token::RParen)?;
20257            Some(opts)
20258        } else {
20259            None
20260        };
20261
20262        Ok(CreateForeignTable {
20263            name,
20264            if_not_exists,
20265            columns,
20266            server_name,
20267            options,
20268        })
20269    }
20270
20271    /// Parse a `CREATE PUBLICATION` statement.
20272    ///
20273    /// See <https://www.postgresql.org/docs/current/sql-createpublication.html>
20274    pub fn parse_create_publication(&mut self) -> Result<CreatePublication, ParserError> {
20275        let name = self.parse_identifier()?;
20276
20277        let target = if self.parse_keyword(Keyword::FOR) {
20278            if self.parse_keywords(&[Keyword::ALL, Keyword::TABLES]) {
20279                Some(PublicationTarget::AllTables)
20280            } else if self.parse_keyword(Keyword::TABLE) {
20281                let tables = self.parse_comma_separated(|p| p.parse_object_name(false))?;
20282                Some(PublicationTarget::Tables(tables))
20283            } else if self.parse_keywords(&[Keyword::TABLES, Keyword::IN, Keyword::SCHEMA]) {
20284                let schemas = self.parse_comma_separated(|p| p.parse_identifier())?;
20285                Some(PublicationTarget::TablesInSchema(schemas))
20286            } else {
20287                return self.expected_ref(
20288                    "ALL TABLES, TABLE, or TABLES IN SCHEMA after FOR",
20289                    self.peek_token_ref(),
20290                );
20291            }
20292        } else {
20293            None
20294        };
20295
20296        let with_options = self.parse_options(Keyword::WITH)?;
20297
20298        Ok(CreatePublication {
20299            name,
20300            target,
20301            with_options,
20302        })
20303    }
20304
20305    /// Parse a `CREATE SUBSCRIPTION` statement.
20306    ///
20307    /// See <https://www.postgresql.org/docs/current/sql-createsubscription.html>
20308    pub fn parse_create_subscription(&mut self) -> Result<CreateSubscription, ParserError> {
20309        let name = self.parse_identifier()?;
20310        self.expect_keyword_is(Keyword::CONNECTION)?;
20311        let connection = self.parse_value()?.value;
20312        self.expect_keyword_is(Keyword::PUBLICATION)?;
20313        let publications = self.parse_comma_separated(|p| p.parse_identifier())?;
20314        let with_options = self.parse_options(Keyword::WITH)?;
20315
20316        Ok(CreateSubscription {
20317            name,
20318            connection,
20319            publications,
20320            with_options,
20321        })
20322    }
20323
20324    /// Parse a `CREATE CAST` statement.
20325    ///
20326    /// See <https://www.postgresql.org/docs/current/sql-createcast.html>
20327    pub fn parse_create_cast(&mut self) -> Result<CreateCast, ParserError> {
20328        self.expect_token(&Token::LParen)?;
20329        let source_type = self.parse_data_type()?;
20330        self.expect_keyword_is(Keyword::AS)?;
20331        let target_type = self.parse_data_type()?;
20332        self.expect_token(&Token::RParen)?;
20333
20334        let function_kind = if self.parse_keywords(&[Keyword::WITHOUT, Keyword::FUNCTION]) {
20335            CastFunctionKind::WithoutFunction
20336        } else if self.parse_keywords(&[Keyword::WITH, Keyword::INOUT]) {
20337            CastFunctionKind::WithInout
20338        } else if self.parse_keywords(&[Keyword::WITH, Keyword::FUNCTION]) {
20339            let function_name = self.parse_object_name(false)?;
20340            let argument_types = if self.peek_token_ref().token == Token::LParen {
20341                self.expect_token(&Token::LParen)?;
20342                let types = if self.peek_token_ref().token == Token::RParen {
20343                    vec![]
20344                } else {
20345                    self.parse_comma_separated(|p| p.parse_data_type())?
20346                };
20347                self.expect_token(&Token::RParen)?;
20348                types
20349            } else {
20350                vec![]
20351            };
20352            CastFunctionKind::WithFunction {
20353                function_name,
20354                argument_types,
20355            }
20356        } else {
20357            return self.expected_ref(
20358                "WITH FUNCTION, WITHOUT FUNCTION, or WITH INOUT",
20359                self.peek_token_ref(),
20360            );
20361        };
20362
20363        let cast_context = if self.parse_keyword(Keyword::AS) {
20364            if self.parse_keyword(Keyword::ASSIGNMENT) {
20365                CastContext::Assignment
20366            } else if self.parse_keyword(Keyword::IMPLICIT) {
20367                CastContext::Implicit
20368            } else {
20369                return self.expected_ref("ASSIGNMENT or IMPLICIT after AS", self.peek_token_ref());
20370            }
20371        } else {
20372            CastContext::Explicit
20373        };
20374
20375        Ok(CreateCast {
20376            source_type,
20377            target_type,
20378            function_kind,
20379            cast_context,
20380        })
20381    }
20382
20383    /// Parse a `CREATE [DEFAULT] CONVERSION` statement.
20384    ///
20385    /// See <https://www.postgresql.org/docs/current/sql-createconversion.html>
20386    pub fn parse_create_conversion(
20387        &mut self,
20388        is_default: bool,
20389    ) -> Result<CreateConversion, ParserError> {
20390        let name = self.parse_object_name(false)?;
20391        self.expect_keyword_is(Keyword::FOR)?;
20392        let source_encoding = self.parse_literal_string()?;
20393        self.expect_keyword_is(Keyword::TO)?;
20394        let destination_encoding = self.parse_literal_string()?;
20395        self.expect_keyword_is(Keyword::FROM)?;
20396        let function_name = self.parse_object_name(false)?;
20397
20398        Ok(CreateConversion {
20399            name,
20400            is_default,
20401            source_encoding,
20402            destination_encoding,
20403            function_name,
20404        })
20405    }
20406
20407    /// Parse a `CREATE [OR REPLACE] [TRUSTED] [PROCEDURAL] LANGUAGE` statement.
20408    ///
20409    /// See <https://www.postgresql.org/docs/current/sql-createlanguage.html>
20410    pub fn parse_create_language(
20411        &mut self,
20412        or_replace: bool,
20413        trusted: bool,
20414        procedural: bool,
20415    ) -> Result<CreateLanguage, ParserError> {
20416        let name = self.parse_identifier()?;
20417
20418        let handler = if self.parse_keyword(Keyword::HANDLER) {
20419            Some(self.parse_object_name(false)?)
20420        } else {
20421            None
20422        };
20423
20424        let inline_handler = if self.parse_keyword(Keyword::INLINE) {
20425            Some(self.parse_object_name(false)?)
20426        } else {
20427            None
20428        };
20429
20430        let validator = if self.parse_keywords(&[Keyword::NO, Keyword::VALIDATOR]) {
20431            None
20432        } else if self.parse_keyword(Keyword::VALIDATOR) {
20433            Some(self.parse_object_name(false)?)
20434        } else {
20435            None
20436        };
20437
20438        Ok(CreateLanguage {
20439            name,
20440            or_replace,
20441            trusted,
20442            procedural,
20443            handler,
20444            inline_handler,
20445            validator,
20446        })
20447    }
20448
20449    /// Parse a `CREATE RULE` statement.
20450    ///
20451    /// See <https://www.postgresql.org/docs/current/sql-createrule.html>
20452    pub fn parse_create_rule(&mut self) -> Result<CreateRule, ParserError> {
20453        let name = self.parse_identifier()?;
20454        self.expect_keyword_is(Keyword::AS)?;
20455        self.expect_keyword_is(Keyword::ON)?;
20456
20457        let event = if self.parse_keyword(Keyword::SELECT) {
20458            RuleEvent::Select
20459        } else if self.parse_keyword(Keyword::INSERT) {
20460            RuleEvent::Insert
20461        } else if self.parse_keyword(Keyword::UPDATE) {
20462            RuleEvent::Update
20463        } else if self.parse_keyword(Keyword::DELETE) {
20464            RuleEvent::Delete
20465        } else {
20466            return self.expected_ref(
20467                "SELECT, INSERT, UPDATE, or DELETE after ON",
20468                self.peek_token_ref(),
20469            );
20470        };
20471
20472        self.expect_keyword_is(Keyword::TO)?;
20473        let table = self.parse_object_name(false)?;
20474
20475        let condition = if self.parse_keyword(Keyword::WHERE) {
20476            Some(self.parse_expr()?)
20477        } else {
20478            None
20479        };
20480
20481        self.expect_keyword_is(Keyword::DO)?;
20482
20483        let instead = if self.parse_keyword(Keyword::INSTEAD) {
20484            true
20485        } else if self.parse_keyword(Keyword::ALSO) {
20486            false
20487        } else {
20488            false
20489        };
20490
20491        let action = if self.parse_keyword(Keyword::NOTHING) {
20492            RuleAction::Nothing
20493        } else if self.peek_token_ref().token == Token::LParen {
20494            self.expect_token(&Token::LParen)?;
20495            let mut stmts = Vec::new();
20496            loop {
20497                stmts.push(self.parse_statement()?);
20498                if !self.consume_token(&Token::SemiColon) {
20499                    break;
20500                }
20501                if self.peek_token_ref().token == Token::RParen {
20502                    break;
20503                }
20504            }
20505            self.expect_token(&Token::RParen)?;
20506            RuleAction::Statements(stmts)
20507        } else {
20508            let stmt = self.parse_statement()?;
20509            RuleAction::Statements(vec![stmt])
20510        };
20511
20512        Ok(CreateRule {
20513            name,
20514            event,
20515            table,
20516            condition,
20517            instead,
20518            action,
20519        })
20520    }
20521
20522    /// Parse a `CREATE STATISTICS` statement.
20523    ///
20524    /// See <https://www.postgresql.org/docs/current/sql-createstatistics.html>
20525    pub fn parse_create_statistics(&mut self) -> Result<CreateStatistics, ParserError> {
20526        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
20527        let name = self.parse_object_name(false)?;
20528
20529        let kinds = if self.consume_token(&Token::LParen) {
20530            let kinds = self.parse_comma_separated(|p| {
20531                let ident = p.parse_identifier()?;
20532                match ident.value.to_lowercase().as_str() {
20533                    "ndistinct" => Ok(StatisticsKind::NDistinct),
20534                    "dependencies" => Ok(StatisticsKind::Dependencies),
20535                    "mcv" => Ok(StatisticsKind::Mcv),
20536                    other => Err(ParserError::ParserError(format!(
20537                        "Unknown statistics kind: {other}"
20538                    ))),
20539                }
20540            })?;
20541            self.expect_token(&Token::RParen)?;
20542            kinds
20543        } else {
20544            vec![]
20545        };
20546
20547        self.expect_keyword_is(Keyword::ON)?;
20548        let on = self.parse_comma_separated(Parser::parse_expr)?;
20549        self.expect_keyword_is(Keyword::FROM)?;
20550        let from = self.parse_object_name(false)?;
20551
20552        Ok(CreateStatistics {
20553            if_not_exists,
20554            name,
20555            kinds,
20556            on,
20557            from,
20558        })
20559    }
20560
20561    /// Parse a `CREATE ACCESS METHOD` statement.
20562    ///
20563    /// See <https://www.postgresql.org/docs/current/sql-create-access-method.html>
20564    pub fn parse_create_access_method(&mut self) -> Result<CreateAccessMethod, ParserError> {
20565        let name = self.parse_identifier()?;
20566        self.expect_keyword_is(Keyword::TYPE)?;
20567        let method_type = if self.parse_keyword(Keyword::INDEX) {
20568            AccessMethodType::Index
20569        } else if self.parse_keyword(Keyword::TABLE) {
20570            AccessMethodType::Table
20571        } else {
20572            return self.expected_ref("INDEX or TABLE after TYPE", self.peek_token_ref());
20573        };
20574        self.expect_keyword_is(Keyword::HANDLER)?;
20575        let handler = self.parse_object_name(false)?;
20576
20577        Ok(CreateAccessMethod {
20578            name,
20579            method_type,
20580            handler,
20581        })
20582    }
20583
20584    /// Parse a `CREATE EVENT TRIGGER` statement.
20585    ///
20586    /// See <https://www.postgresql.org/docs/current/sql-createeventtrigger.html>
20587    pub fn parse_create_event_trigger(&mut self) -> Result<CreateEventTrigger, ParserError> {
20588        let name = self.parse_identifier()?;
20589        self.expect_keyword_is(Keyword::ON)?;
20590        let event_ident = self.parse_identifier()?;
20591        let event = match event_ident.value.to_lowercase().as_str() {
20592            "ddl_command_start" => EventTriggerEvent::DdlCommandStart,
20593            "ddl_command_end" => EventTriggerEvent::DdlCommandEnd,
20594            "table_rewrite" => EventTriggerEvent::TableRewrite,
20595            "sql_drop" => EventTriggerEvent::SqlDrop,
20596            other => {
20597                return Err(ParserError::ParserError(format!(
20598                    "Unknown event trigger event: {other}"
20599                )))
20600            }
20601        };
20602
20603        let when_tags = if self.parse_keyword(Keyword::WHEN) {
20604            self.expect_keyword_is(Keyword::TAG)?;
20605            self.expect_keyword_is(Keyword::IN)?;
20606            self.expect_token(&Token::LParen)?;
20607            let tags = self.parse_comma_separated(|p| p.parse_value().map(|v| v.value))?;
20608            self.expect_token(&Token::RParen)?;
20609            Some(tags)
20610        } else {
20611            None
20612        };
20613
20614        self.expect_keyword_is(Keyword::EXECUTE)?;
20615        let is_procedure = if self.parse_keyword(Keyword::FUNCTION) {
20616            false
20617        } else if self.parse_keyword(Keyword::PROCEDURE) {
20618            true
20619        } else {
20620            return self.expected_ref("FUNCTION or PROCEDURE after EXECUTE", self.peek_token_ref());
20621        };
20622        let execute = self.parse_object_name(false)?;
20623        self.expect_token(&Token::LParen)?;
20624        self.expect_token(&Token::RParen)?;
20625
20626        Ok(CreateEventTrigger {
20627            name,
20628            event,
20629            when_tags,
20630            execute,
20631            is_procedure,
20632        })
20633    }
20634
20635    /// Parse a `CREATE [OR REPLACE] TRANSFORM` statement.
20636    ///
20637    /// See <https://www.postgresql.org/docs/current/sql-createtransform.html>
20638    pub fn parse_create_transform(&mut self, or_replace: bool) -> Result<CreateTransform, ParserError> {
20639        self.expect_keyword_is(Keyword::FOR)?;
20640        let type_name = self.parse_data_type()?;
20641        self.expect_keyword_is(Keyword::LANGUAGE)?;
20642        let language = self.parse_identifier()?;
20643        self.expect_token(&Token::LParen)?;
20644        let elements = self.parse_comma_separated(|p| {
20645            let is_from = if p.parse_keyword(Keyword::FROM) {
20646                true
20647            } else {
20648                p.expect_keyword_is(Keyword::TO)?;
20649                false
20650            };
20651            p.expect_keyword_is(Keyword::SQL)?;
20652            p.expect_keyword_is(Keyword::WITH)?;
20653            p.expect_keyword_is(Keyword::FUNCTION)?;
20654            let function = p.parse_object_name(false)?;
20655            p.expect_token(&Token::LParen)?;
20656            let arg_types = if p.peek_token().token == Token::RParen {
20657                vec![]
20658            } else {
20659                p.parse_comma_separated(|p| p.parse_data_type())?
20660            };
20661            p.expect_token(&Token::RParen)?;
20662            Ok(TransformElement {
20663                is_from,
20664                function,
20665                arg_types,
20666            })
20667        })?;
20668        self.expect_token(&Token::RParen)?;
20669
20670        Ok(CreateTransform {
20671            or_replace,
20672            type_name,
20673            language,
20674            elements,
20675        })
20676    }
20677
20678
20679    /// Parse a `SECURITY LABEL` statement.
20680    ///
20681    /// See <https://www.postgresql.org/docs/current/sql-securitylabel.html>
20682    pub fn parse_security_label(&mut self) -> Result<SecurityLabel, ParserError> {
20683        self.expect_keyword_is(Keyword::LABEL)?;
20684
20685        let provider = if self.parse_keyword(Keyword::FOR) {
20686            Some(self.parse_identifier()?)
20687        } else {
20688            None
20689        };
20690
20691        self.expect_keyword_is(Keyword::ON)?;
20692
20693        let object_kind = if self.parse_keywords(&[Keyword::MATERIALIZED, Keyword::VIEW]) {
20694            SecurityLabelObjectKind::MaterializedView
20695        } else if self.parse_keyword(Keyword::TABLE) {
20696            SecurityLabelObjectKind::Table
20697        } else if self.parse_keyword(Keyword::COLUMN) {
20698            SecurityLabelObjectKind::Column
20699        } else if self.parse_keyword(Keyword::DATABASE) {
20700            SecurityLabelObjectKind::Database
20701        } else if self.parse_keyword(Keyword::DOMAIN) {
20702            SecurityLabelObjectKind::Domain
20703        } else if self.parse_keyword(Keyword::FUNCTION) {
20704            SecurityLabelObjectKind::Function
20705        } else if self.parse_keyword(Keyword::ROLE) {
20706            SecurityLabelObjectKind::Role
20707        } else if self.parse_keyword(Keyword::SCHEMA) {
20708            SecurityLabelObjectKind::Schema
20709        } else if self.parse_keyword(Keyword::SEQUENCE) {
20710            SecurityLabelObjectKind::Sequence
20711        } else if self.parse_keyword(Keyword::TYPE) {
20712            SecurityLabelObjectKind::Type
20713        } else if self.parse_keyword(Keyword::VIEW) {
20714            SecurityLabelObjectKind::View
20715        } else {
20716            return self.expected_ref(
20717                "TABLE, COLUMN, DATABASE, DOMAIN, FUNCTION, MATERIALIZED VIEW, ROLE, SCHEMA, SEQUENCE, TYPE, or VIEW after ON",
20718                self.peek_token_ref(),
20719            );
20720        };
20721
20722        let object_name = self.parse_object_name(false)?;
20723
20724        self.expect_keyword_is(Keyword::IS)?;
20725
20726        let label = if self.parse_keyword(Keyword::NULL) {
20727            None
20728        } else {
20729            Some(self.parse_value()?.value)
20730        };
20731
20732        Ok(SecurityLabel {
20733            provider,
20734            object_kind,
20735            object_name,
20736            label,
20737        })
20738    }
20739
20740    /// Parse a `CREATE USER MAPPING` statement.
20741    ///
20742    /// See <https://www.postgresql.org/docs/current/sql-createusermapping.html>
20743    pub fn parse_create_user_mapping(&mut self) -> Result<CreateUserMapping, ParserError> {
20744        let if_not_exists = self.parse_keywords(&[Keyword::IF, Keyword::NOT, Keyword::EXISTS]);
20745
20746        self.expect_keyword_is(Keyword::FOR)?;
20747
20748        let user = if self.parse_keyword(Keyword::CURRENT_ROLE) {
20749            UserMappingUser::CurrentRole
20750        } else if self.parse_keyword(Keyword::CURRENT_USER) {
20751            UserMappingUser::CurrentUser
20752        } else if self.parse_keyword(Keyword::PUBLIC) {
20753            UserMappingUser::Public
20754        } else if self.parse_keyword(Keyword::USER) {
20755            UserMappingUser::User
20756        } else {
20757            UserMappingUser::Ident(self.parse_identifier()?)
20758        };
20759
20760        self.expect_keyword_is(Keyword::SERVER)?;
20761        let server_name = self.parse_identifier()?;
20762
20763        let options = if self.parse_keyword(Keyword::OPTIONS) {
20764            self.expect_token(&Token::LParen)?;
20765            let opts = self.parse_comma_separated(|p| {
20766                let key = p.parse_identifier()?;
20767                let value = p.parse_identifier()?;
20768                Ok(CreateServerOption { key, value })
20769            })?;
20770            self.expect_token(&Token::RParen)?;
20771            Some(opts)
20772        } else {
20773            None
20774        };
20775
20776        Ok(CreateUserMapping {
20777            if_not_exists,
20778            user,
20779            server_name,
20780            options,
20781        })
20782    }
20783
20784    /// Parse a `CREATE TABLESPACE` statement.
20785    ///
20786    /// See <https://www.postgresql.org/docs/current/sql-createtablespace.html>
20787    pub fn parse_create_tablespace(&mut self) -> Result<CreateTablespace, ParserError> {
20788        let name = self.parse_identifier()?;
20789
20790        let owner = if self.parse_keyword(Keyword::OWNER) {
20791            Some(self.parse_identifier()?)
20792        } else {
20793            None
20794        };
20795
20796        self.expect_keyword_is(Keyword::LOCATION)?;
20797        let location = self.parse_value()?.value;
20798
20799        let with_options = self.parse_options(Keyword::WITH)?;
20800
20801        Ok(CreateTablespace {
20802            name,
20803            owner,
20804            location,
20805            with_options,
20806        })
20807    }
20808
20809    /// The index of the first unprocessed token.
20810    pub fn index(&self) -> usize {
20811        self.index
20812    }
20813
20814    /// Parse a named window definition.
20815    pub fn parse_named_window(&mut self) -> Result<NamedWindowDefinition, ParserError> {
20816        let ident = self.parse_identifier()?;
20817        self.expect_keyword_is(Keyword::AS)?;
20818
20819        let window_expr = if self.consume_token(&Token::LParen) {
20820            NamedWindowExpr::WindowSpec(self.parse_window_spec()?)
20821        } else if self.dialect.supports_window_clause_named_window_reference() {
20822            NamedWindowExpr::NamedWindow(self.parse_identifier()?)
20823        } else {
20824            return self.expected_ref("(", self.peek_token_ref());
20825        };
20826
20827        Ok(NamedWindowDefinition(ident, window_expr))
20828    }
20829
20830    /// Parse `CREATE PROCEDURE` statement.
20831    pub fn parse_create_procedure(&mut self, or_alter: bool) -> Result<Statement, ParserError> {
20832        let name = self.parse_object_name(false)?;
20833        let params = self.parse_optional_procedure_parameters()?;
20834
20835        let language = if self.parse_keyword(Keyword::LANGUAGE) {
20836            Some(self.parse_identifier()?)
20837        } else {
20838            None
20839        };
20840
20841        self.expect_keyword_is(Keyword::AS)?;
20842
20843        let body = self.parse_conditional_statements(&[Keyword::END])?;
20844
20845        Ok(Statement::CreateProcedure {
20846            name,
20847            or_alter,
20848            params,
20849            language,
20850            body,
20851        })
20852    }
20853
20854    /// Parse a window specification.
20855    pub fn parse_window_spec(&mut self) -> Result<WindowSpec, ParserError> {
20856        let window_name = match &self.peek_token_ref().token {
20857            Token::Word(word) if word.keyword == Keyword::NoKeyword => {
20858                self.parse_optional_ident()?
20859            }
20860            _ => None,
20861        };
20862
20863        let partition_by = if self.parse_keywords(&[Keyword::PARTITION, Keyword::BY]) {
20864            self.parse_comma_separated(Parser::parse_expr)?
20865        } else {
20866            vec![]
20867        };
20868        let order_by = if self.parse_keywords(&[Keyword::ORDER, Keyword::BY]) {
20869            self.parse_comma_separated(Parser::parse_order_by_expr)?
20870        } else {
20871            vec![]
20872        };
20873
20874        let window_frame = if !self.consume_token(&Token::RParen) {
20875            let window_frame = self.parse_window_frame()?;
20876            self.expect_token(&Token::RParen)?;
20877            Some(window_frame)
20878        } else {
20879            None
20880        };
20881        Ok(WindowSpec {
20882            window_name,
20883            partition_by,
20884            order_by,
20885            window_frame,
20886        })
20887    }
20888
20889    /// Parse `CREATE TYPE` statement.
20890    pub fn parse_create_type(&mut self) -> Result<Statement, ParserError> {
20891        let name = self.parse_object_name(false)?;
20892
20893        // Check if we have AS keyword
20894        let has_as = self.parse_keyword(Keyword::AS);
20895
20896        if !has_as {
20897            // Two cases: CREATE TYPE name; or CREATE TYPE name (options);
20898            if self.consume_token(&Token::LParen) {
20899                // CREATE TYPE name (options) - SQL definition without AS
20900                let options = self.parse_create_type_sql_definition_options()?;
20901                self.expect_token(&Token::RParen)?;
20902                return Ok(Statement::CreateType {
20903                    name,
20904                    representation: Some(UserDefinedTypeRepresentation::SqlDefinition { options }),
20905                });
20906            }
20907
20908            // CREATE TYPE name; - no representation
20909            return Ok(Statement::CreateType {
20910                name,
20911                representation: None,
20912            });
20913        }
20914
20915        // We have AS keyword
20916        if self.parse_keyword(Keyword::ENUM) {
20917            // CREATE TYPE name AS ENUM (labels)
20918            self.parse_create_type_enum(name)
20919        } else if self.parse_keyword(Keyword::RANGE) {
20920            // CREATE TYPE name AS RANGE (options)
20921            self.parse_create_type_range(name)
20922        } else if self.consume_token(&Token::LParen) {
20923            // CREATE TYPE name AS (attributes) - Composite
20924            self.parse_create_type_composite(name)
20925        } else {
20926            self.expected_ref("ENUM, RANGE, or '(' after AS", self.peek_token_ref())
20927        }
20928    }
20929
20930    /// Parse remainder of `CREATE TYPE AS (attributes)` statement (composite type)
20931    ///
20932    /// See [PostgreSQL](https://www.postgresql.org/docs/current/sql-createtype.html)
20933    fn parse_create_type_composite(&mut self, name: ObjectName) -> Result<Statement, ParserError> {
20934        if self.consume_token(&Token::RParen) {
20935            // Empty composite type
20936            return Ok(Statement::CreateType {
20937                name,
20938                representation: Some(UserDefinedTypeRepresentation::Composite {
20939                    attributes: vec![],
20940                }),
20941            });
20942        }
20943
20944        let mut attributes = vec![];
20945        loop {
20946            let attr_name = self.parse_identifier()?;
20947            let attr_data_type = self.parse_data_type()?;
20948            let attr_collation = if self.parse_keyword(Keyword::COLLATE) {
20949                Some(self.parse_object_name(false)?)
20950            } else {
20951                None
20952            };
20953            attributes.push(UserDefinedTypeCompositeAttributeDef {
20954                name: attr_name,
20955                data_type: attr_data_type,
20956                collation: attr_collation,
20957            });
20958
20959            if !self.consume_token(&Token::Comma) {
20960                break;
20961            }
20962        }
20963        self.expect_token(&Token::RParen)?;
20964
20965        Ok(Statement::CreateType {
20966            name,
20967            representation: Some(UserDefinedTypeRepresentation::Composite { attributes }),
20968        })
20969    }
20970
20971    /// Parse remainder of `CREATE TYPE AS ENUM` statement (see [Statement::CreateType] and [Self::parse_create_type])
20972    ///
20973    /// See [PostgreSQL](https://www.postgresql.org/docs/current/sql-createtype.html)
20974    pub fn parse_create_type_enum(&mut self, name: ObjectName) -> Result<Statement, ParserError> {
20975        self.expect_token(&Token::LParen)?;
20976        let labels = self.parse_comma_separated0(|p| p.parse_identifier(), Token::RParen)?;
20977        self.expect_token(&Token::RParen)?;
20978
20979        Ok(Statement::CreateType {
20980            name,
20981            representation: Some(UserDefinedTypeRepresentation::Enum { labels }),
20982        })
20983    }
20984
20985    /// Parse remainder of `CREATE TYPE AS RANGE` statement
20986    ///
20987    /// See [PostgreSQL](https://www.postgresql.org/docs/current/sql-createtype.html)
20988    fn parse_create_type_range(&mut self, name: ObjectName) -> Result<Statement, ParserError> {
20989        self.expect_token(&Token::LParen)?;
20990        let options = self.parse_comma_separated0(|p| p.parse_range_option(), Token::RParen)?;
20991        self.expect_token(&Token::RParen)?;
20992
20993        Ok(Statement::CreateType {
20994            name,
20995            representation: Some(UserDefinedTypeRepresentation::Range { options }),
20996        })
20997    }
20998
20999    /// Parse a single range option for a `CREATE TYPE AS RANGE` statement
21000    fn parse_range_option(&mut self) -> Result<UserDefinedTypeRangeOption, ParserError> {
21001        let keyword = self.parse_one_of_keywords(&[
21002            Keyword::SUBTYPE,
21003            Keyword::SUBTYPE_OPCLASS,
21004            Keyword::COLLATION,
21005            Keyword::CANONICAL,
21006            Keyword::SUBTYPE_DIFF,
21007            Keyword::MULTIRANGE_TYPE_NAME,
21008        ]);
21009
21010        match keyword {
21011            Some(Keyword::SUBTYPE) => {
21012                self.expect_token(&Token::Eq)?;
21013                let data_type = self.parse_data_type()?;
21014                Ok(UserDefinedTypeRangeOption::Subtype(data_type))
21015            }
21016            Some(Keyword::SUBTYPE_OPCLASS) => {
21017                self.expect_token(&Token::Eq)?;
21018                let name = self.parse_object_name(false)?;
21019                Ok(UserDefinedTypeRangeOption::SubtypeOpClass(name))
21020            }
21021            Some(Keyword::COLLATION) => {
21022                self.expect_token(&Token::Eq)?;
21023                let name = self.parse_object_name(false)?;
21024                Ok(UserDefinedTypeRangeOption::Collation(name))
21025            }
21026            Some(Keyword::CANONICAL) => {
21027                self.expect_token(&Token::Eq)?;
21028                let name = self.parse_object_name(false)?;
21029                Ok(UserDefinedTypeRangeOption::Canonical(name))
21030            }
21031            Some(Keyword::SUBTYPE_DIFF) => {
21032                self.expect_token(&Token::Eq)?;
21033                let name = self.parse_object_name(false)?;
21034                Ok(UserDefinedTypeRangeOption::SubtypeDiff(name))
21035            }
21036            Some(Keyword::MULTIRANGE_TYPE_NAME) => {
21037                self.expect_token(&Token::Eq)?;
21038                let name = self.parse_object_name(false)?;
21039                Ok(UserDefinedTypeRangeOption::MultirangeTypeName(name))
21040            }
21041            _ => self.expected_ref("range option keyword", self.peek_token_ref()),
21042        }
21043    }
21044
21045    /// Parse SQL definition options for CREATE TYPE (options)
21046    fn parse_create_type_sql_definition_options(
21047        &mut self,
21048    ) -> Result<Vec<UserDefinedTypeSqlDefinitionOption>, ParserError> {
21049        self.parse_comma_separated0(|p| p.parse_sql_definition_option(), Token::RParen)
21050    }
21051
21052    /// Parse a single SQL definition option for CREATE TYPE (options)
21053    fn parse_sql_definition_option(
21054        &mut self,
21055    ) -> Result<UserDefinedTypeSqlDefinitionOption, ParserError> {
21056        let keyword = self.parse_one_of_keywords(&[
21057            Keyword::INPUT,
21058            Keyword::OUTPUT,
21059            Keyword::RECEIVE,
21060            Keyword::SEND,
21061            Keyword::TYPMOD_IN,
21062            Keyword::TYPMOD_OUT,
21063            Keyword::ANALYZE,
21064            Keyword::SUBSCRIPT,
21065            Keyword::INTERNALLENGTH,
21066            Keyword::PASSEDBYVALUE,
21067            Keyword::ALIGNMENT,
21068            Keyword::STORAGE,
21069            Keyword::LIKE,
21070            Keyword::CATEGORY,
21071            Keyword::PREFERRED,
21072            Keyword::DEFAULT,
21073            Keyword::ELEMENT,
21074            Keyword::DELIMITER,
21075            Keyword::COLLATABLE,
21076        ]);
21077
21078        match keyword {
21079            Some(Keyword::INPUT) => {
21080                self.expect_token(&Token::Eq)?;
21081                let name = self.parse_object_name(false)?;
21082                Ok(UserDefinedTypeSqlDefinitionOption::Input(name))
21083            }
21084            Some(Keyword::OUTPUT) => {
21085                self.expect_token(&Token::Eq)?;
21086                let name = self.parse_object_name(false)?;
21087                Ok(UserDefinedTypeSqlDefinitionOption::Output(name))
21088            }
21089            Some(Keyword::RECEIVE) => {
21090                self.expect_token(&Token::Eq)?;
21091                let name = self.parse_object_name(false)?;
21092                Ok(UserDefinedTypeSqlDefinitionOption::Receive(name))
21093            }
21094            Some(Keyword::SEND) => {
21095                self.expect_token(&Token::Eq)?;
21096                let name = self.parse_object_name(false)?;
21097                Ok(UserDefinedTypeSqlDefinitionOption::Send(name))
21098            }
21099            Some(Keyword::TYPMOD_IN) => {
21100                self.expect_token(&Token::Eq)?;
21101                let name = self.parse_object_name(false)?;
21102                Ok(UserDefinedTypeSqlDefinitionOption::TypmodIn(name))
21103            }
21104            Some(Keyword::TYPMOD_OUT) => {
21105                self.expect_token(&Token::Eq)?;
21106                let name = self.parse_object_name(false)?;
21107                Ok(UserDefinedTypeSqlDefinitionOption::TypmodOut(name))
21108            }
21109            Some(Keyword::ANALYZE) => {
21110                self.expect_token(&Token::Eq)?;
21111                let name = self.parse_object_name(false)?;
21112                Ok(UserDefinedTypeSqlDefinitionOption::Analyze(name))
21113            }
21114            Some(Keyword::SUBSCRIPT) => {
21115                self.expect_token(&Token::Eq)?;
21116                let name = self.parse_object_name(false)?;
21117                Ok(UserDefinedTypeSqlDefinitionOption::Subscript(name))
21118            }
21119            Some(Keyword::INTERNALLENGTH) => {
21120                self.expect_token(&Token::Eq)?;
21121                if self.parse_keyword(Keyword::VARIABLE) {
21122                    Ok(UserDefinedTypeSqlDefinitionOption::InternalLength(
21123                        UserDefinedTypeInternalLength::Variable,
21124                    ))
21125                } else {
21126                    let value = self.parse_literal_uint()?;
21127                    Ok(UserDefinedTypeSqlDefinitionOption::InternalLength(
21128                        UserDefinedTypeInternalLength::Fixed(value),
21129                    ))
21130                }
21131            }
21132            Some(Keyword::PASSEDBYVALUE) => Ok(UserDefinedTypeSqlDefinitionOption::PassedByValue),
21133            Some(Keyword::ALIGNMENT) => {
21134                self.expect_token(&Token::Eq)?;
21135                let align_keyword = self.parse_one_of_keywords(&[
21136                    Keyword::CHAR,
21137                    Keyword::INT2,
21138                    Keyword::INT4,
21139                    Keyword::DOUBLE,
21140                ]);
21141                match align_keyword {
21142                    Some(Keyword::CHAR) => Ok(UserDefinedTypeSqlDefinitionOption::Alignment(
21143                        Alignment::Char,
21144                    )),
21145                    Some(Keyword::INT2) => Ok(UserDefinedTypeSqlDefinitionOption::Alignment(
21146                        Alignment::Int2,
21147                    )),
21148                    Some(Keyword::INT4) => Ok(UserDefinedTypeSqlDefinitionOption::Alignment(
21149                        Alignment::Int4,
21150                    )),
21151                    Some(Keyword::DOUBLE) => Ok(UserDefinedTypeSqlDefinitionOption::Alignment(
21152                        Alignment::Double,
21153                    )),
21154                    _ => self.expected_ref(
21155                        "alignment value (char, int2, int4, or double)",
21156                        self.peek_token_ref(),
21157                    ),
21158                }
21159            }
21160            Some(Keyword::STORAGE) => {
21161                self.expect_token(&Token::Eq)?;
21162                let storage_keyword = self.parse_one_of_keywords(&[
21163                    Keyword::PLAIN,
21164                    Keyword::EXTERNAL,
21165                    Keyword::EXTENDED,
21166                    Keyword::MAIN,
21167                ]);
21168                match storage_keyword {
21169                    Some(Keyword::PLAIN) => Ok(UserDefinedTypeSqlDefinitionOption::Storage(
21170                        UserDefinedTypeStorage::Plain,
21171                    )),
21172                    Some(Keyword::EXTERNAL) => Ok(UserDefinedTypeSqlDefinitionOption::Storage(
21173                        UserDefinedTypeStorage::External,
21174                    )),
21175                    Some(Keyword::EXTENDED) => Ok(UserDefinedTypeSqlDefinitionOption::Storage(
21176                        UserDefinedTypeStorage::Extended,
21177                    )),
21178                    Some(Keyword::MAIN) => Ok(UserDefinedTypeSqlDefinitionOption::Storage(
21179                        UserDefinedTypeStorage::Main,
21180                    )),
21181                    _ => self.expected_ref(
21182                        "storage value (plain, external, extended, or main)",
21183                        self.peek_token_ref(),
21184                    ),
21185                }
21186            }
21187            Some(Keyword::LIKE) => {
21188                self.expect_token(&Token::Eq)?;
21189                let name = self.parse_object_name(false)?;
21190                Ok(UserDefinedTypeSqlDefinitionOption::Like(name))
21191            }
21192            Some(Keyword::CATEGORY) => {
21193                self.expect_token(&Token::Eq)?;
21194                let category_str = self.parse_literal_string()?;
21195                let category_char = category_str.chars().next().ok_or_else(|| {
21196                    ParserError::ParserError(
21197                        "CATEGORY value must be a single character".to_string(),
21198                    )
21199                })?;
21200                Ok(UserDefinedTypeSqlDefinitionOption::Category(category_char))
21201            }
21202            Some(Keyword::PREFERRED) => {
21203                self.expect_token(&Token::Eq)?;
21204                let value =
21205                    self.parse_keyword(Keyword::TRUE) || !self.parse_keyword(Keyword::FALSE);
21206                Ok(UserDefinedTypeSqlDefinitionOption::Preferred(value))
21207            }
21208            Some(Keyword::DEFAULT) => {
21209                self.expect_token(&Token::Eq)?;
21210                let expr = self.parse_expr()?;
21211                Ok(UserDefinedTypeSqlDefinitionOption::Default(expr))
21212            }
21213            Some(Keyword::ELEMENT) => {
21214                self.expect_token(&Token::Eq)?;
21215                let data_type = self.parse_data_type()?;
21216                Ok(UserDefinedTypeSqlDefinitionOption::Element(data_type))
21217            }
21218            Some(Keyword::DELIMITER) => {
21219                self.expect_token(&Token::Eq)?;
21220                let delimiter = self.parse_literal_string()?;
21221                Ok(UserDefinedTypeSqlDefinitionOption::Delimiter(delimiter))
21222            }
21223            Some(Keyword::COLLATABLE) => {
21224                self.expect_token(&Token::Eq)?;
21225                let value =
21226                    self.parse_keyword(Keyword::TRUE) || !self.parse_keyword(Keyword::FALSE);
21227                Ok(UserDefinedTypeSqlDefinitionOption::Collatable(value))
21228            }
21229            _ => self.expected_ref("SQL definition option keyword", self.peek_token_ref()),
21230        }
21231    }
21232
21233    fn parse_parenthesized_identifiers(&mut self) -> Result<Vec<Ident>, ParserError> {
21234        self.expect_token(&Token::LParen)?;
21235        let idents = self.parse_comma_separated0(|p| p.parse_identifier(), Token::RParen)?;
21236        self.expect_token(&Token::RParen)?;
21237        Ok(idents)
21238    }
21239
21240    fn parse_column_position(&mut self) -> Result<Option<MySQLColumnPosition>, ParserError> {
21241        if dialect_of!(self is MySqlDialect | GenericDialect) {
21242            if self.parse_keyword(Keyword::FIRST) {
21243                Ok(Some(MySQLColumnPosition::First))
21244            } else if self.parse_keyword(Keyword::AFTER) {
21245                let ident = self.parse_identifier()?;
21246                Ok(Some(MySQLColumnPosition::After(ident)))
21247            } else {
21248                Ok(None)
21249            }
21250        } else {
21251            Ok(None)
21252        }
21253    }
21254
21255    /// Parse [Statement::Print]
21256    fn parse_print(&mut self) -> Result<Statement, ParserError> {
21257        Ok(Statement::Print(PrintStatement {
21258            message: Box::new(self.parse_expr()?),
21259        }))
21260    }
21261
21262    /// Parse [Statement::WaitFor]
21263    ///
21264    /// See: <https://learn.microsoft.com/en-us/sql/t-sql/language-elements/waitfor-transact-sql>
21265    fn parse_waitfor(&mut self) -> Result<Statement, ParserError> {
21266        let wait_type = if self.parse_keyword(Keyword::DELAY) {
21267            WaitForType::Delay
21268        } else if self.parse_keyword(Keyword::TIME) {
21269            WaitForType::Time
21270        } else {
21271            return self.expected_ref("DELAY or TIME", self.peek_token_ref());
21272        };
21273        let expr = self.parse_expr()?;
21274        Ok(Statement::WaitFor(WaitForStatement { wait_type, expr }))
21275    }
21276
21277    /// Parse [Statement::Return]
21278    fn parse_return(&mut self) -> Result<Statement, ParserError> {
21279        match self.maybe_parse(|p| p.parse_expr())? {
21280            Some(expr) => Ok(Statement::Return(ReturnStatement {
21281                value: Some(ReturnStatementValue::Expr(expr)),
21282            })),
21283            None => Ok(Statement::Return(ReturnStatement { value: None })),
21284        }
21285    }
21286
21287    /// /// Parse a `EXPORT DATA` statement.
21288    ///
21289    /// See [Statement::ExportData]
21290    fn parse_export_data(&mut self) -> Result<Statement, ParserError> {
21291        self.expect_keywords(&[Keyword::EXPORT, Keyword::DATA])?;
21292
21293        let connection = if self.parse_keywords(&[Keyword::WITH, Keyword::CONNECTION]) {
21294            Some(self.parse_object_name(false)?)
21295        } else {
21296            None
21297        };
21298        self.expect_keyword(Keyword::OPTIONS)?;
21299        self.expect_token(&Token::LParen)?;
21300        let options = self.parse_comma_separated(|p| p.parse_sql_option())?;
21301        self.expect_token(&Token::RParen)?;
21302        self.expect_keyword(Keyword::AS)?;
21303        let query = self.parse_query()?;
21304        Ok(Statement::ExportData(ExportData {
21305            options,
21306            query,
21307            connection,
21308        }))
21309    }
21310
21311    fn parse_vacuum(&mut self) -> Result<Statement, ParserError> {
21312        self.expect_keyword(Keyword::VACUUM)?;
21313        let full = self.parse_keyword(Keyword::FULL);
21314        let sort_only = self.parse_keywords(&[Keyword::SORT, Keyword::ONLY]);
21315        let delete_only = self.parse_keywords(&[Keyword::DELETE, Keyword::ONLY]);
21316        let reindex = self.parse_keyword(Keyword::REINDEX);
21317        let recluster = self.parse_keyword(Keyword::RECLUSTER);
21318        let (table_name, threshold, boost) =
21319            match self.maybe_parse(|p| p.parse_object_name(false))? {
21320                Some(table_name) => {
21321                    let threshold = if self.parse_keyword(Keyword::TO) {
21322                        let value = self.parse_value()?;
21323                        self.expect_keyword(Keyword::PERCENT)?;
21324                        Some(value)
21325                    } else {
21326                        None
21327                    };
21328                    let boost = self.parse_keyword(Keyword::BOOST);
21329                    (Some(table_name), threshold, boost)
21330                }
21331                _ => (None, None, false),
21332            };
21333        Ok(Statement::Vacuum(VacuumStatement {
21334            full,
21335            sort_only,
21336            delete_only,
21337            reindex,
21338            recluster,
21339            table_name,
21340            threshold,
21341            boost,
21342        }))
21343    }
21344
21345    /// Consume the parser and return its underlying token buffer
21346    pub fn into_tokens(self) -> Vec<TokenWithSpan> {
21347        self.tokens
21348    }
21349
21350    /// Returns true if the next keyword indicates a sub query, i.e. SELECT or WITH
21351    fn peek_sub_query(&mut self) -> bool {
21352        self.peek_one_of_keywords(&[Keyword::SELECT, Keyword::WITH])
21353            .is_some()
21354    }
21355
21356    pub(crate) fn parse_show_stmt_options(&mut self) -> Result<ShowStatementOptions, ParserError> {
21357        let show_in;
21358        let mut filter_position = None;
21359        if self.dialect.supports_show_like_before_in() {
21360            if let Some(filter) = self.parse_show_statement_filter()? {
21361                filter_position = Some(ShowStatementFilterPosition::Infix(filter));
21362            }
21363            show_in = self.maybe_parse_show_stmt_in()?;
21364        } else {
21365            show_in = self.maybe_parse_show_stmt_in()?;
21366            if let Some(filter) = self.parse_show_statement_filter()? {
21367                filter_position = Some(ShowStatementFilterPosition::Suffix(filter));
21368            }
21369        }
21370        let starts_with = self.maybe_parse_show_stmt_starts_with()?;
21371        let limit = self.maybe_parse_show_stmt_limit()?;
21372        let from = self.maybe_parse_show_stmt_from()?;
21373        Ok(ShowStatementOptions {
21374            filter_position,
21375            show_in,
21376            starts_with,
21377            limit,
21378            limit_from: from,
21379        })
21380    }
21381
21382    fn maybe_parse_show_stmt_in(&mut self) -> Result<Option<ShowStatementIn>, ParserError> {
21383        let clause = match self.parse_one_of_keywords(&[Keyword::FROM, Keyword::IN]) {
21384            Some(Keyword::FROM) => ShowStatementInClause::FROM,
21385            Some(Keyword::IN) => ShowStatementInClause::IN,
21386            None => return Ok(None),
21387            _ => return self.expected_ref("FROM or IN", self.peek_token_ref()),
21388        };
21389
21390        let (parent_type, parent_name) = match self.parse_one_of_keywords(&[
21391            Keyword::ACCOUNT,
21392            Keyword::DATABASE,
21393            Keyword::SCHEMA,
21394            Keyword::TABLE,
21395            Keyword::VIEW,
21396        ]) {
21397            // If we see these next keywords it means we don't have a parent name
21398            Some(Keyword::DATABASE)
21399                if self.peek_keywords(&[Keyword::STARTS, Keyword::WITH])
21400                    | self.peek_keyword(Keyword::LIMIT) =>
21401            {
21402                (Some(ShowStatementInParentType::Database), None)
21403            }
21404            Some(Keyword::SCHEMA)
21405                if self.peek_keywords(&[Keyword::STARTS, Keyword::WITH])
21406                    | self.peek_keyword(Keyword::LIMIT) =>
21407            {
21408                (Some(ShowStatementInParentType::Schema), None)
21409            }
21410            Some(parent_kw) => {
21411                // The parent name here is still optional, for example:
21412                // SHOW TABLES IN ACCOUNT, so parsing the object name
21413                // may fail because the statement ends.
21414                let parent_name = self.maybe_parse(|p| p.parse_object_name(false))?;
21415                match parent_kw {
21416                    Keyword::ACCOUNT => (Some(ShowStatementInParentType::Account), parent_name),
21417                    Keyword::DATABASE => (Some(ShowStatementInParentType::Database), parent_name),
21418                    Keyword::SCHEMA => (Some(ShowStatementInParentType::Schema), parent_name),
21419                    Keyword::TABLE => (Some(ShowStatementInParentType::Table), parent_name),
21420                    Keyword::VIEW => (Some(ShowStatementInParentType::View), parent_name),
21421                    _ => {
21422                        return self.expected_ref(
21423                            "one of ACCOUNT, DATABASE, SCHEMA, TABLE or VIEW",
21424                            self.peek_token_ref(),
21425                        )
21426                    }
21427                }
21428            }
21429            None => {
21430                // Parsing MySQL style FROM tbl_name FROM db_name
21431                // which is equivalent to FROM tbl_name.db_name
21432                let mut parent_name = self.parse_object_name(false)?;
21433                if self
21434                    .parse_one_of_keywords(&[Keyword::FROM, Keyword::IN])
21435                    .is_some()
21436                {
21437                    parent_name
21438                        .0
21439                        .insert(0, ObjectNamePart::Identifier(self.parse_identifier()?));
21440                }
21441                (None, Some(parent_name))
21442            }
21443        };
21444
21445        Ok(Some(ShowStatementIn {
21446            clause,
21447            parent_type,
21448            parent_name,
21449        }))
21450    }
21451
21452    fn maybe_parse_show_stmt_starts_with(&mut self) -> Result<Option<ValueWithSpan>, ParserError> {
21453        if self.parse_keywords(&[Keyword::STARTS, Keyword::WITH]) {
21454            Ok(Some(self.parse_value()?))
21455        } else {
21456            Ok(None)
21457        }
21458    }
21459
21460    fn maybe_parse_show_stmt_limit(&mut self) -> Result<Option<Expr>, ParserError> {
21461        if self.parse_keyword(Keyword::LIMIT) {
21462            Ok(self.parse_limit()?)
21463        } else {
21464            Ok(None)
21465        }
21466    }
21467
21468    fn maybe_parse_show_stmt_from(&mut self) -> Result<Option<ValueWithSpan>, ParserError> {
21469        if self.parse_keyword(Keyword::FROM) {
21470            Ok(Some(self.parse_value()?))
21471        } else {
21472            Ok(None)
21473        }
21474    }
21475
21476    pub(crate) fn in_column_definition_state(&self) -> bool {
21477        matches!(self.state, ColumnDefinition)
21478    }
21479
21480    /// Parses options provided in key-value format.
21481    ///
21482    /// * `parenthesized` - true if the options are enclosed in parenthesis
21483    /// * `end_words` - a list of keywords that any of them indicates the end of the options section
21484    pub(crate) fn parse_key_value_options(
21485        &mut self,
21486        parenthesized: bool,
21487        end_words: &[Keyword],
21488    ) -> Result<KeyValueOptions, ParserError> {
21489        let mut options: Vec<KeyValueOption> = Vec::new();
21490        let mut delimiter = KeyValueOptionsDelimiter::Space;
21491        if parenthesized {
21492            self.expect_token(&Token::LParen)?;
21493        }
21494        loop {
21495            match self.next_token().token {
21496                Token::RParen => {
21497                    if parenthesized {
21498                        break;
21499                    } else {
21500                        return self.expected_ref(" another option or EOF", self.peek_token_ref());
21501                    }
21502                }
21503                Token::EOF | Token::SemiColon => break,
21504                Token::Comma => {
21505                    delimiter = KeyValueOptionsDelimiter::Comma;
21506                    continue;
21507                }
21508                Token::Word(w) if !end_words.contains(&w.keyword) => {
21509                    options.push(self.parse_key_value_option(&w)?)
21510                }
21511                Token::Word(w) if end_words.contains(&w.keyword) => {
21512                    self.prev_token();
21513                    break;
21514                }
21515                _ => {
21516                    return self.expected_ref(
21517                        "another option, EOF, SemiColon, Comma or ')'",
21518                        self.peek_token_ref(),
21519                    )
21520                }
21521            };
21522        }
21523
21524        Ok(KeyValueOptions { delimiter, options })
21525    }
21526
21527    /// Parses a `KEY = VALUE` construct based on the specified key
21528    pub(crate) fn parse_key_value_option(
21529        &mut self,
21530        key: &Word,
21531    ) -> Result<KeyValueOption, ParserError> {
21532        self.expect_token(&Token::Eq)?;
21533        let peeked_token = self.peek_token();
21534        match peeked_token.token {
21535            Token::SingleQuotedString(_) => Ok(KeyValueOption {
21536                option_name: key.value.clone(),
21537                option_value: KeyValueOptionKind::Single(self.parse_value()?),
21538            }),
21539            Token::Word(word)
21540                if word.keyword == Keyword::TRUE || word.keyword == Keyword::FALSE =>
21541            {
21542                Ok(KeyValueOption {
21543                    option_name: key.value.clone(),
21544                    option_value: KeyValueOptionKind::Single(self.parse_value()?),
21545                })
21546            }
21547            Token::Number(..) => Ok(KeyValueOption {
21548                option_name: key.value.clone(),
21549                option_value: KeyValueOptionKind::Single(self.parse_value()?),
21550            }),
21551            Token::Word(word) => {
21552                self.next_token();
21553                Ok(KeyValueOption {
21554                    option_name: key.value.clone(),
21555                    option_value: KeyValueOptionKind::Single(
21556                        Value::Placeholder(word.value.clone()).with_span(peeked_token.span),
21557                    ),
21558                })
21559            }
21560            Token::LParen => {
21561                // Can be a list of values or a list of key value properties.
21562                // Try to parse a list of values and if that fails, try to parse
21563                // a list of key-value properties.
21564                match self.maybe_parse(|parser| {
21565                    parser.expect_token(&Token::LParen)?;
21566                    let values = parser.parse_comma_separated0(|p| p.parse_value(), Token::RParen);
21567                    parser.expect_token(&Token::RParen)?;
21568                    values
21569                })? {
21570                    Some(values) => Ok(KeyValueOption {
21571                        option_name: key.value.clone(),
21572                        option_value: KeyValueOptionKind::Multi(values),
21573                    }),
21574                    None => Ok(KeyValueOption {
21575                        option_name: key.value.clone(),
21576                        option_value: KeyValueOptionKind::KeyValueOptions(Box::new(
21577                            self.parse_key_value_options(true, &[])?,
21578                        )),
21579                    }),
21580                }
21581            }
21582            _ => self.expected_ref("expected option value", self.peek_token_ref()),
21583        }
21584    }
21585
21586    /// Parses a RESET statement
21587    fn parse_reset(&mut self) -> Result<ResetStatement, ParserError> {
21588        if self.parse_keyword(Keyword::ALL) {
21589            return Ok(ResetStatement { reset: Reset::ALL });
21590        }
21591
21592        let obj = self.parse_object_name(false)?;
21593        Ok(ResetStatement {
21594            reset: Reset::ConfigurationParameter(obj),
21595        })
21596    }
21597}
21598
21599fn maybe_prefixed_expr(expr: Expr, prefix: Option<Ident>) -> Expr {
21600    if let Some(prefix) = prefix {
21601        Expr::Prefixed {
21602            prefix,
21603            value: Box::new(expr),
21604        }
21605    } else {
21606        expr
21607    }
21608}
21609
21610impl Word {
21611    /// Convert a reference to this word into an [`Ident`] by cloning the value.
21612    ///
21613    /// Use this method when you need to keep the original `Word` around.
21614    /// If you can consume the `Word`, prefer [`into_ident`](Self::into_ident) instead
21615    /// to avoid cloning.
21616    pub fn to_ident(&self, span: Span) -> Ident {
21617        Ident {
21618            value: self.value.clone(),
21619            quote_style: self.quote_style,
21620            span,
21621        }
21622    }
21623
21624    /// Convert this word into an [`Ident`] identifier, consuming the `Word`.
21625    ///
21626    /// This avoids cloning the string value. If you need to keep the original
21627    /// `Word`, use [`to_ident`](Self::to_ident) instead.
21628    pub fn into_ident(self, span: Span) -> Ident {
21629        Ident {
21630            value: self.value,
21631            quote_style: self.quote_style,
21632            span,
21633        }
21634    }
21635}
21636
21637#[cfg(test)]
21638mod tests {
21639    use crate::test_utils::{all_dialects, TestedDialects};
21640
21641    use super::*;
21642
21643    #[test]
21644    fn test_prev_index() {
21645        let sql = "SELECT version";
21646        all_dialects().run_parser_method(sql, |parser| {
21647            assert_eq!(parser.peek_token(), Token::make_keyword("SELECT"));
21648            assert_eq!(parser.next_token(), Token::make_keyword("SELECT"));
21649            parser.prev_token();
21650            assert_eq!(parser.next_token(), Token::make_keyword("SELECT"));
21651            assert_eq!(parser.next_token(), Token::make_word("version", None));
21652            parser.prev_token();
21653            assert_eq!(parser.peek_token(), Token::make_word("version", None));
21654            assert_eq!(parser.next_token(), Token::make_word("version", None));
21655            assert_eq!(parser.peek_token(), Token::EOF);
21656            parser.prev_token();
21657            assert_eq!(parser.next_token(), Token::make_word("version", None));
21658            assert_eq!(parser.next_token(), Token::EOF);
21659            assert_eq!(parser.next_token(), Token::EOF);
21660            parser.prev_token();
21661        });
21662    }
21663
21664    #[test]
21665    fn test_peek_tokens() {
21666        all_dialects().run_parser_method("SELECT foo AS bar FROM baz", |parser| {
21667            assert!(matches!(
21668                parser.peek_tokens(),
21669                [Token::Word(Word {
21670                    keyword: Keyword::SELECT,
21671                    ..
21672                })]
21673            ));
21674
21675            assert!(matches!(
21676                parser.peek_tokens(),
21677                [
21678                    Token::Word(Word {
21679                        keyword: Keyword::SELECT,
21680                        ..
21681                    }),
21682                    Token::Word(_),
21683                    Token::Word(Word {
21684                        keyword: Keyword::AS,
21685                        ..
21686                    }),
21687                ]
21688            ));
21689
21690            for _ in 0..4 {
21691                parser.next_token();
21692            }
21693
21694            assert!(matches!(
21695                parser.peek_tokens(),
21696                [
21697                    Token::Word(Word {
21698                        keyword: Keyword::FROM,
21699                        ..
21700                    }),
21701                    Token::Word(_),
21702                    Token::EOF,
21703                    Token::EOF,
21704                ]
21705            ))
21706        })
21707    }
21708
21709    #[cfg(test)]
21710    mod test_parse_data_type {
21711        use crate::ast::{
21712            CharLengthUnits, CharacterLength, DataType, ExactNumberInfo, ObjectName, TimezoneInfo,
21713        };
21714        use crate::dialect::{AnsiDialect, GenericDialect, PostgreSqlDialect};
21715        use crate::test_utils::TestedDialects;
21716
21717        macro_rules! test_parse_data_type {
21718            ($dialect:expr, $input:expr, $expected_type:expr $(,)?) => {{
21719                $dialect.run_parser_method(&*$input, |parser| {
21720                    let data_type = parser.parse_data_type().unwrap();
21721                    assert_eq!($expected_type, data_type);
21722                    assert_eq!($input.to_string(), data_type.to_string());
21723                });
21724            }};
21725        }
21726
21727        #[test]
21728        fn test_ansii_character_string_types() {
21729            // Character string types: <https://jakewheat.github.io/sql-overview/sql-2016-foundation-grammar.html#character-string-type>
21730            let dialect =
21731                TestedDialects::new(vec![Box::new(GenericDialect {}), Box::new(AnsiDialect {})]);
21732
21733            test_parse_data_type!(dialect, "CHARACTER", DataType::Character(None));
21734
21735            test_parse_data_type!(
21736                dialect,
21737                "CHARACTER(20)",
21738                DataType::Character(Some(CharacterLength::IntegerLength {
21739                    length: 20,
21740                    unit: None
21741                }))
21742            );
21743
21744            test_parse_data_type!(
21745                dialect,
21746                "CHARACTER(20 CHARACTERS)",
21747                DataType::Character(Some(CharacterLength::IntegerLength {
21748                    length: 20,
21749                    unit: Some(CharLengthUnits::Characters)
21750                }))
21751            );
21752
21753            test_parse_data_type!(
21754                dialect,
21755                "CHARACTER(20 OCTETS)",
21756                DataType::Character(Some(CharacterLength::IntegerLength {
21757                    length: 20,
21758                    unit: Some(CharLengthUnits::Octets)
21759                }))
21760            );
21761
21762            test_parse_data_type!(dialect, "CHAR", DataType::Char(None));
21763
21764            test_parse_data_type!(
21765                dialect,
21766                "CHAR(20)",
21767                DataType::Char(Some(CharacterLength::IntegerLength {
21768                    length: 20,
21769                    unit: None
21770                }))
21771            );
21772
21773            test_parse_data_type!(
21774                dialect,
21775                "CHAR(20 CHARACTERS)",
21776                DataType::Char(Some(CharacterLength::IntegerLength {
21777                    length: 20,
21778                    unit: Some(CharLengthUnits::Characters)
21779                }))
21780            );
21781
21782            test_parse_data_type!(
21783                dialect,
21784                "CHAR(20 OCTETS)",
21785                DataType::Char(Some(CharacterLength::IntegerLength {
21786                    length: 20,
21787                    unit: Some(CharLengthUnits::Octets)
21788                }))
21789            );
21790
21791            test_parse_data_type!(
21792                dialect,
21793                "CHARACTER VARYING(20)",
21794                DataType::CharacterVarying(Some(CharacterLength::IntegerLength {
21795                    length: 20,
21796                    unit: None
21797                }))
21798            );
21799
21800            test_parse_data_type!(
21801                dialect,
21802                "CHARACTER VARYING(20 CHARACTERS)",
21803                DataType::CharacterVarying(Some(CharacterLength::IntegerLength {
21804                    length: 20,
21805                    unit: Some(CharLengthUnits::Characters)
21806                }))
21807            );
21808
21809            test_parse_data_type!(
21810                dialect,
21811                "CHARACTER VARYING(20 OCTETS)",
21812                DataType::CharacterVarying(Some(CharacterLength::IntegerLength {
21813                    length: 20,
21814                    unit: Some(CharLengthUnits::Octets)
21815                }))
21816            );
21817
21818            test_parse_data_type!(
21819                dialect,
21820                "CHAR VARYING(20)",
21821                DataType::CharVarying(Some(CharacterLength::IntegerLength {
21822                    length: 20,
21823                    unit: None
21824                }))
21825            );
21826
21827            test_parse_data_type!(
21828                dialect,
21829                "CHAR VARYING(20 CHARACTERS)",
21830                DataType::CharVarying(Some(CharacterLength::IntegerLength {
21831                    length: 20,
21832                    unit: Some(CharLengthUnits::Characters)
21833                }))
21834            );
21835
21836            test_parse_data_type!(
21837                dialect,
21838                "CHAR VARYING(20 OCTETS)",
21839                DataType::CharVarying(Some(CharacterLength::IntegerLength {
21840                    length: 20,
21841                    unit: Some(CharLengthUnits::Octets)
21842                }))
21843            );
21844
21845            test_parse_data_type!(
21846                dialect,
21847                "VARCHAR(20)",
21848                DataType::Varchar(Some(CharacterLength::IntegerLength {
21849                    length: 20,
21850                    unit: None
21851                }))
21852            );
21853        }
21854
21855        #[test]
21856        fn test_ansii_character_large_object_types() {
21857            // Character large object types: <https://jakewheat.github.io/sql-overview/sql-2016-foundation-grammar.html#character-large-object-length>
21858            let dialect =
21859                TestedDialects::new(vec![Box::new(GenericDialect {}), Box::new(AnsiDialect {})]);
21860
21861            test_parse_data_type!(
21862                dialect,
21863                "CHARACTER LARGE OBJECT",
21864                DataType::CharacterLargeObject(None)
21865            );
21866            test_parse_data_type!(
21867                dialect,
21868                "CHARACTER LARGE OBJECT(20)",
21869                DataType::CharacterLargeObject(Some(20))
21870            );
21871
21872            test_parse_data_type!(
21873                dialect,
21874                "CHAR LARGE OBJECT",
21875                DataType::CharLargeObject(None)
21876            );
21877            test_parse_data_type!(
21878                dialect,
21879                "CHAR LARGE OBJECT(20)",
21880                DataType::CharLargeObject(Some(20))
21881            );
21882
21883            test_parse_data_type!(dialect, "CLOB", DataType::Clob(None));
21884            test_parse_data_type!(dialect, "CLOB(20)", DataType::Clob(Some(20)));
21885        }
21886
21887        #[test]
21888        fn test_parse_custom_types() {
21889            let dialect =
21890                TestedDialects::new(vec![Box::new(GenericDialect {}), Box::new(AnsiDialect {})]);
21891
21892            test_parse_data_type!(
21893                dialect,
21894                "GEOMETRY",
21895                DataType::Custom(ObjectName::from(vec!["GEOMETRY".into()]), vec![])
21896            );
21897
21898            test_parse_data_type!(
21899                dialect,
21900                "GEOMETRY(POINT)",
21901                DataType::Custom(
21902                    ObjectName::from(vec!["GEOMETRY".into()]),
21903                    vec!["POINT".to_string()]
21904                )
21905            );
21906
21907            test_parse_data_type!(
21908                dialect,
21909                "GEOMETRY(POINT, 4326)",
21910                DataType::Custom(
21911                    ObjectName::from(vec!["GEOMETRY".into()]),
21912                    vec!["POINT".to_string(), "4326".to_string()]
21913                )
21914            );
21915        }
21916
21917        #[test]
21918        fn test_ansii_exact_numeric_types() {
21919            // Exact numeric types: <https://jakewheat.github.io/sql-overview/sql-2016-foundation-grammar.html#exact-numeric-type>
21920            let dialect = TestedDialects::new(vec![
21921                Box::new(GenericDialect {}),
21922                Box::new(AnsiDialect {}),
21923                Box::new(PostgreSqlDialect {}),
21924            ]);
21925
21926            test_parse_data_type!(dialect, "NUMERIC", DataType::Numeric(ExactNumberInfo::None));
21927
21928            test_parse_data_type!(
21929                dialect,
21930                "NUMERIC(2)",
21931                DataType::Numeric(ExactNumberInfo::Precision(2))
21932            );
21933
21934            test_parse_data_type!(
21935                dialect,
21936                "NUMERIC(2,10)",
21937                DataType::Numeric(ExactNumberInfo::PrecisionAndScale(2, 10))
21938            );
21939
21940            test_parse_data_type!(dialect, "DECIMAL", DataType::Decimal(ExactNumberInfo::None));
21941
21942            test_parse_data_type!(
21943                dialect,
21944                "DECIMAL(2)",
21945                DataType::Decimal(ExactNumberInfo::Precision(2))
21946            );
21947
21948            test_parse_data_type!(
21949                dialect,
21950                "DECIMAL(2,10)",
21951                DataType::Decimal(ExactNumberInfo::PrecisionAndScale(2, 10))
21952            );
21953
21954            test_parse_data_type!(dialect, "DEC", DataType::Dec(ExactNumberInfo::None));
21955
21956            test_parse_data_type!(
21957                dialect,
21958                "DEC(2)",
21959                DataType::Dec(ExactNumberInfo::Precision(2))
21960            );
21961
21962            test_parse_data_type!(
21963                dialect,
21964                "DEC(2,10)",
21965                DataType::Dec(ExactNumberInfo::PrecisionAndScale(2, 10))
21966            );
21967
21968            // Test negative scale values.
21969            test_parse_data_type!(
21970                dialect,
21971                "NUMERIC(10,-2)",
21972                DataType::Numeric(ExactNumberInfo::PrecisionAndScale(10, -2))
21973            );
21974
21975            test_parse_data_type!(
21976                dialect,
21977                "DECIMAL(1000,-10)",
21978                DataType::Decimal(ExactNumberInfo::PrecisionAndScale(1000, -10))
21979            );
21980
21981            test_parse_data_type!(
21982                dialect,
21983                "DEC(5,-1000)",
21984                DataType::Dec(ExactNumberInfo::PrecisionAndScale(5, -1000))
21985            );
21986
21987            test_parse_data_type!(
21988                dialect,
21989                "NUMERIC(10,-5)",
21990                DataType::Numeric(ExactNumberInfo::PrecisionAndScale(10, -5))
21991            );
21992
21993            test_parse_data_type!(
21994                dialect,
21995                "DECIMAL(20,-10)",
21996                DataType::Decimal(ExactNumberInfo::PrecisionAndScale(20, -10))
21997            );
21998
21999            test_parse_data_type!(
22000                dialect,
22001                "DEC(5,-2)",
22002                DataType::Dec(ExactNumberInfo::PrecisionAndScale(5, -2))
22003            );
22004
22005            dialect.run_parser_method("NUMERIC(10,+5)", |parser| {
22006                let data_type = parser.parse_data_type().unwrap();
22007                assert_eq!(
22008                    DataType::Numeric(ExactNumberInfo::PrecisionAndScale(10, 5)),
22009                    data_type
22010                );
22011                // Note: Explicit '+' sign is not preserved in output, which is correct
22012                assert_eq!("NUMERIC(10,5)", data_type.to_string());
22013            });
22014        }
22015
22016        #[test]
22017        fn test_ansii_date_type() {
22018            // Datetime types: <https://jakewheat.github.io/sql-overview/sql-2016-foundation-grammar.html#datetime-type>
22019            let dialect =
22020                TestedDialects::new(vec![Box::new(GenericDialect {}), Box::new(AnsiDialect {})]);
22021
22022            test_parse_data_type!(dialect, "DATE", DataType::Date);
22023
22024            test_parse_data_type!(dialect, "TIME", DataType::Time(None, TimezoneInfo::None));
22025
22026            test_parse_data_type!(
22027                dialect,
22028                "TIME(6)",
22029                DataType::Time(Some(6), TimezoneInfo::None)
22030            );
22031
22032            test_parse_data_type!(
22033                dialect,
22034                "TIME WITH TIME ZONE",
22035                DataType::Time(None, TimezoneInfo::WithTimeZone)
22036            );
22037
22038            test_parse_data_type!(
22039                dialect,
22040                "TIME(6) WITH TIME ZONE",
22041                DataType::Time(Some(6), TimezoneInfo::WithTimeZone)
22042            );
22043
22044            test_parse_data_type!(
22045                dialect,
22046                "TIME WITHOUT TIME ZONE",
22047                DataType::Time(None, TimezoneInfo::WithoutTimeZone)
22048            );
22049
22050            test_parse_data_type!(
22051                dialect,
22052                "TIME(6) WITHOUT TIME ZONE",
22053                DataType::Time(Some(6), TimezoneInfo::WithoutTimeZone)
22054            );
22055
22056            test_parse_data_type!(
22057                dialect,
22058                "TIMESTAMP",
22059                DataType::Timestamp(None, TimezoneInfo::None)
22060            );
22061
22062            test_parse_data_type!(
22063                dialect,
22064                "TIMESTAMP(22)",
22065                DataType::Timestamp(Some(22), TimezoneInfo::None)
22066            );
22067
22068            test_parse_data_type!(
22069                dialect,
22070                "TIMESTAMP(22) WITH TIME ZONE",
22071                DataType::Timestamp(Some(22), TimezoneInfo::WithTimeZone)
22072            );
22073
22074            test_parse_data_type!(
22075                dialect,
22076                "TIMESTAMP(33) WITHOUT TIME ZONE",
22077                DataType::Timestamp(Some(33), TimezoneInfo::WithoutTimeZone)
22078            );
22079        }
22080    }
22081
22082    #[test]
22083    fn test_parse_schema_name() {
22084        // The expected name should be identical as the input name, that's why I don't receive both
22085        macro_rules! test_parse_schema_name {
22086            ($input:expr, $expected_name:expr $(,)?) => {{
22087                all_dialects().run_parser_method(&*$input, |parser| {
22088                    let schema_name = parser.parse_schema_name().unwrap();
22089                    // Validate that the structure is the same as expected
22090                    assert_eq!(schema_name, $expected_name);
22091                    // Validate that the input and the expected structure serialization are the same
22092                    assert_eq!(schema_name.to_string(), $input.to_string());
22093                });
22094            }};
22095        }
22096
22097        let dummy_name = ObjectName::from(vec![Ident::new("dummy_name")]);
22098        let dummy_authorization = Ident::new("dummy_authorization");
22099
22100        test_parse_schema_name!(
22101            format!("{dummy_name}"),
22102            SchemaName::Simple(dummy_name.clone())
22103        );
22104
22105        test_parse_schema_name!(
22106            format!("AUTHORIZATION {dummy_authorization}"),
22107            SchemaName::UnnamedAuthorization(dummy_authorization.clone()),
22108        );
22109        test_parse_schema_name!(
22110            format!("{dummy_name} AUTHORIZATION {dummy_authorization}"),
22111            SchemaName::NamedAuthorization(dummy_name.clone(), dummy_authorization.clone()),
22112        );
22113    }
22114
22115    #[test]
22116    fn mysql_parse_index_table_constraint() {
22117        macro_rules! test_parse_table_constraint {
22118            ($dialect:expr, $input:expr, $expected:expr $(,)?) => {{
22119                $dialect.run_parser_method(&*$input, |parser| {
22120                    let constraint = parser.parse_optional_table_constraint().unwrap().unwrap();
22121                    // Validate that the structure is the same as expected
22122                    assert_eq!(constraint, $expected);
22123                    // Validate that the input and the expected structure serialization are the same
22124                    assert_eq!(constraint.to_string(), $input.to_string());
22125                });
22126            }};
22127        }
22128
22129        fn mk_expected_col(name: &str) -> IndexColumn {
22130            IndexColumn {
22131                column: OrderByExpr {
22132                    expr: Expr::Identifier(name.into()),
22133                    options: OrderByOptions {
22134                        asc: None,
22135                        nulls_first: None,
22136                    },
22137                    with_fill: None,
22138                },
22139                operator_class: None,
22140            }
22141        }
22142
22143        let dialect =
22144            TestedDialects::new(vec![Box::new(GenericDialect {}), Box::new(MySqlDialect {})]);
22145
22146        test_parse_table_constraint!(
22147            dialect,
22148            "INDEX (c1)",
22149            IndexConstraint {
22150                display_as_key: false,
22151                name: None,
22152                index_type: None,
22153                columns: vec![mk_expected_col("c1")],
22154                index_options: vec![],
22155            }
22156            .into()
22157        );
22158
22159        test_parse_table_constraint!(
22160            dialect,
22161            "KEY (c1)",
22162            IndexConstraint {
22163                display_as_key: true,
22164                name: None,
22165                index_type: None,
22166                columns: vec![mk_expected_col("c1")],
22167                index_options: vec![],
22168            }
22169            .into()
22170        );
22171
22172        test_parse_table_constraint!(
22173            dialect,
22174            "INDEX 'index' (c1, c2)",
22175            TableConstraint::Index(IndexConstraint {
22176                display_as_key: false,
22177                name: Some(Ident::with_quote('\'', "index")),
22178                index_type: None,
22179                columns: vec![mk_expected_col("c1"), mk_expected_col("c2")],
22180                index_options: vec![],
22181            })
22182        );
22183
22184        test_parse_table_constraint!(
22185            dialect,
22186            "INDEX USING BTREE (c1)",
22187            IndexConstraint {
22188                display_as_key: false,
22189                name: None,
22190                index_type: Some(IndexType::BTree),
22191                columns: vec![mk_expected_col("c1")],
22192                index_options: vec![],
22193            }
22194            .into()
22195        );
22196
22197        test_parse_table_constraint!(
22198            dialect,
22199            "INDEX USING HASH (c1)",
22200            IndexConstraint {
22201                display_as_key: false,
22202                name: None,
22203                index_type: Some(IndexType::Hash),
22204                columns: vec![mk_expected_col("c1")],
22205                index_options: vec![],
22206            }
22207            .into()
22208        );
22209
22210        test_parse_table_constraint!(
22211            dialect,
22212            "INDEX idx_name USING BTREE (c1)",
22213            IndexConstraint {
22214                display_as_key: false,
22215                name: Some(Ident::new("idx_name")),
22216                index_type: Some(IndexType::BTree),
22217                columns: vec![mk_expected_col("c1")],
22218                index_options: vec![],
22219            }
22220            .into()
22221        );
22222
22223        test_parse_table_constraint!(
22224            dialect,
22225            "INDEX idx_name USING HASH (c1)",
22226            IndexConstraint {
22227                display_as_key: false,
22228                name: Some(Ident::new("idx_name")),
22229                index_type: Some(IndexType::Hash),
22230                columns: vec![mk_expected_col("c1")],
22231                index_options: vec![],
22232            }
22233            .into()
22234        );
22235    }
22236
22237    #[test]
22238    fn test_tokenizer_error_loc() {
22239        let sql = "foo '";
22240        let ast = Parser::parse_sql(&GenericDialect, sql);
22241        assert_eq!(
22242            ast,
22243            Err(ParserError::TokenizerError(
22244                "Unterminated string literal at Line: 1, Column: 5".to_string()
22245            ))
22246        );
22247    }
22248
22249    #[test]
22250    fn test_parser_error_loc() {
22251        let sql = "SELECT this is a syntax error";
22252        let ast = Parser::parse_sql(&GenericDialect, sql);
22253        assert_eq!(
22254            ast,
22255            Err(ParserError::ParserError(
22256                "Expected: [NOT] NULL | TRUE | FALSE | DISTINCT | [form] NORMALIZED FROM after IS, found: a at Line: 1, Column: 16"
22257                    .to_string()
22258            ))
22259        );
22260    }
22261
22262    #[test]
22263    fn test_nested_explain_error() {
22264        let sql = "EXPLAIN EXPLAIN SELECT 1";
22265        let ast = Parser::parse_sql(&GenericDialect, sql);
22266        assert_eq!(
22267            ast,
22268            Err(ParserError::ParserError(
22269                "Explain must be root of the plan".to_string()
22270            ))
22271        );
22272    }
22273
22274    #[test]
22275    fn test_parse_multipart_identifier_positive() {
22276        let dialect = TestedDialects::new(vec![Box::new(GenericDialect {})]);
22277
22278        // parse multipart with quotes
22279        let expected = vec![
22280            Ident {
22281                value: "CATALOG".to_string(),
22282                quote_style: None,
22283                span: Span::empty(),
22284            },
22285            Ident {
22286                value: "F(o)o. \"bar".to_string(),
22287                quote_style: Some('"'),
22288                span: Span::empty(),
22289            },
22290            Ident {
22291                value: "table".to_string(),
22292                quote_style: None,
22293                span: Span::empty(),
22294            },
22295        ];
22296        dialect.run_parser_method(r#"CATALOG."F(o)o. ""bar".table"#, |parser| {
22297            let actual = parser.parse_multipart_identifier().unwrap();
22298            assert_eq!(expected, actual);
22299        });
22300
22301        // allow whitespace between ident parts
22302        let expected = vec![
22303            Ident {
22304                value: "CATALOG".to_string(),
22305                quote_style: None,
22306                span: Span::empty(),
22307            },
22308            Ident {
22309                value: "table".to_string(),
22310                quote_style: None,
22311                span: Span::empty(),
22312            },
22313        ];
22314        dialect.run_parser_method("CATALOG . table", |parser| {
22315            let actual = parser.parse_multipart_identifier().unwrap();
22316            assert_eq!(expected, actual);
22317        });
22318    }
22319
22320    #[test]
22321    fn test_parse_multipart_identifier_negative() {
22322        macro_rules! test_parse_multipart_identifier_error {
22323            ($input:expr, $expected_err:expr $(,)?) => {{
22324                all_dialects().run_parser_method(&*$input, |parser| {
22325                    let actual_err = parser.parse_multipart_identifier().unwrap_err();
22326                    assert_eq!(actual_err.to_string(), $expected_err);
22327                });
22328            }};
22329        }
22330
22331        test_parse_multipart_identifier_error!(
22332            "",
22333            "sql parser error: Empty input when parsing identifier",
22334        );
22335
22336        test_parse_multipart_identifier_error!(
22337            "*schema.table",
22338            "sql parser error: Unexpected token in identifier: *",
22339        );
22340
22341        test_parse_multipart_identifier_error!(
22342            "schema.table*",
22343            "sql parser error: Unexpected token in identifier: *",
22344        );
22345
22346        test_parse_multipart_identifier_error!(
22347            "schema.table.",
22348            "sql parser error: Trailing period in identifier",
22349        );
22350
22351        test_parse_multipart_identifier_error!(
22352            "schema.*",
22353            "sql parser error: Unexpected token following period in identifier: *",
22354        );
22355    }
22356
22357    #[test]
22358    fn test_mysql_partition_selection() {
22359        let sql = "SELECT * FROM employees PARTITION (p0, p2)";
22360        let expected = vec!["p0", "p2"];
22361
22362        let ast: Vec<Statement> = Parser::parse_sql(&MySqlDialect {}, sql).unwrap();
22363        assert_eq!(ast.len(), 1);
22364        if let Statement::Query(v) = &ast[0] {
22365            if let SetExpr::Select(select) = &*v.body {
22366                assert_eq!(select.from.len(), 1);
22367                let from: &TableWithJoins = &select.from[0];
22368                let table_factor = &from.relation;
22369                if let TableFactor::Table { partitions, .. } = table_factor {
22370                    let actual: Vec<&str> = partitions
22371                        .iter()
22372                        .map(|ident| ident.value.as_str())
22373                        .collect();
22374                    assert_eq!(expected, actual);
22375                }
22376            }
22377        } else {
22378            panic!("fail to parse mysql partition selection");
22379        }
22380    }
22381
22382    #[test]
22383    fn test_replace_into_placeholders() {
22384        let sql = "REPLACE INTO t (a) VALUES (&a)";
22385
22386        assert!(Parser::parse_sql(&GenericDialect {}, sql).is_err());
22387    }
22388
22389    #[test]
22390    fn test_replace_into_set_placeholder() {
22391        let sql = "REPLACE INTO t SET ?";
22392
22393        assert!(Parser::parse_sql(&GenericDialect {}, sql).is_err());
22394    }
22395
22396    #[test]
22397    fn test_replace_incomplete() {
22398        let sql = r#"REPLACE"#;
22399
22400        assert!(Parser::parse_sql(&MySqlDialect {}, sql).is_err());
22401    }
22402
22403    #[test]
22404    fn test_placeholder_invalid_whitespace() {
22405        for w in ["  ", "/*invalid*/"] {
22406            let sql = format!("\nSELECT\n  :{w}fooBar");
22407            assert!(Parser::parse_sql(&GenericDialect, &sql).is_err());
22408        }
22409    }
22410}