mongocollection.findone(3) [php man page]
MONGOCOLLECTION.FINDONE(3) 1 MONGOCOLLECTION.FINDONE(3) MongoCollection::findOne - Queries this collection, returning a single element SYNOPSIS
public array MongoCollection::findOne ([array $query = array()], [array $fields = array()], [array $options = array()]) DESCRIPTION
As opposed to MongoCollection.find(3), this method will return only the first result from the result set, and not a MongoCursor that can be iterated over. PARAMETERS
o $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. Warning 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. o $fields - Fields of the results to return. The array is in the format array('fieldname' => true, 'fieldname2' => true). The _id field is always returned. o $options - This parameter is an associative array of the form array("name" => <value>, ...). Currently supported options are: o "maxTimeMS"Specifies a cumulative time limit in milliseconds for processing the operation (does not include idle time). If the operation is not completed within the timeout period, a MongoExecutionTimeoutException will be thrown. RETURN VALUES
Returns record matching the search or NULL. ERRORS
/EXCEPTIONS Throws MongoConnectionException if it cannot reach the database. CHANGELOG
+--------+------------------------------------+ |Version | | | | | | | Description | | | | +--------+------------------------------------+ | 1.5.0 | | | | | | | Added optional $options argument. | | | | +--------+------------------------------------+ EXAMPLES
Example #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'))); ?> Example #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); ?> The above example will output something similar to: 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. SEE ALSO
MongoCollection.find(3), MongoCollection.insert(3), MongoDB core docs on find.. PHP Documentation Group MONGOCOLLECTION.FINDONE(3)
Check Out this Related Man Page
MONGOCOLLECTION.FIND(3) 1 MONGOCOLLECTION.FIND(3) MongoCollection::find - Queries this collection, returning aMongoCursorfor the result set SYNOPSIS
public MongoCursor MongoCollection::find ([array $query = array()], [array $fields = array()]) DESCRIPTION
PARAMETERS
o $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. Warning Please make sure that for all special query operators (starting with $) you use single quotes so that PHP doesn't try to replace "$exists" with the value of the variable $exists. o $fields - Fields of the results to return. The array is in the format array('fieldname' => true, 'fieldname2' => true). The _id field is always returned. RETURN VALUES
Returns a cursor for the search results. EXAMPLES
Example #1 MongoCollection.find(3) example This example demonstrates basic search options. <?php $m = new MongoClient(); $db = $m->selectDB('test'); $collection = new MongoCollection($db, 'produce'); // search for fruits $fruitQuery = array('Type' => 'Fruit'); $cursor = $collection->find($fruitQuery); foreach ($cursor as $doc) { var_dump($doc); } // search for produce that is sweet. Taste is a child of Details. $sweetQuery = array('Details.Taste' => 'Sweet'); echo "Sweet "; $cursor = $collection->find($sweetQuery); foreach ($cursor as $doc) { var_dump($doc); } ?> The above example will output: array(4) { ["_id"]=> object(MongoId)#7(1) { ["$id"]=> string(24) "50a87dd084f045a19b220dd6" } ["Name"]=> string(5) "Apple" ["Type"]=> string(5) "Fruit" ["Details"]=> array(2) { ["Taste"]=> string(5) "Sweet" ["Colour"]=> string(3) "Red" } } array(4) { ["_id"]=> object(MongoId)#8(1) { ["$id"]=> string(24) "50a87de084f045a19b220dd7" } ["Name"]=> string(5) "Lemon" ["Type"]=> string(5) "Fruit" ["Details"]=> array(2) { ["Taste"]=> string(4) "Sour" ["Colour"]=> string(5) "Green" } } Sweet: array(4) { ["_id"]=> object(MongoId)#7(1) { ["$id"]=> string(24) "50a87dd084f045a19b220dd6" } ["Name"]=> string(5) "Apple" ["Type"]=> string(5) "Fruit" ["Details"]=> array(2) { ["Taste"]=> string(5) "Sweet" ["Colour"]=> string(3) "Red" } } See MongoCursor for more information how to work with cursors. Example #2 MongoCollection.find(3) example This example demonstrates how to search for a range. <?php $m = new MongoClient(); $db = $m->selectDB('test'); $collection = new MongoCollection($db, 'phpmanual'); // search for documents where 5 < x < 20 $rangeQuery = array('x' => array( '$gt' => 5, '$lt' => 20 )); $cursor = $collection->find($rangeQuery); foreach ($cursor as $doc) { var_dump($doc); } ?> The above example will output: array(2) { ["_id"]=> object(MongoId)#10(1) { ["$id"]=> string(24) "4ebc3e3710b89f2349000000" } ["x"]=> int(12) } array(2) { ["_id"]=> object(MongoId)#11(1) { ["$id"]=> string(24) "4ebc3e3710b89f2349000001" } ["x"]=> int(12) } See MongoCursor for more information how to work with cursors. Example #3 MongoCollection.find(3) example using $where This example demonstrates how to search a collection using javascript code to reduce the resultset. <?php $m = new MongoClient(); $db = $m->selectDB('test'); $collection = new MongoCollection($db, 'phpmanual'); $js = "function() { return this.name == 'Joe' || this.age == 50; }"; $cursor = $collection->find(array('$where' => $js)); foreach ($cursor as $doc) { var_dump($doc); } ?> The above example will output: array(3) { ["_id"]=> object(MongoId)#7(1) { ["$id"]=> string(24) "4ebc3e3710b89f2349000002" } ["name"]=> string(3) "Joe" ["age"]=> int(20) } Example #4 MongoCollection.find(3) example using $in This example demonstrates how to search a collection using the $in operator. <?php $m = new MongoClient(); $db = $m->selectDB('test'); $collection = new MongoCollection($db, 'phpmanual'); $cursor = $collection->find(array( 'name' => array('$in' => array('Joe', 'Wendy')) )); ?> The above example will output: array(3) { ["_id"]=> object(MongoId)#7(1) { ["$id"]=> string(24) "4ebc3e3710b89f2349000002" } ["name"]=> string(3) "Joe" ["age"]=> int(20) } Example #5 Getting results as an array This returns a MongoCursor. Often, when people are starting out, they are more comfortable using an array. To turn a cursor into an array, use the iterator_to_array(3) function. <?php $m = new MongoClient(); $db = $m->selectDB('test'); $collection = new MongoCollection($db, 'phpmanual'); $cursor = $collection->find(); $array = iterator_to_array($cursor); ?> The above example will output: array(3) { ["4ebc40af10b89f5149000000"]=> array(2) { ["_id"]=> object(MongoId)#6(1) { ["$id"]=> string(24) "4ebc40af10b89f5149000000" } ["x"]=> int(12) } ["4ebc40af10b89f5149000001"]=> array(2) { ["_id"]=> object(MongoId)#11(1) { ["$id"]=> string(24) "4ebc40af10b89f5149000001" } ["x"]=> int(12) } ["4ebc40af10b89f5149000002"]=> array(3) { ["_id"]=> object(MongoId)#12(1) { ["$id"]=> string(24) "4ebc40af10b89f5149000002" } ["name"]=> string(3) "Joe" ["age"]=> int(20) } } Using iterator_to_array(3) forces the driver to load all of the results into memory, so do not do this for result sets that are larger than memory! Also, certain system collections do not have an _id field. If you are dealing with a collection that might have documents without _ids, pass FALSE as the second argument to iterator_to_array(3) (so that it will not try to use the non-existent _id values as keys). SEE ALSO
MongoCollection.findOne(3), MongoCollection.insert(3), MongoDB core docs on find.. PHP Documentation Group MONGOCOLLECTION.FIND(3)