Interface QueryOptions

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

Properties

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

Properties

Optional abortSignal

abortSignal?: AbortSignal

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

Optional clientContextId

clientContextId?: string

The returned client context id for this query.

Optional deserializer

deserializer?: Deserializer

Sets the deserializer used by QueryResult.rows to convert query result rows into objects. If not specified, defaults to the cluster's default deserializer.

Optional maxRetries

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.

Optional namedParameters

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

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

Type declaration

  • [key: string]: any

Optional positionalParameters

positionalParameters?: any[]

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

Optional raw

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

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

Type declaration

  • [key: string]: any

Optional readOnly

readOnly?: boolean

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

Optional scanConsistency

scanConsistency?: QueryScanConsistency

Specifies the consistency requirements when executing the query.

See

AnalyticsScanConsistency

Optional timeout

timeout?: number

The timeout for this operation, represented in milliseconds.

Settings

Member Visibility

Theme

On This Page

abortSignalclientContextIddeserializermaxRetriesnamedParameterspositionalParametersrawreadOnlyscanConsistencytimeout