Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

Installing Couchbase Lite on Android

    Description — How to install Couchbase Lite on Android
    Abstract — Getting you up and running quickly with Couchbase Lite on android

    Introduction

    Couchbase Lite on Android supports the development of applications in Java or Kotlin.

    You can install Couchbase Lite Community and-or Enterprise editions from the Maven repository. There are separate downloads for Kotlin and Java.

    Enterprise users can also download the Couchbase Lite Vector Search extension library. Installation instructions are included in the step-by-step install guides for both Java and Kotlin.

    Couchbase Lite Quick Steps

    For experienced developers, this is all you need to add _Couchbase Lite for Android 3.2.4 to your application projects.

    Kotlin - Enterprise

    1. Create a Kotlin Android app project in Android Studio

    2. Add Couchbase Lite as a dependency in your app-level build.gradle
      implementation 'com.couchbase.lite:couchbase-lite-android-ee-ktx:3.2.4'

    3. Add the following maven repo to your repositories (in build.gradle or settings.gradle as required
      https://mobile.maven.couchbase.com/maven2/dev/

      1. If you want to use Vector Search, add the Couchbase Lite Vector Search dependency for architectures other than x86_64: com.couchbase.lite:couchbase-lite-java-vector-search-arm64-1.0.1

        1. For x86_64 architectures: com.couchbase.lite:couchbase-lite-android-vector-search-x86_64-1.0.1

      2. You must then use CouchbaseLite.enableVectorSearch(); to enable the vector search extension.

    4. Build the project and it will pull Couchbase Lite down.

    Kotlin - Community

    1. Create a Kotlin Android app project in Android Studio

    2. Add Couchbase Lite as a dependency in your app-level build.gradle
      implementation 'com.couchbase.lite:couchbase-lite-android-ktx:3.2.4'

    3. Check you have mavenCentral() in repositories (or in settings.gradle)

    4. Build the project and it will pull Couchbase Lite down.

    Java - Enterprise

    1. Create a Java Android app project in Android Studio

    2. Add Couchbase Lite as a dependency in your app-level build.gradle
      implementation 'com.couchbase.lite:couchbase-lite-android-ee:3.2.4'

    3. Add the following maven repo to your repositories (in build.gradle or settings.gradle as required
      https://mobile.maven.couchbase.com/maven2/dev/

      1. If you want to use Vector Search, add the Couchbase Lite Vector Search dependency for architectures other than x86_64: com.couchbase.lite:couchbase-lite-java-vector-search-arm64-1.0.1

        1. For x86_64 architectures: com.couchbase.lite:couchbase-lite-android-vector-search-x86_64-1.0.1

      2. You must then use CouchbaseLite.enableVectorSearch(); to enable the vector search extension.

    4. Build the project and it will pull Couchbase Lite down.

    Java - Community

    1. Create a Java Android app project in Android Studio

    2. Add Couchbase Lite as a dependency in your app-level build.gradle
      implementation 'com.couchbase.lite:couchbase-lite-android:3.2.4'

    3. Check you have mavenCentral() in repositories (or in settings.gradle)

    4. Build the project and it will pull Couchbase Lite down.

    That’s it! You''re all set to begin developing powerful Couchbase Lite applications.

    Now, try the Getting Started application, which demonstrates use of key CRUD functionality.

    Kotlin - Step-by-Step Install

    More detailed instructions on getting up and running with Couchbase Lite for Android (Kotlin).

    The Kotlin download also includes the Java version of Couchbase Lite for Android, along with the other dependencies.

    Create or open an existing Android Studio project and include the following entries in the app-level build.gradle file (typically in the app folder).

    • Enterprise Edition

    • Community Edition

    1. Include the following in the android {} section:

      android {
// Required only if your project has some Kotlin source code
  kotlinOptions { jvmTarget = 1.8}

  compileOptions {
      targetCompatibility 1.8
      sourceCompatibility 1.8
  }

//   ... other section content as required by user
}

    2. Include the following in the repositories {} section:

      repositories {
  maven { url 'https://mobile.maven.couchbase.com/maven2/dev/' }

//   ... other section content as required by user
}

    3. Include the following in the dependencies{} section:

      dependencies {

  implementation 'com.couchbase.lite:couchbase-lite-android-ee-ktx:3.2.4'

//   ... other section content as required by user
}

    1. Set the Java Version, include the following in the android {} section:

      android {
  compileOptions {
      sourceCompatibility JavaVersion.VERSION_1_8
      targetCompatibility JavaVersion.VERSION_1_8
  }
//   ... other section content as required by user
}

    2. Ensure your repositories section includes mavencentral()

      repositories {

  mavenCentral()

  //   ... other section content as required by user
}

    3. Add Couchbase Lite to the dependencies{} section:

      dependencies {

  implementation "com.couchbase.lite:couchbase-lite-android-ktx:3.2.4"

//   ... other section content as required by user
}

    Kotlin Vector Search Extension: Detailed Installation Instructions

    You can get set up with the Vector Search Extension for Android (Kotlin) by following these instructions.

    The Kotlin download also includes the Java version of Couchbase Lite for Android, along with the other dependencies.

    Create or open an existing Android Studio project and include the following entries in the app-level build.gradle file (typically in the app folder).

    You must have Couchbase Lite installed before you can use the Vector Search Extension. Vector Search is available only for 64-bit architectures. The Vector Search extension is an Enterprise-only feature.

    Installing the Vector Search Extension

    1. Include the following in the android {} section:

      android {
// Required only if your project has some Kotlin source code
  kotlinOptions { jvmTarget = 1.8}

  compileOptions {
      targetCompatibility 1.8
      sourceCompatibility 1.8
  }

//   ... other section content as required by user
}

    2. Include the following in the repositories {} section:

      repositories {
  maven { url 'https://mobile.maven.couchbase.com/maven2/dev/' }
  google()
  mavenCentral()
//   ... other section content as required by user
}

    3. For architectures other than x86_64:

      dependencies {

  implementation 'com.couchbase.lite:couchbase-lite-android-ee-ktx:3.2.4'

  // All standard 64-bit ARM architectures
  implementation 'com.couchbase.lite:couchbase-lite-android-vector-search-arm64-1.0.1'

//   ... other section content as required by user
}

      1. For x86_64 architectures:

        dependencies {

  implementation 'com.couchbase.lite:couchbase-lite-android-ee-ktx:3.2.4'

  implementation 'com.couchbase.lite:couchbase-lite-android-vector-search-x86_64-1.0.1'

//   ... other section content as required by user
}

    4. To activate the extension, the snippet below is required:

            try { CouchbaseLite.enableVectorSearch(); }
        catch (CouchbaseLiteException e) {
            throw new IllegalStateException("Could not enable vector search", e);
        }

    Java - Step-by-step Install

    More detailed instructions on getting up and running with Couchbase Lite for Android (Java).

    Create or open an existing Android Studio project and install Couchbase Lite using the following method.

    Include the following entries to the app-level build.gradle file (typically in the app folder).

    • Enterprise

    • Community

    1. Set the Java Version, include the following in the android {} section:

      android {
// Required only if your project has some Kotlin source code
  kotlinOptions { jvmTarget = 1.8}

  compileOptions {
      targetCompatibility 1.8
      sourceCompatibility 1.8
  }

//   ... other section content as required by user
}

    2. Add the following in the repositories {} section:

      repositories {
  maven { url 'https://mobile.maven.couchbase.com/maven2/dev/' }

//   ... other section content as required by user
}

    3. Add Couchbase Lite to your dependencies{} section:

      dependencies {

  implementation 'com.couchbase.lite:couchbase-lite-android-ee:3.2.4'

//   ... other section content as required by user
}

    1. Include the following in the android {} section:

      android {
// Required only if your project has some Kotlin source code
  kotlinOptions { jvmTarget = 1.8 }

  compileOptions {
      targetCompatibility 1.8
      sourceCompatibility 1.8
  }

//   ... other section content as required by user
}

    2. Ensure your repositories section includes mavencentral()

      repositories {

  mavenCentral()

  //   ... other section content as required by user
}

    3. Include the following in the dependencies{} section:

      dependencies {
  implementation 'com.couchbase.lite:couchbase-lite-android:3.2.4'
//   ... other section content as required by user
}

    Java Vector Search Extension: Detailed Installation Instructions

    The Vector Search extension is an Enterprise-only feature.

    You can get set up with the Vector Search Extension for Android (Java) by following these instructions.

    Create or open an existing Android Studio project and install Couchbase Lite using the following method.

    Include the following entries to the app-level build.gradle file (typically in the app folder).

    Installing the Vector Search Extension

    To use Vector Search, you must have Couchbase Lite installed and add the Vector Search extension to your Couchbase Lite application. Vector Search is available only for 64-bit architectures and Intel processors that support the Advanced Vector Extensions 2 (AVX2) instruction set. To verify whether your device supports the AVX2 instructions set, follow these instructions.

    1. Include the following in the android {} section:

      android {
// Required only if your project has some Kotlin source code
  kotlinOptions { jvmTarget = 1.8}

  compileOptions {
      targetCompatibility 1.8
      sourceCompatibility 1.8
  }

//   ... other section content as required by user
}

    2. Include the following in the repositories {} section:

      repositories {
  maven { url 'https://mobile.maven.couchbase.com/maven2/dev/' }
  google()
  mavenCentral()
//   ... other section content as required by user
}

    3. Include the following in the dependencies{} section:

      dependencies {

  implementation 'com.couchbase.lite:couchbase-lite-android-ee-ktx:3.2.4'

  // All standard 64-bit ARM architectures
  implementation 'com.couchbase.lite:couchbase-lite-android-vector-search-arm64-1.0.1'

//   ... other section content as required by user
}

      1. For running on x86_64 architectures, include the following in the dependencies{} section instead:

        dependencies {

  implementation 'com.couchbase.lite:couchbase-lite-android-ee-ktx:3.2.4'

  implementation 'com.couchbase.lite:couchbase-lite-android-vector-search-x86_64-1.0.0-1.0.1'

//   ... other section content as required by user
}

    4. To activate the extension, the snippet below is required:

              try { CouchbaseLite.enableVectorSearch(); }
        catch (CouchbaseLiteException e) {
            throw new IllegalStateException("Could not enable vector search", e);
        }

    Related Content

    How to . . .

    .

    Learn more . . .

    .

    Dive Deeper . . .

    Mobile Forum | Blog | Tutorials

    .