SharedOptions interface

abortSignal för att skicka till alla underliggande nätverksbegäranden som skapats av det här metodanropet. Se https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Exempel

Avbryt en läsbegäran

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const controller = new AbortController();
const results = container.items.query("SELECT * from c", {
  abortSignal: controller.signal,
});

abortSignal?: AbortSignal

Egenskapsvärde

Anger om integrerad cache ska kringgås eller aktiveras för begäran i Azure CosmosDB-tjänsten.

Standardvärdet är falskt. Som standard är integrerad cache aktiverad

bypassIntegratedCache?: boolean

Egenskapsvärde

Konsekvensnivå som krävs av klienten.

consistencyLevel?: string

Egenskapsvärde

DisableRUPerMinuteUsage används för att aktivera/inaktivera kapacitet för begärandeenheter/minutkapacitet för att hantera begäran om regelbundna etablerade RU:er/sekund är slut.

disableRUPerMinuteUsage?: boolean

Egenskapsvärde

Exkluderar en eller flera Azure-regioner för åtgärden.

Det här alternativet tillämpas endast när enableEndPointDiscovery är inställt på true.

excludedLocations?: string[]

Egenskapsvärde

(Avancerat användningsfall) Inledande rubriker att börja med när begäranden skickas till Cosmos

initialHeaders?: CosmosHeaders

Egenskapsvärde

Anger det föråldringsvärde som är associerat med begäran i Azure CosmosDB-tjänsten. För begäranden där <xref:com.azure.cosmos.ConsistencyLevel> är <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> eller <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>är svaren från den integrerade cachen garanterat inte inaktuella än det värde som anges av den här maxIntegratedCacheStaleness. När konsekvensnivån inte har angetts ignoreras den här egenskapen.

Standardvärdet är null

Cacheföråldring stöds i millisekunders kornighet. Allt som är mindre än millisekunder ignoreras.

maxIntegratedCacheStalenessInMs?: number

Egenskapsvärde

Prioritetsnivå (låg/hög) för varje begäran. Begäranden med låg prioritet begränsas alltid före alla begäranden med hög prioritet.

Standardvärdet är null. Som standard har alla begäranden hög prioritet

priorityLevel?: PriorityLevel

Egenskapsvärde

Aktiverar/inaktiverar hämtar dokumentcontainerkvotrelaterad statistik för läsbegäranden för dokumentcontainer.

sessionToken?: string

Egenskapsvärde

Dataflödesbucket för en begäran.

Standardvärdet är null. I det här fallet kan begäran använda 100% av partitionens dataflöde.

Mer information finns i [Cosmos DB dataput Bucketing](https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

Egenskapsvärde