OptionalallowAllows disk use for blocking sort operations exceeding 100MB memory. (MongoDB 3.2 or higher)
OptionalallowFor queries against a sharded collection, allows the command (or subsequent getMore commands) to return partial results, rather than an error, if one or more queried shards are unavailable.
OptionalauthdbOptionalawaitSpecify if the cursor is a tailable-await cursor. Requires tailable to be true
OptionalbatchSet the batchSize for the getMoreCommand when iterating over the query results.
Optionalbsonreturn BSON regular expressions as BSONRegExp instances.
Optionalcheckthe serializer will check if keys are valid.
OptionalcollationSpecify collation (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields).
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.
OptionaldbOptionalenableEnable utf8 validation when deserializing BSON documents. Defaults to true.
OptionalexplainSpecifies the verbosity mode for the explain output.
Optionalfieldsallow to specify if there what fields we wish to return as unserialized raw buffer.
OptionalhintTell the query to use specific indexes in the query. Object of indexes to use, {'_id':1}
Optionalignoreserialize will not emit undefined fields
note that the driver sets this to false
OptionalletMap of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).
OptionallimitSets the limit of documents returned in the query.
OptionalmaxThe exclusive upper bound for a specific index
OptionalmaxThe maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. Requires tailable and awaitData to be true
OptionalmaxNumber of milliseconds to wait before aborting the query.
OptionalminThe inclusive lower bound for a specific index
OptionalnoThe server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.
OptionalnoOptionalomitOptionaloplogOption to enable an optimized code path for queries looking for a particular range of ts values in the oplog. Requires tailable to be true.
OptionalprojectionThe fields to return in the query. Object of fields to either include or exclude (one of, not both), {'a':1, 'b': 1} or {'a': 0, 'b': 0}
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
OptionalreturnIf true, returns only the index keys in the resulting documents.
Optionalserializeserialize the javascript functions
OptionalsessionSpecify ClientSession for this command
OptionalshowDetermines whether to return the record identifier for each document. If true, adds a field $recordId to the returned documents.
OptionalsingleDetermines whether to close the cursor after the first batch. Defaults to false.
OptionalskipSet to skip N documents ahead in your query (useful for pagination).
OptionalsortSet to sort the documents coming back from the query. Array of indexes, [['a', 1]] etc.
OptionaltailableSpecify if the cursor is tailable.
OptionaltimeoutSpecify if the cursor can timeout.
Optionalusewhen deserializing a Long return as a BigInt.
Optionalwill
Unused schema definition, deprecated usage, only specify
FindOptionswith no generic