Sdílet prostřednictvím

@azure/cosmos package

  • Reference

Třídy

AbortError

Tato chyba se vyvolá, když byla přerušena asynchronní operace. Zkontrolujte tuto chybu tím, že otestujete name, že vlastnost názvu chyby odpovídá "AbortError".

Příklad

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

Poskytuje iterátor pro kanál změn.

K získání instance iterátoru použijte Items.changeFeed().
ChangeFeedIteratorResponse

Jedna stránka odpovědi z kanálu změn služby Azure Cosmos DB
ChangeFeedPolicy

Představuje konfiguraci zásad kanálu změn pro kontejner ve službě Azure Cosmos DB.
ChangeFeedResponse

Jedna stránka odpovědi z kanálu změn služby Azure Cosmos DB
ChangeFeedRetentionTimeSpan
ChangeFeedStartFrom

Základní třída, kde spustit ChangeFeedIterator.
ClientSideMetrics
Conflict

Slouží ke čtení nebo odstranění daného Konflikt podle ID.

Viz Konflikty dotazování nebo čtení všech konfliktů.
ConflictResponse
Conflicts

Slouží k dotazování nebo čtení všech konfliktů.

Viz Konflikt ke čtení nebo odstranění daného Konflikt podle ID.
Container

Operace čtení, nahrazení nebo odstranění konkrétního existujícího kontejneru podle ID

Viz Kontejnery pro vytváření nových kontejnerů a čtení a dotazování všech kontejnerů; použít .containers.

Poznámka: Všechny tyto operace vyžadují pevné rozpočty. Systém byste měli navrhnout tak, aby tato volání škálovat podlineárně s vaší aplikací. Například nevolejte container(id).read() před každým voláním item.read(), aby se zajistilo, že kontejner existuje; proveďte to jednou při spuštění aplikace.
ContainerResponse

Objekt odpovědi pro operace kontejneru
Containers

Operace pro vytváření nových kontejnerů a čtení /dotazování všech kontejnerů

Informace o čtení, nahrazení nebo odstranění existujícího kontejneru najdete v kontejneru. použít .container(id).

Poznámka: Všechny tyto operace vyžadují pevné rozpočty. Systém byste měli navrhnout tak, aby tato volání škálovat podlineárně s vaší aplikací. Například nevolejte containers.readAll() před každým voláním item.read(), aby se zajistilo, že kontejner existuje; proveďte to jednou při spuštění aplikace.
CosmosClient

Poskytuje logickou reprezentaci účtu databáze Azure Cosmos DB na straně klienta. Tento klient se používá ke konfiguraci a spouštění požadavků v databázové službě Azure Cosmos DB.

Příklad

Vytvoření instance klienta a vytvoření nové databáze

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

Příklad

Vytvoření instance klienta pomocí vlastních zásad připojení

const client = new CosmosClient({
   endpoint: "<URL HERE>",
   key: "<KEY HERE>",
   connectionPolicy: {
    requestTimeout: 10000,
   },
});
CosmosDiagnostics
  • Toto je typ diagnostiky Cosmos, který uchovává shromážděné diagnostické informace během klientských operací. Ie. Item.read(), Container.create(). Má tři členy -
  1. clientSideRequestStatistics člen obsahuje agregované diagnostické informace, včetně
  • vyhledávání metadat. Všechny požadavky na server jsou kromě konečného zamýšleného prostředku považovány za volání metadat. Tj. pro item.read(id), pokud klient volá server ke zjišťování koncových bodů, považuje se za volání metadat.
  • opětovné pokusy
  • kontaktovali se koncové body.
  • request, response payload stats.
  • gatewayStatistics – informace odpovídající hlavní operaci Například během Item.read() může klient provádět mnoho operací, tj. vyhledávání metadat atd., ale gatewayStatistics představuje diagnostické informace pro skutečnou operaci čtení.
  1. diagnosticNode – je strom jako struktura, která zachycuje podrobné diagnostické informace. Ve výchozím nastavení je zakázaná a má být použita pouze pro ladění v neprodukčním prostředí. Druh podrobností zachycených v diagnostickém uzlu je řízen CosmosDbDiagnosticLevel.
  • CosmosDbDiagnosticLevel.info – je výchozí hodnota. V této úrovni jsou zaznamenány pouze clientSideRequestStatistics. Je určená pro produkční prostředí.
  • CosmosDbDiagnosticLevel.debug – Zachytává diagnosticNode a clientConfig. Nejsou zachyceny žádné datové části požadavků a odpovědí. Není určená k použití v produkčním prostředí.
  • CosmosDbDiagnosticLevel.debug-unsafe – Kromě dat zachycených ve službě CosmosDbDiagnosticLevel.debug také zaznamenává datové části požadavků a odpovědí. Není určená k použití v produkčním prostředí.
  1. clientConfig – Zaznamenává informace týkající se konfigurace klienta během inicializace.
