Class yii\mongodb\Query

All Classes | Properties | Methods

Inheritance	yii\mongodb\Query » yii\base\Component
Implements	yii\db\QueryInterface
Uses Traits	yii\db\QueryTrait
Subclasses	yii\mongodb\ActiveQuery, yii\mongodb\file\ActiveQuery, yii\mongodb\file\Query
Available since version	2.0

Query represents Mongo "find" operation.

Query provides a set of methods to facilitate the specification of "find" command. These methods can be chained together.

For example,

$query = new Query;
// compose the query
$query->select(['name', 'status'])
    ->from('customer')
    ->limit(10);
// execute the query
$rows = $query->all();

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$from	string\|array	The collection to be selected from.	yii\mongodb\Query
$options	array	Cursor options in format: optionKey => optionValue	yii\mongodb\Query
$select	array	The fields of the results to return.	yii\mongodb\Query

Public Methods

Hide inherited methods

Method	Description	Defined By
addOptions()	Adds additional cursor options.	yii\mongodb\Query
all()	Executes the query and returns all results as an array.	yii\mongodb\Query
andFilterCompare()	Helper method for easy querying on values containing some common operators.	yii\mongodb\Query
average()	Returns the average of the specified column values.	yii\mongodb\Query
count()	Returns the number of records.	yii\mongodb\Query
distinct()	Returns a list of distinct values for the given column across a collection.	yii\mongodb\Query
exists()	Returns a value indicating whether the query result contains any row of data.	yii\mongodb\Query
from()	Sets the collection to be selected from.	yii\mongodb\Query
getCollection()	Returns the Mongo collection for this query.	yii\mongodb\Query
max()	Returns the maximum of the specified column values.	yii\mongodb\Query
min()	Returns the minimum of the specified column values.	yii\mongodb\Query
modify()	Performs 'findAndModify' query and returns a single row of result.	yii\mongodb\Query
one()	Executes the query and returns a single row of result.	yii\mongodb\Query
options()	Sets the cursor options.	yii\mongodb\Query
populate()	Converts the raw query results into the format as specified by this query.	yii\mongodb\Query
select()	Sets the list of fields of the results to return.	yii\mongodb\Query
sum()	Returns the sum of the specified column values.	yii\mongodb\Query

Protected Methods

Hide inherited methods

Method	Description	Defined By
aggregate()	Performs the aggregation for the given column.	yii\mongodb\Query
buildCursor()	Builds the Mongo cursor for this query.	yii\mongodb\Query
fetchRows()	Fetches rows from the given Mongo cursor.	yii\mongodb\Query
fetchRowsInternal()		yii\mongodb\Query

Property Details

$from public property

The collection to be selected from. If string considered as the name of the collection inside the default database. If array - first element considered as the name of the database, second - as name of collection inside that database

Method Details

addOptions() public method

Adds additional cursor options.

See also options().

public $this addOptions ( $options )
$options	array	Cursor options in format: optionName => optionValue
return	$this	The query object itself

aggregate() protected method

Performs the aggregation for the given column.

protected integer aggregate ( $column, $operator, $db )
$column	string	Column name.
$operator	string	Aggregation operator.
$db	yii\mongodb\Connection	The database connection used to execute the query.
return	integer	Aggregation result.

all() public method

Executes the query and returns all results as an array.

public array all ( $db = null )
$db	yii\mongodb\Connection	The Mongo connection used to execute the query. If this parameter is not given, the `mongodb` application component will be used.
return	array	The query results. If the query results in nothing, an empty array will be returned.

andFilterCompare() public method (available since version 2.0.5)

Helper method for easy querying on values containing some common operators.

The comparison operator is intelligently determined based on the first few characters in the given value and internally translated to a MongoDB operator. 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 ($lt). >: the column must be greater than the given value ($gt). <=: the column must be less than or equal to the given value ($lte). >=: the column must be greater than or equal to the given value ($gte). <>: the column must not be the same as the given value ($ne). Note that when $partialMatch is true, this would mean the value must not be a substring of the column. =: the column must be equal to the given value ($eq). none of the above: use the $defaultOperator

Note that when the value is empty, no comparison expression will be added to the search condition.

See also \yii\mongodb\yii\mongodb\Collection::buildCondition().

public $this andFilterCompare ( $name, $value, $defaultOperator = '=' )
$name	string	Column name
$value	string	Column value
$defaultOperator	string	Defaults to =, performing an exact match. For example: use 'LIKE' or 'REGEX' for partial cq regex matching
return	$this	The query object itself.

