Configuration

A Realm.Configuration is used to describe the different options used to create a Realm instance.

Default Configuration

defaultConfiguration
Returns the default Realm.Configuration used to create Realms when no other configuration is explicitly specified (i.e. Realm()).
Declaration
Swift

public static var defaultConfiguration: Configuration
Show on GitHub

Initialization


                    
                    
                    init(path:inMemoryIdentifier:encryptionKey:readOnly:schemaVersion:migrationBlock:objectTypes:)

Initializes a Realm.Configuration, suitable for creating new Realm instances.

Declaration

Swift

public init(path: String? = RLMRealmConfiguration.defaultRealmPath(),
            inMemoryIdentifier: String? = nil,
            encryptionKey: NSData? = nil,
            readOnly: Bool = false,
            schemaVersion: UInt64 = 0,
            migrationBlock: MigrationBlock? = nil,
            objectTypes: [Object.Type]? = nil)

Show on GitHub

Configuration Properties

path
The path to the realm file. Mutually exclusive with inMemoryIdentifier.
Declaration
Swift

public var path: String?
Show on GitHub
inMemoryIdentifier
A string used to identify a particular in-memory Realm. Mutually exclusive with path.
Declaration
Swift

public var inMemoryIdentifier: String?
Show on GitHub
encryptionKey
64-byte key to use to encrypt the data.
Declaration
Swift

public var encryptionKey: NSData?
Show on GitHub
readOnly
Whether the Realm is read-only (must be true for read-only files).
Declaration
Swift

public var readOnly: Bool = false
Show on GitHub
schemaVersion
The current schema version.
Declaration
Swift

public var schemaVersion: UInt64 = 0
Show on GitHub
migrationBlock
The block which migrates the Realm to the current version.
Declaration
Swift

public var migrationBlock: MigrationBlock? = nil
Show on GitHub
objectTypes
The classes persisted in the Realm.
Declaration
Swift

public var objectTypes: [Object.Type]?
Show on GitHub