mongoclient.killcursor(3) [php man page]

MONGOCLIENT.KILLCURSOR(3)						 1						 MONGOCLIENT.KILLCURSOR(3)

MongoClient::killCursor - Kills a specific cursor on the server

SYNOPSIS

       public bool MongoClient::killCursor (string  $server_hash, int|MongoInt64  $id)

DESCRIPTION

	In  certain  situations it might be needed to kill a cursor on the server. Usually cursors time out after 10 minutes of inactivity, but it
       is possible to create an immortal cursor with MongoCursor::immortal that never times out. In order to be able to kill such an immortal cur-
       sor, you can call this method with the information supplied by MongoCursor::info.

PARAMETERS

	      o $server_hash
		- The server hash that has the cursor. This can be obtained through MongoCursor::info.

	      o $id
		-  The	ID  of	the  cursor  to kill. You can either supply an int containing the 64 bit cursor ID, or an object of the MongoInt64
		class. The latter is necessary on 32 bit platforms (and Windows).

RETURN VALUES

	Returns TRUE if the method attempted to kill a cursor, and FALSE if there was  something  wrong  with  the  arguments  (such  as  a  wrong
       $server_hash). The return status does not reflect where the cursor was actually killed as the server does not provide that information.

ERRORS
/EXCEPTIONS
	This  method displays a warning if the supplied $server_hash does not match up with an existing connection. No attempt to kill a cursor is
       attempted in that case either.

EXAMPLES

       Example #1

	      MongoClient.killCursor(3) example

	       This example shows how to connect, do a query, obtain the cursor information and then kill the cursor.

	      <?php
	      $m = new MongoClient();
	      $c = $m->testdb->collection;
	      $cursor = $c->find();
	      $result = $cursor->next();

	      // Now the cursor is valid, so we can get the hash and ID out:
	      $info = $cursor->info();

	      // Kill the cursor
	      MongoClient::killCursor( $info['server'], $info['id'] );
	      ?>

PHP Documentation Group 												 MONGOCLIENT.KILLCURSOR(3)

MONGOCURSOR.INFO(3)							 1						       MONGOCURSOR.INFO(3)

MongoCursor::info - Gets information about the cursor's creation and iteration

SYNOPSIS

       public array MongoCursor::info (void  )

DESCRIPTION

	This can be called before or after the cursor has started iterating.

PARAMETERS

       This function has no parameters.

RETURN VALUES

	Returns  the  namespace, batch size, limit, skip, flags, query, and projected fields for this cursor. If the cursor has started iterating,
       additional information about iteration and the connection will be included.

CHANGELOG

       +--------+---------------------------------------------------+
       |Version |						    |
       |	|						    |
       |	|		     Description		    |
       |	|						    |
       +--------+---------------------------------------------------+
       | 1.1.0	|						    |
       |	|						    |
       |	|  Added a number of  other  fields,  including  id |
       |	| (the	cursor	id),  at  (the	driver's counter of |
       |	| which document is current), numReturned (the num- |
       |	| ber returned by the server in the current batch), |
       |	| and server (which server the query was sent  to-- |
       |	| useful in conjunction with "Read Preferences".    |
       |	|						    |
       |1.0.10	|						    |
       |	|						    |
       |	|  Added  started_iterating  field, a boolean indi- |
       |	| cating if cursor is pre- or post-query.	    |
       |	|						    |
       +--------+---------------------------------------------------+
EXAMPLES

       Example #1

	      MongoCursor.info(3) example

	      <?php
	      $m = new MongoClient();

	      $cursor = $m->test->foo->find(array("x" => 4), array("y" => 0));

	      echo "Before iteration started:
";
	      var_dump($cursor->info());

	      echo "
After iteration started:
";
	      $cursor->rewind();
	      var_dump($cursor->info());

	      ?>

	      The above example will output something similar to:

	      Before iteration started:
	      array(8) {
		["ns"]=>
		string(8) "test.foo"
		["limit"]=>
		int(0)
		["batchSize"]=>
		int(0)
		["skip"]=>
		int(0)
		["flags"]=>
		int(0)
		["query"]=>
		array(1) {
		  ["x"]=>
		  int(4)
		}
		["fields"]=>
		array(1) {
		  ["y"]=>
		  int(0)
		}
		["started_iterating"]=>
		bool(false)
	      }

	      After iteration started:
	      array(15) {
		["ns"]=>
		string(8) "test.foo"
		["limit"]=>
		int(0)
		["batchSize"]=>
		int(0)
		["skip"]=>
		int(0)
		["flags"]=>
		int(0)
		["query"]=>
		array(1) {
		  ["x"]=>
		  int(4)
		}
		["fields"]=>
		array(1) {
		  ["y"]=>
		  int(0)
		}
		["started_iterating"]=>
		bool(true)
		["id"]=>
		int(0)
		["at"]=>
		int(0)
		["numReturned"]=>
		int(1)
		["server"]=>
		string(25) "localhost:27017;-;.;26450"
		["host"]=>
		string(9) "localhost"
		["port"]=>
		int(27017)
		["connection_type_desc"]=>
		string(10) "STANDALONE"
	      }

SEE ALSO

       MongoCursorInterface::info.

PHP Documentation Group 												       MONGOCURSOR.INFO(3)