yorkie/dev.yorkie.document/Document

Document

class Document(val key: Document.Key, options: Document.Options = Options(), dispatcher: CoroutineDispatcher = createSingleThreadDispatcher("Document($key)"), snapshotDispatcher: CoroutineDispatcher = dispatcher) : Closeable

A CRDT-based data type. We can represent the model of the application and edit it even while offline.

A single-threaded, Closeable is used as default. Therefore you need to close the document, when the document is no longer needed. If you provide your own dispatcher, it is up to you to decide close is needed or not. snapshotDispatcher can be set differently from dispatcher, as snapshot operation can be much heavier than other operations.

Constructors

constructor(key: Document.Key, options: Document.Options = Options(), dispatcher: CoroutineDispatcher = createSingleThreadDispatcher("Document($key)"), snapshotDispatcher: CoroutineDispatcher = dispatcher)

Types

enum DocumentStatus : Enum<Document.DocumentStatus>

Represents the status of the Document.

interface Event

value class Key(val value: String)

Represents a unique key to identify Document.

data class Options(val disableGC: Boolean = false)

Properties

val events: SharedFlow<Document.Event>

@VisibleForTesting

val garbageLength: Int

val key: Document.Key

val myPresence: P

val presences: StateFlow<Presences>

var status: Document.DocumentStatus

Functions

open override fun close()

fun events(targetPath: String): Flow<Document.Event>

Subscribes to events on the document with the specific targetPath.

@VisibleForTesting

fun garbageCollect(ticket: TimeTicket): Int

Deletes elements that were removed before the given time.

suspend fun getRoot(): JsonObject

Returns a new proxy of cloned root.

getRootThreadSafe

suspend fun getRootThreadSafe(): JsonObject

Returns a new proxy of deep-copied root. It ensures thread-safety by avoiding reuse of clone.

suspend fun getValueByPath(path: String): JsonElement?

Returns the JsonElement corresponding to the path.

suspend fun publishEvent(event: Document.Event)

fun toJson(): String

fun updateAsync(message: String? = null, updater: suspend (root: JsonObject, presence: Presence) -> Unit): Deferred<OperationResult>

Executes the given updater to update this document.