Mongo.setReadPref() (método mongosh)

Esta versión de la documentación está archivada y ya no recibe soporte. Para actualizar su implementación 6.0, consulte Procedimientos de actualización de MongoDB.7.0

Definición

Mongo.setReadPref(mode, tagSet, hedgeOptions): Llamar al método en setReadPref() un Mongo objeto de conexión para controlar cómo el cliente enrutará todas las consultas a los miembros del conjunto de réplicas. []1
Nota
Debe llamar a en el objeto de conexión antes de recuperar documentos que utilizan esa conexión para utilizar esa preferencia de Mongo.setReadPref() lectura.

[1]	Para aplicar una preferencia de lectura a una o varias consultas específicas, puede aplicar `cursor.readPref()` a un cursor antes de la iteración. Consulte para obtener `cursor.readPref()` más información.

Parámetros

Parameter	Tipo	Descripción
moda	string	Uno de los siguientes modos de preferencia `primary` de lectura:,,, `primaryPreferred` `secondarysecondaryPreferred`o `nearest`
tagSet	conjunto de documentos	Opcional. Un conjunto de etiquetas que se utiliza para dirigir las lecturas a los miembros con las etiquetas especificadas. `tagSet` no está disponible si se utiliza el modo de preferencia de `primary` lectura. Para obtener más detalles, consulte Listas de conjuntos de etiquetas de preferencias de lectura.
Opciones de cobertura	Documento	Opcional. Un documento que indica si se debe habilitar el uso de lecturas protegidas: `{ enabled: <boolean> }` El campo `enabled` tiene como valor predeterminado verdadero; es decir, especificar un documento vacío `{ }` es equivalente a especificar `{ enabled: true }`. Las lecturas protegidas están disponibles para clústeres fragmentados. Para usarlas,`mongos` debe tener `enabled support` para lecturas protegidas (valor predeterminado) y las`primary` preferencias de lectura que no sean deben habilitar el uso de lecturas protegidas. La preferencia de lectura habilita el uso de lecturas cubiertas en clústeres fragmentados de manera predeterminada; es decir, de manera predeterminada,`nearest` `{ enabled: true }` tiene.

Mongo.setReadPref() no admite la opción Preferencia maxStalenessSeconds de lectura para preferencia de lectura.

Compatibilidad

Este método está disponible en implementaciones alojadas en los siguientes entornos:

MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB
MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Comportamiento

Mongo.setReadPref() tiene el siguiente comportamiento.

Interacción con db.runCommand()

A partir de 2.0 mongosh, ignora cualquier preferencia de lectura global añadida mediante la cadena de conexión odb.runCommand() el Mongo.setReadPref() método. Para especificar la preferencia de lectura deseada, utilice el options argumento al llamar db.runCommand() a.

Ejemplos

Especificar el modo de preferencia de lectura

La siguiente operación establece el modo de preferencia de lectura para dirigir la lectura a un miembro secundario. Esto permite implícitamente las lecturas desde secundarios.

db.getMongo().setReadPref('secondary')

Sin embargo, si se llama mientras está conectado al primario usando la shell de mongo, el comando anterior no enruta queries a un secundario.

Especificar el conjunto de etiquetas de preferencia de lectura

Para apuntar a elementos secundarios con etiquetas específicas, incluya tanto el modo como la matriz tagSet:

db.getMongo().setReadPref(
   "secondary",
   [
      { "datacenter": "B" },    // First, try matching by the datacenter tag
      { "region": "West"},      // If not found, then try matching by the region tag
      { }                       // If not found, then use the empty document to match all eligible members
   ]
)

Durante el proceso de selección secundaria, MongoDB intenta encontrar primero miembros secundarios con la etiqueta datacenter: "B".

Si se encuentra, MongoDB limita los secundarios elegibles a aquellos con la etiqueta datacenter: "B" e ignora las etiquetas restantes.
Si no se encuentra ninguno, MongoDB intenta encontrar miembros secundarios con la etiqueta "region": "West".
- Si se encuentran, MongoDB limita los secundarios elegibles a aquellos con la etiqueta "region": "West".
- Si no se encuentra ninguno, MongoDB utiliza cualquier secundario elegible.

Consulte Orden de coincidencia de etiquetas para obtener más detalles.

Tip

Configurar conjuntos de etiquetas de set de réplicas

Especificar lectura protegida

En clústeres fragmentados, puede habilitar lecturas protegidas para preferencias de lectura no primarias. Para usar lecturas protegidas, el valor mongos predeterminado es enabled support para lecturas protegidas y lasprimary preferencias de lectura no primarias deben habilitar el uso de lecturas protegidas.

Para apuntar a los secundarios en clústeres fragmentados mediante lecturas cubiertas, incluya tanto el modo como las opciones de cobertura, como en los siguientes ejemplos:

Sin un conjunto de etiquetas
```
db.getMongo().setReadPref(
   "secondary",            // mode
   null,                   // tag set
   { enabled: true }       // hedge options
)
```
Con un conjunto de etiquetas
```
db.getMongo().setReadPref(
   "secondary",                      // mode
   [ { "datacenter": "B" },  { } ],  // tag set
   { enabled: true }                 // hedge options
)
```

Volver

Mongo.setCausalConsistency

Mongo.startSession