Rechercher une fonction PHP

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 MongoClient::killCursor ( string $server_hash , int|MongoInt64 $id ) : bool

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().

Retour à la première page de Manuel PHP  Table des matières Haut

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).

Retour à la première page de Manuel PHP  Table des matières Haut

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.

Retour à la première page de Manuel PHP  Table des matières Haut

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.

Retour à la première page de Manuel PHP  Table des matières Haut

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'] );
?>
Rechercher une fonction PHP

Document créé le 30/01/2003, dernière modification le 26/10/2018
Source du document imprimé : https://www.gaudry.be/php-rf-mongoclient.killcursor.html

L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.

Références

  1. Consulter le document html Langue du document :fr Manuel PHP : http://php.net

Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.

Table des matières Haut