Merge pull request #4234 from morozov/remove-deprecated

Remove deprecated APIs

Author: morozov

UPGRADE.md

@@ -1,5 +1,10 @@
 # Upgrade to 3.0
 
+## BC BREAK: change in the behavior of `SchemaManager::dropDatabase()`
+
+When dropping a database, the DBAL no longer attempts to kill the client sessions that use the database.
+It's the responsibility of the operator to make sure that the database is not being used.  
+
 ## BC BREAK: removed `Synchronizer` package
 
 The `Doctrine\DBAL\Schema\Synchronizer\SchemaSynchronizer` interface and all its implementations have been removed.
@@ -156,6 +161,8 @@ The `Doctrine\DBAL\Driver::getName()` has been removed.
  * Removed `json_array` type and all associated hacks.
  * Removed `Connection::TRANSACTION_*` constants.
  * Removed `AbstractPlatform::DATE_INTERVAL_UNIT_*` and `AbstractPlatform::TRIM_*` constants.
+ * Removed `AbstractPlatform::getSQLResultCasing()`, `::prefersSequences()` and `::supportsForeignKeyOnUpdate()` methods.
+ * Removed `PostgreSqlPlatform::getDisallowDatabaseConnectionsSQL()` and `::getCloseActiveDatabaseConnectionsSQL()` methods.
  * Removed `MysqlSessionInit` listener.
  * Removed `MysqlPlatform::getCollationFieldDeclaration()`.
  * Removed `AbstractPlatform::getIdentityColumnNullInsertSQL()`.

src/Platforms/AbstractPlatform.php

