public function DatabaseSchema_mysql::addField

Add a new field to a table.

Parameters

string $table: Name of the table to be altered.

string $field: Name of the field to be added.

array $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.

array $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.

Return value

void:

Throws

DatabaseSchemaObjectDoesNotExistException If the specified table doesn't exist.

DatabaseSchemaObjectExistsException If the specified table already has a field by that name.

Overrides DatabaseSchema::addField

File

core/includes/database/mysql/schema.inc, line 351

Database schema code for MySQL database servers.

Class

DatabaseSchema_mysql

Class to create and manipulate MySQL tables.

Code

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

  $fix_null = FALSE;
  if (!empty($spec['not null']) && !isset($spec['default'])) {
    $fix_null = TRUE;
    $spec['not null'] = FALSE;
  }
  $query = 'ALTER TABLE {' . $table . '} ADD ';
  $query .= $this->createFieldSql($field, $this->processField($spec));
  if ($keys_sql = $this->createKeysSql($keys_new)) {
    $query .= ', ADD ' . implode(', ADD ', $keys_sql);
  }
  $this->connection->query($query);
  if (isset($spec['initial'])) {
    $this->connection->update($table)
      ->fields(array($field => $spec['initial']))
      ->execute();
  }
  if ($fix_null) {
    $spec['not null'] = TRUE;
    $this->changeField($table, $field, $field, $spec);
  }
}