Description — Working with Couchbase Lite on Java databases
      Related Content — Blobs | Documents | Indexing

      Database Concepts

      Databases created on Couchbase Lite can share the same hierarchical structure as Capella databases. This makes it easier to sync data between mobile applications and applications built using Capella.

      Couchbase Lite Database Hierarchy
      Figure 1. Couchbase Lite Database Hierarchy

      Although the terminology is different, the structure can be mapped to relational database terms:

      Table 1. Relational Database → Couchbase
      Relational database Couchbase







      This structure gives you plenty of choices when it comes to partitioning your data. The most basic structure is to use the single default scope with a single default collection; or you could opt for a structure that allow you to split your collections into logical scopes.

      Couchbase Lite Examples
      Figure 2. Couchbase Lite Examples
      Storing local configuration

      You may not need to sync all the data related for a particular application. You can set up a scope that syncs data, and a second scope that doesn’t.

      One reason for doing this is to store local configuration data (such as the preferred screen orientation or keyboard layout). Since this information only relates to a particular device, there is no need to sync it:

      local data scope

      Contains information pertaining to the device.

      syncing data scope

      Contains information pertaining to the user, which can be synced back to the cloud for use on the web or another device.


      Your first step in using the API must be to call its initializer. An exception is raised if any other API method is invoked before the initializer.

      Example 1. Initializer code
      // Initialize the Couchbase Lite system

      Create or Open Database

      You can create a new database and-or open an existing database, using the Database class. Just pass in a database name and optionally a DatabaseConfiguration — see Example 2.

      Things to watch for include:

      • If the named database does not exist in the specified, or default, location then a new one is created

      • The database is created in a default location unless you specify a directory for it — see: DatabaseConfiguration and DatabaseConfiguration.setDirectory()

        Best Practice is to always specify the path to the database explicitly.

        Typically, the default location for Java is the application sandbox .

      Example 2. Open or create a database
      DatabaseConfiguration config = new DatabaseConfiguration();
      Database database = new Database(DB_NAME, config);

      Close Database

      You are advised to incorporate the closing of all open databases into your application workflow.

      To close a database, use Database.close() — see: Example 3. This also closes [1] active replications, listeners and-or live queries connected to the database.

      Closing a database soon after starting a replication involving it can cause an exception as the asynchronous replicator (start) may not yet be connected.
      Safely Closing a Database pre 2.8
      Before closing, check that any attached listeners (query/replication/change) indicate they are at least at connected status before closing — see for example: Monitor Status.
      Example 3. Close a Database

      Database Encryption

      This is an Enterprise Edition feature.

      Couchbase Lite on Java includes the ability to encrypt Couchbase Lite databases. This allows mobile applications to secure the data at rest, when it is being stored on the device. The algorithm used to encrypt the database is 256-bit AES.


      To enable encryption, use DatabaseConfiguration.setEncryptionKey() to set the encryption key of your choice. Provide this encryption key every time the database is opened — see Example 4.

      Example 4. Configure Database Encryption
      DatabaseConfiguration config = new DatabaseConfiguration();
      config.setEncryptionKey(new EncryptionKey("PASSWORD"));
      Database database = new Database(DB_NAME, config);


      Couchbase Lite does not persist the key. It is the application’s responsibility to manage the key and store it in a platform-specific secure store such Android’s Keystore.


      An encrypted database can only be opened with the same language SDK that was used to encrypt it in the first place. So a database encrypted using the Java SDK, and then exported, is readable only by the Java SDK.


      To change an existing encryption key, open the database using its existing encryption-key and use Database.changeEncryptionKey() to set the required new encryption-key value.


      To remove encryption, open the database using its existing encryption-key and use Database.changeEncryptionKey() with a null value as the encryption key.


      To upgrade an encrypted database see: Upgrade 1.x databases

      Finding a Database File

      By default a Couchbase Lite on Java database is created in a directory at the current location called <databaseName>.cblite2.

      This location is set by the DatabaseConfiguration method. You should always use it to explicitly set the database location. See the following example for how to do this:

      DatabaseConfiguration thisConfig = new DatabaseConfiguration(); thisConfig.setDirectory("yourDBpath");
      Database thisDB = new Database("db", thisConfig);

      Database Maintenance

      From time to time it may be necessary to perform certain maintenance activities on your database, for example to compact the database file, removing unused documents and blobs no longer referenced by any documents.

      Couchbase Lite’s API provides the Database.performMaintenance() method. The available maintenance operations, including compact are as shown in the enum MaintenanceType to accomplish this.

      This is a resource intensive operation and is not performed automatically. It should be run on-demand using the API. If in doubt, consult Couchbase support.

      Command Line Tool

      cblite is a command-line tool for inspecting and querying Couchbase Lite databases.

      You can download and build it from the couchbaselabs GitHub repository. Note that the cblite tool is not supported by the Couchbase Support Policy.


      You should use console logs as your first source of diagnostic information. If the information in the default logging level is insufficient you can focus it on database errors and generate more verbose messages — see: Example 5.

      For more on using Couchbase logs — see: Using Logs.

      Example 5. Increase Level of Database Log Messages

      1. Commencing with Release 2.8