Docs Menu

Configure & Open a Realm - Swift SDKicons/link.png

On this page

  • Open a Local Realm
  • Close a Realm
  • Handle Errors
  • Open an In-Memory Realm
  • Provide a Subset of Classes to a Realm
  • Initialize Properties Using Realm APIs
  • Use Realm When the Device Is Locked

A realm is the core data structure used to organize data in Realm Database. For more information, see Realms - Swift SDK.

See also:

This page explains how to configure and open a local Realm Database. For information about opening a synced realm, including how to open a synced realm offline or online-only, see: Sync Changes Between Devices.

There is no need to manually close a realm in Swift or Objective-C. When a realm goes out of scope and is removed from memory due to ARC, the realm is closed.

You can open a realm entirely in memory, which will not create a .realm file or its associated auxiliary files. Instead the SDK stores objects in memory while the realm is open and discards them immediately when all instances are closed.


When all in-memory realm instances with a particular identifier go out of scope, Realm Database deletes all data in that realm. To avoid this, hold onto a strong reference to any in-memory realms during your app's lifetime.

Operating with Low Memory Constraints

Some applications, such as watchOS apps and iOS app extensions, have tight constraints on their memory footprints. To optimize your data model for low-memory environments, open the realm with a subset of classes.

You might define properties whose values are initialized using Realm Database APIs. For example:

class SomeSwiftType {
let persons = try! Realm().objects(Person.self)
// ...

If this initialization code runs before you set up your Realm configurations, you might get unexpected behavior. For example, if you set a migration block for the default realm configuration in applicationDidFinishLaunching(), but you create an instance of SomeSwiftType before applicationDidFinishLaunching(), you might be accessing your realm before it has been correctly configured.

To avoid such issues, consider doing one of the following:

  • Defer instantiation of any type that eagerly initializes properties using Realm Database APIs until after your app has completed setting up its realm configurations.
  • Define your properties using Swift’s lazy keyword. This allows you to safely instantiate such types at any time during your application’s lifecycle, as long as you do not attempt to access your lazy properties until after your app has set up its realm configurations.
  • Only initialize your properties using Realm APIs that explicitly take in user-defined configurations. You can be sure that the configuration values you are using have been set up properly before they are used to open realms.

By default, iOS 8 and above encrypts app files using NSFileProtection whenever the device is locked. If your app attempts to access a realm while the device is locked, you might see the following error:

open() failed: Operation not permitted

To handle this, downgrade the file protection of the folder containing the Realm files. A less strict protection level like NSFileProtectionCompleteUntilFirstUserAuthentication allows file access even when the device is locked.


If you reduce iOS file encryption, consider using Realm's built-in encryption to secure your data instead.

This example shows how to apply a less strict protection level to the parent directory of the default realm.

let realm = try! Realm()
// Get the realm file's parent directory
let folderPath = realm.configuration.fileURL!.deletingLastPathComponent().path
// Disable file protection for this directory after the user has unlocked the device once
try! FileManager.default.setAttributes([FileAttributeKey.protectionKey: FileProtectionType.completeUntilFirstUserAuthentication],
ofItemAtPath: folderPath)

Realm may create and delete auxiliary files at any time. Instead of downgrading file protection on the files, apply it to the parent folder. This way, the file protection applies to all relevant files regardless of creation time.

Give Feedback
MongoDB logo
© 2021 MongoDB, Inc.


  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2021 MongoDB, Inc.