RLMRealmConfiguration

Objective-C

@interface RLMRealmConfiguration : NSObject <NSCopying>

Swift

@_nonSendable(_assumed) class RLMRealmConfiguration : NSObject, NSCopying

An RLMRealmConfiguration instance describes the different options used to create an instance of a Realm.

RLMRealmConfiguration instances are just plain NSObjects. Unlike RLMRealms and RLMObjects, they can be freely shared between threads as long as you do not mutate them.

Creating configuration objects for class subsets (by setting the objectClasses property) can be expensive. Because of this, you will normally want to cache and reuse a single configuration object for each distinct configuration rather than creating a new object each time you open a Realm.

Show on GitHub

Default Configuration

  • Returns the default configuration used to create Realms when no other configuration is explicitly specified (i.e. +[RLMRealm defaultRealm]).

    Declaration

    Objective-C

    + (nonnull instancetype)defaultConfiguration;

    Swift

    class func `default`() -> Self

    Return Value

    The default Realm configuration.

    Show on GitHub

  • Sets the default configuration to the given RLMRealmConfiguration.

    Declaration

    Objective-C

    + (void)setDefaultConfiguration:(nonnull RLMRealmConfiguration *)configuration;

    Swift

    class func setDefault(_ configuration: RLMRealmConfiguration)

    Parameters

    configuration

    The new default Realm configuration.
    Show on GitHub

Properties

  • The local URL of the Realm file. Mutually exclusive with inMemoryIdentifier; setting one of the two properties will automatically nil out the other.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSURL *fileURL;

    Swift

    var fileURL: URL? { get set }
    Show on GitHub

  • A string used to identify a particular in-memory Realm. Mutually exclusive with fileURL and seedFilePath. Setting an in-memory identifier will automatically nil out the other two.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *inMemoryIdentifier;

    Swift

    var inMemoryIdentifier: String? { get set }
    Show on GitHub

  • A 64-byte key to use to encrypt the data, or nil if encryption is not enabled.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSData *encryptionKey;

    Swift

    var encryptionKey: Data? { get set }
    Show on GitHub

  • Whether to open the Realm in read-only mode.

    For non-synchronized Realms, this is required to be able to open Realm files which are not writeable or are in a directory which is not writeable. This should only be used on files which will not be modified by anyone while they are open, and not just to get a read-only view of a file which may be written to by another thread or process. Opening in read-only mode requires disabling Realm’s reader/writer coordination, so committing a write transaction from another process will result in crashes.

    Syncronized Realms must always be writeable (as otherwise no synchronization could happen), and this instead merely disallows performing write transactions on the Realm. In addition, it will skip some automatic writes made to the Realm, such as to initialize the Realm’s schema. Setting readOnly = YES is not strictly required for Realms which the sync user does not have write access to, but is highly recommended as it will improve error reporting and catch some errors earlier.

    Realms using query-based sync cannot be opened in read-only mode.

    Declaration

    Objective-C

    @property (nonatomic) BOOL readOnly;

    Swift

    var readOnly: Bool { get set }
    Show on GitHub

  • The current schema version.

    Declaration

    Objective-C

    @property (nonatomic) uint64_t schemaVersion;

    Swift

    var schemaVersion: UInt64 { get set }
    Show on GitHub

  • The block which migrates the Realm to the current version.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) RLMMigrationBlock migrationBlock;

    Swift

    var migrationBlock: RLMMigrationBlock? { get set }
    Show on GitHub

  • Whether to recreate the Realm file with the provided schema if a migration is required. This is the case when the stored schema differs from the provided schema or the stored schema version differs from the version on this configuration. Setting this property to YES deletes the file if a migration would otherwise be required or executed.

    Note

    Setting this property to YES doesn’t disable file format migrations.

    Declaration

    Objective-C

    @property (nonatomic) BOOL deleteRealmIfMigrationNeeded;

    Swift

    var deleteRealmIfMigrationNeeded: Bool { get set }
    Show on GitHub

  • A block called when opening a Realm for the first time during the life of a process to determine if it should be compacted before being returned to the user. It is passed the total file size (data + free space) and the total bytes used by data in the file.

    Return YES to indicate that an attempt to compact the file should be made. The compaction will be skipped if another process is accessing it.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) RLMShouldCompactOnLaunchBlock shouldCompactOnLaunch;

    Swift

    var shouldCompactOnLaunch: RLMShouldCompactOnLaunchBlock? { get set }
    Show on GitHub

  • The classes managed by the Realm.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSArray *objectClasses;

    Swift

    var objectClasses: [Any]? { get set }
    Show on GitHub

  • The maximum number of live versions in the Realm file before an exception will be thrown when attempting to start a write transaction.

    Realm provides MVCC snapshot isolation, meaning that writes on one thread do not overwrite data being read on another thread, and instead write a new copy of that data. When a Realm refreshes it updates to the latest version of the data and releases the old versions, allowing them to be overwritten by subsequent write transactions.

    Under normal circumstances this is not a problem, but if the number of active versions grow too large, it will have a negative effect on the filesize on disk. This can happen when performing writes on many different threads at once, when holding on to frozen objects for an extended time, or when performing long operations on background threads which do not allow the Realm to refresh.

    Setting this property to a non-zero value makes it so that exceeding the set number of versions will instead throw an exception. This can be used with a low value during development to help identify places that may be problematic, or in production use to cause the app to crash rather than produce a Realm file which is too large to be opened.

    Declaration

    Objective-C

    @property (nonatomic) NSUInteger maximumNumberOfActiveVersions;

    Swift

    var maximumNumberOfActiveVersions: UInt { get set }
    Show on GitHub

  • When opening the Realm for the first time, instead of creating an empty file, the Realm file will be copied from the provided seed file path and used instead. This can be used to open a Realm file with pre-populated data.

    If a realm file already exists at the configuration’s destination path, the seed file will not be copied and the already existing realm will be opened instead.

    Note that to use this parameter with a synced Realm configuration the seed Realm must be appropriately copied to a destination with [RLMRealm writeCopyForConfiguration:] first.

    This option is mutually exclusive with inMemoryIdentifier. Setting a seedFilePath will nil out the inMemoryIdentifier.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSURL *seedFilePath;

    Swift

    var seedFilePath: URL? { get set }
    Show on GitHub

  • A configuration object representing configuration state for Realms intended to sync with Atlas Device Sync.

    This property is mutually exclusive with both inMemoryIdentifier and fileURL; setting any one of the three properties will automatically nil out the other two.

    See

    RLMSyncConfiguration

    Declaration

    Objective-C

    @property (nonatomic, nullable) RLMSyncConfiguration *syncConfiguration;

    Swift

    var syncConfiguration: RLMSyncConfiguration? { get set }
    Show on GitHub