Install Atlas Device SDK

Add Package Dependency

In Xcode, select File > Add Packages....

Specify the Repository

Copy and paste the following into the search/input box.

https://github.com/realm/realm-cpp

Select the Package Products

Under Package Product, select realm-cpp-sdk. Under Add to Target, select the target you would like to add the SDK to. For example, the target might be the main executable of your app. Click Add Package.

Create or Modify CMakeLists.txt

Create or modify your CMakeLists.txt in the root directory of your project:

1. Add Include(FetchContent) to include the FetchContent module in your project build.

2. Use FetchContent_Declare to locate the SDK dependency and specify the version tag you want to use.

3. Use the FetchContent_MakeAvailable() command to check whether the named dependencies have been populated, and if not, populate them.

4. Finally, target_link_libraries() links the SDK dependency to your target executable.

To get the most recent version tag, refer to the releases on GitHub: realm/realm-cpp.

Set the minimum C++ standard to 17 with set(CMAKE_CXX_STANDARD 17).

In a Windows install, add the required compiler flag:

if(MSVC)
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /Zc:preprocessor /bigobj")
endif()

cmake_minimum_required(VERSION 3.15)
project(MyDeviceSDKCppProject)
# Minimum C++ standard
set(CMAKE_CXX_STANDARD 17)
# In a Windows install, set these compiler flags:
if(MSVC)
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /Zc:preprocessor /bigobj")
endif()
# Include the FetchContent module so you can download the C++ SDK
Include(FetchContent)
# Declare the version of the C++ SDK you want to download
FetchContent_Declare(
   cpprealm
   GIT_REPOSITORY https://github.com/realm/realm-cpp.git
   GIT_TAG        v1.0.0
)
# The MakeAvailable command ensures the named dependencies have been populated
FetchContent_MakeAvailable(cpprealm)
# Create an executable target called myApp with the source file main.cpp
add_executable(myApp main.cpp)
target_link_libraries(myApp PRIVATE cpprealm)

Run CMake

Run CMake in a gitignored directory, such as build, to generate the build configurations that you can then use to compile your app:

# build/ is in .gitignore
mkdir build
cd build
cmake .. # Create Makefile by reading the CMakeLists.txt in the parent directory (../)
make # Actually build the app

You can use CMake to generate more than simple Makefiles by using the -G flag. See the CMake documentation for more information.

Open the NuGet Package Manager

In the Solution Explorer, right-click your solution and select Manage NuGet Packages... to open the NuGet Package management window.

click to enlarge

Add the Realm Package

In the search bar, search for Realm. Select the result and click Add Package. If you are using Xamarin, you may be prompted to select which projects use the Realm package. Select all of the projects, and then click Ok.

Open the NuGet Package Manager

In the Solution Explorer, right-click your solution and select Manage NuGet Packages for Solution... to open the NuGet Package management window.

click to enlarge

Add the Realm Package

In the search bar, search for Realm. Select the result and click Install. When prompted, select all projects and click Ok.

click to enlarge

Add the SDK to the Project

Add io.realm.kotlin, specifying the library version and apply false, to the list of plugins in your project-level Gradle build file, typically found at <project>/build.gradle:

plugins {
     id 'io.realm.kotlin' version '1.16.0' apply false
}

Add the following to your app-level Gradle build file, typically found at <project>/app/build.gradle:

• Add io.realm.kotlin to the list of plugins.

• Add the following to the list of dependencies:

  • Add io.realm.kotlin:library-base to the dependencies block.

  • If using Device Sync in your application, add io.realm.kotlin:library-sync to the dependencies block.

• To use coroutines with the SDK, add org.jetbrains.kotlinx:kotlinx-coroutines-core to the list of dependencies.

plugins {
     id 'com.android.application'
     id 'org.jetbrains.kotlin.android'
     id 'io.realm.kotlin'
}
android {
     // ... build configuration settings
}
dependencies {
     implementation 'io.realm.kotlin:library-base:1.16.0'
     // If using Device Sync
     implementation 'io.realm.kotlin:library-sync:1.16.0'
     // If using coroutines with the SDK
     implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.0'
}

Sync Gradle Files

