Interface ViewQueryOptions

Hierarchy

  • ViewQueryOptions

Properties

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).

full_set?: boolean

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

Deprecated

Use ViewQueryOptions.fullSet instead.

group?: boolean

Specifies whether the results should be grouped together.

groupLevel?: number

Specifies the level to which results should be group.

group_level?: number

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

Deprecated

Use ViewQueryOptions.groupLevel instead.

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

id_range?: ViewQueryIdRange

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

Deprecated

Use ViewQueryOptions.idRange instead.

key?: string

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

keys?: string[]

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

limit?: number

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

Specifies the design document namespace to use when executing the view query.

onError?: ViewErrorMode

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

on_error?: ViewErrorMode

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

Deprecated

Use ViewQueryOptions.onError instead.

order?: ViewOrdering

Specifies the ordering that should be used when returning results.

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

raw?: {
    [key: string]: string;
}

Specifies any additional parameters which should be passed to the view engine when executing the view query.

Type declaration

  • [key: string]: string
reduce?: boolean

Specifies whether reduction should be performed as part of the query.

scanConsistency?: ViewScanConsistency

Specifies the consistency requirements when executing the query.

See

ViewScanConsistency

skip?: number

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

stale?: string

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

Deprecated

Use ViewQueryOptions.scanConsistency instead.

timeout?: number

The timeout for this operation, represented in milliseconds.

Generated using TypeDoc