Database

Operace čtení nebo odstranění existující databáze

Viz Databáze pro vytváření nových databází a čtení a dotazování všech databází; použít client.databases.

Poznámka: Všechny tyto operace vyžadují pevné rozpočty. Systém byste měli navrhnout tak, aby tato volání škálovat podlineárně s vaší aplikací. Například nevolejte database.read() před každým voláním item.read(), aby se zajistilo, že databáze existuje; proveďte to jednou při spuštění aplikace.
DatabaseAccount

Představuje účet DatabaseAccount v databázové službě Azure Cosmos DB.
DatabaseResponse

Objekt odpovědi pro databázové operace
Databases

Operace pro vytváření nových databází a čtení a dotazování všech databází

Informace o čtení nebo odstranění existující databáze najdete v tématu Databáze; použít client.database(id).

Poznámka: Všechny tyto operace vyžadují pevné rozpočty. Systém byste měli navrhnout tak, aby tato volání škálovat podlineárně s vaší aplikací. Například nevolejte databases.readAll() před každým voláním item.read(), aby se zajistilo, že databáze existuje; proveďte to jednou při spuštění aplikace.
ErrorResponse
FeedRange

Určuje rozsah informačního kanálu pro kanál změn.
FeedResponse
Item

Slouží k provádění operací s konkrétní položkou.

Operace se všemi položkami najdete v tématu Položky; viz container.items.
ItemResponse
Items

Operace pro vytváření nových položek a čtení a dotazování všech položek

Viz Položka pro čtení, nahrazení nebo odstranění existujícího kontejneru; použít .item(id).
Offer

Slouží ke čtení nebo nahrazení existující nabídky podle ID.

Podívejte se na Nabídky dotazování nebo čtení všech nabídek.
OfferResponse
Offers

Slouží k dotazování nebo čtení všech nabídek.

Pokud chcete přečíst nebo nahradit existující nabídku ID, přečtěte si nabídky.
PartitionKeyBuilder

Třída Builderu pro sestavení PartitionKey.
Permission

Slouží ke čtení, nahrazení nebo odstranění daného oprávnění podle ID.

Viz Oprávnění vytvářet, upsertovat, dotazovat nebo číst všechna oprávnění.
PermissionResponse
Permissions

Slouží k vytváření, nahrazování, dotazování a čtení všech oprávnění.

Viz Oprávnění ke čtení, nahrazení nebo odstranění konkrétního oprávnění podle ID.
QueryIterator

Představuje objekt QueryIterator, implementaci informačního kanálu nebo odpovědi dotazu, která umožňuje procházení a iteraci odpovědi v databázové službě Azure Cosmos DB.
QueryMetrics
QueryPreparationTimes
ResourceResponse
RestError

Vlastní typ chyby pro neúspěšné požadavky kanálu.
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure

Operace pro čtení, nahrazení, odstranění nebo spuštění konkrétní existující uložené procedury podle ID

Operace pro vytvoření, čtení všech uložených procedur nebo dotazování
StoredProcedureResponse
StoredProcedures

Operace pro vytváření, upsertování nebo čtení /dotazování všech uložených procedur.

Operace čtení, nahrazení, odstranění nebo spuštění konkrétní, existující uložené procedury podle ID naleznete v tématu container.storedProcedure().
TimeoutError
Trigger

Operace čtení, nahrazení nebo odstranění triggeru.

Pomocí container.triggers můžete vytvářet, upsertovat, dotazovat nebo číst vše.
TriggerResponse
Triggers

Operace pro vytváření, upsertování, dotazování a čtení všech triggerů

Pomocí můžete číst, nahrazovat nebo odstraňovattriggeru .
User

Slouží ke čtení, nahrazení a odstraňování uživatelů.

Kromě toho můžete přistupovat k oprávněním daného uživatele prostřednictvím user.permission a user.permissions.

