Connection.php 19.1 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\base\Component;
Qiang Xue committed
11 12
use yii\base\InvalidConfigException;
use yii\base\NotSupportedException;
13
use yii\caching\Cache;
w  
Qiang Xue committed
14

w  
Qiang Xue committed
15
/**
w  
Qiang Xue committed
16
 * Connection represents a connection to a database via [PDO](http://www.php.net/manual/en/ref.pdo.php).
w  
Qiang Xue committed
17
 *
w  
Qiang Xue committed
18 19 20
 * Connection works together with [[Command]], [[DataReader]] and [[Transaction]]
 * to provide data access to various DBMS in a common set of APIs. They are a thin wrapper
 * of the [[PDO PHP extension]](http://www.php.net/manual/en/ref.pdo.php).
w  
Qiang Xue committed
21
 *
w  
Qiang Xue committed
22
 * To establish a DB connection, set [[dsn]], [[username]] and [[password]], and then
23
 * call [[open()]] to be true.
w  
Qiang Xue committed
24 25
 *
 * The following example shows how to create a Connection instance and establish
w  
Qiang Xue committed
26
 * the DB connection:
w  
Qiang Xue committed
27
 *
w  
Qiang Xue committed
28
 * ~~~
Qiang Xue committed
29
 * $connection = new \yii\db\Connection(array(
Qiang Xue committed
30 31 32
 *     'dsn' => $dsn,
 *     'username' => $username,
 *     'password' => $password,
Qiang Xue committed
33
 * ));
34
 * $connection->open();
w  
Qiang Xue committed
35 36
 * ~~~
 *
Qiang Xue committed
37
 * After the DB connection is established, one can execute SQL statements like the following:
w  
Qiang Xue committed
38 39 40
 *
 * ~~~
 * $command = $connection->createCommand('SELECT * FROM tbl_post');
Qiang Xue committed
41 42 43
 * $posts = $command->queryAll();
 * $command = $connection->createCommand('UPDATE tbl_post SET status=1');
 * $command->execute();
w  
Qiang Xue committed
44 45
 * ~~~
 *
Qiang Xue committed
46 47 48
 * One can also do prepared SQL execution and bind parameters to the prepared SQL.
 * When the parameters are coming from user input, you should use this approach
 * to prevent SQL injection attacks. The following is an example:
w  
Qiang Xue committed
49
 *
w  
Qiang Xue committed
50 51 52 53 54
 * ~~~
 * $command = $connection->createCommand('SELECT * FROM tbl_post WHERE id=:id');
 * $command->bindValue(':id', $_GET['id']);
 * $post = $command->query();
 * ~~~
w  
Qiang Xue committed
55
 *
Qiang Xue committed
56 57 58 59
 * For more information about how to perform various DB queries, please refer to [[Command]].
 *
 * If the underlying DBMS supports transactions, you can perform transactional SQL queries
 * like the following:
w  
Qiang Xue committed
60
 *
w  
Qiang Xue committed
61 62 63
 * ~~~
 * $transaction = $connection->beginTransaction();
 * try {
64 65 66 67
 *     $connection->createCommand($sql1)->execute();
 *     $connection->createCommand($sql2)->execute();
 *     // ... executing other SQL statements ...
 *     $transaction->commit();
Qiang Xue committed
68
 * } catch(Exception $e) {
69
 *     $transaction->rollBack();
w  
Qiang Xue committed
70
 * }
w  
Qiang Xue committed
71
 * ~~~
w  
Qiang Xue committed
72
 *
73
 * Connection is often used as an application component and configured in the application
Qiang Xue committed
74
 * configuration like the following:
w  
Qiang Xue committed
75 76
 *
 * ~~~
w  
Qiang Xue committed
77
 * array(
Qiang Xue committed
78 79
 *	 'components' => array(
 *		 'db' => array(
Qiang Xue committed
80
 *			 'class' => '\yii\db\Connection',
Qiang Xue committed
81 82 83 84 85 86
 *			 'dsn' => 'mysql:host=127.0.0.1;dbname=demo',
 *			 'username' => 'root',
 *			 'password' => '',
 *			 'charset' => 'utf8',
 *		 ),
 *	 ),
w  
Qiang Xue committed
87
 * )
w  
Qiang Xue committed
88
 * ~~~
w  
Qiang Xue committed
89
 *
90
 * @property boolean $isActive Whether the DB connection is established. This property is read-only.
Qiang Xue committed
91 92
 * @property Transaction $transaction The currently active transaction. Null if no active transaction.
 * @property Schema $schema The database schema information for the current connection.
Qiang Xue committed
93 94 95
 * @property QueryBuilder $queryBuilder The query builder.
 * @property string $lastInsertID The row ID of the last row inserted, or the last value retrieved from the sequence object.
 * @property string $driverName Name of the DB driver currently being used.
Qiang Xue committed
96
 * @property array $querySummary The statistical results of SQL queries.
Qiang Xue committed
97
 *
w  
Qiang Xue committed
98 99 100
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
101
class Connection extends Component
w  
Qiang Xue committed
102
{
103 104 105 106 107
	/**
	 * @event Event an event that is triggered after a DB connection is established
	 */
	const EVENT_AFTER_OPEN = 'afterOpen';

