Builder

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

Constructors

Builder
Link copied to clipboard
fun Builder(schema: Set<KClass<out BaseRealmObject>>)

Functions

build
Link copied to clipboard
open override fun build(): RealmConfiguration
Creates the RealmConfiguration based on the builder properties.
compactOnLaunch
Link copied to clipboard
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
Link copied to clipboard
Setting this will change the behavior of how migration exceptions are handled.
directory
Link copied to clipboard
fun directory(directoryPath: String): RealmConfiguration.Builder
Sets the path to the directory that contains the realm file.
encryptionKey
Link copied to clipboard
fun encryptionKey(encryptionKey: ByteArray): RealmConfiguration.Builder
Sets the 64 byte key used to encrypt and decrypt the Realm file.
initialData
Link copied to clipboard
fun initialData(callback: InitialDataCallback): RealmConfiguration.Builder
Writes initial data to the Realm file.
inMemory
Link copied to clipboard
fun inMemory(): RealmConfiguration.Builder
Setting this will create an in-memory Realm instead of saving it to disk.
log
Link copied to clipboard
open fun log(level: LogLevel = LogLevel.WARN, customLoggers: List<RealmLogger> = emptyList()): RealmConfiguration.Builder
Configure how Realm will report log events.
maxNumberOfActiveVersions
Link copied to clipboard
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
Link copied to clipboard
fun migration(migration: RealmMigration): RealmConfiguration.Builder
Sets the migration to handle schema updates.
name
Link copied to clipboard
open override fun name(name: String): RealmConfiguration.Builder
Sets the filename of the realm file.
schemaVersion
Link copied to clipboard
fun schemaVersion(schemaVersion: Long): RealmConfiguration.Builder
Sets the schema version of the Realm.