public function Schema::addField

public Schema::addField($table, $field, $spec, $new_keys = array())

Add a new field to a table.

Parameters

$table: Name of the table to be altered.

$field: Name of the field to be added.

$spec: The field specification array, as taken from a schema definition. The specification may also contain the key 'initial', the newly created field will be set to the value of the key in all rows. This is most useful for creating NOT NULL columns with no default value in existing tables.

$keys_new: (optional) Keys and indexes specification to be created on the table along with adding the field. The format is the same as a table specification but without the 'fields' element. If you are adding a type 'serial' field, you MUST specify at least one key or index including it in this array. See db_change_field() for more explanation why.

Throws

\Drupal\Core\Database\SchemaObjectDoesNotExistException If the specified table doesn't exist.

\Drupal\Core\Database\SchemaObjectExistsException If the specified table already has a field by that name.

Overrides Schema::addField

File

core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php, line 513

Class

Schema

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

Namespace

Drupal\Core\Database\Driver\pgsql

Code

public function addField($table, $field, $spec, $new_keys = array()) {
  if (!$this->tableExists($table)) {
    throw new SchemaObjectDoesNotExistException(t("Cannot add field @table.@field: table doesn't exist.", array('@field' => $field, '@table' => $table)));
  }
  if ($this->fieldExists($table, $field)) {
    throw new SchemaObjectExistsException(t("Cannot add field @table.@field: field already exists.", array('@field' => $field, '@table' => $table)));
  }

  $fixnull = FALSE;
  if (!empty($spec['not null']) && !isset($spec['default'])) {
    $fixnull = 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'])) {
    $this->connection->update($table)
      ->fields(array($field => $spec['initial']))
      ->execute();
  }
  if ($fixnull) {
    $this->connection->query("ALTER TABLE {" . $table . "} ALTER $field SET NOT NULL");
  }
  if (isset($new_keys)) {
    $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);
}