@azure/cosmos package

  • Referenz

Klassen

AbortError

Dieser Fehler wird ausgelöst, wenn ein asynchroner Vorgang abgebrochen wurde. Überprüfen Sie auf diesen Fehler, indem Sie testen name , ob die name-Eigenschaft des Fehlers mit übereinstimmt "AbortError".

Beispiel

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

Stellt einen Iterator für den Änderungsfeed bereit.

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

Eine einzelne Antwortseite aus dem Azure Cosmos DB-Änderungsfeed
ChangeFeedResponse

Eine einzelne Antwortseite aus dem Azure Cosmos DB-Änderungsfeed
ChangeFeedStartFrom

Basisklasse für den Start eines ChangeFeedIterators.
ClientSideMetrics
Conflict

Verwenden Sie , um einen bestimmten Konflikt nach ID zu lesen oder zu löschen.

Informationen zum Abfragen oder Lesen aller Konflikte finden Sie unter Konflikte .
ConflictResponse
Conflicts

Verwenden Sie , um alle Konflikte abzufragen oder zu lesen.

Informationen zum Lesen oder Löschen eines bestimmten Konflikts nach ID finden Sie unter Konflikt.
Container

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

Weitere Informationen finden Sie unter Container zum Erstellen neuer Container und Lesen/Abfragen aller Container. Verwenden Sie .containers.

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

Antwortobjekt für Containervorgänge
Containers

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

Informationen zum Lesen, Ersetzen oder Löschen eines vorhandenen Containers finden Sie unter Container . Verwenden Sie .container(id).

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

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>", auth: {masterKey: "<KEY HERE>"}});
await client.databases.create({id: "<datbase name here>"});

Beispiel

Instanziieren eines Clients mit benutzerdefinierter Verbindungsrichtlinie

const connectionPolicy = new ConnectionPolicy();
connectionPolicy.RequestTimeout = 10000;
const client = new CosmosClient({
   endpoint: "<URL HERE>",
   auth: {masterKey: "<KEY HERE>"},
   connectionPolicy
});
CosmosDiagnostics
  • Dies ist ein Cosmos-Diagnosetyp, der während eines Clientbetriebs gesammelte Diagnoseinformationen enthält. Ie. Item.read(), Container.create(). Es verfügt über drei Mitglieder :
  1. clientSideRequestStatistics member enthält aggregierte Diagnoseinformationen, einschließlich -
  • Metadaten-Lookups. Hier werden alle Serveranforderungen außer der endgültigen vorgesehenen Ressource als Metadatenaufrufe betrachtet. Wenn der Client z. B. für item.read(id) einen Serveraufruf vornimmt, um Endpunkte zu ermitteln, wird er als Metadatenaufruf betrachtet.
  • retries
  • Endpunkte, die kontaktiert wurden.
  • Anforderungs-, Antwortnutzlaststatistiken.
  • gatewayStatistics: Informationen zu Standard Vorgang. Beispielsweise während Item.read() kann der Client viele Vorgänge ausführen, z. B. Metadatensuche usw., aber gatewayStatistics stellt die Diagnose Informationen für den tatsächlichen Lesevorgang dar.
  1. diagnosticNode: Eine strukturähnliche Struktur, die detaillierte Diagnoseinformationen erfasst. Standardmäßig ist sie deaktiviert und dient nur zum Debuggen in Nicht-Produktionsumgebungen. Die Art der in diagnosticNode erfassten Details wird von CosmosDbDiagnosticLevelgesteuert.
  • CosmosDbDiagnosticLevel.info: Der Standardwert. Auf dieser Ebene werden nur clientSideRequestStatistics erfasst. Is 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: Erfasst zusätzlich zu den in CosmosDbDiagnosticLevel.debug erfassten Daten auch Anforderungs- und Antwortnutzlasten. Ist nicht für die Verwendung in der Produktionsumgebung vorgesehen.
  1. clientConfig: Erfasst Informationen im Zusammenhang mit der Konfiguration des Clients während der Initialisierung.
Database

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

Informationen zum Erstellen neuer Datenbanken und Lesen/Abfragen aller Datenbanken finden Sie unter Datenbanken . Verwenden Sie client.databases.

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

