Realm

interface Realm : TypedRealm

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

See also

Types

Companion
Link copied to clipboard
object Companion

Functions

close
Link copied to clipboard
abstract fun close()

Close this Realm and all underlying resources. Accessing any methods or Realm Objects after this method has been called will then an IllegalStateException.

getNumberOfActiveVersions
Link copied to clipboard
abstract fun getNumberOfActiveVersions(): Long

Returns the current number of active versions in the Realm file. A large number of active versions can have a negative impact on the Realm file size on disk.

isClosed
Link copied to clipboard
abstract fun isClosed(): Boolean

Check if this Realm has been closed or not. If the Realm has been closed, most methods will throw IllegalStateException if called.

objects
Link copied to clipboard
abstract override fun <T : RealmObject> objects(clazz: KClass<T>): RealmResults<T>

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

observe
Link copied to clipboard
abstract fun observe(): Flow<Realm>

Observe changes to the Realm. If there is any change to the Realm, the flow will emit the updated Realm. The flow will continue running indefinitely until canceled.

version
Link copied to clipboard
abstract fun version(): VersionId

Returns the Realm version of this object. This version number is tied to the transaction the object was read from.

write
Link copied to clipboard
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
Link copied to clipboard
abstract fun <R> writeBlocking(block: MutableRealm.() -> R): R

Modify the underlying Realm file while blocking the calling thread until the transaction is done. Write transactions automatically commit any changes made when the closure returns unless MutableRealm.cancelWrite was called.

Properties

configuration
Link copied to clipboard
abstract val configuration: RealmConfiguration

Configuration used to configure this Realm instance.