MongoCursor::slaveOkay

(PECL mongo >=0.9.4)

MongoCursor::slaveOkay — Définit si la requête peut être effectuée sur un serveur esclave

Description

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

L'appel à cette méthode fera que la driver liera sur les esclaves si :

Vous utilisez un jeu de réplication et
Vous avez créé une instance Mongo en utilisant l'option "replicaSet" => true et
Il y a un esclave en bonne santé qui peut être atteint par le driver.

Vous pouvez savoir quel serveur a été utilisé pour cette requête en appelant la méthode MongoCursor::info() après l'exécution de la requête. L'information sera contenue dans le champ server.

Notez que vous devriez utiliser cette fonction même si vous n'utilisez pas la lecture automatique sur les esclaves. Si vous vous connectez directement sur un secondaire d'un jeu de réplications, vous devrez continuer d'utiliser cette méthode, qui informe la base de données que vous êtes prêt à recevoir d'anciennes données. Si vous ne l'appelez pas, vous recevrez une erreur de type "not master" lors de l'exécution de la requête.

Cette méthode écrasera la variable statique MongoCursor::slaveOkay. Elle écrasera aussi Mongo::setSlaveOkay(), MongoDB::setSlaveOkay() et MongoCollection::setSlaveOkay().

Liste de paramètres

okay: Si l'on peut effectuer la requête sur un serveur esclave.

Valeurs de retour

Returns this cursor.

Erreurs / Exceptions

Lance une exception MongoCursorException si le curseur a commencé à être parcouru.

Exemples

Exemple #1 Exemple avec MongoCursor::slaveOkay()


<?php

MongoCursor::$slaveOkay = false;

// On ne peut pas faire la requête sur un serveur escalve
$cursor = $collection->find();

// On peut faire la requête sur un serveur esclave
$cursor = $collection->find()->slaveOkay();

MongoCursor::$slaveOkay = true;

// On peut faire la requête sur un serveur esclave
$cursor = $collection->find();

// On ne peut pas faire la requête sur un serveur escalve
$cursor = $collection->find()->slaveOkay(false);

?>