Schema.php 11.5 KB
Newer Older
w  
Qiang Xue committed
1 2
<?php
/**
Qiang Xue committed
3
 * Driver class file.
w  
Qiang Xue committed
4 5
 *
 * @link http://www.yiiframework.com/
Qiang Xue committed
6
 * @copyright Copyright &copy; 2008 Yii Software LLC
w  
Qiang Xue committed
7 8 9
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
10
namespace yii\db;
w  
Qiang Xue committed
11

Qiang Xue committed
12
use yii\base\NotSupportedException;
Qiang Xue committed
13
use yii\base\InvalidCallException;
Qiang Xue committed
14
use yii\caching\Cache;
w  
Qiang Xue committed
15

w  
Qiang Xue committed
16
/**
Qiang Xue committed
17
 * Schema is the base class for concrete DBMS-specific schema classes.
Qiang Xue committed
18
 *
Qiang Xue committed
19
 * Schema represents the database schema information that is DBMS specific.
Qiang Xue committed
20
 *
Qiang Xue committed
21
 * @property QueryBuilder $queryBuilder the query builder for the DBMS represented by this schema
Qiang Xue committed
22
 * @property array $tableNames the names of all tables in this database.
Qiang Xue committed
23
 * @property array $tableSchemas the schema information for all tables in this database.
w  
Qiang Xue committed
24 25
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
w  
Qiang Xue committed
26
 * @since 2.0
w  
Qiang Xue committed
27
 */
