Interface Yiisoft\Db\Query\QueryPartsInterface

The value(s) to be set for the FOR part. This can be either a string (for example, 'UPDATE') or a list of strings (such as ['SHARE OF {{t1}}', 'UPDATE OF {{t2}}']) specifying one or several values. null means adding nothing.

More columns to be grouped by. Columns can be specified in either a string (for example 'id, name') or an array (such as ['id', 'name']). The method will automatically quote the column names unless a column has some parenthesis (which means the column has 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 won't be able to correctly decide the group-by columns.

Yiisoft\Db\Expression\ExpressionInterface object can be passed to specify the GROUP BY part explicitly in plain SQL. Yiisoft\Db\Expression\ExpressionInterface object can be passed as well.

The columns (and the directions) to be ordered by. Columns can be specified in either a string (for example "id ASC, name DESC") or an array (for example, ['id' => SORT_ASC, 'name' => SORT_DESC]). The method will automatically quote the column names unless a column has some parenthesis (which means the column has a DB expression). Note that if your order-by is an expression containing commas, you should always use an array to represent the order-by information. Otherwise, the method won't be able to correctly decide the order-by columns. Since Yiisoft\Db\Expression\ExpressionInterface an object can be passed to specify the ORDER BY part explicitly in plain SQL.

The columns to add to the select.

The SQL statement to append using UNION.

The query alias in WITH construction. To specify the alias in plain SQL, you may pass an instance of Yiisoft\Db\Expression\ExpressionInterface.

Its true if using WITH RECURSIVE and false if using WITH.

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.

If this query doesn't support filtering.

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

If this query doesn't support filtering.

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

If this query doesn't support filtering.

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 new WHERE condition. Please refer to where() on how to specify this parameter.

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

Whether to SELECT DISTINCT or not.

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

If this query doesn't support filtering.

The conditions that should be in the WHERE part. where() On how to specify this parameter.

If this query doesn't support filtering.

The value(s) to be set for the FOR part. This can be either a string (for example, 'UPDATE') or a list of strings (such as ['SHARE OF {{t1}}', 'UPDATE OF {{t2}}']) specifying one or several values. null means no FOR part.

If FOR was set previously.

The table(s) to select from. This can be either a string (for example, 'user') or an array (such as ['user', 'profile']) specifying one or several table names. Table names can contain schema prefixes (such as 'public.user') and/or table aliases (such as 'user u'). The method will automatically quote the table names unless it has 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 doesn't need alias, don't 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 Yiisoft\Db\Expression\ExpressionInterface. Here are some examples:

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

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

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

The columns to be grouped by. Columns can be specified in either a string (for example "id, name") or an array (such as ['id', 'name']). The method will automatically quote the column names unless a column has some parenthesis (which means the column has 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 won't be able to correctly decide the group-by columns.

Yiisoft\Db\Expression\ExpressionInterface object can be passed to specify the GROUP BY part explicitly in plain SQL. Yiisoft\Db\Expression\ExpressionInterface object can be passed as well.

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

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

If having was set previously.

The name of the column by which the query results should be indexed by. This can also be callable (for example, anonymous function) that returns the index value based on the given data. The signature of the callable should be:

function (array|object $data): int|string
{
    // return the index value corresponding to $data
}

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 (such as 'public.user') and/or table alias (such as 'user u'). The method will automatically quote the table name unless it has 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 Yiisoft\Db\Query\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 bind to the query.

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

The table to join. Use a string to represent the name of the table to join. The table name can contain a schema prefix (such as 'public.user') and/or table alias (e.g. 'user u'). The method will automatically quote the table name unless it has 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 Yiisoft\Db\Query\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. Keys and values of an associative array are treated as column names and will be quoted before being used in an SQL query.

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

The table to join. Use a string to represent the name of the table to join. The table name can contain a schema prefix (such as 'public.user') and/or table alias (such as 'user u'). The method will automatically quote the table name unless it has 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 Yiisoft\Db\Query\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 bind to the query.

The limit. Use null or negative value to disable limit.

$offset The offset. Use null or negative value to disable offset.

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

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

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

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

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

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

The columns (and the directions) to be ordered by. Columns can be specified in either a string (for example "id ASC, name DESC") or an array (such as ['id' => SORT_ASC, 'name' => SORT_DESC]). The method will automatically quote the column names unless a column has some parenthesis (which means the column has a DB expression). Note that if your order-by is an expression containing commas, you should always use an array to represent the order-by information. Otherwise, the method won't be able to correctly decide the order-by columns. Since Yiisoft\Db\Expression\ExpressionInterface an object can be passed to specify the ORDER BY part explicitly in plain 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 (such as public.user) and/or table alias (such as user u). The method will automatically quote the table name unless it has 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 Yiisoft\Db\Query\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 columns to be selected. Columns can be specified in either a string (for example id, name) or an array (such as ['id', 'name']). Columns can be prefixed with table names (such as user.id) and/or contain column aliases (for example user.id AS user_id). The method will automatically quote the column names unless a column has some parenthesis (which means the column has a DB expression). A DB expression may also be passed in form of an Yiisoft\Db\Expression\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 doesn't need alias, don't use a string key).

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

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

The value(s) to be set for the FOR part. This can be either a string (for example, 'UPDATE') or a list of strings (such as ['SHARE OF {{t1}}', 'UPDATE OF {{t2}}']) specifying one or several values. null means no FOR part.

The conditions to be put after HAVING.

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

The joins to perform in the query. The format is the following:

[
    ['INNER JOIN', 'table1', 'table1.id = table2.id'],
    ['LEFT JOIN', 'table3', 'table1.id = table3.id'],
]

The queries to union such as ['SELECT * FROM table1', 'SELECT * FROM table2'].

The conditions to put in the WHERE part.

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

$sql The SQL statement to be appended using UNION.

true if using UNION ALL and false if using UNION.

The conditions to put in the WHERE part.

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

If where was set previously.

The WITH queries to append to the query.

The SQL statement.

The query alias in WITH construction. To specify the alias in plain SQL, you may pass an instance of Yiisoft\Db\Expression\ExpressionInterface.

Its true if using WITH RECURSIVE and false if using WITH.