Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryOptions

Hierarchy

  • QueryOptions

Index

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.

consistentWith?: MutationState

Specifies a MutationState which the query should be consistent with.

see

MutationState

flexIndex?: boolean

Specifies whether flex-indexes should be enabled. Allowing the use of full-text search from the query service.

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[] | {}

Values to be used for the placeholders within the query.

parentSpan?: RequestSpan

The parent tracing span that this operation will be part of.

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.

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?: {}

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.

timeout?: number

The timeout for this operation, represented in milliseconds.

Generated using TypeDoc