DatabaseOptions Class |
Options for opening a database. All properties default to false or null.
Inheritance HierarchyNamespace: Couchbase.Lite
Assembly: Couchbase.Lite (in Couchbase.Lite.dll) Version: 1.4.1-b107
SyntaxC#
public sealed class DatabaseOptions
The DatabaseOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DatabaseOptions | Initializes a new instance of the DatabaseOptions class |
Properties| Name | Description | |
|---|---|---|
 | Create |
Create database if it doesn't exist?
|
| EncryptionKey |
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 default, null,
means the database is not encrypted.
|
| ReadOnly |
Open database read-only?
|
| StorageType |
The underlying storage engine to use. Legal values are SQLITE_STORAGE, FORESTDB_STORAGE,
or null.
* 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.)
|
Fields| Name | Description | |
|---|---|---|
  | FORESTDB_STORAGE | Obsolete.
The identifier for ForestDB based storage
|
| SQLITE_STORAGE | Obsolete.
The identifier for SQLite based storage
|
See Also