Do not ignore foreign keys DDL on non-InnoDB MySQL

Author: morozov

UPGRADE.md

@@ -8,6 +8,11 @@ awareness about deprecated code.
 
 # Upgrade to 4.0
 
+## BC BREAK: foreign key DDL is generated on MySQL regardless of the storage engine.
+
+The DBAL generates DDL for foreign keys regardless of the MySQL storage engines used by the table
+that owns the foreign key constraint.
+
 ## BC BREAK: removed `AbstractPlatform` methods exposing quote characters.
 
 The `AbstractPlatform::getStringLiteralQuoteCharacter()` and `::getIdentifierQuoteCharacter()` methods

src/Platforms/AbstractMySQLPlatform.php

@@ -13,7 +13,6 @@
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Schema\TableDiff;
 use Doctrine\DBAL\TransactionIsolationLevel;
-use Doctrine\Deprecations\Deprecation;
 
 use function array_merge;
 use function array_unique;
@@ -24,7 +23,6 @@
 use function is_numeric;
 use function sprintf;
 use function str_replace;
-use function strcasecmp;
 use function strtoupper;
 use function trim;
 
@@ -211,38 +209,6 @@ public function getListTablesSQL(): string
         return "SHOW FULL TABLES WHERE Table_type = 'BASE TABLE'";
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function getCreateTablesSQL(array $tables): array
-    {
-        $sql = [];
-
-        foreach ($tables as $table) {
-            $sql = array_merge($sql, $this->getCreateTableWithoutForeignKeysSQL($table));
-        }
-
-        foreach ($tables as $table) {
-            if (! $table->hasOption('engine') || $this->engineSupportsForeignKeys($table->getOption('engine'))) {
-                foreach ($table->getForeignKeys() as $foreignKey) {
-                    $sql[] = $this->getCreateForeignKeySQL(
-                        $foreignKey,
-                        $table->getQuotedName($this)
-                    );
-                }
-            } elseif (count($table->getForeignKeys()) > 0) {
-                Deprecation::trigger(
-                    'doctrine/dbal',
-                    'https://github.com/doctrine/dbal/pull/5414',
-                    'Relying on the DBAL not generating DDL for foreign keys on MySQL engines'
-                    . ' other than InnoDB is deprecated. Define foreign key constraints only if they are necessary.'
-                );
-            }
-        }
-
-        return $sql;
-    }
-
     /**
      * {@inheritDoc}
      */
@@ -291,17 +257,8 @@ protected function _getCreateTableSQL(string $name, array $columns, array $optio
 
         // Propagate foreign key constraints only for InnoDB.
         if (isset($options['foreignKeys'])) {
-            if (! isset($options['engine']) || $this->engineSupportsForeignKeys($options['engine'])) {
-                foreach ($options['foreignKeys'] as $definition) {
-                    $sql[] = $this->getCreateForeignKeySQL($definition, $name);
-                }
-            } elseif (count($options['foreignKeys']) > 0) {
-                Deprecation::trigger(
-                    'doctrine/dbal',
-                    'https://github.com/doctrine/dbal/pull/5414',
-                    'Relying on the DBAL not generating DDL for foreign keys on MySQL engines'
-                    . ' other than InnoDB is deprecated. Define foreign key constraints only if they are necessary.'
-                );
+            foreach ($options['foreignKeys'] as $definition) {
+                $sql[] = $this->getCreateForeignKeySQL($definition, $name);
             }
         }
 
@@ -351,11 +308,6 @@ private function buildTableOptions(array $options): string
         return implode(' ', $tableOptions);
     }
 
-    private function engineSupportsForeignKeys(string $engine): bool
-    {
-        return strcasecmp(trim($engine), 'InnoDB') === 0;
-    }
-
     /**
      * {@inheritDoc}
      */

tests/Platforms/AbstractMySQLPlatformTestCase.php

@@ -8,7 +8,6 @@
 use Doctrine\DBAL\Platforms\AbstractMySQLPlatform;
 use Doctrine\DBAL\Platforms\MySQL;
 use Doctrine\DBAL\Schema\Comparator;
-use Doctrine\DBAL\Schema\ForeignKeyConstraint;
 use Doctrine\DBAL\Schema\Index;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Schema\TableDiff;
@@ -539,79 +538,6 @@ public function testGetVariableLengthBinaryTypeDeclarationSQLNoLength(): void
         parent::testGetVariableLengthBinaryTypeDeclarationSQLNoLength();
     }
 
