mongocursor.timeout(3) [php man page]

MONGOCURSOR.TIMEOUT(3)							 1						    MONGOCURSOR.TIMEOUT(3)

MongoCursor::timeout - Sets a client-side timeout for this query

SYNOPSIS

       public MongoCursor MongoCursor::timeout (int  $ms)

DESCRIPTION

	A timeout can be set at any time and will affect subsequent queries on the cursor, including fetching more results from the database.

PARAMETERS

	      o $ms
		-  The	number	of  milliseconds  for  the cursor to wait for a response. Use -1 to wait forever. By default, the cursor will wait
		$30000 milliseconds (30 seconds).

RETURN VALUES

	This cursor.

ERRORS
/EXCEPTIONS
	Causes methods that fetch results to throw a MongoCursorTimeoutException if the query takes longer than the specified number of  millisec-
       onds.

EXAMPLES

       Example #1

	      MongoCursor.timeout(3) example

	       In  the	following  example,  the  driver  will	wait forever for the initial database response, and then wait 100ms for subsequent
	      responses.

	      <?php

	      $cursor = $collection->find();
	      $cursor->timeout(-1);

	      /* $cursor->hasNext() executes the query. An infinite timeout has been set, so
	       * the driver will wait as long as necessary for a response.
	       */
	      while ($cursor->hasNext()) {
		  $cursor->timeout(100);

		  /* A timeout has now been set, so if the cursor needs to get more results
		   * from the database, it will only wait 100ms for a response.
		   */
		  try {
		      print_r($cursor->getNext());
		  } catch (MongoCursorTimeoutException $e) {
		      echo "query took too long!";
		  }
	      }

	      ?>

NOTES

       Warning

	       This does not cause the MongoDB server to cancel long-running operations; it only instructs  the  driver  to  stop  waiting  for  a
	      response	and  throw  a MongoCursorTimeoutException after a set time. If you need to specify a server-side timeout for a query, con-
	      sider using MongoCursor::maxTimeMS.

SEE ALSO

       MongoCursorInterface::timeout, The socketTimeoutMS option for MongoClient.__construct(3).

PHP Documentation Group 												    MONGOCURSOR.TIMEOUT(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)