Support MySQL index options in CREATE TABLE and ALTER TABLE

Author: mvzink

src/ast/ddl.rs

@@ -1125,6 +1125,8 @@ pub enum TableConstraint {
         index_type: Option<IndexType>,
         /// Referred column identifier list.
         columns: Vec<IndexColumn>,
+        /// Optional index options such as `USING`; see [`IndexOption`].
+        index_options: Vec<IndexOption>,
     },
     /// MySQLs [fulltext][1] definition. Since the [`SPATIAL`][2] definition is exactly the same,
     /// and MySQL displays both the same way, it is part of this definition as well.
@@ -1253,6 +1255,7 @@ impl fmt::Display for TableConstraint {
                 name,
                 index_type,
                 columns,
+                index_options,
             } => {
                 write!(f, "{}", if *display_as_key { "KEY" } else { "INDEX" })?;
                 if let Some(name) = name {
@@ -1262,7 +1265,9 @@ impl fmt::Display for TableConstraint {
                     write!(f, " USING {index_type}")?;
                 }
                 write!(f, " ({})", display_comma_separated(columns))?;
-
+                if !index_options.is_empty() {
+                    write!(f, " {}", display_comma_separated(index_options))?;
+                }
                 Ok(())
             }
             Self::FulltextOrSpatial {
@@ -1377,17 +1382,20 @@ impl fmt::Display for IndexType {
     }
 }
 
-/// MySQLs index option.
-///
-/// This structure used here [`MySQL` CREATE TABLE][1], [`MySQL` CREATE INDEX][2].
+/// MySQL index option, used in [`CREATE TABLE`], [`CREATE INDEX`], and [`ALTER TABLE`].
 ///
-/// [1]: https://dev.mysql.com/doc/refman/8.3/en/create-table.html
-/// [2]: https://dev.mysql.com/doc/refman/8.3/en/create-index.html
+/// [`CREATE TABLE`]: https://dev.mysql.com/doc/refman/8.4/en/create-table.html
+/// [`CREATE INDEX`]: https://dev.mysql.com/doc/refman/8.4/en/create-index.html
+/// [`ALTER TABLE`]: https://dev.mysql.com/doc/refman/8.4/en/alter-table.html
 #[derive(Debug, Clone, PartialEq, PartialOrd, Eq, Ord, Hash)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[cfg_attr(feature = "visitor", derive(Visit, VisitMut))]
 pub enum IndexOption {
+    /// `USING { BTREE | HASH }`: Index type to use for the index.
+    ///
+    /// Note that we permissively parse non-MySQL index types, like `GIN`.
     Using(IndexType),
+    /// `COMMENT 'string'`: Specifies a comment for the index.
     Comment(String),
 }
 

src/ast/spans.rs

@@ -713,6 +713,7 @@ impl Spanned for TableConstraint {
                 name,
                 index_type: _,
                 columns,
+                index_options: _,
             } => union_spans(
                 name.iter()
                     .map(|i| i.span)

src/parser/mod.rs

@@ -8409,12 +8409,14 @@ impl<'a> Parser<'a> {
 
                 let index_type = self.parse_optional_using_then_index_type()?;
                 let columns = self.parse_parenthesized_index_column_list()?;
+                let index_options = self.parse_index_options()?;
 
                 Ok(Some(TableConstraint::Index {
                     display_as_key,
                     name,
                     index_type,
                     columns,
+                    index_options,
                 }))
             }
             Token::Word(w)
@@ -17477,6 +17479,7 @@ mod tests {
                 name: None,
                 index_type: None,
                 columns: vec![mk_expected_col("c1")],
+                index_options: vec![],
             }
         );
 
@@ -17488,6 +17491,7 @@ mod tests {
                 name: None,
                 index_type: None,
                 columns: vec![mk_expected_col("c1")],
+                index_options: vec![],
             }
         );
 
@@ -17499,6 +17503,7 @@ mod tests {
                 name: Some(Ident::with_quote('\'', "index")),
                 index_type: None,
                 columns: vec![mk_expected_col("c1"), mk_expected_col("c2")],
+                index_options: vec![],
             }
         );
 
@@ -17510,6 +17515,7 @@ mod tests {
                 name: None,
                 index_type: Some(IndexType::BTree),
                 columns: vec![mk_expected_col("c1")],
+                index_options: vec![],
             }
         );
 
@@ -17521,6 +17527,7 @@ mod tests {
                 name: None,
                 index_type: Some(IndexType::Hash),
                 columns: vec![mk_expected_col("c1")],
+                index_options: vec![],
             }
         );
 
@@ -17532,6 +17539,7 @@ mod tests {
                 name: Some(Ident::new("idx_name")),
                 index_type: Some(IndexType::BTree),
                 columns: vec![mk_expected_col("c1")],
+                index_options: vec![],
             }
         );
 
@@ -17543,6 +17551,7 @@ mod tests {
                 name: Some(Ident::new("idx_name")),
                 index_type: Some(IndexType::Hash),
                 columns: vec![mk_expected_col("c1")],
+                index_options: vec![],
             }
         );
     }

tests/sqlparser_mysql.rs

@@ -4221,9 +4221,8 @@ fn test_ddl_with_index_using() {
         format!("CREATE TABLE foo (name VARCHAR(255), age INT, KEY idx_name {using} {columns})"),
         format!("ALTER TABLE foo ADD KEY idx_name {using} {columns}"),
         format!("CREATE INDEX idx_name ON test{columns} {using}"),
-        // TODO: Add index options to `TableConstraint::Index`
-        // format!("CREATE TABLE foo (name VARCHAR(255), age INT, KEY idx_name{columns} {using})"),
-        // format!("ALTER TABLE foo ADD KEY idx_name{columns} {using}"),
+        format!("CREATE TABLE foo (name VARCHAR(255), age INT, KEY idx_name {columns} {using})"),
+        format!("ALTER TABLE foo ADD KEY idx_name {columns} {using}"),
     ] {
         mysql_and_generic().verified_stmt(&sql);
     }