w  
Qiang Xue committed
108
	/**
w  
Qiang Xue committed
109 110 111
	 * @var string the Data Source Name, or DSN, contains the information required to connect to the database.
	 * Please refer to the [PHP manual](http://www.php.net/manual/en/function.PDO-construct.php) on
	 * the format of the DSN string.
Qiang Xue committed
112
	 * @see charset
w  
Qiang Xue committed
113 114 115 116 117 118 119 120 121 122
	 */
	public $dsn;
	/**
	 * @var string the username for establishing DB connection. Defaults to empty string.
	 */
	public $username = '';
	/**
	 * @var string the password for establishing DB connection. Defaults to empty string.
	 */
	public $password = '';
w  
Qiang Xue committed
123
	/**
Qiang Xue committed
124
	 * @var array PDO attributes (name=>value) that should be set when calling [[open()]]
w  
Qiang Xue committed
125 126 127 128 129 130 131
	 * to establish a DB connection. Please refer to the
	 * [PHP manual](http://www.php.net/manual/en/function.PDO-setAttribute.php) for
	 * details about available attributes.
	 */
	public $attributes;
	/**
	 * @var \PDO the PHP PDO instance associated with this DB connection.
132
	 * This property is mainly managed by [[open()]] and [[close()]] methods.
w  
Qiang Xue committed
133 134 135 136
	 * When a DB connection is active, this property will represent a PDO instance;
	 * otherwise, it will be null.
	 */
	public $pdo;
137 138 139
	/**
	 * @var boolean whether to enable schema caching.
	 * Note that in order to enable truly schema caching, a valid cache component as specified
140
	 * by [[schemaCache]] must be enabled and [[enableSchemaCache]] must be set true.
141 142
	 * @see schemaCacheDuration
	 * @see schemaCacheExclude
143
	 * @see schemaCache
144 145
	 */
	public $enableSchemaCache = false;
w  
Qiang Xue committed
146 147
	/**
	 * @var integer number of seconds that table metadata can remain valid in cache.
w  
Qiang Xue committed
148
	 * Use 0 to indicate that the cached data will never expire.
149
	 * @see enableSchemaCache
w  
Qiang Xue committed
150
	 */
151
	public $schemaCacheDuration = 3600;
w  
Qiang Xue committed
152 153
	/**
	 * @var array list of tables whose metadata should NOT be cached. Defaults to empty array.
Qiang Xue committed
154
	 * The table names may contain schema prefix, if any. Do not quote the table names.
155
	 * @see enableSchemaCache
w  
Qiang Xue committed
156
	 */
157
	public $schemaCacheExclude = array();
w  
Qiang Xue committed
158
	/**
159 160
	 * @var Cache|string the cache object or the ID of the cache application component that
	 * is used to cache the table metadata.
161
	 * @see enableSchemaCache
w  
Qiang Xue committed
162
	 */
163
	public $schemaCache = 'cache';
