Interface AnalyticsQueryOptions

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

Properties

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

Properties

Optional clientContextId

clientContextId?: string

The returned client context id for this query.

Optional parameters

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

Values to be used for the placeholders within the query.

Type declaration

  • [key: string]: any

Optional priority

priority?: boolean

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

Optional queryContext

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.

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

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

clientContextIdparameterspriorityqueryContextrawreadOnlyscanConsistencytimeout