Class yii\db\Query

Additional columns to be grouped by. Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression).

Note that if your group-by is an expression containing commas, you should always use an array to represent the group-by information. Otherwise, the method will not be able to correctly determine the group-by columns.

Since version 2.0.7, an yii\db\Expression object can be passed to specify the GROUP BY part explicitly in plain SQL. Since version 2.0.14, an yii\db\ExpressionInterface object can be passed as well.

The query object itself

List of query parameter values indexed by parameter placeholders. For example, [':name' => 'Dan', ':age' => 31].

The query object itself

The columns to add to the select. See select() for more details about the format of this parameter.

The query object itself

The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

The query results. If the query results in nothing, an empty array will be returned.

The column name.

The column value optionally prepended with the comparison operator.

The operator to use, when no operator is given in $value. Defaults to =, performing an exact match.

The query object itself

The new HAVING condition. Please refer to having() on how to specify this parameter.

The query object itself

The new HAVING condition. Please refer to where() on how to specify this parameter.

The parameters (name => value) to be bound to the query.

The query object itself

The new WHERE condition. Please refer to where() on how to specify this parameter.

The parameters (name => value) to be bound to the query.

The query object itself

The column name or expression. Make sure you properly quote column names in the expression.

The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

The average of the specified column values.

The number of records to be fetched in each batch.

The database connection. If not set, the "db" application component will be used.

The batch query result. It implements the Iterator interface and can be traversed to retrieve the data in batches.

The number of seconds that query results can remain valid in cache. Use 0 to indicate that the cached data will never expire. Use a negative number to indicate that query cache should not be used. Use boolean true to indicate that yii\db\Connection::$queryCacheDuration should be used. Defaults to true.

The cache dependency associated with the cached result.

The Query object itself

Non-empty array

Table names indexed by aliases

The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

The first column of the query result. An empty array is returned if the query results in nothing.

The COUNT expression. Defaults to '*'. Make sure you properly quote column names in the expression.

The database connection used to generate the SQL statement. If this parameter is not given (or null), the db application component will be used.

Number of records. The result may be a string depending on the underlying database engine and to support integer values higher than a 32bit PHP integer can handle.

The source query object

The new Query object

The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

The created DB command instance.

Whether to SELECT DISTINCT or not.

The query object itself

The number of records to be fetched in each batch.

The database connection. If not set, the "db" application component will be used.

The batch query result. It implements the Iterator interface and can be traversed to retrieve the data in batches.

The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

Whether the query result contains any row of data.

The conditions that should be put in the HAVING part. See having() on how to specify this parameter.

The query object itself

The table(s) to be selected from. This can be either a string (e.g. 'user') or an array (e.g. ['user', 'profile']) specifying one or several table names. Table names can contain schema prefixes (e.g. 'public.user') and/or table aliases (e.g. '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).

When the tables are specified as an array, you may also use the array keys as the table aliases (if a table does not need alias, do not use a string key).

Use a Query object to represent a sub-query. In this case, the corresponding array key will be used as the alias for the sub-query.

To specify the FROM part in plain SQL, you may pass an instance of yii\db\ExpressionInterface.

Here are some examples:

// SELECT * FROM  `user` `u`, `profile`;
$query = (new \yii\db\Query)->from(['u' => 'user', 'profile']);

// SELECT * FROM (SELECT * FROM `user` WHERE `active` = 1) `activeusers`;
$subquery = (new \yii\db\Query)->from('user')->where(['active' => true])
$query = (new \yii\db\Query)->from(['activeusers' => $subquery]);

// subquery can also be a string with plain SQL wrapped in parenthesis
// SELECT * FROM (SELECT * FROM `user` WHERE `active` = 1) `activeusers`;
$subquery = "(SELECT * FROM `user` WHERE `active` = 1)";
$query = (new \yii\db\Query)->from(['activeusers' => $subquery]);

The query object itself

Table names indexed by aliases

List of columns without aliases from SELECT statement.

The columns to be merged to the select.

The columns to be grouped by. Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression).

Note that if your group-by is an expression containing commas, you should always use an array to represent the group-by information. Otherwise, the method will not be able to correctly determine the group-by columns.

Since version 2.0.7, an yii\db\ExpressionInterface object can be passed to specify the GROUP BY part explicitly in plain SQL. Since version 2.0.14, an yii\db\ExpressionInterface object can be passed as well.

