Schema.php 11.4 KB
Newer Older
w  
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
w  
Qiang Xue committed
5 6 7
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
8
namespace yii\db;
w  
Qiang Xue committed
9

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

w  
Qiang Xue committed
15
/**
Qiang Xue committed
16
 * Schema is the base class for concrete DBMS-specific schema classes.
Qiang Xue committed
17
 *
Qiang Xue committed
18
 * Schema represents the database schema information that is DBMS specific.
Qiang Xue committed
19
 *
Qiang Xue committed
20
 * @property QueryBuilder $queryBuilder the query builder for the DBMS represented by this schema
Qiang Xue committed
21
 * @property array $tableNames the names of all tables in this database.
Qiang Xue committed
22
 * @property array $tableSchemas the schema information for all tables in this database.
w  
Qiang Xue committed
23 24
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
w  
Qiang Xue committed
25
 * @since 2.0
w  
Qiang Xue committed
26
 */
Qiang Xue committed
27
abstract class Schema extends \yii\base\Object
w  
Qiang Xue committed
28
{
Qiang Xue committed
29 30 31
	/**
	 * The followings are the supported abstract column data types.
	 */
Qiang Xue committed
32
	const TYPE_PK = 'pk';
Qiang Xue committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
	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
48
	/**
Qiang Xue committed
49
	 * @var Connection the database connection
Qiang Xue committed
50
	 */
Qiang Xue committed
51
	public $db;
Qiang Xue committed
52 53 54
	/**
	 * @var array list of ALL table names in the database
	 */
w  
Qiang Xue committed
55
	private $_tableNames = array();
Qiang Xue committed
56
	/**
Qiang Xue committed
57
	 * @var array list of loaded table metadata (table name => TableSchema)
Qiang Xue committed
58
	 */
w  
Qiang Xue committed
59
	private $_tables = array();
Qiang Xue committed
60 61 62
	/**
	 * @var QueryBuilder the query builder for this database
	 */
w  
Qiang Xue committed
63 64 65 66 67
	private $_builder;

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


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

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

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

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

w  
Qiang Xue committed
121 122
	/**
	 * Returns the metadata for all tables in the database.
Qiang Xue committed
123 124 125
	 * @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
126
	 * @return array the metadata for all tables in the database.
Qiang Xue committed
127
	 * Each array element is an instance of [[TableSchema]] or its child class.
w  
Qiang Xue committed
128
	 */
Qiang Xue committed
129
	public function getTableSchemas($schema = '', $refresh = false)
w  
Qiang Xue committed
130 131
	{
		$tables = array();
Qiang Xue committed
132 133 134 135 136
		foreach ($this->getTableNames($schema, $refresh) as $name) {
			if ($schema !== '') {
				$name = $schema . '.' . $name;
			}
			if (($table = $this->getTableSchema($name, $refresh)) !== null) {
w  
Qiang Xue committed
137 138
				$tables[] = $table;
			}
w  
Qiang Xue committed
139 140 141 142 143 144
		}
		return $tables;
	}

	/**
	 * Returns all table names in the database.
Qiang Xue committed
145
	 * @param string $schema the schema of the tables. Defaults to empty string, meaning the current or default schema name.
w  
Qiang Xue committed
146
	 * If not empty, the returned table names will be prefixed with the schema name.
Qiang Xue committed
147 148
	 * @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
149 150
	 * @return array all table names in the database.
	 */
Qiang Xue committed
151
	public function getTableNames($schema = '', $refresh = false)
w  
Qiang Xue committed
152
	{
Qiang Xue committed
153
		if (!isset($this->_tableNames[$schema]) || $refresh) {
w  
Qiang Xue committed
154
			$this->_tableNames[$schema] = $this->findTableNames($schema);
w  
Qiang Xue committed
155
		}
w  
Qiang Xue committed
156 157 158 159
		return $this->_tableNames[$schema];
	}

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

	/**
	 * Refreshes the schema.
172 173
	 * 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
174
	 */
175
	public function refresh()
w  
Qiang Xue committed
176
	{
177 178 179
		/** @var $cache Cache */
		$cache = is_string($this->db->schemaCache) ? Yii::$app->getComponent($this->db->schemaCache) : $this->db->schemaCache;
		if ($this->db->enableSchemaCache && $cache instanceof Cache) {
180
			foreach ($this->_tables as $name => $table) {
Qiang Xue committed
181
				$cache->delete($this->getCacheKey($cache, $name));
w  
Qiang Xue committed
182 183
			}
		}
Qiang Xue committed
184
		$this->_tableNames = array();
185 186 187 188 189 190 191 192 193 194
		$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
195
		return new QueryBuilder($this->db);
196 197 198 199 200 201 202
	}

	/**
	 * 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
203 204
	 * @return array all table names in the database. The names have NO the schema name prefix.
	 * @throws NotSupportedException if this method is called
205 206 207
	 */
	protected function findTableNames($schema = '')
	{
Qiang Xue committed
208
		throw new NotSupportedException(get_class($this) . ' does not support fetching all table names.');
w  
Qiang Xue committed
209 210
	}

Qiang Xue committed
211 212 213 214
	/**
	 * 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
215
	 * @throws InvalidCallException if the DB connection is not active
Qiang Xue committed
216 217 218 219
	 * @see http://www.php.net/manual/en/function.PDO-lastInsertId.php
	 */
	public function getLastInsertID($sequenceName = '')
	{
Qiang Xue committed
220 221
		if ($this->db->isActive) {
			return $this->db->pdo->lastInsertId($sequenceName);
Qiang Xue committed
222
		} else {
Qiang Xue committed
223
			throw new InvalidCallException('DB Connection is not active.');
Qiang Xue committed
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
		}
	}

	/**
	 * 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
240 241
		$this->db->open();
		if (($value = $this->db->pdo->quote($str)) !== false) {
Qiang Xue committed
242 243 244 245 246 247
			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
248 249 250
	/**
	 * Quotes a table name for use in a query.
	 * If the table name contains schema prefix, the prefix will also be properly quoted.
251
	 * If the table name is already quoted or contains '(' or '{{',
252
	 * then this method will do nothing.
w  
Qiang Xue committed
253 254 255 256 257 258
	 * @param string $name table name
	 * @return string the properly quoted table name
	 * @see quoteSimpleTableName
	 */
	public function quoteTableName($name)
	{
259
		if (strpos($name, '(') !== false || strpos($name, '{{') !== false) {
260 261
			return $name;
		}
w  
Qiang Xue committed
262
		if (strpos($name, '.') === false) {
w  
Qiang Xue committed
263
			return $this->quoteSimpleTableName($name);
w  
Qiang Xue committed
264
		}
w  
Qiang Xue committed
265
		$parts = explode('.', $name);
w  
Qiang Xue committed
266
		foreach ($parts as $i => $part) {
w  
Qiang Xue committed
267
			$parts[$i] = $this->quoteSimpleTableName($part);
w  
Qiang Xue committed
268
		}
w  
Qiang Xue committed
269 270 271 272 273 274 275
		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.
276
	 * If the column name is already quoted or contains '(', '[[' or '{{',
277
	 * then this method will do nothing.
w  
Qiang Xue committed
278 279 280 281 282 283
	 * @param string $name column name
	 * @return string the properly quoted column name
	 * @see quoteSimpleColumnName
	 */
	public function quoteColumnName($name)
	{
284 285 286
		if (strpos($name, '(') !== false || strpos($name, '[[') !== false || strpos($name, '{{') !== false) {
			return $name;
		}
w  
Qiang Xue committed
287
		if (($pos = strrpos($name, '.')) !== false) {
w  
Qiang Xue committed
288 289
			$prefix = $this->quoteTableName(substr($name, 0, $pos)) . '.';
			$name = substr($name, $pos + 1);
Qiang Xue committed
290
		} else {
w  
Qiang Xue committed
291
			$prefix = '';
Qiang Xue committed
292
		}
w  
Qiang Xue committed
293
		return $prefix . $this->quoteSimpleColumnName($name);
w  
Qiang Xue committed
294 295 296
	}

	/**
297 298 299 300 301
	 * 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
302
	 */
303
	public function quoteSimpleTableName($name)
w  
Qiang Xue committed
304
	{
305
		return strpos($name, "'") !== false ? $name : "'" . $name . "'";
w  
Qiang Xue committed
306 307 308
	}

	/**
309 310 311 312 313
	 * 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
314
	 */
315
	public function quoteSimpleColumnName($name)
w  
Qiang Xue committed
316
	{
317
		return strpos($name, '"') !== false || $name === '*' ? $name : '"' . $name . '"';
w  
Qiang Xue committed
318 319 320
	}

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

	/**
	 * Extracts the PHP type from abstract DB type.
339
	 * @param ColumnSchema $column the column schema information
Qiang Xue committed
340 341
	 * @return string PHP type name
	 */
342
	protected function getColumnPhpType($column)
Qiang Xue committed
343 344 345 346 347 348 349 350
	{
		static $typeMap = array( // abstract type => php type
			'smallint' => 'integer',
			'integer' => 'integer',
			'bigint' => 'integer',
			'boolean' => 'boolean',
			'float' => 'double',
		);
351 352 353 354 355
		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
356
			} else {
357
				return $typeMap[$column->type];
Qiang Xue committed
358 359 360 361 362
			}
		} else {
			return 'string';
		}
	}
w  
Qiang Xue committed
363
}