Make column and index renaming configurable

docs/en/reference/schema-manager.rst

@@ -217,7 +217,7 @@ the changes on the database:
 .. code-block:: php
 
     <?php
-    $sql = $fromSchema->getMigrateToSql($toSchema, $conn->getDatabasePlatform());
+    $sql = $sm->createComparator()->compareSchemas($fromSchema, $toSchema)->toSql($conn->getDatabasePlatform());
 
 The ``$sql`` array should give you a SQL query to drop the user
 table:
@@ -233,6 +233,29 @@ table:
     )
     */
 
+createComparator()
+------------------
+
+To create a comparator that can be used to compare two schemas use the
+``createComparator()`` method which returns an instance of
+``Doctrine\DBAL\Schema\Comparator``.
+
+.. code-block:: php
+
+    <?php
+    $comparator = $sm->createComparator();
+    $schemaDiff = $comparator->compareSchemas($fromSchema, $toSchema);
+
+To change the configuration of the comparator, you can pass a
+``Doctrine\DBAL\Schema\ComparatorConfig`` object to the method:
+
+.. code-block:: php
+
+    <?php
+    $config = (new ComparatorConfig())->withDetectRenamedColumns(false);
+    $comparator = $sm->createComparator($config);
+    $schemaDiff = $comparator->compareSchemas($fromSchema, $toSchema);
+
 Overriding the schema manager
 -----------------------------
 

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;
 
@@ -26,8 +27,9 @@ public function __construct(
         private readonly CharsetMetadataProvider $charsetMetadataProvider,
         private readonly CollationMetadataProvider $collationMetadataProvider,
         private readonly DefaultTableOptions $defaultTableOptions,
+        ComparatorConfig $config = new ComparatorConfig(),
     ) {
-        parent::__construct($platform);
+        parent::__construct($platform, $config);
     }
 
     public function compareTables(Table $oldTable, Table $newTable): TableDiff

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;
 
