DittoWriteTransactionPendingCursorOperation

class DittoWriteTransactionPendingCursorOperation

These objects are returned when using findByID functionality on DittoScopedWriteTransactions. You can use them to perform updates on a document and remove or evict a document.

Functions

evict
Link copied to clipboard
fun evict(): List<DittoDocumentID>
Evict all documents that match the query generated by the preceding function chaining.
exec
Link copied to clipboard
fun exec(): List<DittoDocument>
Execute the query generated by the preceding function chaining and return the list of matching documents.
limit
Link copied to clipboard
fun limit(limit: Int): DittoWriteTransactionPendingCursorOperation
Limit the number of documents that get returned when querying a collection for matching documents.
offset
Link copied to clipboard
fun offset(offset: Int): DittoWriteTransactionPendingCursorOperation
Offset the resulting set of matching documents.
remove
Link copied to clipboard
fun remove(): List<DittoDocumentID>
Remove all documents that match the query generated by the preceding function chaining.
sort
Link copied to clipboard
fun sort(query: String, direction: DittoSortDirection): DittoWriteTransactionPendingCursorOperation
Sort the documents that match the query provided in the preceding find-like function call.
update
Link copied to clipboard
fun update(closure: (List<DittoMutableDocument>) -> Unit): Map<DittoDocumentID, List<DittoUpdateResult>>
Update documents that match the query generated by the preceding function chaining.
fun update(updater: DittoMutableDocumentsUpdater): Map<DittoDocumentID, List<DittoUpdateResult>>
Update documents that match the query generated by the preceding function chaining.

Properties

collectionName
Link copied to clipboard
val collectionName: String
the name of the collection that the operation will be performed on.
dittoHandle
Link copied to clipboard
val dittoHandle: SWIGTYPE_p_CDitto
limit
Link copied to clipboard
var limit: Int
objectMapper
Link copied to clipboard
val objectMapper: ObjectMapper
objectReader
Link copied to clipboard
val objectReader: ObjectReader
offset
Link copied to clipboard
var offset: Int = 0
orderByDefinitions
Link copied to clipboard
var orderByDefinitions: MutableList<COrderByParam_t>
query
Link copied to clipboard
val query: String
the query to be used to find matching documents.
queryArgs
Link copied to clipboard
val queryArgs: Map<String, Any?>?
writeTxn
Link copied to clipboard
val writeTxn: SWIGTYPE_p_CWriteTransaction