Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/mongo/src/types.ts>AggregateOptions

MongoDB driver for Deno
Extremely Popular
Go to Latest
interface AggregateOptions
import { type AggregateOptions } from "https://deno.land/x/mongo@v0.31.1/src/types.ts";

Properties

optional
readPreference: string

The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).

optional
batchSize: number
optional
explain: boolean
optional
allowDiskUse: boolean
optional
maxTimeMS: number

maxTimeMS specifies a cumulative time limit in milliseconds for processing operations on the cursor. MongoDB interrupts the operation at the earliest following interrupt point.

optional
bypassDocumentValidation: boolean
optional
raw: boolean
optional
promoteLongs: boolean
optional
promoteValues: boolean
optional
promoteBuffers: boolean
optional
collation: Document

Specify collation settings for operation. See aggregation documentation(https://docs.mongodb.com/manual/reference/command/aggregate).

optional
comment: string

Add a comment to an aggregation command

optional
hint: string | Document

Add an index selection hint to an aggregation command