Make column and index renaming configurable

doctrine · Feb 6, 2024 · 82624c0 · 82624c0
1 parent ac75c3c
commit 82624c0
Show file tree

Hide file tree

Showing 6 changed files with 92 additions and 7 deletions.
diff --git a/src/Platforms/MySQL/Comparator.php b/src/Platforms/MySQL/Comparator.php
@@ -6,6 +6,7 @@
 
 use Doctrine\DBAL\Platforms\AbstractMySQLPlatform;
 use Doctrine\DBAL\Schema\Comparator as BaseComparator;
+use Doctrine\DBAL\Schema\ComparatorConfig;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Schema\TableDiff;
 
@@ -30,11 +31,12 @@ public function __construct(
         parent::__construct($platform);
     }
 
-    public function compareTables(Table $oldTable, Table $newTable): TableDiff
+    public function compareTables(Table $oldTable, Table $newTable, ?ComparatorConfig $config = null): TableDiff
     {
         return parent::compareTables(
             $this->normalizeTable($oldTable),
             $this->normalizeTable($newTable),
+            $config,
         );
     }
 

diff --git a/src/Platforms/SQLServer/Comparator.php b/src/Platforms/SQLServer/Comparator.php
@@ -6,6 +6,7 @@
 
 use Doctrine\DBAL\Platforms\SQLServerPlatform;
 use Doctrine\DBAL\Schema\Comparator as BaseComparator;
+use Doctrine\DBAL\Schema\ComparatorConfig;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Schema\TableDiff;
 
@@ -22,11 +23,12 @@ public function __construct(SQLServerPlatform $platform, private readonly string
         parent::__construct($platform);
     }
 
-    public function compareTables(Table $oldTable, Table $newTable): TableDiff
+    public function compareTables(Table $oldTable, Table $newTable, ?ComparatorConfig $config = null): TableDiff
     {
         return parent::compareTables(
             $this->normalizeColumns($oldTable),
             $this->normalizeColumns($newTable),
+            $config,
         );
     }
 

diff --git a/src/Platforms/SQLite/Comparator.php b/src/Platforms/SQLite/Comparator.php
@@ -6,6 +6,7 @@
 
 use Doctrine\DBAL\Platforms\SQLitePlatform;
 use Doctrine\DBAL\Schema\Comparator as BaseComparator;
+use Doctrine\DBAL\Schema\ComparatorConfig;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Schema\TableDiff;
 
@@ -24,11 +25,12 @@ public function __construct(SQLitePlatform $platform)
         parent::__construct($platform);
     }
 
-    public function compareTables(Table $oldTable, Table $newTable): TableDiff
+    public function compareTables(Table $oldTable, Table $newTable, ?ComparatorConfig $config = null): TableDiff
     {
         return parent::compareTables(
             $this->normalizeColumns($oldTable),
             $this->normalizeColumns($newTable),
+            $config,
         );
     }
 

diff --git a/src/Schema/Comparator.php b/src/Schema/Comparator.php
@@ -24,7 +24,7 @@ public function __construct(private readonly AbstractPlatform $platform)
     /**
      * Returns the differences between the schemas.
      */