w  
Qiang Xue committed
164
	/**
165
	 * @var boolean whether to enable query caching.
w  
Qiang Xue committed
166
	 * Note that in order to enable query caching, a valid cache component as specified
167
	 * by [[queryCache]] must be enabled and [[enableQueryCache]] must be set true.
w  
Qiang Xue committed
168
	 *
169 170 171
	 * Methods [[beginCache()]] and [[endCache()]] can be used as shortcuts to turn on
	 * and off query caching on the fly.
	 * @see queryCacheDuration
172
	 * @see queryCache
173 174 175
	 * @see queryCacheDependency
	 * @see beginCache()
	 * @see endCache()
w  
Qiang Xue committed
176
	 */
177
	public $enableQueryCache = false;
w  
Qiang Xue committed
178
	/**
179
	 * @var integer number of seconds that query results can remain valid in cache.
180
	 * Defaults to 3600, meaning 3600 seconds, or one hour.
181 182
	 * Use 0 to indicate that the cached data will never expire.
	 * @see enableQueryCache
w  
Qiang Xue committed
183
	 */
184
	public $queryCacheDuration = 3600;
w  
Qiang Xue committed
185
	/**
186 187 188
	 * @var \yii\caching\Dependency the dependency that will be used when saving query results into cache.
	 * Defaults to null, meaning no dependency.
	 * @see enableQueryCache
w  
Qiang Xue committed
189
	 */
190
	public $queryCacheDependency;
w  
Qiang Xue committed
191
	/**
192 193
	 * @var Cache|string the cache object or the ID of the cache application component
	 * that is used for query caching.
194
	 * @see enableQueryCache
w  
Qiang Xue committed
195
	 */
196
	public $queryCache = 'cache';
w  
Qiang Xue committed
197 198 199 200 201 202 203 204 205 206 207 208 209 210
	/**
	 * @var string the charset used for database connection. The property is only used
	 * for MySQL and PostgreSQL databases. Defaults to null, meaning using default charset
	 * as specified by the database.
	 *
	 * Note that if you're using GBK or BIG5 then it's highly recommended to
	 * update to PHP 5.3.6+ and to specify charset via DSN like
	 * 'mysql:dbname=mydatabase;host=127.0.0.1;charset=GBK;'.
	 */
	public $charset;
	/**
	 * @var boolean whether to turn on prepare emulation. Defaults to false, meaning PDO
	 * will use the native prepare support if available. For some databases (such as MySQL),
	 * this may need to be set true so that PDO can emulate the prepare support to bypass
Qiang Xue committed
211 212
	 * the buggy native prepare support.
	 * The default value is null, which means the PDO ATTR_EMULATE_PREPARES value will not be changed.
w  
Qiang Xue committed
213 214 215
	 */
	public $emulatePrepare;
	/**
w  
Qiang Xue committed
216
	 * @var boolean whether to enable profiling for the SQL statements being executed.
w  
Qiang Xue committed
217 218
	 * Defaults to false. This should be mainly enabled and used during development
	 * to find out the bottleneck of SQL executions.
w  
Qiang Xue committed
219
	 * @see getStats
w  
Qiang Xue committed
220 221 222
	 */
	public $enableProfiling = false;
	/**
223 224 225
	 * @var string the common prefix or suffix for table names. If a table name is given
	 * as `{{%TableName}}`, then the percentage character `%` will be replaced with this
	 * property value. For example, `{{%post}}` becomes `{{tbl_post}}` if this property is
226
	 * set as `"tbl_"`.
w  
Qiang Xue committed
227 228 229
	 */
	public $tablePrefix;
	/**
Qiang Xue committed
230
	 * @var array mapping between PDO driver names and [[Schema]] classes.
w  
Qiang Xue committed
231
	 * The keys of the array are PDO driver names while the values the corresponding
Qiang Xue committed
232
	 * schema class name or configuration. Please refer to [[\Yii::createObject()]] for
w  
Qiang Xue committed
233 234
	 * details on how to specify a configuration.
	 *
Qiang Xue committed
235
	 * This property is mainly used by [[getSchema()]] when fetching the database schema information.
Qiang Xue committed
236
	 * You normally do not need to set this property unless you want to use your own
Qiang Xue committed
237 238 239
	 * [[Schema]] class to support DBMS that is not supported by Yii.
	 */
	public $schemaMap = array(
240 241 242 243
		'pgsql' => 'yii\db\pgsql\Schema',    // PostgreSQL
		'mysqli' => 'yii\db\mysql\Schema',   // MySQL
		'mysql' => 'yii\db\mysql\Schema',    // MySQL
		'sqlite' => 'yii\db\sqlite\Schema',  // sqlite 3
Qiang Xue committed
244 245
		'sqlite2' => 'yii\db\sqlite\Schema', // sqlite 2
		'mssql' => 'yi\db\dao\mssql\Schema', // Mssql driver on windows hosts
246 247 248
		'sqlsrv' => 'yii\db\mssql\Schema',   // Mssql
		'oci' => 'yii\db\oci\Schema',        // Oracle driver
		'dblib' => 'yii\db\mssql\Schema',    // dblib drivers on linux (and maybe others os) hosts
w  
Qiang Xue committed
249
	);
