@azure/cosmos package

Klasy

AbortError	Ten błąd jest zgłaszany, gdy operacja asynchroniczna została przerwana. Sprawdź ten błąd, testując name, 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(), aby uzyskać wystąpienie iteratora.
ChangeFeedIteratorResponse	Pojedyncza strona odpowiedzi ze zestawienia zmian usługi Azure Cosmos DB
ChangeFeedPolicy	Reprezentuje konfigurację zasad zestawienia zmian dla kontenera w usłudze Azure Cosmos DB.
ChangeFeedResponse	Pojedyncza strona odpowiedzi ze zestawienia zmian usługi Azure Cosmos DB
ChangeFeedRetentionTimeSpan
ChangeFeedStartFrom	Klasa podstawowa, w której należy uruchomić element ChangeFeedIterator.
ClientSideMetrics
Conflict	Użyj polecenia , aby odczytać lub usunąć daną konflikt według identyfikatora. Zobacz Konflikty, aby wysyłać zapytania lub odczytywać wszystkie konflikty.
ConflictResponse
Conflicts	Użyj polecenia , aby wykonywać zapytania lub odczytywać wszystkie konflikty. Zobacz Konflikt odczytywać lub usuwać dane Konflikt według identyfikatora.
Container	Operacje odczytu, zastępowania lub usuwania określonego istniejącego kontenera według identyfikatora. Zobacz Containers na potrzeby tworzenia nowych kontenerów i odczytywania/wykonywania zapytań dotyczących wszystkich kontenerów; użyj .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 podlinearnie z aplikacją. 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 podczas uruchamiania aplikacji.
ContainerResponse	Obiekt odpowiedzi dla operacji kontenera
Containers	Operacje tworzenia nowych kontenerów i odczytywania/wykonywania zapytań dotyczących wszystkich kontenerów Zobacz Container, aby uzyskać informacje na temat odczytywania, zastępowania lub usuwania istniejącego kontenera; użyj .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 podlinearnie z aplikacją. 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 podczas uruchamiania aplikacji.
CosmosClient	Udostępnia 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 Tworzenie wystąpienia klienta i tworzenie nowej bazy danych const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"}); await client.databases.create({id: "<database name here>"}); Przykład Tworzenie wystąpienia klienta przy użyciu niestandardowych zasad połączenia const client = new CosmosClient({ endpoint: "<URL HERE>", key: "<KEY HERE>", connectionPolicy: { requestTimeout: 10000, }, });
CosmosDiagnostics	Jest to typ diagnostyki usługi Cosmos, który przechowuje zebrane informacje diagnostyczne podczas operacji klienta. Ie. Item.read(), Container.create(). Ma trzech członków - element członkowski clientSideRequestStatistics 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, statystyki ładunku odpowiedzi. gatewayStatistics — informacje odpowiadające głównej operacji. Na przykład podczas item.read() klient może wykonywać wiele operacji, np. wyszukiwanie metadanych itp., ale gatewayStatistics reprezentuje informacje diagnostyczne dotyczące rzeczywistej operacji odczytu. diagnosticNode — to struktura podobna 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 węźle diagnostycznym jest kontrolowany przez CosmosDbDiagnosticLevel. CosmosDbDiagnosticLevel.info — jest wartością domyślną. Na tym poziomie przechwytywane są tylko elementy clientSideRequestStatistics. Jest przeznaczony dla środowisk produkcyjnych. CosmosDbDiagnosticLevel.debug — przechwytuje węzeł diagnosticNode i clientConfig. Nie są przechwytywane ładunki żądań i odpowiedzi. Nie jest przeznaczony do użycia w środowisku produkcyjnym. CosmosDbDiagnosticLevel.debug-niebezpieczne — oprócz danych przechwyconych w pliku CosmosDbDiagnosticLevel.debug również przechwytuje ładunki żądań i odpowiedzi. Nie jest przeznaczony do użycia w środowisku produkcyjnym. clientConfig — przechwytuje informacje dotyczące sposobu konfigurowania klienta podczas inicjowania.
Database	Operacje odczytu lub usuwania istniejącej bazy danych. Zobacz Databases na potrzeby tworzenia nowych baz danych oraz odczytywania/wykonywania zapytań dotyczących wszystkich baz danych; użyj 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 podlinearnie z aplikacją. 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 raz podczas uruchamiania 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ń dotyczących wszystkich baz danych Aby odczytywać lub usuwać istniejącą bazę danych, zobacz Database; użyj 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 podlinearnie z aplikacją. 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 raz podczas uruchamiania 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 Items, aby uzyskać informacje o operacjach na wszystkich elementach; zobacz container.items.
ItemResponse
Items	Operacje tworzenia nowych elementów i odczytywania/wykonywania zapytań dotyczących wszystkich elementów Zobacz Item w celu odczytywania, zastępowania lub usuwania istniejącego kontenera; użyj .item(id).
Offer	Użyj polecenia , aby odczytać lub zamienić istniejącą ofertę według identyfikatora. Zobacz Oferty do wykonywania zapytań lub odczytywania wszystkich ofert.
OfferResponse
Offers	Użyj polecenia , aby wykonywać zapytania o wszystkie oferty lub odczytywać je. Zobacz Oferta, aby odczytać lub zamienić istniejącą ofertę według identyfikatora.
PartitionKeyBuilder	Klasa konstruktora do kompilowania partitionkey.
Permission	Służy do odczytywania, zastępowania lub usuwania danego uprawnienia według identyfikatora. Zobacz Uprawnienia, aby utworzyć, upsert, zapytanie lub odczytać wszystkie uprawnienia.
PermissionResponse
Permissions	Służy do tworzenia, zastępowania, wykonywania zapytań i odczytywania wszystkich uprawnień. Zobacz uprawnienia 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 iterowanie 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. Operacje 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 . Użyj container.triggers, aby utworzyć, upsert, zapytanie lub odczytać wszystko.
TriggerResponse
Triggers	Operacje tworzenia, upsert, wykonywania zapytań i odczytywania wszystkich wyzwalaczy. Użyj container.triggers, aby odczytywać, zastępować lub usuwać wyzwalacz .
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 user.permission i user.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, wykonywania zapytań lub odczytywania wszystkich funkcji zdefiniowanych przez użytkownika. Zobacz UserDefinedFunction 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 odczytywać, zastępować lub usuwać 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 SPOWODUJE TO DOMYŚLNIE 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: kontynuacja startTime startFromBeginning Jeśli żadna z tych opcji nie zostanie ustawiona, rozpocznie odczytywanie zmian z pierwszego wywołania ChangeFeedIterator.fetchNext().
ChangeFeedPullModelIterator	Użyj Items.getChangeFeedIterator(), aby zwrócić iterator, który może iterować wszystkie zmiany klucza partycji, zakresu kanału informacyjnego lub całego kontenera.
CompositePath	Reprezentuje ścieżkę złożoną w zasadach indeksowania.
ComputedProperty
ConflictDefinition
ConflictResolutionPolicy	Reprezentuje konfigurację zasad rozwiązywania konfliktów w celu określenia 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 Item 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 do serwera.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions	Opcje, które można określić dla żądanego wystawionego dla serwerów usługi Azure Cosmos DB.=
Resource
RetryOptions	Reprezentuje zasady ponawiania prób alokowane z żądaniami ograniczonymi w usłudze bazy danych Azure Cosmos DB.
SharedOptions	Opcje, które można określić dla żądanego wystawionego dla serwerów usługi Azure Cosmos DB.=
SpatialIndex
SqlParameter	Reprezentuje parametr w sparametryzowanym zapytaniu SQL określonym w 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 pojedynczego unikatowego klucza przekazanego w ramach funkcji UniqueKeyPolicy
UniqueKeyPolicy	Interfejs ustawiania unikatowych kluczy podczas tworzenia kontenera
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition
VectorEmbedding	Reprezentuje osadzanie wektorów. Osadzanie wektorów służy do definiowania pola wektorowego w dokumentach.
VectorEmbeddingPolicy	Reprezentuje konfigurację zasad osadzania wektorów w usłudze Azure Cosmos DB.
VectorIndex	Reprezentuje indeks wektora w usłudze Azure Cosmos DB. Indeks wektorowy służy do indeksowania pól wektorów w dokumentach.

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 dla 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 ponawiania prób podczas operacji klienta usługi CosmosDB.
TokenProvider
UpsertOperation