Viz Uživatelé vytvářet, upsertovat, dotazovat nebo číst vše.
UserDefinedFunction

Slouží ke čtení, nahrazení nebo odstranění zadané funkce Uživatele Definied Function by ID.

Viz UserDefinedFunction vytvoření, upsert, dotaz, čtení všech uživatelem definovaných funkcí.
UserDefinedFunctionResponse
UserDefinedFunctions

Slouží k vytváření, upsertování, dotazování nebo čtení všech uživatelem definovaných funkcí.

Viz UserDefinedFunction ke čtení, nahrazení nebo odstranění dané uživatelem definované funkce podle ID.
UserResponse
Users

Slouží k vytváření, upsertování, dotazování a čtení všech uživatelů.

Informace o přečtení, nahrazení nebo odstranění konkrétního uživatele podle ID najdete v tématu Uživatel.

Rozhraní

@azure/cosmos.Index
Agent
BulkOptions

Objekt Options použitý k úpravě hromadného spuštění continueOnError (výchozí hodnota: false) – pokračuje hromadným spuštěním, pokud operace selže ** POZNÁMKA: VÝCHOZÍ HODNOTA JE PRAVDA VE VERZI 4.0.
ChangeFeedIteratorOptions

Určuje možnosti kanálu změn.

Pokud žádná z těchto možností není nastavená, začne se odteď číst změny pro celý kontejner.
ChangeFeedOptions

Určuje možnosti kanálu změn.

Některé z těchto možností určují, kde a kdy začít číst z kanálu změn. Pořadí priorit je:

  • pokračování
  • startTime
  • startFromBeginning

Pokud není žádná z těchto možností nastavená, začne číst změny z prvního ChangeFeedIterator.fetchNext() volání.
ChangeFeedPullModelIterator

Pomocí Items.getChangeFeedIterator() můžete vrátit iterátor, který může iterovat všechny změny klíče oddílu, rozsahu informačních kanálů nebo celého kontejneru.
CompositePath

Představuje složenou cestu v zásadách indexování.
ComputedProperty
ConflictDefinition
ConflictResolutionPolicy

Představuje konfiguraci zásad řešení konfliktů pro určení způsobu řešení konfliktů v případě, že zápisy z různých oblastí vedou ke konfliktům dokumentů v kolekci ve službě Azure Cosmos DB.
ConnectionPolicy

Představuje zásady připojení přidružené ke službě CosmosClient v databázové službě Azure Cosmos DB.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode

Představuje strom jako strukturu pro zachycení diagnostických informací.
ErrorBody
FailedRequestAttemptDiagnostic

Tento typ zaznamenává diagnostické informace týkající se neúspěšného požadavku na serverové rozhraní API.
FeedOptions

Možnosti informačního kanálu a metody dotazů.
FullTextIndex

Představuje fulltextový index v zásadách indexování.
FullTextPath

Představuje úplnou textovou cestu, která se má indexovat ve službě Azure Cosmos DB.
FullTextPolicy

Představuje zásady fulltextu pro kolekci ve službě Azure Cosmos DB.
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition

Položky ve službě Cosmos DB jsou jednoduše objekty JSON. Většina operací Item umožňuje zadat vlastní typ, který rozšiřuje velmi jednoduchou definici ItemDefinition.

Nemůžete použít žádné rezervované klíče. Seznam rezervovaných klíčů najdete v <xref:ItemBody>
JSONArray
JSONObject
Location

Slouží k určení dostupných umístění, čtení je index 1 a zápis je index 0.
MetadataLookUpDiagnostic

Tento typ obsahuje diagnostické informace týkající se jednoho požadavku na metadata na server.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions

Možnosti, které lze zadat pro požadované vydané servery Azure Cosmos DB.=
Resource
RetryOptions

Představuje zásadu opakování, která se přiděluje omezenými požadavky v databázové službě Azure Cosmos DB.
SharedOptions

Možnosti, které lze zadat pro požadované vydané servery Azure Cosmos DB.=
SpatialIndex
SqlParameter

Představuje parametr v parametrizovaném dotazu SQL zadaném v sqlQuerySpec
SqlQuerySpec

Představuje dotaz SQL ve službě Azure Cosmos DB.

Dotazy se vstupy by měly být parametrizovány pro ochranu před injektáží SQL.

Příklad

Parametrizovaný dotaz SQL

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

Rozhraní pro jeden jedinečný klíč předaný jako součást UniqueKeyPolicy
UniqueKeyPolicy

