Udostępnij za pomocą

RequestOptions interface

Pakiet:
@azure/cosmos

Opcje, które można określić dla żądanego wystawionego dla serwerów usługi Azure Cosmos DB.=

Rozszerzenie
SharedOptions

Właściwości

accessCondition

Warunki skojarzone z żądaniem.
contentResponseOnWriteEnabled

Jeśli ustawiono wartość false, usługa nie zwraca ładunku w odpowiedzi. Zmniejsza obciążenie sieci i procesora, nie wysyłając ładunku z powrotem przez sieć. Domyślna wartość to "true".

UWAGA: Obecnie ta opcja jest obsługiwana tylko w przypadku operacji zbiorczych i wsadowych.
disableAutomaticIdGeneration

Wyłącz automatyczne generowanie identyfikatorów (spowoduje to niepowodzenie tworzenia, jeśli identyfikator nie znajduje się w definicji)
enableScriptLogging

Włącza lub wyłącza rejestrowanie w procedurach składowanych w języku JavaScript.
indexingDirective

Określa dyrektywy indeksowania (indeks, nie indeksuj itp.).
offerThroughput

Przepływność oferty aprowizowana dla kontenera w pomiarze żądań na jednostkę.
offerType

Typ oferty podczas tworzenia kontenerów dokumentów.

Ta opcja jest prawidłowa tylko podczas tworzenia kontenera dokumentów.
populateQuotaInfo

Włącza/wyłącza pobieranie statystyk związanych z limitem przydziału kontenera dokumentów dla żądań odczytu kontenera dokumentów.
postTriggerInclude

Wskazuje, jaki wyzwalacz post ma być wywoływany po operacji.
preTriggerInclude

Wskazuje, jaki jest wyzwalacz wstępny do wywołania przed operacją.
resourceTokenExpirySeconds

Czas wygaśnięcia (w sekundach) tokenu zasobu skojarzonego z uprawnieniem (dotyczy tylko żądań dotyczących uprawnień).
urlConnection

(Zaawansowany przypadek użycia) Adres URL do nawiązania połączenia.

Właściwości dziedziczone

abortSignal

abortSignal przekazać do wszystkich bazowych żądań sieciowych utworzonych przez to wywołanie metody. Zobacz https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Przykład

Anulowanie żądania odczytu

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,
});
bypassIntegratedCache

Ustawia, czy zintegrowana pamięć podręczna powinna zostać pominięta lub włączona dla żądania w usłudze Azure CosmosDB.

Wartość domyślna to false. Domyślnie zintegrowana pamięć podręczna jest włączona
consistencyLevel

Poziom spójności wymagany przez klienta.
disableRUPerMinuteUsage

Funkcja DisableRUPerMinuteUsage służy do włączania/wyłączania jednostek żądań (RU)/minuty w celu obsłużenia żądania w przypadku wyczerpania zwykłej aprowizacji jednostek RU/sekundy.
excludedLocations

Wyklucza co najmniej jeden region świadczenia usługi Azure dla operacji.

Ta opcja jest stosowana tylko wtedy, gdy parametr enableEndPointDiscovery jest ustawiony na wartość true.
initialHeaders

(Zaawansowany przypadek użycia) Początkowe nagłówki do rozpoczęcia od wysyłania żądań do usługi Cosmos
maxIntegratedCacheStalenessInMs

Ustawia wartość nieaktualności skojarzona z żądaniem w usłudze Azure CosmosDB. W przypadku żądań, w których <xref:com.azure.cosmos.ConsistencyLevel> jest <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> lub <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, odpowiedzi ze zintegrowanej pamięci podręcznej nie są nieaktualne niż wartość wskazywana przez tę wartość maxIntegratedCacheStaleness. Jeśli poziom spójności nie jest ustawiony, ta właściwość jest ignorowana.

Wartość domyślna ma wartość null

Nieaktualność pamięci podręcznej jest obsługiwana w milisekundach szczegółowości. Wszystkie elementy mniejsze niż milisekundy zostaną zignorowane.
priorityLevel

Poziom priorytetu (niski/wysoki) dla każdego żądania. Żądania o niskim priorytcie są zawsze ograniczane przed żądaniami o wysokim priorytcie.

Wartość domyślna to null. Domyślnie wszystkie żądania mają wysoki priorytet
sessionToken

Włącza/wyłącza pobieranie statystyk związanych z limitem przydziału kontenera dokumentów dla żądań odczytu kontenera dokumentów.
throughputBucket

Zasobnik przepływności dla żądania.

Wartość domyślna to null. W takim przypadku żądanie może używać 100% przepływności partycji.

