Builder

Used to create a RealmConfiguration. For common use cases, a RealmConfiguration can be created using the RealmConfiguration.create function.

Constructors

Builder

build

Creates the RealmConfiguration based on the builder properties.

compactOnLaunch

Sets a callback for controlling whether the realm should be compacted when opened.

deleteRealmIfMigrationNeeded

Setting this will change the behavior of how migration exceptions are handled.

directory

Sets the path to the directory that contains the realm file.

encryptionKey

Sets the 64 byte key used to encrypt and decrypt the Realm file.

initialData

Writes initial data to the Realm file.

initialRealmFile

Initializes a realm file with a bundled asset realm file.

inMemory

Setting this will create an in-memory Realm instead of saving it to disk.

log

open fun log(level: LogLevel = LogLevel.WARN, customLoggers: List<RealmLogger> = emptyList()): RealmConfiguration.Builder

Configure how Realm will report log events.

maxNumberOfActiveVersions

Sets the maximum number of live versions in the Realm file before an IllegalStateException is thrown when attempting to write more data.

migration

Sets the migration to handle schema updates.

name

Sets the filename of the realm file.

schemaVersion

Sets the schema version of the Realm.