@@ -2454,7 +2454,7 @@ public function getForeignKeyDeclarationSQL(ForeignKeyConstraint $foreignKey)
     public function getAdvancedForeignKeyOptionsSQL(ForeignKeyConstraint $foreignKey)
     {
         $query = '';
-        if ($this->supportsForeignKeyOnUpdate() && $foreignKey->hasOption('onUpdate')) {
+        if ($foreignKey->hasOption('onUpdate')) {
             $query .= ' ON UPDATE ' . $this->getForeignKeyReferentialActionSQL($foreignKey->getOption('onUpdate'));
         }
 
@@ -2565,19 +2565,6 @@ public function getColumnCollationDeclarationSQL($collation)
         return $this->supportsColumnCollation() ? 'COLLATE ' . $collation : '';
     }
 
-    /**
-     * Whether the platform prefers sequences for ID generation.
-     * Subclasses should override this method to return TRUE if they prefer sequences.
-     *
-     * @deprecated
-     *
-     * @return bool
-     */
-    public function prefersSequences()
-    {
-        return false;
-    }
-
     /**
      * Whether the platform prefers identity columns (eg. autoincrement) for ID generation.
      * Subclasses should override this method to return TRUE if they prefer identity columns.
@@ -3147,18 +3134,6 @@ public function supportsCreateDropForeignKeyConstraints(): bool
         return true;
     }
 
-    /**
-     * Whether this platform supports onUpdate in foreign key constraints.
-     *
-     * @deprecated
-     *
-     * @return bool
-     */
-    public function supportsForeignKeyOnUpdate()
-    {
-        return $this->supportsForeignKeyConstraints();
-    }
-
     /**
      * Whether the platform supports database schemas.
      *
@@ -3388,20 +3363,6 @@ public function supportsLimitOffset()
         return true;
     }
 
-    /**
-     * Gets the character casing of a column in an SQL result set of this platform.
-     *
-     * @deprecated
-     *
-     * @param string $column The column name for which to get the correct character casing.
-     *
-     * @return string The column name in the character casing used in SQL result sets.
-     */
-    public function getSQLResultCasing($column)
-    {
-        return $column;
-    }
-
     /**
      * Maximum length of any given database identifier, like tables or column names.
      *

src/Platforms/DB2Platform.php

@@ -19,7 +19,6 @@
 use function implode;
 use function sprintf;
 use function strpos;
-use function strtoupper;
 
 class DB2Platform extends AbstractPlatform
 {
@@ -865,18 +864,6 @@ public function prefersIdentityColumns()
         return true;
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * DB2 returns all column names in SQL result sets in uppercase.
-     *
-     * @deprecated
-     */
-    public function getSQLResultCasing($column)
-    {
-        return strtoupper($column);
-    }
-
     /**
      * {@inheritDoc}
      */

src/Platforms/OraclePlatform.php

@@ -965,16 +965,6 @@ protected function getRenameIndexSQL($oldIndexName, Index $index, $tableName)
         return ['ALTER INDEX ' . $oldIndexName . ' RENAME TO ' . $index->getQuotedName($this)];
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * @deprecated
-     */
-    public function prefersSequences()
-    {
-        return true;
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -1052,18 +1042,6 @@ protected function doModifyLimitQuery($query, $limit, $offset = null)
         return $query;
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * Oracle returns all column names in SQL result sets in uppercase.
-     *
-     * @deprecated
-     */
-    public function getSQLResultCasing($column)
-    {
-        return strtoupper($column);
-    }
-
     /**
      * {@inheritDoc}
      */
@@ -1112,16 +1090,6 @@ public function supportsSequences()
         return true;
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * @deprecated
-     */
-    public function supportsForeignKeyOnUpdate()
-    {
-        return false;
-    }
-
     /**
      * {@inheritDoc}
      */

src/Platforms/PostgreSQL94Platform.php

@@ -209,16 +209,6 @@ public function supportsCommentOnStatement()
         return true;
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * @deprecated
-     */
-    public function prefersSequences()
-    {
-        return true;
-    }
-
     /**
      * {@inheritDoc}
      */
@@ -441,39 +431,6 @@ public function getCreateDatabaseSQL($name)
         return 'CREATE DATABASE ' . $name;
     }
 
-    /**
-     * Returns the SQL statement for disallowing new connections on the given database.
-     *
-     * This is useful to force DROP DATABASE operations which could fail because of active connections.
-     *
-     * @deprecated
-     *
-     * @param string $database The name of the database to disallow new connections for.
-     *
-     * @return string
-     */
-    public function getDisallowDatabaseConnectionsSQL($database)
-    {
-        return "UPDATE pg_database SET datallowconn = 'false' WHERE datname = " . $this->quoteStringLiteral($database);
-    }
-
-    /**
-     * Returns the SQL statement for closing currently active connections on the given database.
-     *
-     * This is useful to force DROP DATABASE operations which could fail because of active connections.
-     *
-     * @deprecated
-     *
-     * @param string $database The name of the database to close currently active connections for.
-     *
-     * @return string
-     */
-    public function getCloseActiveDatabaseConnectionsSQL($database)
-    {
-        return 'SELECT pg_terminate_backend(pid) FROM pg_stat_activity WHERE datname = '
-            . $this->quoteStringLiteral($database);
-    }
-
     /**
      * {@inheritDoc}
      */
@@ -1088,18 +1045,6 @@ public function getName()
         return 'postgresql';
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * PostgreSQL returns all column names in SQL result sets in lowercase.
-     *
-     * @deprecated
-     */
-    public function getSQLResultCasing($column)
-    {
-        return strtolower($column);
-    }
-
     /**
      * {@inheritDoc}
      */

src/Schema/OracleSchemaManager.php

@@ -3,20 +3,16 @@
 namespace Doctrine\DBAL\Schema;
 
 use Doctrine\DBAL\DBALException;
-use Doctrine\DBAL\Driver\Exception;
 use Doctrine\DBAL\Platforms\OraclePlatform;
 use Doctrine\DBAL\Types\Type;
-use Throwable;
 
 use function array_change_key_case;
 use function array_values;
 use function assert;
 use function preg_match;
-use function sprintf;
 use function str_replace;
 use function strpos;
 use function strtolower;
-use function strtoupper;
 use function trim;
 
 use const CASE_LOWER;
@@ -26,35 +22,6 @@
  */
 class OracleSchemaManager extends AbstractSchemaManager
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function dropDatabase($database)
-    {
-        try {
-            parent::dropDatabase($database);
-        } catch (DBALException $exception) {
-            $exception = $exception->getPrevious();
-            assert($exception instanceof Throwable);
-
-            if (! $exception instanceof Exception) {
-                throw $exception;
-            }
-
-            // If we have a error code 1940 (ORA-01940), the drop database operation failed
-            // because of active connections on the database.
-            // To force dropping the database, we first have to close all active connections
-            // on that database and issue the drop database operation again.
-            if ($exception->getCode() !== 1940) {
-                throw $exception;
-            }
-
-            $this->killUserSessions($database);
-
-            parent::dropDatabase($database);
-        }
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -341,46 +308,6 @@ private function getQuotedIdentifierName($identifier)
         return $identifier;
     }
 
-    /**
-     * Kills sessions connected with the given user.
-     *
-     * This is useful to force DROP USER operations which could fail because of active user sessions.
-     *
-     * @param string $user The name of the user to kill sessions for.
-     *
-     * @return void
-     *
-     * @throws DBALException
-     */
-    private function killUserSessions($user)
-    {
-        $sql = <<<SQL
-SELECT
-    s.sid,
-    s.serial#
-FROM
-    gv\$session s,
-    gv\$process p
-WHERE
-    s.username = ?
-    AND p.addr(+) = s.paddr
-SQL;
-
-        $activeUserSessions = $this->_conn->fetchAllAssociative($sql, [strtoupper($user)]);
-
-        foreach ($activeUserSessions as $activeUserSession) {
-            $activeUserSession = array_change_key_case($activeUserSession, CASE_LOWER);
-
-            $this->_execSql(
-                sprintf(
-                    "ALTER SYSTEM KILL SESSION '%s, %s' IMMEDIATE",
-                    $activeUserSession['sid'],
-                    $activeUserSession['serial#']
-                )
-            );
-        }
-    }
-
     /**
      * {@inheritdoc}
      */

src/Schema/PostgreSqlSchemaManager.php

@@ -3,7 +3,6 @@
 namespace Doctrine\DBAL\Schema;
 
 use Doctrine\DBAL\DBALException;
-use Doctrine\DBAL\Exception\DriverException;
 use Doctrine\DBAL\Platforms\PostgreSQL94Platform;
 use Doctrine\DBAL\Types\Type;
 use Doctrine\DBAL\Types\Types;
@@ -98,35 +97,6 @@ public function determineExistingSchemaSearchPaths()
         });
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function dropDatabase($database)
-    {
-        try {
-            parent::dropDatabase($database);
-        } catch (DriverException $exception) {
-            // If we have a SQLSTATE 55006, the drop database operation failed
-            // because of active connections on the database.
-            // To force dropping the database, we first have to close all active connections
-            // on that database and issue the drop database operation again.
-            if ($exception->getSQLState() !== '55006') {
-                throw $exception;
-            }
-
-            assert($this->_platform instanceof PostgreSQL94Platform);
-
-            $this->_execSql(
-                [
-                    $this->_platform->getDisallowDatabaseConnectionsSQL($database),
-                    $this->_platform->getCloseActiveDatabaseConnectionsSQL($database),
-                ]
-            );
-
-            parent::dropDatabase($database);
-        }
-    }
-
     /**
      * {@inheritdoc}
      */