Realm

A Realm instance is the main entry point for interacting with a persisted Realm.

Types

Companion

common

common

abstract fun close()

Close this Realm and all underlying resources.

getNumberOfActiveVersions

common

Returns the current number of active versions in the Realm file.

isClosed

common

abstract fun isClosed(): Boolean

Check if this Realm has been closed or not.

objects

common

abstract override fun <T : RealmObject> objects(clazz: KClass<T>): RealmResults<T>

Returns the results of querying for all objects of a specific type.

observe

common

abstract fun observe(): Flow<Realm>

Observe changes to the Realm.

version

common

abstract fun version(): VersionId

Returns the Realm version of this object.

write

common

abstract suspend fun <R> write(block: MutableRealm.() -> R): R

Modify the underlying Realm file in a suspendable transaction on the default Realm Write Dispatcher.

writeBlocking

common

abstract fun <R> writeBlocking(block: MutableRealm.() -> R): R

Modify the underlying Realm file while blocking the calling thread until the transaction is done.

configuration

common

Configuration used to configure this Realm instance.