Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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)

Check Out this Related Man Page

MONGOCURSOR.GETREADPREFERENCE(3)					 1					  MONGOCURSOR.GETREADPREFERENCE(3)

MongoCursor::getReadPreference - Get the read preference for this query

SYNOPSIS
public array MongoCursor::getReadPreference (void ) DESCRIPTION
PARAMETERS
This function has no parameters. RETURN VALUES
This function returns an array describing the read preference. The array contains the values type for the string read preference mode (cor- responding to the MongoClient constants), and tagsets containing a list of all tag set criteria. If no tag sets were specified, tagsets will not be present in the array. EXAMPLES
Example #1 MongoCursor::getReadPreference return value example <?php $m = new MongoClient(); $cursor = $m->test->users->find(); $cursor->setReadPreference(MongoClient::RP_SECONDARY, array( array('dc' => 'east', 'use' => 'reporting'), array('dc' => 'west'), array(), )); var_dump($cursor->getReadPreference()); ?> The above example will output: array(2) { ["type"]=> string(9) "secondary" ["tagsets"]=> array(3) { [0]=> array(2) { ["dc"]=> string(4) "east" ["use"]=> string(9) "reporting" } [1]=> array(1) { ["dc"]=> string(7) "west" } [2]=> array(0) { } } } SEE ALSO The read preferences documentation., MongoCursor.setReadPreference(3), MongoCursorInterface.getReadPreference(3). PHP Documentation Group MONGOCURSOR.GETREADPREFERENCE(3)
Man Page