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)