Класс yii\mongodb\Query

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

public yii\mongodb\Collection getCollection ( $db = null )

public string|array $from = null

public array $options = []

public array $select = []

addOptions() public method

Добавляет дополнительные параметры курсора.

См. также options().

public $this addOptions ( $options )
$options	array	Параметры курсора в формате: имяПараметра => значениеПараметра
return	$this	Сам объект запроса

aggregate() protected method

Выполняет агрегацию для указанного столбца.

protected integer aggregate ( $column, $operator, $db )
$column	string	Имя столбца.
$operator	string	Оператор агрегации.
$db	yii\mongodb\Connection	Подключение к базе данных, используемое для выполнения запроса.
return	integer	Результат агрегации.

all() public method

Выполняет запрос и возвращает все результаты в виде массива.

public array all ( $db = null )
$db	yii\mongodb\Connection	Подключение к MongoDB, используемое для выполнения запроса. Если этот параметр не задан, используется компонент mongodb приложения.
return	array	Результаты запроса. Если запрос ничего не возвращает, возвращается пустой массив.

andFilterCompare() public method (доступно начиная с версии 2.0.5)

Вспомогательный метод для удобного выполнения запросов на значения, содержащие некоторые общие операторы.

Оператор сравнения интеллектуально определяется на основе первых нескольких символов в заданном значении и внутренне преобразуется в оператор MongoDB. В частности, он распознаёт следующие операторы, если они появляются в качестве ведущих символов в заданном значении: <: столбец должен быть меньше заданного значения ($lt). >: столбец должен быть больше заданного значения ($gt). <=: столбец должен быть меньше или равен заданному значению ($lte). >=: столбец должен быть больше или равен заданному значению ($gte). <>: столбец не должен быть таким же, как заданное значение ($ne). Обратите внимание, что когда $partialMatch имеет значение true, это означает, что значение не должно быть подстрокой столбца. =: столбец должен быть равен заданному значению ($eq). ни один из вышеперечисленных: используйте $defaultOperator

Обратите внимание, что если значение пустое, выражение сравнения не будет добавлено к условию поиска.

См. также \yii\mongodb\yii\mongodb\Collection::buildCondition().

public $this andFilterCompare ( $name, $value, $defaultOperator = '=' )
$name	string	Имя столбца
$value	string	Значение столбца
$defaultOperator	string	По умолчанию =, выполняет точное соответствие. Например: используйте 'LIKE' или 'REGEX' для частичного или регулярного сопоставления.
return	$this	Сам объект запроса.

average() public method

Возвращает среднее значение указанных значений столбца.

public integer average ( $q, $db = null )
$q	string	Имя столбца. Убедитесь, что вы правильно заключаете имена столбцов в выражении.
$db	yii\mongodb\Connection	Подключение к MongoDB, используемое для выполнения запроса. Если этот параметр не задан, используется компонент mongodb приложения.
return	integer	Среднее значение указанных значений столбца.

batch() public method (доступно начиная с версии 2.1)

Инициализирует пакетный запрос.

Пакетный запрос поддерживает извлечение данных частями, что позволяет поддерживать использование памяти в рамках лимита. Этот метод вернёт объект yii\mongodb\BatchQueryResult, который реализует интерфейс Iterator и может быть пройден для извлечения данных по частям.

Например,

$query = (new Query)->from('user');
foreach ($query->batch() as $rows) {
    // $rows is an array of 10 or fewer rows from user collection
}

public yii\mongodb\BatchQueryResult batch ( $batchSize = 100, $db = null )
$batchSize	integer	Количество записей, извлекаемых в каждой группе.
$db	yii\mongodb\Connection	Подключение к MongoDB. Если не указано, используется компонент "mongodb" приложения.
return	yii\mongodb\BatchQueryResult	Результат пакетного запроса. Он реализует интерфейс Iterator и может быть пройден для извлечения данных по частям.

buildCursor() public method

Создаёт курсор MongoDB для этого запроса.

public \MongoDB\Driver\Cursor buildCursor ( $db = null )
$db	yii\mongodb\Connection	Подключение к MongoDB, используемое для выполнения запроса.
return	\MongoDB\Driver\Cursor	Экземпляр курсора Mongo.

column() public method (доступно начиная с версии 2.1.2)

Выполняет запрос и возвращает первый столбец результата.

Столбец _id будет автоматически исключён из полей выборки, если select() не пустой и _id не выбран явно.

public array column ( $db = null )
$db	yii\mongodb\Connection	Подключение к MongoDB, используемое для генерации запроса. Если этот параметр не задан, используется компонент mongodb приложения.
return	array	Первый столбец результата запроса. Если запрос ничего не возвращает, возвращается пустой массив.

count() public method

Возвращает количество записей.

public integer count ( $q = '*', $db = null )
$q	string	Сохранено для соответствия yii\db\QueryInterface, его значение игнорируется.
$db	yii\mongodb\Connection	Подключение к MongoDB, используемое для выполнения запроса. Если этот параметр не задан, используется компонент mongodb приложения.
return	integer	Количество записей
throws	yii\mongodb\Exception	при ошибке.

distinct() public method

Возвращает список уникальных значений для заданного столбца по всей коллекции.

public array distinct ( $q, $db = null )
$q	string	Столбец для использования.
$db	yii\mongodb\Connection	Подключение к MongoDB, используемое для выполнения запроса. Если этот параметр не задан, используется компонент mongodb приложения.
return	array	Массив уникальных значений

each() public method (доступно начиная с версии 2.1)

Инициализирует пакетный запрос и извлекает данные строка за строкой.

Этот метод похож на batch(), за исключением того, что в каждом итерации результата возвращается только одна строка данных. Например,

$query = (new Query)->from('user');
foreach ($query->each() as $row) {
}

public yii\mongodb\BatchQueryResult each ( $batchSize = 100, $db = null )
$batchSize	целое число	Количество записей, извлекаемых в каждой группе.
$db	yii\mongodb\Connection	Подключение к MongoDB. Если не задано, будет использоваться компонент приложения «mongodb».
return	yii\mongodb\BatchQueryResult	Результат пакетного запроса. Он реализует интерфейс Iterator и может быть пройден для получения данных по частям.

exists() общедоступный метод

Возвращает значение, указывающее, содержит ли результат запроса какие-либо строки данных.

public boolean exists ( $db = null )
$db	yii\mongodb\Connection	Подключение к Mongo, используемое для выполнения запроса. Если этот параметр не задан, будет использован компонент приложения mongodb.
return	boolean	Содержит ли результат запроса какие-либо строки данных.

fetchRows() защищённый метод

Извлекает строки из заданного курсора Mongo.

protected массив|boolean fetchRows ( $cursor, $all = true, $indexBy = null )
$cursor	\MongoDB\Driver\Cursor	Экземпляр курсора Mongo для извлечения данных.
$all	boolean	Нужно ли извлечь все строки или только первую.
$indexBy	строка|обратный вызов	Имя столбца или PHP-обратный вызов, по которому результаты запроса должны быть индексированы.
return	массив|boolean	Результат.
throws	yii\mongodb\Exception	при ошибке.

fetchRowsInternal() защищённый метод

См. также yii\mongodb\Query::fetchRows().

protected массив|boolean fetchRowsInternal ( $cursor, $all )
$cursor	\MongoDB\Driver\Cursor	Экземпляр курсора Mongo для извлечения данных.
$all	boolean	Нужно ли извлечь все строки или только первую.
return	массив|boolean	Результат.

from() общедоступный метод

Устанавливает коллекцию для выбора.

public $this from ( $collection )
$collection
return	$this	Сам объект запроса.

getCollection() общедоступный метод

Возвращает коллекцию Mongo для этого запроса.

public yii\mongodb\Collection getCollection ( $db = null )
$db	yii\mongodb\Connection	Подключение к Mongo.
return	yii\mongodb\Collection	Экземпляр коллекции.

