Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AggregateOptions

Hierarchy

Index

Properties

Properties

Optional allowDiskUse

allowDiskUse?: boolean

allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

Optional authdb

authdb?: string

Optional batchSize

batchSize?: number

The number of documents to return per batch. See aggregation documentation.

Optional bsonRegExp

bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.

Optional bypassDocumentValidation

bypassDocumentValidation?: boolean

Allow driver to bypass schema validation in MongoDB 3.2 or higher.

Optional checkKeys

checkKeys?: boolean

the serializer will check if keys are valid.

Optional collation

collation?: CollationOptions

Specify collation.

Optional comment

comment?: unknown

Comment to apply to the operation.

In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

In server versions 4.4 and above, 'comment' can be any valid BSON type.

Optional cursor

cursor?: Document

Return the query as cursor, on 2.6 > it returns as a real cursor on pre 2.6 it returns as an emulated cursor.

Optional dbName

dbName?: string

Optional enableUtf8Validation

enableUtf8Validation?: boolean

Enable utf8 validation when deserializing BSON documents. Defaults to true.

Optional explain

explain?: ExplainVerbosityLike

Specifies the verbosity mode for the explain output.

Optional fieldsAsRaw

fieldsAsRaw?: Document

allow to specify if there what fields we wish to return as unserialized raw buffer.

Optional fullResponse

fullResponse?: boolean
deprecated

This option does nothing

Optional hint

hint?: Hint

Add an index selection hint to an aggregation command

Optional ignoreUndefined

ignoreUndefined?: boolean

serialize will not emit undefined fields (default:true)

Optional let

let?: Document

Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).

Optional maxAwaitTimeMS

maxAwaitTimeMS?: number

The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.

Optional maxTimeMS

maxTimeMS?: number

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

Optional noResponse

noResponse?: boolean

Optional omitReadPreference

omitReadPreference?: boolean

Optional out

out?: string

Optional promoteBuffers

promoteBuffers?: boolean

when deserializing a Binary will return it as a node.js Buffer instance.

Optional promoteLongs

promoteLongs?: boolean

when deserializing a Long will fit it into a Number if it's smaller than 53 bits

Optional promoteValues

promoteValues?: boolean

when deserializing will promote BSON values to their Node.js closest equivalent types.

Optional raw

raw?: boolean

Enabling the raw option will return a Node.js Buffer which is allocated using allocUnsafe API. See this section from the Node.js Docs here for more detail about what "unsafe" refers to in this context. If you need to maintain your own editable clone of the bytes returned for an extended life time of the process, it is recommended you allocate your own buffer and clone the contents:

example
const raw = await collection.findOne({}, { raw: true });
const myBuffer = Buffer.alloc(raw.byteLength);
myBuffer.set(raw, 0);
// Only save and use `myBuffer` beyond this point
remarks

Please note there is a known limitation where this option cannot be used at the MongoClient level (see NODE-3946). It does correctly work at Db, Collection, and per operation the same as other BSON options work.

Optional readConcern

readConcern?: ReadConcernLike

Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)

Optional readPreference

readPreference?: ReadPreferenceLike

The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).

Optional retryWrites

retryWrites?: boolean

Should retry failed writes

Optional serializeFunctions

serializeFunctions?: boolean

serialize the javascript functions (default:false).

Optional session

session?: ClientSession

Specify ClientSession for this command

Optional willRetryWrite

willRetryWrite?: boolean

Optional writeConcern

writeConcern?: WriteConcern | WriteConcernSettings

Write Concern as an object

Generated using TypeDoc