IDatabase Interface |
An interface describing a Couchbase Lite database
Namespace: Couchbase.Lite
Assembly: Couchbase.Lite (in Couchbase.Lite.dll) Version: 2.0.0-b0033
SyntaxC#
public interface IDatabase : IThreadSafe, IDisposable
The IDatabase type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ActionQueue |
Gets the queue that is used for scheduling operations on
the object. If operations are performed outside of this queue
for properties marked with FromQueueOnly
a ThreadSafetyViolationException will be thrown.
(Inherited from IThreadSafe.) |
| ConflictResolver |
Gets or sets the conflict resolver to use when conflicts arise
|
| Item |
Bracket operator for retrieving IDocuments
|
| 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
|
| CreateDocument |
Creates a new IDocument with a unique ID
|
| CreateIndex |
Creates an ValueIndex index on the given path
|
| Delete |
Deletes the database
|
| DeleteIndex |
Deletes an index of the given IndexType on the given propertyPath
|
| Dispose | (Inherited from IDisposable.) |
| DoAsync(Action) |
Convenience method for asynchronously scheduling a job for this
object
(Inherited from IThreadSafe.) |
| DoAsyncT(FuncT) |
Convenience method for asynchronously scheduling a job for this
object
(Inherited from IThreadSafe.) |
| DocumentExists |
Checks if the IDocument with the given ID exists in the database
|
| DoSync(Action) |
Convenience method for scheduling and waiting for a job
on this object's queue
(Inherited from IThreadSafe.) |
| DoSyncT(FuncT) |
Convenience method for scheduling a job on this object's queue,
waiting for it to finish and returning the result
(Inherited from IThreadSafe.) |
| GetDocument |
Gets or creates an IDocument with the specified ID
|
| InBatch |
Runs the given batch of operations as an atomic unit
|
Events
See Also