couchbase
    Preparing search index...

    Interface ViewQueryOptions

    interface ViewQueryOptions {
        full_set?: boolean;
        fullSet?: boolean;
        group?: boolean;
        group_level?: number;
        groupLevel?: number;
        id_range?: ViewQueryIdRange;
        idRange?: ViewQueryIdRange;
        key?: string;
        keys?: string[];
        limit?: number;
        namespace?: DesignDocumentNamespace;
        on_error?: ViewErrorMode;
        onError?: ViewErrorMode;
        order?: ViewOrdering;
        range?: ViewQueryKeyRange;
        raw?: { [key: string]: string };
        reduce?: boolean;
        scanConsistency?: ViewScanConsistency;
        skip?: number;
        stale?: string;
        timeout?: number;
    }
    Index

    Properties

    full_set? fullSet? group? group_level? groupLevel? id_range? idRange? key? keys? limit? namespace? on_error? onError? order? range? raw? reduce? scanConsistency? skip? stale? timeout?

    Properties

    full_set?: boolean

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

    Use ViewQueryOptions.fullSet instead.

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

    group?: boolean

    Specifies whether the results should be grouped together.

    group_level?: number

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

    Use ViewQueryOptions.groupLevel instead.

    groupLevel?: number

    Specifies the level to which results should be group.

    id_range?: ViewQueryIdRange

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

    Use ViewQueryOptions.idRange instead.

    idRange?: ViewQueryIdRange

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

    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.

    namespace?: DesignDocumentNamespace

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

    on_error?: ViewErrorMode

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

    Use ViewQueryOptions.onError instead.

    onError?: ViewErrorMode

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

    order?: ViewOrdering

    Specifies the ordering that should be used when returning results.

    range?: ViewQueryKeyRange

    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.

    reduce?: boolean

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

    scanConsistency?: ViewScanConsistency

    Specifies the consistency requirements when executing the query.

    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.

    Use ViewQueryOptions.scanConsistency instead.

    timeout?: number

    The timeout for this operation, represented in milliseconds.

    Settings

    Member Visibility

    On This Page

    Properties