After updating the Gradle configuration, resolve the dependencies by clicking File > Sync Project with Gradle Files in the Android Studio menu bar. You can now use the SDK in your application.

Add the SDK to the Project

1. Add the following to your app-level Gradle build file, typically found at <project>/app/build.gradle:

   • Add io.realm.kotlin to the list of plugins.

   • Add the following to the list of dependencies:

     • Add io.realm.kotlin:library-base to the dependencies block.

     • If using Device Sync in your application, add io.realm.kotlin:library-sync to the dependencies block.

   • To use coroutines with the SDK, add org.jetbrains.kotlinx:kotlinx-coroutines-core to the list of dependencies.

   App build.gradle

   plugins {
       kotlin("multiplatform")
       kotlin("native.cocoapods")
       id("com.android.library")
       id("io.realm.kotlin") version "1.16.0"
   }
   version = "1.0"
   kotlin {
       android()
       iosX64()
       iosArm64()
       sourceSets {
           val commonMain by getting {
               dependencies {
                   implementation("io.realm.kotlin:library-base:1.16.0")
                   // If using Device Sync
                   implementation("io.realm.kotlin:library-sync:1.16.0")
                   // If using coroutines with the SDK
                   implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.0")
               }
           }
       }
   }

2. If you use any part of the SDK inside the Android module, add the following compile-time dependencies to your module-level Gradle build file, typically found at <project>/module/build.gradle:

   Android Module build.gradle

   dependencies {
       compileOnly("io.realm.kotlin:library-base:1.16.0")
   }
   // If using Device Sync
   dependencies {
       compileOnly("io.realm.kotlin:library-sync:1.16.0")
   }

Sync Gradle Files

After updating the Gradle configuration, resolve the dependencies by clicking File > Sync Project with Gradle Files in the Android Studio menu bar. You can now use the SDK in your application.

Add Package Dependency

In Xcode, select File > Add Packages....

Specify the Repository

Copy and paste the following into the search/input box.

https://github.com/realm/realm-swift.git

Specify Options

In the options for the realm-swift package, we recommend setting the Dependency Rule to Up to Next Major Version, and enter the current Swift library version . Then, click Add Package.

Select the Package Products

Select either RealmSwift or Realm, then click Add Package.

• If you use only Objective-C APIs, add Realm.

• If you use Swift or Swift and Objective-C APIs, add RealmSwift.

(Optional) Build Realm as a Dynamic Framework

To use the Privacy Manifest supplied by the SDK, build Realm or RealmSwift as a dynamic framework. If you build the library as a static framework, you must supply your own Privacy Manifest.

To build the library as a dynamic framework:

1. In your project Targets, select your build target.

2. Go to the General tab.

3. Expand the Frameworks and Libraries element.

4. For the Realm framework, change the Embed option from "Do Not Embed" to "Embed & Sign."

Now, Xcode builds Realm dynamically, and can provide the SDK-supplied Privacy Manifest.

Update the CocoaPods repositories

Initialize CocoaPods for Your Project

If you do not already have a Podfile for your project, run pod init in the root directory of your project to create a Podfile for your project. A Podfile allows you to specify project dependencies to CocoaPods.

Add the SDK as a Dependency in Your Podfile

Add a use_frameworks! line to your Podfile if it is not already there.

Add the line pod 'Realm', '~>10' to your main and test targets.

When done, your Podfile should look similar to this:

platform :ios, '12.0'
target 'MyDeviceSDKProject' do
# Comment the next line if you don't want to use dynamic frameworks
use_frameworks!
# Pods for MyDeviceSDKProject
pod 'Realm', '~>10'
target 'MyRealmProjectTests' do
inherit! :search_paths
# Pods for testing
pod 'Realm', '~>10'
end

Install the Dependencies

From the command line, run pod install to fetch the dependencies.

Use the CocoaPods-Generated .xcworkspace File

CocoaPods generates an .xcworkspace file for you. This file has all of the dependencies configured. From now on, open this file -- not the .xcodeproj file -- to work on your project.

Add the SDK as a Dependency in Your Cartfile

Add the SDK as a dependency by appending the line github "realm/realm-swift" to your Cartfile.

