PHP 8.1.0 RC 2 available for testing

MongoDB\Driver\ReadPreference::__construct

(mongodb >=1.0.0)

MongoDB\Driver\ReadPreference::__constructCréer un nouveau ReadPreference

Description

final public MongoDB\Driver\ReadPreference::__construct(string|int $mode, array $tagSets = null, array $options = array())

Construit un nouveau MongoDB\Driver\ReadPreference, qui est un objet de valeur immuable.

Liste de paramètres

mode

Mode de préférence de lecture
Valeur Description
MongoDB\Driver\ReadPreference::RP_PRIMARY ou "primary"

Toutes les opérations lues à partir du jeu de réplicas actuel primaire. Il s'agit de la préférence de lecture par défaut pour MongoDB.

MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED ou "primaryPreferred"

Dans la plupart des situations, les opérations sont lues à partir du primaire, mais si il n'est pas disponible, les opérations sont lues à partir d'un membre secondaire.

MongoDB\Driver\ReadPreference::RP_SECONDARY ou "secondary"

Toutes les opérations sont lues à partir des membres secondaires du jeu de réplicas.

MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED ou "secondaryPreferred"

Dans la plupart des cas, les opérations sont lues par des membres secondaires, mais si aucun membre secondaire n'est disponible, les opérations sont lues à partir du primaire.

MongoDB\Driver\ReadPreference::RP_NEAREST ou "nearest"

Opérations lues à partir du membre du jeu de réplicas ayant la latence réseau la moins élevée, quel que soit le type du membre.

tagSets

Les jeux de tag vous permettent de cibler des opérations de lecture sur des membres spécifiques d'un jeu de réplicas. Ce paramètre doit être un tableau de tableaux associatifs, qui contiennent chacun zéro ou plusieurs paires clé/valeur. Lors de la sélection d'un serveur pour une opération de lecture, le pilote tente de sélectionner un nœud comportant toutes les balises d'un ensemble (c'est-à-dire le tableau associatif de paires clé/valeur). Si la sélection échoue, le pilote essaiera les jeux suivants. Un jeu de balises vide (array()) correspond à n'importe quel nœud et peut être utilisé comme secours.

Les tags ne sont pas compatibles avec le mode MongoDB\Driver\ReadPreference::RP_PRIMARY et, en général, s'appliquent uniquement lors de la sélection d'un membre secondaire d'un jeu pour une opération de lecture. Toutefois, le mode MongoDB\Driver\ReadPreference::RP_NEAREST, lorsqu'il est combiné avec un jeu de balises, sélectionne le membre correspondant avec la latence réseau la plus basse. Ce membre peut être primaire ou secondaire.

options

options
Option Type Description
hedge object|array

Spécifie si l'on doit utiliser ou non » les lectures croisées, qui sont supportés depuis MongoDB 4.4+ pour les requêtes partagées.

Le serveur des lectures croisées est disponible pour toutes les lectures des références non primaires, et est activé par défaut lors de l'utilisation du mode "nearest". Cette option permet d'activer explicitement le serveur des lectures croisées pour les lectures des références non primaires en spécifiant ['enabled' => true], ou de désactiver explicitement le serveur des lectures croisées pour les lectures des références "nearest" en spécifiant ['enabled' => false].

maxStalenessSeconds entier

Spécifie un décalage de réplication maximal, ou "obsolescence", pour les lectures des secondaires. Lorsque l'obsolescence estimée d'un secondaire dépasse cette valeur, le pilote cesse de l'utiliser pour les opérations de lecture.

Si elle est spécifiée, l'obsolescence maximale doit être un entier signé 32 bits supérieur ou égal à MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS.

Par défaut, MongoDB\Driver\ReadPreference::NO_MAX_STALENESS, ce qui signifie que le pilote ne prendra pas en compte le décalage d'un secondaire lors du choix de l'endroit où diriger une opération de lecture.

Cette option n'est pas compatible avec le mode MongoDB\Driver\ReadPreference::RP_PRIMARY. La spécification d'une obsolescence maximale requiert également que toutes les instances MongoDB du déploiement utilisent MongoDB 3.4+. Une exception sera levée au moment de l'exécution si toutes les instances de MongoDB dans le déploiement sont d'une version de serveur plus ancienne.

Erreurs / Exceptions

Historique

Version Description
PECL mongodb 1.8.0 Ajout de l'option "hedge".
PECL mongodb 1.3.0

L'argument mode accepte maintenant une valeur de chaîne, ce qui est compatible avec l'option URI "readPreference" pour MongoDB\Driver\Manager::__construct()

PECL mongodb 1.2.0

Ajout d'un troisième argument d'options, qui prend en charge l'option "maxStalenessSeconds" .

Exemples

Exemple #1 Exemple avec MongoDB\Driver\ReadPreference::__construct()

<?php

/* Préférez un nœud secondaire mais retombez sur un primaire. */
var_dump(new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED));

/* Préférez un nœud dans le centre de données de New York avec la latence la plus basse. */
var_dump(new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_NEAREST, [['dc' => 'ny']]));

/* Nécessite un nœud secondaire dont le décalage de réplication se trouve dans les deux minutes */
var_dump(new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARYnull, ['maxStalenessSeconds' => 120]));

/* Active explicitement le servuer des lectures croisées */
var_dump(new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARYnull, ['hedge' => ['enabled' => true]]));
?>

Résultat de l'exemple ci-dessus est similaire à :

object(MongoDB\Driver\ReadPreference)#1 (1) {
  ["mode"]=>
  string(18) "secondaryPreferred"
}
object(MongoDB\Driver\ReadPreference)#1 (2) {
  ["mode"]=>
  string(7) "nearest"
  ["tags"]=>
  array(1) {
    [0]=>
    object(stdClass)#2 (1) {
      ["dc"]=>
      string(2) "ny"
    }
  }
}
object(MongoDB\Driver\ReadPreference)#1 (2) {
  ["mode"]=>
  string(9) "secondary"
  ["maxStalenessSeconds"]=>
  int(120)
}
object(MongoDB\Driver\ReadPreference)#1 (2) {
  ["mode"]=>
  string(9) "secondary"
  ["hedge"]=>
  object(stdClass)#1 (1) {
    ["enabled"]=>
    bool(true)
  }
}
add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top