Databases — Data Model
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.
// Initialize the Couchbase Lite system CouchbaseLite.init();
Things to watch for include:
Opening/Creating a database is an asynchronous process
If the named database does not exist in the specified, or default, location then a new one is created
Best Practice is to always specify the path to the database explicitly.
Typically, the default location for Java is the application sandbox.
See also Finding a Database File.
DatabaseConfiguration config = new DatabaseConfiguration(); config.setDirectory(context.getFilesDir().getAbsolutePath()); Database database = new Database(DB_NAME, config);
|1||Here we are specifying the database directory path.|
You are advised to incorporate the closing of all open databases into your application workflow.
Closing a database is a synchronous operation, it is effective immediately
You cannot close a database that is not open.
Remember that opening (or creating) a database is asynchronous. So issuing a close immediately after initiating an open/create, may result in an error if that process has not completed.
Closing a database  also closes any active replications, listeners and-or live queries attached to the database.
Closing a database immediately after kicking-off a replication could cause the sync to generate an exception.
IllegalStateException: Attempt to perform an operation on a closed database
|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, you must set the
DatabaseConfiguration.encryptionKey property to the encryption key of your choice.
Provide this encryption key every time the database is opened.
DatabaseConfiguration config = new DatabaseConfiguration(); config.setEncryptionKey(new EncryptionKey("PASSWORD")); Database database = new Database(DB_NAME, config);
An encrypted database can only be opened with the same language SDK that was used to encrypt it in the first place (Swift, C#, Java, Java (Android) or Objective-C). For example, if a database is encrypted with the Swift SDK and then exported, it will only be readable with the Swift SDK.
If you’re migrating an application from Couchbase Lite 1.x to 2.x, note that the automatic database upgrade functionality is not supported for encrypted databases. Thus, to upgrade an encrypted 1.x database, you should do the following:
Disable encryption using the Couchbase Lite 1.x framework (see 1.x encryption guide)
Open the database file with encryption enabled using the Couchbase Lite 2.x framework.
Since it is not possible to package Couchbase Lite 1.x and Couchbase Lite 2.x in the same application this upgrade path would require two successive upgrades. If you are using Sync Gateway to synchronize the database content, it may be preferable to run a pull replication from a new 2.x database with encryption enabled and delete the 1.x local database.
By default a Couchbase Lite on Java database is created in a directory at the current location called
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);
You should use Couchbase’s 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 4.
For more on using Couchbase logs — see: Using Logs.