Lightweight, embedded, syncable NoSQL database engine for iOS (and Mac!) apps.
Objective-C Swift Objective-C++ Shell CSS C Other
Switch branches/tags
Clone or download

README.md

Couchbase Lite 2.0

Couchbase Lite is an embedded lightweight, document-oriented (NoSQL), syncable database engine.

Couchbase Lite 2.0 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 9.3

Installation

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', '~> 2.0.0'
end
Enterprise Edition
target '<your target name>' do
  use_frameworks!
  pod 'CouchbaseLite-Enterprise', '~> 2.0.0'
end

Swift

Community Edition
target '<your target name>' do
  use_frameworks!
  pod 'CouchbaseLite-Swift', '~> 2.0.0'
end
Enterprise Edition
target '<your target name>' do
  use_frameworks!
  pod 'CouchbaseLite-Swift-Enterprise', '~> 2.0.0'
end

Carthage

You can use Carthage to install CouchbaseLite by adding it in your Cartfile:

Community Edition
binary "https://s3.amazonaws.com/cbmobile-carthage/CouchbaseLite-Community.json" ~> 2.0.0
Enterprise Edition
binary "https://s3.amazonaws.com/cbmobile-carthage/CouchbaseLite-Enterprise.json" ~> 2.0.0

When running carthage update or build, Carthage will build both CouchbaseLite and CouchbaseLiteSwift framework.

How to build the framework files.

  1. 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
  1. 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.