mongocollection.parallelcollectionscan(3) php man page | unix.com

MONGOCOLLECTION.PARALLELCOLLECTIONSCAN(3)				 1				 MONGOCOLLECTION.PARALLELCOLLECTIONSCAN(3)

MongoCollection::parallelCollectionScan - Returns an array of cursors to iterator over a full collection in parallel

SYNOPSIS
       public array[MongoCommandCursor] MongoCollection::parallelCollectionScan (int  $num_cursors)

DESCRIPTION
	This  method  returns an array of a maximum of num_cursors cursors. An iteration over one of the returned cursors results in a partial set
       of documents for a collection. Iteration over all the returned cursors results in getting every document back from the collection.

	This method is a wrapper for the parallelCollectionScan MongoDB command.

PARAMETERS
	      o $num_cursors
		- The number of cursors to request from the server. Please note, that the server can return less cursors than you requested.

RETURN VALUES
	Returns an array of MongoCommandCursor objects.

EXAMPLES
       Example #1

	      MongoCollection.parallelCollectionScan(3) example

	       Returning all documents in a collection by using multiple cursors.

	      <?php
	      $m = new MongoClient;
	      $c = $m->demo->cities;

	      /* Request three cursors */
	      $cursors = $c->parallelCollectionScan( 3 );

	      /* Add all the cursors to the MultipleIterator */
	      $mi = new MultipleIterator( MultipleIterator::MIT_NEED_ANY );
	      foreach ( $cursors as $cursor )
	      {
		  $mi->attachIterator( $cursor );
	      }

	      /* Iterate over all the associated cursors */
	      foreach ( $mi as $items )
	      {
		  foreach ( $items as $item )
		  {
		      if ( $item !== NULL )
		      {
			  echo $item['name'], "
";
		      }
		  }
	      }
	      ?>

SEE ALSO
       MultipleIterator, MongoCommandCursor, MongoDB::command.

PHP Documentation Group 										 MONGOCOLLECTION.PARALLELCOLLECTIONSCAN(3)