You are viewing the documentation for a prerelease version.

View Latest

Installation - Couchbase Lite on Objective-C

    • Beta
      +

      Description — Installing Couchbase Lite on Objective-C

      Get Started

      Create or open an existing Xcode project and install _Couchbase Lite 3.2.0-beta.2 using one of the Install Couchbase Lite methods shown.

      Enterprise users can also download the Couchbase Lite Vector Search extension library.

      Couchbase Lite is distributed as an xcframework, to support this:

      • The minimum required Cocoapods version is 1.15

      • The minimum required Carthage version is 0.38

      Install Couchbase Lite

      There is no Carthage support for the 3.2.0 Beta-1 of Couchbase Lite.
      • Direct Download

      • CocoaPods

      1. Download the binaries from here — Extend with Mobile.

      2. Unpack the download zip file into your XCode project location.

      3. Select your target settings in XCode and drag CouchbaseLite.xcframework from your Finder to the Frameworks, Libraries, and Embedded Content section.

        • Import the xcframework and start using it in your project.

          #include <CouchbaseLite/CouchbaseLite.h>
          ...
      The minimum required version of Cocoapods is 1.15
      1. Install Cocoapods

      2. In your Podfile, add the following.

        Couchbase Lite Community Edition
        target '<your target name>' do
          use_frameworks!
          pod 'CouchbaseLite', '3.2.0-beta.2'
        end
        Couchbase Lite Enterprise Edition
        target '<your target name>' do
          use_frameworks!
          pod 'CouchbaseLite-Enterprise', '3.2.0-beta.2'
        end
      3. Install the pods and open the .xcworkspace file generated by Cocoapods.

        pod install

      Install Vector Search Extension

      Vector Search is an Enterprise-only feature.

      You can get set up with the Vector Search Extension for iOS (Objective-C) by following these instructions.

      To use Vector Search, you must have Couchbase Lite installed and add the Vector Search extension to your Couchbase Lite application. There is no Carthage support for the beta release of Vector Search. 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.

      • Direct Download

      • CocoaPods

      1. Download the binaries from here — binary download link.

      2. Unpack the download zip file into your XCode project location.

      3. Select your target settings in XCode and drag CouchbaseLiteVectorSearch.xcframework from your Finder to the Frameworks, Libraries, and Embedded Content section.

      4. Start using Couchbase Lite Vector Search on Swift in your project.

      The minimum required Cocoapods version is 1.15
      1. Install CocoaPods using the instructions here:
        https://guides.cocoapods.org/using/getting-started.html

      2. Add one of these targets to your Podfile:

        Couchbase Lite Enterprise Edition
        target 'Example' do
          use_frameworks!
          pod 'CouchbaseLiteVectorSearch', '1.0.0-beta.2' (1)
        end
        1 Specify the required version number, here we use the latest version of the beta
      3. Install the pods and open the .xcworkspace file generated by CocoaPods, using:

        pod install