From c3972cf5069f709eba0644f97b75e2ce84db0a86 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=A1bor=20Hojtsy?= Date: Fri, 14 Sep 2007 17:46:32 +0000 Subject: [PATCH] #162432 by bjaspan and chx: serial columns need their keys defined in db_change_field() and friends in MySQL --- includes/database.mysql-common.inc | 125 ++++++++++++++++++++++------- includes/database.pgsql.inc | 95 +++++++++++++++++++--- modules/block/block.schema | 2 +- modules/system/system.install | 44 +++++----- update.php | 35 +++----- 5 files changed, 212 insertions(+), 89 deletions(-) diff --git a/includes/database.mysql-common.inc b/includes/database.mysql-common.inc index f56c321437..181039ec4b 100644 --- a/includes/database.mysql-common.inc +++ b/includes/database.mysql-common.inc @@ -6,11 +6,6 @@ * Functions shared between mysql and mysqli database engines. */ -/** - * @ingroup schemaapi - * @{ - */ - /** * Runs a basic query in the active database. * @@ -47,6 +42,11 @@ function db_query($query) { return _db_query($query); } +/** + * @ingroup schemaapi + * @{ + */ + /** * Generate SQL to create a new table from a Drupal schema definition. * @@ -71,16 +71,9 @@ function db_create_table_sql($name, $table) { } // Process keys & indexes. - if (!empty($table['primary key'])) { - $sql .= " PRIMARY KEY (". _db_create_key_sql($table['primary key']) ."), \n"; - } - if (!empty($table['unique keys'])) { - foreach ($table['unique keys'] as $key => $fields) - $sql .= " UNIQUE KEY $key (". _db_create_key_sql($fields) ."), \n"; - } - if (!empty($table['indexes'])) { - foreach ($table['indexes'] as $index => $fields) - $sql .= " INDEX $index (". _db_create_key_sql($fields) ."), \n"; + $keys = _db_create_keys_sql($table); + if (count($keys)) { + $sql .= implode(", \n", $keys) .", \n"; } // Remove the last comma and space. @@ -91,6 +84,26 @@ function db_create_table_sql($name, $table) { return array($sql); } +function _db_create_keys_sql($spec) { + $keys = array(); + + if (!empty($spec['primary key'])) { + $keys[] = 'PRIMARY KEY ('. _db_create_key_sql($spec['primary key']) .')'; + } + if (!empty($spec['unique keys'])) { + foreach ($spec['unique keys'] as $key => $fields) { + $keys[] = 'UNIQUE KEY '. $key .' ('. _db_create_key_sql($fields) .')'; + } + } + if (!empty($spec['indexes'])) { + foreach ($spec['indexes'] as $index => $fields) { + $keys[] = 'INDEX '. $index .' ('. _db_create_key_sql($fields) .')'; + } + } + + return $keys; +} + function _db_create_key_sql($fields) { $ret = array(); foreach ($fields as $field) { @@ -262,8 +275,15 @@ function db_drop_table(&$ret, $table) { * 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. + * @param $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. */ -function db_add_field(&$ret, $table, $field, $spec) { +function db_add_field(&$ret, $table, $field, $spec, $keys_new = array()) { $fixnull = FALSE; if (!empty($spec['not null']) && !isset($spec['default'])) { $fixnull = TRUE; @@ -271,6 +291,9 @@ function db_add_field(&$ret, $table, $field, $spec) { } $query = 'ALTER TABLE {'. $table .'} ADD '; $query .= _db_create_field_sql($field, _db_process_field($spec)); + if (count($keys_new)) { + $query .= ', ADD '. implode(', ADD ', _db_create_keys_sql($keys_new)); + } $ret[] = update_sql($query); if (isset($spec['initial'])) { // All this because update_sql does not support %-placeholders. @@ -427,14 +450,49 @@ function db_drop_index(&$ret, $table, $name) { /** * Change a field definition. * - * IMPORTANT NOTE: On some database systems (notably PostgreSQL), - * changing a field definition involves adding a new field and - * dropping an old one. This means that any indices, primary keys and - * sequences (from serial-type fields) that use the field to be - * changed get dropped. For database portability, you MUST drop them - * explicitly before calling db_change_field() and then re-create them - * afterwards. Use db_{add,drop}_{primary_key,unique_key,index} for - * this purpose. + * IMPORTANT NOTE: To maintain database portability, you have to explicitly + * recreate all indices and primary keys that are using the changed field. + * + * That means that you have to drop all affected keys and indexes with + * db_drop_{primary_key,unique_key,index}() before calling db_change_field(). + * To recreate the keys and indices, pass the key definitions as the + * optional $keys_new argument directly to db_change_field(). + * + * For example, suppose you have: + * @code + * $schema['foo'] = array( + * 'fields' => array( + * 'bar' => array('type' => 'int', 'not null' => TRUE) + * ), + * 'primary key' => array('bar') + * ); + * @endcode + * and you want to change foo.bar to be type serial, leaving it as the + * primary key. The correct sequence is: + * @code + * db_drop_primary_key($ret, 'foo'); + * db_change_field($ret, 'foo', 'bar', 'bar', + * array('type' => 'serial', 'not null' => TRUE), + * array('primary key' => array('bar'))); + * @endcode + * + * The reasons for this are due to the different database engines: + * + * On PostgreSQL, changing a field definition involves adding a new field + * and dropping an old one which* causes any indices, primary keys and + * sequences (from serial-type fields) that use the changed field to be dropped. + * + * On MySQL, all type 'serial' fields must be part of at least one key + * or index as soon as they are created. You cannot use + * db_add_{primary_key,unique_key,index}() for this purpose because + * the ALTER TABLE command will fail to add the column without a key + * or index specification. The solution is to use the optional + * $keys_new argument to create the key or index at the same time as + * field. + * + * You could use db_add_{primary_key,unique_key,index}() in all cases + * unless you are converting a field to be type serial. You can use + * the $keys_new argument in all cases. * * @param $ret * Array to which query results will be added. @@ -446,10 +504,19 @@ function db_drop_index(&$ret, $table, $name) { * New name for the field (set to the same as $field if you don't want to change the name). * @param $spec * The field specification for the new field. + * @param $keys_new + * Optional keys and indexes specification to be created on the + * table along with changing the field. The format is the same as a + * table specification but without the 'fields' element. */ -function db_change_field(&$ret, $table, $field, $field_new, $spec) { - $ret[] = update_sql("ALTER TABLE {". $table ."} CHANGE $field ". - _db_create_field_sql($field_new, _db_process_field($spec))); + +function db_change_field(&$ret, $table, $field, $field_new, $spec, $keys_new = array()) { + $sql = 'ALTER TABLE {'. $table .'} CHANGE '. $field .' '. + _db_create_field_sql($field_new, _db_process_field($spec)); + if (count($keys_new)) { + $sql .= ', ADD '.implode(', ADD ', _db_create_keys_sql($keys_new)); + } + $ret[] = update_sql($sql); } /** @@ -463,7 +530,3 @@ function db_change_field(&$ret, $table, $field, $field_new, $spec) { function db_last_insert_id($table, $field) { return db_result(db_query('SELECT LAST_INSERT_ID()')); } - -/** - * @} End of "ingroup schemaapi". - */ diff --git a/includes/database.pgsql.inc b/includes/database.pgsql.inc index 5778aac10a..ab2f591ad8 100644 --- a/includes/database.pgsql.inc +++ b/includes/database.pgsql.inc @@ -559,6 +559,22 @@ function _db_create_key_sql($fields) { return implode(', ', $ret); } +function _db_create_keys(&$ret, $table, $new_keys) { + if (isset($new_keys['primary key'])) { + db_add_primary_key($ret, $table, $new_keys['primary key']); + } + if (isset($new_keys['unique keys'])) { + foreach ($new_keys['unique keys'] as $name => $fields) { + db_add_unique_key($ret, $table, $name, $fields); + } + } + if (isset($new_keys['indexes'])) { + foreach ($new_keys['indexes'] as $name => $fields) { + db_add_index($ret, $table, $name, $fields); + } + } +} + /** * Set database-engine specific properties for a field. * @@ -665,8 +681,15 @@ function db_drop_table(&$ret, $table) { * 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. - */ -function db_add_field(&$ret, $table, $field, $spec) { + * @param $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. + */ +function db_add_field(&$ret, $table, $field, $spec, $new_keys = array()) { $fixnull = FALSE; if (!empty($spec['not null']) && !isset($spec['default'])) { $fixnull = TRUE; @@ -684,6 +707,9 @@ function db_add_field(&$ret, $table, $field, $spec) { if ($fixnull) { $ret[] = update_sql("ALTER TABLE {". $table ."} ALTER $field SET NOT NULL"); } + if (isset($new_keys)) { + _db_create_keys($ret, $table, $new_keys); + } } /** @@ -831,14 +857,49 @@ function db_drop_index(&$ret, $table, $name) { /** * Change a field definition. * - * IMPORTANT NOTE: On some database systems (notably PostgreSQL), - * changing a field definition involves adding a new field and - * dropping an old one. This means that any indices, primary keys and - * sequences (from serial-type fields) that use the field to be - * changed get dropped. For database portability, you MUST drop them - * explicitly before calling db_change_field() and then re-create them - * afterwards. Use db_{add,drop}_{primary_key,unique_key,index} for - * this purpose. + * IMPORTANT NOTE: To maintain database portability, you have to explicitly + * recreate all indices and primary keys that are using the changed field. + * + * That means that you have to drop all affected keys and indexes with + * db_drop_{primary_key,unique_key,index}() before calling db_change_field(). + * To recreate the keys and indices, pass the key definitions as the + * optional $new_keys argument directly to db_change_field(). + * + * For example, suppose you have: + * @code + * $schema['foo'] = array( + * 'fields' => array( + * 'bar' => array('type' => 'int', 'not null' => TRUE) + * ), + * 'primary key' => array('bar') + * ); + * @endcode + * and you want to change foo.bar to be type serial, leaving it as the + * primary key. The correct sequence is: + * @code + * db_drop_primary_key($ret, 'foo'); + * db_change_field($ret, 'foo', 'bar', 'bar', + * array('type' => 'serial', 'not null' => TRUE), + * array('primary key' => array('bar'))); + * @endcode + * + * The reasons for this are due to the different database engines: + * + * On PostgreSQL, changing a field definition involves adding a new field + * and dropping an old one which* causes any indices, primary keys and + * sequences (from serial-type fields) that use the changed field to be dropped. + * + * On MySQL, all type 'serial' fields must be part of at least one key + * or index as soon as they are created. You cannot use + * db_add_{primary_key,unique_key,index}() for this purpose because + * the ALTER TABLE command will fail to add the column without a key + * or index specification. The solution is to use the optional + * $new_keys argument to create the key or index at the same time as + * field. + * + * You could use db_add_{primary_key,unique_key,index}() in all cases + * unless you are converting a field to be type serial. You can use + * the $new_keys argument in all cases. * * @param $ret * Array to which query results will be added. @@ -850,17 +911,29 @@ function db_drop_index(&$ret, $table, $name) { * New name for the field (set to the same as $field if you don't want to change the name). * @param $spec * The field specification for the new field. + * @param $new_keys + * Optional keys and indexes specification to be created on the + * table along with changing the field. The format is the same as a + * table specification but without the 'fields' element. */ -function db_change_field(&$ret, $table, $field, $field_new, $spec) { +function db_change_field(&$ret, $table, $field, $field_new, $spec, $new_keys = array()) { $ret[] = update_sql("ALTER TABLE {". $table ."} RENAME $field TO ". $field ."_old"); $not_null = isset($spec['not null']) ? $spec['not null'] : FALSE; unset($spec['not null']); + db_add_field($ret, $table, "$field_new", $spec); + $ret[] = update_sql("UPDATE {". $table ."} SET $field_new = ". $field ."_old"); + if ($not_null) { $ret[] = update_sql("ALTER TABLE {". $table ."} ALTER $field_new SET NOT NULL"); } + db_drop_field($ret, $table, $field .'_old'); + + if (isset($new_keys)) { + _db_create_keys($ret, $table, $new_keys); + } } /** diff --git a/modules/block/block.schema b/modules/block/block.schema index e025867a9e..d433097290 100644 --- a/modules/block/block.schema +++ b/modules/block/block.schema @@ -36,7 +36,7 @@ function block_schema() { $schema['boxes'] = array( 'fields' => array( - 'bid' => array('type' => 'serial', 'not null' => TRUE), + 'bid' => array('type' => 'serial', 'unsigned' => TRUE, 'not null' => TRUE), 'body' => array('type' => 'text', 'not null' => FALSE, 'size' => 'big'), 'info' => array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''), 'format' => array('type' => 'int', 'size' => 'small', 'not null' => TRUE, 'default' => 0) diff --git a/modules/system/system.install b/modules/system/system.install index c6fa00d51f..70d9d553a7 100644 --- a/modules/system/system.install +++ b/modules/system/system.install @@ -3052,8 +3052,6 @@ function system_update_6016() { switch ($GLOBALS['db_type']) { case 'pgsql': - $ret[] = update_sql("ALTER TABLE {node} DROP CONSTRAINT {node}_pkey"); - $ret[] = update_sql("ALTER TABLE {node} ADD PRIMARY KEY (nid)"); $ret[] = update_sql("ALTER TABLE {node} ADD CONSTRAINT {node}_nid_vid_key UNIQUE (nid, vid)"); db_add_column($ret, 'blocks', 'bid', 'serial'); $ret[] = update_sql("ALTER TABLE {blocks} ADD PRIMARY KEY (bid)"); @@ -3070,8 +3068,6 @@ function system_update_6016() { break; case 'mysql': case 'mysqli': - $ret[] = update_sql('ALTER TABLE {node} DROP PRIMARY KEY'); - $ret[] = update_sql('ALTER TABLE {node} ADD PRIMARY KEY (nid)'); $ret[] = update_sql('ALTER TABLE {node} ADD UNIQUE KEY nid_vid (nid, vid)'); $ret[] = update_sql("ALTER TABLE {blocks} ADD bid int NOT NULL AUTO_INCREMENT PRIMARY KEY"); $ret[] = update_sql("ALTER TABLE {filters} ADD fid int NOT NULL AUTO_INCREMENT PRIMARY KEY"); @@ -3198,12 +3194,14 @@ function system_update_6019() { db_drop_primary_key($ret, 'term_node'); db_add_primary_key($ret, 'term_node', array('vid', 'tid', 'nid')); } + + // Make boxes.bid unsigned. + db_drop_primary_key($ret, 'boxes'); + db_change_field($ret, 'boxes', 'bid', 'bid', array('type' => 'serial', 'unsigned' => TRUE, 'not null' => TRUE), array('primary key' => array('bid'))); - // Remove defaults on batch columns. - if (db_table_exists('batch')) { - db_field_set_no_default($ret, 'batch', 'token'); - db_field_set_no_default($ret, 'batch', 'timestamp'); - } + // Fix primary key + db_drop_primary_key($ret, 'node'); + db_add_primary_key($ret, 'node', array('nid')); break; @@ -3235,20 +3233,20 @@ function system_update_6019() { db_change_field($ret, 'cache_form', 'serialized', 'serialized', array('type' => 'int', 'size' => 'small', 'not null' => TRUE, 'default' => 0)); // Remove default => 0, set auto increment. - db_change_field($ret, 'files', 'fid', 'fid', array('type' => 'serial', 'unsigned' => TRUE, 'not null' => TRUE)); - - // Remove default => 0, set auto increment. - $ret[] = update_sql("SET sql_mode = 'NO_AUTO_VALUE_ON_ZERO'"); - db_change_field($ret, 'users', 'uid', 'uid', array('type' => 'serial', 'unsigned' => TRUE, 'not null' => TRUE)); - - // Set auto increment. - db_change_field($ret, 'node_revisions', 'vid', 'vid', array('type' => 'serial', 'unsigned' => TRUE, 'not null' => TRUE)); - - // Set auto increment. - db_change_field($ret, 'boxes', 'bid', 'bid', array('type' => 'serial', 'not null' => TRUE)); - - // Set auto increment, unsigned. - db_change_field($ret, 'batch', 'bid', 'bid', array('type' => 'serial', 'unsigned' => TRUE, 'not null' => TRUE)); + $new_uid = 1 + db_result(db_query('SELECT MAX(uid) FROM {users}')); + $ret[] = update_sql('UPDATE users SET uid = '. $new_uid . ' WHERE uid = 0'); + db_drop_primary_key($ret, 'users'); + db_change_field($ret, 'users', 'uid', 'uid', array('type' => 'serial', 'unsigned' => TRUE, 'not null' => TRUE), array('primary key' => array('uid'))); + $ret[] = update_sql('UPDATE users SET uid = 0 WHERE uid = '. $new_uid); + + // Special field names. + $map = array('node_revisions' => 'vid'); + // Make sure these tables have proper auto_increment fields. + foreach (array('boxes', 'files', 'node', 'node_revisions') as $table) { + $field = isset($map[$table]) ? $map[$table] : $table[0] .'id'; + db_drop_primary_key($ret, $table); + db_change_field($ret, $table, $field, $field, array('type' => 'serial', 'unsigned' => TRUE, 'not null' => TRUE), array('primary key' => array($field))); + } break; } diff --git a/update.php b/update.php index 8ccae94388..476d8c77f2 100644 --- a/update.php +++ b/update.php @@ -677,30 +677,19 @@ function update_create_batch_table() { return; } + $schema['batch'] = array( + 'fields' => array( + 'bid' => array('type' => 'serial', 'unsigned' => TRUE, 'not null' => TRUE), + 'token' => array('type' => 'varchar', 'length' => 64, 'not null' => TRUE), + 'timestamp' => array('type' => 'int', 'not null' => TRUE), + 'batch' => array('type' => 'text', 'not null' => FALSE, 'size' => 'big') + ), + 'primary key' => array('bid'), + 'indexes' => array('token' => array('token')), + ); + $ret = array(); - switch ($GLOBALS['db_type']) { - case 'mysql': - case 'mysqli': - $ret[] = update_sql("CREATE TABLE {batch} ( - bid int(11) NOT NULL, - token varchar(64) NOT NULL, - timestamp int(11) NOT NULL, - batch longtext, - PRIMARY KEY (bid), - KEY token (token) - ) /*!40100 DEFAULT CHARACTER SET UTF8 */ "); - break; - case 'pgsql': - $ret[] = update_sql("CREATE TABLE {batch} ( - bid serial CHECK (bid >= 0), - token varchar(64) NOT NULL default '', - timestamp int NOT NULL default '0', - batch text, - PRIMARY KEY (bid) - )"); - $ret[] = update_sql("CREATE INDEX {batch}_token_idx ON {batch} (token)"); - break; - } + db_create_table($ret, 'batch', $schema['batch']); return $ret; } -- GitLab