@azure/cosmos package

Dieser Fehler wird ausgelöst, wenn ein asynchroner Vorgang abgebrochen wurde. Überprüfen Sie diesen Fehler, indem Sie die name testen, dass die Namenseigenschaft des Fehlers "AbortError"entspricht.

Beispiel

const controller = new AbortController();
controller.abort();
try {
  doAsyncWork(controller.signal)
} catch (e) {
  if (e.name === 'AbortError') {
    // handle abort error here.
  }
}

Stellt Iterator für Änderungsfeed bereit.

Verwenden Sie Items.changeFeed(), um eine Instanz des Iterators abzurufen.

Eine einzelne Antwortseite aus dem Azure Cosmos DB Change Feed

Stellt die Konfiguration der Änderungsfeedrichtlinie für einen Container im Azure Cosmos DB-Dienst dar.

Eine einzelne Antwortseite aus dem Azure Cosmos DB Change Feed

Basisklasse, für die ein ChangeFeedIterator gestartet werden soll.

Dient zum Lesen oder Löschen eines bestimmten Conflict nach ID.

Siehe Konflikte, um alle Konflikte abzufragen oder zu lesen.

Wird verwendet, um alle Konflikte abzufragen oder zu lesen.

Siehe Konflikt- zum Lesen oder Löschen eines bestimmten Conflict nach ID.

Vorgänge zum Lesen, Ersetzen oder Löschen eines bestimmten, vorhandenen Containers nach ID.

Siehe Container zum Erstellen neuer Container und lesen/Abfragen aller Container; verwenden Sie .containers.

Hinweis: Alle diese Vorgänge führen Aufrufe für ein festes Budget aus. Sie sollten Ihr System so entwerfen, dass diese Aufrufe mit Ihrer Anwendung sublinear skaliert werden. Rufen Sie z. B. vor jedem einzelnen item.read() Aufruf nicht container(id).read() auf, um sicherzustellen, dass der Container vorhanden ist; Führen Sie dies einmal beim Starten der Anwendung aus.

Antwortobjekt für Containervorgänge

Vorgänge zum Erstellen neuer Container und Lesen/Abfragen aller Container

Siehe Container- zum Lesen, Ersetzen oder Löschen eines vorhandenen Containers; verwenden Sie .container(id).

Hinweis: Alle diese Vorgänge führen Aufrufe für ein festes Budget aus. Sie sollten Ihr System so entwerfen, dass diese Aufrufe mit Ihrer Anwendung sublinear skaliert werden. Rufen Sie z. B. vor jedem einzelnen item.read() Aufruf nicht containers.readAll() auf, um sicherzustellen, dass der Container vorhanden ist; Führen Sie dies einmal beim Starten der Anwendung aus.

Stellt eine clientseitige logische Darstellung des Azure Cosmos DB-Datenbankkontos bereit. Dieser Client wird verwendet, um Anforderungen im Azure Cosmos DB-Datenbankdienst zu konfigurieren und auszuführen.

Beispiel

Instanziieren eines Clients und Erstellen einer neuen Datenbank

const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"});
await client.databases.create({id: "<database name here>"});

Beispiel

Instanziieren eines Clients mit benutzerdefinierter Verbindungsrichtlinie

const client = new CosmosClient({
   endpoint: "<URL HERE>",
   key: "<KEY HERE>",
   connectionPolicy: {
    requestTimeout: 10000,
   },
});

• Dies ist ein Cosmos Diagnostic-Typ, der gesammelte Diagnoseinformationen während eines Clientbetriebs enthält. ie. Item.read(), Container.create(). Es hat drei Mitglieder -

1. clientSideRequestStatistics Mitglied enthält aggregierte Diagnoseinformationen, einschließlich -

• Metadaten-Nachschlagevorgänge. Hier werden alle Serveranforderungen abgesehen von der endgültigen vorgesehenen Ressource als Metadatenaufrufe betrachtet. d. h. für item.read(id), wenn der Client serveraufruft, um Endpunkte zu ermitteln, wird er als Metadatenaufruf betrachtet.
• Wiederholungen
• Endpunkte, die kontaktiert wurden.
• Anforderungs-, Antwortnutzlast-Statistiken.
• gatewayStatistics – Informationen, die dem Hauptvorgang entsprechen. Beispielsweise während item.read(), kann der Client viele Vorgänge ausführen, z. B. Metadatensuche usw., aber gatewayStatistics stellt die Diagnoseinformationen für den tatsächlichen Lesevorgang dar.

