QueryRequestOptions<TDocument> Class

Definition

Namespace:

System.Cloud.DocumentDb

Assembly:

System.Cloud.DocumentDb.Abstractions.dll

Package:

System.Cloud.DocumentDb.Abstractions v8.0.0-rc.1.23453.1

Defines parameters to be used by store engine for queries.

generic <typename TDocument>
public ref class QueryRequestOptions : System::Cloud::DocumentDb::RequestOptions<TDocument>

public class QueryRequestOptions<TDocument> : System.Cloud.DocumentDb.RequestOptions<TDocument>

type QueryRequestOptions<'Document> = class
    inherit RequestOptions<'Document>

Public Class QueryRequestOptions(Of TDocument)
Inherits RequestOptions(Of TDocument)

Type Parameters

TDocument

The document entity type to be used as a table schema. Request results will be mapped to instance of this type.

Inheritance

Object

RequestOptions

RequestOptions<TDocument>

QueryRequestOptions<TDocument>

Constructors

QueryRequestOptions<TDocument>()

Properties

ConsistencyLevel	Gets or sets the consistency level required for the request. (Inherited from RequestOptions)
ContentResponseOnWrite	Gets or sets a value indicating whether written object should be returned back after write operations. (Inherited from RequestOptions)
ContinuationToken	Gets or sets continuation token to continue reading from a breakpoint.
Document	Gets or sets the document value. (Inherited from RequestOptions<TDocument>)
EnableLowPrecisionOrderBy	Gets or sets the option to enable low precision order by.
EnableScan	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.
FetchCondition	Gets or sets the fetch condition.
ItemVersion	Gets or sets the item version parameter to control item version for concurrent modifications. (Inherited from RequestOptions)
MaxBufferedItemCount	Gets or sets the maximum number of items that can be buffered client side during parallel query execution.
MaxConcurrency	Gets or sets the number of concurrent operations run client side during parallel query execution.
MaxResults	Gets or sets the maximum number of items to be returned.
PartitionKey	Gets or sets the partition key elements for the current request. (Inherited from RequestOptions)
Region	Gets or sets the region ID. (Inherited from RequestOptions)
ResponseContinuationTokenLimitInKb	Gets or sets the continuation token size limit.
SessionToken	Gets or sets the token for use with session consistency. (Inherited from RequestOptions)