Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AggregateOptions

Options used to configure aggregate operations.

Hierarchy

  • AggregateOptions

Index

Constructors

constructor

Methods

getAllowDiskUse

  • getAllowDiskUse(): boolean
  • Set the flag if writing to temporary files is enabled.

    Returns boolean

getBatchSize

  • getBatchSize(): number
  • Set the batch size for methods loading found data in batches.

    Returns number

getCollation

  • Optional.

    Specifies the collation to use for the operation.

    Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.

    Returns CollationOptions

getMaxTime

  • getMaxTime(): number
  • Set the time limit in milliseconds for processing operations on a cursor.

    Returns number

setAllowDiskUse

  • Set the flag if writing to temporary files is enabled.

    Parameters

    • allowDiskUse: boolean

    Returns AggregateOptions

setBatchSize

  • Set the batch size for methods loading found data in batches.

    Parameters

    • batchSize: number

    Returns AggregateOptions

setCollation

  • Optional.

    Specifies the collation to use for the operation.

    Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.

    Parameters

    Returns AggregateOptions

setMaxTime

  • Set the time limit in milliseconds for processing operations on a cursor.

    Parameters

    • maxTime: number

    Returns AggregateOptions

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc