MongoCollection::findOne - Queries this collection, returning a single element
Вернуться к: MongoCollection
MongoCollection::findOne
(PECL mongo >=0.9.0)
MongoCollection::findOne — Queries this collection, returning a single element
Описание
$query = array()
[, array $fields = array()
[, array $options = array()
]]] )As opposed to MongoCollection::find(), this method will return only the first result from the result set, and not a MongoCursor that can be iterated over.
Список параметров
-
query -
The fields for which to search. MongoDB's query language is quite extensive. The PHP driver will in almost all cases pass the query straight through to the server, so reading the MongoDB core docs on » find is a good idea.
ВниманиеPlease make sure that for all special query operaters (starting with $) you use single quotes so that PHP doesn't try to replace "$exists" with the value of the variable $exists.
-
fields -
Fields of the results to return. The array is in the format array('fieldname' => true, 'fieldname2' => true). The _id field is always returned.
-
options -
This parameter is an associative array of the form array("name" => <value>, ...). Currently supported options are:
"maxTimeMS"
Указывает суммарный лимит времени в миллисекундах на обработку операции (не включая время простоя). Если операция не завершилась за это время, то бросается MongoExecutionTimeoutException.
Возвращаемые значения
Returns record matching the search or NULL.
Ошибки
Throws MongoConnectionException if it cannot reach the database.
Список изменений
| Версия | Описание |
|---|---|
| 1.5.0 |
Added optional options argument.
|
Примеры
Пример #1 MongoCollection::findOne() document by its id.
This example demonstrates how to find a single document in a collection by its id.
<?php
$articles = $mongo->my_db->articles;
$article = $articles->findOne(array('_id' => new MongoId('47cc67093475061e3d9536d2')));
?>
Пример #2 MongoCollection::findOne() document by some condition.
This example demonstrates how to find a single document in a collection by some condition and limiting the returned fields.
<?php
$users = $mongo->my_db->users;
$user = $users->findOne(array('username' => 'jwage'), array('password'));
print_r($user);
?>
Результатом выполнения данного примера будет что-то подобное:
Array
(
[_id] => MongoId Object
(
)
[password] => test
)
Notice how even though the document does have a username field, we limited the results to only contain the password field.
Смотрите также
- MongoCollection::find() - Queries this collection, returning a MongoCursor for the result set
- MongoCollection::insert() - Inserts a document into the collection
- MongoDB core docs on » find.
Вернуться к: MongoCollection