average() public method

Returns the average of the specified column values.

public integer average ( $q, $db = null )
$q	string	The column name. Make sure you properly quote column names in the expression.
$db	yii\mongodb\Connection	The Mongo connection used to execute the query. If this parameter is not given, the `mongodb` application component will be used.
return	integer	The average of the specified column values.

buildCursor() protected method

Builds the Mongo cursor for this query.

protected \MongoCursor buildCursor ( $db = null )
$db	yii\mongodb\Connection	The database connection used to execute the query.
return	\MongoCursor	Mongo cursor instance.

count() public method

Returns the number of records.

public integer count ( $q = '*', $db = null )
$q	string	Kept to match \yii\db\QueryInterface, its value is ignored.
$db	yii\mongodb\Connection	The Mongo connection used to execute the query. If this parameter is not given, the `mongodb` application component will be used.
return	integer	Number of records
throws	yii\mongodb\Exception	on failure.

distinct() public method

Returns a list of distinct values for the given column across a collection.

public array distinct ( $q, $db = null )
$q	string	Column to use.
$db	yii\mongodb\Connection	The Mongo connection used to execute the query. If this parameter is not given, the `mongodb` application component will be used.
return	array	Array of distinct values

exists() public method

Returns a value indicating whether the query result contains any row of data.

public boolean exists ( $db = null )
$db	yii\mongodb\Connection	The Mongo connection used to execute the query. If this parameter is not given, the `mongodb` application component will be used.
return	boolean	Whether the query result contains any row of data.

fetchRows() protected method

Fetches rows from the given Mongo cursor.

protected array\|boolean fetchRows ( $cursor, $all = true, $indexBy = null )
$cursor	\MongoCursor	Mongo cursor instance to fetch data from.
$all	boolean	Whether to fetch all rows or only first one.
$indexBy	string\|callable	The column name or PHP callback, by which the query results should be indexed by.
return	array\|boolean	Result.
throws	yii\mongodb\Exception	on failure.

fetchRowsInternal() protected method

protected array\|boolean fetchRowsInternal ( $cursor, $all, $indexBy )
$cursor	\MongoCursor	Mongo cursor instance to fetch data from.
$all	boolean	Whether to fetch all rows or only first one.
$indexBy	string\|callable	Value to index by.
return	array\|boolean	Result.

from() public method

Sets the collection to be selected from.

public $this from ( $collection )
$collection
return	$this	The query object itself.

getCollection() public method

Returns the Mongo collection for this query.

public yii\mongodb\Collection getCollection ( $db = null )
$db	yii\mongodb\Connection	Mongo connection.
return	yii\mongodb\Collection	Collection instance.

max() public method

Returns the maximum of the specified column values.

public integer max ( $q, $db = null )
$q	string	The column name. Make sure you properly quote column names in the expression.
$db	yii\mongodb\Connection	The Mongo connection used to execute the query. If this parameter is not given, the `mongodb` application component will be used.
return	integer	The maximum of the specified column values.

min() public method

Returns the minimum of the specified column values.

public integer min ( $q, $db = null )
$q	string	The column name. Make sure you properly quote column names in the expression.
$db	yii\mongodb\Connection	The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used.
return	integer	The minimum of the specified column values.

modify() public method

Performs 'findAndModify' query and returns a single row of result.

public array\|null modify ( $update, $options = [], $db = null )
$update	array	Update criteria
$options	array	List of options in format: optionName => optionValue.
$db	yii\mongodb\Connection	The Mongo connection used to execute the query.
return	array\|null	The original document, or the modified document when $options['new'] is set.

one() public method

Executes the query and returns a single row of result.

public array\|boolean one ( $db = null )
$db	yii\mongodb\Connection	The Mongo connection used to execute the query. If this parameter is not given, the `mongodb` application component will be used.
return	array\|boolean	The first row (in terms of an array) of the query result. False is returned if the query results in nothing.

options() public method

Sets the cursor options.

public $this options ( $options )
$options	array	Cursor options in format: optionName => optionValue
return	$this	The query object itself

public array populate ( $rows )
$rows	array	The raw query result from database
return	array	The converted query result

public $this select ( array $fields )
$fields	array	Fields of the results to return.
return	$this	The query object itself.

public integer sum ( $q, $db = null )
$q	string	The column name. Make sure you properly quote column names in the expression.
$db	yii\mongodb\Connection	The Mongo connection used to execute the query. If this parameter is not given, the `mongodb` application component will be used.
return	integer	The sum of the specified column values