Inconsistent and unspecified behavior of Connection::getDatabase()

[morozov]

Q	A
BC Break	no
Version	2.9.3

The Connection::getDatabase() method description looks like following:

dbal/lib/Doctrine/DBAL/Connection.php

Lines 232 to 233 in 6820036

	/**
	* Gets the name of the database this Connection is connected to.

This is a bit unclear and doesn't always work in the same way.

1. Depending on the connection parameters

Consider the example:

$conn = DriverManager::getConnection([
    'driver' => 'mysqli',
    'host' => 'localhost',
    'user' => 'root',
]);

var_dump($conn->getDatabase());
// NULL
$conn->exec('USE doctrine');
var_dump($conn->getDatabase());
// string(8) "doctrine"
$conn->exec('USE mysql');
var_dump($conn->getDatabase());
// string(5) "mysql"

The above looks correct since it returns the currently selected database.

Here's another example:

$conn = DriverManager::getConnection([
    'driver' => 'mysqli',
    'host' => 'localhost',
    'user' => 'root',
    'dbname' => 'doctrine',
]);

var_dump($conn->getDatabase());
// string(8) "doctrine"
$conn->exec('USE mysql');
var_dump($conn->getDatabase());
// string(8) "doctrine"

Here, it always returns the originally selected database.

This behavior is consistent across drivers. They all try to use the value from the configuration and fall back to the value reported by the connection which causes the inconsistency.

2. Depending on the authentication method

Most of the drivers support external authentication where most if not all connection parameters including username and database can be omitted and will be picked up by the driver from another place (e.g. php.ini, OS configuration, etc).

For instance, in order to connect to an Oracle database via oci8 using external authentication, one needs to specify / as the user name. If Connection::getDatabase() is called on such a connection, it will return /, not the current database. The same example can be made for most of the supported drivers.

[morozov]

Fixed by #3606.

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.