Search
Preparing search index...
The search index is not available
mongodb
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
mongodb
AggregateOperation
Class AggregateOperation<T>
Type parameters
T =
Document
Hierarchy
CommandOperation
<
T
>
AggregateOperation
Index
Constructors
constructor
Properties
[k
Session]
bson
Options
bypass
Pinning
Check
cmd
explain
has
Write
Stage
logger
ns
options
pipeline
read
Concern
read
Preference
server
target
try
Secondary
Write
write
Concern
Accessors
can
Retry
Read
can
Retry
Write
session
Methods
add
To
Pipeline
execute
execute
Command
has
Aspect
Constructors
constructor
new
Aggregate
Operation
<
T
>
(
ns
:
MongoDBNamespace
, pipeline
:
Document
[]
, options
?:
AggregateOptions
)
:
AggregateOperation
<
T
>
Type parameters
T =
Document
Parameters
ns:
MongoDBNamespace
pipeline:
Document
[]
Optional
options:
AggregateOptions
Returns
AggregateOperation
<
T
>
Properties
[k
Session]
[k
Session]
:
ClientSession
Optional
bson
Options
bson
Options
?:
BSONSerializeOptions
bypass
Pinning
Check
bypass
Pinning
Check
:
boolean
cmd
cmd
:
Document
Optional
explain
explain
?:
Explain
has
Write
Stage
has
Write
Stage
:
boolean
Optional
logger
logger
?:
Logger
ns
ns
:
MongoDBNamespace
options
options
:
AggregateOptions
pipeline
pipeline
:
Document
[]
Optional
read
Concern
read
Concern
?:
ReadConcern
read
Preference
read
Preference
:
ReadPreference
server
server
:
Server
target
target
:
string
|
1
try
Secondary
Write
try
Secondary
Write
:
boolean
Optional
write
Concern
write
Concern
?:
WriteConcern
Accessors
can
Retry
Read
get
canRetryRead
(
)
:
boolean
Returns
boolean
can
Retry
Write
get
canRetryWrite
(
)
:
boolean
Returns
boolean
session
get
session
(
)
:
ClientSession
Returns
ClientSession
Methods
add
To
Pipeline
add
To
Pipeline
(
stage
:
Document
)
:
void
Parameters
stage:
Document
Returns
void
execute
execute
(
server
:
Server
, session
:
ClientSession
, callback
:
Callback
<
T
>
)
:
void
Parameters
server:
Server
session:
ClientSession
callback:
Callback
<
T
>
Returns
void
execute
Command
execute
Command
(
server
:
Server
, session
:
ClientSession
, cmd
:
Document
, callback
:
Callback
<
any
>
)
:
void
Parameters
server:
Server
session:
ClientSession
cmd:
Document
callback:
Callback
<
any
>
Returns
void
has
Aspect
has
Aspect
(
aspect
:
symbol
)
:
boolean
Parameters
aspect:
symbol
Returns
boolean
Exports
Aggregate
Operation
constructor
[k
Session]
bson
Options
bypass
Pinning
Check
cmd
explain
has
Write
Stage
logger
ns
options
pipeline
read
Concern
read
Preference
server
target
try
Secondary
Write
write
Concern
can
Retry
Read
can
Retry
Write
session
add
To
Pipeline
execute
execute
Command
has
Aspect
Generated using
TypeDoc