|
|
@ -15,34 +15,23 @@ use yii\db\Exception; |
|
|
|
/** |
|
|
|
/** |
|
|
|
* Command represents a SQL statement to be executed against a database. |
|
|
|
* Command represents a SQL statement to be executed against a database. |
|
|
|
* |
|
|
|
* |
|
|
|
* A command object is usually created by calling [[Connection::createCommand]]. |
|
|
|
* A command object is usually created by calling [[Connection::createCommand()]]. |
|
|
|
* The SQL statement it represents can be set via the [[sql]] property. |
|
|
|
* The SQL statement it represents can be set via the [[sql]] property. |
|
|
|
* |
|
|
|
* |
|
|
|
* To execute a non-query SQL (such as INSERT, DELETE, UPDATE), call [[execute]]. |
|
|
|
* To execute a non-query SQL (such as INSERT, DELETE, UPDATE), call [[execute()]]. |
|
|
|
* To execute a SQL statement that returns result data set (such as SELECT), |
|
|
|
* To execute a SQL statement that returns result data set (such as SELECT), |
|
|
|
* use [[queryAll]], [[queryRow]], [[queryColumn]], [[queryScalar]], or [[query]]. |
|
|
|
* use [[queryAll()]], [[queryRow()]], [[queryColumn()]], [[queryScalar()]], or [[query()]]. |
|
|
|
* For example, |
|
|
|
* For example, |
|
|
|
* |
|
|
|
* |
|
|
|
* ~~~ |
|
|
|
* ~~~ |
|
|
|
* $users = \Yii::app()->db->createCommand('SELECT * FROM tbl_user')->queryAll(); |
|
|
|
* $users = \Yii::$application->db->createCommand('SELECT * FROM tbl_user')->queryAll(); |
|
|
|
* ~~~ |
|
|
|
* ~~~ |
|
|
|
* |
|
|
|
* |
|
|
|
* Command supports SQL statement preparation and parameter binding. |
|
|
|
* Command supports SQL statement preparation and parameter binding. |
|
|
|
* Call [[bindValue]] to bind a value to a SQL parameter; |
|
|
|
* Call [[bindValue()]] to bind a value to a SQL parameter; |
|
|
|
* Call [[bindParam]] to bind a PHP variable to a SQL parameter. |
|
|
|
* Call [[bindParam()]] to bind a PHP variable to a SQL parameter. |
|
|
|
* When binding a parameter, the SQL statement is automatically prepared. |
|
|
|
* When binding a parameter, the SQL statement is automatically prepared. |
|
|
|
* You may also call [[prepare]] explicitly to prepare a SQL statement. |
|
|
|
* You may also call [[prepare()]] explicitly to prepare a SQL statement. |
|
|
|
* |
|
|
|
|
|
|
|
* Command can be used as a query builder that builds and executes a SQL statement |
|
|
|
|
|
|
|
* from code fragments. For example, |
|
|
|
|
|
|
|
* |
|
|
|
|
|
|
|
* ~~~ |
|
|
|
|
|
|
|
* $user = \Yii::app()->db->createCommand() |
|
|
|
|
|
|
|
* ->select('username, password') |
|
|
|
|
|
|
|
* ->from('tbl_user') |
|
|
|
|
|
|
|
* ->where('id=:id', array(':id'=>1)) |
|
|
|
|
|
|
|
* ->queryRow(); |
|
|
|
|
|
|
|
* ~~~ |
|
|
|
|
|
|
|
* |
|
|
|
* |
|
|
|
* @property string $sql the SQL statement to be executed |
|
|
|
* @property string $sql the SQL statement to be executed |
|
|
|
* |
|
|
|
* |
|
|
@ -56,10 +45,6 @@ class Command extends \yii\base\Component |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
public $connection; |
|
|
|
public $connection; |
|
|
|
/** |
|
|
|
/** |
|
|
|
* @var Query the database query that this command is currently representing |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public $query; |
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* @var \PDOStatement the PDOStatement object that this command contains |
|
|
|
* @var \PDOStatement the PDOStatement object that this command contains |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
public $pdoStatement; |
|
|
|
public $pdoStatement; |
|
|
@ -68,7 +53,6 @@ class Command extends \yii\base\Component |
|
|
|
* @see http://www.php.net/manual/en/function.PDOStatement-setFetchMode.php |
|
|
|
* @see http://www.php.net/manual/en/function.PDOStatement-setFetchMode.php |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
public $fetchMode = \PDO::FETCH_ASSOC; |
|
|
|
public $fetchMode = \PDO::FETCH_ASSOC; |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* @var string the SQL statement that this command represents |
|
|
|
* @var string the SQL statement that this command represents |
|
|
|
*/ |
|
|
|
*/ |
|
|
@ -80,72 +64,48 @@ class Command extends \yii\base\Component |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* Constructor. |
|
|
|
* Constructor. |
|
|
|
* Instead of explicitly creating a Command object using `new` operator, |
|
|
|
* Instead of using the `new` operator, you may use [[Connection::createCommand()]] |
|
|
|
* you should use [[Connection::createCommand]] to get a new Command object. |
|
|
|
* to create a new Command object. |
|
|
|
* @param Connection $connection the database connection |
|
|
|
* @param Connection $connection the database connection |
|
|
|
* @param mixed $query the DB query to be executed. This can be: |
|
|
|
* @param string|array|Query $query the DB query to be executed. This can be: |
|
|
|
* |
|
|
|
* |
|
|
|
* - a string representing the SQL statement to be executed |
|
|
|
* - a string representing the SQL statement to be executed |
|
|
|
* - a [[Query]] object representing the SQL query |
|
|
|
* - a [[Query]] object representing the SQL query |
|
|
|
* - an array that will be used to initialize [[Query]] |
|
|
|
* - an array that will be used to create and initialize the [[Query]] object |
|
|
|
* - null (default) if the query needs to be built using query builder methods next. |
|
|
|
|
|
|
|
*/ |
|
|
|
*/ |
|
|
|
public function __construct($connection, $query = null) |
|
|
|
public function __construct($connection, $query = null) |
|
|
|
{ |
|
|
|
{ |
|
|
|
$this->connection = $connection; |
|
|
|
$this->connection = $connection; |
|
|
|
if (is_object($query)) { |
|
|
|
if (is_array($query)) { |
|
|
|
$this->query = $query; |
|
|
|
$query = Query::newInstance($query); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
if ($query instanceof Query) { |
|
|
|
|
|
|
|
$this->_sql = $query->getSql($connection); |
|
|
|
|
|
|
|
$this->bindValues($query->params); |
|
|
|
} else { |
|
|
|
} else { |
|
|
|
$this->query = new Query; |
|
|
|
$this->_sql = $query; |
|
|
|
if (is_array($query)) { |
|
|
|
|
|
|
|
$this->query->fromArray($query); |
|
|
|
|
|
|
|
} else { |
|
|
|
|
|
|
|
$this->_sql = $query; |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
} |
|
|
|
} |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* Cleans up the command and prepares for building a new query. |
|
|
|
|
|
|
|
* This method is mainly used when a command object is being reused |
|
|
|
|
|
|
|
* multiple times for building different queries. |
|
|
|
|
|
|
|
* Calling this method will clean up these properties: [[sql]], [[query]], |
|
|
|
|
|
|
|
* [[pdoStatement]] and [[params]]. |
|
|
|
|
|
|
|
* @return Command this command instance |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function reset() |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$this->query = new Query; |
|
|
|
|
|
|
|
$this->pdoStatement = null; |
|
|
|
|
|
|
|
$this->_params = array(); |
|
|
|
|
|
|
|
$this->_sql = null; |
|
|
|
|
|
|
|
return $this; |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Returns the SQL statement for this command. |
|
|
|
* Returns the SQL statement for this command. |
|
|
|
* When this method is called, a new SQL statement will be built from [[query]] |
|
|
|
|
|
|
|
* if it has not been done before or if `$rebuild` is `true`. |
|
|
|
|
|
|
|
* @param boolean $rebuild whether to rebuild the SQL statement from [[query]]. |
|
|
|
|
|
|
|
* @return string the SQL statement to be executed |
|
|
|
* @return string the SQL statement to be executed |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
public function getSql($rebuild = false) |
|
|
|
public function getSql() |
|
|
|
{ |
|
|
|
{ |
|
|
|
if ($this->_sql === null || $rebuild) { |
|
|
|
|
|
|
|
$this->_sql = $this->query->getSql($this->connection); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
return $this->_sql; |
|
|
|
return $this->_sql; |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* Specifies the SQL statement to be executed. |
|
|
|
* Specifies the SQL statement to be executed. |
|
|
|
* Any previous execution will be terminated or cancel. |
|
|
|
* Any previous execution will be terminated or cancelled. |
|
|
|
* @param string $value the SQL statement to be set. |
|
|
|
* @param string $value the SQL statement to be set. |
|
|
|
* @return Command this command instance |
|
|
|
* @return Command this command instance |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
public function setSql($value) |
|
|
|
public function setSql($value) |
|
|
|
{ |
|
|
|
{ |
|
|
|
$this->_sql = $this->connection->expandTablePrefix($value); |
|
|
|
$this->_sql = $this->connection->expandTablePrefix($value); |
|
|
|
|
|
|
|
$this->_params = array(); |
|
|
|
$this->cancel(); |
|
|
|
$this->cancel(); |
|
|
|
return $this; |
|
|
|
return $this; |
|
|
|
} |
|
|
|
} |
|
|
@ -174,7 +134,6 @@ class Command extends \yii\base\Component |
|
|
|
/** |
|
|
|
/** |
|
|
|
* Cancels the execution of the SQL statement. |
|
|
|
* Cancels the execution of the SQL statement. |
|
|
|
* This method mainly sets [[pdoStatement]] to be null. |
|
|
|
* This method mainly sets [[pdoStatement]] to be null. |
|
|
|
* Please call [[reset]] if you want to run a different SQL statement. |
|
|
|
|
|
|
|
*/ |
|
|
|
*/ |
|
|
|
public function cancel() |
|
|
|
public function cancel() |
|
|
|
{ |
|
|
|
{ |
|
|
@ -183,7 +142,7 @@ class Command extends \yii\base\Component |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* Binds a parameter to the SQL statement to be executed. |
|
|
|
* Binds a parameter to the SQL statement to be executed. |
|
|
|
* @param mixed $name parameter identifier. For a prepared statement |
|
|
|
* @param string|integer $name parameter identifier. For a prepared statement |
|
|
|
* using named placeholders, this will be a parameter name of |
|
|
|
* using named placeholders, this will be a parameter name of |
|
|
|
* the form `:name`. For a prepared statement using question mark |
|
|
|
* the form `:name`. For a prepared statement using question mark |
|
|
|
* placeholders, this will be the 1-indexed position of the parameter. |
|
|
|
* placeholders, this will be the 1-indexed position of the parameter. |
|
|
@ -212,7 +171,7 @@ class Command extends \yii\base\Component |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* Binds a value to a parameter. |
|
|
|
* Binds a value to a parameter. |
|
|
|
* @param mixed $name Parameter identifier. For a prepared statement |
|
|
|
* @param string|integer $name Parameter identifier. For a prepared statement |
|
|
|
* using named placeholders, this will be a parameter name of |
|
|
|
* using named placeholders, this will be a parameter name of |
|
|
|
* the form `:name`. For a prepared statement using question mark |
|
|
|
* the form `:name`. For a prepared statement using question mark |
|
|
|
* placeholders, this will be the 1-indexed position of the parameter. |
|
|
|
* placeholders, this will be the 1-indexed position of the parameter. |
|
|
@ -235,7 +194,7 @@ class Command extends \yii\base\Component |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* Binds a list of values to the corresponding parameters. |
|
|
|
* Binds a list of values to the corresponding parameters. |
|
|
|
* This is similar to [[bindValue]] except that it binds multiple values at a time. |
|
|
|
* This is similar to [[bindValue()]] except that it binds multiple values at a time. |
|
|
|
* Note that the SQL data type of each value is determined by its PHP type. |
|
|
|
* Note that the SQL data type of each value is determined by its PHP type. |
|
|
|
* @param array $values the values to be bound. This must be given in terms of an associative |
|
|
|
* @param array $values the values to be bound. This must be given in terms of an associative |
|
|
|
* array with array keys being the parameter names, and array values the corresponding parameter values, |
|
|
|
* array with array keys being the parameter names, and array values the corresponding parameter values, |
|
|
@ -244,7 +203,13 @@ class Command extends \yii\base\Component |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
public function bindValues($values) |
|
|
|
public function bindValues($values) |
|
|
|
{ |
|
|
|
{ |
|
|
|
$this->query->addParams($values); |
|
|
|
if ($values !== array()) { |
|
|
|
|
|
|
|
$this->prepare(); |
|
|
|
|
|
|
|
foreach ($values as $name => $value) { |
|
|
|
|
|
|
|
$this->pdoStatement->bindValue($name, $value, $this->connection->getPdoType(gettype($value))); |
|
|
|
|
|
|
|
$this->_params[$name] = $value; |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
} |
|
|
|
return $this; |
|
|
|
return $this; |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
@ -253,15 +218,14 @@ class Command extends \yii\base\Component |
|
|
|
* This method should only be used for executing non-query SQL statement, such as `INSERT`, `DELETE`, `UPDATE` SQLs. |
|
|
|
* This method should only be used for executing non-query SQL statement, such as `INSERT`, `DELETE`, `UPDATE` SQLs. |
|
|
|
* No result set will be returned. |
|
|
|
* No result set will be returned. |
|
|
|
* @param array $params input parameters (name=>value) for the SQL execution. This is an alternative |
|
|
|
* @param array $params input parameters (name=>value) for the SQL execution. This is an alternative |
|
|
|
* to [[bindValues]]. Note that if you pass parameters in this way, any previous call to [[bindParam]] |
|
|
|
* to [[bindValues()]]. Note that if you pass parameters in this way, any previous call to [[bindParam()]] |
|
|
|
* or [[bindValue]] will be ignored. |
|
|
|
* or [[bindValue()]] will be ignored. |
|
|
|
* @return integer number of rows affected by the execution. |
|
|
|
* @return integer number of rows affected by the execution. |
|
|
|
* @throws Exception execution failed |
|
|
|
* @throws Exception execution failed |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
public function execute($params = array()) |
|
|
|
public function execute($params = array()) |
|
|
|
{ |
|
|
|
{ |
|
|
|
$sql = $this->getSql(); |
|
|
|
$sql = $this->getSql(); |
|
|
|
$params = array_merge($this->query->params, $params); |
|
|
|
|
|
|
|
$this->_params = array_merge($this->_params, $params); |
|
|
|
$this->_params = array_merge($this->_params, $params); |
|
|
|
if ($this->_params === array()) { |
|
|
|
if ($this->_params === array()) { |
|
|
|
$paramLog = ''; |
|
|
|
$paramLog = ''; |
|
|
@ -303,8 +267,8 @@ class Command extends \yii\base\Component |
|
|
|
* Executes the SQL statement and returns query result. |
|
|
|
* Executes the SQL statement and returns query result. |
|
|
|
* This method is for executing a SQL query that returns result set, such as `SELECT`. |
|
|
|
* This method is for executing a SQL query that returns result set, such as `SELECT`. |
|
|
|
* @param array $params input parameters (name=>value) for the SQL execution. This is an alternative |
|
|
|
* @param array $params input parameters (name=>value) for the SQL execution. This is an alternative |
|
|
|
* to [[bindValues]]. Note that if you pass parameters in this way, any previous call to [[bindParam]] |
|
|
|
* to [[bindValues()]]. Note that if you pass parameters in this way, any previous call to [[bindParam()]] |
|
|
|
* or [[bindValue]] will be ignored. |
|
|
|
* or [[bindValue()]] will be ignored. |
|
|
|
* @return DataReader the reader object for fetching the query result |
|
|
|
* @return DataReader the reader object for fetching the query result |
|
|
|
* @throws Exception execution failed |
|
|
|
* @throws Exception execution failed |
|
|
|
*/ |
|
|
|
*/ |
|
|
@ -316,8 +280,8 @@ class Command extends \yii\base\Component |
|
|
|
/** |
|
|
|
/** |
|
|
|
* Executes the SQL statement and returns ALL rows at once. |
|
|
|
* Executes the SQL statement and returns ALL rows at once. |
|
|
|
* @param array $params input parameters (name=>value) for the SQL execution. This is an alternative |
|
|
|
* @param array $params input parameters (name=>value) for the SQL execution. This is an alternative |
|
|
|
* to [[bindValues]]. Note that if you pass parameters in this way, any previous call to [[bindParam]] |
|
|
|
* to [[bindValues()]]. Note that if you pass parameters in this way, any previous call to [[bindParam()]] |
|
|
|
* or [[bindValue]] will be ignored. |
|
|
|
* or [[bindValue()]] will be ignored. |
|
|
|
* @param mixed $fetchMode the result fetch mode. Please refer to [PHP manual](http://www.php.net/manual/en/function.PDOStatement-setFetchMode.php) |
|
|
|
* @param mixed $fetchMode the result fetch mode. Please refer to [PHP manual](http://www.php.net/manual/en/function.PDOStatement-setFetchMode.php) |
|
|
|
* for valid fetch modes. If this parameter is null, the value set in [[fetchMode]] will be used. |
|
|
|
* for valid fetch modes. If this parameter is null, the value set in [[fetchMode]] will be used. |
|
|
|
* @return array all rows of the query result. Each array element is an array representing a row of data. |
|
|
|
* @return array all rows of the query result. Each array element is an array representing a row of data. |
|
|
@ -333,8 +297,8 @@ class Command extends \yii\base\Component |
|
|
|
* Executes the SQL statement and returns the first row of the result. |
|
|
|
* Executes the SQL statement and returns the first row of the result. |
|
|
|
* This method is best used when only the first row of result is needed for a query. |
|
|
|
* This method is best used when only the first row of result is needed for a query. |
|
|
|
* @param array $params input parameters (name=>value) for the SQL execution. This is an alternative |
|
|
|
* @param array $params input parameters (name=>value) for the SQL execution. This is an alternative |
|
|
|
* to [[bindValues]]. Note that if you pass parameters in this way, any previous call to [[bindParam]] |
|
|
|
* to [[bindValues()]]. Note that if you pass parameters in this way, any previous call to [[bindParam()]] |
|
|
|
* or [[bindValue]] will be ignored. |
|
|
|
* or [[bindValue()]] will be ignored. |
|
|
|
* @param mixed $fetchMode the result fetch mode. Please refer to [PHP manual](http://www.php.net/manual/en/function.PDOStatement-setFetchMode.php) |
|
|
|
* @param mixed $fetchMode the result fetch mode. Please refer to [PHP manual](http://www.php.net/manual/en/function.PDOStatement-setFetchMode.php) |
|
|
|
* for valid fetch modes. If this parameter is null, the value set in [[fetchMode]] will be used. |
|
|
|
* for valid fetch modes. If this parameter is null, the value set in [[fetchMode]] will be used. |
|
|
|
* @return array|boolean the first row (in terms of an array) of the query result. False is returned if the query |
|
|
|
* @return array|boolean the first row (in terms of an array) of the query result. False is returned if the query |
|
|
@ -350,9 +314,9 @@ class Command extends \yii\base\Component |
|
|
|
* Executes the SQL statement and returns the value of the first column in the first row of data. |
|
|
|
* Executes the SQL statement and returns the value of the first column in the first row of data. |
|
|
|
* This method is best used when only a single value is needed for a query. |
|
|
|
* This method is best used when only a single value is needed for a query. |
|
|
|
* @param array $params input parameters (name=>value) for the SQL execution. This is an alternative |
|
|
|
* @param array $params input parameters (name=>value) for the SQL execution. This is an alternative |
|
|
|
* to [[bindValues]]. Note that if you pass parameters in this way, any previous call to [[bindParam]] |
|
|
|
* to [[bindValues()]]. Note that if you pass parameters in this way, any previous call to [[bindParam()]] |
|
|
|
* or [[bindValue]] will be ignored. |
|
|
|
* or [[bindValue()]] will be ignored. |
|
|
|
* @return mixed the value of the first column in the first row of the query result. |
|
|
|
* @return string|boolean the value of the first column in the first row of the query result. |
|
|
|
* False is returned if there is no value. |
|
|
|
* False is returned if there is no value. |
|
|
|
* @throws Exception execution failed |
|
|
|
* @throws Exception execution failed |
|
|
|
*/ |
|
|
|
*/ |
|
|
@ -371,8 +335,8 @@ class Command extends \yii\base\Component |
|
|
|
* This method is best used when only the first column of result (i.e. the first element in each row) |
|
|
|
* This method is best used when only the first column of result (i.e. the first element in each row) |
|
|
|
* is needed for a query. |
|
|
|
* is needed for a query. |
|
|
|
* @param array $params input parameters (name=>value) for the SQL execution. This is an alternative |
|
|
|
* @param array $params input parameters (name=>value) for the SQL execution. This is an alternative |
|
|
|
* to [[bindValues]]. Note that if you pass parameters in this way, any previous call to [[bindParam]] |
|
|
|
* to [[bindValues()]]. Note that if you pass parameters in this way, any previous call to [[bindParam()]] |
|
|
|
* or [[bindValue]] will be ignored. |
|
|
|
* or [[bindValue()]] will be ignored. |
|
|
|
* @return array the first column of the query result. Empty array is returned if the query results in nothing. |
|
|
|
* @return array the first column of the query result. Empty array is returned if the query results in nothing. |
|
|
|
* @throws Exception execution failed |
|
|
|
* @throws Exception execution failed |
|
|
|
*/ |
|
|
|
*/ |
|
|
@ -385,8 +349,8 @@ class Command extends \yii\base\Component |
|
|
|
* Performs the actual DB query of a SQL statement. |
|
|
|
* Performs the actual DB query of a SQL statement. |
|
|
|
* @param string $method method of PDOStatement to be called |
|
|
|
* @param string $method method of PDOStatement to be called |
|
|
|
* @param array $params input parameters (name=>value) for the SQL execution. This is an alternative |
|
|
|
* @param array $params input parameters (name=>value) for the SQL execution. This is an alternative |
|
|
|
* to [[bindValues]]. Note that if you pass parameters in this way, any previous call to [[bindParam]] |
|
|
|
* to [[bindValues()]]. Note that if you pass parameters in this way, any previous call to [[bindParam()]] |
|
|
|
* or [[bindValue]] will be ignored. |
|
|
|
* or [[bindValue()]] will be ignored. |
|
|
|
* @param mixed $fetchMode the result fetch mode. Please refer to [PHP manual](http://www.php.net/manual/en/function.PDOStatement-setFetchMode.php) |
|
|
|
* @param mixed $fetchMode the result fetch mode. Please refer to [PHP manual](http://www.php.net/manual/en/function.PDOStatement-setFetchMode.php) |
|
|
|
* for valid fetch modes. If this parameter is null, the value set in [[fetchMode]] will be used. |
|
|
|
* for valid fetch modes. If this parameter is null, the value set in [[fetchMode]] will be used. |
|
|
|
* @return mixed the method execution result |
|
|
|
* @return mixed the method execution result |
|
|
@ -395,7 +359,6 @@ class Command extends \yii\base\Component |
|
|
|
{ |
|
|
|
{ |
|
|
|
$db = $this->connection; |
|
|
|
$db = $this->connection; |
|
|
|
$sql = $this->getSql(); |
|
|
|
$sql = $this->getSql(); |
|
|
|
$params = array_merge($this->query->params, $params); |
|
|
|
|
|
|
|
$this->_params = array_merge($this->_params, $params); |
|
|
|
$this->_params = array_merge($this->_params, $params); |
|
|
|
if ($this->_params === array()) { |
|
|
|
if ($this->_params === array()) { |
|
|
|
$paramLog = ''; |
|
|
|
$paramLog = ''; |
|
|
@ -406,7 +369,7 @@ class Command extends \yii\base\Component |
|
|
|
\Yii::trace("Querying SQL: {$sql}{$paramLog}", __CLASS__); |
|
|
|
\Yii::trace("Querying SQL: {$sql}{$paramLog}", __CLASS__); |
|
|
|
|
|
|
|
|
|
|
|
if ($db->queryCachingCount > 0 && $db->queryCachingDuration >= 0 && $method !== '') { |
|
|
|
if ($db->queryCachingCount > 0 && $db->queryCachingDuration >= 0 && $method !== '') { |
|
|
|
$cache = \Yii::app()->getComponent($db->queryCacheID); |
|
|
|
$cache = \Yii::$application->getComponent($db->queryCacheID); |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
if (isset($cache)) { |
|
|
|
if (isset($cache)) { |
|
|
@ -460,477 +423,4 @@ class Command extends \yii\base\Component |
|
|
|
throw new Exception($message, (int)$e->getCode(), $errorInfo); |
|
|
|
throw new Exception($message, (int)$e->getCode(), $errorInfo); |
|
|
|
} |
|
|
|
} |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Sets the SELECT part of the query. |
|
|
|
|
|
|
|
* @param mixed $columns the columns to be selected. Defaults to '*', meaning all columns. |
|
|
|
|
|
|
|
* Columns can be specified in either a string (e.g. "id, name") or an array (e.g. array('id', 'name')). |
|
|
|
|
|
|
|
* Columns can contain table prefixes (e.g. "tbl_user.id") and/or column aliases (e.g. "tbl_user.id AS user_id"). |
|
|
|
|
|
|
|
* The method will automatically quote the column names unless a column contains some parenthesis |
|
|
|
|
|
|
|
* (which means the column contains a DB expression). |
|
|
|
|
|
|
|
* @param boolean $distinct whether to use 'SELECT DISTINCT'. |
|
|
|
|
|
|
|
* @param string $option additional option that should be appended to the 'SELECT' keyword. For example, |
|
|
|
|
|
|
|
* in MySQL, the option 'SQL_CALC_FOUND_ROWS' can be used. |
|
|
|
|
|
|
|
* @return Command the command object itself |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function select($columns = '*', $distinct = false, $option = '') |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$this->query->select = $columns; |
|
|
|
|
|
|
|
$this->query->distinct = $distinct; |
|
|
|
|
|
|
|
$this->query->selectOption = $option; |
|
|
|
|
|
|
|
return $this; |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Sets the FROM part of the query. |
|
|
|
|
|
|
|
* @param mixed $tables the table(s) to be selected from. This can be either a string (e.g. 'tbl_user') |
|
|
|
|
|
|
|
* or an array (e.g. array('tbl_user', 'tbl_profile')) specifying one or several table names. |
|
|
|
|
|
|
|
* Table names can contain schema prefixes (e.g. 'public.tbl_user') and/or table aliases (e.g. 'tbl_user u'). |
|
|
|
|
|
|
|
* The method will automatically quote the table names unless it contains some parenthesis |
|
|
|
|
|
|
|
* (which means the table is given as a sub-query or DB expression). |
|
|
|
|
|
|
|
* @return Command the command object itself |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function from($tables) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$this->query->from = $tables; |
|
|
|
|
|
|
|
return $this; |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Sets the WHERE part of the query. |
|
|
|
|
|
|
|
* |
|
|
|
|
|
|
|
* The method requires a $conditions parameter, and optionally a $params parameter |
|
|
|
|
|
|
|
* specifying the values to be bound to the query. |
|
|
|
|
|
|
|
* |
|
|
|
|
|
|
|
* The $conditions parameter should be either a string (e.g. 'id=1') or an array. |
|
|
|
|
|
|
|
* If the latter, it must be in the format `array(operator, operand1, operand2, ...)`, |
|
|
|
|
|
|
|
* where the operator can be one of the followings, and the possible operands depend on the corresponding |
|
|
|
|
|
|
|
* operator: |
|
|
|
|
|
|
|
* |
|
|
|
|
|
|
|
* - `and`: the operands should be concatenated together using `AND`. For example, |
|
|
|
|
|
|
|
* `array('and', 'id=1', 'id=2')` will generate `id=1 AND id=2`. If an operand is an array, |
|
|
|
|
|
|
|
* it will be converted into a string using the rules described here. For example, |
|
|
|
|
|
|
|
* `array('and', 'type=1', array('or', 'id=1', 'id=2'))` will generate `type=1 AND (id=1 OR id=2)`. |
|
|
|
|
|
|
|
* The method will NOT do any quoting or escaping. |
|
|
|
|
|
|
|
* |
|
|
|
|
|
|
|
* - `or`: similar to the `and` operator except that the operands are concatenated using `OR`. |
|
|
|
|
|
|
|
* |
|
|
|
|
|
|
|
* - `in`: operand 1 should be a column or DB expression, and operand 2 be an array representing |
|
|
|
|
|
|
|
* the range of the values that the column or DB expression should be in. For example, |
|
|
|
|
|
|
|
* `array('in', 'id', array(1,2,3))` will generate `id IN (1,2,3)`. |
|
|
|
|
|
|
|
* The method will properly quote the column name and escape values in the range. |
|
|
|
|
|
|
|
* |
|
|
|
|
|
|
|
* - `not in`: similar to the `in` operator except that `IN` is replaced with `NOT IN` in the generated condition. |
|
|
|
|
|
|
|
* |
|
|
|
|
|
|
|
* - `like`: operand 1 should be a column or DB expression, and operand 2 be a string or an array representing |
|
|
|
|
|
|
|
* the values that the column or DB expression should be like. |
|
|
|
|
|
|
|
* For example, `array('like', 'name', '%tester%')` will generate `name LIKE '%tester%'`. |
|
|
|
|
|
|
|
* When the value range is given as an array, multiple `LIKE` predicates will be generated and concatenated |
|
|
|
|
|
|
|
* using `AND`. For example, `array('like', 'name', array('%test%', '%sample%'))` will generate |
|
|
|
|
|
|
|
* `name LIKE '%test%' AND name LIKE '%sample%'`. |
|
|
|
|
|
|
|
* The method will properly quote the column name and escape values in the range. |
|
|
|
|
|
|
|
* |
|
|
|
|
|
|
|
* - `or like`: similar to the `like` operator except that `OR` is used to concatenate the `LIKE` |
|
|
|
|
|
|
|
* predicates when operand 2 is an array. |
|
|
|
|
|
|
|
* |
|
|
|
|
|
|
|
* - `not like`: similar to the `like` operator except that `LIKE` is replaced with `NOT LIKE` |
|
|
|
|
|
|
|
* in the generated condition. |
|
|
|
|
|
|
|
* |
|
|
|
|
|
|
|
* - `or not like`: similar to the `not like` operator except that `OR` is used to concatenate |
|
|
|
|
|
|
|
* the `NOT LIKE` predicates. |
|
|
|
|
|
|
|
* |
|
|
|
|
|
|
|
* @param mixed $conditions the conditions that should be put in the WHERE part. |
|
|
|
|
|
|
|
* @param array $params the parameters (name=>value) to be bound to the query |
|
|
|
|
|
|
|
* @return Command the command object itself |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function where($conditions, $params = array()) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$this->query->where = $conditions; |
|
|
|
|
|
|
|
$this->query->addParams($params); |
|
|
|
|
|
|
|
return $this; |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Appends an INNER JOIN part to the query. |
|
|
|
|
|
|
|
* @param string $table the table to be joined. |
|
|
|
|
|
|
|
* Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u'). |
|
|
|
|
|
|
|
* The method will automatically quote the table name unless it contains some parenthesis |
|
|
|
|
|
|
|
* (which means the table is given as a sub-query or DB expression). |
|
|
|
|
|
|
|
* @param mixed $conditions the join condition that should appear in the ON part. |
|
|
|
|
|
|
|
* Please refer to [[where]] on how to specify this parameter. |
|
|
|
|
|
|
|
* @param array $params the parameters (name=>value) to be bound to the query |
|
|
|
|
|
|
|
* @return Command the command object itself |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function join($table, $conditions, $params = array()) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
return $this->joinInternal('JOIN', $table, $conditions, $params); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Appends a LEFT OUTER JOIN part to the query. |
|
|
|
|
|
|
|
* @param string $table the table to be joined. |
|
|
|
|
|
|
|
* Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u'). |
|
|
|
|
|
|
|
* The method will automatically quote the table name unless it contains some parenthesis |
|
|
|
|
|
|
|
* (which means the table is given as a sub-query or DB expression). |
|
|
|
|
|
|
|
* @param mixed $conditions the join condition that should appear in the ON part. |
|
|
|
|
|
|
|
* Please refer to [[where]] on how to specify this parameter. |
|
|
|
|
|
|
|
* @param array $params the parameters (name=>value) to be bound to the query |
|
|
|
|
|
|
|
* @return Command the command object itself |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function leftJoin($table, $conditions, $params = array()) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
return $this->joinInternal('LEFT JOIN', $table, $conditions, $params); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Appends a RIGHT OUTER JOIN part to the query. |
|
|
|
|
|
|
|
* @param string $table the table to be joined. |
|
|
|
|
|
|
|
* Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u'). |
|
|
|
|
|
|
|
* The method will automatically quote the table name unless it contains some parenthesis |
|
|
|
|
|
|
|
* (which means the table is given as a sub-query or DB expression). |
|
|
|
|
|
|
|
* @param mixed $conditions the join condition that should appear in the ON part. |
|
|
|
|
|
|
|
* Please refer to [[where]] on how to specify this parameter. |
|
|
|
|
|
|
|
* @param array $params the parameters (name=>value) to be bound to the query |
|
|
|
|
|
|
|
* @return Command the command object itself |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function rightJoin($table, $conditions, $params = array()) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
return $this->joinInternal('RIGHT JOIN', $table, $conditions, $params); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Appends a CROSS JOIN part to the query. |
|
|
|
|
|
|
|
* Note that not all DBMS support CROSS JOIN. |
|
|
|
|
|
|
|
* @param string $table the table to be joined. |
|
|
|
|
|
|
|
* Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u'). |
|
|
|
|
|
|
|
* The method will automatically quote the table name unless it contains some parenthesis |
|
|
|
|
|
|
|
* (which means the table is given as a sub-query or DB expression). |
|
|
|
|
|
|
|
* @return Command the command object itself |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function crossJoin($table) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
return $this->joinInternal('CROSS JOIN', $table); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Appends a NATURAL JOIN part to the query. |
|
|
|
|
|
|
|
* Note that not all DBMS support NATURAL JOIN. |
|
|
|
|
|
|
|
* @param string $table the table to be joined. |
|
|
|
|
|
|
|
* Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u'). |
|
|
|
|
|
|
|
* The method will automatically quote the table name unless it contains some parenthesis |
|
|
|
|
|
|
|
* (which means the table is given as a sub-query or DB expression). |
|
|
|
|
|
|
|
* @return Command the command object itself |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function naturalJoin($table) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
return $this->joinInternal('NATURAL JOIN', $table); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Sets the GROUP BY part of the query. |
|
|
|
|
|
|
|
* @param mixed $columns the columns to be grouped by. |
|
|
|
|
|
|
|
* Columns can be specified in either a string (e.g. "id, name") or an array (e.g. array('id', 'name')). |
|
|
|
|
|
|
|
* The method will automatically quote the column names unless a column contains some parenthesis |
|
|
|
|
|
|
|
* (which means the column contains a DB expression). |
|
|
|
|
|
|
|
* @return Command the command object itself |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function groupBy($columns) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$this->query->groupBy = $columns; |
|
|
|
|
|
|
|
return $this; |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Sets the HAVING part of the query. |
|
|
|
|
|
|
|
* @param mixed $conditions the conditions to be put after HAVING. |
|
|
|
|
|
|
|
* Please refer to [[where]] on how to specify this parameter. |
|
|
|
|
|
|
|
* @param array $params the parameters (name=>value) to be bound to the query |
|
|
|
|
|
|
|
* @return Command the command object itself |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function having($conditions, $params = array()) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$this->query->having = $conditions; |
|
|
|
|
|
|
|
$this->query->addParams($params); |
|
|
|
|
|
|
|
return $this; |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Sets the ORDER BY part of the query. |
|
|
|
|
|
|
|
* @param mixed $columns the columns (and the directions) to be ordered by. |
|
|
|
|
|
|
|
* Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array (e.g. array('id ASC', 'name DESC')). |
|
|
|
|
|
|
|
* The method will automatically quote the column names unless a column contains some parenthesis |
|
|
|
|
|
|
|
* (which means the column contains a DB expression). |
|
|
|
|
|
|
|
* @return Command the command object itself |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function orderBy($columns) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$this->query->orderBy = $columns; |
|
|
|
|
|
|
|
return $this; |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Sets the LIMIT part of the query. |
|
|
|
|
|
|
|
* @param integer $limit the limit |
|
|
|
|
|
|
|
* @return Command the command object itself |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function limit($limit) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$this->query->limit = $limit; |
|
|
|
|
|
|
|
return $this; |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Sets the OFFSET part of the query. |
|
|
|
|
|
|
|
* @param integer $offset the offset |
|
|
|
|
|
|
|
* @return Command the command object itself |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function offset($offset) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$this->query->offset = $offset; |
|
|
|
|
|
|
|
return $this; |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Appends a SQL statement using UNION operator. |
|
|
|
|
|
|
|
* @param string $sql the SQL statement to be appended using UNION |
|
|
|
|
|
|
|
* @return Command the command object itself |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function union($sql) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$this->query->union[] = $sql; |
|
|
|
|
|
|
|
return $this->query; |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Creates and executes an INSERT SQL statement. |
|
|
|
|
|
|
|
* The method will properly escape the column names, and bind the values to be inserted. |
|
|
|
|
|
|
|
* @param string $table the table that new rows will be inserted into. |
|
|
|
|
|
|
|
* @param array $columns the column data (name=>value) to be inserted into the table. |
|
|
|
|
|
|
|
* @return integer number of rows affected by the execution. |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function insert($table, $columns) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$sql = $this->connection->getQueryBuilder()->insert($table, $columns, $params); |
|
|
|
|
|
|
|
return $this->setSql($sql)->execute($params); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Creates and executes an UPDATE SQL statement. |
|
|
|
|
|
|
|
* The method will properly escape the column names and bind the values to be updated. |
|
|
|
|
|
|
|
* @param string $table the table to be updated. |
|
|
|
|
|
|
|
* @param array $columns the column data (name=>value) to be updated. |
|
|
|
|
|
|
|
* @param mixed $conditions the conditions that will be put in the WHERE part. |
|
|
|
|
|
|
|
* Please refer to [[where]] on how to specify this parameter. |
|
|
|
|
|
|
|
* @param array $params the parameters to be bound to the query. |
|
|
|
|
|
|
|
* @return integer number of rows affected by the execution. |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function update($table, $columns, $conditions = '', $params = array()) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$sql = $this->connection->getQueryBuilder()->update($table, $columns, $conditions, $params); |
|
|
|
|
|
|
|
return $this->setSql($sql)->execute($params); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Creates and executes a DELETE SQL statement. |
|
|
|
|
|
|
|
* @param string $table the table where the data will be deleted from. |
|
|
|
|
|
|
|
* @param mixed $conditions the conditions that will be put in the WHERE part. |
|
|
|
|
|
|
|
* Please refer to [[where]] on how to specify this parameter. |
|
|
|
|
|
|
|
* @param array $params the parameters to be bound to the query. |
|
|
|
|
|
|
|
* @return integer number of rows affected by the execution. |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function delete($table, $conditions = '', $params = array()) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$sql = $this->connection->getQueryBuilder()->delete($table, $conditions); |
|
|
|
|
|
|
|
return $this->setSql($sql)->execute($params); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Builds and executes a SQL statement for creating a new DB table. |
|
|
|
|
|
|
|
* |
|
|
|
|
|
|
|
* The columns in the new table should be specified as name-definition pairs (e.g. 'name'=>'string'), |
|
|
|
|
|
|
|
* where name stands for a column name which will be properly quoted by the method, and definition |
|
|
|
|
|
|
|
* stands for the column type which can contain an abstract DB type. |
|
|
|
|
|
|
|
* The method [[\yii\db\dao\QueryBuilder::getColumnType()]] will be called |
|
|
|
|
|
|
|
* to convert the abstract column types to physical ones. For example, `string` will be converted |
|
|
|
|
|
|
|
* as `varchar(255)`, and `string not null` becomes `varchar(255) not null`. |
|
|
|
|
|
|
|
* |
|
|
|
|
|
|
|
* If a column is specified with definition only (e.g. 'PRIMARY KEY (name, type)'), it will be directly |
|
|
|
|
|
|
|
* inserted into the generated SQL. |
|
|
|
|
|
|
|
* |
|
|
|
|
|
|
|
* @param string $table the name of the table to be created. The name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @param array $columns the columns (name=>definition) in the new table. |
|
|
|
|
|
|
|
* @param string $options additional SQL fragment that will be appended to the generated SQL. |
|
|
|
|
|
|
|
* @return integer number of rows affected by the execution. |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function createTable($table, $columns, $options = null) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$sql = $this->connection->getQueryBuilder()->createTable($table, $columns, $options); |
|
|
|
|
|
|
|
return $this->setSql($sql)->execute(); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Builds and executes a SQL statement for renaming a DB table. |
|
|
|
|
|
|
|
* @param string $table the table to be renamed. The name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @param string $newName the new table name. The name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @return integer number of rows affected by the execution. |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function renameTable($table, $newName) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$sql = $this->connection->getQueryBuilder()->renameTable($table, $newName); |
|
|
|
|
|
|
|
return $this->setSql($sql)->execute(); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Builds and executes a SQL statement for dropping a DB table. |
|
|
|
|
|
|
|
* @param string $table the table to be dropped. The name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @return integer number of rows affected by the execution. |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function dropTable($table) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$sql = $this->connection->getQueryBuilder()->dropTable($table); |
|
|
|
|
|
|
|
return $this->setSql($sql)->execute(); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Builds and executes a SQL statement for truncating a DB table. |
|
|
|
|
|
|
|
* @param string $table the table to be truncated. The name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @return integer number of rows affected by the execution. |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function truncateTable($table) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$sql = $this->connection->getQueryBuilder()->truncateTable($table); |
|
|
|
|
|
|
|
return $this->setSql($sql)->execute(); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Builds and executes a SQL statement for adding a new DB column. |
|
|
|
|
|
|
|
* @param string $table the table that the new column will be added to. The table name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @param string $column the name of the new column. The name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @param string $type the column type. [[\yii\db\dao\QueryBuilder::getColumnType()]] will be called |
|
|
|
|
|
|
|
* to convert the give column type to the physical one. For example, `string` will be converted |
|
|
|
|
|
|
|
* as `varchar(255)`, and `string not null` becomes `varchar(255) not null`. |
|
|
|
|
|
|
|
* @return integer number of rows affected by the execution. |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function addColumn($table, $column, $type) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$sql = $this->connection->getQueryBuilder()->addColumn($table, $column, $type); |
|
|
|
|
|
|
|
return $this->setSql($sql)->execute(); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Builds and executes a SQL statement for dropping a DB column. |
|
|
|
|
|
|
|
* @param string $table the table whose column is to be dropped. The name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @param string $column the name of the column to be dropped. The name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @return integer number of rows affected by the execution. |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function dropColumn($table, $column) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$sql = $this->connection->getQueryBuilder()->dropColumn($table, $column); |
|
|
|
|
|
|
|
return $this->setSql($sql)->execute(); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Builds and executes a SQL statement for renaming a column. |
|
|
|
|
|
|
|
* @param string $table the table whose column is to be renamed. The name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @param string $name the old name of the column. The name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @param string $newName the new name of the column. The name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @return integer number of rows affected by the execution. |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function renameColumn($table, $name, $newName) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$sql = $this->connection->getQueryBuilder()->renameColumn($table, $name, $newName); |
|
|
|
|
|
|
|
return $this->setSql($sql)->execute(); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Builds and executes a SQL statement for changing the definition of a column. |
|
|
|
|
|
|
|
* @param string $table the table whose column is to be changed. The table name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @param string $column the name of the column to be changed. The name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @param string $type the column type. [[\yii\db\dao\QueryBuilder::getColumnType()]] will be called |
|
|
|
|
|
|
|
* to convert the give column type to the physical one. For example, `string` will be converted |
|
|
|
|
|
|
|
* as `varchar(255)`, and `string not null` becomes `varchar(255) not null`. |
|
|
|
|
|
|
|
* @return integer number of rows affected by the execution. |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function alterColumn($table, $column, $type) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$sql = $this->connection->getQueryBuilder()->alterColumn($table, $column, $type); |
|
|
|
|
|
|
|
return $this->setSql($sql)->execute(); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Builds a SQL statement for adding a foreign key constraint to an existing table. |
|
|
|
|
|
|
|
* The method will properly quote the table and column names. |
|
|
|
|
|
|
|
* @param string $name the name of the foreign key constraint. |
|
|
|
|
|
|
|
* @param string $table the table that the foreign key constraint will be added to. |
|
|
|
|
|
|
|
* @param string $columns the name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas. |
|
|
|
|
|
|
|
* @param string $refTable the table that the foreign key references to. |
|
|
|
|
|
|
|
* @param string $refColumns the name of the column that the foreign key references to. If there are multiple columns, separate them with commas. |
|
|
|
|
|
|
|
* @param string $delete the ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL |
|
|
|
|
|
|
|
* @param string $update the ON UPDATE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL |
|
|
|
|
|
|
|
* @return integer number of rows affected by the execution. |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function addForeignKey($name, $table, $columns, $refTable, $refColumns, $delete = null, $update = null) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$sql = $this->connection->getQueryBuilder()->addForeignKey($name, $table, $columns, $refTable, $refColumns, $delete, $update); |
|
|
|
|
|
|
|
return $this->setSql($sql)->execute(); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Builds a SQL statement for dropping a foreign key constraint. |
|
|
|
|
|
|
|
* @param string $name the name of the foreign key constraint to be dropped. The name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @param string $table the table whose foreign is to be dropped. The name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @return integer number of rows affected by the execution. |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function dropForeignKey($name, $table) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$sql = $this->connection->getQueryBuilder()->dropForeignKey($name, $table); |
|
|
|
|
|
|
|
return $this->setSql($sql)->execute(); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Builds and executes a SQL statement for creating a new index. |
|
|
|
|
|
|
|
* @param string $name the name of the index. The name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @param string $table the table that the new index will be created for. The table name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @param string $column the column(s) that should be included in the index. If there are multiple columns, please separate them |
|
|
|
|
|
|
|
* by commas. The column names will be properly quoted by the method. |
|
|
|
|
|
|
|
* @param boolean $unique whether to add UNIQUE constraint on the created index. |
|
|
|
|
|
|
|
* @return integer number of rows affected by the execution. |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function createIndex($name, $table, $column, $unique = false) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$sql = $this->connection->getQueryBuilder()->createIndex($name, $table, $column, $unique); |
|
|
|
|
|
|
|
return $this->setSql($sql)->execute(); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Builds and executes a SQL statement for dropping an index. |
|
|
|
|
|
|
|
* @param string $name the name of the index to be dropped. The name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @param string $table the table whose index is to be dropped. The name will be properly quoted by the method. |
|
|
|
|
|
|
|
* @return integer number of rows affected by the execution. |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
public function dropIndex($name, $table) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$sql = $this->connection->getQueryBuilder()->dropIndex($name, $table); |
|
|
|
|
|
|
|
return $this->setSql($sql)->execute(); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
|
|
* Appends an JOIN part to the query. |
|
|
|
|
|
|
|
* @param string $type the join type ('join', 'left join', 'right join', 'cross join', 'natural join') |
|
|
|
|
|
|
|
* @param string $table the table to be joined. |
|
|
|
|
|
|
|
* Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u'). |
|
|
|
|
|
|
|
* The method will automatically quote the table name unless it contains some parenthesis |
|
|
|
|
|
|
|
* (which means the table is given as a sub-query or DB expression). |
|
|
|
|
|
|
|
* @param mixed $conditions the join condition that should appear in the ON part. |
|
|
|
|
|
|
|
* Please refer to [[where]] on how to specify this parameter. |
|
|
|
|
|
|
|
* @param array $params the parameters (name=>value) to be bound to the query |
|
|
|
|
|
|
|
* @return Command the command object itself |
|
|
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
private function joinInternal($type, $table, $conditions = '', $params = array()) |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
$this->query->join[] = array($type, $table, $conditions); |
|
|
|
|
|
|
|
$this->query->addParams($params); |
|
|
|
|
|
|
|
return $this; |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
} |
|
|
|
} |
|
|
|