FeedOptions interface

The feed options and query methods.

Properties

accessCondition

Conditions Associated with the request.

a_im

Indicates a change feed request. Must be set to "Incremental feed", or omitted otherwise.

continuation

Opaque token for continuing the enumeration.

disableRUPerMinuteUsage

DisableRUPerMinuteUsage is used to enable/disable Request Units(RUs)/minute capacity to serve the request if regular provisioned RUs/second is exhausted.

enableCrossPartitionQuery

A value indicating whether users are enabled to send more than one request to execute the query in the Azure Cosmos DB database service. More than one request is necessary if the query is not scoped to single partition key value.

enableScanInQuery

Allow scan on the queries which couldn't be served as indexing was opted out on the requested paths.

initialHeaders

(Advanced use case) Initial headers to start with when sending requests to Cosmos

maxDegreeOfParallelism

The maximum number of concurrent operations that run client side during parallel query execution in the Azure Cosmos DB database service. Negative values make the system automatically decides the number of concurrent operations to run.

maxItemCount

Max number of items to be returned in the enumeration operation.

partitionKey

Specifies a partition key definition for a particular path in the Azure Cosmos DB database service.

populateQueryMetrics

Enable returning query metrics in response headers

sessionToken

Token for use with Session consistency.

Property Details

accessCondition

Conditions Associated with the request.

accessCondition?: Object

Property Value

Object

a_im

Indicates a change feed request. Must be set to "Incremental feed", or omitted otherwise.

a_im?: string

Property Value

string

continuation

Opaque token for continuing the enumeration.

continuation?: string

Property Value

string

disableRUPerMinuteUsage

DisableRUPerMinuteUsage is used to enable/disable Request Units(RUs)/minute capacity to serve the request if regular provisioned RUs/second is exhausted.

disableRUPerMinuteUsage?: boolean

Property Value

boolean

enableCrossPartitionQuery

A value indicating whether users are enabled to send more than one request to execute the query in the Azure Cosmos DB database service. More than one request is necessary if the query is not scoped to single partition key value.

enableCrossPartitionQuery?: boolean

Property Value

boolean

enableScanInQuery

Allow scan on the queries which couldn't be served as indexing was opted out on the requested paths.

enableScanInQuery?: boolean

Property Value

boolean

initialHeaders

(Advanced use case) Initial headers to start with when sending requests to Cosmos

initialHeaders?: IHeaders

Property Value

maxDegreeOfParallelism

The maximum number of concurrent operations that run client side during parallel query execution in the Azure Cosmos DB database service. Negative values make the system automatically decides the number of concurrent operations to run.

maxDegreeOfParallelism?: number

Property Value

number

maxItemCount

Max number of items to be returned in the enumeration operation.

maxItemCount?: number

Property Value

number

partitionKey

Specifies a partition key definition for a particular path in the Azure Cosmos DB database service.

partitionKey?: string

Property Value

string

populateQueryMetrics

Enable returning query metrics in response headers

populateQueryMetrics?: boolean

Property Value

boolean

sessionToken

Token for use with Session consistency.

sessionToken?: string

Property Value

string