MongoClient
PHP Manual

MongoClient::killCursor

(PECL mongo >=1.5.0)

MongoClient::killCursorSupprime un curseur spécifique du serveur

Cette extension, qui définie cette méthode est obsolète. Veuillez utiliser l'extension MongoDB à la place. Il n'y a pas d'équivalent à cette méthode dans la nouvelle extension.

Description

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

Dans certaines situations, il peut être nécessaire de supprimer un curseur du serveur. Habituellement, les curseurs ont une durée de vie de 10 minutes d'inactivité, mais il est possible de créer des curseurs immortels avec la méthode MongoCursor::immortal(). Afin de pouvoir supprimer un curseur immortel, vous pouvez appeler cette méthode avec l'information fournie par la méthode MongoCursor::info().

Liste de paramètres

server_hash

Le hash serveur du curseur. Peut être obtenu via la méthode MongoCursor::info().

id

L'ID du curseur à supprimer. Vous pouvez soit fournir un entier contenant l'ID du curseur sur 64 bit, ou un objet de la classe MongoInt64. Ce dernier est nécessaire sur les plateformes 32 bit (et sous Windows).

Valeurs de retour

Retourne TRUE si la méthode tente de supprimer un curseur, et FALSE s'il n'y a rien d'incorrect avec l'argument (comme un server_hash incorrect). Le statut retourné ne reflète pas la réussite de l'opération sachant que le serveur n'indique pas si le curseur a bien été supprimé ou non.

Erreurs / Exceptions

Cette méthode affiche une alerte si le server_hash fourni ne correspond pas à une connexion existante. Aucune tentative de suppression de curseur n'est effectuée dans ce cas.

Exemples

Exemple #1 Exemple avec MongoClient::killCursor()

Cet exemple montre comment se connecter, effectuer une requête, obtenir l'information quant au curseur, et supprimer ce curseur.

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

// Maintenant, le curseur est valide, nous pouvons donc récupérer le hash et l'ID :
$info $cursor->info();

// Supprime le curseur
MongoClient::killCursor$info['server'], $info['id'] );
?>

MongoClient
PHP Manual