RLMRealmConfiguration

@interface RLMRealmConfiguration : NSObject <NSCopying>

An RLMRealmConfiguration is used to describe the different options used to create an RLMRealm instance.

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;

    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;

    Parameters

    configuration

    The new default Realm configuration.
    Show on GitHub

Properties

  • The path to the realm file. Mutually exclusive with inMemoryIdentifier.

    Declaration

    Objective‑C

    @property (readwrite, copy, nonatomic, nullable) NSString *path;
    Show on GitHub

  • A string used to identify a particular in-memory Realm. Mutually exclusive with path.

    Declaration

    Objective‑C

    @property (readwrite, copy, nonatomic, nullable) NSString *inMemoryIdentifier;
    Show on GitHub

  • 64-byte key to use to encrypt the data.

    Declaration

    Objective‑C

    @property (readwrite, copy, nonatomic, nullable) NSData *encryptionKey;
    Show on GitHub

  • Whether the Realm is read-only (must be YES for read-only files).

    Declaration

    Objective‑C

    @property (assign, readwrite, nonatomic) BOOL readOnly;
    Show on GitHub

  • The current schema version.

    Declaration

    Objective‑C

    @property (assign, readwrite, nonatomic) uint64_t schemaVersion;
    Show on GitHub

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

    Declaration

    Objective‑C

    @property (readwrite, copy, nonatomic, nullable)
    RLMMigrationBlock migrationBlock;
    Show on GitHub

  • The classes persisted in the Realm.

    Declaration

    Objective‑C

    @property (readwrite, copy, nonatomic, nullable) NSArray *objectClasses;
    Show on GitHub