Install Couchbase Lite for C
Description — Installing Couchbase Lite for C
- Steps in Getting Started
-
Install | Build and Run
Download
Couchbase Lite for C 3.1.9 is available for all supported platforms — see: Platform Availability.
You can obtain the downloads here:
-
Android, iOS and Windows — Mobile & Edge
-
Linux and macOS — downloads table
The binary release download comprises a root directory (libcblite-community), which contains:
-
For Linux, Windows, Android, and Mac OS:
-
lib— the core library binaries -
include— the header files for inclusion -
bin— the Couchbase Lite for C.dllfiles (Microsoft Windows-only) .
-
-
For iOS, an xcframework.
|
Debug Symbols
Debug symbol versions are available for all desktop variants of C (Windows, macOS, Debian, Ubuntu and Raspbian) - see: downloads table. For Android and iOS the symbols are incorporated in the standard release package. |
Install for Linux
Using APT
Using the Advanced Package Tool (apt) is the easiest way to install Couchbase Lite on Ubuntu and Debian platforms. Just download the meta package that apt requires to automatically get and install Couchbase Lite, including any dependencies.
-
Download the meta package
-
curl
-
wget
curl -O https://packages.couchbase.com/releases/couchbase-release/couchbase-release-1.0-noarch.debwget https://packages.couchbase.com/releases/couchbase-release/couchbase-release-1.0-noarch.deb -
-
Install the meta package
-
apt
-
dpkg
sudo apt install ./couchbase-release-1.0-noarch.debsudo dpkg -i ./couchbase-release-1.0-noarch.deb -
-
Update the local package database
sudo apt update -
Install the required release package(s)
-
Enterprise
-
Community
Runtime Onlysudo apt install libcbliteDevelopmentsudo apt install libcblite-devRuntime Onlysudo apt install libcblite-communityDevelopmentsudo apt install libcblite-dev-community -
That’s it. At this point, you are ready to start building the Getting Started app, or doing your own thing with Couchbase Lite for C
Using .deb Package
Use your package manager to install from a local .deb file.
-
Just
wgetthe appropriate.debpackage — see downloads table for a package URL. -
Install the package and its dependency, using
apt install-
For community version:
sudo apt install ./libcblite-community sudo apt install ./libcblite-dev-community -
For enterprise version:
sudo apt install ./libcblite sudo apt install ./libcblite-dev
-
-
That’s it.
You just need to pass the-lcblitecommand-line flag to the compiler when you build.
At this point, you are ready to start building the Getting Started app, or doing your own thing with Couchbase Lite for C
Install for Windows
To install the Couchbase for C libraries on Windows from a downloaded release binary:
-
Download and extract the release package — see: Mobile & Edge
-
From within the root directory, libcblite-community, deploy the
lib,includeandbinlibraries to a location accessible to your compiler. -
Within Visual Studio:
-
Create a new C++ project
Be sure to select x64 for 64-bit builds
-
Within Project Properties → C++ directories → Library Directories, Add
<path-to-deployed-directories>/lib -
Within Project Properties → C++ directories → Include Directories, Add
<path-to-deployed-directories>/include -
Within Project Properties → Linker → Input → Additional Dependencies, Add
cblite.lib
-
-
Copy
<path-to-deployed-directories>/bin/cblite.dllto your build locationCouchbase Lite for C does not have any preferred installation path for the
.dll. It is up to you to determine where best to place it so it is available during execution, though copying to a location on the system path is not recommended on Windows
Install for macOS
To install the Couchbase for C libraries on macOS from a downloaded release package:
-
Download and extract the release package here — downloads table.
-
Optionally … From within the root directory, libcblite-community, Copy the
includeandlibdirectories to/usr/local/ -
Within Xcode:
-
Create a new project
-
Add
<path/to>/includeto the project’s Header Search Path -
Add
<path/to>/libto the project’s Library Search Path -
Drag
libcblite-community.dylibinto your Xcode project. Then, within the dialog:-
Select Create Directory References If Needed
-
Check the correct target is selected
-
-
At this point, you are ready to start building the Getting Started app, or doing your own thing with Couchbase Lite for C
Install for iOS
To install the Couchbase for C libraries for iOS from a downloaded release package:
-
Download and extract the release package here — Mobile & Edge
-
Drag
CouchbaseLite.xcframeworkinto your Xcode project, then within the dialog:-
Select Create Directory References If Needed
-
Check the correct target is selected
-
At this point, you are ready to start building the Getting Started app, or doing your own thing with Couchbase Lite for C
If you encounter a build error — Include of non-modular header inside framework module — You may need to change the build setting
allow non-modular includes in framework module to Yes.
Install for Android
This install assumes use of the Android Studio IDE. In addition to the Couchbase Lite for C download you also require the following tool chain dependencies, all installable from within Android Studio if necessary:
-
CMake 3.18.1
-
NDK 21.4.7075529
-
Build tools 30.0.2
In this instance the release comprises a ready to adapt application project.
-
Download and Unpack the binary release here — Mobile & Edge
-
Within Android Studio, select and open the project folder (within the libcblite-community folder)
-
-
Check the above dependencies are installed, select any that are not
OK to Continue
Once the install is finished, you can build and run this skeleton app.
At this point, you are ready to start building the Getting Started app, or doing your own thing with Couchbase Lite for C
Platform Availability
Couchbase Lite for C is available on the platforms shown in the tables below.
|
Deprecation Notice
Support for the following will be deprecated in this release and will be removed in a future release:
Please plan to migrate your apps to use an appropriate alternative version. |
Download Links
Couchbase Lite for C is available for all Supported Platforms. You can obtain downloads for Linux and macOS from the links here in the downloads table.
Release 3.1.9
MacOS
-
Enterprise Edition
-
Community Edition
| Platform | Download | SHA | Debug Symbols |
|---|---|---|---|
MacOS |
| Platform | Download | SHA | Debug Symbols |
|---|---|---|---|
MacOS |
Windows
-
Enterprise Edition
-
Community Edition
| Platform | Download | SHA | Debug Symbols |
|---|---|---|---|
Windows |
couchbase-lite-c-enterprise-3.1.9-windows-x86_64-symbols.zip |
| Platform | Download | SHA | Debug Symbols |
|---|---|---|---|
Windows |
Debian
-
Enterprise Edition
-
Community Edition
| Platform | Download | SHA | Debug Symbols |
|---|---|---|---|
Debian |
|||
couchbase-lite-c-community-3.1.9-linux-x86_64-symbols.tar.gz |
|||
Ubuntu
-
Enterprise Edition
-
Community Edition
| Platform | Download | SHA | Debug Symbols |
|---|---|---|---|
Ubuntu |
|||
couchbase-lite-c-community-3.1.9-linux-x86_64-symbols.tar.gz |
|||
Raspbian
Please use the Debian .deb download choosing the appropriate version (debian9 or debian10) and architecture.