mongocommandcursor.__construct(3) [php man page]

MONGOCOMMANDCURSOR.__CONSTRUCT(3)					 1					 MONGOCOMMANDCURSOR.__CONSTRUCT(3)

MongoCommandCursor::__construct - Create a new command cursor

SYNOPSIS

       public MongoCommandCursor::__construct (MongoClient  $connection, string  $ns, array  $command = array())

DESCRIPTION

	Generally,  you  should not have to construct a MongoCommandCursor manually, as there are helper functions such as MongoCollection::aggre-
       gateCursor and MongoCollection::parallelCollectionScan; however, if the server introduces new commands that can return cursors,	this  con-
       structor will be useful in the absence of specific helper methods. You may also consider using MongoCommandCursor::createFromDocument.

PARAMETERS

	      o $connection
		- Database connection.

	      o $ns
		- Full name of the database and collection (e.g.  "test.foo")

	      o $command
		- Database command.

RETURN VALUES

	Returns the new cursor.

EXAMPLES

       Example #1

	      MongoCommandCursor example

	      <?php
	      $m = new MongoClient;

	      // Define the aggregation pipeline
	      $pipeline = [
		  [ '$group' => [
		      '_id' => '$country_code',
		      'timezones' => [ '$addToSet' => '$timezone' ]
		  ] ],
		  [ '$sort' => [ '_id' => 1 ] ],
	      ];

	      // Construct a MongoCommandCursor object
	      $cursor = new MongoCommandCursor(
		  $m, // MongoClient object
		  'demo.cities', // namespace
		  [
		      'aggregate' => 'cities',
		      'pipeline' => $pipeline,
		      'cursor' => [ 'batchSize' => 0 ],
		  ]
	      );

	      foreach($cursor as $result) {

	      }
	      ?>

SEE ALSO 
MongoCommandCursor.createFromDocument(3), MongoCollection.aggregateCursor(3), MongoCollection.parallelCollectionScan(3).
PHP Documentation Group 											 MONGOCOMMANDCURSOR.__CONSTRUCT(3)

Check Out this Related Man Page

MONGOCOMMANDCURSOR.REWIND(3)						 1					      MONGOCOMMANDCURSOR.REWIND(3)

MongoCommandCursor::rewind - Executes the command and resets the cursor to the start of the result set

SYNOPSIS

       public array MongoCommandCursor::rewind (void  )

DESCRIPTION

	If the cursor has already started iteration, the command will be re-executed.

PARAMETERS

       This function has no parameters.

RETURN VALUES

	The raw server result document.

ERRORS
/EXCEPTIONS
	Throws MongoConnectionException if it cannot reach the database and MongoCursorTimeoutException if the timeout is exceeded.

	Throws	MongoCursorException  if  the  cursor was created with MongoCommandCursor.createFromDocument(3) and has already started iteration.
       Such cursors cannot be iterated multiple times, as they lack the original command necessary for re-execution.

EXAMPLES

       Example #1

	      MongoCommandCursor.rewind(3)

	      <?php
	      $rawResult = $commandCursor->rewind();

	      // Command cursor is now reset to the start of the result set

	      var_dump($rawResult);
	      ?>

	      The above example will output something similar to:

	      array(2) {
		["cursor"]=>
		array(3) {
		  ["id"]=>
		  object(MongoInt64)#5(1) {
		    ["value"]=>
		    string(12) "310050110216"
		  }
		  ["ns"]=>
		  string(9) "demo.test"
		  ["firstBatch"]=>
		  array(1) {
		    [0]=>
		    array(2) {
		      ["_id"]=>
		      object(MongoId)#6(1) {
			["$id"]=>
			string(24) "52f5691544670a8077b0dc51"
		      }
		      ["value"]=>
		      string(2) "42"
		    }
		  }
		}
		["ok"]=>
		float(1)
	      }

SEE ALSO

       Iterator::rewind.

PHP Documentation Group 											      MONGOCOMMANDCURSOR.REWIND(3)

Linux and UNIX Man Pages

mongocommandcursor.__construct(3) [php man page]

Check Out this Related Man Page