W3cubDocs

/Drupal 8

public function Schema::renameTable

public Schema::renameTable($table, $new_name)

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/mysql/Schema.php, line 369

Class

Schema
MySQL implementation of \Drupal\Core\Database\Schema.

Namespace

Drupal\Core\Database\Driver\mysql

Code

public function renameTable($table, $new_name) {
  if (!$this->tableExists($table)) {
    throw new SchemaObjectDoesNotExistException(t("Cannot rename @table to @table_new: table @table doesn't exist.", array('@table' => $table, '@table_new' => $new_name)));
  }
  if ($this->tableExists($new_name)) {
    throw new SchemaObjectExistsException(t("Cannot rename @table to @table_new: table @table_new already exists.", array('@table' => $table, '@table_new' => $new_name)));
  }

  $info = $this->getPrefixInfo($new_name);
  return $this->connection->query('ALTER TABLE {' . $table . '} RENAME TO `' . $info['table'] . '`');
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Database!Driver!mysql!Schema.php/function/Schema::renameTable/8.1.x