ClientSession | mongodb

A class representing a client session on the server

NOTE: not meant to be instantiated directly.

Hierarchy

TypedEventEmitter<ClientSessionEvents>
- ClientSession

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new ClientSession(topology: Topology, sessionPool: ServerSessionPool, options: ClientSessionOptions, clientOptions?: MongoOptions): ClientSession

Overrides TypedEventEmitter.constructor
- Defined in src/sessions.ts:143
Create a client session.

internal

Parameters
- topology: Topology
  
  The current client's topology (Internal Class)
- sessionPool: ServerSessionPool
  
  The server session pool (Internal Class)
- options: ClientSessionOptions
  
  Optional settings
- Optional clientOptions: MongoOptions
  
  Optional settings provided when creating a MongoClient
Returns ClientSession

Properties

Optional [kPinnedConnection]

[kPinnedConnection]: Connection

internal

Optional [kServerSession]

[kServerSession]: ServerSession

internal

[kSnapshotEnabled]

[kSnapshotEnabled]: boolean = false

internal

Optional [kSnapshotTime]

[kSnapshotTime]: Timestamp

internal

Optional clientOptions

clientOptions: MongoOptions

Optional clusterTime

clusterTime: ClusterTime

defaultTransactionOptions

defaultTransactionOptions: TransactionOptions

explicit

explicit: boolean

hasEnded

hasEnded: boolean

Optional operationTime

operationTime: Timestamp

Optional owner

owner: symbol | AbstractCursor<any, AbstractCursorEvents>

internal

sessionPool

sessionPool: ServerSessionPool

internal

supports

supports: { causalConsistency: boolean }

Type declaration

causalConsistency: boolean

topology

topology: Topology

internal

transaction

transaction: Transaction

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

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.

Accessors

id

get id(): undefined | ServerSessionId

- Defined in src/sessions.ts:192
The server id associated with this session

Returns undefined | ServerSessionId

isPinned

get isPinned(): boolean

- Defined in src/sessions.ts:241
Returns boolean

loadBalanced

get loadBalanced(): boolean

- Defined in src/sessions.ts:210
Returns boolean

pinnedConnection

get pinnedConnection(): undefined | Connection

- Defined in src/sessions.ts:215
internal

Returns undefined | Connection

serverSession

get serverSession(): ServerSession

- Defined in src/sessions.ts:196
Returns ServerSession

snapshotEnabled

get snapshotEnabled(): boolean

- Defined in src/sessions.ts:206
Whether or not this session is configured for snapshot reads

Returns boolean

Methods

abortTransaction

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

- Defined in src/sessions.ts:438
Aborts the currently active transaction in this session.

Returns Promise<Document>
- Defined in src/sessions.ts:439
Parameters
- callback: Callback<Document>
Returns void

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 src/mongo_types.ts:341
Type parameters
- EventKey: "ended"
Parameters
- event: EventKey
- listener: ClientSessionEvents[EventKey]
Returns ClientSession
Inherited from TypedEventEmitter.addListener
- Defined in src/mongo_types.ts:342
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 src/mongo_types.ts:346
Parameters
- event: string | symbol
- listener: GenericListener
Returns ClientSession

advanceClusterTime

advanceClusterTime(clusterTime: ClusterTime): void

- Defined in src/sessions.ts:317
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

advanceOperationTime

advanceOperationTime(operationTime: Timestamp): void

- Defined in src/sessions.ts:301
Advances the operationTime for a ClientSession.

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

commitTransaction

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

- Defined in src/sessions.ts:427
Commits the currently active transaction in this session.

Returns Promise<Document>
- Defined in src/sessions.ts:428
Parameters
- callback: Callback<Document>
Returns void

emit

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

Inherited from TypedEventEmitter.emit
- Defined in src/mongo_types.ts:388
Type parameters
- EventKey: "ended"
Parameters
- event: symbol | EventKey
- Rest ...args: Parameters<ClientSessionEvents[EventKey]>
Returns boolean

endSession

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

- Defined in src/sessions.ts:251
Ends this session on the server

Returns Promise<void>
- Defined in src/sessions.ts:252
Parameters
- callback: Callback<void>
Returns void
- Defined in src/sessions.ts:253
Parameters
- options: EndSessionOptions
Returns Promise<void>
- Defined in src/sessions.ts:254
Parameters
- options: EndSessionOptions
- callback: Callback<void>
Returns void

equals

equals(session: ClientSession): boolean

- Defined in src/sessions.ts:345
Used to determine if this session equals another

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

eventNames

eventNames(): string[]

Inherited from TypedEventEmitter.eventNames
- Defined in src/mongo_types.ts:414
Returns string[]

getMaxListeners

getMaxListeners(): number

Inherited from TypedEventEmitter.getMaxListeners
- Defined in src/mongo_types.ts:415
Returns number

inTransaction

inTransaction(): boolean

- Defined in src/sessions.ts:366
Returns boolean

whether this session is currently in a transaction or not

incrementTransactionNumber

incrementTransactionNumber(): void

- Defined in src/sessions.ts:358
Increment the transaction number on the internal ServerSession

Returns void

listenerCount

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

Inherited from TypedEventEmitter.listenerCount
- Defined in src/mongo_types.ts:393
Type parameters
- EventKey: "ended"
Parameters
- type: string | symbol | EventKey
Returns number

listeners

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

