* @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. * This method may be overridden by child classes to create a DBMS-specific query builder. * @return QueryBuilder query builder instance */ public function createQueryBuilder() { return new QueryBuilder($this->db); } /** * 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. * If not empty, the returned table names will be prefixed with the schema name. * @return array all table names in the database. */ public function findTableNames($schema = '') { $sql = "SELECT DISTINCT tbl_name FROM sqlite_master WHERE tbl_name<>'sqlite_sequence'"; return $this->db->createCommand($sql)->queryColumn(); } /** * 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; $table->name = $name; if ($this->findColumns($table)) { $this->findConstraints($table); return $table; } else { return null; } } /** * Collects the table column metadata. * @param TableSchema $table the table metadata * @return boolean whether the table exists in the database */ protected function findColumns($table) { $sql = "PRAGMA table_info(" . $this->quoteSimpleTableName($table->name) . ')'; $columns = $this->db->createCommand($sql)->queryAll(); if (empty($columns)) { return false; } foreach ($columns as $info) { $column = $this->loadColumnSchema($info); $table->columns[$column->name] = $column; if ($column->isPrimaryKey) { $table->primaryKey[] = $column->name; } } if (count($table->primaryKey) === 1 && !strncasecmp($table->columns[$table->primaryKey[0]]->dbType, 'int', 3)) { $table->sequenceName = ''; $table->columns[$table->primaryKey[0]]->autoIncrement = true; } return true; } /** * Collects the foreign key column details for the given table. * @param TableSchema $table the table metadata */ protected function findConstraints($table) { $sql = "PRAGMA foreign_key_list(" . $this->quoteSimpleTableName($table->name) . ')'; $keys = $this->db->createCommand($sql)->queryAll(); foreach ($keys as $key) { $id = (int)$key['id']; if (!isset($table->foreignKeys[$id])) { $table->foreignKeys[$id] = [$key['table'], $key['from'] => $key['to']]; } else { // composite FK $table->foreignKeys[$id][$key['from']] = $key['to']; } } } /** * 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 = "PRAGMA index_list(" . $this->quoteSimpleTableName($table->name) . ')'; $indexes = $this->db->createCommand($sql)->queryAll(); $uniqueIndexes = []; foreach ($indexes as $index) { $indexName = $index['name']; $indexInfo = $this->db->createCommand("PRAGMA index_info(" . $this->quoteValue($index['name']) . ")")->queryAll(); if ($index['unique']) { $uniqueIndexes[$indexName] = []; foreach ($indexInfo as $row) { $uniqueIndexes[$indexName][] = $row['name']; } } } return $uniqueIndexes; } /** * 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['name']; $column->allowNull = !$info['notnull']; $column->isPrimaryKey = $info['pk'] != 0; $column->dbType = $info['type']; $column->unsigned = strpos($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])) { $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); $value = $info['dflt_value']; if ($column->type === 'string') { $column->defaultValue = trim($value, "'\""); } else { $column->defaultValue = $column->typecast(strcasecmp($value, 'null') ? $value : null); } return $column; } }