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.
584 lines
20 KiB
584 lines
20 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\InvalidConfigException; |
|
use yii\base\NotSupportedException; |
|
use yii\db\Constraint; |
|
use yii\db\ConstraintFinderInterface; |
|
use yii\db\ConstraintFinderTrait; |
|
use yii\db\Exception; |
|
use yii\db\Expression; |
|
use yii\db\ForeignKeyConstraint; |
|
use yii\db\IndexConstraint; |
|
use yii\db\TableSchema; |
|
use yii\helpers\ArrayHelper; |
|
|
|
/** |
|
* Schema is the class for retrieving metadata from a MySQL database (version 4.1.x and 5.x). |
|
* |
|
* @author Qiang Xue <qiang.xue@gmail.com> |
|
* @since 2.0 |
|
*/ |
|
class Schema extends \yii\db\Schema implements ConstraintFinderInterface |
|
{ |
|
use ConstraintFinderTrait; |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
public $columnSchemaClass = 'yii\db\mysql\ColumnSchema'; |
|
/** |
|
* @var bool whether MySQL used is older than 5.1. |
|
*/ |
|
private $_oldMysql; |
|
|
|
|
|
/** |
|
* @var array mapping from physical column types (keys) to abstract column types (values) |
|
*/ |
|
public $typeMap = [ |
|
'tinyint' => self::TYPE_TINYINT, |
|
'bit' => self::TYPE_INTEGER, |
|
'smallint' => self::TYPE_SMALLINT, |
|
'mediumint' => self::TYPE_INTEGER, |
|
'int' => self::TYPE_INTEGER, |
|
'integer' => self::TYPE_INTEGER, |
|
'bigint' => self::TYPE_BIGINT, |
|
'float' => self::TYPE_FLOAT, |
|
'double' => self::TYPE_DOUBLE, |
|
'real' => self::TYPE_FLOAT, |
|
'decimal' => self::TYPE_DECIMAL, |
|
'numeric' => self::TYPE_DECIMAL, |
|
'tinytext' => self::TYPE_TEXT, |
|
'mediumtext' => self::TYPE_TEXT, |
|
'longtext' => self::TYPE_TEXT, |
|
'longblob' => self::TYPE_BINARY, |
|
'blob' => self::TYPE_BINARY, |
|
'text' => self::TYPE_TEXT, |
|
'varchar' => self::TYPE_STRING, |
|
'string' => self::TYPE_STRING, |
|
'char' => self::TYPE_CHAR, |
|
'datetime' => self::TYPE_DATETIME, |
|
'year' => self::TYPE_DATE, |
|
'date' => self::TYPE_DATE, |
|
'time' => self::TYPE_TIME, |
|
'timestamp' => self::TYPE_TIMESTAMP, |
|
'enum' => self::TYPE_STRING, |
|
'varbinary' => self::TYPE_BINARY, |
|
'json' => self::TYPE_JSON, |
|
]; |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected $tableQuoteCharacter = '`'; |
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected $columnQuoteCharacter = '`'; |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected function resolveTableName($name) |
|
{ |
|
$resolvedName = new TableSchema(); |
|
$parts = explode('.', str_replace('`', '', $name)); |
|
if (isset($parts[1])) { |
|
$resolvedName->schemaName = $parts[0]; |
|
$resolvedName->name = $parts[1]; |
|
} else { |
|
$resolvedName->schemaName = $this->defaultSchema; |
|
$resolvedName->name = $name; |
|
} |
|
$resolvedName->fullName = ($resolvedName->schemaName !== $this->defaultSchema ? $resolvedName->schemaName . '.' : '') . $resolvedName->name; |
|
return $resolvedName; |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected function findTableNames($schema = '') |
|
{ |
|
$sql = 'SHOW TABLES'; |
|
if ($schema !== '') { |
|
$sql .= ' FROM ' . $this->quoteSimpleTableName($schema); |
|
} |
|
|
|
return $this->db->createCommand($sql)->queryColumn(); |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected function loadTableSchema($name) |
|
{ |
|
$table = new TableSchema(); |
|
$this->resolveTableNames($table, $name); |
|
|
|
if ($this->findColumns($table)) { |
|
$this->findConstraints($table); |
|
return $table; |
|
} |
|
|
|
return null; |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected function loadTablePrimaryKey($tableName) |
|
{ |
|
return $this->loadTableConstraints($tableName, 'primaryKey'); |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected function loadTableForeignKeys($tableName) |
|
{ |
|
return $this->loadTableConstraints($tableName, 'foreignKeys'); |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected function loadTableIndexes($tableName) |
|
{ |
|
static $sql = <<<'SQL' |
|
SELECT |
|
`s`.`INDEX_NAME` AS `name`, |
|
`s`.`COLUMN_NAME` AS `column_name`, |
|
`s`.`NON_UNIQUE` ^ 1 AS `index_is_unique`, |
|
`s`.`INDEX_NAME` = 'PRIMARY' AS `index_is_primary` |
|
FROM `information_schema`.`STATISTICS` AS `s` |
|
WHERE `s`.`TABLE_SCHEMA` = COALESCE(:schemaName, DATABASE()) AND `s`.`INDEX_SCHEMA` = `s`.`TABLE_SCHEMA` AND `s`.`TABLE_NAME` = :tableName |
|
ORDER BY `s`.`SEQ_IN_INDEX` ASC |
|
SQL; |
|
|
|
$resolvedName = $this->resolveTableName($tableName); |
|
$indexes = $this->db->createCommand($sql, [ |
|
':schemaName' => $resolvedName->schemaName, |
|
':tableName' => $resolvedName->name, |
|
])->queryAll(); |
|
$indexes = $this->normalizePdoRowKeyCase($indexes, true); |
|
$indexes = ArrayHelper::index($indexes, null, 'name'); |
|
$result = []; |
|
foreach ($indexes as $name => $index) { |
|
$result[] = new IndexConstraint([ |
|
'isPrimary' => (bool) $index[0]['index_is_primary'], |
|
'isUnique' => (bool) $index[0]['index_is_unique'], |
|
'name' => $name !== 'PRIMARY' ? $name : null, |
|
'columnNames' => ArrayHelper::getColumn($index, 'column_name'), |
|
]); |
|
} |
|
|
|
return $result; |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected function loadTableUniques($tableName) |
|
{ |
|
return $this->loadTableConstraints($tableName, 'uniques'); |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
* @throws NotSupportedException if this method is called. |
|
*/ |
|
protected function loadTableChecks($tableName) |
|
{ |
|
throw new NotSupportedException('MySQL does not support check constraints.'); |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
* @throws NotSupportedException if this method is called. |
|
*/ |
|
protected function loadTableDefaultValues($tableName) |
|
{ |
|
throw new NotSupportedException('MySQL does not support default value constraints.'); |
|
} |
|
|
|
/** |
|
* Creates a query builder for the MySQL database. |
|
* @return QueryBuilder query builder instance |
|
*/ |
|
public function createQueryBuilder() |
|
{ |
|
return new QueryBuilder($this->db); |
|
} |
|
|
|
/** |
|
* Resolves the table name and schema name (if any). |
|
* @param TableSchema $table the table metadata object |
|
* @param string $name the table name |
|
*/ |
|
protected function resolveTableNames($table, $name) |
|
{ |
|
$parts = explode('.', str_replace('`', '', $name)); |
|
if (isset($parts[1])) { |
|
$table->schemaName = $parts[0]; |
|
$table->name = $parts[1]; |
|
$table->fullName = $table->schemaName . '.' . $table->name; |
|
} else { |
|
$table->fullName = $table->name = $parts[0]; |
|
} |
|
} |
|
|
|
/** |
|
* Loads the column information into a [[ColumnSchema]] object. |
|
* @param array $info column information |
|
* @return ColumnSchema the column schema object |
|
*/ |
|
protected function loadColumnSchema($info) |
|
{ |
|
$column = $this->createColumnSchema(); |
|
|
|
$column->name = $info['field']; |
|
$column->allowNull = $info['null'] === 'YES'; |
|
$column->isPrimaryKey = strpos($info['key'], 'PRI') !== false; |
|
$column->autoIncrement = stripos($info['extra'], 'auto_increment') !== false; |
|
$column->comment = $info['comment']; |
|
|
|
$column->dbType = $info['type']; |
|
$column->unsigned = stripos($column->dbType, 'unsigned') !== false; |
|
|
|
$column->type = self::TYPE_STRING; |
|
if (preg_match('/^(\w+)(?:\(([^\)]+)\))?/', $column->dbType, $matches)) { |
|
$type = strtolower($matches[1]); |
|
if (isset($this->typeMap[$type])) { |
|
$column->type = $this->typeMap[$type]; |
|
} |
|
if (!empty($matches[2])) { |
|
if ($type === 'enum') { |
|
preg_match_all("/'[^']*'/", $matches[2], $values); |
|
foreach ($values[0] as $i => $value) { |
|
$values[$i] = trim($value, "'"); |
|
} |
|
$column->enumValues = $values; |
|
} else { |
|
$values = explode(',', $matches[2]); |
|
$column->size = $column->precision = (int) $values[0]; |
|
if (isset($values[1])) { |
|
$column->scale = (int) $values[1]; |
|
} |
|
if ($column->size === 1 && $type === 'bit') { |
|
$column->type = 'boolean'; |
|
} elseif ($type === 'bit') { |
|
if ($column->size > 32) { |
|
$column->type = 'bigint'; |
|
} elseif ($column->size === 32) { |
|
$column->type = 'integer'; |
|
} |
|
} |
|
} |
|
} |
|
} |
|
|
|
$column->phpType = $this->getColumnPhpType($column); |
|
|
|
if (!$column->isPrimaryKey) { |
|
/** |
|
* When displayed in the INFORMATION_SCHEMA.COLUMNS table, a default CURRENT TIMESTAMP is displayed |
|
* as CURRENT_TIMESTAMP up until MariaDB 10.2.2, and as current_timestamp() from MariaDB 10.2.3. |
|
* |
|
* See details here: https://mariadb.com/kb/en/library/now/#description |
|
*/ |
|
if (($column->type === 'timestamp' || $column->type === 'datetime') |
|
&& preg_match('/^current_timestamp(?:\(([0-9]*)\))?$/i', $info['default'], $matches)) { |
|
$column->defaultValue = new Expression('CURRENT_TIMESTAMP' . (!empty($matches[1]) ? '(' . $matches[1] . ')' : '')); |
|
} elseif (isset($type) && $type === 'bit') { |
|
$column->defaultValue = bindec(trim($info['default'], 'b\'')); |
|
} else { |
|
$column->defaultValue = $column->phpTypecast($info['default']); |
|
} |
|
} |
|
|
|
return $column; |
|
} |
|
|
|
/** |
|
* Collects the metadata of table columns. |
|
* @param TableSchema $table the table metadata |
|
* @return bool whether the table exists in the database |
|
* @throws \Exception if DB query fails |
|
*/ |
|
protected function findColumns($table) |
|
{ |
|
$sql = 'SHOW FULL COLUMNS FROM ' . $this->quoteTableName($table->fullName); |
|
try { |
|
$columns = $this->db->createCommand($sql)->queryAll(); |
|
} catch (\Exception $e) { |
|
$previous = $e->getPrevious(); |
|
if ($previous instanceof \PDOException && strpos($previous->getMessage(), 'SQLSTATE[42S02') !== false) { |
|
// table does not exist |
|
// https://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html#error_er_bad_table_error |
|
return false; |
|
} |
|
throw $e; |
|
} |
|
foreach ($columns as $info) { |
|
if ($this->db->slavePdo->getAttribute(\PDO::ATTR_CASE) !== \PDO::CASE_LOWER) { |
|
$info = array_change_key_case($info, CASE_LOWER); |
|
} |
|
$column = $this->loadColumnSchema($info); |
|
$table->columns[$column->name] = $column; |
|
if ($column->isPrimaryKey) { |
|
$table->primaryKey[] = $column->name; |
|
if ($column->autoIncrement) { |
|
$table->sequenceName = ''; |
|
} |
|
} |
|
} |
|
|
|
return true; |
|
} |
|
|
|
/** |
|
* Gets the CREATE TABLE sql string. |
|
* @param TableSchema $table the table metadata |
|
* @return string $sql the result of 'SHOW CREATE TABLE' |
|
*/ |
|
protected function getCreateTableSql($table) |
|
{ |
|
$row = $this->db->createCommand('SHOW CREATE TABLE ' . $this->quoteTableName($table->fullName))->queryOne(); |
|
if (isset($row['Create Table'])) { |
|
$sql = $row['Create Table']; |
|
} else { |
|
$row = array_values($row); |
|
$sql = $row[1]; |
|
} |
|
|
|
return $sql; |
|
} |
|
|
|
/** |
|
* Collects the foreign key column details for the given table. |
|
* @param TableSchema $table the table metadata |
|
* @throws \Exception |
|
*/ |
|
protected function findConstraints($table) |
|
{ |
|
$sql = <<<'SQL' |
|
SELECT |
|
kcu.constraint_name, |
|
kcu.column_name, |
|
kcu.referenced_table_name, |
|
kcu.referenced_column_name |
|
FROM information_schema.referential_constraints AS rc |
|
JOIN information_schema.key_column_usage AS kcu ON |
|
( |
|
kcu.constraint_catalog = rc.constraint_catalog OR |
|
(kcu.constraint_catalog IS NULL AND rc.constraint_catalog IS NULL) |
|
) AND |
|
kcu.constraint_schema = rc.constraint_schema AND |
|
kcu.constraint_name = rc.constraint_name |
|
WHERE rc.constraint_schema = database() AND kcu.table_schema = database() |
|
AND rc.table_name = :tableName AND kcu.table_name = :tableName1 |
|
SQL; |
|
|
|
try { |
|
$rows = $this->db->createCommand($sql, [':tableName' => $table->name, ':tableName1' => $table->name])->queryAll(); |
|
$constraints = []; |
|
|
|
foreach ($rows as $row) { |
|
$constraints[$row['constraint_name']]['referenced_table_name'] = $row['referenced_table_name']; |
|
$constraints[$row['constraint_name']]['columns'][$row['column_name']] = $row['referenced_column_name']; |
|
} |
|
|
|
$table->foreignKeys = []; |
|
foreach ($constraints as $name => $constraint) { |
|
$table->foreignKeys[$name] = array_merge( |
|
[$constraint['referenced_table_name']], |
|
$constraint['columns'] |
|
); |
|
} |
|
} catch (\Exception $e) { |
|
$previous = $e->getPrevious(); |
|
if (!$previous instanceof \PDOException || strpos($previous->getMessage(), 'SQLSTATE[42S02') === false) { |
|
throw $e; |
|
} |
|
|
|
// table does not exist, try to determine the foreign keys using the table creation sql |
|
$sql = $this->getCreateTableSql($table); |
|
$regexp = '/FOREIGN KEY\s+\(([^\)]+)\)\s+REFERENCES\s+([^\(^\s]+)\s*\(([^\)]+)\)/mi'; |
|
if (preg_match_all($regexp, $sql, $matches, PREG_SET_ORDER)) { |
|
foreach ($matches as $match) { |
|
$fks = array_map('trim', explode(',', str_replace('`', '', $match[1]))); |
|
$pks = array_map('trim', explode(',', str_replace('`', '', $match[3]))); |
|
$constraint = [str_replace('`', '', $match[2])]; |
|
foreach ($fks as $k => $name) { |
|
$constraint[$name] = $pks[$k]; |
|
} |
|
$table->foreignKeys[md5(serialize($constraint))] = $constraint; |
|
} |
|
$table->foreignKeys = array_values($table->foreignKeys); |
|
} |
|
} |
|
} |
|
|
|
/** |
|
* Returns all unique indexes for the given table. |
|
* |
|
* Each array element is of the following structure: |
|
* |
|
* ```php |
|
* [ |
|
* 'IndexName1' => ['col1' [, ...]], |
|
* 'IndexName2' => ['col2' [, ...]], |
|
* ] |
|
* ``` |
|
* |
|
* @param TableSchema $table the table metadata |
|
* @return array all unique indexes for the given table. |
|
*/ |
|
public function findUniqueIndexes($table) |
|
{ |
|
$sql = $this->getCreateTableSql($table); |
|
$uniqueIndexes = []; |
|
|
|
$regexp = '/UNIQUE KEY\s+\`(.+)\`\s*\((\`.+\`)+\)/mi'; |
|
if (preg_match_all($regexp, $sql, $matches, PREG_SET_ORDER)) { |
|
foreach ($matches as $match) { |
|
$indexName = $match[1]; |
|
$indexColumns = array_map('trim', explode('`,`', trim($match[2], '`'))); |
|
$uniqueIndexes[$indexName] = $indexColumns; |
|
} |
|
} |
|
|
|
return $uniqueIndexes; |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
public function createColumnSchemaBuilder($type, $length = null) |
|
{ |
|
return new ColumnSchemaBuilder($type, $length, $this->db); |
|
} |
|
|
|
/** |
|
* @return bool whether the version of the MySQL being used is older than 5.1. |
|
* @throws InvalidConfigException |
|
* @throws Exception |
|
* @since 2.0.13 |
|
*/ |
|
protected function isOldMysql() |
|
{ |
|
if ($this->_oldMysql === null) { |
|
$version = $this->db->getSlavePdo()->getAttribute(\PDO::ATTR_SERVER_VERSION); |
|
$this->_oldMysql = version_compare($version, '5.1', '<='); |
|
} |
|
|
|
return $this->_oldMysql; |
|
} |
|
|
|
/** |
|
* Loads multiple types of constraints and returns the specified ones. |
|
* @param string $tableName table name. |
|
* @param string $returnType return type: |
|
* - primaryKey |
|
* - foreignKeys |
|
* - uniques |
|
* @return mixed constraints. |
|
*/ |
|
private function loadTableConstraints($tableName, $returnType) |
|
{ |
|
static $sql = <<<'SQL' |
|
SELECT |
|
`kcu`.`CONSTRAINT_NAME` AS `name`, |
|
`kcu`.`COLUMN_NAME` AS `column_name`, |
|
`tc`.`CONSTRAINT_TYPE` AS `type`, |
|
CASE |
|
WHEN :schemaName IS NULL AND `kcu`.`REFERENCED_TABLE_SCHEMA` = DATABASE() THEN NULL |
|
ELSE `kcu`.`REFERENCED_TABLE_SCHEMA` |
|
END AS `foreign_table_schema`, |
|
`kcu`.`REFERENCED_TABLE_NAME` AS `foreign_table_name`, |
|
`kcu`.`REFERENCED_COLUMN_NAME` AS `foreign_column_name`, |
|
`rc`.`UPDATE_RULE` AS `on_update`, |
|
`rc`.`DELETE_RULE` AS `on_delete`, |
|
`kcu`.`ORDINAL_POSITION` AS `position` |
|
FROM |
|
`information_schema`.`KEY_COLUMN_USAGE` AS `kcu`, |
|
`information_schema`.`REFERENTIAL_CONSTRAINTS` AS `rc`, |
|
`information_schema`.`TABLE_CONSTRAINTS` AS `tc` |
|
WHERE |
|
`kcu`.`TABLE_SCHEMA` = COALESCE(:schemaName, DATABASE()) AND `kcu`.`CONSTRAINT_SCHEMA` = `kcu`.`TABLE_SCHEMA` AND `kcu`.`TABLE_NAME` = :tableName |
|
AND `rc`.`CONSTRAINT_SCHEMA` = `kcu`.`TABLE_SCHEMA` AND `rc`.`TABLE_NAME` = :tableName AND `rc`.`CONSTRAINT_NAME` = `kcu`.`CONSTRAINT_NAME` |
|
AND `tc`.`TABLE_SCHEMA` = `kcu`.`TABLE_SCHEMA` AND `tc`.`TABLE_NAME` = :tableName AND `tc`.`CONSTRAINT_NAME` = `kcu`.`CONSTRAINT_NAME` AND `tc`.`CONSTRAINT_TYPE` = 'FOREIGN KEY' |
|
UNION |
|
SELECT |
|
`kcu`.`CONSTRAINT_NAME` AS `name`, |
|
`kcu`.`COLUMN_NAME` AS `column_name`, |
|
`tc`.`CONSTRAINT_TYPE` AS `type`, |
|
NULL AS `foreign_table_schema`, |
|
NULL AS `foreign_table_name`, |
|
NULL AS `foreign_column_name`, |
|
NULL AS `on_update`, |
|
NULL AS `on_delete`, |
|
`kcu`.`ORDINAL_POSITION` AS `position` |
|
FROM |
|
`information_schema`.`KEY_COLUMN_USAGE` AS `kcu`, |
|
`information_schema`.`TABLE_CONSTRAINTS` AS `tc` |
|
WHERE |
|
`kcu`.`TABLE_SCHEMA` = COALESCE(:schemaName, DATABASE()) AND `kcu`.`TABLE_NAME` = :tableName |
|
AND `tc`.`TABLE_SCHEMA` = `kcu`.`TABLE_SCHEMA` AND `tc`.`TABLE_NAME` = :tableName AND `tc`.`CONSTRAINT_NAME` = `kcu`.`CONSTRAINT_NAME` AND `tc`.`CONSTRAINT_TYPE` IN ('PRIMARY KEY', 'UNIQUE') |
|
ORDER BY `position` ASC |
|
SQL; |
|
|
|
$resolvedName = $this->resolveTableName($tableName); |
|
$constraints = $this->db->createCommand($sql, [ |
|
':schemaName' => $resolvedName->schemaName, |
|
':tableName' => $resolvedName->name, |
|
])->queryAll(); |
|
$constraints = $this->normalizePdoRowKeyCase($constraints, true); |
|
$constraints = ArrayHelper::index($constraints, null, ['type', 'name']); |
|
$result = [ |
|
'primaryKey' => null, |
|
'foreignKeys' => [], |
|
'uniques' => [], |
|
]; |
|
foreach ($constraints as $type => $names) { |
|
foreach ($names as $name => $constraint) { |
|
switch ($type) { |
|
case 'PRIMARY KEY': |
|
$result['primaryKey'] = new Constraint([ |
|
'columnNames' => ArrayHelper::getColumn($constraint, 'column_name'), |
|
]); |
|
break; |
|
case 'FOREIGN KEY': |
|
$result['foreignKeys'][] = new ForeignKeyConstraint([ |
|
'name' => $name, |
|
'columnNames' => ArrayHelper::getColumn($constraint, 'column_name'), |
|
'foreignSchemaName' => $constraint[0]['foreign_table_schema'], |
|
'foreignTableName' => $constraint[0]['foreign_table_name'], |
|
'foreignColumnNames' => ArrayHelper::getColumn($constraint, 'foreign_column_name'), |
|
'onDelete' => $constraint[0]['on_delete'], |
|
'onUpdate' => $constraint[0]['on_update'], |
|
]); |
|
break; |
|
case 'UNIQUE': |
|
$result['uniques'][] = new Constraint([ |
|
'name' => $name, |
|
'columnNames' => ArrayHelper::getColumn($constraint, 'column_name'), |
|
]); |
|
break; |
|
} |
|
} |
|
} |
|
foreach ($result as $type => $data) { |
|
$this->setTableMetadata($tableName, $type, $data); |
|
} |
|
|
|
return $result[$returnType]; |
|
} |
|
}
|
|
|