Interface Yiisoft\Db\Query\QueryInterface

Defined in: Yiisoft\Db\Query\QueryPartsInterface::addFor()

Adds more FOR parts to the existing ones.

See also:

• for()
• setFor()

Defined in: Yiisoft\Db\Query\QueryPartsInterface::addGroupBy()

Adds more group-by columns to the existing ones.

See also groupBy().

Defined in: Yiisoft\Db\Query\QueryPartsInterface::addOrderBy()

Adds more ORDER BY columns to the query.

See also orderBy().

Defined in: Yiisoft\Db\Query\QueryPartsInterface::addSelect()

Add more columns to the SELECT part of the query.

Note, that if select() hasn't been specified before, you should include * explicitly if you want to select all remaining columns too:

$query->addSelect(["*", "CONCAT(first_name, ' ', last_name) AS full_name"])->one();

See also select() for more details about the format of this parameter.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::addWithQuery()

Prepends an SQL statement using WITH syntax.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::andFilterCompare()

Adds a filtering condition for a specific column and allow the user to choose a filter operator.

It adds WHERE condition for the given field and determines the comparison operator based on the first few characters of the given value.

The condition is added in the same way as in andFilterWhere() so \Yiisoft\Db\Query\Query::isEmpty() are ignored.

The new condition and the existing one are joined using the AND operator.

The comparison operator is intelligently determined based on the first few characters in the given value.

In particular, it recognizes the following operators if they appear as the leading characters in the given value:

• <: the column must be less than the given value.
• >: the column must be greater than the given value.
• <=: the column must be less than or equal to the given value.
• >=: the column must be greater than or equal to the given value.
• <>: the column must not be the same as the given value.
• =: the column must be equal to the given value.
• If operator isn't regognized, the $defaultOperator is used.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::andFilterHaving()

Adds HAVING condition to the existing one but ignores Query::isEmpty().

The new condition and the existing one will be joined using the AND operator.

This method is similar to andHaving(). The main difference is that this method will remove \Yiisoft\Db\Query\Query::isEmpty().

As a result, this method is best suited for building query conditions based on filter values entered by users.

See also:

• filterHaving()
• orFilterHaving()

Defined in: Yiisoft\Db\Query\QueryPartsInterface::andFilterWhere()

Adds WHERE condition to the existing one but ignores Query::isEmpty().

The new condition and the existing one will be joined using the AND operator.

This method is similar to andWhere(). The main difference is that this method will remove \Yiisoft\Db\Query\Query::isEmpty().

As a result, this method is best suited for building query conditions based on filter values entered by users.

See also:

• filterWhere()
• orFilterWhere()

Defined in: Yiisoft\Db\Query\QueryPartsInterface::andHaving()

Adds HAVING condition to the existing one.

The new condition and the existing one will be joined using the AND operator.

See also:

• having()
• orHaving()

Defined in: Yiisoft\Db\Query\QueryPartsInterface::andWhere()

Adds WHERE condition to the existing one.

The new condition and the existing one will be joined using the AND operator.

See also:

• where()
• orWhere()

Defined in: Yiisoft\Db\Query\QueryFunctionsInterface::average()

Returns the average of the specified column values.

Defined in: Yiisoft\Db\Query\QueryFunctionsInterface::count()

Returns the number of records.

Note: Make sure you quote column names in the expression.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::distinct()

Sets the value indicating whether to SELECT DISTINCT or not.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::filterHaving()

Sets the HAVING part of the query but ignores Query::isEmpty().

This method is similar to having(). The main difference is that this method will remove \Yiisoft\Db\Query\Query::isEmpty(). As a result, this method is best suited for building query conditions based on filter values entered by users.

The following code shows the difference between this method and having():

// HAVING `age`=:age
$query->filterHaving(['name' => null, 'age' => 20]);
// HAVING `age`=:age
$query->having(['age' => 20]);
// HAVING `name` IS NULL AND `age`=:age
$query->having(['name' => null, 'age' => 20]);

