vendor/doctrine/dbal/src/Driver/PDO/PgSQL/Driver.php line 41

Open in your IDE?
  1. <?php
  3. namespace Doctrine\DBAL\Driver\PDO\PgSQL;
  5. use Doctrine\DBAL\Driver\AbstractPostgreSQLDriver;
  6. use Doctrine\DBAL\Driver\PDO\Connection;
  7. use Doctrine\DBAL\Driver\PDO\Exception;
  8. use Doctrine\Deprecations\Deprecation;
  9. use PDO;
  10. use PDOException;
  11. use SensitiveParameter;
  13. final class Driver extends AbstractPostgreSQLDriver
  14. {
  15.     /**
  16.      * {@inheritDoc}
  17.      *
  18.      * @return Connection
  19.      */
  20.     public function connect(
  21.         #[SensitiveParameter]
  22.         array $params
  23.     ) {
  24.         $driverOptions = $params['driverOptions'] ?? [];
  26.         if (! empty($params['persistent'])) {
  27.             $driverOptions[PDO::ATTR_PERSISTENT] = true;
  28.         }
  30.         $safeParams = $params;
  31.         unset($safeParams['password'], $safeParams['url']);
  33.         try {
  34.             $pdo = new PDO(
  35.                 $this->constructPdoDsn($safeParams),
  36.                 $params['user'] ?? '',
  37.                 $params['password'] ?? '',
  38.                 $driverOptions,
  39.             );
  40.         } catch (PDOException $exception) {
  41.             throw Exception::new($exception);
  42.         }
  44.         if (
  45.             ! isset($driverOptions[PDO::PGSQL_ATTR_DISABLE_PREPARES])
  46.             || $driverOptions[PDO::PGSQL_ATTR_DISABLE_PREPARES] === true
  47.         ) {
  48.             $pdo->setAttribute(PDO::PGSQL_ATTR_DISABLE_PREPARES, true);
  49.         }
  51.         $connection = new Connection($pdo);
  53.         /* defining client_encoding via SET NAMES to avoid inconsistent DSN support
  54.          * - passing client_encoding via the 'options' param breaks pgbouncer support
  55.          */
  56.         if (isset($params['charset'])) {
  57.             $connection->exec('SET NAMES \'' . $params['charset'] . '\'');
  58.         }
  60.         return $connection;
  61.     }
  63.     /**
  64.      * Constructs the Postgres PDO DSN.
  65.      *
  66.      * @param array<string, mixed> $params
  67.      */
  68.     private function constructPdoDsn(array $params): string
  69.     {
  70.         $dsn = 'pgsql:';
  72.         if (isset($params['host']) && $params['host'] !== '') {
  73.             $dsn .= 'host=' . $params['host'] . ';';
  74.         }
  76.         if (isset($params['port']) && $params['port'] !== '') {
  77.             $dsn .= 'port=' . $params['port'] . ';';
  78.         }
  80.         if (isset($params['dbname'])) {
  81.             $dsn .= 'dbname=' . $params['dbname'] . ';';
  82.         } elseif (isset($params['default_dbname'])) {
  83.             Deprecation::trigger(
  84.                 'doctrine/dbal',
  85.                 'https://github.com/doctrine/dbal/pull/5705',
  86.                 'The "default_dbname" connection parameter is deprecated. Use "dbname" instead.',
  87.             );
  89.             $dsn .= 'dbname=' . $params['default_dbname'] . ';';
  90.         } else {
  91.             if (isset($params['user']) && $params['user'] !== 'postgres') {
  92.                 Deprecation::trigger(
  93.                     'doctrine/dbal',
  94.                     'https://github.com/doctrine/dbal/pull/5705',
  95.                     'Relying on the DBAL connecting to the "postgres" database by default is deprecated.'
  96.                         . ' Unless you want to have the server determine the default database for the connection,'
  97.                         . ' specify the database name explicitly.',
  98.                 );
  99.             }
  101.             // Used for temporary connections to allow operations like dropping the database currently connected to.
  102.             $dsn .= 'dbname=postgres;';
  103.         }
  105.         if (isset($params['sslmode'])) {
  106.             $dsn .= 'sslmode=' . $params['sslmode'] . ';';
  107.         }
  109.         if (isset($params['sslrootcert'])) {
  110.             $dsn .= 'sslrootcert=' . $params['sslrootcert'] . ';';
  111.         }
  113.         if (isset($params['sslcert'])) {
  114.             $dsn .= 'sslcert=' . $params['sslcert'] . ';';
  115.         }
  117.         if (isset($params['sslkey'])) {
  118.             $dsn .= 'sslkey=' . $params['sslkey'] . ';';
  119.         }
  121.         if (isset($params['sslcrl'])) {
  122.             $dsn .= 'sslcrl=' . $params['sslcrl'] . ';';
  123.         }
  125.         if (isset($params['application_name'])) {
  126.             $dsn .= 'application_name=' . $params['application_name'] . ';';
  127.         }
  129.         if (isset($params['gssencmode'])) {
  130.             $dsn .= 'gssencmode=' . $params['gssencmode'] . ';';
  131.         }
  133.         return $dsn;
  134.     }
  135. }