ditto/live.ditto/DittoWriteTransactionPendingCursorOperation

DittoWriteTransactionPendingCursorOperation

class DittoWriteTransactionPendingCursorOperation

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

Properties

collectionName

val collectionName: String

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

limit

var limit: Int

objectMapper

val objectMapper: ObjectMapper

objectReader

val objectReader: ObjectReader

offset

var offset: Int

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

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. 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 where you would use offset.

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

fun update(updater: DittoMutableDocumentsUpdater): Map<DittoDocumentId, List<DittoUpdateResult>>

Update documents that match the query generated by the preceding function chaining.