Package com.couchbase.lite
Class DatabaseConfiguration
java.lang.Object
com.couchbase.lite.DatabaseConfiguration
Configuration for opening a database.
-
Constructor Summary
ConstructorsConstructorDescriptionCopy constructor -
Method Summary
Modifier and TypeMethodDescriptionprotected DatabaseConfiguration
Returns the path to the directory that contains the database.ENTERPRISE EDITION APIsetDirectory
(String directory) Set the canonical path of the directory in which to store the database.setEncryptionKey
(EncryptionKey encryptionKey) ENTERPRISE EDITION API
-
Constructor Details
-
DatabaseConfiguration
public DatabaseConfiguration() -
DatabaseConfiguration
Copy constructor- Parameters:
config
- the configuration to duplicate.
-
-
Method Details
-
setEncryptionKey
ENTERPRISE EDITION API
Set a key to encrypt the database with. If the database does not exist and is being created, it will use this key, and the same key must be given every time it's opened
- Parameters:
encryptionKey
- the key- Returns:
- this.
-
getEncryptionKey
ENTERPRISE EDITION API
Returns a key to encrypt the database with.
- Returns:
- the key
-
getDatabaseConfiguration
-
setDirectory
Set the canonical path of the directory in which to store the database. If the directory doesn't already exist it will be created. If it cannot be created an CouchbaseLiteError will be thrown.- Parameters:
directory
- the directory- Returns:
- this.
- Throws:
CouchbaseLiteError
- if the directory does not exist and cannot be created
-
getDirectory
Returns the path to the directory that contains the database. If this path has not been set explicitly (see:setDirectory
below), then it is the system default.- Returns:
- the database directory
-