Class AggregateOperation<T>

internal

Type parameters

T = Document

Hierarchy

CommandOperation<T>
- AggregateOperation

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new AggregateOperation<T>(parent: OperationParent, pipeline: Document[], options?: AggregateOptions): AggregateOperation<T>

Overrides CommandOperation.constructor
- Defined in src/operations/aggregate.ts:48
Type parameters
- T = Document
Parameters
- parent: OperationParent
- pipeline: Document[]
- Optional options: AggregateOptions
Returns AggregateOperation<T>

Properties

[kSession]

[kSession]: ClientSession

Optional bsonOptions

bsonOptions: BSONSerializeOptions

cmd

Optional explain

explain: Explain

Optional fullResponse

fullResponse: boolean

hasWriteStage

hasWriteStage: boolean

Optional logger

logger: Logger

ns

ns: MongoDBNamespace

options

options: AggregateOptions

pipeline

pipeline: Document[]

Optional readConcern

readConcern: ReadConcern

readPreference

readPreference: ReadPreference

server

server: Server

target

target: string | 1

Optional writeConcern

writeConcern: WriteConcern

Accessors

canRetryRead

get canRetryRead(): boolean

- Defined in src/operations/aggregate.ts:86
Returns boolean

canRetryWrite

get canRetryWrite(): boolean

- Defined in src/operations/command.ts:105
Returns boolean

session

get session(): ClientSession

- Defined in src/operations/operation.ts:83
Returns ClientSession

Methods

addToPipeline

addToPipeline(stage: Document): void

- Defined in src/operations/aggregate.ts:90
Parameters
- stage: Document
Returns void

execute

execute(server: Server, session: ClientSession, callback: Callback<T>): void

Overrides CommandOperation.execute
- Defined in src/operations/aggregate.ts:94
Parameters
- server: Server
- session: ClientSession
- callback: Callback<T>
Returns void

executeCommand

executeCommand(server: Server, session: ClientSession, cmd: Document, callback: Callback<any>): void

Inherited from CommandOperation.executeCommand
- Defined in src/operations/command.ts:114
Parameters
- server: Server
- session: ClientSession
- cmd: Document
- callback: Callback<any>
Returns void

hasAspect

hasAspect(aspect: symbol): boolean

Inherited from CommandOperation.hasAspect
- Defined in src/operations/operation.ts:74
Parameters
- aspect: symbol
Returns boolean

Generated using TypeDoc