Realm Kotlin SDK/io.realm.kotlin.dynamic/DynamicRealm

DynamicRealm

A dynamic realm gives access to the data of the realm through a generic string based API instead of the conventional Realm API that uses the schema classes supplied in the configuration.

NOTE: All objects obtained from a DynamicRealm are only valid in the scope of the dynamic realm. Thus they cannot be passed outside of an RealmMigration that gives access to a specific DynamicRealm instance, etc.

Functions

getNumberOfActiveVersions

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

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.

query

abstract fun query(className: String, query: String = TRUE_PREDICATE, vararg args: Any?): RealmQuery<out DynamicRealmObject>

Returns a query for dynamic realm objects of the specified class.

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. This version number is tied to the transaction the object was read from.

Properties

configuration

abstract val configuration: Configuration

Configuration used to configure this Realm instance.

Inheritors

DynamicMutableRealm