2. diagnosticNode – Ist eine Struktur wie struktur, die detaillierte Diagnoseinformationen erfasst. Standardmäßig ist sie deaktiviert und soll nur für das Debuggen in Nicht-Produktionsumgebungen verwendet werden. Die Art der in diagnosticNode erfassten Details wird durch CosmosDbDiagnosticLevelgesteuert.

• CosmosDbDiagnosticLevel.info – Standardwert. Auf dieser Ebene werden nur clientSideRequestStatistics erfasst. Ist für Produktionsumgebungen vorgesehen.
• CosmosDbDiagnosticLevel.debug - Erfasst diagnosticNode und clientConfig. Es werden keine Anforderungs- und Antwortnutzlasten erfasst. Ist nicht für die Verwendung in der Produktionsumgebung vorgesehen.
• CosmosDbDiagnosticLevel.debug-unsafe - Zusätzlich zu den in CosmosDbDiagnosticLevel.debug erfassten Daten werden auch Anforderungs- und Antwortnutzlasten erfasst. Ist nicht für die Verwendung in der Produktionsumgebung vorgesehen.

3. clientConfig – Erfasst Informationen im Zusammenhang mit der Konfiguration des Clients während der Initialisierung.

Vorgänge zum Lesen oder Löschen einer vorhandenen Datenbank.

Siehe Datenbanken zum Erstellen neuer Datenbanken und lesen/Abfragen aller Datenbanken; verwenden Sie client.databases.

Hinweis: Alle diese Vorgänge führen Aufrufe für ein festes Budget aus. Sie sollten Ihr System so entwerfen, dass diese Aufrufe mit Ihrer Anwendung sublinear skaliert werden. Rufen Sie z. B. vor jedem einzelnen item.read() Aufruf nicht database.read() auf, um sicherzustellen, dass die Datenbank vorhanden ist; Führen Sie dies einmal beim Starten der Anwendung aus.

Stellt ein DatabaseAccount im Azure Cosmos DB-Datenbankdienst dar.

Antwortobjekt für Datenbankvorgänge

Vorgänge zum Erstellen neuer Datenbanken und Lesen/Abfragen aller Datenbanken

Siehe Datenbank zum Lesen oder Löschen einer vorhandenen Datenbank; verwenden Sie client.database(id).

Hinweis: Alle diese Vorgänge führen Aufrufe für ein festes Budget aus. Sie sollten Ihr System so entwerfen, dass diese Aufrufe mit Ihrer Anwendung sublinear skaliert werden. Rufen Sie z. B. vor jedem einzelnen item.read() Aufruf nicht databases.readAll() auf, um sicherzustellen, dass die Datenbank vorhanden ist; Führen Sie dies einmal beim Starten der Anwendung aus.

Gibt einen Feedbereich für den Änderungsfeed an.

Wird verwendet, um Vorgänge für ein bestimmtes Element auszuführen.

Siehe Elemente für Vorgänge für alle Elemente; siehe container.items.

Vorgänge zum Erstellen neuer Elemente und Lesen/Abfragen aller Elemente

Siehe Element- zum Lesen, Ersetzen oder Löschen eines vorhandenen Containers; verwenden Sie .item(id).

Dient zum Lesen oder Ersetzen einer vorhandenen Angebots- nach ID.

Siehe Angebote, um alle Angebote abzufragen oder zu lesen.

Wird verwendet, um alle Angebote abzufragen oder zu lesen.

Siehe Angebot, um ein vorhandenes Angebot nach ID zu lesen oder zu ersetzen.

Generatorklasse zum Erstellen von PartitionKey.

Dient zum Lesen, Ersetzen oder Löschen eines bestimmten Berechtigungs- nach ID.

Lesen Sie Berechtigungen zum Erstellen, Upsert, Abfragen oder Lesen aller Berechtigungen.

Dient zum Erstellen, Ersetzen, Abfragen und Lesen aller Berechtigungen.

Weitere Informationen finden Sie unter Berechtigungs- zum Lesen, Ersetzen oder Löschen einer bestimmten Berechtigung nach ID.

Stellt ein QueryIterator-Objekt dar, eine Implementierung der Feed- oder Abfrageantwort, die das Durchlaufen und Durchlaufen der Antwort im Azure Cosmos DB-Datenbankdienst ermöglicht.

Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.

Vorgänge zum Lesen, Ersetzen, Löschen oder Ausführen einer bestimmten, vorhandenen gespeicherten Prozedur nach ID.

Für Vorgänge zum Erstellen, Lesen aller oder Abfragen gespeicherter Prozeduren,

Vorgänge zum Erstellen, Upserting oder Lesen/Abfragen aller gespeicherten Prozeduren.

