FeedOptions FeedOptions FeedOptions FeedOptions FeedOptions FeedOptions Class

Definition

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

public ref class FeedOptions sealed
public ref class FeedOptions sealed
class FeedOptions sealed
public sealed class FeedOptions
type FeedOptions = class
Public NotInheritable Class FeedOptions
Inheritance
FeedOptionsFeedOptionsFeedOptionsFeedOptionsFeedOptionsFeedOptions

Remarks

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

Constructors

FeedOptions() FeedOptions() FeedOptions() FeedOptions() FeedOptions() FeedOptions()

Initializes a new instance of the FeedOptions class for the Azure Cosmos DB service.

Properties

ConsistencyLevel ConsistencyLevel ConsistencyLevel ConsistencyLevel ConsistencyLevel ConsistencyLevel

Gets or sets the consistency level required for the feed (query/read feed) operation in the Azure Cosmos DB service.

DisableRUPerMinuteUsage DisableRUPerMinuteUsage DisableRUPerMinuteUsage DisableRUPerMinuteUsage DisableRUPerMinuteUsage DisableRUPerMinuteUsage

Gets or sets the DisableRUPerMinuteUsage option for the current query in the Azure Cosmos DB service.

EnableCrossPartitionQuery EnableCrossPartitionQuery EnableCrossPartitionQuery EnableCrossPartitionQuery EnableCrossPartitionQuery 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 EnableLowPrecisionOrderBy EnableLowPrecisionOrderBy EnableLowPrecisionOrderBy EnableLowPrecisionOrderBy EnableLowPrecisionOrderBy

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

EnableScanInQuery EnableScanInQuery EnableScanInQuery EnableScanInQuery EnableScanInQuery 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 JsonSerializerSettings JsonSerializerSettings JsonSerializerSettings JsonSerializerSettings 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 MaxBufferedItemCount MaxBufferedItemCount MaxBufferedItemCount MaxBufferedItemCount 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 MaxDegreeOfParallelism MaxDegreeOfParallelism MaxDegreeOfParallelism MaxDegreeOfParallelism 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 MaxItemCount MaxItemCount MaxItemCount MaxItemCount MaxItemCount

Gets or sets the maximum number of items to be returned in the enumeration operation in the Azure Cosmos DB service.

PartitionKey PartitionKey PartitionKey PartitionKey PartitionKey PartitionKey

Gets or sets the PartitionKey for the current request in the Azure Cosmos DB service.

PartitionKeyRangeId PartitionKeyRangeId PartitionKeyRangeId PartitionKeyRangeId PartitionKeyRangeId PartitionKeyRangeId

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

PopulateQueryMetrics PopulateQueryMetrics PopulateQueryMetrics PopulateQueryMetrics PopulateQueryMetrics PopulateQueryMetrics

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

RequestContinuation RequestContinuation RequestContinuation RequestContinuation RequestContinuation RequestContinuation

Gets or sets the request continuation token in the Azure Cosmos DB service.

ResponseContinuationTokenLimitInKb ResponseContinuationTokenLimitInKb ResponseContinuationTokenLimitInKb ResponseContinuationTokenLimitInKb ResponseContinuationTokenLimitInKb ResponseContinuationTokenLimitInKb

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

SessionToken SessionToken SessionToken SessionToken SessionToken SessionToken

Gets or sets the session token for use with session consistency in the Azure Cosmos DB service.

Extension Methods

IsDefined(Object) IsDefined(Object) IsDefined(Object) IsDefined(Object) IsDefined(Object) IsDefined(Object)

Determines if a certain property is defined or not.

IsNull(Object) IsNull(Object) IsNull(Object) IsNull(Object) IsNull(Object) IsNull(Object)

Determines if a certain property is null or not.

IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object)

Determines if a certain property is of premitive JSON type.

Applies to