How to rename a database table

dmitrii_fediuk · January 26, 2016, 9:48pm

Use the renameTable() method of the \Magento\Framework\DB\Adapter\AdapterInterface:

magento/magento2/blob/720667e/lib/internal/Magento/Framework/DB/Adapter/AdapterInterface.php#L239-L247


/**
 * Rename table
 *
 * @param string $oldTableName
 * @param string $newTableName
 * @param string $schemaName
 * @return boolean
 */
public function renameTable($oldTableName, $newTableName, $schemaName = null);

A usage example from the core:

github.com

magento/magento2/blob/720667e/app/code/Magento/Variable/Setup/InstallSchema.php#L30-L36


/**
 * Rename/Create table 'variable'
 */
$variableTableName = $installer->getTable('variable');
$coreVariableTableName = $installer->getTable('core_variable');
if ($installer->tableExists('core_variable')) {
    $connection->renameTable($coreVariableTableName, $variableTableName);

By default the \Magento\Framework\DB\Adapter\AdapterInterface interface is implemented by the \Magento\Framework\DB\Adapter\Pdo\Mysql class:

github.com

magento/magento2/blob/720667e/lib/internal/Magento/Framework/DB/Adapter/Pdo/Mysql.php#L2477-L2495


public function renameTable($oldTableName, $newTableName, $schemaName = null)
{
    if (!$this->isTableExists($oldTableName, $schemaName)) {
        throw new \Zend_Db_Exception(sprintf('Table "%s" is not exists', $oldTableName));
    }
    if ($this->isTableExists($newTableName, $schemaName)) {
        throw new \Zend_Db_Exception(sprintf('Table "%s" already exists', $newTableName));
    }


    $oldTable = $this->_getTableName($oldTableName, $schemaName);
    $newTable = $this->_getTableName($newTableName, $schemaName);


    $query = sprintf('ALTER TABLE %s RENAME TO %s', $oldTable, $newTable);
    $this->query($query);


    $this->resetDdlCache($oldTableName, $schemaName);


    return true;
}

dmitrii_fediuk · January 26, 2016, 9:51pm