RLMRealm

Obtains an instance of the default Realm.

The default Realm is used by the RLMObject class methods which do not take a RLMRealm parameter, but is otherwise not special. The default Realm is persisted as default.realm under the Documents directory of your Application on iOS, and in your application’s Application Support directory on OS X.

The default Realm is created using the default RLMRealmConfiguration, which can be changed via +[RLMRealmConfiguration setDefaultConfiguration:].

Obtains an RLMRealm instance with the given configuration.

Obtains an RLMRealm instance persisted at a specific file path.

Path to the file where this Realm is persisted.

Indicates if this Realm was opened in read-only mode.

The RLMSchema used by this RLMRealm.

Indicates if this Realm is currently in a write transaction.

Returns the RLMRealmConfiguration that was used to create this RLMRealm instance.

Indicates if this Realm contains any objects.

Add a notification handler for changes in this RLMRealm.

Notification handlers are called after each write transaction is committed, either on the current thread or other threads. The block is called on the same thread as they were added on, and can only be added on threads which are currently within a run loop. Unless you are specifically creating and running a run loop on a background thread, this normally will only be the main thread.

The block has the following definition:

typedef void(^RLMNotificationBlock)(NSString *notification, RLMRealm *realm);

It receives the following parameters:

• NSString *notification: The name of the incoming notification. See RLMRealmNotification for information on what notifications are sent.

• RLMRealm *realm: The realm for which this notification occurred

Remove a previously registered notification handler using the token returned from -addNotificationBlock:

Begins a write transaction in an RLMRealm.

Only one write transaction can be open at a time. Write transactions cannot be nested, and trying to begin a write transaction on a RLMRealm which is already in a write transaction will throw an exception. Calls to beginWriteTransaction from RLMRealm instances in other threads will block until the current write transaction completes.

Before beginning the write transaction, beginWriteTransaction updates the RLMRealm to the latest Realm version, as if refresh was called, and generates notifications if applicable. This has no effect if the RLMRealm was already up to date.

It is rarely a good idea to have write transactions span multiple cycles of the run loop, but if you do wish to do so you will need to ensure that the RLMRealm in the write transaction is kept alive until the write transaction is committed.

Commits all write operations in the current write transaction, and ends the transaction.

Commits all write operations in the current write transaction, and ends the transaction.

Reverts all writes made in the current write transaction and ends the transaction.

This rolls back all objects in the Realm to the state they were in at the beginning of the write transaction, and then ends the transaction.

This restores the data for deleted objects, but does not revive invalidated object instances. Any RLMObjects which were added to the Realm will be invalidated rather than switching back to standalone objects. Given the following code:

ObjectType *oldObject = [[ObjectType objectsWhere:@"..."] firstObject];
ObjectType *newObject = [[ObjectType alloc] init];

[realm beginWriteTransaction];
[realm addObject:newObject];
[realm deleteObject:oldObject];
[realm cancelWriteTransaction];

Both oldObject and newObject will return YES for isInvalidated, but re-running the query which provided oldObject will once again return the valid object.

Helper to perform a block within a transaction.

Performs actions contained within the given block inside a write transation.

Write transactions cannot be nested, and trying to execute a write transaction on a RLMRealm which is already in a write transaction will throw an exception. Calls to transactionWithBlock: from RLMRealm instances in other threads will block until the current write transaction completes.

Before beginning the write transaction, transactionWithBlock: updates the RLMRealm to the latest Realm version, as if refresh was called, and generates notifications if applicable. This has no effect if the RLMRealm was already up to date.

Update an RLMRealm and outstanding objects to point to the most recent data for this RLMRealm.

Set to YES to automatically update this Realm when changes happen in other threads.

If set to YES (the default), changes made on other threads will be reflected in this Realm on the next cycle of the run loop after the changes are committed. If set to NO, you must manually call -refresh on the Realm to update it to get the latest version.

Note that by default, background threads do not have an active run loop and you will need to manually call -refresh in order to update to the latest version, even if autorefresh is set to true.

Even with this enabled, you can still call -refresh at any time to update the Realm before the automatic refresh would occur.

Notifications are sent when a write transaction is committed whether or not this is enabled.

Disabling this on an RLMRealm without any strong references to it will not have any effect, and it will switch back to YES the next time the RLMRealm object is created. This is normally irrelevant as it means that there is nothing to refresh (as persisted RLMObjects, RLMArrays, and RLMResults have strong references to the containing RLMRealm), but it means that setting RLMRealm.defaultRealm.autorefresh = NO in application:didFinishLaunchingWithOptions: and only later storing Realm objects will not work.

Defaults to YES.

Write a compacted copy of the RLMRealm to the given path.

The destination file cannot already exist.

Note that if this is called from within a write transaction it writes the current data, and not data when the last write transaction was committed.

Write an encrypted and compacted copy of the RLMRealm to the given path.

The destination file cannot already exist.

Note that if this is called from within a write transaction it writes the current data, and not data when the last write transaction was committed.

Invalidate all RLMObjects and RLMResults read from this Realm.

An RLMRealm holds a read lock on the version of the data accessed by it, so that changes made to the Realm on different threads do not modify or delete the data seen by this RLMRealm. Calling this method releases the read lock, allowing the space used on disk to be reused by later write transactions rather than growing the file. This method should be called before performing long blocking operations on a background thread on which you previously read data from the Realm which you no longer need.

All RLMObject, RLMResults and RLMArray instances obtained from this RLMRealm on the current thread are invalidated, and can not longer be used. The RLMRealm itself remains valid, and a new read transaction is implicitly begun the next time data is read from the Realm.

Calling this method multiple times in a row without reading any data from the Realm, or before ever reading any data from the Realm is a no-op. This method cannot be called on a read-only Realm.

Adds an object to be persisted in this Realm.

Once added, this object can be retrieved using the objectsWhere: selectors on RLMRealm and on subclasses of RLMObject. When added, all (child) relationships referenced by this object will also be added to the Realm if they are not already in it. If the object or any related objects already belong to a different Realm an exception will be thrown. Use -[RLMObject createInRealm:withObject] to insert a copy of a persisted object into a different Realm.

The object to be added must be valid and cannot have been previously deleted from a Realm (i.e. isInvalidated) must be false.

Adds objects in the given array to be persisted in this Realm.

This is the equivalent of addObject: except for an array of objects.

Adds or updates an object to be persisted in this Realm. The object provided must have a designated primary key. If no objects exist in the RLMRealm instance with the same primary key value, the object is inserted. Otherwise, the existing object is updated with any changed values.

As with addObject:, the object cannot already be persisted in a different Realm. Use -[RLMObject createOrUpdateInRealm:withValue:] to copy values to a different Realm.

Adds or updates objects in the given array to be persisted in this Realm.

This is the equivalent of addOrUpdateObject: except for an array of objects.

Delete an object from this Realm.

Delete an NSArray, RLMArray, or RLMResults of objects from this Realm.

Deletes all objects in this Realm.

Get the schema version for a Realm at a given path.

Get the schema version for an encrypted Realm at a given path.

Performs the given Realm configuration’s migration block on a Realm at the given path.

This method is called automatically when opening a Realm for the first time and does not need to be called explicitly. You can choose to call this method to control exactly when and how migrations are performed.