webmaster@1: $field) { webmaster@1: $sql .= _db_create_field_sql($field_name, _db_process_field($field)) .", \n"; webmaster@1: } webmaster@1: webmaster@1: // Process keys & indexes. webmaster@1: $keys = _db_create_keys_sql($table); webmaster@1: if (count($keys)) { webmaster@1: $sql .= implode(", \n", $keys) .", \n"; webmaster@1: } webmaster@1: webmaster@1: // Remove the last comma and space. webmaster@1: $sql = substr($sql, 0, -3) ."\n) "; webmaster@1: webmaster@1: $sql .= $table['mysql_suffix']; webmaster@1: webmaster@1: return array($sql); webmaster@1: } webmaster@1: webmaster@1: function _db_create_keys_sql($spec) { webmaster@1: $keys = array(); webmaster@1: webmaster@1: if (!empty($spec['primary key'])) { webmaster@1: $keys[] = 'PRIMARY KEY ('. _db_create_key_sql($spec['primary key']) .')'; webmaster@1: } webmaster@1: if (!empty($spec['unique keys'])) { webmaster@1: foreach ($spec['unique keys'] as $key => $fields) { webmaster@1: $keys[] = 'UNIQUE KEY '. $key .' ('. _db_create_key_sql($fields) .')'; webmaster@1: } webmaster@1: } webmaster@1: if (!empty($spec['indexes'])) { webmaster@1: foreach ($spec['indexes'] as $index => $fields) { webmaster@1: $keys[] = 'INDEX '. $index .' ('. _db_create_key_sql($fields) .')'; webmaster@1: } webmaster@1: } webmaster@1: webmaster@1: return $keys; webmaster@1: } webmaster@1: webmaster@1: function _db_create_key_sql($fields) { webmaster@1: $ret = array(); webmaster@1: foreach ($fields as $field) { webmaster@1: if (is_array($field)) { webmaster@1: $ret[] = $field[0] .'('. $field[1] .')'; webmaster@1: } webmaster@1: else { webmaster@1: $ret[] = $field; webmaster@1: } webmaster@1: } webmaster@1: return implode(', ', $ret); webmaster@1: } webmaster@1: webmaster@1: /** webmaster@1: * Set database-engine specific properties for a field. webmaster@1: * webmaster@1: * @param $field webmaster@1: * A field description array, as specified in the schema documentation. webmaster@1: */ webmaster@1: function _db_process_field($field) { webmaster@1: webmaster@1: if (!isset($field['size'])) { webmaster@1: $field['size'] = 'normal'; webmaster@1: } webmaster@1: webmaster@1: // Set the correct database-engine specific datatype. webmaster@1: if (!isset($field['mysql_type'])) { webmaster@1: $map = db_type_map(); webmaster@1: $field['mysql_type'] = $map[$field['type'] .':'. $field['size']]; webmaster@1: } webmaster@1: webmaster@1: if ($field['type'] == 'serial') { webmaster@1: $field['auto_increment'] = TRUE; webmaster@1: } webmaster@1: webmaster@1: return $field; webmaster@1: } webmaster@1: webmaster@1: /** webmaster@1: * Create an SQL string for a field to be used in table creation or alteration. webmaster@1: * webmaster@1: * Before passing a field out of a schema definition into this function it has webmaster@1: * to be processed by _db_process_field(). webmaster@1: * webmaster@1: * @param $name webmaster@1: * Name of the field. webmaster@1: * @param $spec webmaster@1: * The field specification, as per the schema data structure format. webmaster@1: */ webmaster@1: function _db_create_field_sql($name, $spec) { webmaster@1: $sql = "`". $name ."` ". $spec['mysql_type']; webmaster@1: webmaster@1: if (isset($spec['length'])) { webmaster@1: $sql .= '('. $spec['length'] .')'; webmaster@1: } webmaster@1: elseif (isset($spec['precision']) && isset($spec['scale'])) { webmaster@1: $sql .= '('. $spec['precision'] .', '. $spec['scale'] .')'; webmaster@1: } webmaster@1: webmaster@1: if (!empty($spec['unsigned'])) { webmaster@1: $sql .= ' unsigned'; webmaster@1: } webmaster@1: webmaster@1: if (!empty($spec['not null'])) { webmaster@1: $sql .= ' NOT NULL'; webmaster@1: } webmaster@1: webmaster@1: if (!empty($spec['auto_increment'])) { webmaster@1: $sql .= ' auto_increment'; webmaster@1: } webmaster@1: webmaster@1: if (isset($spec['default'])) { webmaster@1: if (is_string($spec['default'])) { webmaster@1: $spec['default'] = "'". $spec['default'] ."'"; webmaster@1: } webmaster@1: $sql .= ' DEFAULT '. $spec['default']; webmaster@1: } webmaster@1: webmaster@1: if (empty($spec['not null']) && !isset($spec['default'])) { webmaster@1: $sql .= ' DEFAULT NULL'; webmaster@1: } webmaster@1: webmaster@1: return $sql; webmaster@1: } webmaster@1: webmaster@1: /** webmaster@1: * This maps a generic data type in combination with its data size webmaster@1: * to the engine-specific data type. webmaster@1: */ webmaster@1: function db_type_map() { webmaster@1: // Put :normal last so it gets preserved by array_flip. This makes webmaster@1: // it much easier for modules (such as schema.module) to map webmaster@1: // database types back into schema types. webmaster@1: $map = array( webmaster@1: 'varchar:normal' => 'VARCHAR', webmaster@1: 'char:normal' => 'CHAR', webmaster@1: webmaster@1: 'text:tiny' => 'TINYTEXT', webmaster@1: 'text:small' => 'TINYTEXT', webmaster@1: 'text:medium' => 'MEDIUMTEXT', webmaster@1: 'text:big' => 'LONGTEXT', webmaster@1: 'text:normal' => 'TEXT', webmaster@1: webmaster@1: 'serial:tiny' => 'TINYINT', webmaster@1: 'serial:small' => 'SMALLINT', webmaster@1: 'serial:medium' => 'MEDIUMINT', webmaster@1: 'serial:big' => 'BIGINT', webmaster@1: 'serial:normal' => 'INT', webmaster@1: webmaster@1: 'int:tiny' => 'TINYINT', webmaster@1: 'int:small' => 'SMALLINT', webmaster@1: 'int:medium' => 'MEDIUMINT', webmaster@1: 'int:big' => 'BIGINT', webmaster@1: 'int:normal' => 'INT', webmaster@1: webmaster@1: 'float:tiny' => 'FLOAT', webmaster@1: 'float:small' => 'FLOAT', webmaster@1: 'float:medium' => 'FLOAT', webmaster@1: 'float:big' => 'DOUBLE', webmaster@1: 'float:normal' => 'FLOAT', webmaster@1: webmaster@1: 'numeric:normal' => 'DECIMAL', webmaster@1: webmaster@1: 'blob:big' => 'LONGBLOB', webmaster@1: 'blob:normal' => 'BLOB', webmaster@1: webmaster@1: 'datetime:normal' => 'DATETIME', webmaster@1: ); webmaster@1: return $map; webmaster@1: } webmaster@1: webmaster@1: /** webmaster@1: * Rename a table. webmaster@1: * webmaster@1: * @param $ret webmaster@1: * Array to which query results will be added. webmaster@1: * @param $table webmaster@1: * The table to be renamed. webmaster@1: * @param $new_name webmaster@1: * The new name for the table. webmaster@1: */ webmaster@1: function db_rename_table(&$ret, $table, $new_name) { webmaster@1: $ret[] = update_sql('ALTER TABLE {'. $table .'} RENAME TO {'. $new_name .'}'); webmaster@1: } webmaster@1: webmaster@1: /** webmaster@1: * Drop a table. webmaster@1: * webmaster@1: * @param $ret webmaster@1: * Array to which query results will be added. webmaster@1: * @param $table webmaster@1: * The table to be dropped. webmaster@1: */ webmaster@1: function db_drop_table(&$ret, $table) { webmaster@1: $ret[] = update_sql('DROP TABLE {'. $table .'}'); webmaster@1: } webmaster@1: webmaster@1: /** webmaster@1: * Add a new field to a table. webmaster@1: * webmaster@1: * @param $ret webmaster@1: * Array to which query results will be added. webmaster@1: * @param $table webmaster@1: * Name of the table to be altered. webmaster@1: * @param $field webmaster@1: * Name of the field to be added. webmaster@1: * @param $spec webmaster@1: * The field specification array, as taken from a schema definition. webmaster@1: * The specification may also contain the key 'initial', the newly webmaster@1: * created field will be set to the value of the key in all rows. webmaster@1: * This is most useful for creating NOT NULL columns with no default webmaster@1: * value in existing tables. webmaster@1: * @param $keys_new webmaster@1: * Optional keys and indexes specification to be created on the webmaster@1: * table along with adding the field. The format is the same as a webmaster@1: * table specification but without the 'fields' element. If you are webmaster@1: * adding a type 'serial' field, you MUST specify at least one key webmaster@1: * or index including it in this array. @see db_change_field for more webmaster@1: * explanation why. webmaster@1: */ webmaster@1: function db_add_field(&$ret, $table, $field, $spec, $keys_new = array()) { webmaster@1: $fixnull = FALSE; webmaster@1: if (!empty($spec['not null']) && !isset($spec['default'])) { webmaster@1: $fixnull = TRUE; webmaster@1: $spec['not null'] = FALSE; webmaster@1: } webmaster@1: $query = 'ALTER TABLE {'. $table .'} ADD '; webmaster@1: $query .= _db_create_field_sql($field, _db_process_field($spec)); webmaster@1: if (count($keys_new)) { webmaster@1: $query .= ', ADD '. implode(', ADD ', _db_create_keys_sql($keys_new)); webmaster@1: } webmaster@1: $ret[] = update_sql($query); webmaster@1: if (isset($spec['initial'])) { webmaster@1: // All this because update_sql does not support %-placeholders. webmaster@1: $sql = 'UPDATE {'. $table .'} SET '. $field .' = '. db_type_placeholder($spec['type']); webmaster@1: $result = db_query($sql, $spec['initial']); webmaster@1: $ret[] = array('success' => $result !== FALSE, 'query' => check_plain($sql .' ('. $spec['initial'] .')')); webmaster@1: } webmaster@1: if ($fixnull) { webmaster@1: $spec['not null'] = TRUE; webmaster@1: db_change_field($ret, $table, $field, $field, $spec); webmaster@1: } webmaster@1: } webmaster@1: webmaster@1: /** webmaster@1: * Drop a field. webmaster@1: * webmaster@1: * @param $ret webmaster@1: * Array to which query results will be added. webmaster@1: * @param $table webmaster@1: * The table to be altered. webmaster@1: * @param $field webmaster@1: * The field to be dropped. webmaster@1: */ webmaster@1: function db_drop_field(&$ret, $table, $field) { webmaster@1: $ret[] = update_sql('ALTER TABLE {'. $table .'} DROP '. $field); webmaster@1: } webmaster@1: webmaster@1: /** webmaster@1: * Set the default value for a field. webmaster@1: * webmaster@1: * @param $ret webmaster@1: * Array to which query results will be added. webmaster@1: * @param $table webmaster@1: * The table to be altered. webmaster@1: * @param $field webmaster@1: * The field to be altered. webmaster@1: * @param $default webmaster@1: * Default value to be set. NULL for 'default NULL'. webmaster@1: */ webmaster@1: function db_field_set_default(&$ret, $table, $field, $default) { webmaster@1: if ($default == NULL) { webmaster@1: $default = 'NULL'; webmaster@1: } webmaster@1: else { webmaster@1: $default = is_string($default) ? "'$default'" : $default; webmaster@1: } webmaster@1: webmaster@1: $ret[] = update_sql('ALTER TABLE {'. $table .'} ALTER COLUMN '. $field .' SET DEFAULT '. $default); webmaster@1: } webmaster@1: webmaster@1: /** webmaster@1: * Set a field to have no default value. webmaster@1: * webmaster@1: * @param $ret webmaster@1: * Array to which query results will be added. webmaster@1: * @param $table webmaster@1: * The table to be altered. webmaster@1: * @param $field webmaster@1: * The field to be altered. webmaster@1: */ webmaster@1: function db_field_set_no_default(&$ret, $table, $field) { webmaster@1: $ret[] = update_sql('ALTER TABLE {'. $table .'} ALTER COLUMN '. $field .' DROP DEFAULT'); webmaster@1: } webmaster@1: webmaster@1: /** webmaster@1: * Add a primary key. webmaster@1: * webmaster@1: * @param $ret webmaster@1: * Array to which query results will be added. webmaster@1: * @param $table webmaster@1: * The table to be altered. webmaster@1: * @param $fields webmaster@1: * Fields for the primary key. webmaster@1: */ webmaster@1: function db_add_primary_key(&$ret, $table, $fields) { webmaster@1: $ret[] = update_sql('ALTER TABLE {'. $table .'} ADD PRIMARY KEY ('. webmaster@1: _db_create_key_sql($fields) .')'); webmaster@1: } webmaster@1: webmaster@1: /** webmaster@1: * Drop the primary key. webmaster@1: * webmaster@1: * @param $ret webmaster@1: * Array to which query results will be added. webmaster@1: * @param $table webmaster@1: * The table to be altered. webmaster@1: */ webmaster@1: function db_drop_primary_key(&$ret, $table) { webmaster@1: $ret[] = update_sql('ALTER TABLE {'. $table .'} DROP PRIMARY KEY'); webmaster@1: } webmaster@1: webmaster@1: /** webmaster@1: * Add a unique key. webmaster@1: * webmaster@1: * @param $ret webmaster@1: * Array to which query results will be added. webmaster@1: * @param $table webmaster@1: * The table to be altered. webmaster@1: * @param $name webmaster@1: * The name of the key. webmaster@1: * @param $fields webmaster@1: * An array of field names. webmaster@1: */ webmaster@1: function db_add_unique_key(&$ret, $table, $name, $fields) { webmaster@1: $ret[] = update_sql('ALTER TABLE {'. $table .'} ADD UNIQUE KEY '. webmaster@1: $name .' ('. _db_create_key_sql($fields) .')'); webmaster@1: } webmaster@1: webmaster@1: /** webmaster@1: * Drop a unique key. webmaster@1: * webmaster@1: * @param $ret webmaster@1: * Array to which query results will be added. webmaster@1: * @param $table webmaster@1: * The table to be altered. webmaster@1: * @param $name webmaster@1: * The name of the key. webmaster@1: */ webmaster@1: function db_drop_unique_key(&$ret, $table, $name) { webmaster@1: $ret[] = update_sql('ALTER TABLE {'. $table .'} DROP KEY '. $name); webmaster@1: } webmaster@1: webmaster@1: /** webmaster@1: * Add an index. webmaster@1: * webmaster@1: * @param $ret webmaster@1: * Array to which query results will be added. webmaster@1: * @param $table webmaster@1: * The table to be altered. webmaster@1: * @param $name webmaster@1: * The name of the index. webmaster@1: * @param $fields webmaster@1: * An array of field names. webmaster@1: */ webmaster@1: function db_add_index(&$ret, $table, $name, $fields) { webmaster@1: $query = 'ALTER TABLE {'. $table .'} ADD INDEX '. $name .' ('. _db_create_key_sql($fields) .')'; webmaster@1: $ret[] = update_sql($query); webmaster@1: } webmaster@1: webmaster@1: /** webmaster@1: * Drop an index. webmaster@1: * webmaster@1: * @param $ret webmaster@1: * Array to which query results will be added. webmaster@1: * @param $table webmaster@1: * The table to be altered. webmaster@1: * @param $name webmaster@1: * The name of the index. webmaster@1: */ webmaster@1: function db_drop_index(&$ret, $table, $name) { webmaster@1: $ret[] = update_sql('ALTER TABLE {'. $table .'} DROP INDEX '. $name); webmaster@1: } webmaster@1: webmaster@1: /** webmaster@1: * Change a field definition. webmaster@1: * webmaster@1: * IMPORTANT NOTE: To maintain database portability, you have to explicitly webmaster@1: * recreate all indices and primary keys that are using the changed field. webmaster@1: * webmaster@1: * That means that you have to drop all affected keys and indexes with webmaster@1: * db_drop_{primary_key,unique_key,index}() before calling db_change_field(). webmaster@1: * To recreate the keys and indices, pass the key definitions as the webmaster@1: * optional $keys_new argument directly to db_change_field(). webmaster@1: * webmaster@1: * For example, suppose you have: webmaster@1: * @code webmaster@1: * $schema['foo'] = array( webmaster@1: * 'fields' => array( webmaster@1: * 'bar' => array('type' => 'int', 'not null' => TRUE) webmaster@1: * ), webmaster@1: * 'primary key' => array('bar') webmaster@1: * ); webmaster@1: * @endcode webmaster@1: * and you want to change foo.bar to be type serial, leaving it as the webmaster@1: * primary key. The correct sequence is: webmaster@1: * @code webmaster@1: * db_drop_primary_key($ret, 'foo'); webmaster@1: * db_change_field($ret, 'foo', 'bar', 'bar', webmaster@1: * array('type' => 'serial', 'not null' => TRUE), webmaster@1: * array('primary key' => array('bar'))); webmaster@1: * @endcode webmaster@1: * webmaster@1: * The reasons for this are due to the different database engines: webmaster@1: * webmaster@1: * On PostgreSQL, changing a field definition involves adding a new field webmaster@1: * and dropping an old one which* causes any indices, primary keys and webmaster@1: * sequences (from serial-type fields) that use the changed field to be dropped. webmaster@1: * webmaster@1: * On MySQL, all type 'serial' fields must be part of at least one key webmaster@1: * or index as soon as they are created. You cannot use webmaster@1: * db_add_{primary_key,unique_key,index}() for this purpose because webmaster@1: * the ALTER TABLE command will fail to add the column without a key webmaster@1: * or index specification. The solution is to use the optional webmaster@1: * $keys_new argument to create the key or index at the same time as webmaster@1: * field. webmaster@1: * webmaster@1: * You could use db_add_{primary_key,unique_key,index}() in all cases webmaster@1: * unless you are converting a field to be type serial. You can use webmaster@1: * the $keys_new argument in all cases. webmaster@1: * webmaster@1: * @param $ret webmaster@1: * Array to which query results will be added. webmaster@1: * @param $table webmaster@1: * Name of the table. webmaster@1: * @param $field webmaster@1: * Name of the field to change. webmaster@1: * @param $field_new webmaster@1: * New name for the field (set to the same as $field if you don't want to change the name). webmaster@1: * @param $spec webmaster@1: * The field specification for the new field. webmaster@1: * @param $keys_new webmaster@1: * Optional keys and indexes specification to be created on the webmaster@1: * table along with changing the field. The format is the same as a webmaster@1: * table specification but without the 'fields' element. webmaster@1: */ webmaster@1: webmaster@1: function db_change_field(&$ret, $table, $field, $field_new, $spec, $keys_new = array()) { webmaster@1: $sql = 'ALTER TABLE {'. $table .'} CHANGE '. $field .' '. webmaster@1: _db_create_field_sql($field_new, _db_process_field($spec)); webmaster@1: if (count($keys_new)) { webmaster@1: $sql .= ', ADD '. implode(', ADD ', _db_create_keys_sql($keys_new)); webmaster@1: } webmaster@1: $ret[] = update_sql($sql); webmaster@1: } webmaster@1: webmaster@1: /** webmaster@1: * Returns the last insert id. webmaster@1: * webmaster@1: * @param $table webmaster@1: * The name of the table you inserted into. webmaster@1: * @param $field webmaster@1: * The name of the autoincrement field. webmaster@1: */ webmaster@1: function db_last_insert_id($table, $field) { webmaster@1: return db_result(db_query('SELECT LAST_INSERT_ID()')); webmaster@1: }