Stellt ein DatabaseAccount im Azure Cosmos DB-Datenbankdienst dar.
DatabaseResponse

Antwortobjekt für Datenbankvorgänge
Databases

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

Informationen zum Lesen oder Löschen einer vorhandenen Datenbank finden Sie unter Datenbank . Verwenden Sie client.database(id).

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

Gibt einen Feedbereich für den Changefeed an.
FeedResponse
Item

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

Unter Elemente finden Sie Vorgänge für alle Elemente. Siehe container.items.
ItemResponse
Items

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

Informationen zum Lesen, Ersetzen oder Löschen eines vorhandenen Containers finden Sie unter Element . Verwenden Sie .item(id).
Offer

Verwenden Sie , um ein vorhandenes Angebot durch die ID zu lesen oder zu ersetzen.

Informationen zum Abfragen oder Lesen aller Angebote finden Sie unter Angebote .
OfferResponse
Offers

Verwenden Sie , um alle Angebote abzufragen oder zu lesen.

Informationen zum Lesen oder Ersetzen eines vorhandenen Angebots durch die ID finden Sie unter Angebot.
PartitionKeyBuilder

Builder-Klasse zum Erstellen von PartitionKey.
Permission

Verwenden Sie , um eine bestimmte Berechtigung nach ID zu lesen, zu ersetzen oder zu löschen.

Weitere Informationen finden Sie unter Berechtigungen zum Erstellen, Upsertieren, Abfragen oder Lesen aller Berechtigungen.
PermissionResponse
Permissions

Verwenden Sie zum Erstellen, Ersetzen, Abfragen und Lesen aller Berechtigungen.

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

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

Ein benutzerdefinierter Fehlertyp für fehlerhafte Pipelineanforderungen.
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure

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:
StoredProcedureResponse
StoredProcedures

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

Informationen zu Vorgängen zum Lesen, Ersetzen, Löschen oder Ausführen einer bestimmten, vorhandenen gespeicherten Prozedur nach ID finden Sie unter container.storedProcedure().
TimeoutError
Trigger

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

Verwenden Sie container.triggers zum Erstellen, Upsertieren, Abfragen oder Lesen aller Elemente.
TriggerResponse
Triggers

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

Verwenden Sie container.triggers zum Lesen, Ersetzen oder Löschen eines Triggers.
User

Wird zum Lesen, Ersetzen und Löschen von Benutzern verwendet.

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

Weitere Informationen finden Sie unter Benutzer zum Erstellen, Upsertieren, Abfragen oder Lesen aller Benutzer.
UserDefinedFunction

Wird verwendet, um eine angegebene User Definied-Funktion nach ID zu lesen, zu ersetzen oder zu löschen.

Informationen zum Erstellen, Upsert, Abfragen, Lesen aller benutzerdefinierten Funktionen finden Sie unter UserDefinedFunction .
UserDefinedFunctionResponse
UserDefinedFunctions

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

Informationen zum Lesen, Ersetzen oder Löschen einer bestimmten benutzerdefinierten Funktion nach ID finden Sie unter UserDefinedFunction .
UserResponse
Users

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

Weitere Informationen finden Sie unter Benutzer , um einen bestimmten Benutzer anhand der ID zu lesen, zu ersetzen oder zu löschen.

Schnittstellen

@azure/cosmos.Index
Agent
BulkOptions

Options-Objekt, das zum Ändern der Massenausführung verwendet wird. continueOnError (Standardwert: false) – Setzt die Massenausführung fort, wenn ein Vorgang fehlschlägt ** HINWEIS, DASS DIES IM RELEASE 4.0 STANDARDMÄßIG AUF TRUE FESTGELEGT IST
ChangeFeedIteratorOptions

Gibt Optionen für den Änderungsfeed an.

Wenn keine dieser Optionen festgelegt ist, beginnt das Lesen der Änderungen ab sofort für den gesamten Container.
ChangeFeedOptions

Gibt Optionen für den Änderungsfeed an.

Einige dieser Optionen steuern, wo und wann mit dem Lesen aus dem Änderungsfeed begonnen werden soll. Die Rangfolge lautet:

  • Continuation
  • startTime
  • startFromBeginning