max() общедоступный метод

Возвращает максимальное значение указанных значений столбца.

public целое число max ( $q, $db = null )
$q	строка	Имя столбца. Убедитесь, что вы правильно заключаете имена столбцов в выражение.
$db	yii\mongodb\Connection	Подключение к MongoDB, используемое для выполнения запроса. Если этот параметр не задан, будет использован компонент приложения mongodb.
return	целое число	Максимальное значение указанных значений столбца.

min() общедоступный метод

Возвращает минимальное значение указанных значений столбца.

public целое число min ( $q, $db = null )
$q	строка	Имя столбца. Убедитесь, что вы правильно заключаете имена столбцов в выражение.
$db	yii\mongodb\Connection	Подключение к MongoDB, используемое для выполнения запроса. Если этот параметр не задан, будет использован компонент приложения db.
return	целое число	Минимальное значение указанных значений столбца.

modify() общедоступный метод

Выполняет запрос 'findAndModify' и возвращает одну строку результата.

public массив|null modify ( $update, $options = [], $db = null )
$update	массив	Критерии обновления
$options	массив	Список параметров в формате: имяПараметра => значениеПараметра.
$db	yii\mongodb\Connection	Подключение к Mongo, используемое для выполнения запроса.
return	массив|null	Исходный документ или изменённый документ, когда $options['new'] задан.

one() общедоступный метод

Выполняет запрос и возвращает одну строку результата.

public массив|false one ( $db = null )
$db	yii\mongodb\Connection	Подключение к Mongo, используемое для выполнения запроса. Если этот параметр не задан, будет использован компонент приложения mongodb.
return	массив|false	Первая строка (с точки зрения массива) результата запроса. false возвращается, если в результате запроса ничего нет.

options() общедоступный метод

Устанавливает параметры курсора.

См. также addOptions().

public $this options ( $options )
$options	массив	Параметры курсора в формате: имяПараметра => значениеПараметра
return	$this	Сам объект запроса

populate() общедоступный метод

Преобразует результаты запроса в указанный формат.

Этот метод используется внутри для преобразования данных, извлеченных из базы данных, в формат, требуемый этим запросом.

public массив populate ( $rows )
$rows	массив	Необработанный результат запроса из базы данных
return	массив	Преобразованный результат запроса

prepare() общедоступный метод (доступен начиная с версии 2.1.3)

Подготавливает запрос к построению.

Этот метод вызывается перед фактическим составлением запроса, например, построением курсора, подсчётом и т. д. Вы можете переопределить этот метод, чтобы выполнить некоторые заключительные подготовительные действия перед выполнением запроса.

public $this prepare ( )
return	$this	Подготовленный экземпляр запроса.

scalar() общедоступный метод (доступен начиная с версии 2.1.2)

Возвращает результат запроса как скалярное значение.

Возвращаемое значение будет первой колонкой в первой строке результатов запроса. Столбец _id будет автоматически исключён из полей select, если select() не пустой и _id не выбран явно.

public строка|null|false scalar ( $db = null )
$db	yii\mongodb\Connection	Подключение MongoDB, используемое для генерации запроса. Если этот параметр не указан, будет использовано компонент mongodb приложения.
return	строка|null|false	Значение первой колонки в первой строке результата запроса. false возвращается, если результат запроса пустой.

select() public method

Устанавливает список полей результатов для возврата.

public $this select ( массив $fields )
$fields	массив	Поля результатов для возврата.
return	$this	Сам объект запроса.

sum() public method

Возвращает сумму значений указанной колонки.

public целое число sum ( $q, $db = null )
$q	строка	Имя колонки. Убедитесь, что имена колонок правильно заключены в кавычки в выражении.
$db	yii\mongodb\Connection	Подключение Mongo, используемое для выполнения запроса. Если этот параметр не указан, будет использовано компонент mongodb приложения.
return	целое число	Сумма значений указанной колонки