QueryRequestOptions Class

Definition

The Cosmos query request options

public class QueryRequestOptions : Azure.Cosmos.RequestOptions
type QueryRequestOptions = class
    inherit RequestOptions
Public Class QueryRequestOptions
Inherits RequestOptions
Inheritance
System.Object
QueryRequestOptions

Constructors

QueryRequestOptions()

Properties

ConsistencyLevel

Gets or sets the consistency level required for the request in the Azure Cosmos DB service.

EnableLowPrecisionOrderBy

Gets or sets the option to enable low precision order by in the Azure Cosmos DB service.

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.

IfMatch

Optionally limit requests to resources that have a matching ETag.

(Inherited from MatchConditions)
IfNoneMatch

Optionally limit requests to resources that do not match the ETag.

(Inherited from MatchConditions)
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.

ResponseContinuationTokenLimitInKb

Gets or sets the ResponseContinuationTokenLimitInKb request option for document query requests in the Azure Cosmos DB service.

Applies to