ClientSession | Documentation

A class representing a client session on the server

NOTE: not meant to be instantiated directly.

Hierarchy

TypedEventEmitter<ClientSessionEvents>
- ClientSession

Constructors

constructor

new ClientSession(): ClientSession

Inherited from TypedEventEmitter.constructor
- Defined in node_modules/@types/node/events.d.ts:11
Returns ClientSession

Methods

Static once

once(emitter: <internal>.NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: <internal>.DOMEventTarget, event: string): Promise<any[]>

Inherited from TypedEventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:13
Parameters
- emitter: <internal>.NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from TypedEventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:14
Parameters
- emitter: <internal>.DOMEventTarget
- event: string
Returns Promise<any[]>

Static on

on(emitter: <internal>.EventEmitter, event: string): <internal>.AsyncIterableIterator<any>

Inherited from TypedEventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:15
Parameters
- emitter: <internal>.EventEmitter
- event: string
Returns <internal>.AsyncIterableIterator<any>

Static listenerCount

listenerCount(emitter: <internal>.EventEmitter, event: string | symbol): number

Inherited from TypedEventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:18
deprecated
since v4.0.0

Parameters
- emitter: <internal>.EventEmitter
- event: string | symbol
Returns number

endSession

endSession(): Promise<void>
endSession(options: EndSessionOptions): Promise<void>
endSession(callback: <internal>.Callback<void>): void
endSession(options: EndSessionOptions, callback: <internal>.Callback<void>): void

- Defined in node_modules/mongodb/mongodb.d.ts:1628
Ends this session on the server

Returns Promise<void>
- Defined in node_modules/mongodb/mongodb.d.ts:1629
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- options: EndSessionOptions
Returns Promise<void>
- Defined in node_modules/mongodb/mongodb.d.ts:1631
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: <internal>.Callback<void>
Returns void
- Defined in node_modules/mongodb/mongodb.d.ts:1633
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- options: EndSessionOptions
- callback: <internal>.Callback<void>
Returns void

advanceOperationTime

advanceOperationTime(operationTime: Timestamp): void

- Defined in node_modules/mongodb/mongodb.d.ts:1639
Advances the operationTime for a ClientSession.

Parameters
- operationTime: Timestamp
  
  the BSON.Timestamp of the operation type it is desired to advance to
Returns void

advanceClusterTime

advanceClusterTime(clusterTime: ClusterTime): void

- Defined in node_modules/mongodb/mongodb.d.ts:1645
Advances the clusterTime for a ClientSession to the provided clusterTime of another ClientSession

Parameters
- clusterTime: ClusterTime
  
  the $clusterTime returned by the server from another session in the form of a document containing the BSON.Timestamp clusterTime and signature
Returns void

equals

equals(session: ClientSession): boolean

- Defined in node_modules/mongodb/mongodb.d.ts:1651
Used to determine if this session equals another

Parameters
- session: ClientSession
  
  The session to compare to
Returns boolean

incrementTransactionNumber

incrementTransactionNumber(): void

- Defined in node_modules/mongodb/mongodb.d.ts:1660
Increment the transaction number on the internal ServerSession

privateremarks
This helper increments a value stored on the client session that will be added to the serverSession's txnNumber upon applying it to a command. This is because the serverSession is lazily acquired after a connection is obtained

Returns void

inTransaction

inTransaction(): boolean

- Defined in node_modules/mongodb/mongodb.d.ts:1662
Returns boolean
whether this session is currently in a transaction or not

startTransaction

startTransaction(options?: TransactionOptions): void

- Defined in node_modules/mongodb/mongodb.d.ts:1668
Starts a new transaction with the given options.

Parameters
- Optional options: TransactionOptions
  
  Options for the transaction
Returns void

commitTransaction

commitTransaction(): Promise<<internal>.Document>
commitTransaction(callback: <internal>.Callback<<internal>.Document>): void

- Defined in node_modules/mongodb/mongodb.d.ts:1674
Commits the currently active transaction in this session.

Returns Promise<<internal>.Document>
- Defined in node_modules/mongodb/mongodb.d.ts:1676
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: <internal>.Callback<<internal>.Document>
Returns void

abortTransaction

abortTransaction(): Promise<<internal>.Document>
abortTransaction(callback: <internal>.Callback<<internal>.Document>): void

- Defined in node_modules/mongodb/mongodb.d.ts:1682
Aborts the currently active transaction in this session.

