mirror of
https://github.com/yiisoft/yii2.git
synced 2025-11-04 14:46:19 +08:00
354 lines
11 KiB
PHP
354 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* @link http://www.yiiframework.com/
|
|
* @copyright Copyright (c) 2008 Yii Software LLC
|
|
* @license http://www.yiiframework.com/license/
|
|
*/
|
|
|
|
namespace yii\db\mssql;
|
|
|
|
use yii\db\ColumnSchema;
|
|
|
|
/**
|
|
* Schema is the class for retrieving metadata from a MS SQL Server databases (version 2008 and above).
|
|
*
|
|
* @author Timur Ruziev <resurtm@gmail.com>
|
|
* @since 2.0
|
|
*/
|
|
class Schema extends \yii\db\Schema
|
|
{
|
|
/**
|
|
* Default schema name to be used.
|
|
*/
|
|
const DEFAULT_SCHEMA = 'dbo';
|
|
|
|
/**
|
|
* @var array mapping from physical column types (keys) to abstract column types (values)
|
|
*/
|
|
public $typeMap = [
|
|
// exact numerics
|
|
'bigint' => self::TYPE_BIGINT,
|
|
'numeric' => self::TYPE_DECIMAL,
|
|
'bit' => self::TYPE_SMALLINT,
|
|
'smallint' => self::TYPE_SMALLINT,
|
|
'decimal' => self::TYPE_DECIMAL,
|
|
'smallmoney' => self::TYPE_MONEY,
|
|
'int' => self::TYPE_INTEGER,
|
|
'tinyint' => self::TYPE_SMALLINT,
|
|
'money' => self::TYPE_MONEY,
|
|
|
|
// approximate numerics
|
|
'float' => self::TYPE_FLOAT,
|
|
'real' => self::TYPE_FLOAT,
|
|
|
|
// date and time
|
|
'date' => self::TYPE_DATE,
|
|
'datetimeoffset' => self::TYPE_DATETIME,
|
|
'datetime2' => self::TYPE_DATETIME,
|
|
'smalldatetime' => self::TYPE_DATETIME,
|
|
'datetime' => self::TYPE_DATETIME,
|
|
'time' => self::TYPE_TIME,
|
|
|
|
// character strings
|
|
'char' => self::TYPE_STRING,
|
|
'varchar' => self::TYPE_STRING,
|
|
'text' => self::TYPE_TEXT,
|
|
|
|
// unicode character strings
|
|
'nchar' => self::TYPE_STRING,
|
|
'nvarchar' => self::TYPE_STRING,
|
|
'ntext' => self::TYPE_TEXT,
|
|
|
|
// binary strings
|
|
'binary' => self::TYPE_BINARY,
|
|
'varbinary' => self::TYPE_BINARY,
|
|
'image' => self::TYPE_BINARY,
|
|
|
|
// other data types
|
|
// 'cursor' type cannot be used with tables
|
|
'timestamp' => self::TYPE_TIMESTAMP,
|
|
'hierarchyid' => self::TYPE_STRING,
|
|
'uniqueidentifier' => self::TYPE_STRING,
|
|
'sql_variant' => self::TYPE_STRING,
|
|
'xml' => self::TYPE_STRING,
|
|
'table' => 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 MSSQL database.
|
|
* @return QueryBuilder query builder interface.
|
|
*/
|
|
public function createQueryBuilder()
|
|
{
|
|
return new QueryBuilder($this->db);
|
|
}
|
|
|
|
/**
|
|
* Loads the metadata for the specified table.
|
|
* @param string $name table name
|
|
* @return TableSchema|null driver dependent table metadata. Null if the table does not exist.
|
|
*/
|
|
public function loadTableSchema($name)
|
|
{
|
|
$table = new TableSchema();
|
|
$this->resolveTableNames($table, $name);
|
|
$this->findPrimaryKeys($table);
|
|
if ($this->findColumns($table)) {
|
|
$this->findForeignKeys($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));
|
|
$partCount = count($parts);
|
|
if ($partCount == 3) {
|
|
// catalog name, schema name and table name passed
|
|
$table->catalogName = $parts[0];
|
|
$table->schemaName = $parts[1];
|
|
$table->name = $parts[2];
|
|
} elseif ($partCount == 2) {
|
|
// only schema name and table name passed
|
|
$table->schemaName = $parts[0];
|
|
$table->name = $parts[1];
|
|
} else {
|
|
// only schema name passed
|
|
$table->schemaName = static::DEFAULT_SCHEMA;
|
|
$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['column_name'];
|
|
$column->allowNull = $info['is_nullable'] == 'YES';
|
|
$column->dbType = $info['data_type'];
|
|
$column->enumValues = []; // mssql has only vague equivalents to enum
|
|
$column->isPrimaryKey = null; // primary key will be determined in findColumns() method
|
|
$column->autoIncrement = $info['is_identity'] == 1;
|
|
$column->unsigned = stripos($column->dbType, 'unsigned') !== false;
|
|
$column->comment = $info['comment'] === null ? '' : $info['comment'];
|
|
|
|
$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])) {
|
|
$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 ($info['column_default'] == '(NULL)') {
|
|
$info['column_default'] = null;
|
|
}
|
|
if ($column->type !== 'timestamp' || $info['column_default'] !== 'CURRENT_TIMESTAMP') {
|
|
$column->defaultValue = $column->typecast($info['column_default']);
|
|
}
|
|
|
|
return $column;
|
|
}
|
|
|
|
/**
|
|
* Collects the metadata of table columns.
|
|
* @param TableSchema $table the table metadata
|
|
* @return boolean whether the table exists in the database
|
|
*/
|
|
protected function findColumns($table)
|
|
{
|
|
$columnsTableName = 'information_schema.columns';
|
|
$whereSql = "[t1].[table_name] = '{$table->name}'";
|
|
if ($table->catalogName !== null) {
|
|
$columnsTableName = "{$table->catalogName}.{$columnsTableName}";
|
|
$whereSql .= " AND [t1].[table_catalog] = '{$table->catalogName}'";
|
|
}
|
|
if ($table->schemaName !== null) {
|
|
$whereSql .= " AND [t1].[table_schema] = '{$table->schemaName}'";
|
|
}
|
|
$columnsTableName = $this->quoteTableName($columnsTableName);
|
|
|
|
$sql = <<<SQL
|
|
SELECT
|
|
[t1].[column_name], [t1].[is_nullable], [t1].[data_type], [t1].[column_default],
|
|
COLUMNPROPERTY(OBJECT_ID([t1].[table_schema] + '.' + [t1].[table_name]), [t1].[column_name], 'IsIdentity') AS is_identity,
|
|
CONVERT(VARCHAR, [t2].[value]) AS comment
|
|
FROM {$columnsTableName} AS [t1]
|
|
LEFT OUTER JOIN [sys].[extended_properties] AS [t2] ON
|
|
[t1].[ordinal_position] = [t2].[minor_id] AND
|
|
OBJECT_NAME([t2].[major_id]) = [t1].[table_name] AND
|
|
[t2].[class] = 1 AND
|
|
[t2].[class_desc] = 'OBJECT_OR_COLUMN' AND
|
|
[t2].[name] = 'MS_Description'
|
|
WHERE {$whereSql}
|
|
SQL;
|
|
|
|
try {
|
|
$columns = $this->db->createCommand($sql)->queryAll();
|
|
} catch (\Exception $e) {
|
|
return false;
|
|
}
|
|
foreach ($columns as $column) {
|
|
$column = $this->loadColumnSchema($column);
|
|
foreach ($table->primaryKey as $primaryKey) {
|
|
if (strcasecmp($column->name, $primaryKey) === 0) {
|
|
$column->isPrimaryKey = true;
|
|
break;
|
|
}
|
|
}
|
|
if ($column->isPrimaryKey && $column->autoIncrement) {
|
|
$table->sequenceName = '';
|
|
}
|
|
$table->columns[$column->name] = $column;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Collects the primary key column details for the given table.
|
|
* @param TableSchema $table the table metadata
|
|
*/
|
|
protected function findPrimaryKeys($table)
|
|
{
|
|
$keyColumnUsageTableName = 'information_schema.key_column_usage';
|
|
$tableConstraintsTableName = 'information_schema.table_constraints';
|
|
if ($table->catalogName !== null) {
|
|
$keyColumnUsageTableName = $table->catalogName . '.' . $keyColumnUsageTableName;
|
|
$tableConstraintsTableName = $table->catalogName . '.' . $tableConstraintsTableName;
|
|
}
|
|
$keyColumnUsageTableName = $this->quoteTableName($keyColumnUsageTableName);
|
|
$tableConstraintsTableName = $this->quoteTableName($tableConstraintsTableName);
|
|
|
|
$sql = <<<SQL
|
|
SELECT
|
|
[kcu].[column_name] AS [field_name]
|
|
FROM {$keyColumnUsageTableName} AS [kcu]
|
|
LEFT JOIN {$tableConstraintsTableName} AS [tc] ON
|
|
[kcu].[table_name] = [tc].[table_name] AND
|
|
[kcu].[constraint_name] = [tc].[constraint_name]
|
|
WHERE
|
|
[tc].[constraint_type] = 'PRIMARY KEY' AND
|
|
[kcu].[table_name] = :tableName AND
|
|
[kcu].[table_schema] = :schemaName
|
|
SQL;
|
|
|
|
$table->primaryKey = $this->db
|
|
->createCommand($sql, [':tableName' => $table->name, ':schemaName' => $table->schemaName])
|
|
->queryColumn();
|
|
}
|
|
|
|
/**
|
|
* Collects the foreign key column details for the given table.
|
|
* @param TableSchema $table the table metadata
|
|
*/
|
|
protected function findForeignKeys($table)
|
|
{
|
|
$referentialConstraintsTableName = 'information_schema.referential_constraints';
|
|
$keyColumnUsageTableName = 'information_schema.key_column_usage';
|
|
if ($table->catalogName !== null) {
|
|
$referentialConstraintsTableName = $table->catalogName . '.' . $referentialConstraintsTableName;
|
|
$keyColumnUsageTableName = $table->catalogName . '.' . $keyColumnUsageTableName;
|
|
}
|
|
$referentialConstraintsTableName = $this->quoteTableName($referentialConstraintsTableName);
|
|
$keyColumnUsageTableName = $this->quoteTableName($keyColumnUsageTableName);
|
|
|
|
// please refer to the following page for more details:
|
|
// http://msdn2.microsoft.com/en-us/library/aa175805(SQL.80).aspx
|
|
$sql = <<<SQL
|
|
SELECT
|
|
[kcu1].[column_name] AS [fk_column_name],
|
|
[kcu2].[table_name] AS [uq_table_name],
|
|
[kcu2].[column_name] AS [uq_column_name]
|
|
FROM {$referentialConstraintsTableName} AS [rc]
|
|
JOIN {$keyColumnUsageTableName} AS [kcu1] ON
|
|
[kcu1].[constraint_catalog] = [rc].[constraint_catalog] AND
|
|
[kcu1].[constraint_schema] = [rc].[constraint_schema] AND
|
|
[kcu1].[constraint_name] = [rc].[constraint_name]
|
|
JOIN {$keyColumnUsageTableName} AS [kcu2] ON
|
|
[kcu2].[constraint_catalog] = [rc].[constraint_catalog] AND
|
|
[kcu2].[constraint_schema] = [rc].[constraint_schema] AND
|
|
[kcu2].[constraint_name] = [rc].[constraint_name] AND
|
|
[kcu2].[ordinal_position] = [kcu1].[ordinal_position]
|
|
WHERE [kcu1].[table_name] = :tableName
|
|
SQL;
|
|
|
|
$rows = $this->db->createCommand($sql, [':tableName' => $table->name])->queryAll();
|
|
$table->foreignKeys = [];
|
|
foreach ($rows as $row) {
|
|
$table->foreignKeys[] = [$row['uq_table_name'], $row['fk_column_name'] => $row['uq_column_name']];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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 = '')
|
|
{
|
|
if ($schema === '') {
|
|
$schema = static::DEFAULT_SCHEMA;
|
|
}
|
|
|
|
$sql = <<<SQL
|
|
SELECT [t].[table]
|
|
FROM [information_schema].[tables] AS [t]
|
|
WHERE [t].[table_schema] = :schema AND [t].[table_type] = 'BASE TABLE'
|
|
SQL;
|
|
|
|
return $this->db->createCommand($sql, [':schema' => $schema])->queryColumn();
|
|
}
|
|
}
|