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)

MONGOCOMMANDCURSOR.CREATEFROMDOCUMENT(3)				 1				  MONGOCOMMANDCURSOR.CREATEFROMDOCUMENT(3)

MongoCommandCursor::createFromDocument - Create a new command cursor from an existing command response document

SYNOPSIS

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

DESCRIPTION

	Use this method if you have a raw command result with cursor information in it. Note that cursors created with this method cannot be iter-
       ated multiple times, as they will lack the original command necessary for re-execution.

PARAMETERS

	      o $connection
		- Database connection.

	      o $hash
		- The connection hash, as obtained through the third by-reference argument to MongoDB::command.

	      o $document
		- Document with cursor information in it. This document needs to contain the id, ns and firstBatch  fields.  Such  a  document	is
		obtained  by  calling  the  MongoDB::command with appropriate arguments to return a cursor, and not just an inline result. See the
		example below.

RETURN VALUES

	Returns the new cursor.

EXAMPLES

       Example #1

	      MongoCommandCursor.createFromDocument(3)

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

	      // Define the aggregation pipeline
	      $pipeline = [
		  [ '$group' => [
		      '_id' => '$country_code',
		      'timezones' => [ '$addToSet' => '$timezone' ]
		  ] ],
		  [ '$sort' => [ '_id' => 1 ] ],
	      ];

	      // Execute the command. The "cursor" option instructs the server to return
	      // cursor information in the response instead of inline results.
	      $r = $d->command(
		  [
		      'aggregate' => 'cities',
		      'pipeline' => $pipeline,
		      'cursor' => [ 'batchSize' => 1 ],
		  ],
		  null,
		  $hash
	      );

	      // Show result and hash
	      var_dump( $r, $hash );

	      // Construct the command cursor
	      $cursor = MongoCommandCursor::createFromDocument( $m, $hash, $r );
	      ?>

	      The above example will output something similar to:

	      array(2) {
		["cursor"]=>
		array(3) {
		  ["id"]=>
		  object(MongoInt64)#5(1) {
		    ["value"]=>
		    string(12) "392143983421"
		  }
		  ["ns"]=>
		  string(11) "demo.cities"
		  ["firstBatch"]=>
		  array(1) {
		    [0]=>
		    array(2) {
		      ["_id"]=>
		      string(2) "AD"
		      ["timezones"]=>
		      array(1) {
			[0]=>
			string(14) "Europe/Andorra"
		      }
		    }
		  }
		}
		["ok"]=>
		float(1)
	      }
	      string(25) "localhost:27017;-;.;17617"

	       As you can see, the returned cursor information has the id, ns and firstBatch fields.

SEE ALSO 
MongoCommandCursor.__construct(3).
PHP Documentation Group 										  MONGOCOMMANDCURSOR.CREATEFROMDOCUMENT(3)