123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292 |
- <?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\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 <[email protected]>
- * @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_SMALLINT,
- '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_FLOAT,
- 'real' => self::TYPE_FLOAT,
- 'decimal' => self::TYPE_DECIMAL,
- 'numeric' => self::TYPE_DECIMAL,
- 'tinytext' => self::TYPE_TEXT,
- 'mediumtext' => self::TYPE_TEXT,
- 'longtext' => self::TYPE_TEXT,
- 'text' => self::TYPE_TEXT,
- 'varchar' => self::TYPE_STRING,
- 'string' => self::TYPE_STRING,
- 'char' => self::TYPE_STRING,
- '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 = new ColumnSchema;
- $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 = strpos($column->dbType, 'unsigned') !== false;
- $column->type = self::TYPE_STRING;
- if (preg_match('/^(\w+)(?:\(([^\)]+)\))?/', $column->dbType, $matches)) {
- $type = $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 === 'tinyint' || $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->type !== 'timestamp' || $info['Default'] !== 'CURRENT_TIMESTAMP') {
- $column->defaultValue = $column->typecast($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->quoteSimpleTableName($table->name);
- try {
- $columns = $this->db->createCommand($sql)->queryAll();
- } catch (\Exception $e) {
- $previous = $e->getPrevious();
- if ($previous instanceof \PDOException && $previous->getCode() == '42S02') {
- // table does not exist
- return false;
- }
- throw $e;
- }
- foreach ($columns as $info) {
- $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->quoteSimpleTableName($table->name))->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 = $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[] = $constraint;
- }
- }
- }
- /**
- * Returns all unique indexes for the given table.
- * Each array element is of the following structure:
- *
- * ~~~
- * [
- * '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();
- }
- }
|