Deprecate Driver::getSchemaManager() in favor of AbstractPlatform::createSchemaManager()

morozov · morozov · commit 3640bbca252b · 2022-06-20T15:42:04.000-07:00
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -8,6 +8,10 @@ awareness about deprecated code.
 
 # Upgrade to 3.4
 
+## Deprecated `Driver::getSchemaManager()`.
+
+The `Driver::getSchemaManager()` method has been deprecated. Use `AbstractPlatform::createSchemaManager()` instead.
+
 ## Deprecated `ConsolerRunner`.
 
 The `ConsoleRunner` class has been deprecated. Use Symfony Console documentation
diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -317,6 +317,10 @@
                 <referencedMethod name="Doctrine\DBAL\Schema\Schema::visit"/>
                 <referencedMethod name="Doctrine\DBAL\Schema\Sequence::visit"/>
                 <referencedMethod name="Doctrine\DBAL\Schema\Table::visit"/>
+                <!--
+                    TODO: remove in 4.0.0
+                -->
+                <referencedMethod name="Doctrine\DBAL\Driver::getSchemaManager"/>
             </errorLevel>
         </DeprecatedMethod>
         <DeprecatedProperty>
diff --git a/src/Driver.php b/src/Driver.php
@@ -37,6 +37,8 @@ public function getDatabasePlatform();
      * Gets the SchemaManager that can be used to inspect and change the underlying
      * database schema of the platform this driver connects to.
      *
+     * @deprecated Use {@link AbstractPlatform::createSchemaManager()} instead.
+     *
      * @return AbstractSchemaManager
      */
     public function getSchemaManager(Connection $conn, AbstractPlatform $platform);
diff --git a/src/Driver/AbstractDB2Driver.php b/src/Driver/AbstractDB2Driver.php
@@ -9,6 +9,7 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Platforms\DB2Platform;
 use Doctrine\DBAL\Schema\DB2SchemaManager;
+use Doctrine\Deprecations\Deprecation;
 
 use function assert;
 
@@ -27,9 +28,18 @@ public function getDatabasePlatform()
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated Use {@link DB2Platform::createSchemaManager()} instead.
      */
     public function getSchemaManager(Connection $conn, AbstractPlatform $platform)
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5458',
+            'AbstractDB2Driver::getSchemaManager() is deprecated.'
+                . ' Use DB2Platform::createSchemaManager() instead.'
+        );
+
         assert($platform instanceof DB2Platform);
 
         return new DB2SchemaManager($conn, $platform);
diff --git a/src/Driver/AbstractMySQLDriver.php b/src/Driver/AbstractMySQLDriver.php
@@ -132,10 +132,19 @@ public function getDatabasePlatform()
     /**
      * {@inheritdoc}
      *
+     * @deprecated Use {@link AbstractMySQLPlatform::createSchemaManager()} instead.
+     *
      * @return MySQLSchemaManager
      */
     public function getSchemaManager(Connection $conn, AbstractPlatform $platform)
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5458',
+            'AbstractMySQLDriver::getSchemaManager() is deprecated.'
+                . ' Use MySQLPlatform::createSchemaManager() instead.'
+        );
+
         assert($platform instanceof AbstractMySQLPlatform);
 
         return new MySQLSchemaManager($conn, $platform);
diff --git a/src/Driver/AbstractOracleDriver.php b/src/Driver/AbstractOracleDriver.php
@@ -10,6 +10,7 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Platforms\OraclePlatform;
 use Doctrine\DBAL\Schema\OracleSchemaManager;
+use Doctrine\Deprecations\Deprecation;
 
 use function assert;
 
@@ -28,9 +29,18 @@ public function getDatabasePlatform()
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated Use {@link OraclePlatform::createSchemaManager()} instead.
      */
     public function getSchemaManager(Connection $conn, AbstractPlatform $platform)
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5458',
+            'AbstractOracleDriver::getSchemaManager() is deprecated.'
+                . ' Use OraclePlatform::createSchemaManager() instead.'
+        );
+
         assert($platform instanceof OraclePlatform);
 
         return new OracleSchemaManager($conn, $platform);
diff --git a/src/Driver/AbstractPostgreSQLDriver.php b/src/Driver/AbstractPostgreSQLDriver.php
@@ -64,9 +64,18 @@ public function getDatabasePlatform()
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated Use {@link PostgreSQLPlatform::createSchemaManager()} instead.
      */
     public function getSchemaManager(Connection $conn, AbstractPlatform $platform)
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5458',
+            'AbstractPostgreSQLDriver::getSchemaManager() is deprecated.'
+                . ' Use PostgreSQLPlatform::createSchemaManager() instead.'
+        );
+
         assert($platform instanceof PostgreSQLPlatform);
 
         return new PostgreSQLSchemaManager($conn, $platform);
diff --git a/src/Driver/AbstractSQLServerDriver.php b/src/Driver/AbstractSQLServerDriver.php
@@ -9,6 +9,7 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Platforms\SQLServer2012Platform;
 use Doctrine\DBAL\Schema\SQLServerSchemaManager;
