Realm Kotlin SDK/io.realm.kotlin/RealmConfiguration

RealmConfiguration

interface RealmConfiguration : Configuration

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

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.

Companion

object Companion

Properties

compactOnLaunchCallback

abstract val compactOnLaunchCallback: CompactOnLaunchCallback?

Callback that determines if the realm file should be compacted as part of opening it.

deleteRealmIfMigrationNeeded

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

abstract val encryptionKey: ByteArray?

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

initialDataCallback

abstract val initialDataCallback: InitialDataCallback?

Callback that will be triggered in order to write initial data when the Realm file is created for the first time.

initialRealmFileConfiguration

abstract val initialRealmFileConfiguration: InitialRealmFileConfiguration?

Configuration that holds details of a bundled asset file used as initial state of the realm file. See SharedBuilder.initialRealmFile for details. null is returned if no initial realm file has been configured.

inMemory

abstract val inMemory: Boolean

Describes whether the realm should reside in memory or on disk.

log

~~abstract~~ ~~val~~ ~~log~~: LogConfiguration

The log configuration used for the realm instance.

maxNumberOfActiveVersions

abstract val maxNumberOfActiveVersions: Long

Maximum number of active versions.

name

abstract val name: String

Filename of the realm file.

path

abstract val path: String

Path to the realm file.

schema

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

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

schemaVersion

abstract val schemaVersion: Long

The schema version.

RealmConfiguration

See also

Types

Properties