Mongo.startSession() (método mongosh)

Definición

Mongo.startSession(<options>)

Starts a session for the connection. mongosh assigns the session ID to commands associated with the session.

Importante

Método mongosh

This page documents a mongosh method. This is not the documentation for database commands or language-specific drivers, such as Node.js.

Para el comando de base de datos, consulta el comando startSession.

Para los drivers de API de MongoDB, consulte la documentación del driver de MongoDB específica del lenguaje.

Una sesión sólo se puede utilizar con el objeto MongoClient que la creó. Una sola sesión no se puede utilizar de forma simultánea. Las operaciones que utilizan una única sesión deben ejecutarse de forma secuencial.

The startSession() method can take a document with session options. The options available are:

Campo	Descripción
Coherencia causal	Boolean. Enables or disables causal consistency for the session. Mongo.startSession() enables causalConsistency by default. Mutually exclusive with snapshot. Después de iniciar una sesión, no se puede modificar su configuración causalConsistency. La sesión puede tener habilitada la consistencia causal incluso aunque el objeto de conexión Mongo() tenga la consistencia causal deshabilitada o viceversa. Para establecer la coherencia causal en el objeto de conexión, consulta Mongo.setCausalConsistency().
readConcern	Documento. Especifica el nivel de consistencia de lectura. Para modificar la configuración después de iniciar una sesión, consulta Session.getOptions().setReadConcern().
readPreference	documento. Especifica la preferencia de lectura. El documento readPreference contiene el campo mode y el campo opcional tags: { mode: <string>, tags: <array> } Para modificar la configuración después de iniciar una sesión, consulta Session.getOptions().setReadPreference().
retryWrites	booleano. Habilita o deshabilita la capacidad de reintentar guardados al encontrar errores de red transitorios. If you start mongosh with the --retryWrites option, retryWrites is enabled by default for Mongo.startSession(). Después de iniciar una sesión, no se puede modificar su configuración retryWrites.
snapshot	booleano. Habilita lecturas de snapshot para la sesión en implementaciones de MongoDB 5.0+ . Mutuamente excluyente con causalConsistency.
writeConcern	documento. Especifica el nivel de confirmación de escritura (write concern). Para modificar la configuración después de iniciar una sesión, consulta Session.getOptions().setWriteConcern().

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.

Ejemplos

The following starts a session with causal consistency and retryable writes enabled on the Mongo() connection object associated with mongosh's global db variable:

db = db.getMongo().startSession({retryWrites: true, causalConsistency: true}).getDatabase(db.getName());