+use Doctrine\Deprecations\Deprecation;
 
 use function assert;
 
@@ -27,9 +28,18 @@ public function getDatabasePlatform()
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated Use {@link SQLServerPlatform::createSchemaManager()} instead.
      */
     public function getSchemaManager(Connection $conn, AbstractPlatform $platform)
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5458',
+            'AbstractSQLServerDriver::getSchemaManager() is deprecated.'
+                . ' Use SQLServerPlatform::createSchemaManager() instead.'
+        );
+
         assert($platform instanceof SQLServer2012Platform);
 
         return new SQLServerSchemaManager($conn, $platform);
diff --git a/src/Driver/AbstractSQLiteDriver.php b/src/Driver/AbstractSQLiteDriver.php
@@ -9,6 +9,7 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Platforms\SqlitePlatform;
 use Doctrine\DBAL\Schema\SqliteSchemaManager;
+use Doctrine\Deprecations\Deprecation;
 
 use function assert;
 
@@ -27,9 +28,18 @@ public function getDatabasePlatform()
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated Use {@link SqlitePlatform::createSchemaManager()} instead.
      */
     public function getSchemaManager(Connection $conn, AbstractPlatform $platform)
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5458',
+            'AbstractSQLiteDriver::getSchemaManager() is deprecated.'
+                . ' Use SqlitePlatform::createSchemaManager() instead.'
+        );
+
         assert($platform instanceof SqlitePlatform);
 
         return new SqliteSchemaManager($conn, $platform);
diff --git a/src/Driver/Middleware/AbstractDriverMiddleware.php b/src/Driver/Middleware/AbstractDriverMiddleware.php
@@ -7,6 +7,7 @@
 use Doctrine\DBAL\Driver\API\ExceptionConverter;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\VersionAwarePlatformDriver;
+use Doctrine\Deprecations\Deprecation;
 
 abstract class AbstractDriverMiddleware implements VersionAwarePlatformDriver
 {
@@ -36,9 +37,18 @@ public function getDatabasePlatform()
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated Use {@link AbstractPlatform::createSchemaManager()} instead.
      */
     public function getSchemaManager(Connection $conn, AbstractPlatform $platform)
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5458',
+            'AbstractDriverMiddleware::getSchemaManager() is deprecated.'
+                . ' Use AbstractPlatform::createSchemaManager() instead.'
+        );
+
         return $this->wrappedDriver->getSchemaManager($conn, $platform);
     }
 
diff --git a/src/Platforms/AbstractMySQLPlatform.php b/src/Platforms/AbstractMySQLPlatform.php
@@ -2,10 +2,12 @@
 
 namespace Doctrine\DBAL\Platforms;
 
+use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Schema\ForeignKeyConstraint;
 use Doctrine\DBAL\Schema\Identifier;
 use Doctrine\DBAL\Schema\Index;
+use Doctrine\DBAL\Schema\MySQLSchemaManager;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Schema\TableDiff;
 use Doctrine\DBAL\TransactionIsolationLevel;
@@ -1280,4 +1282,9 @@ private function getDatabaseNameSQL(?string $databaseName): string
 
         return $this->getCurrentDatabaseExpression();
     }
+
+    public function createSchemaManager(Connection $connection): MySQLSchemaManager
+    {
+        return new MySQLSchemaManager($connection, $this);
+    }
 }
diff --git a/src/Platforms/AbstractPlatform.php b/src/Platforms/AbstractPlatform.php
@@ -3,6 +3,7 @@
 namespace Doctrine\DBAL\Platforms;
 
 use Doctrine\Common\EventManager;
+use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Event\SchemaAlterTableAddColumnEventArgs;
 use Doctrine\DBAL\Event\SchemaAlterTableChangeColumnEventArgs;
 use Doctrine\DBAL\Event\SchemaAlterTableEventArgs;
@@ -16,6 +17,7 @@
 use Doctrine\DBAL\Exception\InvalidLockMode;
 use Doctrine\DBAL\LockMode;
 use Doctrine\DBAL\Platforms\Keywords\KeywordList;
+use Doctrine\DBAL\Schema\AbstractSchemaManager;
 use Doctrine\DBAL\Schema\Column;
 use Doctrine\DBAL\Schema\ColumnDiff;
 use Doctrine\DBAL\Schema\Constraint;
@@ -4335,4 +4337,17 @@ public function columnsEqual(Column $column1, Column $column2): bool
 
         return $column1->getType() === $column2->getType();
     }
+
+    /**
+     * Creates the schema manager that can be used to inspect and change the underlying
+     * database schema according to the dialect of the platform.
+     *
+     * @throws Exception
+     *
+     * @abstract
+     */
+    public function createSchemaManager(Connection $connection): AbstractSchemaManager
+    {
+        throw Exception::notSupported(__METHOD__);
+    }
 }
diff --git a/src/Platforms/DB2Platform.php b/src/Platforms/DB2Platform.php
@@ -2,8 +2,10 @@
 
 namespace Doctrine\DBAL\Platforms;
 
