public function Schema::renameTable in Drupal 9
Same name in this branch
- 9 core/lib/Drupal/Core/Database/Schema.php \Drupal\Core\Database\Schema::renameTable()
- 9 core/lib/Drupal/Core/Database/Driver/sqlite/Schema.php \Drupal\Core\Database\Driver\sqlite\Schema::renameTable()
- 9 core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php \Drupal\Core\Database\Driver\pgsql\Schema::renameTable()
- 9 core/lib/Drupal/Core/Database/Driver/mysql/Schema.php \Drupal\Core\Database\Driver\mysql\Schema::renameTable()
- 9 core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/Schema.php \Drupal\corefake\Driver\Database\corefakeWithAllCustomClasses\Schema::renameTable()
Same name and namespace in other branches
- 8 core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php \Drupal\Core\Database\Driver\pgsql\Schema::renameTable()
Rename a table.
Parameters
$table: The table to be renamed.
$new_name: The new name for the table.
Throws
\Drupal\Core\Database\SchemaObjectDoesNotExistException If the specified table doesn't exist.
\Drupal\Core\Database\SchemaObjectExistsException If a table with the specified new name already exists.
Overrides Schema::renameTable
File
- core/
lib/ Drupal/ Core/ Database/ Driver/ pgsql/ Schema.php, line 559
Class
- Schema
- PostgreSQL implementation of \Drupal\Core\Database\Schema.
Namespace
Drupal\Core\Database\Driver\pgsqlCode
public function renameTable($table, $new_name) {
if (!$this
->tableExists($table)) {
throw new SchemaObjectDoesNotExistException("Cannot rename '{$table}' to '{$new_name}': table '{$table}' doesn't exist.");
}
if ($this
->tableExists($new_name)) {
throw new SchemaObjectExistsException("Cannot rename '{$table}' to '{$new_name}': table '{$new_name}' already exists.");
}
// Get the schema and tablename for the old table.
$old_full_name = str_replace('"', '', $this->connection
->prefixTables('{' . $table . '}'));
list($old_schema, $old_table_name) = strpos($old_full_name, '.') ? explode('.', $old_full_name) : [
'public',
$old_full_name,
];
// Index names and constraint names are global in PostgreSQL, so we need to
// rename them when renaming the table.
$indexes = $this->connection
->query('SELECT indexname FROM pg_indexes WHERE schemaname = :schema AND tablename = :table', [
':schema' => $old_schema,
':table' => $old_table_name,
]);
foreach ($indexes as $index) {
// Get the index type by suffix, e.g. idx/key/pkey
$index_type = substr($index->indexname, strrpos($index->indexname, '_') + 1);
// If the index is already rewritten by ensureIdentifiersLength() to not
// exceed the 63 chars limit of PostgreSQL, we need to take care of that.
// cSpell:disable-next-line
// Example (drupal_Gk7Su_T1jcBHVuvSPeP22_I3Ni4GrVEgTYlIYnBJkro_idx).
if (strpos($index->indexname, 'drupal_') !== FALSE) {
preg_match('/^drupal_(.*)_' . preg_quote($index_type) . '/', $index->indexname, $matches);
$index_name = $matches[1];
}
else {
// Make sure to remove the suffix from index names, because
// $this->ensureIdentifiersLength() will add the suffix again and thus
// would result in a wrong index name.
preg_match('/^' . preg_quote($old_full_name) . '__(.*)__' . preg_quote($index_type) . '/', $index->indexname, $matches);
$index_name = $matches[1];
}
$this->connection
->query('ALTER INDEX "' . $index->indexname . '" RENAME TO ' . $this
->ensureIdentifiersLength($new_name, $index_name, $index_type) . '');
}
// Ensure the new table name does not include schema syntax.
$prefixInfo = $this
->getPrefixInfo($new_name);
// Rename sequences if the table contains serial fields.
$info = $this
->queryTableInformation($table);
if (!empty($info->serial_fields)) {
foreach ($info->serial_fields as $field) {
// The initial name of the sequence is generated automatically by
// PostgreSQL when the table is created, so we need to use
// pg_get_serial_sequence() to retrieve it.
$old_sequence = $this->connection
->query("SELECT pg_get_serial_sequence('" . $old_full_name . "', '" . $field . "')")
->fetchField();
// If the new sequence name exceeds the maximum identifier length limit,
// it will not match the pattern that is automatically applied by
// PostgreSQL on table creation, but that's ok because
// pg_get_serial_sequence() will return our non-standard name on
// subsequent table renames.
$new_sequence = $this
->ensureIdentifiersLength($new_name, $field, 'seq', '_');
$this->connection
->query('ALTER SEQUENCE ' . $old_sequence . ' RENAME TO ' . $new_sequence);
}
}
// Now rename the table.
$this->connection
->query('ALTER TABLE {' . $table . '} RENAME TO ' . $prefixInfo['table']);
$this
->resetTableInformation($table);
}