FeedOptions Class

Definition

Specifies the options associated with feed methods (enumeration operations) in the Azure DocumentDB database service.

public sealed class FeedOptions
Inheritance
FeedOptions

Remarks

Used to manage query and ReadFeed execution. Can use FeedOptions to set page size (MaxItemCount)

Constructors

FeedOptions()

Initializes a new instance of the FeedOptions class for the Azure DocumentDB database service.

Properties

DisableRUPerMinuteUsage

Gets or sets the DisableRUPerMinuteUsage option for the current query in the Azure DocumentDB database service.

EnableCrossPartitionQuery

Gets or sets a value indicating whether users are enabled to send more than one request to execute the query in the Azure DocumentDB database service. More than one request is necessary if the query is not scoped to single partition key value.

EnableLowPrecisionOrderBy

Gets or sets the option to enable low precision order by in the Azure DocumentDB database 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 DocumentDB database service.

MaxBufferedItemCount

Gets or sets the maximum number of items that can be buffered client side during parallel query execution in the Azure DocumentDB database 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.

MaxDegreeOfParallelism

Gets or sets the number of concurrent operations run client side during parallel query execution in the Azure DocumentDB database 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 DocumentDB database service.

PartitionKey

Gets or sets the PartitionKey for the current request in the Azure DocumentDB database service.

PartitionKeyRangeId

Gets or sets the partition key range id for the current request.

PopulateQueryMetrics

Gets or sets the PopulateQueryMetrics request option for document query requests in the Azure DocumentDB database service.

RequestContinuation

Gets or sets the request continuation token in the Azure DocumentDB database service.

ResponseContinuationTokenLimitInKb

Gets or sets the ResponseContinuationTokenLimitInKb request option for document query requests in the Azure DocumentDB database service.

SessionToken

Gets or sets the session token for use with session consistency in the Azure DocumentDB database service.

Extension Methods

IsDefined(Object)
IsNull(Object)
IsPrimitive(Object)