Class WriteTransactionPendingCursorOperation

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.

Hierarchy

Properties

The collection the receiver is operating on.

query: string

The query the receiver is operating with.

queryArgs: QueryArguments

The named arguments for the query.

Methods

  • Evicts all documents that match the query generated by the preceding function chaining.

    Returns Promise<DocumentID[]>

    An array promise containing the IDs of the documents that were evicted.

  • Executes the query generated by the preceding function chaining and return the list of matching documents.

    Returns Promise<Document[]>

    An array promise containing documents matching the query generated by the preceding function chaining.

  • 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.

    Parameters

    • offset: number

      The number of matching documents that you want the eventual resulting set of matching documents to be offset by (and thus not include).

    Returns WriteTransactionPendingCursorOperation

    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.

    Returns Promise<DocumentID[]>

    An array promise containing the IDs of the documents that were removed.

  • Updates documents that match the query generated by the preceding function chaining.

    Parameters

    • closure: ((documents) => void)

      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.

    Returns Promise<UpdateResultsMap>

    An UpdateResultsMap promise mapping document IDs to lists of update results that describe the updates that were performed for each document.