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.SLAVEOKAY(3)						 1						  MONGOCURSOR.SLAVEOKAY(3)

MongoCursor::slaveOkay - Sets whether this query can be done on a secondary [deprecated]

SYNOPSIS

       public MongoCursor MongoCursor::slaveOkay ([bool  $okay = true])

DESCRIPTION

       Warning

	       This method is deprecated since version 1.5.0. Instead, please use MongoCursor::setReadPreference and "Read Preferences".

	Calling this will make the driver route reads to secondaries if:

	      o You are using a replica set, and

	      o You created a MongoClient instance using the option
		"replicaSet" => "setName", and

	      o There is a healthy secondary that can be reached by the driver.

	You  can  check  which	server was used for this query by calling MongoCursor.info(3) after running the query. It's server field will show
       which server the query was sent to.

	Note that you should use this function even if you do not use the automatic routing to secondaries. If you connect directly to a secondary
       in  a  replica  set,  you still need to call this function, which basically tells the database that you are aware that you might be getting
       older data and you're okay with that. If you do not call this, you'll get "not master" errors when you try to query.

	This method will override the static class variable $MongoCursor::$slaveOkay. It will also  override  Mongo.setSlaveOkay(3),  MongoDB.set-
       SlaveOkay(3) and MongoCollection.setSlaveOkay(3).

PARAMETERS

	      o $okay
		- If it is okay to query the secondary.

RETURN VALUES

	Returns this cursor.

ERRORS
/EXCEPTIONS
	Throws MongoCursorException if this cursor has started iterating.

EXAMPLES

       Example #1

	      MongoCursor.slaveOkay(3) example

	      <?php

	      MongoCursor::$slaveOkay = false;

	      // cannot query secondary
	      $cursor = $collection->find();

	      // can query secondary
	      $cursor = $collection->find()->slaveOkay();

	      MongoCursor::$slaveOkay = true;

	      // can query secondary
	      $cursor = $collection->find();

	      // cannot query secondary
	      $cursor = $collection->find()->slaveOkay(false);

	      ?>

SEE ALSO";Read Preferences ,
       MongoCursor::setReadPreference, MongoCursor::getReadPreference.

CHANGELOG

       +--------+---------------------------------------------------+
       |Version |						    |
       |	|						    |
       |	|		     Description		    |
       |	|						    |
       +--------+---------------------------------------------------+
       | 1.5.0	|						    |
       |	|						    |
       |	|  This  method  has  been  deprecated in favour of |
       |	| MongoCursor::setReadPreference and "Read  Prefer- |
       |	| ences".					    |
       |	|						    |
       +--------+---------------------------------------------------+
PHP Documentation Group 												  MONGOCURSOR.SLAVEOKAY(3)