Merge pull request #5705 from morozov/deprecate-pdo-pgsql-default-dbname

Deprecate PostgreSQL-specific connection parameters and behavior

Author: morozov

UPGRADE.md

@@ -8,6 +8,15 @@ awareness about deprecated code.
 
 # Upgrade to 3.5
 
+## Deprecated default PostgreSQL connection database.
+
+Relying on the DBAL connecting to the "postgres" database by default is deprecated. Unless you want to have the server
+determine the default database for the connection, specify the database name explicitly.
+
+## Deprecated the "default_dbname" parameter of the wrapper `Connection`.
+
+The "default_dbname" parameter of the wrapper `Connection` has been deprecated. Use "dbname" instead.
+
 ## Deprecated the "platform" parameter of the wrapper `Connection`.
 
 The "platform" parameter of the wrapper `Connection` has been deprecated. Use a driver middleware that would instantiate

docs/en/reference/configuration.rst

@@ -203,8 +203,6 @@ pdo_pgsql
 -  ``dbname`` (string): Name of the database/schema to connect to.
 -  ``charset`` (string): The charset used when connecting to the
    database.
--  ``default_dbname`` (string): Override the default database (postgres)
-   to connect to.
 -  ``sslmode`` (string): Determines whether or with what priority
    a SSL TCP/IP connection will be negotiated with the server.
    See the list of available modes:

src/Driver/PDO/PgSQL/Driver.php

@@ -5,6 +5,7 @@
 use Doctrine\DBAL\Driver\AbstractPostgreSQLDriver;
 use Doctrine\DBAL\Driver\PDO\Connection;
 use Doctrine\DBAL\Driver\PDO\Exception;
+use Doctrine\Deprecations\Deprecation;
 use PDO;
 use PDOException;
 
@@ -73,11 +74,25 @@ private function constructPdoDsn(array $params): string
         if (isset($params['dbname'])) {
             $dsn .= 'dbname=' . $params['dbname'] . ';';
         } elseif (isset($params['default_dbname'])) {
+            Deprecation::trigger(
+                'doctrine/dbal',
+                'https://github.com/doctrine/dbal/pull/5705',
+                'The "default_dbname" connection parameter is deprecated. Use "dbname" instead.',
+            );
+
             $dsn .= 'dbname=' . $params['default_dbname'] . ';';
         } else {
+            if (isset($params['user']) && $params['user'] !== 'postgres') {
+                Deprecation::trigger(
+                    'doctrine/dbal',
+                    'https://github.com/doctrine/dbal/pull/5705',
+                    'Relying on the DBAL connecting to the "postgres" database by default is deprecated.'
+                        . ' Unless you want to have the server determine the default database for the connection,'
+                        . ' specify the database name explicitly.',
+                );
+            }
+
             // Used for temporary connections to allow operations like dropping the database currently connected to.
-            // Connecting without an explicit database does not work, therefore "postgres" database is used
-            // as it is mostly present in every server setup.
             $dsn .= 'dbname=postgres;';
         }