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

fun evict(): List<DittoDocumentID>

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

exec

fun exec(): List<DittoDocument>

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

limit

fun limit(limit: Int): DittoWriteTransactionPendingCursorOperation

Limit the number of documents that get returned when querying a collection for matching documents.

offset

fun offset(offset: Int): DittoWriteTransactionPendingCursorOperation

Offset the resulting set of matching documents.

remove

fun remove(): List<DittoDocumentID>

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

sort

fun sort(query: String, direction: DittoSortDirection): DittoWriteTransactionPendingCursorOperation

Sort the documents that match the query provided in the preceding find-like function call.

update

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

val collectionName: String

the name of the collection that the operation will be performed on.

dittoHandle

val dittoHandle: SWIGTYPE_p_CDitto

limit

var limit: Int

objectMapper

val objectMapper: ObjectMapper

objectReader

val objectReader: ObjectReader

offset

var offset: Int = 0

orderByDefinitions

var orderByDefinitions: MutableList<COrderByParam_t>

query

val query: String

the query to be used to find matching documents.

queryArgs

val queryArgs: Map<String, Any?>?

writeTxn

val writeTxn: SWIGTYPE_p_CWriteTransaction