Returns Promise<<internal>.Document>
- Defined in node_modules/mongodb/mongodb.d.ts:1684
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: <internal>.Callback<<internal>.Document>
Returns void

toBSON

toBSON(): never

- Defined in node_modules/mongodb/mongodb.d.ts:1688
This is here to ensure that ClientSession is never serialized to BSON.

Returns never

withTransaction

withTransaction<T>(fn: WithTransactionCallback<T>, options?: TransactionOptions): Promise<<internal>.Document>

- Defined in node_modules/mongodb/mongodb.d.ts:1710
Runs a provided callback within a transaction, retrying either the commitTransaction 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, and await all operations. Any callbacks that do not return a Promise will result in undefined behavior.
remarks
This function:
- Will return the command response from the final commitTransaction if every operation is successful (can be used as a truthy object)
- Will return undefined if the transaction is explicitly aborted with await session.abortTransaction()
- Will throw if one of the operations throws or throw statement is used inside the withTransaction callback
Checkout a descriptive example here:
see
https://www.mongodb.com/developer/quickstart/node-transactions/
Type Parameters
- T = void
Parameters
- fn: WithTransactionCallback<T>
  
  callback to run within a transaction
- Optional options: TransactionOptions
  
  optional settings for the transaction
Returns Promise<<internal>.Document>
A raw command response or undefined

addListener

addListener<EventKey>(event: EventKey, listener: ClientSessionEvents[EventKey]): ClientSession
addListener(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): ClientSession
addListener(event: string | symbol, listener: GenericListener): ClientSession

Inherited from TypedEventEmitter.addListener
- Defined in node_modules/mongodb/mongodb.d.ts:6481
Type Parameters
- EventKey extends "ended"
Parameters
- event: EventKey
- listener: ClientSessionEvents[EventKey]
Returns ClientSession
Inherited from TypedEventEmitter.addListener
- Defined in node_modules/mongodb/mongodb.d.ts:6482
Parameters
- event: CommonEvents
- listener: ((eventName: string | symbol, listener: GenericListener) => void)
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns ClientSession
Inherited from TypedEventEmitter.addListener
- Defined in node_modules/mongodb/mongodb.d.ts:6483
Parameters
- event: string | symbol
- listener: GenericListener
Returns ClientSession

on

on<EventKey>(event: EventKey, listener: ClientSessionEvents[EventKey]): ClientSession
on(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): ClientSession
on(event: string | symbol, listener: GenericListener): ClientSession

Inherited from TypedEventEmitter.on
- Defined in node_modules/mongodb/mongodb.d.ts:6484
Type Parameters
- EventKey extends "ended"
Parameters
- event: EventKey
- listener: ClientSessionEvents[EventKey]
Returns ClientSession
Inherited from TypedEventEmitter.on
- Defined in node_modules/mongodb/mongodb.d.ts:6485
Parameters
- event: CommonEvents
- listener: ((eventName: string | symbol, listener: GenericListener) => void)
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns ClientSession
Inherited from TypedEventEmitter.on
- Defined in node_modules/mongodb/mongodb.d.ts:6486
Parameters
- event: string | symbol
- listener: GenericListener
Returns ClientSession

once

once<EventKey>(event: EventKey, listener: ClientSessionEvents[EventKey]): ClientSession
once(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): ClientSession
once(event: string | symbol, listener: GenericListener): ClientSession

Inherited from TypedEventEmitter.once
- Defined in node_modules/mongodb/mongodb.d.ts:6487
Type Parameters
- EventKey extends "ended"
Parameters
- event: EventKey
- listener: ClientSessionEvents[EventKey]
Returns ClientSession
Inherited from TypedEventEmitter.once
- Defined in node_modules/mongodb/mongodb.d.ts:6488
Parameters
- event: CommonEvents
- listener: ((eventName: string | symbol, listener: GenericListener) => void)
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns ClientSession
Inherited from TypedEventEmitter.once
- Defined in node_modules/mongodb/mongodb.d.ts:6489
Parameters
- event: string | symbol
- listener: GenericListener
Returns ClientSession

removeListener

removeListener<EventKey>(event: EventKey, listener: ClientSessionEvents[EventKey]): ClientSession
removeListener(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): ClientSession
removeListener(event: string | symbol, listener: GenericListener): ClientSession

