Install Realm for iOS, macOS, tvOS, and watchOS

Overview

Realm's Swift SDK enables your iOS, macOS, tvOS, and watchOS applications to interact with Realm using either the Swift or Objective-C programming languages. This page details how to install Realm in your project and get started.

Prerequisites

Before getting started, ensure your development environment meets the following prerequisites:

• Xcode 14.1-14.3.1 with a target of iOS 11.0 or higher, macOS 10.13 or higher, tvOS 11.0 or higher, or watchOS 4.0 or higher.

• Reflection is enabled in your project. The Realm Swift SDK uses reflection to determine your model's properties. Your project must not set SWIFT_REFLECTION_METADATA_LEVEL = none or Realm cannot see properties in your model. Reflection is enabled by default if your project does not specifically set a level for this setting.

Swift SDK version 10.40.0 drops support for Xcode 13. For v10.39.01 and earlier, these Xcode 13 requirements apply:

• Xcode version 13.1 or higher.

• When using Xcode 13, a target of iOS 9.0 or higher, macOS 10.9 or higher, tvOS 9.0 or higher, or watchOS 2.0 or higher.

• If using Swift Package Manager with Xcode 13, target of iOS 11+ or macOS 10.10+ is required.

Installation

You can use SwiftPM, CocoaPods, or Carthage to add the Realm Swift SDK to your project.

Import Realm

Add the following line at the top of your source files to use Realm:

App Download File Size

Realm should only add around 5 to 8 MB to your app's download size. The releases we distribute are significantly larger because they include support for the iOS, watchOS and tvOS simulators, some debug symbols, and bitcode, all of which are stripped by the App Store automatically when apps are downloaded.

Troubleshooting

If you have build issues after using one of these methods to install Realm, see our troubleshooting guidelines for information about resolving those issues in realm.

OS Support

Swift Concurrency Support

The Realm Swift SDK supports Swift's concurrency-related language features. For best practices on using Realm with Swift concurrency features, refer to the documentation below.