Click or drag to resize

QueryOptions Properties

The QueryOptions type exposes the following members.

Properties
  NameDescription
Public propertyAllDocsMode
Gets or sets the options for an _all_docs query
Public propertyContentOptions
Gets or sets the content options for including document values in the results
Public propertyDescending
Gets or sets whether or not the query is in descending order
Public propertyEndKey
Gets or sets the end key for the query.
Public propertyEndKeyDocId
Gets or sets the last document ID to include in the results
Public propertyFilter
Gets or sets the filter used for filtering the results of the query
Public propertyGroup
Gets or sets whether or not this query groups its results
Public propertyGroupLevel
Gets or sets the group level of the query
Public propertyIncludeDeletedDocs
Gets or sets whether or not to include deleted documents in the result set
Public propertyIncludeDocs
Gets or sets whether or not to include document information in the results
Public propertyInclusiveEnd
Gets or sets whether or not to include the end key in the result set
Public propertyInclusiveStart
Gets or sets whether or not to include the start key in the result set
Public propertyKeys
Gets or sets the keys to include in the query
Public propertyLimit
Gets or sets the number of results the query is limited to
Public propertyPrefixMatchLevel
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.
Public propertyReduce
Gets or sets whether or not this query should reduce
Public propertyReduceSpecified
Gets or sets whether or not the reduce parameter was explicitly specified (Defaults vary depending on whether or not it was)
Public propertySkip
Gets or sets the number of documents the query should skip
Public propertyStale
Gets or sets the timing for updating the results of the query
Public propertyStartKey
Gets or sets the start key for the query
Public propertyStartKeyDocId
Gets or sets the first document ID to include in the results
Public propertyUpdateSeq
Gets or sets whether or not to include the most recently updated sequence number from the database in the result set
Top
See Also