Inherited from TypedEventEmitter.removeListener
- Defined in node_modules/mongodb/mongodb.d.ts:6490
Type Parameters
- EventKey extends "ended"
Parameters
- event: EventKey
- listener: ClientSessionEvents[EventKey]
Returns ClientSession
Inherited from TypedEventEmitter.removeListener
- Defined in node_modules/mongodb/mongodb.d.ts:6491
Parameters
- event: CommonEvents
- listener: ((eventName: string | symbol, listener: GenericListener) => void)
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns ClientSession
Inherited from TypedEventEmitter.removeListener
- Defined in node_modules/mongodb/mongodb.d.ts:6492
Parameters
- event: string | symbol
- listener: GenericListener
Returns ClientSession

off

off<EventKey>(event: EventKey, listener: ClientSessionEvents[EventKey]): ClientSession
off(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): ClientSession
off(event: string | symbol, listener: GenericListener): ClientSession

Inherited from TypedEventEmitter.off
- Defined in node_modules/mongodb/mongodb.d.ts:6493
Type Parameters
- EventKey extends "ended"
Parameters
- event: EventKey
- listener: ClientSessionEvents[EventKey]
Returns ClientSession
Inherited from TypedEventEmitter.off
- Defined in node_modules/mongodb/mongodb.d.ts:6494
Parameters
- event: CommonEvents
- listener: ((eventName: string | symbol, listener: GenericListener) => void)
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns ClientSession
Inherited from TypedEventEmitter.off
- Defined in node_modules/mongodb/mongodb.d.ts:6495
Parameters
- event: string | symbol
- listener: GenericListener
Returns ClientSession

removeAllListeners

removeAllListeners<EventKey>(event?: string | symbol | EventKey): ClientSession

Inherited from TypedEventEmitter.removeAllListeners
- Defined in node_modules/mongodb/mongodb.d.ts:6496
Type Parameters
- EventKey extends "ended"
Parameters
- Optional event: string | symbol | EventKey
Returns ClientSession

listeners

listeners<EventKey>(event: string | symbol | EventKey): ClientSessionEvents[EventKey][]

Inherited from TypedEventEmitter.listeners
- Defined in node_modules/mongodb/mongodb.d.ts:6497
Type Parameters
- EventKey extends "ended"
Parameters
- event: string | symbol | EventKey
Returns ClientSessionEvents[EventKey][]

rawListeners

rawListeners<EventKey>(event: string | symbol | EventKey): ClientSessionEvents[EventKey][]

Inherited from TypedEventEmitter.rawListeners
- Defined in node_modules/mongodb/mongodb.d.ts:6498
Type Parameters
- EventKey extends "ended"
Parameters
- event: string | symbol | EventKey
Returns ClientSessionEvents[EventKey][]

emit

emit<EventKey>(event: symbol | EventKey, ...args: Parameters<ClientSessionEvents[EventKey]>): boolean

Inherited from TypedEventEmitter.emit
- Defined in node_modules/mongodb/mongodb.d.ts:6499
Type Parameters
- EventKey extends "ended"
Parameters
- event: symbol | EventKey
- Rest ...args: Parameters<ClientSessionEvents[EventKey]>
Returns boolean

listenerCount

listenerCount<EventKey>(type: string | symbol | EventKey): number

Inherited from TypedEventEmitter.listenerCount
- Defined in node_modules/mongodb/mongodb.d.ts:6500
Type Parameters
- EventKey extends "ended"
Parameters
- type: string | symbol | EventKey
Returns number

prependListener

prependListener<EventKey>(event: EventKey, listener: ClientSessionEvents[EventKey]): ClientSession
prependListener(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): ClientSession
prependListener(event: string | symbol, listener: GenericListener): ClientSession

Inherited from TypedEventEmitter.prependListener
- Defined in node_modules/mongodb/mongodb.d.ts:6501
Type Parameters
- EventKey extends "ended"
Parameters
- event: EventKey
- listener: ClientSessionEvents[EventKey]
Returns ClientSession
Inherited from TypedEventEmitter.prependListener
- Defined in node_modules/mongodb/mongodb.d.ts:6502
Parameters
- event: CommonEvents
- listener: ((eventName: string | symbol, listener: GenericListener) => void)
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns ClientSession
Inherited from TypedEventEmitter.prependListener
- Defined in node_modules/mongodb/mongodb.d.ts:6503
Parameters
- event: string | symbol
- listener: GenericListener
Returns ClientSession

prependOnceListener

