couchbase
    Preparing search index...

    Interface AnalyticsQueryOptions

    interface AnalyticsQueryOptions {
        clientContextId?: string;
        parameters?: any[] | { [key: string]: any };
        parentSpan?: RequestSpan;
        priority?: boolean;
        queryContext?: string;
        raw?: { [key: string]: any };
        readOnly?: boolean;
        scanConsistency?: AnalyticsScanConsistency;
        timeout?: number;
    }
    Index

    Properties

    clientContextId? parameters? parentSpan? priority? queryContext? raw? readOnly? scanConsistency? timeout?

    Properties

    clientContextId?: string

    The returned client context id for this query.

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

    Values to be used for the placeholders within the query.

    parentSpan?: RequestSpan

    Specifies the parent span for this specific operation.

    priority?: boolean

    Indicates whether this query should be executed with a specific priority level.

    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

    Indicates whether this query should be executed in read-only mode.

    scanConsistency?: AnalyticsScanConsistency

    Specifies the consistency requirements when executing the query.

    AnalyticsScanConsistency

    timeout?: number

    The timeout for this operation, represented in milliseconds.

    Settings

    Member Visibility

    On This Page

    Properties