db_add_field
Definition
db_add_field(&$ret, $table, $field, $spec, $keys_new = array())
drupal/includes/database/database.inc, line 2044
Description
Add a new field to a table.
Parameters
$ret Array to which query results will be added.
$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.
Related topics
Name | Description |
|---|---|
| Schema API | A Drupal schema definition is an array structure representing one or more tables and their related keys and indexes. A schema is defined by hook_schema(), which usually lives in a modulename.install file. |
Code
function db_add_field(&$ret, $table, $field, $spec, $keys_new = array()) {
return Database::getActiveConnection()->schema()->addField($ret, $table, $field, $spec, $keys_new);
}