SharedOptions interface
Optionen, die für eine angeforderte, ausgestellte Azure Cosmos DB-Server angegeben werden können.=
Eigenschaften
| abort |
abortSignal, um an alle zugrunde liegenden Netzwerkanforderungen zu übergeben, die von diesem Methodenaufruf erstellt wurden. Siehe https://developer.mozilla.org/en-US/docs/Web/API/AbortController. Beispiel Abbrechen einer Leseanforderung |
| bypass |
Legt fest, ob der integrierte Cache für die Anforderung im Azure CosmosDB-Dienst umgangen oder aktiviert werden soll. Der Standardwert ist "false". Standardmäßig ist der integrierte Cache aktiviert. |
| consistency |
Konsistenzstufe, die vom Client benötigt wird. |
| disable |
DisableRUPerMinuteUsage wird verwendet, um Anforderungseinheiten(RUs)/Minute-Kapazität für die Anforderung zu aktivieren/zu deaktivieren, wenn reguläre bereitgestellte RUs/Sekunde erschöpft sind. |
| excluded |
Schließt eine oder mehrere Azure-Regionen für den Vorgang aus. Diese Option wird nur angewendet, wenn enableEndPointDiscovery auf true festgelegt ist. |
| initial |
(Erweiterter Anwendungsfall) Anfängliche Kopfzeilen, die beim Senden von Anforderungen an Cosmos beginnen sollen |
| max |
Legt den Veraltetkeitswert fest, der der Anforderung im Azure CosmosDB-Dienst zugeordnet ist. Bei Anforderungen, bei denen die <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> oder <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>ist, sind Antworten aus dem integrierten Cache garantiert kein Staler als der wert, der durch diese maxIntegratedCacheStaleness angegeben ist. Wenn die Konsistenzstufe nicht festgelegt ist, wird diese Eigenschaft ignoriert. Standardwert ist NULL Die Cache-Veraltetkeit wird in Millisekunden Granularität unterstützt. Alles, was kleiner als Millisekunden ist, wird ignoriert. |
| priority |
Prioritätsstufe (Niedrig/Hoch) für jede Anforderung. Anforderungen mit niedriger Priorität werden immer vor Anforderungen mit hoher Priorität gedrosselt. Der Standardwert ist NULL. Standardmäßig sind alle Anforderungen von hoher Priorität |
| session |
Aktiviert/deaktiviert das Abrufen von Dokumentcontainerkontingentstatistiken für Dokumentcontainerleseanforderungen. |
| throughput |
Durchsatz-Bucket für eine Anforderung. Der Standardwert ist NULL. In diesem Fall kann die Anforderung 100% des Partitionsdurchsatzes verwenden. Weitere Informationen finden Sie unter [Bucketing des Cosmos DB-Durchsatzes](https://aka.ms/cosmsodb-bucketing). |
Details zur Eigenschaft
abortSignal
abortSignal, um an alle zugrunde liegenden Netzwerkanforderungen zu übergeben, die von diesem Methodenaufruf erstellt wurden. Siehe https://developer.mozilla.org/en-US/docs/Web/API/AbortController.
Beispiel
Abbrechen einer Leseanforderung
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?: AbortSignalEigenschaftswert
AbortSignal
bypassIntegratedCache
Legt fest, ob der integrierte Cache für die Anforderung im Azure CosmosDB-Dienst umgangen oder aktiviert werden soll.
Der Standardwert ist "false". Standardmäßig ist der integrierte Cache aktiviert.
bypassIntegratedCache?: booleanEigenschaftswert
boolean
consistencyLevel
Konsistenzstufe, die vom Client benötigt wird.
consistencyLevel?: stringEigenschaftswert
string
disableRUPerMinuteUsage
DisableRUPerMinuteUsage wird verwendet, um Anforderungseinheiten(RUs)/Minute-Kapazität für die Anforderung zu aktivieren/zu deaktivieren, wenn reguläre bereitgestellte RUs/Sekunde erschöpft sind.
disableRUPerMinuteUsage?: booleanEigenschaftswert
boolean
excludedLocations
Schließt eine oder mehrere Azure-Regionen für den Vorgang aus.
Diese Option wird nur angewendet, wenn enableEndPointDiscovery auf true festgelegt ist.
excludedLocations?: string[]Eigenschaftswert
string[]
initialHeaders
(Erweiterter Anwendungsfall) Anfängliche Kopfzeilen, die beim Senden von Anforderungen an Cosmos beginnen sollen
initialHeaders?: CosmosHeadersEigenschaftswert
maxIntegratedCacheStalenessInMs
Legt den Veraltetkeitswert fest, der der Anforderung im Azure CosmosDB-Dienst zugeordnet ist. Bei Anforderungen, bei denen die <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> oder <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>ist, sind Antworten aus dem integrierten Cache garantiert kein Staler als der wert, der durch diese maxIntegratedCacheStaleness angegeben ist. Wenn die Konsistenzstufe nicht festgelegt ist, wird diese Eigenschaft ignoriert.
Standardwert ist NULL
Die Cache-Veraltetkeit wird in Millisekunden Granularität unterstützt. Alles, was kleiner als Millisekunden ist, wird ignoriert.
maxIntegratedCacheStalenessInMs?: numberEigenschaftswert
number
priorityLevel
Prioritätsstufe (Niedrig/Hoch) für jede Anforderung. Anforderungen mit niedriger Priorität werden immer vor Anforderungen mit hoher Priorität gedrosselt.
Der Standardwert ist NULL. Standardmäßig sind alle Anforderungen von hoher Priorität
priorityLevel?: PriorityLevelEigenschaftswert
sessionToken
Aktiviert/deaktiviert das Abrufen von Dokumentcontainerkontingentstatistiken für Dokumentcontainerleseanforderungen.
sessionToken?: stringEigenschaftswert
string
throughputBucket
Durchsatz-Bucket für eine Anforderung.
Der Standardwert ist NULL. In diesem Fall kann die Anforderung 100% des Partitionsdurchsatzes verwenden.
Weitere Informationen finden Sie unter [Bucketing des Cosmos DB-Durchsatzes](https://aka.ms/cosmsodb-bucketing).throughputBucket?: numberEigenschaftswert
number