Realm Kotlin SDK/io.realm.kotlin/RealmConfiguration/Builder

Builder

class Builder(schema: Set<KClass<out TypedRealmObject>>) : Configuration.SharedBuilder<RealmConfiguration, RealmConfiguration.Builder>

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

Constructors

Builder

constructor(schema: Set<KClass<out TypedRealmObject>>)

Functions

build

open override fun build(): RealmConfiguration

Creates the RealmConfiguration based on the builder properties.

compactOnLaunch

fun compactOnLaunch(callback: CompactOnLaunchCallback = Realm.DEFAULT_COMPACT_ON_LAUNCH_CALLBACK): RealmConfiguration.Builder

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

deleteRealmIfMigrationNeeded

fun deleteRealmIfMigrationNeeded(): RealmConfiguration.Builder

Setting this will change the behavior of how migration exceptions are handled. Instead of throwing an exception the on-disc Realm will be cleared and recreated with the new Realm schema.

directory

fun directory(directoryPath: String): RealmConfiguration.Builder

Sets the path to the directory that contains the realm file. If the directory does not exists, it and all intermediate directories will be created.

encryptionKey

fun encryptionKey(encryptionKey: ByteArray): RealmConfiguration.Builder

Sets the 64 byte key used to encrypt and decrypt the Realm file. If no key is provided the Realm file will be unencrypted.

initialData

fun initialData(callback: InitialDataCallback): RealmConfiguration.Builder

Writes initial data to the Realm file. This callback will be executed only once, when the database file is created. This also include cases where RealmConfiguration.Builder.deleteRealmIfMigrationNeeded was set causing the file to be deleted.

initialRealmFile

fun initialRealmFile(assetFile: String, sha256checkSum: String? = null): RealmConfiguration.Builder

Initializes a realm file with a bundled asset realm file.

inMemory

fun inMemory(): RealmConfiguration.Builder

Setting this will create an in-memory Realm instead of saving it to disk. In-memory Realms might still use disk space if memory is running low, but all files created by an in-memory Realm will be deleted when the Realm is closed.

maxNumberOfActiveVersions

fun maxNumberOfActiveVersions(maxVersions: Long = 8): RealmConfiguration.Builder

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

migration

fun migration(migration: RealmMigration): RealmConfiguration.Builder

Sets the migration to handle schema updates.

fun migration(migration: AutomaticSchemaMigration, resolveEmbeddedObjectConstraints: Boolean = false): RealmConfiguration.Builder

Sets the migration to handle schema updates with automatic migration of data.

name

open override fun name(name: String): RealmConfiguration.Builder

Sets the filename of the realm file.

schemaVersion

fun schemaVersion(schemaVersion: Long): RealmConfiguration.Builder

Sets the schema version of the Realm. This must be equal to or higher than the schema version of the existing Realm file, if any. If the schema version is higher than the already existing Realm, a migration is needed.