The query object itself

The conditions to be put after HAVING. Please refer to where() on how to specify this parameter.

The parameters (name => value) to be bound to the query.

The query object itself

The table to be joined.

Use a string to represent the name of the table to be joined. The table name can contain a schema prefix (e.g. 'public.user') and/or table alias (e.g. '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).

Use an array to represent joining with a sub-query. The array must contain only one element. The value must be a yii\db\Query object representing the sub-query while the corresponding key represents the alias for the sub-query.

The join condition that should appear in the ON part. Please refer to join() on how to specify this parameter.

The parameters (name => value) to be bound to the query.

The query object itself

The type of join, such as INNER JOIN, LEFT JOIN.

The table to be joined.

Use a string to represent the name of the table to be joined. The table name can contain a schema prefix (e.g. 'public.user') and/or table alias (e.g. '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).

Use an array to represent joining with a sub-query. The array must contain only one element. The value must be a yii\db\Query object representing the sub-query while the corresponding key represents the alias for the sub-query.

The join condition that should appear in the ON part. Please refer to where() on how to specify this parameter.

Note that the array format of where() is designed to match columns to values instead of columns to columns, so the following would not work as expected: ['post.author_id' => 'user.id'], it would match the post.author_id column value against the string 'user.id'. It is recommended to use the string syntax here which is more suited for a join:

'post.author_id = user.id'

The parameters (name => value) to be bound to the query.

The query object itself

The table to be joined.

Use a string to represent the name of the table to be joined. The table name can contain a schema prefix (e.g. 'public.user') and/or table alias (e.g. '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).

Use an array to represent joining with a sub-query. The array must contain only one element. The value must be a yii\db\Query object representing the sub-query while the corresponding key represents the alias for the sub-query.

The join condition that should appear in the ON part. Please refer to join() on how to specify this parameter.

The parameters (name => value) to be bound to the query

The query object itself

The column name or expression. Make sure you properly quote column names in the expression.

The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

The maximum of the specified column values.

The column name or expression. Make sure you properly quote column names in the expression.

The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

The minimum of the specified column values.

The Query object itself

The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

The first row (in terms of an array) of the query result. False is returned if the query results in nothing.

The new HAVING condition. Please refer to having() on how to specify this parameter.

The query object itself

The new HAVING condition. Please refer to where() on how to specify this parameter.

The parameters (name => value) to be bound to the query.

The query object itself

The new WHERE condition. Please refer to where() on how to specify this parameter.

The parameters (name => value) to be bound to the query.

The query object itself

List of query parameter values indexed by parameter placeholders. For example, [':name' => 'Dan', ':age' => 31].

The query object itself

The raw query result from database

The converted query result

A prepared query instance which will be used by yii\db\QueryBuilder to build the SQL

The table to be joined.

Use a string to represent the name of the table to be joined. The table name can contain a schema prefix (e.g. 'public.user') and/or table alias (e.g. '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).

Use an array to represent joining with a sub-query. The array must contain only one element. The value must be a yii\db\Query object representing the sub-query while the corresponding key represents the alias for the sub-query.

The join condition that should appear in the ON part. Please refer to join() on how to specify this parameter.

The parameters (name => value) to be bound to the query

The query object itself

The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

The value of the first column in the first row of the query result. False is returned if the query result is empty.

The columns to be selected. Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']). Columns can be prefixed with table names (e.g. "user.id") and/or contain column aliases (e.g. "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). A DB expression may also be passed in form of an yii\db\ExpressionInterface object.

Note that if you are selecting an expression like CONCAT(first_name, ' ', last_name), you should use an array to specify the columns. Otherwise, the expression may be incorrectly split into several parts.

When the columns are specified as an array, you may also use array keys as the column aliases (if a column does not need alias, do not use a string key).

Starting from version 2.0.1, you may also select sub-queries as columns by specifying each such column as a Query instance representing the sub-query.

Additional option that should be appended to the 'SELECT' keyword. For example, in MySQL, the option 'SQL_CALC_FOUND_ROWS' can be used.

The query object itself

The column name or expression. Make sure you properly quote column names in the expression.

The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

The sum of the specified column values.

The SQL statement to be appended using UNION

TRUE if using UNION ALL and FALSE if using UNION

The query object itself

The conditions that should be put in the WHERE part.

The parameters (name => value) to be bound to the query.

The query object itself