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.GETREADPREFERENCE(3)					 1				      MONGOCOLLECTION.GETREADPREFERENCE(3)

MongoCollection::getReadPreference - Get the read preference for this collection

SYNOPSIS

       public array MongoCollection::getReadPreference (void  )

DESCRIPTION

PARAMETERS

       This function has no parameters.

RETURN VALUES

       This function returns an array describing the read preference. The array contains the values type for the string read preference mode (cor-
       responding to the MongoClient constants), and tagsets containing a list of all tag set criteria. If no tag  sets  were  specified,  tagsets
       will not be present in the array.

CHANGELOG

       +--------+---------------------------------------------------+
       |Version |						    |
       |	|						    |
       |	|		     Description		    |
       |	|						    |
       +--------+---------------------------------------------------+
       | 1.3.3	|						    |
       |	|						    |
       |	|  The	return	value  has changed to be consistent |
       |	| with MongoCollection::setReadPreference. The type |
       |	| value  was  changed  from  a	number to a string, |
       |	| type_string  was   removed,	and   tagsets	now |
       |	| expresses  tags  as  key/value  pairs  instead of |
       |	| colon-delimited strings.			    |
       |	|						    |
       +--------+---------------------------------------------------+
EXAMPLES

       Example #1

	      MongoCollection::getReadPreference return value example

	      <?php

	      $m = new MongoClient();
	      $c = $m->test->users;
	      $c->setReadPreference(MongoClient::RP_SECONDARY, array(
		  array('dc' => 'east', 'use' => 'reporting'),
		  array('dc' => 'west'),
		  array(),
	      ));
	      var_dump($c->getReadPreference());
	      ?>

	      The above example will output:

	      array(2) {
		["type"]=>
		string(9) "secondary"
		["tagsets"]=>
		array(3) {
		  [0]=>
		  array(2) {
		    ["dc"]=>
		    string(4) "east"
		    ["use"]=>
		    string(9) "reporting"
		  }
		  [1]=>
		  array(1) {
		    ["dc"]=>
		    string(7) "west"
		  }
		  [2]=>
		  array(0) {
		  }
		}
	      }

SEE ALSO The read preferences documentation., MongoCollection.setReadPreference(3).
PHP Documentation Group 										      MONGOCOLLECTION.GETREADPREFERENCE(3)

Linux and UNIX Man Pages

mongocollection.findone(3) [php man page]

Check Out this Related Man Page