390 lines
12 KiB
PHP
390 lines
12 KiB
PHP
<?php
|
||
// $Id$
|
||
|
||
/**
|
||
* @file
|
||
* Database schema code for MySQL database servers.
|
||
*/
|
||
|
||
|
||
/**
|
||
* @ingroup schemaapi
|
||
* @{
|
||
*/
|
||
|
||
class DatabaseSchema_mysql extends DatabaseSchema {
|
||
|
||
/**
|
||
* Maximum length of a table comment in MySQL.
|
||
*/
|
||
const COMMENT_MAX_TABLE = 60;
|
||
|
||
/**
|
||
* Maximum length of a column comment in MySQL.
|
||
*/
|
||
const COMMENT_MAX_COLUMN = 255;
|
||
|
||
/**
|
||
* Build a condition to match a table name against a standard information_schema.
|
||
*
|
||
* MySQL uses databases like schemas rather than catalogs so when we build
|
||
* a condition to query the information_schema.tables, we set the default
|
||
* database as the schema unless specified otherwise, and exclude table_catalog
|
||
* from the condition criteria.
|
||
*/
|
||
protected function buildTableNameCondition($table_name, $operator = '=') {
|
||
$info = Database::getConnectionInfo();
|
||
|
||
if (strpos($table_name, '.')) {
|
||
list($schema, $table_name) = explode('.', $table_name);
|
||
}
|
||
else {
|
||
$schema = $info['default']['database'];
|
||
}
|
||
|
||
$condition = new DatabaseCondition('AND');
|
||
$condition->condition('table_schema', $schema);
|
||
$condition->condition('table_name', $table_name, $operator);
|
||
return $condition;
|
||
}
|
||
|
||
/**
|
||
* Generate SQL to create a new table from a Drupal schema definition.
|
||
*
|
||
* @param $name
|
||
* The name of the table to create.
|
||
* @param $table
|
||
* A Schema API table definition array.
|
||
* @return
|
||
* An array of SQL statements to create the table.
|
||
*/
|
||
protected function createTableSql($name, $table) {
|
||
// Provide some defaults if needed
|
||
$table += array(
|
||
'mysql_engine' => 'InnoDB',
|
||
'mysql_character_set' => 'UTF8',
|
||
);
|
||
|
||
$sql = "CREATE TABLE {" . $name . "} (\n";
|
||
|
||
// Add the SQL statement for each field.
|
||
foreach ($table['fields'] as $field_name => $field) {
|
||
$sql .= $this->createFieldSql($field_name, $this->processField($field)) . ", \n";
|
||
}
|
||
|
||
// Process keys & indexes.
|
||
$keys = $this->createKeysSql($table);
|
||
if (count($keys)) {
|
||
$sql .= implode(", \n", $keys) . ", \n";
|
||
}
|
||
|
||
// Remove the last comma and space.
|
||
$sql = substr($sql, 0, -3) . "\n) ";
|
||
|
||
$sql .= 'ENGINE = ' . $table['mysql_engine'] . ' DEFAULT CHARACTER SET ' . $table['mysql_character_set'];
|
||
|
||
// Add table comment.
|
||
if (!empty($table['description'])) {
|
||
$sql .= ' COMMENT ' . $this->prepareComment($table['description'], self::COMMENT_MAX_TABLE);
|
||
}
|
||
|
||
return array($sql);
|
||
}
|
||
|
||
/**
|
||
* Create an SQL string for a field to be used in table creation or alteration.
|
||
*
|
||
* Before passing a field out of a schema definition into this function it has
|
||
* to be processed by _db_process_field().
|
||
*
|
||
* @param $name
|
||
* Name of the field.
|
||
* @param $spec
|
||
* The field specification, as per the schema data structure format.
|
||
*/
|
||
protected function createFieldSql($name, $spec) {
|
||
$sql = "`" . $name . "` " . $spec['mysql_type'];
|
||
|
||
if (isset($spec['length'])) {
|
||
$sql .= '(' . $spec['length'] . ')';
|
||
}
|
||
elseif (isset($spec['precision']) && isset($spec['scale'])) {
|
||
$sql .= '(' . $spec['precision'] . ', ' . $spec['scale'] . ')';
|
||
}
|
||
|
||
if (!empty($spec['unsigned'])) {
|
||
$sql .= ' unsigned';
|
||
}
|
||
|
||
if (!empty($spec['not null'])) {
|
||
$sql .= ' NOT NULL';
|
||
}
|
||
|
||
if (!empty($spec['auto_increment'])) {
|
||
$sql .= ' auto_increment';
|
||
}
|
||
|
||
// $spec['default'] can be NULL, so we explicitly check for the key here.
|
||
if (array_key_exists('default', $spec)) {
|
||
if (is_string($spec['default'])) {
|
||
$spec['default'] = "'" . $spec['default'] . "'";
|
||
}
|
||
elseif (is_null($spec['default'])) {
|
||
$spec['default'] = 'NULL';
|
||
}
|
||
$sql .= ' DEFAULT ' . $spec['default'];
|
||
}
|
||
|
||
if (empty($spec['not null']) && !isset($spec['default'])) {
|
||
$sql .= ' DEFAULT NULL';
|
||
}
|
||
|
||
// Add column comment.
|
||
if (!empty($spec['description'])) {
|
||
$sql .= ' COMMENT ' . $this->prepareComment($spec['description'], self::COMMENT_MAX_COLUMN);
|
||
}
|
||
|
||
return $sql;
|
||
}
|
||
|
||
/**
|
||
* Set database-engine specific properties for a field.
|
||
*
|
||
* @param $field
|
||
* A field description array, as specified in the schema documentation.
|
||
*/
|
||
protected function processField($field) {
|
||
|
||
if (!isset($field['size'])) {
|
||
$field['size'] = 'normal';
|
||
}
|
||
|
||
// Set the correct database-engine specific datatype.
|
||
if (!isset($field['mysql_type'])) {
|
||
$map = db_type_map();
|
||
$field['mysql_type'] = $map[$field['type'] . ':' . $field['size']];
|
||
}
|
||
|
||
if ($field['type'] == 'serial') {
|
||
$field['auto_increment'] = TRUE;
|
||
}
|
||
|
||
return $field;
|
||
}
|
||
|
||
public function getFieldTypeMap() {
|
||
// Put :normal last so it gets preserved by array_flip. This makes
|
||
// it much easier for modules (such as schema.module) to map
|
||
// database types back into schema types.
|
||
// $map does not use drupal_static as its value never changes.
|
||
static $map = array(
|
||
'varchar:normal' => 'VARCHAR',
|
||
'char:normal' => 'CHAR',
|
||
|
||
'text:tiny' => 'TINYTEXT',
|
||
'text:small' => 'TINYTEXT',
|
||
'text:medium' => 'MEDIUMTEXT',
|
||
'text:big' => 'LONGTEXT',
|
||
'text:normal' => 'TEXT',
|
||
|
||
'serial:tiny' => 'TINYINT',
|
||
'serial:small' => 'SMALLINT',
|
||
'serial:medium' => 'MEDIUMINT',
|
||
'serial:big' => 'BIGINT',
|
||
'serial:normal' => 'INT',
|
||
|
||
'int:tiny' => 'TINYINT',
|
||
'int:small' => 'SMALLINT',
|
||
'int:medium' => 'MEDIUMINT',
|
||
'int:big' => 'BIGINT',
|
||
'int:normal' => 'INT',
|
||
|
||
'float:tiny' => 'FLOAT',
|
||
'float:small' => 'FLOAT',
|
||
'float:medium' => 'FLOAT',
|
||
'float:big' => 'DOUBLE',
|
||
'float:normal' => 'FLOAT',
|
||
|
||
'numeric:normal' => 'DECIMAL',
|
||
|
||
'blob:big' => 'LONGBLOB',
|
||
'blob:normal' => 'BLOB',
|
||
|
||
'datetime:normal' => 'DATETIME',
|
||
);
|
||
return $map;
|
||
}
|
||
|
||
|
||
|
||
|
||
protected function createKeysSql($spec) {
|
||
$keys = array();
|
||
|
||
if (!empty($spec['primary key'])) {
|
||
$keys[] = 'PRIMARY KEY (' . $this->createKeysSqlHelper($spec['primary key']) . ')';
|
||
}
|
||
if (!empty($spec['unique keys'])) {
|
||
foreach ($spec['unique keys'] as $key => $fields) {
|
||
$keys[] = 'UNIQUE KEY ' . $key . ' (' . $this->createKeysSqlHelper($fields) . ')';
|
||
}
|
||
}
|
||
if (!empty($spec['indexes'])) {
|
||
foreach ($spec['indexes'] as $index => $fields) {
|
||
$keys[] = 'INDEX ' . $index . ' (' . $this->createKeysSqlHelper($fields) . ')';
|
||
}
|
||
}
|
||
|
||
return $keys;
|
||
}
|
||
|
||
protected function createKeySql($fields) {
|
||
$ret = array();
|
||
foreach ($fields as $field) {
|
||
if (is_array($field)) {
|
||
$ret[] = $field[0] . '(' . $field[1] . ')';
|
||
}
|
||
else {
|
||
$ret[] = $field;
|
||
}
|
||
}
|
||
return implode(', ', $ret);
|
||
}
|
||
|
||
protected function createKeysSqlHelper($fields) {
|
||
$ret = array();
|
||
foreach ($fields as $field) {
|
||
if (is_array($field)) {
|
||
$ret[] = $field[0] . '(' . $field[1] . ')';
|
||
}
|
||
else {
|
||
$ret[] = $field;
|
||
}
|
||
}
|
||
return implode(', ', $ret);
|
||
}
|
||
|
||
public function renameTable(&$ret, $table, $new_name) {
|
||
$ret[] = update_sql('ALTER TABLE {' . $table . '} RENAME TO {' . $new_name . '}');
|
||
}
|
||
|
||
public function dropTable(&$ret, $table) {
|
||
$ret[] = update_sql('DROP TABLE {' . $table . '}');
|
||
}
|
||
|
||
public function addField(&$ret, $table, $field, $spec, $keys_new = array()) {
|
||
$fixnull = FALSE;
|
||
if (!empty($spec['not null']) && !isset($spec['default'])) {
|
||
$fixnull = TRUE;
|
||
$spec['not null'] = FALSE;
|
||
}
|
||
$query = 'ALTER TABLE {' . $table . '} ADD ';
|
||
$query .= $this->createFieldSql($field, $this->processField($spec));
|
||
if (count($keys_new)) {
|
||
$query .= ', ADD ' . implode(', ADD ', $this->createKeysSql($keys_new));
|
||
}
|
||
$ret[] = update_sql($query);
|
||
if (isset($spec['initial'])) {
|
||
// All this because update_sql does not support %-placeholders.
|
||
$sql = 'UPDATE {' . $table . '} SET ' . $field . ' = ' . db_type_placeholder($spec['type']);
|
||
$result = db_query($sql, $spec['initial']);
|
||
$ret[] = array('success' => $result !== FALSE, 'query' => check_plain($sql . ' (' . $spec['initial'] . ')'));
|
||
}
|
||
if ($fixnull) {
|
||
$spec['not null'] = TRUE;
|
||
$this->changeField($ret, $table, $field, $field, $spec);
|
||
}
|
||
}
|
||
|
||
public function dropField(&$ret, $table, $field) {
|
||
$ret[] = update_sql('ALTER TABLE {' . $table . '} DROP ' . $field);
|
||
}
|
||
|
||
public function fieldSetDefault(&$ret, $table, $field, $default) {
|
||
if (is_null($default)) {
|
||
$default = 'NULL';
|
||
}
|
||
else {
|
||
$default = is_string($default) ? "'$default'" : $default;
|
||
}
|
||
|
||
$ret[] = update_sql('ALTER TABLE {' . $table . '} ALTER COLUMN ' . $field . ' SET DEFAULT ' . $default);
|
||
}
|
||
|
||
public function fieldSetNoDefault(&$ret, $table, $field) {
|
||
$ret[] = update_sql('ALTER TABLE {' . $table . '} ALTER COLUMN ' . $field . ' DROP DEFAULT');
|
||
}
|
||
|
||
public function addPrimaryKey(&$ret, $table, $fields) {
|
||
$ret[] = update_sql('ALTER TABLE {' . $table . '} ADD PRIMARY KEY (' . $this->createKeySql($fields) . ')');
|
||
}
|
||
|
||
public function dropPrimaryKey(&$ret, $table) {
|
||
$ret[] = update_sql('ALTER TABLE {' . $table . '} DROP PRIMARY KEY');
|
||
}
|
||
|
||
public function addUniqueKey(&$ret, $table, $name, $fields) {
|
||
$ret[] = update_sql('ALTER TABLE {' . $table . '} ADD UNIQUE KEY ' . $name . ' (' . $this->createKeySql($fields) . ')');
|
||
}
|
||
|
||
public function dropUniqueKey(&$ret, $table, $name) {
|
||
$ret[] = update_sql('ALTER TABLE {' . $table . '} DROP KEY ' . $name);
|
||
}
|
||
|
||
public function addIndex(&$ret, $table, $name, $fields) {
|
||
$query = 'ALTER TABLE {' . $table . '} ADD INDEX ' . $name . ' (' . $this->createKeySql($fields) . ')';
|
||
$ret[] = update_sql($query);
|
||
}
|
||
|
||
public function dropIndex(&$ret, $table, $name) {
|
||
$ret[] = update_sql('ALTER TABLE {' . $table . '} DROP INDEX ' . $name);
|
||
}
|
||
|
||
public function changeField(&$ret, $table, $field, $field_new, $spec, $keys_new = array()) {
|
||
$sql = 'ALTER TABLE {' . $table . '} CHANGE `' . $field . '` ' . $this->createFieldSql($field_new, $this->processField($spec));
|
||
if (count($keys_new)) {
|
||
$sql .= ', ADD ' . implode(', ADD ', $this->createKeysSql($keys_new));
|
||
}
|
||
$ret[] = update_sql($sql);
|
||
}
|
||
|
||
public function prepareComment($comment, $length = NULL) {
|
||
// Decode HTML-encoded comments.
|
||
$comment = decode_entities(strip_tags($comment));
|
||
|
||
// Work around a bug in some versions of PDO, see http://bugs.php.net/bug.php?id=41125
|
||
$comment = str_replace("'", '’', $comment);
|
||
|
||
// Truncate comment to maximum comment length.
|
||
if (isset($length)) {
|
||
// Add table prefixes before truncating.
|
||
$comment = truncate_utf8($this->connection->prefixTables($comment), $length, TRUE, TRUE);
|
||
}
|
||
|
||
return $this->connection->quote($comment);
|
||
}
|
||
|
||
/**
|
||
* Retrieve a table or column comment.
|
||
*/
|
||
public function getComment($table, $column = NULL) {
|
||
$condition = $this->buildTableNameCondition($this->connection->prefixTables('{' . $table . '}'));
|
||
if (isset($column)) {
|
||
$condition->condition('column_name', $column);
|
||
$condition->compile($this->connection);
|
||
// Don't use {} around information_schema.columns table.
|
||
return db_query("SELECT column_comment FROM information_schema.columns WHERE " . (string) $condition, $condition->arguments())->fetchField();
|
||
}
|
||
$condition->compile($this->connection);
|
||
// Don't use {} around information_schema.tables table.
|
||
$comment = db_query("SELECT table_comment FROM information_schema.tables WHERE " . (string) $condition, $condition->arguments())->fetchField();
|
||
// Work-around for MySQL 5.0 bug http://bugs.mysql.com/bug.php?id=11379
|
||
return preg_replace('/; InnoDB free:.*$/', '', $comment);
|
||
}
|
||
|
||
}
|
||
|
||
/**
|
||
* @} End of "ingroup schemaapi".
|
||
*/
|