Note that unlike having(), you can't pass binding parameters to this method.

See also:

• having()
• andFilterHaving()
• orFilterHaving()

Defined in: Yiisoft\Db\Query\QueryPartsInterface::filterWhere()

Sets the WHERE part of the query but ignores Query::isEmpty().

This method is similar to where().

The main difference is that this method will remove \Yiisoft\Db\Query\Query::isEmpty().

As a result, this method is best suited for building query conditions based on filter values entered by users.

The following code shows the difference between this method and where():

// WHERE `age`=:age
$query->filterWhere(['name' => null, 'age' => 20]);
// WHERE `age`=:age
$query->where(['age' => 20]);
// WHERE `name` IS NULL AND `age`=:age
$query->where(['name' => null, 'age' => 20]);

Note that unlike where(), you can't pass binding parameters to this method.

See also:

• where()
• andFilterWhere()
• orFilterWhere()

Defined in: Yiisoft\Db\Query\QueryPartsInterface::for()

Sets the FOR part of the query.

See also:

• addFor()
• setFor()

Defined in: Yiisoft\Db\Query\QueryPartsInterface::from()

Sets the FROM part of the query.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::groupBy()

Sets the GROUP BY part of the query.

See also addGroupBy().

Defined in: Yiisoft\Db\Query\QueryPartsInterface::having()

Initially sets the HAVING part of the query.

See also:

• andHaving()
• orHaving()

Defined in: Yiisoft\Db\Query\QueryPartsInterface::indexBy()

Sets the indexBy() property.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::innerJoin()

Appends an INNER JOIN part to the query.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::join()

Appends a JOIN part to the query.

The first parameter specifies what type of join it is.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::leftJoin()

Appends a LEFT OUTER JOIN part to the query.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::limit()

Sets the LIMIT part of the query.

Defined in: Yiisoft\Db\Query\QueryFunctionsInterface::max()

Returns the maximum of the specified column values.

Defined in: Yiisoft\Db\Query\QueryFunctionsInterface::min()

Returns the minimum of the specified column values.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::offset()

Sets the OFFSET part of the query.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::orFilterHaving()

Adds HAVING condition to the existing one but ignores Query::isEmpty().

The new condition and the existing one will be joined using the OR operator.

This method is similar to orHaving(). The main difference is that this method will remove \Yiisoft\Db\Query\Query::isEmpty(). As a result, this method is best suited for building query conditions based on filter values entered by users.

See also:

• filterHaving()
• andFilterHaving()

Defined in: Yiisoft\Db\Query\QueryPartsInterface::orFilterWhere()

Adds WHERE condition to the existing one but ignores Query::isEmpty().

The new condition and the existing one will be joined using the 'OR' operator.

This method is similar to orWhere(). The main difference is that this method will remove \Yiisoft\Db\Query\Query::isEmpty(). As a result, this method is best suited for building query conditions based on filter values entered by users.

See also:

• filterWhere()
• andFilterWhere()

Defined in: Yiisoft\Db\Query\QueryPartsInterface::orHaving()

Adds HAVING condition to the existing one.

The new condition and the existing one will be joined using the OR operator.

See also:

• having()
• andHaving()

Defined in: Yiisoft\Db\Query\QueryPartsInterface::orWhere()

Adds WHERE condition to the existing one.

The new condition and the existing one will be joined using the OR operator.

See also:

• where()
• andWhere()

Defined in: Yiisoft\Db\Query\QueryPartsInterface::orderBy()

Sets the ORDER BY part of the query.

See also addOrderBy().

Defined in: Yiisoft\Db\Query\QueryPartsInterface::rightJoin()

Appends a RIGHT OUTER JOIN part to the query.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::select()

Sets the SELECT part of the query.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::selectOption()

It allows you to specify more options for the SELECT clause of an SQL statement.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::setFor()

Overwrites the FOR part of the query.

See also:

• for()
• addFor()

Defined in: Yiisoft\Db\Query\QueryPartsInterface::setHaving()

