Opciones de cadena de conexión

Especifica el nombre de la Conjunto de réplicas, si es miembro de un conjunto de réplicas. Configure mongod la replicaSet opción de conexión para garantizar un comportamiento consistente entre los controladores.

Al conectarse a un set de réplicas, proporcione una lista de nodos iniciales de los nodos del set de réplicas al componente host[:port] del URI. Para obtener detalles específicos, consulte la documentación de su driver.

Especifica si el cliente se conecta directamente al host[:port] en el URI de conexión:

• true: el cliente envía operaciones únicamente al host especificado. No intenta descubrir ningún otro nodo del set de réplicas.

• false: el cliente intenta descubrir todos los servidores en el set de réplicas y envía operaciones al nodo primario. Este es el valor por defecto.

Corresponde a la opciónw del nivel de confirmación de escritura. La opción w solicita confirmación de que la operación de escritura se ha propagado a un número especificado de instancias mongod o a instancias mongod con etiquetas especificadas.

Puede especificar un number, el string majority o un tag set.

Para más detalles, consulte w Option.

Corresponde al nivel de confirmación de escritura wtimeout. wtimeoutMS especifica un límite de tiempo, en milisegundos, para el nivel de confirmación de escritura.

Cuando wtimeoutMS 0es, las operaciones de escritura nunca expirarán. Para más información,wtimeout consulte.

Corresponde a la j opción de nivel de confirmación de escritura. La opción journal solicita a MongoDB que confirme que la operación de escritura se guardó en el registro en la bitácora. Para obtener más detalles, consulta j Opción.

Si establece journal en true y especifica un valor de w menor que 1, prevalece journal.

El nivel de aislamiento. Puede aceptar uno de los siguientes valores:

• local

• majority

• linearizable

• available

Esta opción de cadena de conexión no está disponible para mongosh. Especifique el nivel de consistencia de lectura como una opción para la Operación específica.

Especifica las preferencias de lectura para esta conexión. Los valores posibles son:

• primary (por defecto)

• primaryPreferred

• secondary

• secondaryPreferred

• nearest

Las transacciones distribuidas que contienen operaciones de lectura deben usar la preferencia de lectura primary. Todas las operaciones en una transacción dada deben dirigirse al mismo nodo.

Esta opción de cadena de conexión no está disponible para el shell mongo. Consulte cursor.readPref() y Mongo.setReadPref() en su lugar.

Especifica, en segundos, cuán obsoleto puede estar un secundario antes de que el cliente deje de usarlo para operaciones de lectura. Para obtener más información, consulte Preferencia de Lectura maxStalenessSeconds.

De manera predeterminada, no existe un límite de obsolescencia y los clientes no considerarán el retraso de un secundario al elegir dónde dirigir una operación de lectura.

El maxStalenessSeconds valor mínimo de es de 90 segundos. Especificar un valor entre 0 y 90 segundos generará un error. Los controladores de MongoDB consideran un maxStalenessSeconds valor de -1 como "sin obsolescencia máxima", lo mismo que si maxStalenessSeconds se omitiera.

Especifica el documento de etiquetas como una lista de pares clave-valor separados por comas y separados por dos puntos. Por ejemplo,

• Para especificar el documento de etiquetas { "dc": "ny", "rack": "r1" }, utilice readPreferenceTags=dc:ny,rack:r1 en la cadena de conexión.

• Para especificar un documento de etiquetas vacío { }, utilice readPreferenceTags= sin asignar un valor.

Para especificar una lista de documentos de etiquetas, utiliza múltiples readPreferenceTags. Por ejemplo, readPreferenceTags=dc:ny,rack:r1&readPreferenceTags=.

El orden importa al usar múltiples readPreferenceTags. Las readPreferenceTags se prueban en orden hasta que se encuentre una coincidencia. Para obtener más detalles, consulte el Orden de coincidencia de etiquetas.

Esta opción de cadena de conexión no está disponible para el shell mongo. Consulte cursor.readPref() y Mongo.setReadPref() en su lugar.

Especifica el nombre de la base de datos asociado a las credenciales del usuario. Si authSource no está especificado, authSource se asigna por defecto a la cadena de conexión defaultauthdb especificada. Si defaultauthdb no está especificado, entonces authSource se establece por defecto en admin.

Los mecanismos de autenticación PLAIN (LDAP), GSSAPI (Kerberos) y MONGODB-AWS (IAM) requieren que authSource se establezca en $external, ya que estos mecanismos delegan el almacenamiento de credenciales a servicios externos.

MongoDB ignorará los valores si no se proporciona ningún nombre de usuario, ya sea en la cadena de conexión o mediante authSource el --username parámetro.

Especifique el mecanismo de autenticación que utiliza MongoDB para autenticar la conexión. Si no especifica un authMechanism pero proporciona las credenciales de usuario, MongoDB intenta utilizar SCRAM-SHA-256. Si esto falla, se recurre a SCRAM-SHA-1.

