Database Class |
Namespace: Couchbase.Lite
public sealed class Database : ICouchStoreDelegate, IDisposable
The Database type exposes the following members.
Name | Description | |
---|---|---|
AllReplications |
Gets all the running Replications
for this Database.
This includes all continuous Replications and
any non-continuous Replications that has been started
and are still running.
| |
DocumentCount | Obsolete.
Gets the number of Document in the Database.
| |
FilterCompiler |
Gets or sets an object that can compile source code into FilterDelegate.
| |
LastSequenceNumber | Obsolete.
Gets the latest sequence number used by the Database. Every new Revision is assigned a new sequence
number, so this property increases monotonically as changes are made to the Database. This can be used to
check whether the Database has changed between two points in time.
| |
Manager |
Gets the Manager that owns this Database.
| |
MaxRevTreeDepth | Obsolete.
Maximum depth of a document's revision tree (or, max length of its revision history.)
Revisions older than this limit will be deleted during a -compact: operation.
| |
Name |
Gets the Database name.
| |
PersistentCookieStore | Obsolete.
Gets the container the holds cookie information received from the remote replicator
| |
TotalDataSize | Obsolete.
Gets the total size of the database on the filesystem.
|
Name | Description | |
---|---|---|
AsQueryable |
Returns a rudimentary LINQ queryable database
| |
ChangeEncryptionKey |
Change the encryption key used to secure this database
| |
Close |
Closes the database asynchronously
| |
Compact | ||
CreateAllDocumentsQuery | ||
CreateDocument |
Creates a Document with a unique id.
| |
CreatePullReplication |
Creates a new Replication that will pull from the source Database at the given url.
| |
CreatePushReplication |
Creates a new Replication that will push to the target Database at the given url.
| |
DatabaseStorageChanged | ||
Delete |
Deletes the Database.
| |
DeleteLocalDocument |
Deletes the local Document with the given id.
| |
Dispose |
Releases all resource used by the Database object.
| |
GetDocument |
Gets or creates the Document with the given id.
| |
GetDocumentCount |
Gets the number of Document in the Database.
| |
GetExistingDocument |
Gets the Document with the given id, or null if it does not exist.
| |
GetExistingLocalDocument |
Gets the local document with the given id, or null if it does not exist.
| |
GetExistingView |
Gets the View with the given name, or null if it does not exist.
| |
GetFilter |
Returns the ValidateDelegate for the given name, or null if it does not exist.
| |
GetLastSequenceNumber |
Gets the latest sequence number used by the Database. Every new Revision is assigned a new sequence
number, so this property increases monotonically as changes are made to the Database. This can be used to
check whether the Database has changed between two points in time.
| |
GetMaxRevTreeDepth |
Maximum depth of a document's revision tree (or, max length of its revision history.)
Revisions older than this limit will be deleted during a -compact: operation.
| |
GetTotalDataSize |
Gets the total size of the database on the filesystem.
| |
GetValidation |
Gets the ValidateDelegate for the given name, or null if it does not exist.
| |
GetView | ||
PutLocalDocument | ||
RunAsync |
Runs the RunAsyncDelegate asynchronously.
| |
RunInTransaction |
Runs the delegate within a transaction. If the delegate returns false,
the transaction is rolled back.
| |
SetFilter |
Sets the ValidateDelegate for the given name. If delegate is null, the filter
with the given name is deleted. Before a Revision is replicated via a
push Replication, its filter delegate is called and
given a chance to exclude it from the Replication.
| |
SetMaxRevTreeDepth |
Sets the maximum depth of a document's revision tree (or, max length of its revision history.)
Revisions older than this limit will be deleted during a -compact: operation.
| |
SetValidation |
Sets the validation delegate for the given name. If delegate is null,
the validation with the given name is deleted. Before any change
to the Database is committed, including incoming changes from a pull
Replication, all of its validation delegates are called and given
a chance to reject it.
| |
StorageExitedTransaction | ||
ToString |
Returns a String that represents the current Database.
(Overrides ObjectToString.) |
Name | Description | |
---|---|---|
Changed |
Event handler delegate that will be called whenever a Document within the Database changes.
|