Qiang Xue committed
28
abstract class Schema extends \yii\base\Object
w  
Qiang Xue committed
29
{
Qiang Xue committed
30 31 32
	/**
	 * The followings are the supported abstract column data types.
	 */
Qiang Xue committed
33
	const TYPE_PK = 'pk';
Qiang Xue committed
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
	const TYPE_STRING = 'string';
	const TYPE_TEXT = 'text';
	const TYPE_SMALLINT = 'smallint';
	const TYPE_INTEGER = 'integer';
	const TYPE_BIGINT = 'bigint';
	const TYPE_FLOAT = 'float';
	const TYPE_DECIMAL = 'decimal';
	const TYPE_DATETIME = 'datetime';
	const TYPE_TIMESTAMP = 'timestamp';
	const TYPE_TIME = 'time';
	const TYPE_DATE = 'date';
	const TYPE_BINARY = 'binary';
	const TYPE_BOOLEAN = 'boolean';
	const TYPE_MONEY = 'money';

Qiang Xue committed
49
	/**
Qiang Xue committed
50
	 * @var Connection the database connection
Qiang Xue committed
51
	 */
Qiang Xue committed
52
	public $db;
Qiang Xue committed
53 54 55
	/**
	 * @var array list of ALL table names in the database
	 */
w  
Qiang Xue committed
56
	private $_tableNames = array();
Qiang Xue committed
57
	/**
Qiang Xue committed
58
	 * @var array list of loaded table metadata (table name => TableSchema)
Qiang Xue committed
59
	 */
w  
Qiang Xue committed
60
	private $_tables = array();
Qiang Xue committed
61 62 63
	/**
	 * @var QueryBuilder the query builder for this database
	 */
w  
Qiang Xue committed
64 65 66 67 68
	private $_builder;

	/**
	 * Loads the metadata for the specified table.
	 * @param string $name table name
Qiang Xue committed
69
	 * @return TableSchema DBMS-dependent table metadata, null if the table does not exist.
w  
Qiang Xue committed
70
	 */
w  
Qiang Xue committed
71
	abstract protected function loadTableSchema($name);
w  
Qiang Xue committed
72 73 74 75


	/**
	 * Obtains the metadata for the named table.
w  
Qiang Xue committed
76
	 * @param string $name table name. The table name may contain schema name if any. Do not quote the table name.
Qiang Xue committed
77
	 * @param boolean $refresh whether to reload the table schema even if it is found in the cache.
Qiang Xue committed
78
	 * @return TableSchema table metadata. Null if the named table does not exist.
w  
Qiang Xue committed
79
	 */
Qiang Xue committed
80
	public function getTableSchema($name, $refresh = false)
w  
Qiang Xue committed
81
	{
Qiang Xue committed
82
		if (isset($this->_tables[$name]) && !$refresh) {
w  
Qiang Xue committed
83
			return $this->_tables[$name];
w  
Qiang Xue committed
84
		}
w  
Qiang Xue committed
85

Qiang Xue committed
86
		$db = $this->db;
87
		$realName = $this->getRealTableName($name);
Qiang Xue committed
88

Qiang Xue committed
89
		/** @var $cache Cache */
90
		if ($db->enableSchemaCache && ($cache = \Yii::$application->getComponent($db->schemaCacheID)) !== null && !in_array($name, $db->schemaCacheExclude, true)) {
Qiang Xue committed
91
			$key = $this->getCacheKey($cache, $name);
Qiang Xue committed
92
			if ($refresh || ($table = $cache->get($key)) === false) {
w  
Qiang Xue committed
93 94
				$table = $this->loadTableSchema($realName);
				if ($table !== null) {
95
					$cache->set($key, $table, $db->schemaCacheDuration);
w  
Qiang Xue committed
96 97
				}
			}
w  
Qiang Xue committed
98
			$this->_tables[$name] = $table;
Qiang Xue committed
99
		} else {
w  
Qiang Xue committed
100 101
			$this->_tables[$name] = $table = $this->loadTableSchema($realName);
		}
w  
Qiang Xue committed
102

w  
Qiang Xue committed
103
		return $table;
w  
Qiang Xue committed
104 105
	}

Qiang Xue committed
106 107
	/**
	 * Returns the cache key for the specified table name.
Qiang Xue committed
108
	 * @param Cache $cache the cache component
Qiang Xue committed
109 110 111
	 * @param string $name the table name
	 * @return string the cache key
	 */
Qiang Xue committed
112
	public function getCacheKey($cache, $name)
Qiang Xue committed
113
	{
Qiang Xue committed
114
		return $cache->buildKey(__CLASS__, $this->db->dsn, $this->db->username, $name);
Qiang Xue committed
115 116
	}

w  
Qiang Xue committed
117 118
	/**
	 * Returns the metadata for all tables in the database.
Qiang Xue committed
119 120 121
	 * @param string $schema the schema of the tables. Defaults to empty string, meaning the current or default schema name.
	 * @param boolean $refresh whether to fetch the latest available table schemas. If this is false,
	 * cached data may be returned if available.
w  
Qiang Xue committed
122
	 * @return array the metadata for all tables in the database.
Qiang Xue committed
123
	 * Each array element is an instance of [[TableSchema]] or its child class.
w  
Qiang Xue committed
124
	 */
Qiang Xue committed
125
	public function getTableSchemas($schema = '', $refresh = false)
w  
Qiang Xue committed
126 127
	{
		$tables = array();
Qiang Xue committed
128 129 130 131 132
		foreach ($this->getTableNames($schema, $refresh) as $name) {
			if ($schema !== '') {
				$name = $schema . '.' . $name;
			}
			if (($table = $this->getTableSchema($name, $refresh)) !== null) {
w  
Qiang Xue committed
133 134
				$tables[] = $table;
			}
w  
Qiang Xue committed
135 136 137 138 139 140
		}
		return $tables;
	}

	/**
	 * Returns all table names in the database.
Qiang Xue committed
141
	 * @param string $schema the schema of the tables. Defaults to empty string, meaning the current or default schema name.
w  
Qiang Xue committed
142
	 * If not empty, the returned table names will be prefixed with the schema name.
Qiang Xue committed
143 144
	 * @param boolean $refresh whether to fetch the latest available table names. If this is false,
	 * table names fetched previously (if available) will be returned.
w  
Qiang Xue committed
145 146
	 * @return array all table names in the database.
	 */
Qiang Xue committed
147
	public function getTableNames($schema = '', $refresh = false)
w  
Qiang Xue committed
148
	{
Qiang Xue committed
149
		if (!isset($this->_tableNames[$schema]) || $refresh) {
w  
Qiang Xue committed
150
			$this->_tableNames[$schema] = $this->findTableNames($schema);
w  
Qiang Xue committed
151
		}
w  
Qiang Xue committed
152 153 154 155
		return $this->_tableNames[$schema];
	}

	/**
w  
Qiang Xue committed
156
	 * @return QueryBuilder the query builder for this connection.
w  
Qiang Xue committed
157
	 */
w  
Qiang Xue committed
158
	public function getQueryBuilder()
w  
Qiang Xue committed
159
	{
w  
Qiang Xue committed
160 161 162 163
		if ($this->_builder === null) {
			$this->_builder = $this->createQueryBuilder();
		}
		return $this->_builder;
w  
Qiang Xue committed
164 165 166 167
	}

	/**
	 * Refreshes the schema.
168 169
	 * This method cleans up all cached table schemas so that they can be re-created later
	 * to reflect the database schema change.
w  
Qiang Xue committed
170
	 */
171
	public function refresh()
w  
Qiang Xue committed
172
	{
173
		/** @var $cache \yii\caching\Cache */
Qiang Xue committed
174
		if ($this->db->enableSchemaCache && ($cache = \Yii::$application->getComponent($this->db->schemaCacheID)) !== null) {
175
			foreach ($this->_tables as $name => $table) {
Qiang Xue committed
176
				$cache->delete($this->getCacheKey($cache, $name));
w  
Qiang Xue committed
177 178
			}
		}
Qiang Xue committed
179
		$this->_tableNames = array();
180 181 182 183 184 185 186 187 188 189
		$this->_tables = array();
	}

	/**
	 * Creates a query builder for the database.
	 * This method may be overridden by child classes to create a DBMS-specific query builder.
	 * @return QueryBuilder query builder instance
	 */
	public function createQueryBuilder()
	{
Qiang Xue committed
190
		return new QueryBuilder($this->db);
191 192 193 194 195 196 197
	}

	/**
	 * Returns all table names in the database.
	 * This method should be overridden by child classes in order to support this feature
	 * because the default implementation simply throws an exception.
	 * @param string $schema the schema of the tables. Defaults to empty string, meaning the current or default schema.
Qiang Xue committed
198 199
	 * @return array all table names in the database. The names have NO the schema name prefix.
	 * @throws NotSupportedException if this method is called
200 201 202
	 */
	protected function findTableNames($schema = '')
	{
Qiang Xue committed
203
		throw new NotSupportedException(get_class($this) . ' does not support fetching all table names.');
w  
Qiang Xue committed
204 205
	}

Qiang Xue committed
206 207 208 209
	/**
	 * Returns the ID of the last inserted row or sequence value.
	 * @param string $sequenceName name of the sequence object (required by some DBMS)
	 * @return string the row ID of the last row inserted, or the last value retrieved from the sequence object
Qiang Xue committed
210
	 * @throws InvalidCallException if the DB connection is not active
Qiang Xue committed
211 212 213 214
	 * @see http://www.php.net/manual/en/function.PDO-lastInsertId.php
	 */
	public function getLastInsertID($sequenceName = '')
	{
Qiang Xue committed
215 216
		if ($this->db->isActive) {
			return $this->db->pdo->lastInsertId($sequenceName);
Qiang Xue committed
217
		} else {
Qiang Xue committed
218
			throw new InvalidCallException('DB Connection is not active.');
Qiang Xue committed
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
		}
	}

	/**
	 * Quotes a string value for use in a query.
	 * Note that if the parameter is not a string, it will be returned without change.
	 * @param string $str string to be quoted
	 * @return string the properly quoted string
	 * @see http://www.php.net/manual/en/function.PDO-quote.php
	 */
	public function quoteValue($str)
	{
		if (!is_string($str)) {
			return $str;
		}

Qiang Xue committed
235 236
		$this->db->open();
		if (($value = $this->db->pdo->quote($str)) !== false) {
Qiang Xue committed
237 238 239 240 241 242
			return $value;
		} else { // the driver doesn't support quote (e.g. oci)
			return "'" . addcslashes(str_replace("'", "''", $str), "\000\n\r\\\032") . "'";
		}
	}

w  
Qiang Xue committed
243 244 245
	/**
	 * Quotes a table name for use in a query.
	 * If the table name contains schema prefix, the prefix will also be properly quoted.
246 247
	 * If the table name is already quoted or contains special characters including '(', '[[' and '{{',
	 * then this method will do nothing.
w  
Qiang Xue committed
248 249 250 251 252 253
	 * @param string $name table name
	 * @return string the properly quoted table name
	 * @see quoteSimpleTableName
	 */
	public function quoteTableName($name)
	{
254 255 256
		if (strpos($name, '(') !== false || strpos($name, '[[') !== false || strpos($name, '{{') !== false) {
			return $name;
		}
w  
Qiang Xue committed
257
		if (strpos($name, '.') === false) {
w  
Qiang Xue committed
258
			return $this->quoteSimpleTableName($name);
w  
Qiang Xue committed
259
		}
w  
Qiang Xue committed
260
		$parts = explode('.', $name);
w  
Qiang Xue committed
261
		foreach ($parts as $i => $part) {
w  
Qiang Xue committed
262
			$parts[$i] = $this->quoteSimpleTableName($part);
w  
Qiang Xue committed
263
		}
w  
Qiang Xue committed
264 265 266 267 268 269 270
		return implode('.', $parts);

	}

	/**
	 * Quotes a column name for use in a query.
	 * If the column name contains prefix, the prefix will also be properly quoted.
271 272
	 * If the column name is already quoted or contains special characters including '(', '[[' and '{{',
	 * then this method will do nothing.
w  
Qiang Xue committed
273 274 275 276 277 278
	 * @param string $name column name
	 * @return string the properly quoted column name
	 * @see quoteSimpleColumnName
	 */
	public function quoteColumnName($name)
	{
279 280 281
		if (strpos($name, '(') !== false || strpos($name, '[[') !== false || strpos($name, '{{') !== false) {
			return $name;
		}
w  
Qiang Xue committed
282
		if (($pos = strrpos($name, '.')) !== false) {
w  
Qiang Xue committed
283 284
			$prefix = $this->quoteTableName(substr($name, 0, $pos)) . '.';
			$name = substr($name, $pos + 1);
Qiang Xue committed
285
		} else {
w  
Qiang Xue committed
286
			$prefix = '';
Qiang Xue committed
287
		}
w  
Qiang Xue committed
288
		return $prefix . $this->quoteSimpleColumnName($name);
w  
Qiang Xue committed
289 290 291
	}

	/**
292 293 294 295 296
	 * Quotes a simple table name for use in a query.
	 * A simple table name should contain the table name only without any schema prefix.
	 * If the table name is already quoted, this method will do nothing.
	 * @param string $name table name
	 * @return string the properly quoted table name
w  
Qiang Xue committed
297
	 */
298
	public function quoteSimpleTableName($name)
w  
Qiang Xue committed
299
	{
300
		return strpos($name, "'") !== false ? $name : "'" . $name . "'";
w  
Qiang Xue committed
301 302 303
	}

	/**
304 305 306 307 308
	 * Quotes a simple column name for use in a query.
	 * A simple column name should contain the column name only without any prefix.
	 * If the column name is already quoted or is the asterisk character '*', this method will do nothing.
	 * @param string $name column name
	 * @return string the properly quoted column name
w  
Qiang Xue committed
309
	 */
310
	public function quoteSimpleColumnName($name)
w  
Qiang Xue committed
311
	{
312
		return strpos($name, '"') !== false || $name === '*' ? $name : '"' . $name . '"';
w  
Qiang Xue committed
313 314 315
	}

	/**
316 317 318 319 320
	 * Returns the real name of a table name.
	 * This method will strip off curly brackets from the given table name
	 * and replace the percentage character in the name with [[Connection::tablePrefix]].
	 * @param string $name the table name to be converted
	 * @return string the real name of the given table name
w  
Qiang Xue committed
321
	 */
322
	public function getRealTableName($name)
w  
Qiang Xue committed
323
	{
Qiang Xue committed
324
		if ($this->db->enableAutoQuoting && strpos($name, '{{') !== false) {
325
			$name = preg_replace('/\\{\\{(.*?)\\}\\}/', '\1', $name);
Qiang Xue committed
326
			return str_replace('%', $this->db->tablePrefix, $name);
327 328 329
		} else {
			return $name;
		}
w  
Qiang Xue committed
330
	}
Qiang Xue committed
331 332 333

	/**
	 * Extracts the PHP type from abstract DB type.
334
	 * @param ColumnSchema $column the column schema information
Qiang Xue committed
335 336
	 * @return string PHP type name
	 */
337
	protected function getColumnPhpType($column)
Qiang Xue committed
338 339 340 341 342 343 344 345
	{
		static $typeMap = array( // abstract type => php type
			'smallint' => 'integer',
			'integer' => 'integer',
			'bigint' => 'integer',
			'boolean' => 'boolean',
			'float' => 'double',
		);
346 347 348 349 350
		if (isset($typeMap[$column->type])) {
			if ($column->type === 'bigint') {
				return PHP_INT_SIZE == 8 && !$column->unsigned ? 'integer' : 'string';
			} elseif ($column->type === 'integer') {
				return PHP_INT_SIZE == 4 && $column->unsigned ? 'string' : 'integer';
Qiang Xue committed
351
			} else {
352
				return $typeMap[$column->type];
Qiang Xue committed
353 354 355 356 357
			}
		} else {
			return 'string';
		}
	}
w  
Qiang Xue committed
358
}