yorkie/dev.yorkie.document/Document

Document

class Document(key: String, options: Document.Options = Options()) : Closeable, Attachable

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.

Constructors

Document

constructor(key: String, options: Document.Options = Options())

Types

BroadcastOptions

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

BroadcastOptions are the options to create a new broadcast.

Companion

object Companion

DocumentHistory

interface DocumentHistory

Interface for undo/redo operations on a document.

Event

sealed interface Event : ResourceEvent

Options

data class Options @JvmOverloads constructor(val disableGC: Boolean = false, val disablePresence: Boolean = false, val maxUndoDepth: Int = MaxUndoRedoStackDepth)

Properties

changeID

@VisibleForTesting

var changeID: ChangeID

events

val events: SharedFlow<Document.Event>

garbageLength

@VisibleForTesting

val garbageLength: Int

history

val history: Document.DocumentHistory

Provides undo/redo operations for local user changes in this document. The resulting document changes are synchronized normally.

myPresence

val myPresence: P

presences

val presences: StateFlow<Presences>

Functions

applyStatus

open override fun applyStatus(status: ResourceStatus)

open override fun close()

Releases this document's coroutine scope and dispatcher.

events

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

Subscribes to events on the document with the specific targetPath.

garbageCollect

@VisibleForTesting

fun garbageCollect(minSyncedVersionVector: VersionVector): Int

Deletes elements that were removed before the given time.

getDocSize

fun getDocSize(): DocSize

getDocSize returns the size of this document.

getKey

open override fun getKey(): String

getKey returns the key of this document.

getMaxSizePerDocument

fun getMaxSizePerDocument(): Int

getMaxSizePerDocument gets the maximum size of this document.

getRoot

suspend fun getRoot(): JsonObject

Returns a new proxy of cloned root.

getSchemaRules

fun getSchemaRules(): List<Rule>

getSchemaRules gets the schema rules of this document.

getStatus

open override fun getStatus(): ResourceStatus

getStatus returns the status of this document.

getValueByPath

suspend fun getValueByPath(path: String): JsonElement?

Returns the JsonElement corresponding to the path.

getVersionVector

fun getVersionVector(): VersionVector

getVersionVector returns the version vector of document

hasLocalChanges

open override fun hasLocalChanges(): Boolean

hasLocalChanges returns whether this document has local changes or not.

hasMintedOperations

fun hasMintedOperations(): Boolean

True once this document has queued a change carrying at least one operation -- local, undo/redo, or replayed from a store. Read by dev.yorkie.core.Client to decide whether this document's key takes the per-client pre-attach re-issue claim on attach or on detach. Ports yorkie-js-sdk document.ts's hasMintedOperations() (ed25355e, #1449, yorkie#2111).

isMintable

fun isMintable(): Boolean

True unless a resync has suspended minting on this document (see mintingSuspended) -- i.e. no resync is currently between its discard and its re-anchor. DocumentHistory.canUndo/DocumentHistory.canRedo gate on this in addition to their own stack checks, and updateAsync/undo-redo refuse with YorkieException.Code.ErrRefused via ensureMintableAtEntry while it is false.

metaToBytes

suspend fun metaToBytes(): ByteArray

Serializes just the checkpoint and changeID — plus the compaction epoch and docId — the client's position against the server, without touching the root. Mirrors JS metaToBytes.

publish

open override fun publish(event: ResourceEvent)

publish publishes an event to notify observers about changes in this resource.

publishEvent

suspend fun publishEvent(event: Document.Event)

setActor

open override fun setActor(actorID: String)

Sets actorID into this document. This is also applied in the localChanges the document has.

setMaxSizePerDocument

fun setMaxSizePerDocument(size: Int)

setMaxSizePerDocument sets the maximum size of this document.

setSchemaRules

fun setSchemaRules(rules: List<Rule>)

setSchemaRules sets the schema rules of this document.

toBytes

suspend fun toBytes(): ByteArray

Serializes this document's full restorable state — root, presences, checkpoint, changeID, pending changes, compaction epoch, and docId — into a self-contained byte envelope. The reverse of Companion.fromBytes.

toJson

fun toJson(): String

updateAsync

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

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

Executes the given updater to update this document.