Manager Class |
The top-level object that manages Couchbase Lite Databases.
Inheritance HierarchyNamespace: Couchbase.Lite
Assembly: Couchbase.Lite (in Couchbase.Lite.dll) Version: 1.4.1-b107
SyntaxC#
public sealed class Manager
The Manager type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Manager |
Initializes a Manager that stores Databases in the default directory.
|
| Manager(DirectoryInfo, ManagerOptions) |
Initializes a Manager that stores Databases in the given directory.
|
Properties| Name | Description | |
|---|---|---|
 | AllDatabaseNames |
Gets the names of all existing Databases.
|
 | DefaultOptions |
Gets the default options for creating a manager
|
| Directory |
Gets the directory where the Manager stores Database.
|
| SharedInstance |
Gets a shared, per-process, instance of Manager.
|
| StorageType |
Default storage type for newly created databases.
There are two options, StorageEngineTypes.SQLite (the default) or
StorageEngineTypes.ForestDB.
|
Methods| Name | Description | |
|---|---|---|
| AllOpenDatabases |
Returns all the databases that are open by this manager.
|
| Close |
Releases all resources used by the Manager and closes all its Databases.
|
| DeleteDatabase |
Deletes a database that can no longer be opened by other means (lost password, etc).
Note: will only work for databases created with version 1.2 or later.
|
| ForgetDatabase |
Removes the given database from the manager, along with any associated replications
|
| GetDatabase | |
| GetExistingDatabase |
Returns the Database with the given name if it exists, otherwise null.
|
| IsValidDatabaseName |
Determines if the given name is a valid Database name.
Only the following characters are valid: abcdefghijklmnopqrstuvwxyz0123456789_$()+-/
|
| OpenDatabase |
Returns the database with the given name. If the database is not yet open, the options given
will be applied; if it's already open, the options are ignored.
Multiple calls with the same name will return the same CBLDatabase instance.
|
| RegisterEncryptionKey | Obsolete.
Registers an encryption key for use when a given database is requested via GetDatabase
|
| ReplaceDatabase(String, Stream, Boolean) |
Replaces or installs a database from a zipped DB folder structure
|
| ReplaceDatabase(String, Stream, IDictionaryString, Stream) | Obsolete. Replaces or installs a database from a file. |
| ToString | (Overrides ObjectToString.) |
Fields| Name | Description | |
|---|---|---|
 | VersionString |
The version of Couchbase Lite that is running
|
See Also