Couchbase Lite for iOS and MacOS
Couchbase Lite is an embedded lightweight, document-oriented (NoSQL), syncable database engine.
Couchbase Lite 2.x has a completely new set of APIs. The implementation is on top of Couchbase Lite Core, which is also a new cross-platform implementation of database CRUD and query features, as well as document versioning.
Requirements
- iOS 9.0+ | macOS 10.11+
- Xcode 10.3+
Installation
Swift Package
Requirements:
- XCode 12+
Community Edition
dependencies: [
.package(name: "CouchbaseLiteSwift",
url: "https://github.com/couchbase/couchbase-lite-ios.git",
from: "2.8.0"),
],
Enterprise Edition
dependencies: [
.package(name: "CouchbaseLiteSwift",
url: "https://github.com/couchbase/couchbase-lite-swift-ee.git",
from: "2.8.0"),
],
More detailed information on how to setup is available here: swift package manager
CocoaPods
You can use CocoaPods to install CouchbaseLite for Objective-C API or CouchbaseLiteSwift for Swift API by adding it in your Podfile:
Objective-C
Community Edition
target '<your target name>' do
use_frameworks!
pod 'CouchbaseLite'
end
Enterprise Edition
target '<your target name>' do
use_frameworks!
pod 'CouchbaseLite-Enterprise'
end
Swift
Community Edition
target '<your target name>' do
use_frameworks!
pod 'CouchbaseLite-Swift'
end
Enterprise Edition
target '<your target name>' do
use_frameworks!
pod 'CouchbaseLite-Swift-Enterprise'
end
Carthage
You can use Carthage to install CouchbaseLite by adding it in your Cartfile:
Community Edition
binary "https://packages.couchbase.com/releases/couchbase-lite-ios/carthage/CouchbaseLite-Community.json"
Enterprise Edition
binary "https://packages.couchbase.com/releases/couchbase-lite-ios/carthage/CouchbaseLite-Enterprise.json"
When running
carthage update or build, Carthage will build both CouchbaseLite and CouchbaseLiteSwift framework.
How to build the framework files.
- Clone the repo and update submodules
$ git clone https://github.com/couchbase/couchbase-lite-ios.git
$ cd couchbase-lite-ios
$ git submodule update --init --recursive
-
If not already installed, install doxygen,
brew install doxygen -
Run ./Scripts/build_framework.sh to build a platform framework which could be either an Objective-C or a Swift framework. The supported platforms include iOS, tvOS, and macOS.
$ ./Scripts/build_framework.sh -s "CBL ObjC" -p iOS -o output // For building the ObjC framework for iOS
$ ./Scripts/build_framework.sh -s "CBL Swift" -p iOS -o output // For building the Swift framework for iOS
Documentation
Sample Apps
- Todo : Objective-C and Swift
License
Like all Couchbase source code, this is released under the Apache 2 license.