function Database::renameConnection
Same name in other branches
- 7.x includes/database/database.inc \Database::renameConnection()
- 9 core/lib/Drupal/Core/Database/Database.php \Drupal\Core\Database\Database::renameConnection()
- 10 core/lib/Drupal/Core/Database/Database.php \Drupal\Core\Database\Database::renameConnection()
- 11.x core/lib/Drupal/Core/Database/Database.php \Drupal\Core\Database\Database::renameConnection()
Rename a connection and its corresponding connection information.
Parameters
string $old_key: The old connection key.
string $new_key: The new connection key.
Return value
bool TRUE in case of success, FALSE otherwise.
7 calls to Database::renameConnection()
- KernelTestBase::getDatabaseConnectionInfo in core/
tests/ Drupal/ KernelTests/ KernelTestBase.php - Returns the Database connection info to be used for this test.
- MigrateTestBase::cleanupMigrateConnection in core/
modules/ migrate/ tests/ src/ Kernel/ MigrateTestBase.php - Cleans up the test migrate connection.
- MigrateTestBase::createMigrationConnection in core/
modules/ migrate/ tests/ src/ Kernel/ MigrateTestBase.php - Changes the database connection to the prefixed one.
- MigrationPluginListTest::testGetDefinitions in core/
modules/ migrate/ tests/ src/ Kernel/ Plugin/ MigrationPluginListTest.php - @covers ::getDefinitions
- SqlBaseTest::testConnectionTypes in core/
modules/ migrate/ tests/ src/ Kernel/ SqlBaseTest.php - Tests different connection types.
File
-
core/
lib/ Drupal/ Core/ Database/ Database.php, line 309
Class
- Database
- Primary front-controller for the database system.
Namespace
Drupal\Core\DatabaseCode
public static final function renameConnection($old_key, $new_key) {
if (!empty(self::$databaseInfo[$old_key]) && empty(self::$databaseInfo[$new_key])) {
// Migrate the database connection information.
self::$databaseInfo[$new_key] = self::$databaseInfo[$old_key];
unset(self::$databaseInfo[$old_key]);
// Migrate over the DatabaseConnection object if it exists.
if (isset(self::$connections[$old_key])) {
self::$connections[$new_key] = self::$connections[$old_key];
unset(self::$connections[$old_key]);
}
return TRUE;
}
else {
return FALSE;
}
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.