Mongo.setReadPref() (método mongosh)

Esta versión de la documentación se archivó y ya no se admite. Para actualizar tu implementación de 6.0, consulta el Procedimientos de actualización de MongoDB.7.0

Definición

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

[1]	Para aplicar una preferencia de lectura a una query específica, puedes aplicar `cursor.readPref()` a un cursor antes de la iteración. Consulte `cursor.readPref()` para obtener detalles.

Parámetros

Parameter	Tipo	Descripción
moda	string	Uno de los siguientes modos de preferencia `primary` de lectura:,,, `primaryPreferred` `secondarysecondaryPreferred`o `nearest`
tagSet	arreglo de documentos	opcional. Un conjunto de etiquetas utilizado para dirigir lecturas a los nodos con la(s) etiqueta(s) especificada(s). `tagSet` no está disponible si se utiliza el modo de preferencia de lectura `primary`. Para obtener más detalles, consulte Listas de conjuntos de etiquetas de preferencias de lectura.
hedgeOptions	Documento	Opcional. Un documento que indica si se debe habilitar el uso de lecturas protegidas: `{ enabled: <boolean> }` El campo `enabled` por defecto es verdadero; es decir, especificar un documento vacío `{ }` equivale 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 mongosh 2.0, db.runCommand() ignora cualquier preferencia de lectura global añadida a través de la cadena de conexión o mediante el método Mongo.setReadPref(). Para especificar la preferencia de lectura deseada, usa el argumento options al invocar db.runCommand().

Ejemplos

Especificar el modo de preferencia de lectura

La siguiente operación establece la preferencia de lectura en el modo para dirigir la lectura a un secundario. Esto permite implícitamente 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 conjunto de etiquetas de preferencia de lectura

Para dirigir los secundarios con etiquetas específicas, incluye tanto el modo como el arreglo 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 de secundaria, MongoDB intenta encontrar primero los 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 nodos secundarios con la etiqueta "region": "West".
- Si se encuentra, 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

Especifique lectura protegida

Para clústeres fragmentados, puedes habilitar las lecturas protegidas para preferencias de lectura que no son primarias. Para utilizar lecturas protegidas, el mongos debe tener enabled support para lecturas protegidas (por defecto) y el preferencia de lectura que no seaprimary debe habilitar el uso de lecturas protegidas.

Para dirigir segundarios en clústeres usando lecturas protegidas, incluya tanto la moda como las hedgeOptions, 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