couchbase
    Preparing search index...

    Interface QueryOptions

    interface QueryOptions {
        adhoc?: boolean;
        clientContextId?: string;
        consistentWith?: MutationState;
        flexIndex?: boolean;
        maxParallelism?: number;
        metrics?: boolean;
        parameters?: any[] | { [key: string]: any };
        pipelineBatch?: number;
        pipelineCap?: number;
        preserveExpiry?: boolean;
        profile?: QueryProfileMode;
        queryContext?: string;
        raw?: { [key: string]: any };
        readOnly?: boolean;
        scanCap?: number;
        scanConsistency?: QueryScanConsistency;
        scanWait?: number;
        timeout?: number;
        useReplica?: boolean;
    }
    Index

    Properties

    adhoc? clientContextId? consistentWith? flexIndex? maxParallelism? metrics? parameters? pipelineBatch? pipelineCap? preserveExpiry? profile? queryContext? raw? readOnly? scanCap? scanConsistency? scanWait? timeout? useReplica?

    Properties

    adhoc?: boolean

    Specifies whether this is an ad-hoc query, or if it should be prepared for faster execution in the future.

    clientContextId?: string

    The returned client context id for this query.

    consistentWith?: MutationState

    Specifies a MutationState which the query should be consistent with.

    MutationState

    flexIndex?: boolean

    Specifies whether flex-indexes should be enabled. Allowing the use of full-text search from the query service.

    maxParallelism?: number

    This is an advanced option, see the query service reference for more information on the proper use and tuning of this option.

    metrics?: boolean

    Specifies whether metrics should be captured as part of the execution of the query.

    parameters?: any[] | { [key: string]: any }

    Values to be used for the placeholders within the query.

    pipelineBatch?: number

    This is an advanced option, see the query service reference for more information on the proper use and tuning of this option.

    pipelineCap?: number

    This is an advanced option, see the query service reference for more information on the proper use and tuning of this option.

    preserveExpiry?: boolean

    Specifies that the query should preserve the existing document expiry times when mutating documents.

    profile?: QueryProfileMode

    Specifies the level of profiling that should be used for the query.

    queryContext?: string

    Specifies the context within which this query should be executed. This can be scoped to a scope or a collection within the dataset.

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

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

    readOnly?: boolean

    Specifies that this query should be executed in read-only mode, disabling the ability for the query to make any changes to the data.

    scanCap?: number

    This is an advanced option, see the query service reference for more information on the proper use and tuning of this option.

    scanConsistency?: QueryScanConsistency

    Specifies the consistency requirements when executing the query.

    QueryScanConsistency

    scanWait?: number

    This is an advanced option, see the query service reference for more information on the proper use and tuning of this option. Specified in milliseconds.

    timeout?: number

    The timeout for this operation, represented in milliseconds.

    useReplica?: boolean

    Specifies whether the query engine should use replica nodes for kv fetches, if the active node is down.

    Settings

    Member Visibility

    On This Page

    Properties