Overwrites the HAVING part of the query.

See also having().

Defined in: Yiisoft\Db\Query\QueryPartsInterface::setJoins()

Specify the joins for a SELECT statement in a database query.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::setUnions()

Specify queries for a SELECT statement that are combined with UNIONs.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::setWhere()

Overwrites the WHERE part of the query.

See also where().

Defined in: Yiisoft\Db\Query\QueryFunctionsInterface::sum()

Returns the sum of the specified column values.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::union()

Appends an SQL statement using UNION operator.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::where()

Initially sets the WHERE part of the query.

The $condition specified as an array can be in one of the following two formats:

• key-value format: ['column1' => value1, 'column2' => value2, ...]
• operator format: [operator, operand1, operand2, ...]

A condition in key-value format represents the following SQL expression in general: column1=value1 AND column2=value2 AND .... In case when a value is an array, an IN expression will be generated. And if a value is null, IS NULL will be used in the generated expression. Below are some examples:

• ['type' => 1, 'status' => 2] generates (type = 1) AND (status = 2).
• ['id' => [1, 2, 3], 'status' => 2] generates (id IN (1, 2, 3)) AND (status = 2).
• ['status' => null] generates status IS NULL.

A condition in operator format generates the SQL expression according to the specified operator, which can be one of the following:

• and: the operands should be concatenated together using AND. For example, ['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, ['and', 'type=1', ['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. For example, ['or', ['type' => [7, 8, 9]], ['id' => [1, 2, 3]]] will generate (type IN (7, 8, 9) OR (id IN (1, 2, 3))).

• not: this will take only one operand and build the negation of it by prefixing the query string with NOT. For example ['not', ['attribute' => null]] will result in the condition NOT (attribute IS NULL).

• between: operand 1 should be the column name, and operand 2 and 3 should be the starting and ending values of the range that the column is in. For example, ['between', 'id', 1, 10] will generate id BETWEEN 1 AND 10.

• not between: similar to between except the BETWEEN is replaced with NOT BETWEEN in the generated condition.

• 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, ['in', 'id', [1, 2, 3]] will generate id IN (1, 2, 3). The method will quote the column name and escape values in the range.

  To create a composite IN condition you can use and array for the column name and value, where the values are indexed by the column name: ['in', ['id', 'name'], [['id' => 1, 'name' => 'foo'], ['id' => 2, 'name' => 'bar']] ].

  You may also specify a sub-query that's used to get the values for the IN-condition: ['in', 'user_id', (new Query())->select('id')->from('users')->where(['active' => 1])]

• 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, ['like', 'name', 'tester'] will generate name LIKE '%tester%'. When the value range is given as an array, many LIKE predicates will be generated and concatenated using AND. For example, ['like', 'name', ['test', 'sample']] will generate name LIKE '%test%' AND name LIKE '%sample%'. The method will quote the column name and escape special characters in the values. Sometimes, you may want to add the percentage characters to the matching value by yourself. You may supply a third operand false to do so. For example, ['like', 'name', '%tester', false] will generate name LIKE '%tester'.

• 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.

• exists: operand 1 is a query object that used to build an EXISTS condition. For example ['exists', (new Query())->select('id')->from('users')->where(['active' => 1])] will result in the following SQL expression: EXISTS (SELECT "id" FROM "users" WHERE "active"=1).

• not exists: similar to the exists operator except that EXISTS is replaced with NOT EXISTS in the generated condition.

• Additionally, you can specify arbitrary operators as follows: A condition of ['>=', 'id', 10] will result in the following SQL expression: id >= 10.

Note that this method will override any existing WHERE condition. You might want to use andWhere() or orWhere() instead.

See also:

• andWhere()
• orWhere()

Defined in: Yiisoft\Db\Query\QueryPartsInterface::withQueries()

Specifies the WITH query clause for the query.

Defined in: Yiisoft\Db\Query\QueryPartsInterface::withQuery()

Set an SQL statement using WITH syntax.