Realm Kotlin SDK/io.realm.kotlin/Realm/Companion

Companion

Properties

val DEFAULT_COMPACT_ON_LAUNCH_CALLBACK: CompactOnLaunchCallback

The default implementation for determining if a file should be compacted or not. This implementation will only trigger if the file is above 50 MB and 50% or more of the space can be reclaimed.

DEFAULT_FILE_NAME

const val DEFAULT_FILE_NAME: String

Default name for realm files unless overridden by Configuration.SharedBuilder.name.

DEFAULT_LOG_TAG

const val DEFAULT_LOG_TAG: String

Default tag used by log entries

ENCRYPTION_KEY_LENGTH

const val ENCRYPTION_KEY_LENGTH: Int

The required length for encryption keys used to encrypt Realm data.

Functions

compactRealm

fun compactRealm(configuration: Configuration): Boolean

Compacts the Realm file defined by the given configuration. Compaction can only succeed if all references to the Realm file has been closed.

deleteRealm

fun deleteRealm(configuration: Configuration)

Deletes the realm file along with other related temporary files specified by the given RealmConfiguration from the filesystem. The temporary file with ".lock" extension won't be deleted.

open

fun open(configuration: Configuration): Realm

Open a realm instance.