• Public
  • Public/Protected
  • All

Interface MapReduceOptions<TKey, TValue>

Type parameters




Optional authdb

authdb?: string

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 bypassPinningCheck

bypassPinningCheck?: boolean

Optional checkKeys

checkKeys?: boolean

the serializer will check if keys are valid.

Optional collation

collation?: CollationOptions


Optional comment

comment?: string | Document

A user-provided comment to attach to this command

Optional dbName

dbName?: string

Optional explain

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 finalize

finalize?: string | FinalizeFunction<TKey, TValue>

Finalize function.

Optional fullResponse

fullResponse?: boolean

This option does nothing

Optional ignoreUndefined

ignoreUndefined?: boolean

serialize will not emit undefined fields (default:true)

Optional jsMode

jsMode?: boolean

It is possible to make the execution stay in JS. Provided in MongoDB > 2.0.X.

Optional keeptemp

keeptemp?: boolean

Keep temporary data.

Optional limit

limit?: number

Number of objects to return from collection.

Optional maxTimeMS

maxTimeMS?: number

Optional noResponse

noResponse?: boolean

Optional omitReadPreference

omitReadPreference?: boolean

Optional out

out?: "inline" | { inline: 1 } | { replace: string } | { merge: string } | { reduce: string }

Sets the output target for the map reduce job.

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 query

query?: Document

Query filter object.

Optional raw

raw?: boolean

Return BSON filled buffers from operations

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 scope

scope?: Document

Can pass in variables that can be access from map/reduce/finalize.

Optional serializeFunctions

serializeFunctions?: boolean

serialize the javascript functions (default:false).

Optional session

session?: ClientSession

Specify ClientSession for this command

Optional sort

sort?: Sort

Sorts the input objects using this key. Useful for optimization, like sorting by the emit key for fewer reduces.

Optional verbose

verbose?: boolean

Provide statistics on job execution time.

Optional willRetryWrites

willRetryWrites?: boolean

Optional writeConcern

Write Concern as an object

Generated using TypeDoc