Qiang Xue committed
250 251 252
	/**
	 * @var Transaction the currently active transaction
	 */
w  
Qiang Xue committed
253
	private $_transaction;
Qiang Xue committed
254
	/**
Qiang Xue committed
255
	 * @var Schema the database schema
Qiang Xue committed
256
	 */
Qiang Xue committed
257
	private $_schema;
w  
Qiang Xue committed
258 259

	/**
w  
Qiang Xue committed
260
	 * Closes the connection when this component is being serialized.
w  
Qiang Xue committed
261 262 263 264 265 266 267 268 269
	 * @return array
	 */
	public function __sleep()
	{
		$this->close();
		return array_keys(get_object_vars($this));
	}

	/**
w  
Qiang Xue committed
270
	 * Returns a value indicating whether the DB connection is established.
w  
Qiang Xue committed
271 272
	 * @return boolean whether the DB connection is established
	 */
273
	public function getIsActive()
w  
Qiang Xue committed
274
	{
w  
Qiang Xue committed
275
		return $this->pdo !== null;
w  
Qiang Xue committed
276 277 278
	}

	/**
279 280 281
	 * Turns on query caching.
	 * This method is provided as a shortcut to setting two properties that are related
	 * with query caching: [[queryCacheDuration]] and [[queryCacheDependency]].
w  
Qiang Xue committed
282
	 * @param integer $duration the number of seconds that query results may remain valid in cache.
283
	 * If not set, it will use the value of [[queryCacheDuration]]. See [[queryCacheDuration]] for more details.
Qiang Xue committed
284
	 * @param \yii\caching\Dependency $dependency the dependency for the cached query result.
285 286 287 288 289 290 291 292 293 294 295 296 297
	 * See [[queryCacheDependency]] for more details.
	 */
	public function beginCache($duration = null, $dependency = null)
	{
		$this->enableQueryCache = true;
		if ($duration !== null) {
			$this->queryCacheDuration = $duration;
		}
		$this->queryCacheDependency = $dependency;
	}

	/**
	 * Turns off query caching.
w  
Qiang Xue committed
298
	 */
299
	public function endCache()
w  
Qiang Xue committed
300
	{
301
		$this->enableQueryCache = false;
w  
Qiang Xue committed
302 303 304
	}

	/**
w  
Qiang Xue committed
305 306 307
	 * Establishes a DB connection.
	 * It does nothing if a DB connection has already been established.
	 * @throws Exception if connection fails
w  
Qiang Xue committed
308
	 */
w  
Qiang Xue committed
309
	public function open()
w  
Qiang Xue committed
310
	{
w  
Qiang Xue committed
311 312
		if ($this->pdo === null) {
			if (empty($this->dsn)) {
313
				throw new InvalidConfigException('Connection::dsn cannot be empty.');
w  
Qiang Xue committed
314 315
			}
			try {
316
				\Yii::trace('Opening DB connection: ' . $this->dsn, __METHOD__);
w  
Qiang Xue committed
317
				$this->pdo = $this->createPdoInstance();
Qiang Xue committed
318
				$this->initConnection();
w  
Qiang Xue committed
319
			}
w  
Qiang Xue committed
320
			catch (\PDOException $e) {
321
				\Yii::error("Failed to open DB connection ({$this->dsn}): " . $e->getMessage(), __METHOD__);
Qiang Xue committed
322
				$message = YII_DEBUG ? 'Failed to open DB connection: ' . $e->getMessage() : 'Failed to open DB connection.';
323
				throw new Exception($message, $e->errorInfo, (int)$e->getCode());
w  
Qiang Xue committed
324 325 326 327 328 329 330 331
			}
		}
	}

	/**
	 * Closes the currently active DB connection.
	 * It does nothing if the connection is already closed.
	 */
w  
Qiang Xue committed
332
	public function close()
w  
Qiang Xue committed
333
	{
w  
Qiang Xue committed
334
		if ($this->pdo !== null) {
335
			\Yii::trace('Closing DB connection: ' . $this->dsn, __METHOD__);
w  
Qiang Xue committed
336
			$this->pdo = null;
Qiang Xue committed
337
			$this->_schema = null;
Qiang Xue committed
338
			$this->_transaction = null;
w  
Qiang Xue committed
339
		}
w  
Qiang Xue committed
340 341 342 343
	}

	/**
	 * Creates the PDO instance.
w  
Qiang Xue committed
344
	 * This method is called by [[open]] to establish a DB connection.
Qiang Xue committed
345 346
	 * The default implementation will create a PHP PDO instance.
	 * You may override this method if the default PDO needs to be adapted for certain DBMS.
w  
Qiang Xue committed
347
	 * @return \PDO the pdo instance
w  
Qiang Xue committed
348 349 350
	 */
	protected function createPdoInstance()
	{
w  
Qiang Xue committed
351 352 353 354
		$pdoClass = '\PDO';
		if (($pos = strpos($this->dsn, ':')) !== false) {
			$driver = strtolower(substr($this->dsn, 0, $pos));
			if ($driver === 'mssql' || $driver === 'dblib' || $driver === 'sqlsrv') {
Qiang Xue committed
355
				$pdoClass = 'yii\db\mssql\PDO';
w  
Qiang Xue committed
356
			}
w  
Qiang Xue committed
357
		}
w  
Qiang Xue committed
358
		return new $pdoClass($this->dsn, $this->username, $this->password, $this->attributes);
w  
Qiang Xue committed
359 360 361
	}

	/**
w  
Qiang Xue committed
362 363
	 * Initializes the DB connection.
	 * This method is invoked right after the DB connection is established.
Qiang Xue committed
364 365
	 * The default implementation turns on `PDO::ATTR_EMULATE_PREPARES`
	 * if [[emulatePrepare]] is true, and sets the database [[charset]] if it is not empty.
Qiang Xue committed
366
	 * It then triggers an [[EVENT_AFTER_OPEN]] event.
w  
Qiang Xue committed
367
	 */
w  
Qiang Xue committed
368
	protected function initConnection()
w  
Qiang Xue committed
369
	{
w  
Qiang Xue committed
370 371 372
		$this->pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);
		if ($this->emulatePrepare !== null && constant('\PDO::ATTR_EMULATE_PREPARES')) {
			$this->pdo->setAttribute(\PDO::ATTR_EMULATE_PREPARES, $this->emulatePrepare);
w  
Qiang Xue committed
373
		}
Qiang Xue committed
374 375
		if ($this->charset !== null && in_array($this->getDriverName(), array('pgsql', 'mysql', 'mysqli'))) {
			$this->pdo->exec('SET NAMES ' . $this->pdo->quote($this->charset));
w  
Qiang Xue committed
376
		}
377
		$this->trigger(self::EVENT_AFTER_OPEN);
w  
Qiang Xue committed
378 379 380 381
	}

	/**
	 * Creates a command for execution.
Qiang Xue committed
382 383
	 * @param string $sql the SQL statement to be executed
	 * @param array $params the parameters to be bound to the SQL statement
w  
Qiang Xue committed
384
	 * @return Command the DB command
w  
Qiang Xue committed
385
	 */
Qiang Xue committed
386
	public function createCommand($sql = null, $params = array())
