You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
365 lines
13 KiB
365 lines
13 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\db\mysql; |
|
|
|
use yii\base\InvalidArgumentException; |
|
use yii\base\NotSupportedException; |
|
use yii\db\Exception; |
|
use yii\db\Expression; |
|
use yii\db\Query; |
|
|
|
/** |
|
* QueryBuilder is the query builder for MySQL databases. |
|
* |
|
* @author Qiang Xue <qiang.xue@gmail.com> |
|
* @since 2.0 |
|
*/ |
|
class QueryBuilder extends \yii\db\QueryBuilder |
|
{ |
|
/** |
|
* @var array mapping from abstract column types (keys) to physical column types (values). |
|
*/ |
|
public $typeMap = [ |
|
Schema::TYPE_PK => 'int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY', |
|
Schema::TYPE_UPK => 'int(10) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY', |
|
Schema::TYPE_BIGPK => 'bigint(20) NOT NULL AUTO_INCREMENT PRIMARY KEY', |
|
Schema::TYPE_UBIGPK => 'bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY', |
|
Schema::TYPE_CHAR => 'char(1)', |
|
Schema::TYPE_STRING => 'varchar(255)', |
|
Schema::TYPE_TEXT => 'text', |
|
Schema::TYPE_TINYINT => 'tinyint(3)', |
|
Schema::TYPE_SMALLINT => 'smallint(6)', |
|
Schema::TYPE_INTEGER => 'int(11)', |
|
Schema::TYPE_BIGINT => 'bigint(20)', |
|
Schema::TYPE_FLOAT => 'float', |
|
Schema::TYPE_DOUBLE => 'double', |
|
Schema::TYPE_DECIMAL => 'decimal(10,0)', |
|
Schema::TYPE_DATETIME => 'datetime', |
|
Schema::TYPE_TIMESTAMP => 'timestamp', |
|
Schema::TYPE_TIME => 'time', |
|
Schema::TYPE_DATE => 'date', |
|
Schema::TYPE_BINARY => 'blob', |
|
Schema::TYPE_BOOLEAN => 'tinyint(1)', |
|
Schema::TYPE_MONEY => 'decimal(19,4)', |
|
Schema::TYPE_JSON => 'json' |
|
]; |
|
|
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected function defaultExpressionBuilders() |
|
{ |
|
return array_merge(parent::defaultExpressionBuilders(), [ |
|
'yii\db\JsonExpression' => 'yii\db\mysql\JsonExpressionBuilder', |
|
]); |
|
} |
|
|
|
/** |
|
* Builds a SQL statement for renaming a column. |
|
* @param string $table the table whose column is to be renamed. The name will be properly quoted by the method. |
|
* @param string $oldName the old name of the column. The name will be properly quoted by the method. |
|
* @param string $newName the new name of the column. The name will be properly quoted by the method. |
|
* @return string the SQL statement for renaming a DB column. |
|
* @throws Exception |
|
*/ |
|
public function renameColumn($table, $oldName, $newName) |
|
{ |
|
$quotedTable = $this->db->quoteTableName($table); |
|
$row = $this->db->createCommand('SHOW CREATE TABLE ' . $quotedTable)->queryOne(); |
|
if ($row === false) { |
|
throw new Exception("Unable to find column '$oldName' in table '$table'."); |
|
} |
|
if (isset($row['Create Table'])) { |
|
$sql = $row['Create Table']; |
|
} else { |
|
$row = array_values($row); |
|
$sql = $row[1]; |
|
} |
|
if (preg_match_all('/^\s*`(.*?)`\s+(.*?),?$/m', $sql, $matches)) { |
|
foreach ($matches[1] as $i => $c) { |
|
if ($c === $oldName) { |
|
return "ALTER TABLE $quotedTable CHANGE " |
|
. $this->db->quoteColumnName($oldName) . ' ' |
|
. $this->db->quoteColumnName($newName) . ' ' |
|
. $matches[2][$i]; |
|
} |
|
} |
|
} |
|
// try to give back a SQL anyway |
|
return "ALTER TABLE $quotedTable CHANGE " |
|
. $this->db->quoteColumnName($oldName) . ' ' |
|
. $this->db->quoteColumnName($newName); |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
* @see https://bugs.mysql.com/bug.php?id=48875 |
|
*/ |
|
public function createIndex($name, $table, $columns, $unique = false) |
|
{ |
|
return 'ALTER TABLE ' |
|
. $this->db->quoteTableName($table) |
|
. ($unique ? ' ADD UNIQUE INDEX ' : ' ADD INDEX ') |
|
. $this->db->quoteTableName($name) |
|
. ' (' . $this->buildColumns($columns) . ')'; |
|
} |
|
|
|
/** |
|
* Builds a SQL statement for dropping a foreign key constraint. |
|
* @param string $name the name of the foreign key constraint to be dropped. The name will be properly quoted by the method. |
|
* @param string $table the table whose foreign is to be dropped. The name will be properly quoted by the method. |
|
* @return string the SQL statement for dropping a foreign key constraint. |
|
*/ |
|
public function dropForeignKey($name, $table) |
|
{ |
|
return 'ALTER TABLE ' . $this->db->quoteTableName($table) |
|
. ' DROP FOREIGN KEY ' . $this->db->quoteColumnName($name); |
|
} |
|
|
|
/** |
|
* Builds a SQL statement for removing a primary key constraint to an existing table. |
|
* @param string $name the name of the primary key constraint to be removed. |
|
* @param string $table the table that the primary key constraint will be removed from. |
|
* @return string the SQL statement for removing a primary key constraint from an existing table. |
|
*/ |
|
public function dropPrimaryKey($name, $table) |
|
{ |
|
return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' DROP PRIMARY KEY'; |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
public function dropUnique($name, $table) |
|
{ |
|
return $this->dropIndex($name, $table); |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
* @throws NotSupportedException this is not supported by MySQL. |
|
*/ |
|
public function addCheck($name, $table, $expression) |
|
{ |
|
throw new NotSupportedException(__METHOD__ . ' is not supported by MySQL.'); |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
* @throws NotSupportedException this is not supported by MySQL. |
|
*/ |
|
public function dropCheck($name, $table) |
|
{ |
|
throw new NotSupportedException(__METHOD__ . ' is not supported by MySQL.'); |
|
} |
|
|
|
/** |
|
* Creates a SQL statement for resetting the sequence value of a table's primary key. |
|
* The sequence will be reset such that the primary key of the next new row inserted |
|
* will have the specified value or 1. |
|
* @param string $tableName the name of the table whose primary key sequence will be reset |
|
* @param mixed $value the value for the primary key of the next new row inserted. If this is not set, |
|
* the next new row's primary key will have a value 1. |
|
* @return string the SQL statement for resetting sequence |
|
* @throws InvalidArgumentException if the table does not exist or there is no sequence associated with the table. |
|
*/ |
|
public function resetSequence($tableName, $value = null) |
|
{ |
|
$table = $this->db->getTableSchema($tableName); |
|
if ($table !== null && $table->sequenceName !== null) { |
|
$tableName = $this->db->quoteTableName($tableName); |
|
if ($value === null) { |
|
$key = reset($table->primaryKey); |
|
$value = $this->db->createCommand("SELECT MAX(`$key`) FROM $tableName")->queryScalar() + 1; |
|
} else { |
|
$value = (int) $value; |
|
} |
|
|
|
return "ALTER TABLE $tableName AUTO_INCREMENT=$value"; |
|
} elseif ($table === null) { |
|
throw new InvalidArgumentException("Table not found: $tableName"); |
|
} |
|
|
|
throw new InvalidArgumentException("There is no sequence associated with table '$tableName'."); |
|
} |
|
|
|
/** |
|
* Builds a SQL statement for enabling or disabling integrity check. |
|
* @param bool $check whether to turn on or off the integrity check. |
|
* @param string $schema the schema of the tables. Meaningless for MySQL. |
|
* @param string $table the table name. Meaningless for MySQL. |
|
* @return string the SQL statement for checking integrity |
|
*/ |
|
public function checkIntegrity($check = true, $schema = '', $table = '') |
|
{ |
|
return 'SET FOREIGN_KEY_CHECKS = ' . ($check ? 1 : 0); |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
public function buildLimit($limit, $offset) |
|
{ |
|
$sql = ''; |
|
if ($this->hasLimit($limit)) { |
|
$sql = 'LIMIT ' . $limit; |
|
if ($this->hasOffset($offset)) { |
|
$sql .= ' OFFSET ' . $offset; |
|
} |
|
} elseif ($this->hasOffset($offset)) { |
|
// limit is not optional in MySQL |
|
// http://stackoverflow.com/a/271650/1106908 |
|
// http://dev.mysql.com/doc/refman/5.0/en/select.html#idm47619502796240 |
|
$sql = "LIMIT $offset, 18446744073709551615"; // 2^64-1 |
|
} |
|
|
|
return $sql; |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected function hasLimit($limit) |
|
{ |
|
// In MySQL limit argument must be nonnegative integer constant |
|
return ctype_digit((string) $limit); |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected function hasOffset($offset) |
|
{ |
|
// In MySQL offset argument must be nonnegative integer constant |
|
$offset = (string) $offset; |
|
return ctype_digit($offset) && $offset !== '0'; |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected function prepareInsertValues($table, $columns, $params = []) |
|
{ |
|
list($names, $placeholders, $values, $params) = parent::prepareInsertValues($table, $columns, $params); |
|
if (!$columns instanceof Query && empty($names)) { |
|
$tableSchema = $this->db->getSchema()->getTableSchema($table); |
|
if ($tableSchema !== null) { |
|
$columns = !empty($tableSchema->primaryKey) ? $tableSchema->primaryKey : [reset($tableSchema->columns)->name]; |
|
foreach ($columns as $name) { |
|
$names[] = $this->db->quoteColumnName($name); |
|
$placeholders[] = 'DEFAULT'; |
|
} |
|
} |
|
} |
|
return [$names, $placeholders, $values, $params]; |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
* @see https://downloads.mysql.com/docs/refman-5.1-en.pdf |
|
*/ |
|
public function upsert($table, $insertColumns, $updateColumns, &$params) |
|
{ |
|
$insertSql = $this->insert($table, $insertColumns, $params); |
|
list($uniqueNames, , $updateNames) = $this->prepareUpsertColumns($table, $insertColumns, $updateColumns); |
|
if (empty($uniqueNames)) { |
|
return $insertSql; |
|
} |
|
|
|
if ($updateColumns === true) { |
|
$updateColumns = []; |
|
foreach ($updateNames as $name) { |
|
$updateColumns[$name] = new Expression('VALUES(' . $this->db->quoteColumnName($name) . ')'); |
|
} |
|
} elseif ($updateColumns === false) { |
|
$name = $this->db->quoteColumnName(reset($uniqueNames)); |
|
$updateColumns = [$name => new Expression($this->db->quoteTableName($table) . '.' . $name)]; |
|
} |
|
list($updates, $params) = $this->prepareUpdateSets($table, $updateColumns, $params); |
|
return $insertSql . ' ON DUPLICATE KEY UPDATE ' . implode(', ', $updates); |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
* @since 2.0.8 |
|
*/ |
|
public function addCommentOnColumn($table, $column, $comment) |
|
{ |
|
// Strip existing comment which may include escaped quotes |
|
$definition = trim(preg_replace("/COMMENT '(?:''|[^'])*'/i", '', |
|
$this->getColumnDefinition($table, $column))); |
|
|
|
return 'ALTER TABLE ' . $this->db->quoteTableName($table) |
|
. ' CHANGE ' . $this->db->quoteColumnName($column) |
|
. ' ' . $this->db->quoteColumnName($column) |
|
. (empty($definition) ? '' : ' ' . $definition) |
|
. ' COMMENT ' . $this->db->quoteValue($comment); |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
* @since 2.0.8 |
|
*/ |
|
public function addCommentOnTable($table, $comment) |
|
{ |
|
return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' COMMENT ' . $this->db->quoteValue($comment); |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
* @since 2.0.8 |
|
*/ |
|
public function dropCommentFromColumn($table, $column) |
|
{ |
|
return $this->addCommentOnColumn($table, $column, ''); |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
* @since 2.0.8 |
|
*/ |
|
public function dropCommentFromTable($table) |
|
{ |
|
return $this->addCommentOnTable($table, ''); |
|
} |
|
|
|
|
|
/** |
|
* Gets column definition. |
|
* |
|
* @param string $table table name |
|
* @param string $column column name |
|
* @return null|string the column definition |
|
* @throws Exception in case when table does not contain column |
|
*/ |
|
private function getColumnDefinition($table, $column) |
|
{ |
|
$quotedTable = $this->db->quoteTableName($table); |
|
$row = $this->db->createCommand('SHOW CREATE TABLE ' . $quotedTable)->queryOne(); |
|
if ($row === false) { |
|
throw new Exception("Unable to find column '$column' in table '$table'."); |
|
} |
|
if (isset($row['Create Table'])) { |
|
$sql = $row['Create Table']; |
|
} else { |
|
$row = array_values($row); |
|
$sql = $row[1]; |
|
} |
|
if (preg_match_all('/^\s*`(.*?)`\s+(.*?),?$/m', $sql, $matches)) { |
|
foreach ($matches[1] as $i => $c) { |
|
if ($c === $column) { |
|
return $matches[2][$i]; |
|
} |
|
} |
|
} |
|
|
|
return null; |
|
} |
|
|
|
}
|
|
|