function Schema::changeField

Overrides Schema::changeField

File

core/modules/sqlite/src/Driver/Database/sqlite/Schema.php, line 602

Class

Schema

SQLite implementation of <a href="/api/drupal/core%21lib%21Drupal%21Core%21Database%21Schema.php/class/Schema/11.x" title="Provides a base implementation for Database Schema." class="local">\Drupal\Core\Database\Schema</a>.

Namespace

Code

public function changeField($table, $field, $field_new, $spec, $keys_new = []) {
    if (!$this->fieldExists($table, $field)) {
        throw new SchemaObjectDoesNotExistException("Cannot change the definition of field '{$table}.{$field}': field doesn't exist.");
    }
    if ($field != $field_new && $this->fieldExists($table, $field_new)) {
        throw new SchemaObjectExistsException("Cannot rename field '{$table}.{$field}' to '{$field_new}': target field already exists.");
    }
    if (isset($keys_new['primary key']) && in_array($field_new, $keys_new['primary key'], TRUE)) {
        $this->ensureNotNullPrimaryKey($keys_new['primary key'], [
            $field_new => $spec,
        ]);
    }
    $old_schema = $this->introspectSchema($table);
    $new_schema = $old_schema;
    // Map the old field to the new field.
    if ($field != $field_new) {
        $mapping[$field_new] = $field;
    }
    else {
        $mapping = [];
    }
    // Remove the previous definition and swap in the new one.
    unset($new_schema['fields'][$field]);
    $new_schema['fields'][$field_new] = $spec;
    // Map the former indexes to the new column name.
    $new_schema['primary key'] = $this->mapKeyDefinition($new_schema['primary key'], $mapping);
    foreach ([
        'unique keys',
        'indexes',
    ] as $k) {
        foreach ($new_schema[$k] as &$key_definition) {
            $key_definition = $this->mapKeyDefinition($key_definition, $mapping);
        }
    }
    // Add in the keys from $keys_new.
    if (isset($keys_new['primary key'])) {
        $new_schema['primary key'] = $keys_new['primary key'];
    }
    foreach ([
        'unique keys',
        'indexes',
    ] as $k) {
        if (!empty($keys_new[$k])) {
            $new_schema[$k] = $keys_new[$k] + $new_schema[$k];
        }
    }
    $this->alterTable($table, $old_schema, $new_schema, $mapping);
}