-    public function testDoesNotPropagateForeignKeyCreationForNonSupportingEngines(): void
-    {
-        $table = new Table('foreign_table');
-        $table->addColumn('id', 'integer');
-        $table->addColumn('fk_id', 'integer');
-        $table->addForeignKeyConstraint('foreign_table', ['fk_id'], ['id']);
-        $table->setPrimaryKey(['id']);
-        $table->addOption('engine', 'MyISAM');
-
-        self::assertSame(
-            [
-                'CREATE TABLE foreign_table (id INT NOT NULL, fk_id INT NOT NULL, '
-                    . 'INDEX IDX_5690FFE2A57719D0 (fk_id), PRIMARY KEY(id)) '
-                    . 'ENGINE = MyISAM',
-            ],
-            $this->platform->getCreateTableSQL($table)
-        );
-
-        $table = clone $table;
-        $table->addOption('engine', 'InnoDB');
-
-        self::assertSame(
-            [
-                'CREATE TABLE foreign_table (id INT NOT NULL, fk_id INT NOT NULL, '
-                    . 'INDEX IDX_5690FFE2A57719D0 (fk_id), PRIMARY KEY(id)) '
-                    . 'ENGINE = InnoDB',
-                'ALTER TABLE foreign_table ADD CONSTRAINT FK_5690FFE2A57719D0 FOREIGN KEY (fk_id)'
-                    . ' REFERENCES foreign_table (id)',
-            ],
-            $this->platform->getCreateTableSQL($table)
-        );
-    }
-
-    public function testDoesNotPropagateForeignKeyAlterationForNonSupportingEngines(): void
-    {
-        $table = new Table('foreign_table');
-        $table->addColumn('id', 'integer');
-        $table->addColumn('fk_id', 'integer');
-        $table->addForeignKeyConstraint('foreign_table', ['fk_id'], ['id']);
-        $table->setPrimaryKey(['id']);
-        $table->addOption('engine', 'MyISAM');
-
-        $addedForeignKeys   = [new ForeignKeyConstraint(['fk_id'], 'foo', ['id'], 'fk_add')];
-        $changedForeignKeys = [new ForeignKeyConstraint(['fk_id'], 'bar', ['id'], 'fk_change')];
-        $removedForeignKeys = [new ForeignKeyConstraint(['fk_id'], 'baz', ['id'], 'fk_remove')];
-
-        $tableDiff                     = new TableDiff('foreign_table');
-        $tableDiff->fromTable          = $table;
-        $tableDiff->addedForeignKeys   = $addedForeignKeys;
-        $tableDiff->changedForeignKeys = $changedForeignKeys;
-        $tableDiff->removedForeignKeys = $removedForeignKeys;
-
-        self::assertEmpty($this->platform->getAlterTableSQL($tableDiff));
-
-        $table->addOption('engine', 'InnoDB');
-
-        $tableDiff                     = new TableDiff('foreign_table');
-        $tableDiff->fromTable          = $table;
-        $tableDiff->addedForeignKeys   = $addedForeignKeys;
-        $tableDiff->changedForeignKeys = $changedForeignKeys;
-        $tableDiff->removedForeignKeys = $removedForeignKeys;
-
-        self::assertSame(
-            [
-                'ALTER TABLE foreign_table DROP FOREIGN KEY fk_remove',
-                'ALTER TABLE foreign_table DROP FOREIGN KEY fk_change',
-                'ALTER TABLE foreign_table ADD CONSTRAINT fk_add FOREIGN KEY (fk_id) REFERENCES foo (id)',
-                'ALTER TABLE foreign_table ADD CONSTRAINT fk_change FOREIGN KEY (fk_id) REFERENCES bar (id)',
-            ],
-            $this->platform->getAlterTableSQL($tableDiff)
-        );
-    }
-
     /**
      * @return string[]
      */