• SCRAM-SHA-1

• SCRAM-SHA-256

• MONGODB-X509

• MONGODB-AWS

• GSSAPI (Kerberos)

• PLAIN (SASL LDAP)

Solo las instancias de MongoDB Enterprisemongod y mongos proporcionan los mecanismos GSSAPI (Kerberos) y PLAIN (LDAP).

Para usar MONGODB-X509, debe tener el TLS/SSL activado.

Para utilizar MONGODB-AWS, debe estar conectado a un clúster de MongoDB Atlas que haya sido configurado para admitir la autenticación mediante credenciales de AWS IAM (un ID de clave de acceso de AWS y una clave de acceso secreta, y opcionalmente un token de sesión de AWS). El mecanismo de autenticación MONGODB-AWS requiere que el authSource esté configurado en $external.

Al MONGODB-AWS usar, proporcione su ID de clave de acceso de AWS como nombre de usuario y la clave de acceso secreta como contraseña. Si también usa un token de sesión de AWS, proporciónelo con el AWS_SESSION_TOKEN authMechanismProperties valor.

Si el ID de clave de acceso de AWS, la clave de acceso secreta o el token de sesión incluyen los siguientes caracteres, dichos caracteres deben convertirse mediante codificación de porcentaje.

$ : / ? # [ ] @

De manera alternativa, si el ID de clave de acceso de AWS, la clave de acceso secreta o el token de sesión están definidos en su plataforma utilizando sus respectivas variables de entorno de AWS IAM, mongosh utilizará estos valores de variable de entorno para autenticarse; no necesita especificarlos en la cadena de conexión.

Consulta Conéctate a un clúster de Atlas para un ejemplo de uso del MONGODB-AWS mecanismo de autenticación utilizando tanto una cadena de conexión como el método de variables de entorno.

Consulte Autenticación en Implementaciones Autogestionadas para obtener más información sobre el sistema de autenticación en MongoDB. También consulte Usar509 certificados X. para autenticar clientes en Implementaciones Autogestionadas para obtener más información sobre la509 autenticación x.

Especifica las propiedades para el authMechanism como una lista separada por comas de pares clave-valor separados por dos puntos.

Los posibles pares clave-valor son:

SERVICE_NAME:<string>

Se debe establecer el nombre del servicio Kerberos al realizar la conexión a instancias de MongoDB con Kerberos. Este valor debe coincidir con el nombre del servicio establecido en las instancias de MongoDB a las que se está realizando la conexión. Válido solo cuando se utiliza el mecanismo de autenticación GSSAPI.

SERVICE_NAME se establece por defecto en mongodb para todos los clientes y las instancias de MongoDB. Si cambia la configuración saslServiceName en una instancia de MongoDB, debe configurar SERVICE_NAME para que coincida con esa configuración. Solo es válido cuando se utiliza el mecanismo de autenticación GSSAPI.

CANONICALIZE_HOST_NAME:true|false

Canonice el nombre de host de la máquina host del cliente al conectarse al servidor Kerberos. Esto puede ser necesario cuando los hosts informen de nombres de host diferentes a los que figuran en la base de datos de Kerberos. Se establece por defecto en false. Solo es válido cuando se utiliza el mecanismo de autenticación GSSAPI.

SERVICE_REALM:<string>

Establezca el realm de Kerberos para el servicio de MongoDB. Esto puede ser necesario para dar soporte a la autenticación entre realms donde el usuario existe en un realm y el servicio en otro. Solo válido cuando se utiliza el mecanismo de autenticación GSSAPI.

AWS_SESSION_TOKEN:<security_token>

Establezca el token de sesión de AWS para la autenticación con credenciales temporales al utilizar una solicitud de AssumeRole, o al trabajar con recursos de AWS que especifiquen este valor, como Lambda. Solo es válido cuando se utiliza el mecanismo de autenticación MONGODB-AWS. Debe tener un ID de clave de acceso de AWS y una clave de acceso secreta también. Consulte Conectarse a un clúster de Atlas para ver un ejemplo de uso.

Establezca el nombre del servicio Kerberos al conectarse a instancias de MongoDB con Kerberos. Este valor debe coincidir con el nombre del servicio establecido en las instancias de MongoDB a las que se está conectando.

gssapiServiceName tiene por defecto mongodb para todos los clientes e instancias de MongoDB. Si cambia la configuración saslServiceName en una instancia de MongoDB, debe establecer gssapiServiceName para que coincida con esa configuración.

gssapiServiceName es un alias obsoleto para authMechanismProperties=SERVICE_NAME:mongodb. Para obtener más información sobre qué opciones soporta su controlador y su prioridad relativa entre ellas, consulte la documentación de la versión de controlador que prefiera.