QueryRequestOptions Class

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Package:: Microsoft.Azure.Cosmos v3.45.0

Source:: QueryRequestOptions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The Cosmos query request options

public class QueryRequestOptions : Microsoft.Azure.Cosmos.RequestOptions

type QueryRequestOptions = class
    inherit RequestOptions

Public Class QueryRequestOptions
Inherits RequestOptions

Inheritance: Object

RequestOptions
QueryRequestOptions

Constructors

QueryRequestOptions()

Properties

AddRequestHeaders	Gets or sets a delegate which injects/appends a custom header in the request. (Inherited from RequestOptions)
ConsistencyLevel	Gets or sets the consistency level required for the request in the Azure Cosmos DB service.
CosmosThresholdOptions	Threshold values for Distributed Tracing. These values decides whether to generate operation level EventSource with request diagnostics or not. (Inherited from RequestOptions)
DedicatedGatewayRequestOptions	Gets or sets the DedicatedGatewayRequestOptions for requests against the dedicated gateway. Learn more about dedicated gateway here. These options are only exercised when ConnectionMode is set to ConnectionMode.Gateway and the dedicated gateway endpoint is used for sending requests. These options have no effect otherwise.
EnableLowPrecisionOrderBy	Gets or sets the option to enable low precision order by in the Azure Cosmos DB service.
EnableOptimisticDirectExecution	Gets or sets the option for customers to opt in for direct (optimistic) execution of the query.
EnableScanInQuery	Gets or sets the option to enable scans on the queries which couldn't be served as indexing was opted out on the requested paths in the Azure Cosmos DB service.
ExcludeRegions	List of regions to be excluded routing the request to. This can be used to route a request to a specific region by excluding all other regions. If all regions are excluded, then the request will be routed to the primary/hub region. (Inherited from RequestOptions)
IfMatchEtag	Gets or sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service. (Inherited from RequestOptions)
IfNoneMatchEtag	Gets or sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service. (Inherited from RequestOptions)
MaxBufferedItemCount	Gets or sets the maximum number of items that can be buffered client side during parallel query execution in the Azure Cosmos DB service. A positive property value limits the number of buffered items to the set value. If it is set to less than 0, the system automatically decides the number of items to buffer.
MaxConcurrency	Gets or sets the number of concurrent operations run client side during parallel query execution in the Azure Cosmos DB service. A positive property value limits the number of concurrent operations to the set value. If it is set to less than 0, the system automatically decides the number of concurrent operations to run.
MaxItemCount	Gets or sets the maximum number of items to be returned in the enumeration operation in the Azure Cosmos DB service.
PartitionKey	Gets or sets the PartitionKey for the current request in the Azure Cosmos DB service.
PopulateIndexMetrics	Gets or sets the PopulateIndexMetrics request option for document query requests in the Azure Cosmos DB service.
PriorityLevel	Gets or sets the priority level for a request. (Inherited from RequestOptions)
Properties	Application opted Cosmos request context that flow through with the RequestMessage. Context will be available through handlers. (Inherited from RequestOptions)
QueryTextMode	Enables printing query in Traces db.query.text attribute. By default, query is not printed. Users have the option to enable printing parameterized or all queries, but has to beware that customer data may be shown when the later option is chosen. It's the user's responsibility to sanitize the queries if necessary.
ResponseContinuationTokenLimitInKb	Gets or sets the ResponseContinuationTokenLimitInKb request option for document query requests in the Azure Cosmos DB service.
SessionToken	Gets or sets the token for use with session consistency in the Azure Cosmos DB service.

Methods

ShallowCopy()

Clone RequestOptions.

(Inherited from RequestOptions)

Applies to

Share via