Inherited from TypedEventEmitter.listeners
- Defined in src/mongo_types.ts:380
Type parameters
- EventKey: "ended"
Parameters
- event: string | symbol | EventKey
Returns ClientSessionEvents[EventKey][]

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 src/mongo_types.ts:369
Type parameters
- EventKey: "ended"
Parameters
- event: EventKey
- listener: ClientSessionEvents[EventKey]
Returns ClientSession
Inherited from TypedEventEmitter.off
- Defined in src/mongo_types.ts:370
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 src/mongo_types.ts:374
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 src/mongo_types.ts:348
Type parameters
- EventKey: "ended"
Parameters
- event: EventKey
- listener: ClientSessionEvents[EventKey]
Returns ClientSession
Inherited from TypedEventEmitter.on
- Defined in src/mongo_types.ts:349
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 src/mongo_types.ts:353
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 src/mongo_types.ts:355
Type parameters
- EventKey: "ended"
Parameters
- event: EventKey
- listener: ClientSessionEvents[EventKey]
Returns ClientSession
Inherited from TypedEventEmitter.once
- Defined in src/mongo_types.ts:356
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 src/mongo_types.ts:360
Parameters
- event: string | symbol
- listener: GenericListener
Returns ClientSession

pin(conn: Connection): void

- Defined in src/sessions.ts:220
internal

Parameters
- conn: Connection
Returns void

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 src/mongo_types.ts:397
Type parameters
- EventKey: "ended"
Parameters
- event: EventKey
- listener: ClientSessionEvents[EventKey]
Returns ClientSession
Inherited from TypedEventEmitter.prependListener
- Defined in src/mongo_types.ts:398
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 src/mongo_types.ts:402
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 src/mongo_types.ts:404
Type parameters
- EventKey: "ended"
Parameters
- event: EventKey
- listener: ClientSessionEvents[EventKey]
Returns ClientSession
Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:408
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 src/mongo_types.ts:412
Parameters
- event: string | symbol
- listener: GenericListener
Returns ClientSession

rawListeners

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

Inherited from TypedEventEmitter.rawListeners
- Defined in src/mongo_types.ts:384
Type parameters
- EventKey: "ended"
Parameters
- event: string | symbol | EventKey
Returns ClientSessionEvents[EventKey][]

removeAllListeners

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

Inherited from TypedEventEmitter.removeAllListeners
- Defined in src/mongo_types.ts:376
Type parameters
- EventKey: "ended"
Parameters
- Optional event: string | symbol | EventKey
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 src/mongo_types.ts:362
Type parameters
- EventKey: "ended"
Parameters
- event: EventKey
- listener: ClientSessionEvents[EventKey]
Returns ClientSession
Inherited from TypedEventEmitter.removeListener
- Defined in src/mongo_types.ts:363
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 src/mongo_types.ts:367
Parameters
- event: string | symbol
- listener: GenericListener
Returns ClientSession

setMaxListeners

setMaxListeners(n: number): ClientSession

Inherited from TypedEventEmitter.setMaxListeners
- Defined in src/mongo_types.ts:416
Parameters
- n: number
Returns ClientSession

startTransaction

startTransaction(options?: TransactionOptions): void

- Defined in src/sessions.ts:375
Starts a new transaction with the given options.

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

toBSON

toBSON(): never

- Defined in src/sessions.ts:447
This is here to ensure that ClientSession is never serialized to BSON.

Returns never

unpin

unpin(options?: { error?: AnyError; force?: boolean; forceClear?: boolean }): void

- Defined in src/sessions.ts:233
internal

Parameters
- Optional options: { error?: AnyError; force?: boolean; forceClear?: boolean }
  - Optional error?: AnyError
  - Optional force?: boolean
  - Optional forceClear?: boolean
Returns void

withTransaction

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

- Defined in src/sessions.ts:462
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.

Type parameters
- T = void
Parameters
- fn: WithTransactionCallback<T>
  
  A lambda to run within a transaction
- Optional options: TransactionOptions
  
  Optional settings for the transaction
Returns Promise<T>

Static getEventListener

getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

Inherited from TypedEventEmitter.getEventListener
- Defined in node_modules/@types/node/events.d.ts:34
Returns a list listener for a specific emitter event name.

Parameters
- emitter: DOMEventTarget | EventEmitter
- name: string | symbol
Returns Function[]

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from TypedEventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:30
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

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

Static once

once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>

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

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

topology: Topology

sessionPool: ServerSessionPool

options: ClientSessionOptions

Optional clientOptions: MongoOptions

Returns ClientSession

Properties

Optional [kPinnedConnection]

Optional [kServerSession]

[kSnapshotEnabled]

Optional [kSnapshotTime]

Optional clientOptions

Optional clusterTime

defaultTransactionOptions

explicit

hasEnded

Optional operationTime

Optional owner

sessionPool

supports

Type declaration

causalConsistency: boolean

topology

transaction

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Accessors

id

Returns undefined | ServerSessionId

isPinned

Returns boolean

loadBalanced

Returns boolean

pinnedConnection

Returns undefined | Connection

serverSession

Returns ServerSession

snapshotEnabled

Returns boolean

Methods

abortTransaction

Returns Promise<Document>

Parameters

callback: Callback<Document>

Returns void

addListener

Type parameters

EventKey: "ended"

Parameters

event: EventKey

listener: ClientSessionEvents[EventKey]

Returns ClientSession

Parameters

event: CommonEvents

listener: (eventName: string | symbol, listener: GenericListener) => void

Parameters

eventName: string | symbol

listener: GenericListener

Returns void

Returns ClientSession

Parameters

event: string | symbol

listener: GenericListener

Returns ClientSession

advanceClusterTime

Parameters

clusterTime: ClusterTime

Returns void

advanceOperationTime

Parameters