Optional
authdbOptional
bsonreturn BSON regular expressions as BSONRegExp instances.
false
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
ignoreserialize will not emit undefined fields
note that the driver sets this to false
true
Optional
maxSpecifies the maximum amount of time to allow a commit action on a transaction to run in milliseconds
Optional
maxOptional
noOptional
omitOptional
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
readA default read concern for commands in this transaction
Optional
readA default read preference for commands in this transaction
Optional
retryShould retry failed writes
Optional
serializeserialize the javascript functions
false
Optional
sessionSpecify ClientSession for this command
Optional
usewhen deserializing a Long return as a BigInt.
false
Optional
willOptional
writeA default writeConcern for commands in this transaction
Generated using TypeDoc
Configuration options for a transaction.