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.
getNumberOfActiveVersions
Link copied to clipboard
abstract fun getNumberOfActiveVersions(): Long
Returns the current number of active versions in the Realm file.
isClosed
Link copied to clipboard
abstract fun isClosed(): Boolean
Check if this Realm has been closed or not.
observe
Link copied to clipboard
abstract fun observe(): Flow<Realm>
Observe changes to the realm.
query
Link copied to clipboard
abstract override fun <T : RealmObject> query(clazz: KClass<T>, query: String, vararg args: Any?): RealmQuery<T>
Returns a RealmQuery matching the predicate represented by query.
schema
Link copied to clipboard
abstract fun schema(): RealmSchema
Returns an immutable schema of the realm.
version
Link copied to clipboard
abstract fun version(): VersionId
Returns the Realm version of this object.
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.

Properties

configuration
Link copied to clipboard
abstract val configuration: Configuration
Configuration used to configure this Realm instance.

Extensions

query
Link copied to clipboard
inline fun <T : RealmObject> Realm.query(query: String = "TRUEPREDICATE", vararg args: Any?): RealmQuery<T>
Returns a RealmQuery matching the predicate represented by query.