OptionalarrayOptionalauthdbOptionalbsonreturn BSON regular expressions as BSONRegExp instances.
OptionalbypassIf true, allows the write to opt-out of document level validation
Optionalcheckthe serializer will check if keys are valid.
OptionalcollationSpecifies a collation
OptionalcommentComment 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.
OptionaldbOptionalenableEnable utf8 validation when deserializing BSON documents. Defaults to true.
OptionalexplainSpecifies the verbosity mode for the explain output.
Optionalfieldsallow to specify if there what fields we wish to return as unserialized raw buffer.
OptionalhintSpecify that the update query should only consider plans using the hinted index
Optionalignoreserialize will not emit undefined fields
note that the driver sets this to false
OptionalletMap of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).
OptionalmaxmaxTimeMS is a server-side time limit in milliseconds for processing an operation.
OptionalnoOptionalomitOptionalpromotewhen deserializing a Binary will return it as a node.js Buffer instance.
Optionalpromotewhen deserializing a Long will fit it into a Number if it's smaller than 53 bits.
Optionalpromotewhen deserializing will promote BSON values to their Node.js closest equivalent types.
OptionalrawEnabling 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:
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
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.
OptionalreadSpecify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
OptionalreadThe preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).
OptionalretryShould retry failed writes
Optionalserializeserialize the javascript functions
OptionalsessionSpecify ClientSession for this command
Optional ExperimentaltimeoutMSSpecifies the time an operation will run until it throws a timeout error
OptionalupsertWhen true, creates a new document if no document matches the query
Optionalusewhen deserializing a Long return as a BigInt.
OptionalwillOptionalwriteWrite Concern as an object
A set of filters specifying to which array elements an update should apply