w  
Qiang Xue committed
387
	{
w  
Qiang Xue committed
388
		$this->open();
389
		$command = new Command(array(
Qiang Xue committed
390
			'db' => $this,
391 392
			'sql' => $sql,
		));
Qiang Xue committed
393
		return $command->bindValues($params);
w  
Qiang Xue committed
394 395 396 397
	}

	/**
	 * Returns the currently active transaction.
w  
Qiang Xue committed
398
	 * @return Transaction the currently active transaction. Null if no active transaction.
w  
Qiang Xue committed
399
	 */
Qiang Xue committed
400
	public function getTransaction()
w  
Qiang Xue committed
401
	{
Qiang Xue committed
402
		return $this->_transaction && $this->_transaction->isActive ? $this->_transaction : null;
w  
Qiang Xue committed
403 404 405 406
	}

	/**
	 * Starts a transaction.
Qiang Xue committed
407
	 * @return Transaction the transaction initiated
w  
Qiang Xue committed
408 409 410
	 */
	public function beginTransaction()
	{
w  
Qiang Xue committed
411
		$this->open();
412
		$this->_transaction = new Transaction(array(
Qiang Xue committed
413
			'db' => $this,
414 415 416
		));
		$this->_transaction->begin();
		return $this->_transaction;
w  
Qiang Xue committed
417 418 419
	}

	/**
Qiang Xue committed
420 421
	 * Returns the schema information for the database opened by this connection.
	 * @return Schema the schema information for the database opened by this connection.
Qiang Xue committed
422
	 * @throws NotSupportedException if there is no support for the current driver type
w  
Qiang Xue committed
423
	 */
Qiang Xue committed
424
	public function getSchema()
w  
Qiang Xue committed
425
	{
Qiang Xue committed
426 427
		if ($this->_schema !== null) {
			return $this->_schema;
Qiang Xue committed
428
		} else {
w  
Qiang Xue committed
429
			$driver = $this->getDriverName();
Qiang Xue committed
430 431
			if (isset($this->schemaMap[$driver])) {
				$this->_schema = \Yii::createObject($this->schemaMap[$driver]);
Qiang Xue committed
432
				$this->_schema->db = $this;
Qiang Xue committed
433
				return $this->_schema;
Qiang Xue committed
434
			} else {
Qiang Xue committed
435
				throw new NotSupportedException("Connection does not support reading schema information for '$driver' DBMS.");
w  
Qiang Xue committed
436
			}
w  
Qiang Xue committed
437 438 439
		}
	}

Qiang Xue committed
440 441 442 443
	/**
	 * Returns the query builder for the current DB connection.
	 * @return QueryBuilder the query builder for the current DB connection.
	 */
w  
Qiang Xue committed
444 445
	public function getQueryBuilder()
	{
Qiang Xue committed
446
		return $this->getSchema()->getQueryBuilder();
w  
Qiang Xue committed
447 448
	}

Qiang Xue committed
449
	/**
Qiang Xue committed
450 451
	 * Obtains the schema information for the named table.
	 * @param string $name table name.
Qiang Xue committed
452
	 * @param boolean $refresh whether to reload the table schema even if it is found in the cache.
Qiang Xue committed
453
	 * @return TableSchema table schema information. Null if the named table does not exist.
Qiang Xue committed
454 455 456
	 */
	public function getTableSchema($name, $refresh = false)
	{
Qiang Xue committed
457
		return $this->getSchema()->getTableSchema($name, $refresh);
Qiang Xue committed
458 459
	}

w  
Qiang Xue committed
460 461 462 463 464 465 466 467
	/**
	 * 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
	 * @see http://www.php.net/manual/en/function.PDO-lastInsertId.php
	 */
	public function getLastInsertID($sequenceName = '')
	{
Qiang Xue committed
468
		return $this->getSchema()->getLastInsertID($sequenceName);
w  
Qiang Xue committed
469 470 471 472
	}

	/**
	 * Quotes a string value for use in a query.
Qiang Xue committed
473
	 * Note that if the parameter is not a string, it will be returned without change.
w  
Qiang Xue committed
474 475 476 477 478 479
	 * @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)
	{
Qiang Xue committed
480
		return $this->getSchema()->quoteValue($str);
w  
Qiang Xue committed
481 482 483 484 485
	}

	/**
	 * Quotes a table name for use in a query.
	 * If the table name contains schema prefix, the prefix will also be properly quoted.
486 487
	 * If the table name is already quoted or contains special characters including '(', '[[' and '{{',
	 * then this method will do nothing.
w  
Qiang Xue committed
488 489 490
	 * @param string $name table name
	 * @return string the properly quoted table name
	 */
