可选2dsphere可选authdb可选background可选bits可选bsonreturn BSON regular expressions as BSONRegExp instances.
可选bucket可选checkthe serializer will check if keys are valid.
可选collationCollation
可选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.
可选commit(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.
可选db可选default_可选enableEnable utf8 validation when deserializing BSON documents. Defaults to true.
可选expireAllows you to expire data on indexes applied to a data (MongoDB 2.2 or higher)
可选explainSpecifies the verbosity mode for the explain output.
可选fieldsallow to specify if there what fields we wish to return as unserialized raw buffer.
可选hiddenSpecifies 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)
可选ignoreserialize will not emit undefined fields (default:true)
可选language_可选maxFor geospatial indexes set the high bound for the co-ordinates.
可选max可选minFor geospatial indexes set the lower bound for the co-ordinates.
可选nameOverride the autogenerated index name (useful if the resulting name is larger than 128 bytes)
可选no可选omit可选partialCreates a partial index based on the given filter object (MongoDB 3.2 or higher)
可选promotewhen deserializing a Binary will return it as a node.js Buffer instance.
可选promotewhen deserializing a Long will fit it into a Number if it's smaller than 53 bits.
可选promotewhen deserializing will promote BSON values to their Node.js closest equivalent types.
可选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.
可选readSpecify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
可选readThe preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).
可选retryShould retry failed writes
可选serializeserialize the javascript functions (default:false).
可选sessionSpecify ClientSession for this command
可选sparseCreates a sparse index.
可选storageAllows users to configure the storage engine on a per-index basis when creating an index. (MongoDB 3.0 or higher)
可选text可选uniqueCreates an unique index.
可选usewhen deserializing a Long will return as a BigInt.
可选versionSpecifies the index version number, either 0 or 1.
可选weights可选wildcard可选will
Creates the index in the background, yielding whenever possible.