Optional authdbOptional bsonfalse
Optional bypassAllow driver to bypass schema validation in MongoDB 3.2 or higher.
Optional checkthe serializer will check if keys are valid.
false
Optional collationCollation
Optional commentComment 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 dbOptional enableEnable utf8 validation when deserializing BSON documents. Defaults to true.
Optional explainSpecifies the verbosity mode for the explain output.
Optional fieldsallow to specify if there what fields we wish to return as unserialized raw buffer.
null
Optional hintAn optional hint for query optimization. See the command reference for more information.
Optional ignoreserialize will not emit undefined fields
note that the driver sets this to false
true
Optional includeReturn the ModifyResult instead of the modified document. Defaults to true but will default to false in the next major version.
Optional letMap of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).
Optional maxOptional noOptional omitOptional projectionLimits the fields to return for all matching documents.
Optional promotewhen deserializing a Binary will return it as a node.js Buffer instance.
false
Optional promotewhen deserializing a Long will fit it into a Number if it's smaller than 53 bits.
true
Optional promotewhen deserializing will promote BSON values to their Node.js closest equivalent types.
true
Optional rawEnabling 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.
Optional readSpecify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
Optional readThe preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).
Optional retryShould retry failed writes
Optional returnWhen set to 'after', returns the updated document rather than the original. The default is 'before'.
Optional serializeserialize the javascript functions
false
Optional sessionSpecify ClientSession for this command
Optional sortDetermines which document the operation modifies if the query selects multiple documents.
Optional upsertUpsert the document if it does not exist.
Optional usewhen deserializing a Long return as a BigInt.
false
Optional willOptional writeWrite Concern as an object
Generated using TypeDoc
return BSON regular expressions as BSONRegExp instances.