FeedOptions Class

Reference

Definition

Namespace:: Microsoft.Azure.Documents.Client

Assemblies:: Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Packages:: Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

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.

Specifies the options associated with feed methods (enumeration operations) in the Azure Cosmos DB service.

public sealed class FeedOptions

type FeedOptions = class

Public NotInheritable Class FeedOptions

Inheritance: Object
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 Cosmos DB service.

Properties

ConsistencyLevel	Gets or sets the consistency level required for the feed (query/read feed) operation in the Azure Cosmos DB service.
DisableRUPerMinuteUsage	Gets or sets the DisableRUPerMinuteUsage option for the current query in the Azure Cosmos DB 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 Cosmos DB 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 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.
JsonSerializerSettings	Gets or sets the JsonSerializerSettings for the current request used to deserialize the document. If null, uses the default serializer settings set up in the DocumentClient.
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.
MaxDegreeOfParallelism	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.
PartitionKeyRangeId	Gets or sets the partition key range id for the current request.
PopulateIndexMetrics	Gets or sets the the PopulateIndexMetrics request option for document query requests in the Azure Cosmos DB service.
PopulateQueryMetrics	Gets or sets the PopulateQueryMetrics request option for document query requests in the Azure Cosmos DB service.
RequestContinuation	Gets or sets the request continuation token in the Azure Cosmos DB service.
ResponseContinuationTokenLimitInKb	Gets or sets the ResponseContinuationTokenLimitInKb request option for document query requests in the Azure Cosmos DB service.
SessionToken	Gets or sets the session token for use with session consistency in the Azure Cosmos DB service.

Applies to