Builder

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

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

Constructors

Builder

common

fun Builder(schema: Set<KClass<out RealmObject>> = setOf())

Functions

build

common

fun build(): RealmConfiguration

Creates the RealmConfiguration based on the builder properties.

deleteRealmIfMigrationNeeded

common

fun deleteRealmIfMigrationNeeded(): RealmConfiguration.Builder

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

encryptionKey

common

fun encryptionKey(encryptionKey: ByteArray): RealmConfiguration.Builder

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

log

common

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

Configure how Realm will report log events.

maxNumberOfActiveVersions

common

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.

name

common

fun name(name: String): RealmConfiguration.Builder

Sets the filename of the realm file.

path

common

fun path(path: String?): RealmConfiguration.Builder

Sets the absolute path of the realm file.

schema

common

fun schema(vararg classes: KClass<out RealmObject>): RealmConfiguration.Builder

Sets the classes of the schema.

fun schema(classes: Set<KClass<out RealmObject>>): RealmConfiguration.Builder

Sets the classes of the schema.

schemaVersion

common

fun schemaVersion(schemaVersion: Long): RealmConfiguration.Builder

Sets the schema version of the Realm.

Properties

schema

common

var schema: Set<KClass<out RealmObject>>