Informationen zum Lesen, Ersetzen, Löschen oder Ausführen einer bestimmten, vorhandenen gespeicherten Prozedur anhand der ID finden Sie unter container.storedProcedure().

Vorgänge zum Lesen, Ersetzen oder Löschen eines Trigger-.

Verwenden Sie container.triggers zum Erstellen, Upsert, Abfragen oder Lesen aller Elemente.

Vorgänge zum Erstellen, Upsert, Abfragen und Lesen aller Trigger.

Verwenden Sie container.triggers zum Lesen, Ersetzen oder Löschen eines Trigger-.

Wird verwendet, um Benutzer zu lesen, zu ersetzen und zu löschen.

Darüber hinaus können Sie über user.permission und user.permissionsauf die Berechtigungen für einen bestimmten Benutzer zugreifen.

Siehe Benutzer zum Erstellen, Upsert, Abfragen oder Lesen aller Benutzer.

Dient zum Lesen, Ersetzen oder Löschen einer angegebenen Benutzer definied-Funktion nach ID.

Siehe UserDefinedFunction- zum Erstellen, Upsert, Abfragen, Lesen aller benutzerdefinierten Funktionen.

Wird zum Erstellen, Upsert, Abfragen oder Lesen aller benutzerdefinierten Funktionen verwendet.

Siehe UserDefinedFunction-, um eine bestimmte benutzerdefinierte Funktion anhand der ID zu lesen, zu ersetzen oder zu löschen.

Wird zum Erstellen, Upsert, Abfragen und Lesen aller Benutzer verwendet.

Siehe Benutzer-, um einen bestimmten Benutzer nach ID zu lesen, zu ersetzen oder zu löschen.

Options-Objekt zum Ändern der Massenausführung. continueOnError (Standardwert: false) – Setzt die Massenausführung fort, wenn ein Vorgang fehlschlägt ** BEACHTEN SIE, DASS DIES IN DER VERSION 4.0 STANDARDMÄßIG AUF "TRUE" FESTGELEGT IST.

Gibt Optionen für den Änderungsfeed an.

Wenn keine dieser Optionen festgelegt ist, beginnt sie mit dem Lesen von Änderungen ab jetzt für den gesamten Container.

Gibt Optionen für den Änderungsfeed an.

Einige dieser Optionen steuern, wo und wann Sie mit dem Lesen aus dem Änderungsfeed beginnen. Die Reihenfolge der Rangfolge lautet:

• Fortsetzung
• startTime
• startFromBeginning

Wenn keine dieser Optionen festgelegt ist, beginnt sie mit dem Lesen von Änderungen vom ersten ChangeFeedIterator.fetchNext() Anruf.

Verwenden Sie Items.getChangeFeedIterator(), um einen Iterator zurückzugeben, der alle Änderungen für einen Partitionsschlüssel, einen Feedbereich oder einen gesamten Container durchlaufen kann.

Stellt einen zusammengesetzten Pfad in der Indizierungsrichtlinie dar.

Stellt die Konfiguration der Konfliktlösungsrichtlinie dar, mit der angegeben wird, wie Konflikte bei Schreibvorgängen aus verschiedenen Regionen gelöst werden sollen, zu Konflikten bei Dokumenten in der Auflistung im Azure Cosmos DB-Dienst führen.

Stellt die Verbindungsrichtlinie dar, die einem CosmosClient im Azure Cosmos DB-Datenbankdienst zugeordnet ist.

Stellt eine Struktur wie struktur zum Erfassen von Diagnoseinformationen dar.

Dieser Typ erfasst Diagnoseinformationen zu einer fehlgeschlagenen Anforderung an die Server-API.

Die Feedoptionen und Abfragemethoden.

Elemente in Cosmos DB sind einfach JSON-Objekte. Die meisten Elementvorgänge ermöglichen es, Ihren eigenen Typ bereitzustellen, der die sehr einfache ItemDefinition erweitert.

Sie können keine reservierten Schlüssel verwenden. Sie können die Reservierte Schlüsselliste in <xref:ItemBody>

Wird verwendet, um die verfügbaren Speicherorte anzugeben, ist "Index 1" und "Schreibzugriff" index 0.

Dieser Typ enthält Diagnoseinformationen zu einer einzelnen Metadatenanforderung an den Server.

Optionen, die für eine angeforderte, ausgestellte Azure Cosmos DB-Server angegeben werden können.=

Stellt die Wiederholungsrichtlinie dar, die mit eingeschränkten Anforderungen im Azure Cosmos DB-Datenbankdienst zugeordnet ist.

