[doctrineGH-4503] Trigger deprecation in schema- and namespace-relate…

…d APIs
morozov · Apr 1, 2021 · e5e31e1 · e5e31e1
1 parent a602f2b
commit e5e31e1
Show file tree

Hide file tree

Showing 6 changed files with 67 additions and 2 deletions.
diff --git a/src/Platforms/AbstractPlatform.php b/src/Platforms/AbstractPlatform.php
@@ -2758,6 +2758,13 @@ public function getListDatabasesSQL()
      */
     public function getListNamespacesSQL()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4503',
+            'AbstractPlatform::getListNamespacesSQL() is deprecated,'
+                . ' use AbstractSchemaManager::listSchemaNames() instead.'
+        );
+
         throw Exception::notSupported(__METHOD__);
     }
 

diff --git a/src/Platforms/PostgreSQL94Platform.php b/src/Platforms/PostgreSQL94Platform.php
@@ -233,6 +233,13 @@ public function getListDatabasesSQL()
      */
     public function getListNamespacesSQL()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4503',
+            'PostgreSQL94Platform::getListNamespacesSQL() is deprecated,'
+                . ' use PostgreSQLSchemaManager::listSchemaNames() instead.'
+        );
+
         return "SELECT schema_name AS nspname
                 FROM   information_schema.schemata
                 WHERE  schema_name NOT LIKE 'pg\_%'

diff --git a/src/Platforms/SQLServer2012Platform.php b/src/Platforms/SQLServer2012Platform.php
@@ -1166,6 +1166,13 @@ public function getListDatabasesSQL()
      */
     public function getListNamespacesSQL()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4503',
+            'SQLServer2012Platform::getListNamespacesSQL() is deprecated,'
+                . ' use SQLServerSchemaManager::listSchemaNames() instead.'
+        );
+
         return "SELECT name FROM sys.schemas WHERE name NOT IN('guest', 'INFORMATION_SCHEMA', 'sys')";
     }
 

diff --git a/src/Schema/AbstractSchemaManager.php b/src/Schema/AbstractSchemaManager.php
@@ -117,6 +117,13 @@ public function listDatabases()
      */
     public function listNamespaceNames()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4503',
+            'AbstractSchemaManager::listNamespaceNames() is deprecated,'
+                . ' use AbstractSchemaManager::listSchemaNames() instead.'
+        );
+
         $sql = $this->_platform->getListNamespacesSQL();
 
         $namespaces = $this->_conn->fetchAllAssociative($sql);
@@ -735,6 +742,13 @@ protected function _getPortableDatabasesList($databases)
      */
     protected function getPortableNamespacesList(array $namespaces)
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4503',
+            'AbstractSchemaManager::getPortableNamespacesList() is deprecated,'
+                . ' use AbstractSchemaManager::listSchemaNames() instead.'
+        );
+
         $namespacesList = [];
 
         foreach ($namespaces as $namespace) {
@@ -765,6 +779,13 @@ protected function _getPortableDatabaseDefinition($database)
      */
     protected function getPortableNamespaceDefinition(array $namespace)
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4503',
+            'AbstractSchemaManager::getPortableNamespaceDefinition() is deprecated,'
+                . ' use AbstractSchemaManager::listSchemaNames() instead.'
+        );
+
         return $namespace;
     }
 

diff --git a/src/Schema/PostgreSQLSchemaManager.php b/src/Schema/PostgreSQLSchemaManager.php
@@ -6,6 +6,7 @@
 use Doctrine\DBAL\Platforms\PostgreSQL94Platform;
 use Doctrine\DBAL\Types\Type;
 use Doctrine\DBAL\Types\Types;
+use Doctrine\Deprecations\Deprecation;
 
 use function array_change_key_case;
 use function array_filter;
@@ -46,6 +47,13 @@ class PostgreSQLSchemaManager extends AbstractSchemaManager
      */
     public function getSchemaNames()
     {
+        Deprecation::trigger(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4503',
+            'PostgreSQLSchemaManager::getSchemaNames() is deprecated,'
+                . ' use PostgreSQLSchemaManager::listSchemaNames() instead.'
+        );
+
         return $this->listNamespaceNames();
     }
 
@@ -287,10 +295,17 @@ protected function _getPortableSequencesList($sequences)
     /**
      * {@inheritdoc}
      *
-     * @deprecated Use {@link PostgreSQLSchemaManager::listSchemaNames()} instead.
+     * @deprecated Use {@link listSchemaNames()} instead.
      */
     protected function getPortableNamespaceDefinition(array $namespace)
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4503',
+            'PostgreSQLSchemaManager::getPortableNamespaceDefinition() is deprecated,'
+                . ' use PostgreSQLSchemaManager::listSchemaNames() instead.'
+        );
+
         return $namespace['nspname'];
     }
 

diff --git a/src/Schema/SQLServerSchemaManager.php b/src/Schema/SQLServerSchemaManager.php
@@ -5,6 +5,7 @@
 use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Platforms\SQLServer2012Platform;
 use Doctrine\DBAL\Types\Type;
+use Doctrine\Deprecations\Deprecation;
 use PDOException;
 
 use function assert;
@@ -214,10 +215,17 @@ protected function _getPortableDatabaseDefinition($database)
     /**
      * {@inheritdoc}
      *
-     * @deprecated Use {@link SQLServerSchemaManager::listSchemaNames()} instead.
+     * @deprecated Use {@link listSchemaNames()} instead.
      */
     protected function getPortableNamespaceDefinition(array $namespace)
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4503',
+            'SQLServerSchemaManager::getPortableNamespaceDefinition() is deprecated,'
+                . ' use SQLServerSchemaManager::listSchemaNames() instead.'
+        );
+
         return $namespace['name'];
     }