AggregateQueryBuilder
Value members
Concrete methods
Enables writing to temporary files. A null value indicates that it's unspecified.
Enables writing to temporary files. A null value indicates that it's unspecified.
- Value Params
- allowDiskUse
true if writing to temporary files is enabled
- Returns
AggregateQueryBuilder
Sets the number of documents to return per batch.
Sets the number of documents to return per batch.
Overrides the Subscription#request value for setting the batch size, allowing for fine grained control over the underlying cursor.
- Value Params
- batchSize
the batch size
- Returns
AggregateQueryBuilder
- Since
1.8
Sets the bypass document level validation flag.
Sets the bypass document level validation flag.
Note: This only applies when an $out stage is specified.
- Value Params
- bypassDocumentValidation
If true, allows the write to opt-out of document level validation.
- Returns
AggregateQueryBuilder
- Since
1.2
Sets the collation options
Sets the collation options
A null value represents the server default.
- Value Params
- collation
the collation options to use
- Returns
AggregateQueryBuilder
- Since
1.3
Sets the comment to the aggregation.
Sets the comment to the aggregation.
- Value Params
- comment
the comment
- Returns
AggregateQueryBuilder
- Since
1.7
Explain the execution plan for this operation with the server's default verbosity level
Explain the execution plan for this operation with the server's default verbosity level
- Returns
the execution plan
- Since
4.2
Explain the execution plan for this operation with the given verbosity level
Explain the execution plan for this operation with the given verbosity level
- Value Params
- verbosity
the verbosity of the explanation
- Returns
the execution plan
- Since
4.2
Sets the hint for which index to use.
Sets the hint for which index to use.
- Value Params
- hint
the hint
- Returns
AggregateQueryBuilder
- Since
1.7
Add top-level variables to the aggregation.
Add top-level variables to the aggregation.
For MongoDB 5.0+, the aggregate command accepts a let option. This option is a
document consisting of zero or more fields representing variables that are accessible to the aggregation pipeline. The key is the name
of the variable and the value is a constant in the aggregate expression language. Each parameter name is then usable to access the
value of the corresponding expression with the "$$" syntax within aggregate expression contexts which may require the use of $expr
or a pipeline.
- Value Params
- variables
the variables
- Returns
AggregateQueryBuilder
- Since
4.3
The maximum amount of time for the server to wait on new documents to satisfy a $changeStream aggregation.
The maximum amount of time for the server to wait on new documents to satisfy a $changeStream aggregation.
A zero value will be ignored.
- Value Params
- duration
the max await time
- Returns
the maximum await execution time in the given time unit
- Since
1.6
Sets the maximum execution time on the server for this operation.
Sets the maximum execution time on the server for this operation.
- Value Params
- duration
the max time
- Returns
AggregateQueryBuilder