Readonly collectionThe collection the receiver is operating on.
Readonly queryThe query the receiver is operating with.
Readonly queryThe named arguments for the query.
Evicts all documents that match the query generated by the preceding function chaining.
An array promise containing the IDs of the documents that were evicted.
Limits the number of documents that get returned when querying a collection for matching documents.
The maximum number of documents that will be returned.
A cursor that you can chain further function calls and then either get the matching documents immediately or get updates about them over time.
Offsets the resulting set of matching documents.
This is useful if you aren't interested in the first N matching documents
for one reason or another. For example, you might already have queried the
collection and obtained the first 20 matching documents and so you might
want to run the same query as you did previously but ignore the first 20
matching documents, and that is when you would use offset.
The number of matching documents that you want the eventual resulting set of matching documents to be offset by (and thus not include).
A cursor that you can chain further function calls and then either get the matching documents immediately or get updates about them over time.
Removes all documents that match the query generated by the preceding function chaining.
An array promise containing the IDs of the documents that were removed.
Sorts the documents that match the query provided in the preceding
find-like function call.
Documents that are missing the field to sort by will appear at the beginning of the results when sorting in ascending order.
Name or path of the field to sort by.
Optional direction: SortDirectionSpecify whether you want the sorting order to be
ascending or descending. Defaults to ascending.
A cursor that you can chain further function calls and then either get the matching documents immediately or get updates about them over time.
Updates documents that match the query generated by the preceding function chaining.
Document values must not be set to any non-finite numbers (NaN,
Infinity, -Infinity).
A closure that gets called with all of the documents matching the query. The documents are instances of MutableDocument so you can call update-related functions on them.
An UpdateResultsMap promise mapping document IDs to lists of update results that describe the updates that were performed for each document.
These objects are returned when using
find-like functionality on Collection.They allow chaining of further query-related functions to do things like add a limit to the number of documents you want returned or specify how you want the documents to be sorted and ordered.
You can call exec() on the cursor to get an array of documents or you can use methods for updating, removing or evicting any matching documents.
Live queries and subscriptions are only available outside of transactions.