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

BroadcastOptions

data class BroadcastOptions(val maxRetries: Int = Int.MAX_VALUE)

BroadcastOptions are the options to create a new broadcast.

enum DocStatus : Enum<Document.DocStatus>

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

@VisibleForTesting

var changeID: ChangeID

val events: SharedFlow<Document.Event>

@VisibleForTesting

val garbageLength: Int

val key: Document.Key

val myPresence: P

val presences: StateFlow<Presences>

var status: Document.DocStatus

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(minSyncedVersionVector: VersionVector): Int

Deletes elements that were removed before the given time.

fun getDocSize(): DocSize

getDocSize returns the size of this document.

getMaxSizePerDocument

fun getMaxSizePerDocument(): Int

getMaxSizePerDocument gets the maximum size of this document.

suspend fun getRoot(): JsonObject

Returns a new proxy of cloned root.

fun getSchemaRules(): List<Rule>

getSchemaRules gets the schema rules of this document.

suspend fun getValueByPath(path: String): JsonElement?

Returns the JsonElement corresponding to the path.

getVersionVector

fun getVersionVector(): VersionVector

getVersionVector returns the version vector of document

suspend fun publishEvent(event: Document.Event)

setMaxSizePerDocument

fun setMaxSizePerDocument(size: Int)

setMaxSizePerDocument sets the maximum size of this document.

fun setSchemaRules(rules: List<Rule>)

setSchemaRules sets the schema rules of this document.

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.