Aby uzyskać więcej informacji, odwiedź stronę [Zasobnik przepływności usługi Cosmos DB](https://aka.ms/cosmsodb-bucketing).

Szczegóły właściwości

accessCondition

Warunki skojarzone z żądaniem.

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

Wartość właściwości

{ condition: string, type: string }

contentResponseOnWriteEnabled

Jeśli ustawiono wartość false, usługa nie zwraca ładunku w odpowiedzi. Zmniejsza obciążenie sieci i procesora, nie wysyłając ładunku z powrotem przez sieć. Domyślna wartość to "true".

UWAGA: Obecnie ta opcja jest obsługiwana tylko w przypadku operacji zbiorczych i wsadowych.

contentResponseOnWriteEnabled?: boolean

Wartość właściwości

boolean

disableAutomaticIdGeneration

Wyłącz automatyczne generowanie identyfikatorów (spowoduje to niepowodzenie tworzenia, jeśli identyfikator nie znajduje się w definicji)

disableAutomaticIdGeneration?: boolean

Wartość właściwości

boolean

enableScriptLogging

Włącza lub wyłącza rejestrowanie w procedurach składowanych w języku JavaScript.

enableScriptLogging?: boolean

Wartość właściwości

boolean

indexingDirective

Określa dyrektywy indeksowania (indeks, nie indeksuj itp.).

indexingDirective?: string

Wartość właściwości

string

offerThroughput

Przepływność oferty aprowizowana dla kontenera w pomiarze żądań na jednostkę.

offerThroughput?: number

Wartość właściwości

number

offerType

Typ oferty podczas tworzenia kontenerów dokumentów.

Ta opcja jest prawidłowa tylko podczas tworzenia kontenera dokumentów.

offerType?: string

Wartość właściwości

string

populateQuotaInfo

Włącza/wyłącza pobieranie statystyk związanych z limitem przydziału kontenera dokumentów dla żądań odczytu kontenera dokumentów.

populateQuotaInfo?: boolean

Wartość właściwości

boolean

postTriggerInclude

Wskazuje, jaki wyzwalacz post ma być wywoływany po operacji.

postTriggerInclude?: string | string[]

Wartość właściwości

string | string[]

preTriggerInclude

Wskazuje, jaki jest wyzwalacz wstępny do wywołania przed operacją.

preTriggerInclude?: string | string[]

Wartość właściwości

string | string[]

resourceTokenExpirySeconds

Czas wygaśnięcia (w sekundach) tokenu zasobu skojarzonego z uprawnieniem (dotyczy tylko żądań dotyczących uprawnień).

resourceTokenExpirySeconds?: number

Wartość właściwości

number

urlConnection

(Zaawansowany przypadek użycia) Adres URL do nawiązania połączenia.

urlConnection?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

abortSignal

abortSignal przekazać do wszystkich bazowych żądań sieciowych utworzonych przez to wywołanie metody. Zobacz https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Przykład

Anulowanie żądania odczytu

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

Wartość właściwości

AbortSignal

dziedziczone zSharedOptions.abortSignal

bypassIntegratedCache

Ustawia, czy zintegrowana pamięć podręczna powinna zostać pominięta lub włączona dla żądania w usłudze Azure CosmosDB.

Wartość domyślna to false. Domyślnie zintegrowana pamięć podręczna jest włączona

bypassIntegratedCache?: boolean

Wartość właściwości

boolean

dziedziczone zSharedOptions.bypassIntegratedCache

consistencyLevel

Poziom spójności wymagany przez klienta.

consistencyLevel?: string

Wartość właściwości

string

Odziedziczone poSharedOptions.consistencyLevel

disableRUPerMinuteUsage

Funkcja DisableRUPerMinuteUsage służy do włączania/wyłączania jednostek żądań (RU)/minuty w celu obsłużenia żądania w przypadku wyczerpania zwykłej aprowizacji jednostek RU/sekundy.

disableRUPerMinuteUsage?: boolean

Wartość właściwości

boolean

Odziedziczone poSharedOptions.disableRUPerMinuteUsage

excludedLocations

Wyklucza co najmniej jeden region świadczenia usługi Azure dla operacji.

Ta opcja jest stosowana tylko wtedy, gdy parametr enableEndPointDiscovery jest ustawiony na wartość true.

excludedLocations?: string[]

Wartość właściwości

string[]

Odziedziczone poSharedOptions.excludedLocations

initialHeaders

(Zaawansowany przypadek użycia) Początkowe nagłówki do rozpoczęcia od wysyłania żądań do usługi Cosmos

initialHeaders?: CosmosHeaders

Wartość właściwości

CosmosHeaders

dziedziczone zSharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

Ustawia wartość nieaktualności skojarzona z żądaniem w usłudze Azure CosmosDB. W przypadku żądań, w których <xref:com.azure.cosmos.ConsistencyLevel> jest <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> lub <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, odpowiedzi ze zintegrowanej pamięci podręcznej nie są nieaktualne niż wartość wskazywana przez tę wartość maxIntegratedCacheStaleness. Jeśli poziom spójności nie jest ustawiony, ta właściwość jest ignorowana.

Wartość domyślna ma wartość null

Nieaktualność pamięci podręcznej jest obsługiwana w milisekundach szczegółowości. Wszystkie elementy mniejsze niż milisekundy zostaną zignorowane.

maxIntegratedCacheStalenessInMs?: number

Wartość właściwości

number

dziedziczone zSharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

Poziom priorytetu (niski/wysoki) dla każdego żądania. Żądania o niskim priorytcie są zawsze ograniczane przed żądaniami o wysokim priorytcie.

Wartość domyślna to null. Domyślnie wszystkie żądania mają wysoki priorytet

priorityLevel?: PriorityLevel

Wartość właściwości

PriorityLevel

dziedziczone zSharedOptions.priorityLevel

sessionToken

Włącza/wyłącza pobieranie statystyk związanych z limitem przydziału kontenera dokumentów dla żądań odczytu kontenera dokumentów.

sessionToken?: string

Wartość właściwości

string

dziedziczone zSharedOptions.sessionToken

throughputBucket

Zasobnik przepływności dla żądania.

Wartość domyślna to null. W takim przypadku żądanie może używać 100% przepływności partycji.

Aby uzyskać więcej informacji, odwiedź stronę [Zasobnik przepływności usługi Cosmos DB](https://aka.ms/cosmsodb-bucketing). 
throughputBucket?: number

Wartość właściwości

number

Odziedziczone poSharedOptions.throughputBucket