@azure/cosmos package

Klasy

AbortError	Ten błąd jest zgłaszany, gdy operacja asynchroniczna została przerwana. Sprawdź ten błąd, testującname, czy właściwość name błędu jest zgodna z ."AbortError" Przykład const controller = new AbortController(); controller.abort(); try { doAsyncWork(controller.signal) } catch (e) { if (e.name === 'AbortError') { // handle abort error here. } }
ChangeFeedIterator	Udostępnia iterator zestawienia zmian. Użyj Items.changeFeed() polecenia , aby uzyskać wystąpienie iteratora.
ChangeFeedIteratorResponse	Pojedyncza strona odpowiedzi ze źródła zmian usługi Azure Cosmos DB
ChangeFeedResponse	Pojedyncza strona odpowiedzi ze źródła zmian usługi Azure Cosmos DB
ChangeFeedStartFrom	Klasa bazowa dla miejsca uruchamiania obiektu ChangeFeedIterator.
ClientSideMetrics
Conflict	Służy do odczytywania lub usuwania danego konfliktu według identyfikatora. Zobacz Konflikty , aby wysyłać zapytania lub odczytywać wszystkie konflikty.
ConflictResponse
Conflicts	Służy do wykonywania zapytań lub odczytywania wszystkich konfliktów. Zobacz Konflikt , aby odczytać lub usunąć dany konflikt według identyfikatora.
Container	Operacje odczytu, zastępowania lub usuwania określonego istniejącego kontenera według identyfikatora. Zobacz Kontenery dotyczące tworzenia nowych kontenerów i odczytywania/wykonywania zapytań dotyczących wszystkich kontenerów. użyj polecenia .containers. Uwaga: wszystkie te operacje tworzą wywołania względem stałego budżetu. Należy zaprojektować system tak, aby te wywołania były skalowane podlinijnie w aplikacji. Na przykład nie należy wywoływać container(id).read() przed każdym wywołaniem item.read() , aby upewnić się, że kontener istnieje. Zrób to raz na uruchomieniu aplikacji.
ContainerResponse	Obiekt odpowiedzi dla operacji kontenera
Containers	Operacje tworzenia nowych kontenerów i odczytywania/wykonywania zapytań względem wszystkich kontenerów Zobacz Kontener do odczytywania, zastępowania lub usuwania istniejącego kontenera; użyj polecenia .container(id). Uwaga: wszystkie te operacje tworzą wywołania względem stałego budżetu. Należy zaprojektować system tak, aby te wywołania były skalowane podlinijnie w aplikacji. Na przykład nie należy wywoływać containers.readAll() przed każdym wywołaniem item.read() , aby upewnić się, że kontener istnieje. Zrób to raz na uruchomieniu aplikacji.
CosmosClient	Zapewnia logiczną reprezentację konta bazy danych usługi Azure Cosmos DB po stronie klienta. Ten klient służy do konfigurowania i wykonywania żądań w usłudze bazy danych Azure Cosmos DB. Przykład Utworzenie wystąpienia klienta i utworzenie nowej bazy danych const client = new CosmosClient({endpoint: "<URL HERE>", auth: {masterKey: "<KEY HERE>"}}); await client.databases.create({id: "<datbase name here>"}); Przykład Tworzenie wystąpienia klienta przy użyciu niestandardowych zasad połączenia const connectionPolicy = new ConnectionPolicy(); connectionPolicy.RequestTimeout = 10000; const client = new CosmosClient({ endpoint: "<URL HERE>", auth: {masterKey: "<KEY HERE>"}, connectionPolicy });
CosmosDiagnostics	Jest to typ diagnostyczny usługi Cosmos, który przechowuje zebrane informacje diagnostyczne podczas operacji klienta. Ie. Item.read(), Container.create(). Ma trzech członków - clientSideRequestStatistics Element członkowski zawiera zagregowane informacje diagnostyczne, w tym — wyszukiwania metadanych. Tutaj wszystkie żądania serwera, oprócz końcowego zamierzonego zasobu są traktowane jako wywołania metadanych. tj. w przypadku elementu item.read(id), jeśli klient wykonuje wywołanie serwera w celu odnalezienia punktów końcowych, zostanie uznane za wywołanie metadanych. Ponownych prób skontaktowano się z punktami końcowymi. żądanie, statystyka ładunku odpowiedzi. gatewayStatistics — informacje odpowiadające głównej operacji. Na przykład podczas elementu Item.read() klient może wykonywać wiele operacji, np. wyszukiwanie metadanych itp., ale gatewayStatistics reprezentuje informacje diagnostyczne dotyczące rzeczywistej operacji odczytu. diagnosticNode — jest strukturą podobną do drzewa, która przechwytuje szczegółowe informacje diagnostyczne. Domyślnie jest on wyłączony i ma być używany tylko do debugowania w środowiskach nieprodukcyjnych. Rodzaj szczegółów przechwyconych w programie diagnosticNode jest kontrolowany przez element CosmosDbDiagnosticLevel. CosmosDbDiagnosticLevel.info — jest wartością domyślną. Na tym poziomie są przechwytywane tylko clientSideRequestStatistics. Jest przeznaczony dla środowisk produkcyjnych. CosmosDbDiagnosticLevel.debug — przechwytuje diagnosticNode i clientConfig. Żadne ładunki żądań i odpowiedzi nie są przechwytywane. Nie jest przeznaczony do użycia w środowisku produkcyjnym. CosmosDbDiagnosticLevel.debug-unsafe — oprócz danych przechwyconych w pliku CosmosDbDiagnosticLevel.debug przechwytuje również ładunki żądań i odpowiedzi. Nie jest przeznaczony do użycia w środowisku produkcyjnym. clientConfig — przechwytuje informacje związane z konfiguracją klienta podczas inicjowania.
Database	Operacje odczytu lub usuwania istniejącej bazy danych. Zobacz Bazy danych dotyczące tworzenia nowych baz danych i odczytywania/wykonywania zapytań dotyczących wszystkich baz danych. użyj polecenia client.databases. Uwaga: wszystkie te operacje tworzą wywołania względem stałego budżetu. Należy zaprojektować system tak, aby te wywołania były skalowane podlinijnie w aplikacji. Na przykład nie należy wywoływać database.read() przed każdym wywołaniem item.read() , aby upewnić się, że baza danych istnieje. Zrób to po uruchomieniu aplikacji.
DatabaseAccount	Reprezentuje wartość DatabaseAccount w usłudze bazy danych Azure Cosmos DB.
DatabaseResponse	Obiekt odpowiedzi dla operacji bazy danych
Databases	Operacje tworzenia nowych baz danych i odczytywania/wykonywania zapytań względem wszystkich baz danych Zobacz Baza danych do odczytu lub usuwania istniejącej bazy danych; użyj polecenia client.database(id). Uwaga: wszystkie te operacje tworzą wywołania względem stałego budżetu. Należy zaprojektować system tak, aby te wywołania były skalowane podlinijnie w aplikacji. Na przykład nie należy wywoływać databases.readAll() przed każdym wywołaniem item.read() , aby upewnić się, że baza danych istnieje. Zrób to po uruchomieniu aplikacji.
ErrorResponse
FeedRange	Określa zakres kanału informacyjnego dla kanału zmian.
FeedResponse
Item	Służy do wykonywania operacji na określonym elemencie. Zobacz Elementy dla operacji na wszystkich elementach; zobacz container.items.
ItemResponse
Items	Operacje tworzenia nowych elementów i odczytywania/wykonywania zapytań dotyczących wszystkich elementów Zobacz Element do odczytywania, zastępowania lub usuwania istniejącego kontenera; użyj polecenia .item(id).
Offer	Użyj polecenia , aby odczytać lub zastąpić istniejącą ofertę według identyfikatora. Zobacz Oferty do wykonywania zapytań lub odczytywania wszystkich ofert.
OfferResponse
Offers	Użyj polecenia , aby wysłać zapytanie do wszystkich ofert lub odczytać wszystkie oferty. Zobacz Oferty , aby odczytać lub zamienić istniejącą ofertę według identyfikatora.
PartitionKeyBuilder	Klasa Builder do kompilowania partitionKey.
Permission	Służy do odczytywania, zastępowania lub usuwania danego uprawnienia według identyfikatora. Zobacz Uprawnienia do tworzenia, upsert, zapytania lub odczytywania wszystkich uprawnień.
PermissionResponse
Permissions	Służy do tworzenia, zastępowania, wykonywania zapytań i odczytywania wszystkich uprawnień. Zobacz Uprawnienie do odczytywania, zastępowania lub usuwania określonego uprawnienia według identyfikatora.
QueryIterator	Reprezentuje obiekt QueryIterator, implementację kanału informacyjnego lub odpowiedzi na zapytanie, która umożliwia przechodzenie i iterację odpowiedzi w usłudze bazy danych Azure Cosmos DB.
QueryMetrics
QueryPreparationTimes
ResourceResponse
RestError	Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure	Operacje odczytu, zastępowania, usuwania lub wykonywania określonej, istniejącej procedury składowanej według identyfikatora. W przypadku operacji tworzenia, odczytywania wszystkich lub wykonywania zapytań dotyczących procedur składowanych,
StoredProcedureResponse
StoredProcedures	Operacje tworzenia, rozbudowy lub odczytywania/wykonywania zapytań dotyczących wszystkich procedur składowanych. Aby uzyskać informacje o operacjach odczytu, zastępowania, usuwania lub wykonywania określonej, istniejącej procedury składowanej według identyfikatora, zobacz container.storedProcedure().
TimeoutError
Trigger	Operacje odczytu, zastępowania lub usuwania wyzwalacza. Służy container.triggers do tworzenia, upsert, wykonywania zapytań lub odczytywania wszystkich.
TriggerResponse
Triggers	Operacje tworzenia, upsert, wykonywania zapytań i odczytywania wszystkich wyzwalaczy. Służy container.triggers do odczytywania, zastępowania lub usuwania wyzwalacza.
User	Służy do odczytywania, zastępowania i usuwania użytkowników. Ponadto możesz uzyskać dostęp do uprawnień dla danego użytkownika za pośrednictwem i user.permissionuser.permissions. Zobacz Użytkownicy , aby utworzyć, upsert, zapytanie lub odczytać wszystko.
UserDefinedFunction	Służy do odczytywania, zastępowania lub usuwania określonej funkcji definied użytkownika według identyfikatora. Zobacz UserDefinedFunction , aby utworzyć, upsert, zapytanie, przeczytać wszystkie funkcje zdefiniowane przez użytkownika.
UserDefinedFunctionResponse
UserDefinedFunctions	Służy do tworzenia, upsert, zapytania lub odczytywania wszystkich funkcji zdefiniowanych przez użytkownika. Zobacz UserDefinedFunction , aby odczytywać, zastępować lub usuwać daną funkcję zdefiniowaną przez użytkownika według identyfikatora.
UserResponse
Users	Służy do tworzenia, upsert, wykonywania zapytań i odczytywania wszystkich użytkowników. Zobacz Użytkownik do odczytywania, zastępowania lub usuwania określonego użytkownika według identyfikatora.

Interfejsy

@azure/cosmos.Index

Agent
BulkOptions	Obiekt options używany do modyfikowania wykonywania zbiorczego. continueOnError (wartość domyślna: false) — kontynuuje wykonywanie zbiorcze, gdy operacja kończy się niepowodzeniem ** UWAGA WARTOŚĆ DOMYŚLNA TO WARTOŚĆ TRUE W WERSJI 4.0
ChangeFeedIteratorOptions	Określa opcje zestawienia zmian Jeśli żadna z tych opcji nie zostanie ustawiona, rozpocznie odczytywanie zmian od teraz dla całego kontenera.
ChangeFeedOptions	Określa opcje zestawienia zmian Niektóre z tych opcji określają, gdzie i kiedy rozpocząć odczytywanie ze zestawienia zmian. Kolejność pierwszeństwa to: Kontynuacji startTime startFromBeginning Jeśli żadna z tych opcji nie zostanie ustawiona, rozpocznie odczytywanie zmian z pierwszego ChangeFeedIterator.fetchNext() wywołania.
ChangeFeedPullModelIterator	Służy Items.getChangeFeedIterator() do zwracania iteratora, który może iterować po wszystkich zmianach klucza partycji, zakresu kanału informacyjnego lub całego kontenera.
ConflictDefinition
ConflictResolutionPolicy	Reprezentuje konfigurację zasad rozwiązywania konfliktów służącą do określania sposobu rozwiązywania konfliktów w przypadku zapisu z różnych regionów powoduje konflikty dokumentów w kolekcji w usłudze Azure Cosmos DB.
ConnectionPolicy	Reprezentuje zasady połączenia skojarzone z obiektem CosmosClient w usłudze bazy danych Azure Cosmos DB.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode	Reprezentuje drzewo, takie jak struktura, do przechwytywania informacji diagnostycznych.
ErrorBody
FailedRequestAttemptDiagnostic	Ten typ przechwytuje informacje diagnostyczne dotyczące nieudanego żądania do interfejsu API serwera.
FeedOptions	Opcje kanału informacyjnego i metody zapytań.
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition	Elementy w usłudze Cosmos DB to po prostu obiekty JSON. Większość operacji elementu umożliwia podanie własnego typu, który rozszerza bardzo prosty elementDefinition. Nie można użyć żadnych kluczy zarezerwowanych. Lista kluczy zarezerwowanych jest widoczna w <xref:ItemBody>
JSONArray
JSONObject
Location	Służy do określania dostępnych lokalizacji, odczyt to indeks 1, a zapis to indeks 0.
MetadataLookUpDiagnostic	Ten typ zawiera informacje diagnostyczne dotyczące pojedynczego żądania metadanych na serwerze.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions	Opcje, które można określić dla żądanych serwerów usługi Azure Cosmos DB.=
Resource
RetryOptions	Reprezentuje zasady ponawiania próby przydzielone przy użyciu żądań ograniczonych w usłudze bazy danych Azure Cosmos DB.
SharedOptions	Opcje, które można określić dla żądanych serwerów usługi Azure Cosmos DB.=
SpatialIndex
SqlParameter	Reprezentuje parametr w sparametryzowanym zapytaniu SQL określonym w obiekcie SqlQuerySpec
SqlQuerySpec	Reprezentuje zapytanie SQL w usłudze Azure Cosmos DB. Zapytania z danymi wejściowymi powinny być sparametryzowane w celu ochrony przed wstrzyknięciem kodu SQL. Przykład Sparametryzowane zapytanie SQL const query: SqlQuerySpec = { query: "SELECT * FROM Families f where f.lastName = @lastName", parameters: [ {name: "@lastName", value: "Wakefield"} ] };
StoredProcedureDefinition
TriggerDefinition
UniqueKey	Interfejs dla pojedynczego unikatowego klucza przekazanego w ramach elementu UniqueKeyPolicy
UniqueKeyPolicy	Interfejs do ustawiania unikatowych kluczy podczas tworzenia kontenera
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition

Aliasy typu

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic	Ten typ zawiera informacje związane z inicjowaniem CosmosClient
ClientSideRequestStatistics	Jest to typ kolekcji dla wszystkich informacji diagnostycznych po stronie klienta.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics	Ten typ zawiera informacje diagnostyczne dotyczące wszystkich żądań metadanych do serwera podczas operacji klienta usługi CosmosDB.
NonePartitionKeyType	Zwrócony obiekt reprezentuje wartość klucza partycji, która umożliwia tworzenie i uzyskiwanie dostępu do elementów bez wartości klucza partycji
NullPartitionKeyType	Zwrócony obiekt reprezentuje wartość klucza partycji, która umożliwia tworzenie i uzyskiwanie dostępu do elementów z wartością null klucza partycji.
Operation
OperationInput
OperationWithItem
PartitionKey	PartitionKey kontenera.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue	Wartość klucza partycji pierwotnej.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics	Ten typ przechwytuje informacje diagnostyczne dotyczące próby ponawiania prób podczas operacji klienta usługi CosmosDB.
TokenProvider
UpsertOperation

Wyliczenia

ConflictResolutionMode
ConnectionMode	Określa zachowanie połączenia obiektu CosmosClient. Obecnie obsługujemy tylko tryb bramy.
ConsistencyLevel	Reprezentuje poziomy spójności obsługiwane dla operacji klienta usługi Azure Cosmos DB. Żądany poziom ConsistencyLevel musi być zgodny lub słabszy niż aprowidowany dla konta bazy danych. Poziomy spójności. Poziomy spójności według kolejności siły to Silna, Powiązana opowieść, Sesja, Spójny prefiks i Ostateczna. Zobacz https://aka.ms/cosmos-consistency bardziej szczegółową dokumentację dotyczącą poziomów spójności.
CosmosDbDiagnosticLevel	Poziom diagnostyczny usługi Cosmos DB
DataType	Definiuje docelowy typ danych specyfikacji ścieżki indeksu w usłudze Azure Cosmos DB.
GeospatialType
IndexKind	Określa obsługiwane typy indeksów.
IndexingMode	Określa obsługiwane tryby indeksowania.
MetadataLookUpType	Jest to wyliczenie dla możliwego typu odnośników metadanych.
PartitionKeyDefinitionVersion	PartitionKey Definition Version
PartitionKeyKind	Typ partitionKey, tj. skrót, multiHash
PermissionMode	Wyliczenie wartości trybu uprawnień.
PriorityLevel	Reprezentuje poziom priorytetu skojarzony z poszczególnymi żądaniami klienta usługi Azure Cosmos DB. Żądania o niskim priorytcie są zawsze ograniczane przed wszelkimi żądaniami o wysokim priorytetu. Domyślnie wszystkie żądania są traktowane jako żądania o wysokim priorytcie. Zobacz https://aka.ms/CosmosDB/PriorityBasedExecution bardziej szczegółową dokumentację dotyczącą ograniczania na podstawie priorytetu.
SpatialType
TriggerOperation	Wyliczenie wartości operacji wyzwalacza. określa operacje, na których ma zostać wykonany wyzwalacz.
TriggerType	Wyliczenie wartości typów wyzwalacza. Określa typ wyzwalacza.
UserDefinedFunctionType	Wyliczenie dla wartości typu udf. Określa typy funkcji zdefiniowanych przez użytkownika.

Funkcje

createAuthorizationSasToken(string, SasTokenProperties)

Eksperymentalne wewnętrzne generuje tylko ładunek reprezentujący konfigurację uprawnień dla tokenu sas.

Szczegóły funkcji

createAuthorizationSasToken(string, SasTokenProperties)

Eksperymentalne wewnętrzne generuje tylko ładunek reprezentujący konfigurację uprawnień dla tokenu sas.

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

Parametry

masterKey

string

sasTokenProperties

SasTokenProperties

Zwraca

Promise<string>