Mongo.startSession()

Definição

Mongo.startSession(<options>)

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

Importante

Método mongosh

Esta página documenta um método mongosh. Esta não é a documentação para comandos de banco de dados nem drivers específicos de linguagem, como Node.js.

Para o comando do banco de dados, consulte o comando startSession.

Para drivers de API do MongoDB, consulte a documentação do driver do MongoDB específica da linguagem.

Uma sessão só pode ser usada com o objeto MongoClient que criou a sessão. Uma única sessão não pode ser usada simultaneamente. As operações que usam uma única sessão devem ser executadas sequencialmente.

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

Campo	Descrição
causalConsistency	Booleano. Habilita ou desabilita a consistência causal da sessão. Mongo.startSession() enables causalConsistency by default. Mutually exclusive with snapshot. After starting a session, you cannot modify its causalConsistency setting. The session may have causal consistency enabled even though the Mongo() connection object may have causal consistency disabled or vice versa. To set causal consistency on the connection object, see Mongo.setCausalConsistency().
readConcern	Documento. Especifica a read concern. To modify the setting after starting a session, see Session.getOptions().setReadConcern().
readPreference	Documento. Especifica a read preference. The readPreference document contains the mode field and the optional tags field: { mode: <string>, tags: <array> } To modify the setting after starting a session, see Session.getOptions().setReadPreference().
retryWrites	Boolean. Enables or disables the ability to retry writes upon encountering transient network errors. If you start mongosh with the --retryWrites option, retryWrites is enabled by default for Mongo.startSession(). After starting a session, you cannot modify its retryWrites setting.
snapshot	Boolean. Enables snapshot reads for the session for MongoDB 5.0+ deployments. Mutually exclusive with causalConsistency.
writeConcern	Documento. Especifica a write concern. To modify the setting after starting a session, see Session.getOptions().setWriteConcern().

Compatibilidade

Esse método está disponível em implantações hospedadas nos seguintes ambientes:

• MongoDB Atlas: o serviço totalmente gerenciado para implantações do MongoDB na nuvem

• MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB

• MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB

Exemplos

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());