Opciones de cadena de conexión

Especifica el nombre del 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 conjunto de réplicas, proporcione una lista inicial de los miembros del host[:port] conjunto de réplicas en el componente. Consulte la documentación de su controlador para obtener más detalles.

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

• trueEl cliente envía operaciones únicamente al host especificado y no intenta descubrir otros miembros del conjunto 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.

IMPORTANTE: La opción wtimeoutMS está en desuso. Configure timeoutMS en su lugar. timeoutMS anula wtimeoutMS.

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 es 0, las operaciones de guardado nunca agotan el tiempo de espera. Para obtener más información, consulta wtimeout.

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. Acepta 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 que contienen operaciones de lectura deben usar la preferencia de primary lectura. Todas las operaciones de una transacción deben dirigirse al mismo miembro.

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.

Por defecto, no hay un límite máximo de antigüedad y los clientes no consideran la demora de un secundario al elegir dónde dirigir una operación de lectura.

El valor mínimo de maxStalenessSeconds es 90 segundos. Especificar un valor entre 0 y 90 segundos genera un error. Los controladores de MongoDB tratan un valor maxStalenessSeconds de -1 como "sin obsolescencia máxima", igual que si se omite maxStalenessSeconds.

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.

Nombre de la base de datos asociada a las credenciales del usuario. Si se especifica, el valor predeterminado es defaultauthdb; de lo contrario, es admin.

Los PLAIN GSSAPI MONGODB-AWS mecanismos, y requieren que se authSource establezca $external en, ya que delegan el almacenamiento de credenciales a servicios externos.

MongoDB ignora si no se proporciona un nombre de usuario en la cadena de conexión o a authSource través --username de.

Mecanismo de autenticación para la conexión. Sin un authMechanism explícito, MongoDB intenta SCRAM-SHA-256 y recurre a SCRAM-SHA-1 si falla.

• 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 usar,MONGODB-AWS debe conectarse a un clúster de MongoDB Atlas 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 MONGODB-AWS mecanismo de autenticación requiere que esté authSource configurado $external en.

Cuando uses MONGODB-AWS, proporciona tu ID de clave de acceso de AWS como el nombre de usuario y la clave de acceso secreta como la contraseña. Si también utilizas un token de sesión de AWS, proporciónalo con el valor AWS_SESSION_TOKEN authMechanismProperties.

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 usando codificación por porcentaje.

$ : / ? # [ ] @

Como alternativa, si el ID de la clave de acceso de AWS, la clave de acceso secreta o el token de sesión se definen en su plataforma mediante sus respectivas variables de entorno de AWS IAM, mongosh utiliza estos valores para la autenticación automática. No es necesario especificarlos en la cadena de conexión. Existen otros métodos para proporcionar credenciales de AWS según su entorno de implementación y los requisitos de seguridad.

Para ver un ejemplo de uso del mecanismo de autenticación MONGODB-AWS, consulte Cadenas de conexión.

Consulte Autenticación en implementaciones autogestionadas para obtener más información sobre el sistema de autenticación en MongoDB. Considere también usar X.509 para autenticar clientes en MongoDB autogestionado para obtener más información sobre la autenticación x509.

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>

Configura el token de sesión de AWS para la autenticación con credenciales temporales cuando se utiliza una AssumeRole solicitud o cuando se trabaja con recursos de AWS que especifican este valor, como Lambda. Válido únicamente al utilizar el mecanismo de autenticación MONGODB-AWS. También debe tener una ID de clave de acceso a AWS y una clave de acceso secreta. Para ver un ejemplo de uso, consulta Cadenas de conexión.

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.