function Schema::addField

Overrides Schema::addField

File

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

Class

Schema

PostgreSQL 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 addField($table, $field, $spec, $new_keys = []) {
    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($new_keys['primary key']) && in_array($field, $new_keys['primary key'], TRUE);
    if ($is_primary_key) {
        $this->ensureNotNullPrimaryKey($new_keys['primary key'], [
            $field => $spec,
        ]);
    }
    $fix_null = FALSE;
    if (!empty($spec['not null']) && !isset($spec['default']) && !$is_primary_key) {
        $fix_null = TRUE;
        $spec['not null'] = FALSE;
    }
    $query = 'ALTER TABLE {' . $table . '} ADD COLUMN ';
    $query .= $this->createFieldSql($field, $this->processField($spec));
    $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 ($fix_null) {
        $this->connection
            ->query("ALTER TABLE {" . $table . "} ALTER {$field} SET NOT NULL");
    }
    if (isset($new_keys)) {
        // 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($new_keys['primary key']) && $this->constraintExists($table, 'pkey')) {
            $this->dropPrimaryKey($table);
        }
        $this->_createKeys($table, $new_keys);
    }
    // Add column comment.
    if (!empty($spec['description'])) {
        $this->connection
            ->query('COMMENT ON COLUMN {' . $table . '}.' . $field . ' IS ' . $this->prepareComment($spec['description']));
    }
    $this->resetTableInformation($table);
}