Wenn keine dieser Optionen festgelegt ist, beginnt das Lesen der Änderungen aus dem ersten ChangeFeedIterator.fetchNext() Aufruf.
ChangeFeedPullModelIterator

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.
ConflictDefinition
ConflictResolutionPolicy

Stellt die Konfliktlösungsrichtlinienkonfiguration dar, mit der angegeben wird, wie Konflikte gelöst werden sollen, falls Schreibvorgänge aus verschiedenen Regionen zu Konflikten in Dokumenten in der Sammlung im Azure Cosmos DB-Dienst führen.
ConnectionPolicy

Stellt die Verbindungsrichtlinie dar, die einem CosmosClient im Azure Cosmos DB-Datenbankdienst zugeordnet ist.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode

Stellt eine Struktur wie eine Struktur zum Erfassen von Diagnoseinformationen dar.
ErrorBody
FailedRequestAttemptDiagnostic

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

Die Feedoptionen und Abfragemethoden.
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition

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

Reservierte Schlüssel können nicht verwendet werden. Die Liste mit reservierten Schlüsseln finden Sie unter <xref:ItemBody>
JSONArray
JSONObject
Location

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

Dieser Typ enthält Diagnoseinformationen zu einer einzelnen Metadatenanforderung an den Server.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions

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

Stellt die Wiederholungsrichtlinie dar, die mit gedrosselten Anforderungen im Azure Cosmos DB-Datenbankdienst zugeordnet ist.
SharedOptions

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

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

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

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

Beispiel

Parametrisierte SQL-Abfrage

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

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

Schnittstelle zum Festlegen eindeutiger Schlüssel bei der Containererstellung
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition

Typaliase

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic

Dieser Typ enthält Informationen im Zusammenhang mit der Initialisierung von CosmosClient
ClientSideRequestStatistics

Dies ist ein Sammlungstyp für alle clientseitigen Diagnoseinformationen.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics

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

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.
NullPartitionKeyType

Das zurückgegebene Objekt stellt einen Partitionsschlüsselwert dar, der das Erstellen und Zugreifen auf Elemente mit einem NULL-Wert für den Partitionsschlüssel ermöglicht.
Operation
OperationInput
OperationWithItem
PartitionKey

PartitionKey eines Containers.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue

Ein primitiver Partitionsschlüsselwert.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics

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

Enumerationen

ConflictResolutionMode
ConnectionMode

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

Stellt die für Azure Cosmos DB-Clientvorgänge unterstützten Konsistenzebenen dar.
Der angeforderte ConsistencyLevel muss mit dem für das Datenbankkonto bereitgestellten Wert übereinstimmen oder schwächer sein. Konsistenzebenen.

Konsistenzebenen nach Reihenfolge der Stärke sind Strong, BoundedStaleness, Session, Consistent Prefix und Eventual.

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

Cosmos DB-Diagnoseebene
DataType

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

Gibt die unterstützten Indextypen an.
IndexingMode

Gibt die unterstützten Indizierungsmodi an.
MetadataLookUpType

Dies ist eine Enumeration für typ der möglichen Metadatensuchvorgänge.
PartitionKeyDefinitionVersion

PartitionKey-Definitionsversion
PartitionKeyKind

Typ von PartitionKey, d. h. Hash, MultiHash
PermissionMode

Enumeration für Berechtigungsmoduswerte.
PriorityLevel

Stellt die Prioritätsebene 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 https://aka.ms/CosmosDB/PriorityBasedExecution in der Dokumentation.
SpatialType
TriggerOperation

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

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

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

Functions

createAuthorizationSasToken(string, SasTokenProperties)

Nur experimentell intern Generiert die Nutzlast, die die Berechtigungskonfiguration für das SAS-Token darstellt.

Details zur Funktion

createAuthorizationSasToken(string, SasTokenProperties)

Nur experimentell intern Generiert die Nutzlast, die die Berechtigungskonfiguration für das SAS-Token darstellt.

function createAuthorizationSasToken(masterKey: string, sasTokenProperties: SasTokenProperties): Promise<string>

Parameter

masterKey

string

sasTokenProperties
SasTokenProperties

Gibt zurück

Promise<string>