mongocollection.parallelcollectionscan(3) [php man page]

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)

MULTIPLEITERATOR(3)							 1						       MULTIPLEITERATOR(3)

The MultipleIterator class

INTRODUCTION

	An Iterator that sequentially iterates over all attached iterators

CLASS SYNOPSIS

       MultipleIterator

       MultipleIteratorIterator

       Constants

       o const integer$MultipleIterator::MIT_NEED_ANY0

       o const integer$MultipleIterator::MIT_NEED_ALL1

       o const integer$MultipleIterator::MIT_KEYS_NUMERIC0

       o const integer$MultipleIterator::MIT_KEYS_ASSOC2

       Methods

       o public MultipleIterator::__construct ([int  $flags = MultipleIterator::MIT_NEED_ALL|MultipleIterator::MIT_KEYS_NUMERIC])

       o public void MultipleIterator::attachIterator (Iterator  $iterator, [string  $infos])

       o public void MultipleIterator::containsIterator (Iterator  $iterator)

       o public void MultipleIterator::countIterators (void  )

       o public array MultipleIterator::current (void  )

       o public void MultipleIterator::detachIterator (Iterator  $iterator)

       o public void MultipleIterator::getFlags (void  )

       o public array MultipleIterator::key (void  )

       o public void MultipleIterator::next (void  )

       o public void MultipleIterator::rewind (void  )

       o public void MultipleIterator::setFlags (int  $flags)

       o public void MultipleIterator::valid (void  )

PREDEFINED CONSTANTS

	      o MultipleIterator::MIT_NEED_ANY - Do not require all sub iterators to be valid in iteration.

	      o MultipleIterator::MIT_NEED_ALL - Require all sub iterators to be valid in iteration.

	      o MultipleIterator::MIT_KEYS_NUMERIC - Keys are created from the sub iterators position.

	      o MultipleIterator::MIT_KEYS_ASSOC - Keys are created from sub iterators associated information.

PHP Documentation Group 												       MULTIPLEITERATOR(3)