Realm

The Schema used by the Realm.

The Configuration value that was used to create the Realm instance.

Indicates if the Realm contains any objects.

Obtains an instance of the default Realm.

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 Configuration, which can be changed by setting the Realm.Configuration.defaultConfiguration property to a new value.

Obtains a Realm instance with the given configuration.

Obtains a Realm instance persisted at a specified file URL.

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

If the block throws an error, the transaction will be canceled, reverting any writes made in the block before the error was thrown.

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

Before executing the write transaction, write updates the Realm instance to the latest Realm version, as if refresh() had been called, and generates notifications if applicable. This has no effect if the Realm was already up to date.

Begins a write transaction on the Realm.

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

Before beginning the write transaction, beginWrite updates the Realm instance to the latest Realm version, as if refresh() had been called, and generates notifications if applicable. This has no effect if the Realm 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 Realm 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.

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 Objects which were added to the Realm will be invalidated rather than becoming unmanaged.

Given the following code:

let oldObject = objects(ObjectType).first!
let newObject = ObjectType()

realm.beginWrite()
realm.add(newObject)
realm.delete(oldObject)
realm.cancelWrite()

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

Indicates whether the Realm is currently in a write transaction.

Adds or updates an existing object into the Realm.

Only pass true to update if the object has a primary key. If no objects exist in the Realm with the same primary key value, the object is inserted. Otherwise, the existing object is updated with any changed values.

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 are already being managed by a different Realm an error will be thrown. Instead, use one of the create functions to insert a copy of a managed 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 or updates all the objects in a collection into the Realm.

Creates or updates a Realm object with a given value, adding it to the Realm and returning it.

Only pass true to update if the object has a primary key. If no objects exist in the Realm with the same primary key value, the object is inserted. Otherwise, the existing object is updated with any changed values.

The value argument can be a key-value coding compliant object, an array or dictionary returned from the methods in NSJSONSerialization, or an Array containing one element for each managed property. An exception will be thrown if any required properties are not present and those properties were not defined with default values. Do not pass in a LinkingObjects instance, either by itself or as a member of a collection.

When passing in an Array as the value argument, all properties must be present, valid and in the same order as the properties defined in the model.

Deletes an object from the Realm. Once the object is deleted it is considered invalidated.

Deletes zero or more objects from the Realm.

Deletes all objects from the Realm.

Returns all objects of the given type stored in the Realm.

Retrieves the single instance of a given object type with the given primary key from the Realm.

This method requires that primaryKey() be overridden on the given object class.

Adds a notification handler for changes made to this Realm, and returns a notification token.

Notification handlers are called after each write transaction is committed, independent of the thread or process.

Handler blocks are called on the same thread that they were added on, and may 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 will normally only be the main thread.

Notifications can’t be delivered as long as the run loop is blocked by other activity. When notifications can’t be delivered instantly, multiple notifications may be coalesced.

You must retain the returned token for as long as you want updates to be sent to the block. To stop receiving updates, call stop() on the token.

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

If set to true (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 false, you must manually call refresh() on the Realm to update it to get the latest data.

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 property 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 automatic refreshing is enabled.

Disabling autorefresh on a Realm without any strong references to it will not have any effect, and autorefresh will revert back to true the next time the Realm is created. This is normally irrelevant as it means that there is nothing to refresh (as managed Objects, Lists, and Results have strong references to the Realm that manages them), but it means that setting autorefresh = false in application(_:didFinishLaunchingWithOptions:) and only later storing Realm objects will not work.

Defaults to true.

Updates the Realm and outstanding objects managed by the Realm to point to the most recent data.

Invalidates all Objects, Results, LinkingObjects, and Lists managed by the Realm.

A Realm 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 Realm. 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 Object, Results and List instances obtained from this Realm instance on the current thread are invalidated. Objects and Arrays cannot be used. Results will become empty. The Realm 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 may not be called on a read-only Realm.

Writes a compacted and optionally encrypted copy of the Realm to the given local URL.

The destination file cannot already exist.

Note that if this method is called from within a write transaction, the current data is written, not the data from the point when the previous write transaction was committed.

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.

A notification indicating that changes were made to a Realm.

A Configuration instance describes the different options used to create an instance of a Realm.

Configuration instances are just plain Swift structs. Unlike Realms and Objects, they can be freely shared between threads as long as you do not mutate them.

Creating configuration values 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 value for each distinct configuration rather than creating a new value each time you open a Realm.

A human-readable description of the configuration value.