startSession

Definition

startSession

The startSession command starts a new logical session for a sequence of operations.

Syntax

The command has the following syntax:

db.runCommand(
   {
     startSession: 1
   }
)

To run startSession, use the db.runCommand( { <command> } ) method.

db.runCommand(
   {
     startSession: 1
   }
)

Behavior

If the deployment enforces authentication/authorization, you must be authenticated to run the startSession command. The user who runs startSession owns the created session, and only that user can use the session.

If the deployment does not enforce authentication/authorization, a created session has no owner and can be used by any user on any connection. If the user authenticates and creates a session for a deployment that does not enforce authentication/authorization, the user owns the session. However, any user on any connection may use the session.

If the deployment transitions to auth without any downtime, any sessions without an owner cannot be used.

Output

In addition to the status and operation time of the command, the startSession returns the following session specific information:

id: { id: <UUID> }