function Schema::renameTable

Overrides Schema::renameTable

File

core/modules/pgsql/src/Driver/Database/pgsql/Schema.php, line 556

Class

Schema

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

Namespace

Code

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.
    $table_name = $this->connection
        ->getPrefix() . $table;
    // 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' => $this->defaultSchema,
        ':table' => $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 (str_contains($index->indexname, 'drupal_')) {
            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($table_name) . '__(.*)__' . preg_quote($index_type) . '/', $index->indexname, $matches);
            $index_name = $matches[1];
        }
        // The renaming of an index will fail when the there exists an table with
        // the same name as the renamed index.
        if (!$this->tableExists($this->ensureIdentifiersLength($new_name, $index_name, $index_type), FALSE)) {
            $this->connection
                ->query('ALTER INDEX "' . $this->defaultSchema . '"."' . $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('" . $this->defaultSchema . '.' . $table_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);
}