Options
All
  • Public
  • Public/Protected
  • All
Menu

Schema for a query view operation.

Hierarchy

  • ViewQuery

Index

Properties

att_encoding_info?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular attachment is compressed.

attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in the _conflicts property of the returned document. Ignored if include_docs isn't true.

descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

end_key?: any

Schema for any JSON type.

end_key_doc_id?: string

Schema for a document ID.

group?: boolean

Parameter to specify whether to group the results using the reduce function to a group rather than a single row. Implies reduce is true and the maximum group_level.

group_level?: number

Parameter to specify the group level to be used. Implies group is true.

include_docs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

inclusive_end?: boolean

Parameter to specify whether the specified end key should be included in the result.

key?: any

Schema for any JSON type.

keys?: any[]

Parameter to specify to return only documents that match the specified keys. String representation of a JSON array containing elements that match the key type emitted by the view function.

limit?: number

Parameter to specify the number of returned documents to limit the result to.

reduce?: boolean

Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce function is defined.

skip?: number

Parameter to specify the number of records before starting to return the results.

stable?: boolean

Parameter to specify whether view results should be returned from a stable set of shards.

start_key?: any

Schema for any JSON type.

start_key_doc_id?: string

Schema for a document ID.

update?: string

Parameter to specify whether or not the view in question should be updated prior to responding to the user.

update_seq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of the database the view reflects.

Generated using TypeDoc