DatabaseSchema::addField
abstract public function DatabaseSchema::addField
abstract public DatabaseSchema::addField($table, $field, $spec, $keys_new = 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
DatabaseSchemaObjectDoesNotExistException If the specified table doesn't exist.
DatabaseSchemaObjectExistsException If the specified table already has a field by that name.
File
- includes/database/schema.inc, line 434
- Generic Database schema code.
Class
Code
abstract public function addField($table, $field, $spec, $keys_new = array());
© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/includes!database!schema.inc/function/DatabaseSchema::addField/7.x