+use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Schema\ColumnDiff;
+use Doctrine\DBAL\Schema\DB2SchemaManager;
 use Doctrine\DBAL\Schema\Identifier;
 use Doctrine\DBAL\Schema\Index;
 use Doctrine\DBAL\Schema\TableDiff;
@@ -968,4 +970,9 @@ public function getListTableCommentsSQL(string $table): string
             $this->quoteStringLiteral($table)
         );
     }
+
+    public function createSchemaManager(Connection $connection): DB2SchemaManager
+    {
+        return new DB2SchemaManager($connection, $this);
+    }
 }
diff --git a/src/Platforms/OraclePlatform.php b/src/Platforms/OraclePlatform.php
@@ -2,10 +2,12 @@
 
 namespace Doctrine\DBAL\Platforms;
 
+use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Schema\ForeignKeyConstraint;
 use Doctrine\DBAL\Schema\Identifier;
 use Doctrine\DBAL\Schema\Index;
+use Doctrine\DBAL\Schema\OracleSchemaManager;
 use Doctrine\DBAL\Schema\Sequence;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Schema\TableDiff;
@@ -1251,4 +1253,9 @@ public function getListTableCommentsSQL(string $table, ?string $database = null)
             $ownerCondition
         );
     }
+
+    public function createSchemaManager(Connection $connection): OracleSchemaManager
+    {
+        return new OracleSchemaManager($connection, $this);
+    }
 }
diff --git a/src/Platforms/PostgreSQLPlatform.php b/src/Platforms/PostgreSQLPlatform.php
@@ -2,11 +2,13 @@
 
 namespace Doctrine\DBAL\Platforms;
 
+use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Schema\Column;
 use Doctrine\DBAL\Schema\ColumnDiff;
 use Doctrine\DBAL\Schema\ForeignKeyConstraint;
 use Doctrine\DBAL\Schema\Identifier;
 use Doctrine\DBAL\Schema\Index;
+use Doctrine\DBAL\Schema\PostgreSQLSchemaManager;
 use Doctrine\DBAL\Schema\Sequence;
 use Doctrine\DBAL\Schema\TableDiff;
 use Doctrine\DBAL\Types\BinaryType;
@@ -1277,4 +1279,9 @@ public function getListTableMetadataSQL(string $table, ?string $schema = null):
             $this->quoteStringLiteral($table)
         );
     }
+
+    public function createSchemaManager(Connection $connection): PostgreSQLSchemaManager
+    {
+        return new PostgreSQLSchemaManager($connection, $this);
+    }
 }
diff --git a/src/Platforms/SQLServerPlatform.php b/src/Platforms/SQLServerPlatform.php
@@ -2,6 +2,7 @@
 
 namespace Doctrine\DBAL\Platforms;
 
+use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Exception\InvalidLockMode;
 use Doctrine\DBAL\LockMode;
 use Doctrine\DBAL\Schema\Column;
@@ -10,6 +11,7 @@
 use Doctrine\DBAL\Schema\Identifier;
 use Doctrine\DBAL\Schema\Index;
 use Doctrine\DBAL\Schema\Sequence;
+use Doctrine\DBAL\Schema\SQLServerSchemaManager;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Schema\TableDiff;
 use Doctrine\Deprecations\Deprecation;
@@ -1696,4 +1698,9 @@ private function shouldAddOrderBy($query): bool
 
         return true;
     }
+
+    public function createSchemaManager(Connection $connection): SQLServerSchemaManager
+    {
+        return new SQLServerSchemaManager($connection, $this);
+    }
 }
diff --git a/src/Platforms/SqlitePlatform.php b/src/Platforms/SqlitePlatform.php
@@ -2,6 +2,7 @@
 
 namespace Doctrine\DBAL\Platforms;
 
+use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Driver\API\SQLite\UserDefinedFunctions;
 use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Schema\Column;
@@ -10,6 +11,7 @@
 use Doctrine\DBAL\Schema\Identifier;
 use Doctrine\DBAL\Schema\Index;
 use Doctrine\DBAL\Schema\SchemaException;
+use Doctrine\DBAL\Schema\SqliteSchemaManager;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Schema\TableDiff;
 use Doctrine\DBAL\TransactionIsolationLevel;
@@ -1381,4 +1383,9 @@ private function getPrimaryIndexInAlteredTable(TableDiff $diff, Table $fromTable
 
         return $primaryIndex;
     }
+
+    public function createSchemaManager(Connection $connection): SqliteSchemaManager
+    {
+        return new SqliteSchemaManager($connection, $this);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,8 @@ public function getDatabasePlatform();`
`37`	`37`	`* Gets the SchemaManager that can be used to inspect and change the underlying`
`38`	`38`	`* database schema of the platform this driver connects to.`
`39`	`39`	`*`
	`40`	`+ * @deprecated Use {@link AbstractPlatform::createSchemaManager()} instead.`
	`41`	`+ *`
`40`	`42`	`* @return AbstractSchemaManager`
`41`	`43`	`*/`
`42`	`44`	`public function getSchemaManager(Connection $conn, AbstractPlatform $platform);`