mirror of
https://github.com/yiisoft/yii2.git
synced 2025-11-04 14:46:19 +08:00
359 lines
12 KiB
PHP
359 lines
12 KiB
PHP
<?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\db\Expression;
|
|
use yii\db\TableSchema;
|
|
use yii\db\ColumnSchema;
|
|
|
|
/**
|
|
* 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
|
|
{
|
|
/**
|
|
* @var array mapping from physical column types (keys) to abstract column types (values)
|
|
*/
|
|
public $typeMap = [
|
|
'tinyint' => self::TYPE_SMALLINT,
|
|
'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,
|
|
];
|
|
|
|
|
|
/**
|
|
* Quotes a table name for use in a query.
|
|
* A simple table name has no schema prefix.
|
|
* @param string $name table name
|
|
* @return string the properly quoted table name
|
|
*/
|
|
public function quoteSimpleTableName($name)
|
|
{
|
|
return strpos($name, '`') !== false ? $name : "`$name`";
|
|
}
|
|
|
|
/**
|
|
* Quotes a column name for use in a query.
|
|
* A simple column name has no prefix.
|
|
* @param string $name column name
|
|
* @return string the properly quoted column name
|
|
*/
|
|
public function quoteSimpleColumnName($name)
|
|
{
|
|
return strpos($name, '`') !== false || $name === '*' ? $name : "`$name`";
|
|
}
|
|
|
|
/**
|
|
* Creates a query builder for the MySQL database.
|
|
* @return QueryBuilder query builder instance
|
|
*/
|
|
public function createQueryBuilder()
|
|
{
|
|
return new QueryBuilder($this->db);
|
|
}
|
|
|
|
/**
|
|
* Loads the metadata for the specified table.
|
|
* @param string $name table name
|
|
* @return TableSchema driver dependent table metadata. Null if the table does not exist.
|
|
*/
|
|
protected function loadTableSchema($name)
|
|
{
|
|
$table = new TableSchema;
|
|
$this->resolveTableNames($table, $name);
|
|
|
|
if ($this->findColumns($table)) {
|
|
$this->findConstraints($table);
|
|
|
|
return $table;
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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') {
|
|
$values = explode(',', $matches[2]);
|
|
foreach ($values 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) {
|
|
if ($column->type === 'timestamp' && $info['default'] === 'CURRENT_TIMESTAMP') {
|
|
$column->defaultValue = new Expression('CURRENT_TIMESTAMP');
|
|
} 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 boolean 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
|
|
*/
|
|
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 $constraint) {
|
|
$table->foreignKeys[] = 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]+)\s*\(([^\(\)]+)\)/mi';
|
|
if (preg_match_all($regexp, $sql, $matches, PREG_SET_ORDER)) {
|
|
foreach ($matches as $match) {
|
|
$indexName = str_replace('`', '', $match[1]);
|
|
$indexColumns = array_map('trim', explode(',', str_replace('`', '', $match[2])));
|
|
$uniqueIndexes[$indexName] = $indexColumns;
|
|
}
|
|
}
|
|
|
|
return $uniqueIndexes;
|
|
}
|
|
|
|
/**
|
|
* Returns all table names in the database.
|
|
* @param string $schema the schema of the tables. Defaults to empty string, meaning the current or default schema.
|
|
* @return array all table names in the database. The names have NO schema name prefix.
|
|
*/
|
|
protected function findTableNames($schema = '')
|
|
{
|
|
$sql = 'SHOW TABLES';
|
|
if ($schema !== '') {
|
|
$sql .= ' FROM ' . $this->quoteSimpleTableName($schema);
|
|
}
|
|
|
|
return $this->db->createCommand($sql)->queryColumn();
|
|
}
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
public function createColumnSchemaBuilder($type, $length = null)
|
|
{
|
|
return new ColumnSchemaBuilder($type, $length, $this->db);
|
|
}
|
|
}
|