@@ -17,9 +18,12 @@
 class Comparator extends BaseComparator
 {
     /** @internal The comparator can be only instantiated by a schema manager. */
-    public function __construct(SQLServerPlatform $platform, private readonly string $databaseCollation)
-    {
-        parent::__construct($platform);
+    public function __construct(
+        SQLServerPlatform $platform,
+        private readonly string $databaseCollation,
+        ComparatorConfig $config = new ComparatorConfig(),
+    ) {
+        parent::__construct($platform, $config);
     }
 
     public function compareTables(Table $oldTable, Table $newTable): TableDiff

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;
 
@@ -19,9 +20,9 @@
 class Comparator extends BaseComparator
 {
     /** @internal The comparator can be only instantiated by a schema manager. */
-    public function __construct(SQLitePlatform $platform)
+    public function __construct(SQLitePlatform $platform, ComparatorConfig $config = new ComparatorConfig())
     {
-        parent::__construct($platform);
+        parent::__construct($platform, $config);
     }
 
     public function compareTables(Table $oldTable, Table $newTable): TableDiff

src/Schema/AbstractSchemaManager.php

@@ -17,6 +17,8 @@
 use function array_map;
 use function array_values;
 use function count;
+use function func_get_arg;
+use function func_num_args;
 use function strtolower;
 
 /**
@@ -840,9 +842,9 @@
         return $database;
     }
 
-    public function createComparator(): Comparator
+    public function createComparator(/* ComparatorConfig $config = new ComparatorConfig() */): Comparator
     {
-        return new Comparator($this->platform);
+        return new Comparator($this->platform, func_num_args() > 0 ? func_get_arg(0) : new ComparatorConfig());
     }
 
     /**

src/Schema/Comparator.php

@@ -17,8 +17,10 @@
 class Comparator
 {
     /** @internal The comparator can be only instantiated by a schema manager. */
-    public function __construct(private readonly AbstractPlatform $platform)
-    {
+    public function __construct(
+        private readonly AbstractPlatform $platform,
+        private readonly ComparatorConfig $config = new ComparatorConfig(),
+    ) {
     }
 
     /**
@@ -149,6 +151,7 @@ public function compareTables(Table $oldTable, Table $newTable): TableDiff
         $addedIndexes        = [];
         $modifiedIndexes     = [];
         $droppedIndexes      = [];
+        $renamedIndexes      = [];
         $addedForeignKeys    = [];
         $modifiedForeignKeys = [];
         $droppedForeignKeys  = [];
@@ -207,7 +210,9 @@ public function compareTables(Table $oldTable, Table $newTable): TableDiff
             );
         }
 
-        $this->detectRenamedColumns($modifiedColumns, $addedColumns, $droppedColumns);
+        if ($this->config->getDetectRenamedColumns()) {
+            $this->detectRenamedColumns($modifiedColumns, $addedColumns, $droppedColumns);
+        }
 
         $oldIndexes = $oldTable->getIndexes();
         $newIndexes = $newTable->getIndexes();
@@ -244,7 +249,9 @@ public function compareTables(Table $oldTable, Table $newTable): TableDiff
             $modifiedIndexes[] = $newIndex;
         }
 
-        $renamedIndexes = $this->detectRenamedIndexes($addedIndexes, $droppedIndexes);
+        if ($this->config->getDetectRenamedIndexes()) {
+            $renamedIndexes = $this->detectRenamedIndexes($addedIndexes, $droppedIndexes);
+        }
 
         $oldForeignKeys = $oldTable->getForeignKeys();
         $newForeignKeys = $newTable->getForeignKeys();

src/Schema/ComparatorConfig.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Schema;
+
+final class ComparatorConfig
+{
+    public function __construct(
+        private readonly bool $detectRenamedColumns = true,
+        private readonly bool $detectRenamedIndexes = true,
+    ) {
+    }
+
+    public function withDetectRenamedColumns(bool $detectRenamedColumns): self
+    {
+        return new self(
+            $detectRenamedColumns,
+            $this->detectRenamedIndexes,
+        );
+    }
+
+    public function getDetectRenamedColumns(): bool
+    {
+        return $this->detectRenamedColumns;
+    }
+
+    public function withDetectRenamedIndexes(bool $detectRenamedIndexes): self
+    {
+        return new self(
+            $this->detectRenamedColumns,
+            $detectRenamedIndexes,
+        );
+    }
+
+    public function getDetectRenamedIndexes(): bool
+    {
+        return $this->detectRenamedIndexes;
+    }
+}

src/Schema/MySQLSchemaManager.php

@@ -20,6 +20,8 @@
 use function array_map;
 use function assert;
 use function explode;
+use function func_get_arg;
+use function func_num_args;
 use function implode;
 use function is_string;
 use function preg_match;
@@ -335,7 +337,7 @@
     }
 
     /** @throws Exception */
-    public function createComparator(): Comparator
+    public function createComparator(/* ComparatorConfig $config = new ComparatorConfig() */): Comparator
     {
         return new MySQL\Comparator(
             $this->platform,
@@ -346,6 +348,7 @@
                 new ConnectionCollationMetadataProvider($this->connection),
             ),
             $this->getDefaultTableOptions(),
+            func_num_args() > 0 ? func_get_arg(0) : new ComparatorConfig(),
         );
     }
 

src/Schema/SQLServerSchemaManager.php

@@ -13,6 +13,8 @@
 use function array_change_key_case;
 use function assert;
 use function explode;
+use function func_get_arg;
+use function func_num_args;
 use function implode;
 use function is_string;
 use function preg_match;
@@ -262,9 +264,13 @@ protected function _getPortableViewDefinition(array $view): View
     }
 
     /** @throws Exception */
-    public function createComparator(): Comparator
+    public function createComparator(/* ComparatorConfig $config = new ComparatorConfig() */): Comparator
     {
-        return new SQLServer\Comparator($this->platform, $this->getDatabaseCollation());
+        return new SQLServer\Comparator(
+            $this->platform,
+            $this->getDatabaseCollation(),
+            func_num_args() > 0 ? func_get_arg(0) : new ComparatorConfig(),
+        );
     }
 
     /** @throws Exception */

src/Schema/SQLiteSchemaManager.php

@@ -16,6 +16,8 @@
 use function array_merge;
 use function assert;
 use function count;
+use function func_get_arg;
+use function func_num_args;
 use function implode;
 use function is_string;
 use function preg_match;
@@ -496,9 +498,9 @@
         return $details;
     }
 
-    public function createComparator(): Comparator
+    public function createComparator(/* ComparatorConfig $config = new ComparatorConfig() */): Comparator
     {
-        return new SQLite\Comparator($this->platform);
+        return new SQLite\Comparator($this->platform, func_num_args() > 0 ? func_get_arg(0) : new ComparatorConfig());
     }
 
     protected function selectTableNames(string $databaseName): Result

tests/Functional/Schema/ComparatorTest.php

@@ -8,6 +8,7 @@
 use Doctrine\DBAL\Platforms\MariaDBPlatform;
 use Doctrine\DBAL\Schema\AbstractSchemaManager;
 use Doctrine\DBAL\Schema\Comparator;
+use Doctrine\DBAL\Schema\ComparatorConfig;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Tests\Functional\Platform\RenameColumnTest;
 use Doctrine\DBAL\Tests\FunctionalTestCase;
