Install Realm - Android SDK¶

Add the Realm Dependency to the Project-Level build.gradle File¶

Create or open your project in Android Studio. Select the "Project" view in the top-left panel:

Open the project-level build.gradle file:

Paste the Realm classpath into the buildscript.dependencies block:

classpath "io.realm:realm-gradle-plugin:10.3.1"

When done, your project-level build.gradle should look something like this:

buildscript {
    repositories {
        google()
        jcenter()
    }
    dependencies {
        classpath "com.android.tools.build:gradle:3.5.1"
        classpath "io.realm:realm-gradle-plugin:10.3.1"
    }
}
allprojects {
    repositories {
        google()
        jcenter()
    }
    dependencies {
    }
}
task clean(type: Delete) {
    delete rootProject.buildDir
}

Add Realm to the Application-Level build.gradle File¶

Expand the app folder on the "Project" view in the top-left panel to reveal the application files. Open the application-level build.gradle file in this folder:

If your application uses the Kotlin programming language, you need to apply the kotlin-kapt plugin:

apply plugin: 'kotlin-kapt'

Apply the realm-android plugin near the top of your application level build.gradle file:

apply plugin: 'realm-android'

If your application uses sync, you must enable the sync features of the Android SDK here:

realm {
   syncEnabled = true
}

When done, your application-level build.gradle file should look something like this:

apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
apply plugin: 'kotlin-kapt'
apply plugin: 'realm-android'
android {
   compileSdkVersion 29
   buildToolsVersion "29.0.2"
   defaultConfig {
      applicationId "com.mongodb.realmsnippets"
      minSdkVersion 21
      targetSdkVersion 29
   }
   compileOptions {
      sourceCompatibility 1.8
      targetCompatibility 1.8
   }
}
realm {
   syncEnabled = true
}
dependencies {
   implementation fileTree(dir: 'libs', include: ['*.jar'])
   implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
   implementation "androidx.appcompat:appcompat:1.1.0"
   implementation "androidx.core:core-ktx:1.2.0"
}

realm {
   syncEnabled = true
}

Sync Project with Gradle Files¶

Now that you have updated the build.gradle files, resolve the dependencies by clicking File > Sync Project with Gradle Files.

Once Android Studio has resolved the dependencies, you can get started with Realm. Import the Realm SDK with this import statement in your .java or .kt files:

import io.realm.Realm