mongocommandcursor.rewind(3) [php 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)

MONGOCOMMANDCURSOR(3)							 1						     MONGOCOMMANDCURSOR(3)

The MongoCommandCursor class

INTRODUCTION

	A  command  cursor is similar to a MongoCursor except that you use it for iterating through the results of a database command instead of a
       normal query. Command cursors are useful for iterating over large result sets that might exceed the document size limit (currently 16MB) of
       a single MongoDB.command(3) response.

	While  you  can  create  command  cursors  using MongoCommandCursor.__construct(3) or the MongoCommandCursor.createFromDocument(3) factory
       method, you will generally want to use command-specific helpers such as MongoCollection.aggregateCursor(3).

	Note that the cursor does not "contain" the database command's results; it just manages iteration through them. Thus, if you print a  cur-
       sor (f.e. with var_dump(3) or print_r(3)), you will see the cursor object but not the result documents.

CURSOR STAGES

	A MongoCommandCursor has two "life stages": pre- and post- command. When a cursor is created, it has not yet contacted the database, so it
       is in its pre-command state. When the client first attempts to get a result (by calling	MongoCommandCursor.rewind(3),  directly  or  indi-
       rectly), the cursor moves into the post-command state.

	The command cursor's batch size and socket timeout may be configured in both the pre- and post- command states.

       Example #1

	      Adding options to MongoCommandCursor

	      <?php

	      $cursor = new MongoCommandCursor(...);

	      $cursor = $cursor->batchSize( 4 );

	      foreach ($cursor as $result) {
		  var_dump($result);
	      }
	      ?>

CLASS SYNOPSIS

       MongoCommandCursor

       MongoCommandCursorMongoCursorInterfaceIterator

       Methods

       o public MongoCommandCursor MongoCommandCursor::batchSize (int  $batchSize)

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

       o publicstatic MongoCommandCursor MongoCommandCursor::createFromDocument (MongoClient  $connection, string  $hash, array  $document)

       o public array MongoCommandCursor::current (void  )

       o public bool MongoCommandCursor::dead (void  )

       o public array MongoCommandCursor::getReadPreference (void  )

       o public array MongoCommandCursor::info (void  )

       o public int MongoCommandCursor::key (void  )

       o public void MongoCommandCursor::next (void  )

       o public array MongoCommandCursor::rewind (void	)

       o public MongoCommandCursor MongoCommandCursor::setReadPreference (string  $read_preference, [array  $tags])

       o public MongoCommandCursor MongoCommandCursor::timeout (int  $ms)

       o public bool MongoCommandCursor::valid (void  )

SEE ALSO

	      o MongoDB::command

	      o MongoCollection::aggregateCursor

PHP Documentation Group 												     MONGOCOMMANDCURSOR(3)