prependOnceListener<EventKey>(event: EventKey, listener: ClientSessionEvents[EventKey]): ClientSession
prependOnceListener(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): ClientSession
prependOnceListener(event: string | symbol, listener: GenericListener): ClientSession

Inherited from TypedEventEmitter.prependOnceListener
- Defined in node_modules/mongodb/mongodb.d.ts:6504
Type Parameters
- EventKey extends "ended"
Parameters
- event: EventKey
- listener: ClientSessionEvents[EventKey]
Returns ClientSession
Inherited from TypedEventEmitter.prependOnceListener
- Defined in node_modules/mongodb/mongodb.d.ts:6505
Parameters
- event: CommonEvents
- listener: ((eventName: string | symbol, listener: GenericListener) => void)
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns ClientSession
Inherited from TypedEventEmitter.prependOnceListener
- Defined in node_modules/mongodb/mongodb.d.ts:6506
Parameters
- event: string | symbol
- listener: GenericListener
Returns ClientSession

eventNames

eventNames(): string[]

Inherited from TypedEventEmitter.eventNames
- Defined in node_modules/mongodb/mongodb.d.ts:6507
Returns string[]

getMaxListeners

getMaxListeners(): number

Inherited from TypedEventEmitter.getMaxListeners
- Defined in node_modules/mongodb/mongodb.d.ts:6508
Returns number

setMaxListeners

setMaxListeners(n: number): ClientSession

Inherited from TypedEventEmitter.setMaxListeners
- Defined in node_modules/mongodb/mongodb.d.ts:6509
Parameters
- n: number
Returns ClientSession

Properties

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

hasEnded

hasEnded: boolean

Optional clientOptions

clientOptions?: <internal>.MongoOptions

supports

supports: { causalConsistency: boolean }

Type declaration

causalConsistency: boolean

Optional clusterTime

clusterTime?: ClusterTime

Optional operationTime

operationTime?: Timestamp

explicit

explicit: boolean

defaultTransactionOptions

defaultTransactionOptions: TransactionOptions

transaction

transaction: Transaction

Accessors

id

get id(): ServerSessionId

- Defined in node_modules/mongodb/mongodb.d.ts:1613
The server id associated with this session

Returns ServerSessionId

serverSession

get serverSession(): ServerSession

- Defined in node_modules/mongodb/mongodb.d.ts:1614
Returns ServerSession

snapshotEnabled

get snapshotEnabled(): boolean

- Defined in node_modules/mongodb/mongodb.d.ts:1616
Whether or not this session is configured for snapshot reads

Returns boolean

loadBalanced

get loadBalanced(): boolean

- Defined in node_modules/mongodb/mongodb.d.ts:1617
Returns boolean

isPinned

get isPinned(): boolean

- Defined in node_modules/mongodb/mongodb.d.ts:1621
Returns boolean

Hierarchy

Index

Constructors

Methods

Properties

Accessors

Constructors

constructor

Returns ClientSession

Methods

Static once

Parameters

emitter: <internal>.NodeEventTarget

event: string | symbol

Returns Promise<any[]>

Parameters

emitter: <internal>.DOMEventTarget

event: string

Returns Promise<any[]>

Static on

Parameters

emitter: <internal>.EventEmitter

event: string

Returns <internal>.AsyncIterableIterator<any>

Static listenerCount

Parameters

emitter: <internal>.EventEmitter

event: string | symbol

Returns number

endSession

Returns Promise<void>

Parameters

options: EndSessionOptions

Returns Promise<void>

Parameters

callback: <internal>.Callback<void>

Returns void

Parameters

options: EndSessionOptions

callback: <internal>.Callback<void>

Returns void

advanceOperationTime

Parameters

operationTime: Timestamp

Returns void

advanceClusterTime

Parameters

clusterTime: ClusterTime

Returns void

equals

Parameters

session: ClientSession

Returns boolean

incrementTransactionNumber

Returns void

inTransaction

Returns boolean

startTransaction

Parameters

Optional options: TransactionOptions

Returns void

commitTransaction

Returns Promise<<internal>.Document>

Parameters

callback: <internal>.Callback<<internal>.Document>

Returns void

abortTransaction

Returns Promise<<internal>.Document>

Parameters

callback: <internal>.Callback<<internal>.Document>

Returns void

toBSON

Returns never

withTransaction

Type Parameters

T = void

Parameters

fn: WithTransactionCallback<T>

Optional options: TransactionOptions

Returns Promise<<internal>.Document>