[clickhouse] Add support for Engine parameters parsing

Author: lustefaniak

src/ast/helpers/stmt_create_table.rs

@@ -8,8 +8,8 @@ use serde::{Deserialize, Serialize};
 use sqlparser_derive::{Visit, VisitMut};
 
 use crate::ast::{
-    ColumnDef, FileFormat, HiveDistributionStyle, HiveFormat, Ident, ObjectName, OnCommit, Query,
-    SqlOption, Statement, TableConstraint,
+    ColumnDef, EngineSpec, FileFormat, HiveDistributionStyle, HiveFormat, Ident, ObjectName,
+    OnCommit, Query, SqlOption, Statement, TableConstraint,
 };
 use crate::parser::ParserError;
 
@@ -64,7 +64,7 @@ pub struct CreateTableBuilder {
     pub without_rowid: bool,
     pub like: Option<ObjectName>,
     pub clone: Option<ObjectName>,
-    pub engine: Option<String>,
+    pub engine: Option<EngineSpec>,
     pub comment: Option<String>,
     pub auto_increment_offset: Option<u32>,
     pub default_charset: Option<String>,
@@ -196,7 +196,7 @@ impl CreateTableBuilder {
         self
     }
 
-    pub fn engine(mut self, engine: Option<String>) -> Self {
+    pub fn engine(mut self, engine: Option<EngineSpec>) -> Self {
         self.engine = engine;
         self
     }

src/ast/mod.rs

@@ -174,6 +174,24 @@ impl fmt::Display for ObjectName {
     }
 }
 
+#[derive(Debug, Clone, PartialEq, PartialOrd, Eq, Ord, Hash)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "visitor", derive(Visit, VisitMut))]
+pub struct EngineSpec {
+    pub name: String,
+    pub options: Option<Vec<Expr>>,
+}
+
+impl fmt::Display for EngineSpec {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        if let Some(opts) = &self.options {
+            write!(f, "{}({})", self.name, display_comma_separated(&opts))
+        } else {
+            write!(f, "{}", self.name)
+        }
+    }
+}
+
 /// Represents an Array Expression, either
 /// `ARRAY[..]`, or `[..]`
 #[derive(Debug, Clone, PartialEq, PartialOrd, Eq, Ord, Hash)]
@@ -1373,7 +1391,7 @@ pub enum Statement {
         without_rowid: bool,
         like: Option<ObjectName>,
         clone: Option<ObjectName>,
-        engine: Option<String>,
+        engine: Option<EngineSpec>,
         comment: Option<String>,
         auto_increment_offset: Option<u32>,
         default_charset: Option<String>,

src/parser/mod.rs

@@ -3669,10 +3669,25 @@ impl<'a> Parser<'a> {
         let engine = if self.parse_keyword(Keyword::ENGINE) {
             self.expect_token(&Token::Eq)?;
             let next_token = self.next_token();
-            match next_token.token {
-                Token::Word(w) => Some(w.value),
+            let engine_name = match next_token.token {
+                Token::Word(w) => w.value,
                 _ => self.expected("identifier", next_token)?,
-            }
+            };
+            let engine_options = if self.consume_token(&Token::LParen) {
+                let columns = if self.peek_token() != Token::RParen {
+                    self.parse_comma_separated(|p| p.parse_expr())?
+                } else {
+                    vec![]
+                };
+                self.expect_token(&Token::RParen)?;
+                Some(columns)
+            } else {
+                None
+            };
+            Some(EngineSpec {
+                name: engine_name,
+                options: engine_options,
+            })
         } else {
             None
         };

tests/sqlparser_clickhouse.rs

@@ -344,6 +344,9 @@ fn parse_create_table() {
     clickhouse().verified_stmt(
         r#"CREATE TABLE "x" ("a" Nullable(DateTime64(8))) ENGINE=MergeTree ORDER BY ("x") AS SELECT * FROM "t" WHERE true"#,
     );
+    clickhouse().verified_stmt(
+        r#"CREATE TABLE default.runs_buffer (`workspace` LowCardinality(String), `id` String, `assets` Array(String), `asset_types` Array(Int32), `target` Array(String), `target_type` Array(Int32), `extra_references` Array(String) DEFAULT [], `extra_reference_types` Array(Int32) DEFAULT [], `run_type` Int32, `run_status` Int32, `message` String, `created_at` DateTime64(8,'UTC'), `started_at` DateTime64(8,'UTC'), `finished_at` DateTime64(8,'UTC'), `meta` String, `exclude_status_update` Bool, `ingested_at` DateTime64(8,'UTC'), `parent_ids` Array(String), `skipped` Bool DEFAULT false) ENGINE=Buffer('default', 'runs', 4, 2, 5, 10000, 1000000, 2500000, 10000000)"#,
+    );
 }
 
 #[test]

tests/sqlparser_mysql.rs

@@ -443,7 +443,7 @@ fn parse_create_table_engine_default_charset() {
                 },],
                 columns
             );
-            assert_eq!(engine, Some("InnoDB".to_string()));
+            assert_eq!(engine.unwrap().name, "InnoDB".to_string());
             assert_eq!(default_charset, Some("utf8mb3".to_string()));
         }
         _ => unreachable!(),