Wyliczenia

ChangeFeedMode
ConflictResolutionMode
ConnectionMode	Określa zachowanie połączenia obiektu CosmosClient. Uwaga: 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ż aprowizowany 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. Aby uzyskać bardziej szczegółową dokumentację dotyczącą poziomów spójności, zobacz https://aka.ms/cosmos-consistency.
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 żądaniami o wysokim priorytcie. Domyślnie wszystkie żądania są traktowane jako żądania o wysokim priorytcie. Aby uzyskać bardziej szczegółową dokumentację dotyczącą ograniczania na podstawie priorytetów, zobacz https://aka.ms/CosmosDB/PriorityBasedExecution.
SpatialType
TriggerOperation	Wyliczenie wartości operacji wyzwalacza. określa operacje, na których ma zostać wykonany wyzwalacz.
TriggerType	Wyliczenie dla wartości typu wyzwalacza. Określa typ wyzwalacza.
UserDefinedFunctionType	Wyliczenie dla wartości typu udf. Określa typy funkcji zdefiniowanych przez użytkownika.
VectorEmbeddingDataType	Reprezentuje typ danych wektora.
VectorEmbeddingDistanceFunction	Reprezentuje funkcję odległości, która ma być używana do obliczania odległości między wektorami.
VectorIndexType	Reprezentuje typ indeksu wektora.

Funkcje

createAuthorizationSasToken(string, SasTokenProperties)

Eksperymentalna funkcja wewnętrzna generuje tylko ładunek reprezentujący konfigurację uprawnień dla tokenu sas.

Szczegóły funkcji

createAuthorizationSasToken(string, SasTokenProperties)

Eksperymentalna funkcja wewnętrzna 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>