Interface TransactionQueryOptions

Hierarchy

  • TransactionQueryOptions

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.

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.

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

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
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.

See

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.

scope?: Scope

Specifies the scope to run this query in.

Generated using TypeDoc