You can create a Cartfile or append to an existing one by running the following command in your project directory:

echo 'github "realm/realm-swift"' >> Cartfile

Install the Dependencies

From the command line, run carthage update --use-xcframeworks to fetch the dependencies.

Add the Frameworks to Your Project

Carthage places the built dependencies in the Carthage/Build directory.

Open your project's xcodeproj file in Xcode. Go to the Project Navigator panel and click your application name to open the project settings editor. Select the General tab.

In Finder, open the Carthage/Build/ directory. Drag the RealmSwift.xcframework and Realm.xcframework files found in that directory to the Frameworks, Libraries, and Embedded Content section of your project's General settings.

click to enlarge

Download and Extract the Framework

Download the latest release of the Swift library and extract the zip.

Copy Framework(s) Into Your Project

Drag Realm.xcframework and RealmSwift.xcframework (if using) to the File Navigator of your Xcode project. Select the Copy items if needed checkbox and press Finish.

Add Package Dependency

In Xcode, select File > Add Packages....

Specify the Repository

Copy and paste the following into the search/input box.

https://github.com/realm/realm-swift.git

Specify Options

In the options for the realm-swift package, we recommend setting the Dependency Rule to Up to Next Major Version, and enter the current Swift library version . Then, click Add Package.

Select the Package Products

Select either RealmSwift or Realm, then click Add Package.

• If you use Swift or Swift and Objective-C APIs, add RealmSwift.

• If you use only Objective-C APIs, add Realm.

(Optional) Build RealmSwift as a Dynamic Framework

To use the Privacy Manifest supplied by the SDK, build the library as a dynamic framework. If you build the library as a static framework, you must supply your own Privacy Manifest.

To build the library as a dynamic framework:

1. In your project Targets, select your build target.

2. Go to the General tab.

3. Expand the Frameworks and Libraries element.

4. For the RealmSwift framework, change the Embed option from "Do Not Embed" to "Embed & Sign."

Now, Xcode builds RealmSwift dynamically, and can provide the SDK-supplied Privacy Manifest.

Update the CocoaPods repositories

Initialize CocoaPods for Your Project

If you do not already have a Podfile for your project, run pod init in the root directory of your project to create a Podfile for your project. A Podfile allows you to specify project dependencies to CocoaPods.

Add the SDK as a Dependency in Your Podfile

Add a use_frameworks! line to your Podfile if it is not already there.

Add the line pod 'RealmSwift', '~>10' to your main and test targets.

When done, your Podfile should look similar to this:

platform :ios, '12.0'
target 'MyDeviceSDKProject' do
# Comment the next line if you don't want to use dynamic frameworks
use_frameworks!
# Pods for MyDeviceSDKProject
pod 'RealmSwift', '~>10'
end

Install the Dependencies

From the command line, run pod install to fetch the dependencies.

Use the CocoaPods-Generated .xcworkspace File

CocoaPods generates an .xcworkspace file for you. This file has all of the dependencies configured. From now on, open this file -- not the .xcodeproj file -- to work on your project.

Add the SDK as a Dependency in Your Cartfile

Add the SDK as a dependency by appending the line github "realm/realm-swift" to your Cartfile.

You can create a Cartfile or append to an existing one by running the following command in your project directory:

echo 'github "realm/realm-swift"' >> Cartfile

Install the Dependencies

From the command line, run carthage update --use-xcframeworks to fetch the dependencies.

Add the Frameworks to Your Project

Carthage places the built dependencies in the Carthage/Build directory.

Open your project's xcodeproj file in Xcode. Go to the Project Navigator panel and click your application name to open the project settings editor. Select the General tab.

In Finder, open the Carthage/Build/ directory. Drag the RealmSwift.xcframework and Realm.xcframework files found in that directory to the Frameworks, Libraries, and Embedded Content section of your project's General settings.

click to enlarge

Download and Extract the Framework

Download the latest release of the Swift library and extract the zip.

Copy Framework(s) Into Your Project

Drag Realm.xcframework and RealmSwift.xcframework (if using) to the File Navigator of your Xcode project. Select the Copy items if needed checkbox and press Finish.