-    public function compareSchemas(Schema $oldSchema, Schema $newSchema): SchemaDiff
+    public function compareSchemas(Schema $oldSchema, Schema $newSchema, ?ComparatorConfig $config = null): SchemaDiff
     {
         $createdSchemas   = [];
         $droppedSchemas   = [];
@@ -59,6 +59,7 @@ public function compareSchemas(Schema $oldSchema, Schema $newSchema): SchemaDiff
                 $tableDiff = $this->compareTables(
                     $oldSchema->getTable($newTableName),
                     $newSchema->getTable($newTableName),
+                    $config,
                 );
 
                 if (! $tableDiff->isEmpty()) {
@@ -141,14 +142,18 @@ public function diffSequence(Sequence $sequence1, Sequence $sequence2): bool
     /**
      * Compares the tables and returns the difference between them.
      */
-    public function compareTables(Table $oldTable, Table $newTable): TableDiff
+    public function compareTables(Table $oldTable, Table $newTable, ?ComparatorConfig $config = null): TableDiff
     {
+        $config ??= new ComparatorConfig();
+
         $addedColumns        = [];
         $modifiedColumns     = [];
         $droppedColumns      = [];
+        $renamedColumns      = [];
         $addedIndexes        = [];
         $modifiedIndexes     = [];
         $droppedIndexes      = [];
+        $renamedIndexes      = [];
         $addedForeignKeys    = [];
         $modifiedForeignKeys = [];
         $droppedForeignKeys  = [];
@@ -187,7 +192,9 @@ public function compareTables(Table $oldTable, Table $newTable): TableDiff
             $modifiedColumns[] = new ColumnDiff($oldColumn, $newColumn);
         }
 
-        $renamedColumns = $this->detectRenamedColumns($addedColumns, $droppedColumns);
+        if ($config->getDetectRenamedColumns()) {
+            $renamedColumns = $this->detectRenamedColumns($addedColumns, $droppedColumns);
+        }
 
         $oldIndexes = $oldTable->getIndexes();
         $newIndexes = $newTable->getIndexes();
@@ -224,7 +231,9 @@ public function compareTables(Table $oldTable, Table $newTable): TableDiff
             $modifiedIndexes[] = $newIndex;
         }
 
-        $renamedIndexes = $this->detectRenamedIndexes($addedIndexes, $droppedIndexes);
+        if ($config->getDetectRenamedIndexes()) {
+            $renamedIndexes = $this->detectRenamedIndexes($addedIndexes, $droppedIndexes);
+        }
 
         $oldForeignKeys = $oldTable->getForeignKeys();
         $newForeignKeys = $newTable->getForeignKeys();

diff --git a/src/Schema/ComparatorConfig.php b/src/Schema/ComparatorConfig.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Schema;
+
+class ComparatorConfig
+{
+    protected bool $detectRenamedColumns = true;
+
+    protected bool $detectRenamedIndexes = true;
+
+    public function setDetectRenamedColumns(bool $detectRenamedColumns): void
+    {
+        $this->detectRenamedColumns = $detectRenamedColumns;
+    }
+
+    public function getDetectRenamedColumns(): bool
+    {
+        return $this->detectRenamedColumns;
+    }
+
+    public function setDetectRenamedIndexes(bool $detectRenamedIndexes): void
+    {
+        $this->detectRenamedIndexes = $detectRenamedIndexes;
+    }
+
+    public function getDetectRenamedIndexes(): bool
+    {
+        return $this->detectRenamedIndexes;
+    }
+}
diff --git a/tests/Schema/AbstractComparatorTestCase.php b/tests/Schema/AbstractComparatorTestCase.php
@@ -8,6 +8,7 @@
 use Doctrine\DBAL\Schema\Column;
 use Doctrine\DBAL\Schema\ColumnDiff;
 use Doctrine\DBAL\Schema\Comparator;
+use Doctrine\DBAL\Schema\ComparatorConfig;
 use Doctrine\DBAL\Schema\ForeignKeyConstraint;
 use Doctrine\DBAL\Schema\Index;
 use Doctrine\DBAL\Schema\Schema;
@@ -395,6 +396,23 @@ public function testDetectRenameColumn(): void
         self::assertEquals('bar', $renamedColumns['foo']->getName());
     }
 
+    public function testDetectRenameColumnDisabled(): void
+    {
+        $tableA = new Table('foo');
+        $tableA->addColumn('foo', Types::INTEGER);
+
+        $tableB = new Table('foo');
+        $tableB->addColumn('bar', Types::INTEGER);
+
+        $config = new ComparatorConfig();
+        $config->setDetectRenamedColumns(false);
+        $tableDiff = $this->comparator->compareTables($tableA, $tableB, $config);
+
+        self::assertCount(1, $tableDiff->getAddedColumns());
+        self::assertCount(1, $tableDiff->getDroppedColumns());
+        self::assertCount(0, $tableDiff->getRenamedColumns());
+    }
+
     /**
      * You can easily have ambiguities in the column renaming. If these
      * are detected no renaming should take place, instead adding and dropping
@@ -437,6 +455,26 @@ public function testDetectRenameIndex(): void
         self::assertEquals('idx_bar', $renamedIndexes['idx_foo']->getName());
     }
 
+    public function testDetectRenameIndexDisabled(): void
+    {
+        $table1 = new Table('foo');
+        $table1->addColumn('foo', Types::INTEGER);
+
+        $table2 = clone $table1;
+
+        $table1->addIndex(['foo'], 'idx_foo');
+
+        $table2->addIndex(['foo'], 'idx_bar');
+
+        $config = new ComparatorConfig();
+        $config->setDetectRenamedIndexes(false);
+        $tableDiff = $this->comparator->compareTables($table1, $table2, $config);
+
+        self::assertCount(1, $tableDiff->getAddedIndexes());
+        self::assertCount(1, $tableDiff->getDroppedIndexes());
+        self::assertCount(0, $tableDiff->getRenamedIndexes());
+    }
+
     /**
      * You can easily have ambiguities in the index renaming. If these
      * are detected no renaming should take place, instead adding and dropping