couchbase-analytics
    Preparing search index...

    Interface StartQueryOptions

    Options for the Cluster.startQuery and Scope.startQuery operations.

    interface StartQueryOptions {
        abortSignal?: AbortSignal;
        clientContextId?: string;
        maxRetries?: number;
        namedParameters?: { [key: string]: any };
        positionalParameters?: any[];
        raw?: { [key: string]: any };
        readOnly?: boolean;
        scanConsistency?: QueryScanConsistency;
        timeout?: number;
    }
    Index

    Properties

    abortSignal? clientContextId? maxRetries? namedParameters? positionalParameters? raw? readOnly? scanConsistency? timeout?

    Properties

    abortSignal?: AbortSignal

    Sets an abort signal for the query allowing the operation to be canceled.

    clientContextId?: string

    The returned client context id for this query.

    maxRetries?: number

    Specifies the maximum number of retries for this query. If unset, defaults to the cluster-level maxRetries.

    Volatile: This API is subject to change at any time.

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

    Named values to be used for the placeholders within the query.

    positionalParameters?: any[]

    Positional values to be used for the placeholders within the query.

    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?: QueryScanConsistency

    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