mongocursor.getreadpreference(3) [php man page]

MONGOCURSOR.GETREADPREFERENCE(3)					 1					  MONGOCURSOR.GETREADPREFERENCE(3)

MongoCursor::getReadPreference - Get the read preference for this query

SYNOPSIS

       public array MongoCursor::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.

EXAMPLES

       Example #1

	      MongoCursor::getReadPreference return value example

	      <?php

	      $m = new MongoClient();
	      $cursor = $m->test->users->find();
	      $cursor->setReadPreference(MongoClient::RP_SECONDARY, array(
		  array('dc' => 'east', 'use' => 'reporting'),
		  array('dc' => 'west'),
		  array(),
	      ));
	      var_dump($cursor->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., MongoCursor.setReadPreference(3), MongoCursorInterface.getReadPreference(3).
PHP Documentation Group 											  MONGOCURSOR.GETREADPREFERENCE(3)

MONGOCURSOR.INFO(3)							 1						       MONGOCURSOR.INFO(3)

MongoCursor::info - Gets information about the cursor's creation and iteration

SYNOPSIS

       public array MongoCursor::info (void  )

DESCRIPTION

	This can be called before or after the cursor has started iterating.

PARAMETERS

       This function has no parameters.

RETURN VALUES

	Returns  the  namespace, batch size, limit, skip, flags, query, and projected fields for this cursor. If the cursor has started iterating,
       additional information about iteration and the connection will be included.

CHANGELOG

       +--------+---------------------------------------------------+
       |Version |						    |
       |	|						    |
       |	|		     Description		    |
       |	|						    |
       +--------+---------------------------------------------------+
       | 1.1.0	|						    |
       |	|						    |
       |	|  Added a number of  other  fields,  including  id |
       |	| (the	cursor	id),  at  (the	driver's counter of |
       |	| which document is current), numReturned (the num- |
       |	| ber returned by the server in the current batch), |
       |	| and server (which server the query was sent  to-- |
       |	| useful in conjunction with "Read Preferences".    |
       |	|						    |
       |1.0.10	|						    |
       |	|						    |
       |	|  Added  started_iterating  field, a boolean indi- |
       |	| cating if cursor is pre- or post-query.	    |
       |	|						    |
       +--------+---------------------------------------------------+
EXAMPLES

       Example #1

	      MongoCursor.info(3) example

	      <?php
	      $m = new MongoClient();

	      $cursor = $m->test->foo->find(array("x" => 4), array("y" => 0));

	      echo "Before iteration started:
";
	      var_dump($cursor->info());

	      echo "
After iteration started:
";
	      $cursor->rewind();
	      var_dump($cursor->info());

	      ?>

	      The above example will output something similar to:

	      Before iteration started:
	      array(8) {
		["ns"]=>
		string(8) "test.foo"
		["limit"]=>
		int(0)
		["batchSize"]=>
		int(0)
		["skip"]=>
		int(0)
		["flags"]=>
		int(0)
		["query"]=>
		array(1) {
		  ["x"]=>
		  int(4)
		}
		["fields"]=>
		array(1) {
		  ["y"]=>
		  int(0)
		}
		["started_iterating"]=>
		bool(false)
	      }

	      After iteration started:
	      array(15) {
		["ns"]=>
		string(8) "test.foo"
		["limit"]=>
		int(0)
		["batchSize"]=>
		int(0)
		["skip"]=>
		int(0)
		["flags"]=>
		int(0)
		["query"]=>
		array(1) {
		  ["x"]=>
		  int(4)
		}
		["fields"]=>
		array(1) {
		  ["y"]=>
		  int(0)
		}
		["started_iterating"]=>
		bool(true)
		["id"]=>
		int(0)
		["at"]=>
		int(0)
		["numReturned"]=>
		int(1)
		["server"]=>
		string(25) "localhost:27017;-;.;26450"
		["host"]=>
		string(9) "localhost"
		["port"]=>
		int(27017)
		["connection_type_desc"]=>
		string(10) "STANDALONE"
	      }

SEE ALSO

       MongoCursorInterface::info.

PHP Documentation Group 												       MONGOCURSOR.INFO(3)