Database Class |
A container for storing and maintaining Couchbase Lite Documents
Inheritance HierarchyNamespace: Couchbase.Lite
Assembly: Couchbase.Lite (in Couchbase.Lite.dll) Version: 2.0.0-b0074
SyntaxC#
public sealed class Database : IDisposable
The Database type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Database(String) |
Creates a database instance with the given name. Internally
it may be operating on the same underlying data as another instance.
|
| Database(Database) |
Copy constructor
|
| Database(String, DatabaseOptions) |
Creates a database given a name and some options
|
Properties| Name | Description | |
|---|---|---|
 | ConflictResolver |
Gets or sets the conflict resolver to use when conflicts arise
|
| DocumentCount |
Gets the total number of documents in the database
|
| Item |
Bracket operator for retrieving DocumentFragment objects
|
| Name |
Gets the name of the database
|
| Options |
Gets the options that were used to create the database
|
| Path |
Gets the path on disk where the database exists
|
Methods| Name | Description | |
|---|---|---|
| Close |
Closes the database
|
| CreateIndex(IListIExpression) |
Creates an ValueIndex index on the given path
|
| CreateIndex(IList, IndexType, IndexOptions) |
Creates an index of the given type on the given path with the given options
|
| CreateReplication(Uri) |
Creates a replication with the giveb remote URL
|
| CreateReplication(Database) |
Creates a replication with another local database
|
| Delete |
Deletes the database
|
| Delete(Document) |
Deletes the given Document from the database
|
 | Delete(String, String) |
Deletes the contents of a database with the given name in the
given directory
|
| DeleteIndex |
Deletes an index of the given IndexType on the given propertyPath
|
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
| DocumentExists |
Checks whether a document with the given ID exists in the database
|
| Equals | (Inherited from Object.) |
| Exists |
Returns whether or not a database with the given name
exists in the given directory
|
 | Finalize |
Finalizer
(Overrides ObjectFinalize.) |
| GetDocument |
Gets the Document with the specified ID
|
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| InBatch |
Runs the given batch of operations as an atomic unit
|
| Purge |
Purges the given Document from the database. This leaves
no trace behind and will not be replicated
|
| Save |
Saves the given Document into this database
|
| ToString | (Inherited from Object.) |
Events
See Also