ditto-lib / live.ditto / DittoWriteTransactionPendingIDSpecificOperation

DittoWriteTransactionPendingIDSpecificOperation

class DittoWriteTransactionPendingIDSpecificOperation

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.

Properties

collectionName

val collectionName: String

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

dittoHandle

val dittoHandle: SWIGTYPE_p_Ditto

docID

val docID: String

the ID of the document that the operation will be performed on.

objectMapper

val objectMapper: ObjectMapper

objectReader

val objectReader: ObjectReader

writeTxn

val writeTxn: SWIGTYPE_p_Ditto_WriteTransaction

Functions

evict

fun evict(): Boolean

Evict the document with the matching ID.

remove

fun remove(): Boolean

Remove the document with the matching ID.

update

fun update(closure: (DittoMutableDocument?) -> Unit): List<DittoUpdateResult>
fun update(updater: DittoSingleMutableDocumentUpdater): List<DittoUpdateResult>

Update the document with the matching ID.