QueryOptions Class |
Standard query options for views.
Inheritance HierarchyNamespace: Couchbase.Lite
Assembly: Couchbase.Lite (in Couchbase.Lite.dll) Version: 1.4.1-b107
SyntaxC#
public sealed class QueryOptions
The QueryOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | QueryOptions |
Constructor
|
Properties| Name | Description | |
|---|---|---|
 | AllDocsMode |
Gets or sets the options for an _all_docs query
|
| ContentOptions |
Gets or sets the content options for including document values in the results
|
| Descending |
Gets or sets whether or not the query is in descending order
|
| EndKey |
Gets or sets the end key for the query.
|
| EndKeyDocId |
Gets or sets the last document ID to include in the results
|
| Filter |
Gets or sets the filter used for filtering the results of the query
|
| Group |
Gets or sets whether or not this query groups its results
|
| GroupLevel |
Gets or sets the group level of the query
|
| IncludeDeletedDocs |
Gets or sets whether or not to include deleted documents in the result set
|
| IncludeDocs |
Gets or sets whether or not to include document information in the results
|
| InclusiveEnd |
Gets or sets whether or not to include the end key in the result set
|
| InclusiveStart |
Gets or sets whether or not to include the start key in the result set
|
| Keys |
Gets or sets the keys to include in the query
|
| Limit |
Gets or sets the number of results the query is limited to
|
| PrefixMatchLevel |
If nonzero, enables prefix matching of string or array keys.
* A value of 1 treats the endKey itself as a prefix: if it's a string, keys in the index that
come after the endKey, but begin with the same prefix, will be matched. (For example, if the
endKey is "foo" then the key "foolish" in the index will be matched, but not "fong".) Or if
the endKey is an array, any array beginning with those elements will be matched. (For
example, if the endKey is [1], then [1, "x"] will match, but not [2].) If the key is any
other type, there is no effect.
* A value of 2 assumes the endKey is an array and treats its final item as a prefix, using the
rules above. (For example, an endKey of [1, "x"] will match [1, "xtc"] but not [1, "y"].)
* A value of 3 assumes the key is an array of arrays, etc.
Note that if the .Descending property is also set, the search order is reversed and the above
discussion applies to the startKey, _not_ the endKey.
|
| Reduce |
Gets or sets whether or not this query should reduce
|
| ReduceSpecified |
Gets or sets whether or not the reduce parameter was explicitly specified
(Defaults vary depending on whether or not it was)
|
| Skip |
Gets or sets the number of documents the query should skip
|
| Stale |
Gets or sets the timing for updating the results of the query
|
| StartKey |
Gets or sets the start key for the query
|
| StartKeyDocId |
Gets or sets the first document ID to include in the results
|
| UpdateSeq |
Gets or sets whether or not to include the most recently updated sequence number
from the database in the result set
|
Methods| Name | Description | |
|---|---|---|
| Copy |
Create a copy of a given QueryOptions object
|
| GetAllDocsMode | Obsolete.
Get the all document query mode for this query
|
| GetContentOptions | Obsolete.
Get the options for including document content in the result set
|
| GetEndKey | Obsolete.
Gets the end key for the query
|
| GetEndKeyDocId | Obsolete.
Gets the last document ID to include in the result set
|
| GetGroupLevel | Obsolete.
Gets the group level of the query
|
| GetKeys | Obsolete.
Gets the keys to include in the query results
|
| GetLimit | Obsolete.
Gets the number of docs to limit the query to
|
| GetSkip | Obsolete.
Gets the number of docs to skip in the query
|
| GetStale | Obsolete.
Gets the timing of when to update the query results
|
| GetStartKey | Obsolete.
Gets the start key for the query
|
| GetStartKeyDocId | Obsolete.
Gets the first document ID to include in the result set
|
| IsDescending | Obsolete.
Returns whether or not the query should order the results in descending in order
|
| IsGroup | Obsolete.
Gets whether or not this query groups its results
|
| IsIncludeDeletedDocs | Obsolete.
Gets whether or not to include deleted documents in the reuslt set
|
| IsIncludeDocs | Obsolete.
Returns whether or not the document bodies should be included with the query results
|
| IsInclusiveEnd | Obsolete.
Gets whether or not the query includes the end key
|
| IsReduce | Obsolete.
Gets whether or not this query should reduce
|
| IsReduceSpecified | Obsolete.
Gets whether or not the Reduce property has been manually specified
|
| IsUpdateSeq | Obsolete.
Gets whether or not the results include the last sequence updated in the database
|
| SetAllDocsMode | Obsolete.
Sets the all document query mode for this query
|
| SetContentOptions | Obsolete.
Sets the options for including document content in the result set
|
| SetDescending | Obsolete.
Sets whether or not the query should order the results in descending in order
|
| SetEndKey | Obsolete.
Sets the end key for the query
|
| SetEndKeyDocId | Obsolete.
Sets the last document ID to include in the result set
|
| SetGroup | Obsolete.
Sets whether or not this query groups its results
|
| SetGroupLevel | Obsolete.
Sets the group level of the query
|
| SetIncludeDeletedDocs | Obsolete.
Sets whether or not to include deleted documents in the reuslt set
|
| SetIncludeDocs | Obsolete.
Sets whether or not the document bodies should be included with the query results
|
| SetInclusiveEnd | Obsolete.
Sets whether or not the query includes the end key
|
| SetKeys | Obsolete.
Sets the keys to include in the query results
|
| SetLimit | Obsolete.
Sets the number of docs to limit the query to
|
| SetReduce | Obsolete.
Sets whether or not this query should reduce
|
| SetReduceSpecified | Obsolete.
Sets whether or not the Reduce property has been manually specified
|
| SetSkip | Obsolete.
Sets the number of docs to skip in the query
|
| SetStale | Obsolete.
Sets the timing of when to update the query results
|
| SetStartKey | Obsolete.
Sets the start key for the query
|
| SetStartKeyDocId | Obsolete.
Sets the first document ID to include in the result set
|
| SetUpdateSeq | Obsolete.
Sets whether or not the results include the last sequence updated in the database
|
Fields| Name | Description | |
|---|---|---|
  | DEFAULT_LIMIT | Obsolete.
The default limit to use when querying (i.e. unlimited)
|
| DefaultLimit |
The default limit to use when querying (i.e. unlimited)
|
See Also