Optional
attParameter to specify whether to include the encoding information in attachment stubs if the particular attachment is compressed.
Optional
attachmentsParameter to specify whether to include attachments bodies in a response.
Optional
conflictsParameter to specify whether to include a list of conflicted revisions in each returned document. Active
only when include_docs
is true
.
Path parameter to specify the database name.
Path parameter to specify the design document name. The design document name is the design document ID
excluding the _design/
prefix.
Optional
descendingParameter to specify whether to return the documents in descending by key order.
Optional
endSchema for any JSON type.
Optional
endSchema for a document ID.
Optional
groupParameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the
view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the
number of array elements with the group_level
parameter.
Optional
groupParameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays.
Implies group is true
. Group level groups the reduced results by the specified number of array elements. If
unset, results are grouped by the entire array key, returning a reduced value for each complete key.
Optional
headersOptional
includeParameter to specify whether to include the full content of the documents in the response.
Optional
inclusiveParameter to specify whether the specified end key should be included in the result.
Optional
keySchema for any JSON type.
Optional
keysParameter to specify returning only documents that match any of the specified keys. A JSON array of keys that match the key type emitted by the view function.
Optional
limitParameter to specify the number of returned documents to limit the result to.
Path parameter to specify the database partition key.
Optional
reduceParameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce function is defined.
Optional
skipParameter to specify the number of records before starting to return the results.
Optional
stableQuery parameter to specify whether use the same replica of the index on each request. The default value
false
contacts all replicas and returns the result from the first, fastest, responder. Setting it to true
when used in conjunction with update=false
may improve consistency at the expense of increased latency and
decreased throughput if the selected replica is not the fastest of the available replicas.
Note: In general setting true
is discouraged and is strictly not recommended when using update=true
.
Optional
startSchema for any JSON type.
Optional
startSchema for a document ID.
Optional
updateParameter to specify whether or not the view in question should be updated prior to responding to the user.
true
- Return results after the view is updated.false
- Return results without updating the view.lazy
- Return the view results without waiting for an update, but update them immediately after the request.Optional
updateParameter to specify whether to include in the response an update_seq value indicating the sequence id of the database the view reflects.
Path parameter to specify the map reduce view function name.
Generated using TypeDoc
Parameters for the
postPartitionView
operation.