Class: ClientSession

Members

idSessionId

The server id associated with this session

Methods

abortTransaction(callback){Promise}

node_modules/mongodb-core/lib/sessions.js, line 224

Aborts the currently active transaction in this session.

Name	Type	Description
callback	function	optional optional callback for completion of this operation

Returns:

promise is returned if no callback is provided

advanceOperationTime(operationTime)

node_modules/mongodb-core/lib/sessions.js, line 137

Advances the operationTime for a ClientSession.

Name	Type	Description
operationTime	Timestamp	the BSON.Timestamp of the operation type it is desired to advance to

commitTransaction(callback){Promise}

node_modules/mongodb-core/lib/sessions.js, line 203

Commits the currently active transaction in this session.

Name	Type	Description
callback	function	optional optional callback for completion of this operation

Returns:

promise is returned if no callback is provided

endSession(options, callback)

node_modules/mongodb-core/lib/sessions.js, line 108

Ends this session on the server

Name	Type	Description
options	Object	optional Optional settings. Currently reserved for future use
callback	function	optional Optional callback for completion of this operation

equals(session){boolean}

node_modules/mongodb-core/lib/sessions.js, line 153

Used to determine if this session equals another

Name	Type	Description
session	ClientSession

Returns:

if the sessions are equal

incrementTransactionNumber()

node_modules/mongodb-core/lib/sessions.js, line 164

Increment the transaction number on the internal ServerSession

inTransaction(){boolean}

node_modules/mongodb-core/lib/sessions.js, line 171

Returns:

this session is currently in a transaction or not

startTransaction(options)

node_modules/mongodb-core/lib/sessions.js, line 180

Starts a new transaction with the given options.

Name	Type	Description
options	TransactionOptions	Options for the transaction