MongoCursor::maxTimeMS

(PECL mongo >=1.5.0)

MongoCursor::maxTimeMSDéfini le délai d'attente maximal côté serveur pour la requête

Description

public MongoCursor::maxTimeMS ( int $ms ) : MongoCursor

Spécifie une limite de temps cumulative, en millisecondes, autorisé au serveur pour effectuer les opérations sur le curseur.

Liste de paramètres

ms

Spécifie une limite de temps cumulative, en millisecondes, autorisé au serveur pour effectuer les opérations sur le curseur.

Valeurs de retour

Ce curseur.

Erreurs / Exceptions

Lance une exception MongoCursorException si le curseur a commencé son itération.

Fait que les méthodes qui récupèrent les résultats lance une exception MongoExecutionTimeoutException si la requête prend plus de temps que le nombre de millisecondes spécifié dans l'exécution des opérations.

Exemples

Exemple #1 Exemple avec MongoCursor::maxTimeMS()

Dans l'exemple suivant, le serveur a interrompre la requête si le curseur requiert plus de deux secondes dans l'exécution des opérations pour retourner les résultats.

<?php

$cursor 
$collection->find();
$cursor->maxTimeMS(2000);

try {
    
$results iterator_to_array($cursor);
} catch (
MongoExecutionTimeoutException $e) {
    echo 
"query took too long!";
}

?>

Notes

Avertissement

Contrairement à la méthode MongoCursor::timeout(), qui spécifie un délai d'attente maximal côté client, la méthode MongoCursor::maxTimeMS() peut être utilisée pour stopper le serveur MongoDB lors de l'exécution de requêtes qui prennent trop de temps. Ce délai d'attente maximal est cumulatif pour la durée de vie du curseur (i.e. chaque lot va contribuer à cette durée). Le délai d'attente maximal ne prend en considération que le temps d'exécution ; le temps d'inactivité n'est pas pris en compte.