Merge branch 'QA'

Signed-off-by: William Desportes <williamdes@wdes.fr>

Author: williamdes

CHANGELOG.md

@@ -13,6 +13,7 @@
 * Fix PHP notice "Undefined index: name in src/Components/Key.php#206" for table keys using expressions (#347)
 * Added support for MySQL 8.0 table structure KEY expressions (#347)
 * Added support for KEY order (ASC/DESC) (#296)
+* Added missing KEY options for MySQL and MariaDB (#348)
 
 ## [5.4.2] - 2021-02-05
 
@@ -87,6 +88,7 @@
 - Fix PHP notice "Undefined index: name in src/Components/Key.php#206" for table keys using functions (#347)
 - Fix MySQL 8.0 table structure KEY expression not recognized (#347)
 - Fix KEY order (ASC/DESC) not part of the KEY definition (#296)
+- Fix missing KEY options for MySQL and MariaDB (#348)
 
 ## [4.7.2] - 2021-02-05
 

src/Components/Key.php

@@ -31,7 +31,7 @@ class Key extends Component
     public static $KEY_OPTIONS = [
         'KEY_BLOCK_SIZE' => [
             1,
-            'var',
+            'var=',
         ],
         'USING' => [
             2,
@@ -45,6 +45,25 @@ class Key extends Component
             4,
             'var',
         ],
+        // MariaDB options
+        'CLUSTERING' => [
+            4,
+            'var=',
+        ],
+        'ENGINE_ATTRIBUTE' => [
+            5,
+            'var=',
+        ],
+        'SECONDARY_ENGINE_ATTRIBUTE' => [
+            5,
+            'var=',
+        ],
+        // MariaDB & MySQL options
+        'VISIBLE' => 6,
+        'INVISIBLE' => 6,
+        // MariaDB options
+        'IGNORED' => 10,
+        'NOT IGNORED' => 10,
     ];
 
     /**

tests/Components/KeyTest.php

@@ -142,6 +142,60 @@ public function testParseKeyWithLengthWithOptions(): void
         );
     }
 
+    public function testParseKeyWithLengthWithAllOptions(): void
+    {
+        $component = Key::parse(
+            new Parser(),
+            $this->getTokensList(
+                // This is not a vary plausible example but it runs
+                // Only ENGINE_ATTRIBUTE gives a not supported error but is still a valid syntax
+                'KEY `alias_type_idx` (`alias_type`(10))'
+                . ' COMMENT \'my comment\' VISIBLE KEY_BLOCK_SIZE=1'
+                . ' INVISIBLE ENGINE_ATTRIBUTE \'foo\' SECONDARY_ENGINE_ATTRIBUTE=\'bar\' USING BTREE,'
+            )
+        );
+        $this->assertEquals('KEY', $component->type);
+        $this->assertEquals('alias_type_idx', $component->name);
+        $this->assertEquals(new OptionsArray(
+            [
+                1 => [
+                    'name' => 'KEY_BLOCK_SIZE',
+                    'equals' => true,
+                    'expr' => '1',
+                    'value' => '1',
+                ],
+                2 => [
+                    'name' => 'USING',
+                    'equals' => false,
+                    'expr' => 'BTREE',
+                    'value' => 'BTREE',
+                ],
+                4 => [
+                    'name' => 'COMMENT',
+                    'equals' => false,
+                    'expr' => '\'my comment\'',
+                    'value' => 'my comment',
+                ],
+                5 => [
+                    'name' => 'ENGINE_ATTRIBUTE',
+                    'equals' => true,
+                    'expr' => '\'foo\'',
+                    'value' => 'foo',
+                ],
+                6 => 'VISIBLE',
+                12 => 'INVISIBLE',
+                13 => [
+                    'name' => 'SECONDARY_ENGINE_ATTRIBUTE',
+                    'equals' => true,
+                    'expr' => '\'bar\'',
+                    'value' => 'bar',
+                ],
+            ]
+        ), $component->options);
+        $this->assertNull($component->expr);
+        $this->assertSame([['name' => 'alias_type', 'length' => 10]], $component->columns);
+    }
+
     public function testParseKeyExpressionWithoutOptions(): void
     {
         $component = Key::parse(

tests/Parser/CreateStatementTest.php

@@ -49,6 +49,7 @@ public function createProvider(): array
             ['parser/parseCreateTableLike'],
             ['parser/parseCreateTableSpatial'],
             ['parser/parseCreateTableTimestampWithPrecision'],
+            ['parser/parseCreateTableWithInvisibleKey'],
             ['parser/parseCreateTrigger'],
             ['parser/parseCreateUser'],
             ['parser/parseCreateView'],

tests/data/parser/parseCreateTableWithInvisibleKey.in

@@ -0,0 +1,12 @@
+CREATE TABLE `animes_comments` (
+  `anime_comment_id` bigint unsigned NOT NULL AUTO_INCREMENT,
+  `anime_id` bigint unsigned NOT NULL,
+  `user_id` bigint unsigned NOT NULL,
+  `comment_text` varchar(500) COLLATE utf8mb4_general_ci DEFAULT NULL,
+  `comment_at` datetime DEFAULT NULL,
+  PRIMARY KEY (`anime_comment_id`),
+  KEY `animes_comments_animes_fk` (`anime_id`) invisible,
+  KEY `animes_comments_users_fk` (`user_id`),
+  KEY `comment_at_idx` (`comment_at`) ,
+  CONSTRAINT `animes_comments_animes_fk` FOREIGN KEY (`anime_id`) REFERENCES `animes` (`anime_id`) ON DELETE CASCADE ON UPDATE RESTRICT,
+  CONSTRAINT `animes_comments_users_fk` FOREIGN KEY (`user_id`) REFERENCES `users` (`user_id`) ON DELETE CASCADE ON UPDATE RESTRICT)