couchbase-lite-ios

Lightweight, embedded, syncable NoSQL database engine for iOS and MacOS apps.

Github stars Tracking Chart

Couchbase Lite for iOS and MacOS

License Build Status Coverage Status

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

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

  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. If not already installed, install doxygen, brew install doxygen

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

Main metrics

Overview
Name With Ownercouchbase/couchbase-lite-ios
Primary LanguageObjective-C
Program languageObjective-C (Language Count: 10)
Platform
License:Apache License 2.0
所有者活动
Created At2013-02-01 00:09:26
Pushed At2025-07-22 01:31:46
Last Commit At2025-07-22 04:31:43
Release Count103
Last Release Name3.2.4 (Posted on )
First Release Namea1c1 (Posted on 2013-04-22 12:23:49)
用户参与
Stargazers Count1.6k
Watchers Count82
Fork Count299
Commits Count4.8k
Has Issues Enabled
Issues Count1912
Issue Open Count2
Pull Requests Count1283
Pull Requests Open Count4
Pull Requests Close Count215
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private