Class: ClientSession

Members

idSessionId

The server id associated with this session

Methods

abortTransaction(callback){Promise}

lib/core/sessions.js, line 239

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)

lib/core/sessions.js, line 143

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}

lib/core/sessions.js, line 218

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)

lib/core/sessions.js, line 113

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}

lib/core/sessions.js, line 159

Used to determine if this session equals another

Name	Type	Description
session	ClientSession

Returns:

if the sessions are equal

incrementTransactionNumber()

lib/core/sessions.js, line 170

Increment the transaction number on the internal ServerSession

inTransaction(){boolean}

lib/core/sessions.js, line 177

Returns:

this session is currently in a transaction or not

startTransaction(options)

lib/core/sessions.js, line 186

Starts a new transaction with the given options.

Name	Type	Description
options	TransactionOptions	Options for the transaction

withTransaction(fn, options)

lib/core/sessions.js, line 281

Runs a provided lambda within a transaction, retrying either the commit operation
or entire transaction as needed (and when the error permits) to better ensure that
the transaction can complete successfully.

IMPORTANT: This method requires the user to return a Promise, all lambdas that do not
return a Promise will result in undefined behavior.

Name	Type	Description
fn	WithTransactionCallback
options	TransactionOptions	optional Optional settings for the transaction