@ibm-cloud/cloudant - v0.12.7
    Preparing search index...

    Class ExplainResultOpts

    Options used for the request.

    Index

    Constructors

    Properties

    bookmark: string

    Opaque bookmark token used when paginating results.

    conflicts: boolean

    Conflicts used in the request query.

    executionStats: boolean

    Execution statistics used in the request query.

    fields: string[]

    JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be returned. If it is omitted or empty, the entire document is returned.

    limit: number

    Limit used in the request query.

    partition: string

    On which database partition the request was used. If it was not used on a database partition, it returns with "".

    r: number

    The read quorum that is needed for the result.

    skip: number

    Skip used in the request query.

    sort: any

    Schema for any JSON type.

    stable: boolean

    Stable used in the request query.

    stale: boolean

    Deprecated: Stale used in the request query.

    update: boolean

    Update used in the request query.

    useIndex: string[]

    Use index used in the request query.

    Methods