DittoStore

Provides access to execute Ditto queries, work with DittoCollections and a write transaction API.

Functions

fun addReplicationSubscription(query: String, arguments: Map<String, Any>? = null): DittoReplicationSubscription

Installs and returns a replication subscription for a query, configuring Ditto to receive updates from other peers for documents matching that query. The given query must be a SELECT query, otherwise a DittoError.StoreError with DittoError.StoreErrorReason.QueryNotSupported is thrown.

collection

fun collection(name: String): DittoCollection

Returns a DittoCollection with the provided name.

collectionNames

fun collectionNames(): List<String>

Returns a list of the names of collections in the store.

collections

fun collections(): DittoPendingCollectionsOperation

Returns an object that lets you fetch or observe the collections in the store.

execute

fun execute(query: String, arguments: Map<String, Any?> = mapOf()): DittoQueryResult

Executes a DQL query and returns items as a query result.

get

operator fun get(name: String): DittoCollection

Returns a DittoCollection with the provided name.

queriesHash

fun queriesHash(liveQueries: Array<DittoLiveQuery>): BigInteger

Returns a hash representing the current version of the given queries. When a document matching such queries gets mutated, the hash will change as well.

queriesHashMnemonic

fun queriesHashMnemonic(liveQueries: Array<DittoLiveQuery>): String

Returns a sequence of English words representing the current version of the given queries. When a document matching such queries gets mutated, the words will change as well.

removeReplicationSubscription

fun removeReplicationSubscription(replicationSubscription: DittoReplicationSubscription): Boolean

Removes the given replicationSubscription from the store configuring Ditto to not receive updates for documents matching the corresponding query anymore. No-op if the given replicationSubscription has already been removed.

write

fun write(block: (DittoWriteTransaction) -> Unit): List<DittoWriteTransactionResult>

fun write(handler: DittoWriteTransactionHandler): List<DittoWriteTransactionResult>

Allows you to group multiple operations together that affect multiple documents, potentially across multiple collections.

Properties

replicationSubscriptions

var replicationSubscriptions: Set<DittoReplicationSubscription>

All currently active replication subscriptions in the store.