Interface
AggregateOptions
Options for SinterCollection.aggregate.
interface AggregateOptions extends QueryBudgetOptionsDefined in packages/driver/src/aggregation.ts:139
Hierarchy
- QueryBudgetOptions
- AggregateOptions
Properties#
batchSize
#readonly batchSize?: numberHow many documents the cursor fetches from the server per round trip.
Defined in packages/driver/src/aggregation.ts:143
maxScanned
#readonly maxScanned?: numberThe most documents the server may examine for the request, counting every document it reads, not only the ones it returns. An index lowers the number. A positive integer.
Inherited from QueryBudgetOptions.maxScanned
Defined in packages/driver/src/budget.ts:28
maxTimeMS
#readonly maxTimeMS?: numberThe most milliseconds the server may spend on the request. The server looks at the clock while it examines documents, so a limit can be passed by a little before the request stops, and a long sort or group is not interrupted once its documents are read. A positive integer.
This is separate from the client's requestTimeoutMS, which gives up
waiting for the answer. Keep requestTimeoutMS larger than maxTimeMS,
or the client may stop waiting first.
Inherited from QueryBudgetOptions.maxTimeMS
Defined in packages/driver/src/budget.ts:22