function Schema::addField

Overrides Schema::addField

File

core/lib/Drupal/Core/Database/Driver/mysql/Schema.php, line 409

Class

Schema

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

Namespace

Code

public function addField($table, $field, $spec, $keys_new = []) {
    if (!$this->tableExists($table)) {
        throw new SchemaObjectDoesNotExistException("Cannot add field '{$table}.{$field}': table doesn't exist.");
    }
    if ($this->fieldExists($table, $field)) {
        throw new SchemaObjectExistsException("Cannot add field '{$table}.{$field}': field already exists.");
    }
    // Fields that are part of a PRIMARY KEY must be added as NOT NULL.
    $is_primary_key = isset($keys_new['primary key']) && in_array($field, $keys_new['primary key'], TRUE);
    if ($is_primary_key) {
        $this->ensureNotNullPrimaryKey($keys_new['primary key'], [
            $field => $spec,
        ]);
    }
    $fixnull = FALSE;
    if (!empty($spec['not null']) && !isset($spec['default']) && !$is_primary_key) {
        $fixnull = TRUE;
        $spec['not null'] = FALSE;
    }
    $query = 'ALTER TABLE {' . $table . '} ADD ';
    $query .= $this->createFieldSql($field, $this->processField($spec));
    if ($keys_sql = $this->createKeysSql($keys_new)) {
        // Make sure to drop the existing primary key before adding a new one.
        // This is only needed when adding a field because this method, unlike
        // changeField(), is supposed to handle primary keys automatically.
        if (isset($keys_new['primary key']) && $this->indexExists($table, 'PRIMARY')) {
            $query .= ', DROP PRIMARY KEY';
        }
        $query .= ', ADD ' . implode(', ADD ', $keys_sql);
    }
    $this->connection
        ->query($query);
    if (isset($spec['initial_from_field'])) {
        if (isset($spec['initial'])) {
            $expression = 'COALESCE(' . $spec['initial_from_field'] . ', :default_initial_value)';
            $arguments = [
                ':default_initial_value' => $spec['initial'],
            ];
        }
        else {
            $expression = $spec['initial_from_field'];
            $arguments = [];
        }
        $this->connection
            ->update($table)
            ->expression($field, $expression, $arguments)
            ->execute();
    }
    elseif (isset($spec['initial'])) {
        $this->connection
            ->update($table)
            ->fields([
            $field => $spec['initial'],
        ])
            ->execute();
    }
    if ($fixnull) {
        $spec['not null'] = TRUE;
        $this->changeField($table, $field, $field, $spec);
    }
}