Mongo.startSession() (método mongosh)

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

This page documents a mongosh method. This is not the documentation for database commands or language-specific drivers, such as 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	Boolean. Enables or disables causal consistency for the session. Mongo.startSession() enables causalConsistency by default. Mutually exclusive with snapshot. Depois de iniciar uma sessão, não é possível modificar sua configuração causalConsistency. A sessão pode ter a consistência causal habilitada, embora o objeto de conexão Mongo() possa ter a consistência causal desabilitada ou vice-versa. Para definir a consistência causal no objeto de conexão, consulte Mongo.setCausalConsistency().
readConcern	Documento. Especifica a read concern. Para modificar a configuração após iniciar uma sessão, consulte Session.getOptions().setReadConcern().
readPreference	Documento. Especifica a read preference. O documento readPreference contém o campo mode e o campo opcional tags: { mode: <string>, tags: <array> } Para modificar a configuração após iniciar uma sessão, consulte Session.getOptions().setReadPreference().
retryWrites	Booleano. Habilita ou desabilita a capacidade de repetir as escritas ao encontrar erros transitórios de rede. If you start mongosh with the --retryWrites option, retryWrites is enabled by default for Mongo.startSession(). Depois de iniciar uma sessão, não é possível modificar sua configuração retryWrites.
snapshot	Boolean. Permite leituras de snapshots para a sessão para MongoDB 5.0+ sistemas. Mutualmente exclusivo com causalConsistency.
writeConcern	Documento. Especifica a write concern. Para modificar a configuração após iniciar uma sessão, consulte Session.getOptions().setWriteConcern().

Compatibilidade

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

• MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

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