Optional
authdbOptional
autoOptional
bsonreturn BSON regular expressions as BSONRegExp instances.
false
Optional
cappedCreate a capped collection
Optional
changeIf set, enables pre-update and post-update document events to be included for any change streams that listen on this collection.
Optional
checkthe serializer will check if keys are valid.
false
Optional
clusteredA document specifying configuration options for clustered collections. For MongoDB 5.3 and above.
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
Experimental
encryptedOptional
expireThe number of seconds after which a document in a timeseries or clustered collection expires.
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
flagsAvailable for the MMAPv1 storage engine only to set the usePowerOf2Sizes and the noPadding flag
Optional
ignoreserialize will not emit undefined fields
note that the driver sets this to false
true
Optional
indexAllows users to specify a default configuration for indexes when creating a collection
Optional
maxThe maximum number of documents in the capped collection
Optional
maxOptional
noOptional
omitOptional
pipelineAn array that consists of the aggregation pipeline stage. Creates the view by applying the specified pipeline to the viewOn collection or view
Optional
pkA primary key factory function for generation of custom _id keys.
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
serializeserialize the javascript functions
false
Optional
sessionSpecify ClientSession for this command
Optional
sizeThe size of the capped collection in bytes
Optional
storageAllows users to specify configuration to the storage engine on a per-collection basis when creating a collection
Optional
timeseriesA document specifying configuration options for timeseries collections.
Optional
usewhen deserializing a Long return as a BigInt.
false
Optional
validationDetermines whether to error on invalid documents or just warn about the violations but allow invalid documents to be inserted
Optional
validationDetermines how strictly MongoDB applies the validation rules to existing documents during an update
Optional
validatorAllows users to specify validation rules or expressions for the collection. For more information, see Document Validation
Optional
viewThe name of the source collection or view from which to create the view. The name is not the full namespace of the collection or view (i.e., does not include the database name and implies the same database as the view to create)
Optional
willOptional
writeWrite Concern as an object
Generated using TypeDoc
Deprecated
Create an index on the _id field of the document. This option is deprecated in MongoDB 3.2+ and will be removed once no longer supported by the server.