These objects are returned when using DittoScopedWriteTransaction.Find(string), DittoScopedWriteTransaction.Find(string, Dictionary<string, object>), or DittoScopedWriteTransaction.FindAll.
More...
◆ Evict()
unsafe List< DittoDocumentID > DittoSDK.DittoWriteTransactionPendingCursorOperation.Evict |
( |
| ) |
|
|
inline |
Evict all documents that match the query generated by the preceding function chaining.
- Returns
- A list containing the IDs of the documents that were evicted.
◆ Exec()
unsafe List< DittoDocument > DittoSDK.DittoWriteTransactionPendingCursorOperation.Exec |
( |
| ) |
|
|
inline |
Execute the query generated by the preceding function chaining and return the list of matching documents.
- Returns
- A list of DittoDocument objects matching the query generated by the preceding function chaining.
◆ Limit()
Limit the number of documents that get returned when querying a collection for matching documents.
- Parameters
-
limit | The maximum number of documents that will be returned. |
- Returns
- A
DittoWriteTransactionPendingCursorOperation
that you can chain further function calls to.
◆ Offset()
Offset 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(uint).
- Parameters
-
offset | The number of matching documents that you want the eventual resulting set of matching documents to be offset by (and thus not include). |
- Returns
- A
DittoWriteTransactionPendingCursorOperation
that you can chain further function calls to.
◆ Remove()
unsafe List< DittoDocumentID > DittoSDK.DittoWriteTransactionPendingCursorOperation.Remove |
( |
| ) |
|
|
inline |
Remove all documents that match the query generated by the preceding function chaining.
- Returns
- A list containing the IDs of the documents that were removed.
◆ Sort()
Sort the documents that match the query provided in the preceding find
-like function call.
- Parameters
-
query | The query specifies the logic to be used when sorting the matching documents. |
direction | Specify whether you want the sorting order to be ascending or descending. |
- Returns
- A
DittoWriteTransactionPendingCursorOperation
that you can chain further function calls to.
◆ Update()
Update documents that match the query generated by the preceding function chaining.
- Parameters
-
updater | A block that gets called with all of the documents matching the query. The documents are DittoMutableDocument objects so you can call update-related functions on them. |
- Returns
- A dictionary mapping document IDs to lists of DittoUpdateResult that describes the updates that were performed for each document.