491
	public function quoteTableName($name)
w  
Qiang Xue committed
492
	{
Qiang Xue committed
493
		return $this->getSchema()->quoteTableName($name);
w  
Qiang Xue committed
494 495 496 497
	}

	/**
	 * Quotes a column name for use in a query.
498 499 500
	 * If the column name contains prefix, the prefix will also be properly quoted.
	 * If the column name is already quoted or contains special characters including '(', '[[' and '{{',
	 * then this method will do nothing.
w  
Qiang Xue committed
501 502 503
	 * @param string $name column name
	 * @return string the properly quoted column name
	 */
504
	public function quoteColumnName($name)
Qiang Xue committed
505
	{
Qiang Xue committed
506
		return $this->getSchema()->quoteColumnName($name);
Qiang Xue committed
507 508
	}

509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
	/**
	 * Processes a SQL statement by quoting table and column names that are enclosed within double brackets.
	 * Tokens enclosed within double curly brackets are treated as table names, while
	 * tokens enclosed within double square brackets are column names. They will be quoted accordingly.
	 * Also, the percentage character "%" in a table name will be replaced with [[tablePrefix]].
	 * @param string $sql the SQL to be quoted
	 * @return string the quoted SQL
	 */
	public function quoteSql($sql)
	{
		$db = $this;
		return preg_replace_callback('/(\\{\\{([\w\-\. ]+)\\}\\}|\\[\\[([\w\-\. ]+)\\]\\])/',
			function($matches) use($db) {
				if (isset($matches[3])) {
					return $db->quoteColumnName($matches[3]);
				} else {
525
					return str_replace('%', $db->tablePrefix, $db->quoteTableName($matches[2]));
526 527 528 529
				}
			}, $sql);
	}

w  
Qiang Xue committed
530
	/**
w  
Qiang Xue committed
531
	 * Returns the name of the DB driver for the current [[dsn]].
w  
Qiang Xue committed
532 533 534 535
	 * @return string name of the DB driver
	 */
	public function getDriverName()
	{
w  
Qiang Xue committed
536 537
		if (($pos = strpos($this->dsn, ':')) !== false) {
			return strtolower(substr($this->dsn, 0, $pos));
Qiang Xue committed
538
		} else {
Qiang Xue committed
539
			return strtolower($this->pdo->getAttribute(\PDO::ATTR_DRIVER_NAME));
w  
Qiang Xue committed
540
		}
w  
Qiang Xue committed
541 542 543
	}

	/**
Qiang Xue committed
544
	 * Returns the statistical results of SQL queries.
w  
Qiang Xue committed
545 546
	 * The results returned include the number of SQL statements executed and
	 * the total time spent.
w  
Qiang Xue committed
547
	 * In order to use this method, [[enableProfiling]] has to be set true.
w  
Qiang Xue committed
548 549
	 * @return array the first element indicates the number of SQL statements executed,
	 * and the second element the total time spent in SQL execution.
Qiang Xue committed
550
	 * @see \yii\logging\Logger::getProfiling()
w  
Qiang Xue committed
551
	 */
Qiang Xue committed
552
	public function getQuerySummary()
w  
Qiang Xue committed
553
	{
w  
Qiang Xue committed
554
		$logger = \Yii::getLogger();
Qiang Xue committed
555
		$timings = $logger->getProfiling(array('yii\db\Command::query', 'yii\db\Command::execute'));
w  
Qiang Xue committed
556
		$count = count($timings);
w  
Qiang Xue committed
557 558 559 560
		$time = 0;
		foreach ($timings as $timing) {
			$time += $timing[1];
		}
w  
Qiang Xue committed
561 562 563
		return array($count, $time);
	}
}