Installation - Couchbase Lite on Objective-C
Description — Installing Couchbase Lite on Objective-C
Get Started
Create or open an existing Xcode project and install _Couchbase Lite 4.0.1 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:
|
Install Couchbase Lite
-
Direct Download
-
Carthage
-
CocoaPods
-
Download the binaries from here — Extend with Mobile.
-
Unpack the download zip file into your XCode project location.
-
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 Carthage is 38.0 |
-
In your Cartfile, add the following.
Couchbase Lite Community Editionbinary "https://packages.couchbase.com/releases/couchbase-lite-ios/carthage/CouchbaseLite-Community.json" ~> 4.0.1Couchbase Lite Enterprise Editionbinary "https://packages.couchbase.com/releases/couchbase-lite-ios/carthage/CouchbaseLite-Enterprise.json" ~> 4.0.1 -
Run
carthage update --platform ios. -
Drag CouchbaseLite.xcframework from Carthage/Build/ to the Xcode navigator.
-
Click on Project > General > Embedded Binary and add CouchbaseLite.xcframework to this section.
| The minimum required version of Cocoapods is 1.15 |
-
In your Podfile, add the following.
Couchbase Lite Community Editiontarget '<your target name>' do use_frameworks! pod 'CouchbaseLite', '4.0.1' endCouchbase Lite Enterprise Editiontarget '<your target name>' do use_frameworks! pod 'CouchbaseLite-Enterprise', '4.0.1' end -
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. 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
-
Carthage
-
CocoaPods
-
Download the binaries from here — binary download link.
-
Unpack the download zip file into your XCode project location.
-
Select your target settings in XCode and drag CouchbaseLiteVectorSearch.xcframework from your Finder to the Frameworks, Libraries, and Embedded Content section.
-
Start using Couchbase Lite Vector Search on Swift in your project.
| The minimum required version of Carthage is 38.0 |
-
In your Cartfile, add the following.
Couchbase Lite Enterprise Editionbinary "http://packages.couchbase.com/releases/couchbase-lite-vector-search/carthage/CouchbaseLiteVectorSearch.json" ~> 2.0.0 -
Run
carthage update --platform ios. -
Drag CouchbaseLite.xcframework from Carthage/Build/ to the Xcode navigator.
-
Click on Project > General > Embedded Binary and add CouchbaseLite.xcframework to this section.
| The minimum required Cocoapods version is 1.15 |
-
Install CocoaPods using the instructions here:
https://guides.cocoapods.org/using/getting-started.html -
Add one of these targets to your Podfile:
Couchbase Lite Enterprise Editiontarget 'Example' do use_frameworks! pod 'CouchbaseLiteVectorSearch', '2.0.0' (1) end1 Specify the required version number, here we use the latest version -
Install the pods and open the
.xcworkspacefile generated by CocoaPods, using:pod install