Rozhraní pro nastavení jedinečných klíčů při vytváření kontejneru
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition
VectorEmbedding

Představuje vektorové vkládání. Vektorové vkládání se používá k definování vektorového pole v dokumentech.
VectorEmbeddingPolicy

Představuje konfiguraci zásad pro vektorové vkládání ve službě Azure Cosmos DB.
VectorIndex

Představuje vektorový index ve službě Azure Cosmos DB. Vektorový index se používá k indexování vektorových polí v dokumentech.

Aliasy typu

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic

Tento typ obsahuje informace související s inicializací CosmosClient
ClientSideRequestStatistics

Toto je typ kolekce pro všechny diagnostické informace na straně klienta.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics

Tento typ obsahuje diagnostické informace týkající se všech požadavků na metadata na server během operace klienta CosmosDB.
NonePartitionKeyType

Vrácený objekt představuje hodnotu klíče oddílu, která umožňuje vytváření a přístup k položkám bez hodnoty klíče oddílu.
NullPartitionKeyType

Vrácený objekt představuje hodnotu klíče oddílu, která umožňuje vytváření a přístup k položkám s hodnotou null pro klíč oddílu.
Operation
OperationInput
OperationWithItem
PartitionKey

PartitionKey kontejneru.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue

Primitivní hodnota klíče oddílu.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics

Tento typ zaznamenává diagnostické informace týkající se pokusů o opakování během operace klienta Cosmos DB.
TokenProvider
UpsertOperation

Výčty

ChangeFeedMode
ConflictResolutionMode
ConnectionMode

Určuje chování připojení CosmosClient. Upozorňujeme, že aktuálně podporujeme pouze režim brány.
ConsistencyLevel

Představuje úrovně konzistence podporované pro klientské operace Azure Cosmos DB.
Požadovaná úroveň konzistence se musí shodovat nebo musí být slabší než hodnota zřízená pro databázový účet. Úrovně konzistence.

Úrovně konzistence podle pořadí síly jsou Strong, BoundedStaleness, Session, Consistent Prefix a Eventual.

Podrobnější dokumentaci k úrovním konzistence najdete v https://aka.ms/cosmos-consistency.
CosmosDbDiagnosticLevel

Úroveň diagnostiky služby Cosmos DB
DataType

Definuje cílový datový typ specifikace cesty indexu ve službě Azure Cosmos DB.
GeospatialType
IndexKind

Určuje podporované typy indexů.
IndexingMode

Určuje podporované režimy indexování.
MetadataLookUpType

Toto je výčet pro možný typ vyhledávání metadat.
PartitionKeyDefinitionVersion

Verze definice PartitionKey
PartitionKeyKind

Typ PartitionKey, tj. Hash, MultiHash
PermissionMode

Výčet hodnot režimu oprávnění.
PriorityLevel

Představuje úroveň priority přidruženou k jednotlivým požadavkům klientů služby Azure Cosmos DB.
Požadavky s nízkou prioritou se vždy omezují před všemi požadavky s vysokou prioritou.

Ve výchozím nastavení se všechny požadavky považují za požadavky s vysokou prioritou.

Podrobnější dokumentaci k omezování na základě priority najdete v https://aka.ms/CosmosDB/PriorityBasedExecution.
SpatialType
TriggerOperation

Výčt pro hodnoty operací triggeru určuje operace, na kterých se má aktivační událost spustit.
TriggerType

Výčet pro hodnoty typu triggeru Určuje typ triggeru.
UserDefinedFunctionType

Výčet pro hodnoty typu udf Určuje typy uživatelem definovaných funkcí.
VectorEmbeddingDataType

Představuje datový typ vektoru.
VectorEmbeddingDistanceFunction

Představuje funkci vzdálenosti, která se má použít pro výpočet vzdálenosti mezi vektory.
VectorIndexType

Představuje typ indexu vektoru.

Funkce

createAuthorizationSasToken(string, SasTokenProperties)

Experimentální interní pouze vygeneruje datovou část představující konfiguraci oprávnění pro token SAS.

Podrobnosti funkce

createAuthorizationSasToken(string, SasTokenProperties)

Experimentální interní pouze vygeneruje datovou část představující konfiguraci oprávnění pro token SAS.

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

Parametry

masterKey

string

sasTokenProperties
SasTokenProperties

Návraty

Promise<string>