Realm

interface Realm : TypedRealm

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

Types

Companion

object Companion

Functions

asFlow

abstract fun asFlow(): Flow<RealmChange<Realm>>

Observe changes to the realm.

abstract fun close()

Close this realm and all underlying resources.

copyFromRealm

abstract fun <T : TypedRealmObject> copyFromRealm(obj: T, depth: UInt = UInt.MAX_VALUE): T

Makes an unmanaged in-memory copy of an already persisted io.realm.kotlin.types.RealmObject.

abstract fun <T : TypedRealmObject> copyFromRealm(dictionary: RealmDictionary<T?>, depth: UInt = UInt.MAX_VALUE): Map<String, T?>

Makes an unmanaged in-memory copy of a RealmDictionary of already persisted io.realm.kotlin.types.RealmObjects.

abstract fun <T : TypedRealmObject> copyFromRealm(collection: Iterable<T>, depth: UInt = UInt.MAX_VALUE): List<T>

Makes an unmanaged in-memory copy of a collection of already persisted io.realm.kotlin.types.RealmObjects.

getNumberOfActiveVersions

abstract fun getNumberOfActiveVersions(): Long

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

isClosed

abstract fun isClosed(): Boolean

Check if this Realm has been closed or not.

query

abstract override fun <T : BaseRealmObject> query(clazz: KClass<T>, query: String, vararg args: Any?): RealmQuery<T>

Returns a RealmQuery matching the predicate represented by query.

schema

abstract fun schema(): RealmSchema

Returns an immutable schema of the realm.

schemaVersion

abstract fun schemaVersion(): Long

Returns the schema version of the realm.

version

abstract fun version(): VersionId

Returns the Realm version of this object.

write

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

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

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

writeCopyTo

abstract fun writeCopyTo(targetConfiguration: Configuration)

Writes a compacted copy of the Realm to the given destination as defined by the targetConfiguration.

Properties

configuration

abstract val configuration: Configuration

Configuration used to configure this Realm instance.

Extensions