Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MapReduceOptions<TKey, TValue>

Type parameters

Hierarchy

Index

Properties

authdb?: string
bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.

bypassDocumentValidation?: boolean

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

checkKeys?: boolean

the serializer will check if keys are valid.

collation?: CollationOptions

Collation

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.

dbName?: string
enableUtf8Validation?: boolean

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

Specifies the verbosity mode for the explain output.

fieldsAsRaw?: Document

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

finalize?: string | FinalizeFunction<TKey, TValue>

Finalize function.

fullResponse?: boolean
deprecated

This option does nothing

ignoreUndefined?: boolean

serialize will not emit undefined fields (default:true)

jsMode?: boolean

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

keeptemp?: boolean

Keep temporary data.

limit?: number

Number of objects to return from collection.

maxTimeMS?: number
noResponse?: boolean
omitReadPreference?: boolean
out?: "inline" | { inline: 1 } | { replace: string } | { merge: string } | { reduce: string }

Sets the output target for the map reduce job.

promoteBuffers?: boolean

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

promoteLongs?: boolean

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

promoteValues?: boolean

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

query?: Document

Query filter object.

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.

readConcern?: ReadConcernLike

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

readPreference?: ReadPreferenceLike

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

retryWrites?: boolean

Should retry failed writes

scope?: Document

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

serializeFunctions?: boolean

serialize the javascript functions (default:false).

session?: ClientSession

Specify ClientSession for this command

sort?: Sort

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

verbose?: boolean

Provide statistics on job execution time.

willRetryWrite?: boolean

Write Concern as an object

Generated using TypeDoc