Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/hex/src/lib/data/deps.ts>mongo.AggregateOptions

An ecosystem delivering practices, philosophy and portability. Powered By Deno and JavaScript.
Latest
interface mongo.AggregateOptions
import { type mongo } from "https://deno.land/x/hex@0.6.5/src/lib/data/deps.ts";
const { AggregateOptions } = mongo;

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