QueryAllDocsMode Property |
Changes the behavior of a query created by -queryAllDocuments.
Namespace:
Couchbase.Lite
Assembly:
Couchbase.Lite (in Couchbase.Lite.dll) Version: 1.4.1-b107
Syntax public AllDocsMode AllDocsMode { get; set; }
Property Value
Type:
AllDocsModeRemarks
Changes the behavior of a query created by -queryAllDocuments.
- In mode kCBLAllDocs (the default), the query simply returns all non-deleted documents.
- In mode kCBLIncludeDeleted, it also returns deleted documents.
- In mode kCBLShowConflicts, the .conflictingRevisions property of each row will return the
conflicting revisions, if any, of that document.
- In mode kCBLOnlyConflicts, _only_ documents in conflict will be returned.
(This mode is especially useful for use with a CBLLiveQuery, so you can be notified of
conflicts as they happen, i.e. when they're pulled in by a replication.)
See Also