Optional2dsphereOptionalauthdbOptionalbackgroundOptionalbitsOptionalbsonreturn BSON regular expressions as BSONRegExp instances.
OptionalbucketOptionalcheckthe serializer will check if keys are valid.
OptionalcollationCollation
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.
Optionalcommit(MongoDB 4.4. or higher) Specifies how many data-bearing members of a replica set, including the primary, must complete the index builds successfully before the primary marks the indexes as ready. This option accepts the same values for the "w" field in a write concern plus "votingMembers", which indicates all voting data-bearing nodes.
OptionaldbOptionaldefault_OptionalenableEnable utf8 validation when deserializing BSON documents. Defaults to true.
OptionalexpireAllows you to expire data on indexes applied to a data (MongoDB 2.2 or higher)
OptionalexplainSpecifies the verbosity mode for the explain output.
Optionalfieldsallow to specify if there what fields we wish to return as unserialized raw buffer.
OptionalhiddenSpecifies that the index should exist on the target collection but should not be used by the query planner when executing operations. (MongoDB 4.4 or higher)
Optionalignoreserialize will not emit undefined fields
note that the driver sets this to false
Optionallanguage_OptionalmaxFor geospatial indexes set the high bound for the co-ordinates.
OptionalmaxmaxTimeMS is a server-side time limit in milliseconds for processing an operation.
OptionalminFor geospatial indexes set the lower bound for the co-ordinates.
OptionalnameOverride the autogenerated index name (useful if the resulting name is larger than 128 bytes)
OptionalnoOptionalomitOptionalpartialCreates a partial index based on the given filter object (MongoDB 3.2 or higher)
Optionalpromotewhen 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
OptionalsparseCreates a sparse index.
OptionalstorageAllows users to configure the storage engine on a per-index basis when creating an index. (MongoDB 3.0 or higher)
OptionaltextOptional ExperimentaltimeoutMSSpecifies the time an operation will run until it throws a timeout error
OptionaluniqueCreates an unique index.
Optionalusewhen deserializing a Long return as a BigInt.
OptionalversionSpecifies the index version number, either 0 or 1.
OptionalweightsOptionalwildcardOptionalwill
Creates the index in the background, yielding whenever possible.