Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ViewQueryOptions

Hierarchy

  • ViewQueryOptions

Index

Properties

Optional fullSet

fullSet: boolean

Indicates whether the query should force the entire set of document in the index to be included in the result. This is on by default for production views and off by default for development views (only a subset of results may be returned).

Optional full_set

full_set: boolean

Same as ViewQueryOptions.fullSet, but represented as the raw server-side value instead.

deprecated

Use ViewQueryOptions.fullSet instead.

Optional group

group: boolean

Specifies whether the results should be grouped together.

Optional groupLevel

groupLevel: number

Specifies the level to which results should be group.

Optional group_level

group_level: number

Same as ViewQueryOptions.groupLevel, but represented as the raw server-side value instead.

deprecated

Use ViewQueryOptions.groupLevel instead.

Optional idRange

Specifies a range of ids that should be fetched from the index.

Optional id_range

Same as ViewQueryOptions.idRange, but represented as the raw server-side value instead.

deprecated

Use ViewQueryOptions.idRange instead.

Optional key

key: string

Specifies a specific key which should be fetched from the index.

Optional keys

keys: string[]

Specifies a list of keys which should be fetched from the index.

Optional limit

limit: number

Specifies the limit to the number of results that should be returned.

Optional onError

onError: ViewErrorMode

Specifies the error-handling behaviour that should be used when an error occurs.

Optional on_error

on_error: ViewErrorMode

Same as ViewQueryOptions.onError, but represented as the raw server-side value instead.

deprecated

Use ViewQueryOptions.onError instead.

Optional order

Specifies the ordering that should be used when returning results.

Optional parentSpan

parentSpan: RequestSpan

The parent tracing span that this operation will be part of.

Optional range

Specifies a range of keys that should be fetched from the index.

Optional reduce

reduce: string

Specifies a reduction function that should be used for the 'reduce' portion of map/reduce querying.

Optional scanConsistency

scanConsistency: ViewScanConsistency

Specifies the consistency requirements when executing the query.

see

ViewScanConsistency

Optional skip

skip: number

Specifies the number of results to skip from the index before returning results.

Optional stale

stale: string

Same as ViewQueryOptions.scanConsistency, but represented as the raw server-side value instead.

deprecated

Use ViewQueryOptions.scanConsistency instead.

Optional timeout

timeout: number

The timeout for this operation, represented in milliseconds.

Generated using TypeDoc