Optionen, die für eine angeforderte, ausgestellte Azure Cosmos DB-Server angegeben werden können.=

Stellt einen Parameter in einer parametrisierten SQL-Abfrage dar, die in SqlQuerySpec-

Stellt eine SQL-Abfrage im Azure Cosmos DB-Dienst dar.

Abfragen mit Eingaben sollten parametrisiert werden, um vor DER SQL-Einfügung zu schützen.

Beispiel

Parametrisierte SQL-Abfrage

const query: SqlQuerySpec = {
  query: "SELECT * FROM Families f where f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Wakefield"}
  ]
};

Schnittstelle für einen einzelnen eindeutigen Schlüssel, der als Teil von UniqueKeyPolicy übergeben wird

Schnittstelle zum Festlegen eindeutiger Schlüssel bei der Containererstellung

Stellt eine Vektoreinbettung dar. Eine Vektoreinbettung wird verwendet, um ein Vektorfeld in den Dokumenten zu definieren.

Stellt die Richtlinienkonfiguration für Vektoreinbettungen im Azure Cosmos DB-Dienst dar.

Stellt einen Vektorindex im Azure Cosmos DB-Dienst dar. Ein Vektorindex wird zum Indizieren von Vektorfeldern in den Dokumenten verwendet.

Dieser Typ enthält Informationen zur Initialisierung von CosmosClient

Dies ist ein Sammlungstyp für alle clientseitigen Diagnoseinformationen.

Dieser Typ enthält Diagnoseinformationen zu allen Metadatenanforderungen an den Server während eines CosmosDB-Clientvorgangs.

Das zurückgegebene Objekt stellt einen Partitionsschlüsselwert dar, der das Erstellen und Zugreifen auf Elemente ohne einen Wert für den Partitionsschlüssel ermöglicht.

Das zurückgegebene Objekt stellt einen Partitionsschlüsselwert dar, der das Erstellen und Zugreifen auf Elemente mit einem Nullwert für den Partitionsschlüssel ermöglicht.

Partitionkey eines Containers.

Ein primitiver Partitionsschlüsselwert.

Dieser Typ erfasst Diagnoseinformationen zu Wiederholungsversuchen während eines CosmosDB-Clientvorgangs.

Bestimmt das Verbindungsverhalten des CosmosClient. Beachten Sie, dass derzeit nur der Gatewaymodus unterstützt wird.

Stellt die Konsistenzstufen dar, die für Azure Cosmos DB-Clientvorgänge unterstützt werden.
Die angeforderte Konsistenzstufe muss übereinstimmen oder schwächer sein als die für das Datenbankkonto bereitgestellte. Konsistenzstufen.

Konsistenzstufen nach Festigkeitsreihenfolge sind "Strong", "BoundedStaleness", "Session", "Consistent Prefix" und "Eventual".

Ausführlichere Dokumentation zu Konsistenzstufen finden Sie unter https://aka.ms/cosmos-consistency.

Cosmos DB-Diagnosestufe

Definiert einen Zieldatentyp einer Indexpfadspezifikation im Azure Cosmos DB-Dienst.

Gibt die unterstützten Indextypen an.

Gibt die unterstützten Indizierungsmodi an.

Dies ist eine Enumeration für den möglichen Typ von Metadaten-Nachschlagevorgängen.

PartitionKey Definition Version

Typ des PartitionKey, d. h. Hash, MultiHash

Enumeration für Berechtigungsmoduswerte.

Stellt die Prioritätsstufe dar, die den einzelnen Azure Cosmos DB-Clientanforderungen zugeordnet ist.
Die Anforderungen mit niedriger Priorität werden immer vor Anforderungen mit hoher Priorität gedrosselt.

Standardmäßig werden alle Anforderungen als Anforderungen mit hoher Priorität betrachtet.

Ausführlichere Dokumentation zur Prioritätsbasierten Drosselung finden Sie unter https://aka.ms/CosmosDB/PriorityBasedExecution.

Enumeration für Triggervorgangswerte. Gibt die Vorgänge an, für die ein Trigger ausgeführt werden soll.

Enumeration für Triggertypwerte. Gibt den Typ des Triggers an.

Enumeration für UDF-Typwerte. Gibt die Typen von benutzerdefinierten Funktionen an.

Stellt den Datentyp des Vektors dar.

Stellt die Abstandsfunktion dar, die für die Entfernungsberechnung zwischen Vektoren verwendet werden soll.

Stellt den Indextyp des Vektors dar.

Experimental internal only Generates the payload representing the permission configuration for the sas token.