For 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.
Specify if the cursor is a a tailable-await cursor. Requires tailable to be true
Set the batchSize for the getMoreCommand when iterating over the query results.
return BSON regular expressions as BSONRegExp instances.
the serializer will check if keys are valid.
Specify collation (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields).
You can put a $comment field on a query to make looking in the profiler logs simpler.
Specifies the verbosity mode for the explain output.
allow to specify if there what fields we wish to return as unserialized raw buffer.
Return the full server response for the command
Tell the query to use specific indexes in the query. Object of indexes to use, {'_id':1}
serialize will not emit undefined fields (default:true)
Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).
Sets the limit of documents returned in the query.
The exclusive upper bound for a specific index
The 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
Number of milliseconds to wait before aborting the query.
The inclusive lower bound for a specific index
The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.
The 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}
when deserializing a Binary will return it as a node.js Buffer instance.
when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).
Should retry failed writes
If true, returns only the index keys in the resulting documents.
serialize the javascript functions (default:false).
Specify ClientSession for this command
Determines whether to return the record identifier for each document. If true, adds a field $recordId to the returned documents.
Determines whether to close the cursor after the first batch. Defaults to false.
Set to skip N documents ahead in your query (useful for pagination).
Set to sort the documents coming back from the query. Array of indexes, [['a', 1]] etc.
Specify if the cursor is tailable.
Specify if the cursor can timeout.
Write Concern as an object
Generated using TypeDoc
Allows disk use for blocking sort operations exceeding 100MB memory. (MongoDB 3.2 or higher)