com.couchbase.lite

Class DatabaseOptions

java.lang.Object

com.couchbase.lite.DatabaseOptions

public class DatabaseOptions
extends java.lang.Object

Options for opening a database. All properties default to false or null.

Constructor Summary

Constructors

Constructor and Description
DatabaseOptions()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getEncryptionKey() Get the encryption key.
java.lang.String	getStorageType() Get the storage type.
boolean	isCreate() Get Create option value.
boolean	isReadOnly() Get ReadOnly option value
void	setCreate(boolean create) Set Create option.
void	setEncryptionKey(java.lang.Object encryptionKey) Set a key to encrypt the database with.
void	setReadOnly(boolean readOnly) Set ReadOnly option.
void	setStorageType(java.lang.String storageType) Set the underlying storage engine to use.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatabaseOptions

public DatabaseOptions()

Method Detail

setCreate

public void setCreate(boolean create)

Set Create option. If set to True, opening a database will create the database if it doesn't exist.

isCreate

public boolean isCreate()

Get Create option value.

Returns:

Create option value.

setReadOnly

public void setReadOnly(boolean readOnly)

Set ReadOnly option. If set to True, the database will be opened in read-only mode.

isReadOnly

public boolean isReadOnly()

Get ReadOnly option value

Returns:

ReadOnly option value

setStorageType

public void setStorageType(java.lang.String storageType)

Set the underlying storage engine to use. Legal values are @"SQLite", @"ForestDB", or nil.

• If the database is being created, the given storage engine will be used, or the default if the value is null
• If the database exists, and the value is not null, the database will be upgraded to that storage engine if possible. (SQLite-to-ForestDB upgrades are supported.)

getStorageType

public java.lang.String getStorageType()

Get the storage type.

Returns:

Storage type.

setEncryptionKey

public void setEncryptionKey(java.lang.Object encryptionKey)

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.

• The primary form of key is an NSData object 32 bytes in length: this is interpreted as a raw AES-256 key. To create a key, generate random data using a secure cryptographic randomizer like SecRandomCopyBytes or CCRandomGenerateBytes.
• Alternatively, the value may be an NSString containing a passphrase. This will be run through 64,000 rounds of the PBKDF algorithm to securely convert it into an AES-256 key.
• A default null value, of course, means the database is unencrypted.

getEncryptionKey

public java.lang.Object getEncryptionKey()

Get the encryption key.

Returns:

Encryption key.