ditto/live.ditto/DittoScopedWriteTransaction

DittoScopedWriteTransaction

class DittoScopedWriteTransaction(baseTransaction: DittoWriteTransaction, val collectionName: String)

DittoScopedWriteTransaction exposes functionality that allows you to perform multiple operations on the store within a single write transaction.

Constructors

fun DittoScopedWriteTransaction(baseTransaction: DittoWriteTransaction, collectionName: String)

Functions

find

fun find(query: String): DittoWriteTransactionPendingCursorOperation

fun find(query: String, queryArgs: Map<String, Any?>): DittoWriteTransactionPendingCursorOperation

Generates a DittoWriteTransactionPendingCursorOperation with the provided query that can be used to update, remove, or evict documents.

findAll

fun findAll(): DittoWriteTransactionPendingCursorOperation

Generates a DittoWriteTransactionPendingCursorOperation that can be used to update, remove or evict documents.

findById

fun findById(id: DittoDocumentId): DittoWriteTransactionPendingIdSpecificOperation

Generates a DittoWriteTransactionPendingIdSpecificOperation with the provided document identifier that can be used to update, remove, or evict the document.

upsert

@JvmOverloads

fun <T : Any> upsert(value: T, writeStrategy: DittoWriteStrategy = DittoWriteStrategy.Merge): DittoDocumentId

Inserts a new document into the collection and returns its identifier. If the document already exists, the behavior is determined by the given writeStrategy.

Properties

collectionName

val collectionName: String

the name of the collection that the scoped write transaction is scoped to.