Package version:

Interface RequestOptions

Options that can be specified for a requested issued to the Azure Cosmos DB servers.=

interface RequestOptions {
    abortSignal?: AbortSignal;
    accessCondition?: {
        condition: string;
        type: string;
    };
    bypassIntegratedCache?: boolean;
    consistencyLevel?: string;
    disableAutomaticIdGeneration?: boolean;
    disableRUPerMinuteUsage?: boolean;
    enableScriptLogging?: boolean;
    indexingDirective?: string;
    initialHeaders?: CosmosHeaders;
    maxIntegratedCacheStalenessInMs?: number;
    offerThroughput?: number;
    offerType?: string;
    populateQuotaInfo?: boolean;
    postTriggerInclude?: string | string[];
    preTriggerInclude?: string | string[];
    priorityLevel?: PriorityLevel;
    resourceTokenExpirySeconds?: number;
    sessionToken?: string;
    urlConnection?: string;
}

Hierarchy (view full)

Properties

abortSignal? accessCondition? bypassIntegratedCache? consistencyLevel? disableAutomaticIdGeneration? disableRUPerMinuteUsage? enableScriptLogging? indexingDirective? initialHeaders? maxIntegratedCacheStalenessInMs? offerThroughput? offerType? populateQuotaInfo? postTriggerInclude? preTriggerInclude? priorityLevel? resourceTokenExpirySeconds? sessionToken? urlConnection?

Properties

OptionalabortSignal

abortSignal?: AbortSignal

abortSignal to pass to all underlying network requests created by this method call. See https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Example: Cancel a read request

const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()

OptionalaccessCondition

accessCondition?: {
    condition: string;
    type: string;
}

Conditions Associated with the request.

Type declaration

  • condition: string

    Conditional HTTP method header value (the _etag field from the last version you read).

  • type: string

    Conditional HTTP method header type (IfMatch or IfNoneMatch).

OptionalbypassIntegratedCache

bypassIntegratedCache?: boolean

Sets if integrated cache should be bypassed or enabled for the request in Azure CosmosDB service.

Default value is false. By default integrated cache is enabled

OptionalconsistencyLevel

consistencyLevel?: string

Consistency level required by the client.

OptionaldisableAutomaticIdGeneration

disableAutomaticIdGeneration?: boolean

Disable automatic id generation (will cause creates to fail if id isn't on the definition)

OptionaldisableRUPerMinuteUsage

disableRUPerMinuteUsage?: boolean

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

OptionalenableScriptLogging

enableScriptLogging?: boolean

Enables or disables logging in JavaScript stored procedures.

OptionalindexingDirective

indexingDirective?: string

Specifies indexing directives (index, do not index .. etc).

OptionalinitialHeaders

initialHeaders?: CosmosHeaders

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

OptionalmaxIntegratedCacheStalenessInMs

maxIntegratedCacheStalenessInMs?: number

Sets the staleness value associated with the request in the Azure CosmosDB service. For requests where the com.azure.cosmos.ConsistencyLevel is com.azure.cosmos.ConsistencyLevel#EVENTUAL or com.azure.cosmos.ConsistencyLevel#SESSION, responses from the integrated cache are guaranteed to be no staler than value indicated by this maxIntegratedCacheStaleness. When the consistency level is not set, this property is ignored.

Default value is null

Cache Staleness is supported in milliseconds granularity. Anything smaller than milliseconds will be ignored.

OptionalofferThroughput

offerThroughput?: number

The offer throughput provisioned for a container in measurement of Requests-per-Unit.

OptionalofferType

offerType?: string

Offer type when creating document containers.

This option is only valid when creating a document container.

OptionalpopulateQuotaInfo

populateQuotaInfo?: boolean

Enables/disables getting document container quota related stats for document container read requests.

OptionalpostTriggerInclude

postTriggerInclude?: string | string[]

Indicates what is the post trigger to be invoked after the operation.

OptionalpreTriggerInclude

preTriggerInclude?: string | string[]

Indicates what is the pre trigger to be invoked before the operation.

OptionalpriorityLevel

priorityLevel?: PriorityLevel

Priority Level (Low/High) for each request. Low priority requests are always throttled before any high priority requests.

Default value is null. By default all requests are of High priority

OptionalresourceTokenExpirySeconds

resourceTokenExpirySeconds?: number

Expiry time (in seconds) for resource token associated with permission (applicable only for requests on permissions).

OptionalsessionToken

sessionToken?: string

Enables/disables getting document container quota related stats for document container read requests.

OptionalurlConnection

urlConnection?: string

(Advanced use case) The url to connect to.

Settings

Member Visibility