SharedOptions interface
Opcje, które można określić dla żądanego wystawionego dla serwerów usługi Azure Cosmos DB.=
Właściwości
| abort |
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 |
| bypass |
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 |
| consistency |
Poziom spójności wymagany przez klienta. |
| disable |
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. |
| excluded |
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. |
| initial |
(Zaawansowany przypadek użycia) Początkowe nagłówki do rozpoczęcia od wysyłania żądań do usługi Cosmos |
| max |
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. |
| priority |
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 |
| session |
Włącza/wyłącza pobieranie statystyk związanych z limitem przydziału kontenera dokumentów dla żądań odczytu kontenera dokumentów. |
| throughput |
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
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?: AbortSignalWartość właściwości
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?: booleanWartość właściwości
boolean
consistencyLevel
Poziom spójności wymagany przez klienta.
consistencyLevel?: stringWartość właściwości
string
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?: booleanWartość właściwości
boolean
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[]
initialHeaders
(Zaawansowany przypadek użycia) Początkowe nagłówki do rozpoczęcia od wysyłania żądań do usługi Cosmos
initialHeaders?: CosmosHeadersWartość właściwości
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?: numberWartość właściwości
number
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?: PriorityLevelWartość właściwości
sessionToken
Włącza/wyłącza pobieranie statystyk związanych z limitem przydziału kontenera dokumentów dla żądań odczytu kontenera dokumentów.
sessionToken?: stringWartość właściwości
string
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?: numberWartość właściwości
number