RealmConfiguration

A Realm Configuration defining specific setup and configuration for a Realm instance.

The RealmConfiguration can, for simple uses cases, be created directly through the constructor. More advanced setup requires building the RealmConfiguration through RealmConfiguration.Builder.build.

Types

Builder

common

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

Used to create a RealmConfiguration.

Companion

common

object Companion

SharedBuilder

common

abstract class SharedBuilder<T, S : RealmConfiguration.SharedBuilder<T, S>>(schema: Set<KClass<out RealmObject>>)

This class contains shared properties across the two types of configuration builders.

Properties

deleteRealmIfMigrationNeeded

common

abstract val deleteRealmIfMigrationNeeded: Boolean

Flag indicating whether the realm will be deleted if the schema has changed in a way that requires schema migration.

encryptionKey

common

abstract val encryptionKey: ByteArray?

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

log

common

abstract val log: LogConfiguration

The log configuration used for the realm instance.

maxNumberOfActiveVersions

common

abstract val maxNumberOfActiveVersions: Long

Maximum number of active versions.

name

common

abstract val name: String

Filename of the realm file.

path

common

abstract val path: String

Path to the realm file.

schema

common

abstract val schema: Set<KClass<out RealmObject>>

The set of classes included in the schema for the realm.

schemaVersion

common

abstract val schemaVersion: Long

The schema version.

RealmConfiguration

See also

Types

Properties