@@ -53,7 +54,7 @@ public function testDefaultValueComparison(string $type, mixed $value): void
     public function testRenameColumnComparison(): void
     {
         $platform   = $this->connection->getDatabasePlatform();
-        $comparator = new Comparator($platform);
+        $comparator = new Comparator($platform, new ComparatorConfig());
 
         $table = new Table('rename_table');
         $table->addColumn('test', Types::STRING, ['default' => 'baz', 'length' => 20]);

tests/Platforms/AbstractMySQLPlatformTestCase.php

@@ -11,6 +11,7 @@
 use Doctrine\DBAL\Platforms\MySQL\CollationMetadataProvider;
 use Doctrine\DBAL\Platforms\MySQL\DefaultTableOptions;
 use Doctrine\DBAL\Schema\Comparator;
+use Doctrine\DBAL\Schema\ComparatorConfig;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\TransactionIsolationLevel;
 use Doctrine\DBAL\Types\Types;
@@ -692,6 +693,7 @@ protected function createComparator(): Comparator
             self::createStub(CharsetMetadataProvider::class),
             self::createStub(CollationMetadataProvider::class),
             new DefaultTableOptions('utf8mb4', 'utf8mb4_general_ci'),
+            new ComparatorConfig(),
         );
     }
 }

tests/Platforms/AbstractPlatformTestCase.php

@@ -10,6 +10,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\Table;
@@ -40,7 +41,7 @@ protected function setUp(): void
 
     protected function createComparator(): Comparator
     {
-        return new Comparator($this->platform);
+        return new Comparator($this->platform, new ComparatorConfig());
     }
 
     public function testQuoteIdentifier(): void

tests/Platforms/MySQL/ComparatorTest.php

@@ -9,17 +9,19 @@
 use Doctrine\DBAL\Platforms\MySQL\Comparator;
 use Doctrine\DBAL\Platforms\MySQL\DefaultTableOptions;
 use Doctrine\DBAL\Platforms\MySQLPlatform;
+use Doctrine\DBAL\Schema\ComparatorConfig;
 use Doctrine\DBAL\Tests\Schema\AbstractComparatorTestCase;
 
 class ComparatorTest extends AbstractComparatorTestCase
 {
-    protected function setUp(): void
+    protected function createComparator(ComparatorConfig $config): Comparator
     {
-        $this->comparator = new Comparator(
+        return new Comparator(
             new MySQLPlatform(),
             self::createStub(CharsetMetadataProvider::class),
             self::createStub(CollationMetadataProvider::class),
             new DefaultTableOptions('utf8mb4', 'utf8mb4_general_ci'),
+            $config,
         );
     }
 }

tests/Platforms/MySQL/MariaDBJsonComparatorTest.php

@@ -9,6 +9,7 @@
 use Doctrine\DBAL\Platforms\MySQL\CollationMetadataProvider;
 use Doctrine\DBAL\Platforms\MySQL\Comparator;
 use Doctrine\DBAL\Platforms\MySQL\DefaultTableOptions;
+use Doctrine\DBAL\Schema\ComparatorConfig;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Types\Types;
 use PHPUnit\Framework\Attributes\DataProvider;
@@ -40,6 +41,7 @@ public function getCollationCharset(string $collation): ?string
                 }
             },
             new DefaultTableOptions('utf8mb4', 'utf8mb4_general_ci'),
+            new ComparatorConfig(),
         );
 
         // TableA has collation set at table level and various column collations

tests/Platforms/SQLServer/ComparatorTest.php

@@ -6,12 +6,13 @@
 
 use Doctrine\DBAL\Platforms\SQLServer\Comparator;
 use Doctrine\DBAL\Platforms\SQLServerPlatform;
+use Doctrine\DBAL\Schema\ComparatorConfig;
 use Doctrine\DBAL\Tests\Schema\AbstractComparatorTestCase;
 
 class ComparatorTest extends AbstractComparatorTestCase
 {
-    protected function setUp(): void
+    protected function createComparator(ComparatorConfig $config): Comparator
     {
-        $this->comparator = new Comparator(new SQLServerPlatform(), '');
+        return new Comparator(new SQLServerPlatform(), '', $config);
     }
 }

tests/Platforms/SQLServerPlatformTest.php

@@ -13,6 +13,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\Index;
 use Doctrine\DBAL\Schema\Sequence;
 use Doctrine\DBAL\Schema\Table;
@@ -32,7 +33,7 @@ public function createPlatform(): AbstractPlatform
 
     protected function createComparator(): Comparator
     {
-        return new SQLServer\Comparator($this->platform, '');
+        return new SQLServer\Comparator($this->platform, '', new ComparatorConfig());
     }
 
     public function getGenerateTableSql(): string