ditto/live.ditto/DittoStore

DittoStore

class DittoStore

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

Types

Companion

object Companion

Properties

attachmentFetchers

var attachmentFetchers: Set<DittoAttachmentFetcher>

All currently active attachment fetchers.

observers

var observers: Set<DittoStoreObserver>

All currently active store observers.

Functions

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

@JvmOverloads

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

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

executeBlocking

@JvmName(name = "execute")

@JvmOverloads

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

Non-suspend version of execute. Provides a simpler API to Java where Kotlin Coroutines are not typically used.

fetchAttachment

fun fetchAttachment(tokenMap: Map<String, Any>, onFetchEvent: (DittoAttachmentFetchEvent) -> Unit): DittoAttachmentFetcher

fun fetchAttachment(tokenMap: Map<String, Any>, fetchEventHandler: DittoAttachmentFetchEventHandler): DittoAttachmentFetcher

fun fetchAttachment(token: DittoAttachmentToken, onFetchEvent: (DittoAttachmentFetchEvent) -> Unit): DittoAttachmentFetcher

fun fetchAttachment(token: DittoAttachmentToken, fetchEventHandler: DittoAttachmentFetchEventHandler): DittoAttachmentFetcher

Trigger an attachment to be downloaded locally to the device and observe its progress as it does so.

get

operator fun get(name: String): DittoCollection

Returns a DittoCollection with the provided name.

newAttachment

@JvmOverloads

suspend fun newAttachment(inputStream: InputStream, metadata: Map<String, String> = emptyMap()): DittoAttachment

@JvmOverloads

suspend fun newAttachment(path: String, metadata: Map<String, String> = emptyMap()): DittoAttachment

Creates a new attachment, which can then be inserted into a document.

newAttachmentBlocking

@JvmName(name = "newAttachment")

@JvmOverloads

fun newAttachmentBlocking(inputStream: InputStream, metadata: Map<String, String> = emptyMap()): DittoAttachment

@JvmName(name = "newAttachment")

@JvmOverloads

fun newAttachmentBlocking(path: String, metadata: Map<String, String> = emptyMap()): DittoAttachment

Non-suspend version of newAttachment. Provides a simpler API to Java where Kotlin Coroutines are not typically used.

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.

registerObserver

@JvmOverloads

fun registerObserver(query: String, arguments: Map<String, Any?>? = null, changeHandler: DittoChangeHandler): DittoStoreObserver

Convenience method, same as registerObserver where signalNext is called automatically after the changeHandler finishes.

fun registerObserver(query: String, arguments: Map<String, Any?>? = null, changeHandler: DittoChangeHandlerWithNextSignal): DittoStoreObserver

Installs and returns a store observer for a query, configuring Ditto to trigger the passed in change handler whenever documents in the local store change such that the result of the matching query changes. The passed in query must be a SELECT query, otherwise a StoreError with QueryNotSupported reason is thrown.

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.