@azure/cosmos package

Osztályok

AbortError	Ez a hiba akkor jelenik meg, ha egy aszinkron műveletet megszakítottak. Ezt a hibát a hiba name tesztelésével ellenőrizheti, hogy a hiba névtulajdonsága megegyezik "AbortError". példa const controller = new AbortController(); controller.abort(); try { doAsyncWork(controller.signal) } catch (e) { if (e.name === 'AbortError') { // handle abort error here. } }
ChangeFeedIterator	Iterátort biztosít a változáscsatorna számára. Az Items.changeFeed() használatával kérje le az iterátor egy példányát.
ChangeFeedIteratorResponse	Egyetlen válaszlap az Azure Cosmos DB változáscsatornájából
ChangeFeedPolicy	Az Azure Cosmos DB szolgáltatásban lévő tároló változáscsatorna-szabályzatkonfigurációját jelöli.
ChangeFeedResponse	Egyetlen válaszlap az Azure Cosmos DB változáscsatornájából
ChangeFeedRetentionTimeSpan
ChangeFeedStartFrom	Alaposztály a ChangeFeedIterator indításához.
ClientSideMetrics
Conflict	Egy adott ütközési olvasására vagy törlésére használható azonosító alapján. Lásd: Ütközések az összes ütközés lekérdezéséhez vagy olvasásához.
ConflictResponse
Conflicts	Az összes ütközés lekérdezésére vagy olvasására használható. Egy adott ütközési azonosító alapján történő olvasásához vagy törléséhez tekintse meg az ütközési című témakört.
Container	Adott, meglévő tárolók beolvasására, cseréjére vagy törlésére szolgáló műveletek azonosító alapján. Lásd: Tárolók új tárolók létrehozásához és az összes tároló olvasásához/lekérdezéséhez; .containershasználata. Megjegyzés: ezek a műveletek rögzített költségvetéssel kapcsolatos hívásokat hajtanak végre. Úgy kell megterveznie a rendszert, hogy ezek a hívások az alkalmazással együtt alkonyatosan skálázhatók legyenek. Például ne hívjon container(id).read() minden egyes item.read() hívás előtt, hogy a tároló létezik-e; ezt egyszer kell elvégeznie az alkalmazás indításakor.
ContainerResponse	Tárolóműveletek válaszobjektuma
Containers	Új tárolók létrehozására és az összes tároló olvasására/lekérdezésére szolgáló műveletek Meglévő tároló olvasásával, cseréjével vagy törlésével kapcsolatban lásd: Tároló; .container(id)használata. Megjegyzés: ezek a műveletek rögzített költségvetéssel kapcsolatos hívásokat hajtanak végre. Úgy kell megterveznie a rendszert, hogy ezek a hívások az alkalmazással együtt alkonyatosan skálázhatók legyenek. Például ne hívjon containers.readAll() minden egyes item.read() hívás előtt, hogy a tároló létezik-e; ezt egyszer kell elvégeznie az alkalmazás indításakor.
CosmosClient	Az Azure Cosmos DB-adatbázisfiók ügyféloldali logikai ábrázolását biztosítja. Ez az ügyfél a kérések konfigurálására és végrehajtására szolgál az Azure Cosmos DB adatbázis-szolgáltatásban. példa Ügyfél példányosítása és új adatbázis létrehozása const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"}); await client.databases.create({id: "<database name here>"}); példa Ügyfél példányosítása egyéni kapcsolati házirenddel const client = new CosmosClient({ endpoint: "<URL HERE>", key: "<KEY HERE>", connectionPolicy: { requestTimeout: 10000, }, });
CosmosDiagnostics	Ez egy Cosmos Diagnosztikai típus, amely az ügyfélműveletek során gyűjtött diagnosztikai adatokat tárolja. Ie. Item.read(), Container.create(). Három tagból áll: clientSideRequestStatistics tag összesített diagnosztikai adatokat tartalmaz, beleértve a következőket: metaadat-keresések. Itt a végső tervezett erőforráson kívül az összes kiszolgálókérés metaadat-hívásnak minősül. Például az item.read(id) esetében, ha az ügyfél kiszolgálói hívást kezdeményez a végpontok felderítésére, az metaadat-hívásnak minősül. Próbálkozás a kapcsolattal kapcsolatba lépő végpontok. kérelem, válasz hasznos adatstatisztikái. gatewayStatistics – A fő műveletnek megfelelő információk. Például az Item.read() során az ügyfél számos műveletet hajthat végre, például metaadatok keresését stb., de a gatewayStatistics a tényleges olvasási művelet diagnosztikai adatait jelöli. diagnosticNode – Olyan fa, mint a struktúra, amely részletes diagnosztikai információkat rögzít. Alapértelmezés szerint le van tiltva, és csak nem éles környezetekben történő hibakereséshez használható. A diagnosticNode-ban rögzített adatok típusait a CosmosDbDiagnosticLevelvezérli. CosmosDbDiagnosticLevel.info – Az alapértelmezett érték. Ezen a szinten csak a clientSideRequestStatistics lesz rögzítve. Éles környezetekhez készült. CosmosDbDiagnosticLevel.debug – Rögzíti a diagnosticNode és a clientConfig fájlt. A rendszer nem rögzíti a kérések és válaszok hasznos adatait. Éles környezetben nem használható. CosmosDbDiagnosticLevel.debug-unsafe – A CosmosDbDiagnosticLevel.debugban rögzített adatok mellett a kérelmek és válaszok hasznos adatait is rögzíti. Éles környezetben nem használható. clientConfig – Az ügyfél inicializálás során konfigurálásának módjával kapcsolatos információkat rögzíti.
Database	Meglévő adatbázis olvasására vagy törlésére szolgáló műveletek. Lásd: Adatbázisok új adatbázisok létrehozásához és az összes adatbázis olvasásához/lekérdezéséhez; client.databaseshasználata. Megjegyzés: ezek a műveletek rögzített költségvetéssel kapcsolatos hívásokat hajtanak végre. Úgy kell megterveznie a rendszert, hogy ezek a hívások az alkalmazással együtt alkonyatosan skálázhatók legyenek. Például ne hívjon database.read() minden egyes item.read() hívás előtt, hogy meggyőződjön arról, hogy az adatbázis létezik; ezt egyszer kell elvégeznie az alkalmazás indításakor.
DatabaseAccount	DatabaseAccount értéket jelöl az Azure Cosmos DB adatbázis-szolgáltatásban.
DatabaseResponse	Válaszobjektum adatbázis-műveletekhez
Databases	Új adatbázisok létrehozására és az összes adatbázis olvasására/lekérdezésére szolgáló műveletek A meglévő adatbázisok olvasásával vagy törlésével kapcsolatban lásd: Adatbázis; client.database(id)használata. Megjegyzés: ezek a műveletek rögzített költségvetéssel kapcsolatos hívásokat hajtanak végre. Úgy kell megterveznie a rendszert, hogy ezek a hívások az alkalmazással együtt alkonyatosan skálázhatók legyenek. Például ne hívjon databases.readAll() minden egyes item.read() hívás előtt, hogy meggyőződjön arról, hogy az adatbázis létezik; ezt egyszer kell elvégeznie az alkalmazás indításakor.
ErrorResponse
FeedRange	Megadja a változáscsatorna adatcsatornájának tartományát.
FeedResponse
Item	Műveletek végrehajtására szolgál egy adott elemen. Az Elemek az összes elemen végzett műveletekhez; lásd: container.items.
ItemResponse
Items	Új elemek létrehozására és az összes elem olvasására/lekérdezésére szolgáló műveletek A meglévő tárolók olvasásához, cseréjéhez vagy törléséhez tekintse meg elem; .item(id)használata.
Offer	Meglévő Ajánlat azonosító alapján történő olvasására vagy cseréjére használható. Tekintse meg Ajánlatok az összes ajánlat lekérdezéséhez vagy olvasásához.
OfferResponse
Offers	Az összes ajánlat lekérdezésére vagy olvasására használható. Tekintse meg Ajánlat egy meglévő Ajánlat azonosító alapján történő olvasásához vagy cseréjéhez.
PartitionKeyBuilder	Builder-osztály a PartitionKey létrehozásához.
Permission	Egy adott engedély olvasására, cseréjére vagy törlésére használható, azonosító alapján. Tekintse meg Engedélyek az összes engedély létrehozásához, frissítéséhez, lekérdezéséhez vagy olvasásához.
PermissionResponse
Permissions	Az összes engedély létrehozásához, cseréjéhez, lekérdezéséhez és olvasásához használható. Lásd: Engedély egy adott engedély beolvasásához, cseréjéhez vagy törléséhez azonosító alapján.
QueryIterator	Egy QueryIterator-objektumot jelöl, amely a hírcsatorna vagy lekérdezési válasz implementációja, amely lehetővé teszi a válasz bejárását és iterálását az Azure Cosmos DB adatbázis-szolgáltatásban.
QueryMetrics
QueryPreparationTimes
ResourceResponse
RestError	A sikertelen folyamatkérések egyéni hibatípusa.
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure	Adott, meglévő tárolt eljárás azonosító szerinti olvasására, cseréjére, törlésére vagy végrehajtására szolgáló műveletek. Tárolt eljárások létrehozásához, olvasásához vagy lekérdezéséhez
StoredProcedureResponse
StoredProcedures	Műveletek az összes tárolt eljárás létrehozására, frissítésére vagy olvasására/lekérdezésére. Ha egy adott, meglévő tárolt eljárást szeretne beolvasni, lecserélni, törölni vagy végrehajtani, tekintse meg a container.storedProcedure().
TimeoutError
Trigger	triggerolvasására, cseréjére vagy törlésére szolgáló műveletek. Az container.triggers használatával létrehozhatja, módosíthatja, lekérdezheti vagy elolvashatja az összeset.
TriggerResponse
Triggers	Műveletek az összes eseményindító létrehozásához, frissítéséhez, lekérdezéséhez és olvasásához. container.triggers használata triggerolvasásához, cseréjéhez vagy törléséhez.
User	Felhasználók olvasására, cseréjére és törlésére szolgál. Emellett az adott felhasználó engedélyeit user.permission és user.permissionskeresztül is elérheti. Lásd Felhasználók az összes létrehozásához, frissítéséhez, lekérdezéséhez vagy olvasásához.
UserDefinedFunction	Egy megadott felhasználói definied függvény beolvasására, cseréjére vagy törlésére szolgál azonosító alapján. Lásd: UserDefinedFunction az összes felhasználó által definiált függvény létrehozásához, frissítéséhez, lekérdezéséhez és olvasásához.
UserDefinedFunctionResponse
UserDefinedFunctions	Az összes felhasználó által definiált függvény létrehozásához, frissítéséhez, lekérdezéséhez vagy olvasásához használható. Lásd: UserDefinedFunction egy adott felhasználó által definiált függvény beolvasásához, cseréjéhez vagy törléséhez azonosító alapján.
UserResponse
Users	Az összes felhasználó létrehozásához, frissítéséhez, lekérdezéséhez és olvasásához használható. Lásd: Felhasználó egy adott felhasználó azonosító alapján történő olvasásához, cseréjéhez vagy törléséhez.

Interfészek

@azure/cosmos.Index

Agent
BulkOptions	A tömeges végrehajtás módosításához használt beállításobjektum. continueOnError (Alapértelmezett érték: hamis) – Folytatja a tömeges végrehajtást, ha egy művelet meghiúsul ** MEGJEGYZÉS: EZ ALAPÉRTELMEZÉS SZERINT IGAZ LESZ a 4.0-s KIADÁSBAN
ChangeFeedIteratorOptions	A változáscsatorna beállításainak megadása Ha egyik beállítás sincs beállítva, mostantól a teljes tároló módosításait fogja olvasni.
ChangeFeedOptions	A változáscsatorna beállításainak megadása Néhány beállítás azt határozza meg, hogy hol és mikor kezdjen el olvasni a változáscsatornából. Az elsőbbségi sorrend a következő: folytatás startTime startFromBeginning Ha egyik beállítás sincs beállítva, az első ChangeFeedIterator.fetchNext() hívás módosításait fogja olvasni.
ChangeFeedPullModelIterator	A Items.getChangeFeedIterator() használatával olyan iterátort adhat vissza, amely át tudja iterálni a partíciókulcs, az adatcsatornatartomány vagy egy teljes tároló összes módosítását.
CompositePath	Összetett elérési utat jelöl az indexelési házirendben.
ComputedProperty
ConflictDefinition
ConflictResolutionPolicy	Az ütközésfeloldási szabályzat konfigurációját jelöli, amely meghatározza, hogyan oldható fel az ütközés, ha a különböző régiókból történő írások ütközéseket eredményeznek az Azure Cosmos DB szolgáltatás gyűjteményében lévő dokumentumokon.
ConnectionPolicy	A CosmosClienthez társított kapcsolati szabályzatot jelöli az Azure Cosmos DB adatbázis-szolgáltatásban.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode	A diagnosztikai információk rögzítésére szolgáló faszerkezetet jelöl.
ErrorBody
FailedRequestAttemptDiagnostic	Ez a típus rögzíti a kiszolgálói API-nak küldött sikertelen kérés diagnosztikai adatait.
FeedOptions	A hírcsatorna beállításai és a lekérdezési módszerek.
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition	A Cosmos DB elemei egyszerűen JSON-objektumok. Az Elem műveletek többsége lehetővé teszi, hogy saját típust adjon meg, amely kibővíti a nagyon egyszerű ItemDefinitiont. Nem használhat fenntartott kulcsokat. A fenntartott kulcsok listája <xref:ItemBody>
JSONArray
JSONObject
Location	A rendelkezésre álló helyek megadására szolgál, az olvasás az 1. index, az írás pedig a 0. index.
MetadataLookUpDiagnostic	Ez a típus diagnosztikai adatokat tartalmaz a kiszolgálónak küldött egyetlen metaadat-kéréssel kapcsolatban.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions	Az Azure Cosmos DB-kiszolgálóknak kiadott kért szolgáltatásokhoz megadható beállítások.=
Resource
RetryOptions	Az Újrapróbálkozási szabályzatot jelöli az Azure Cosmos DB adatbázis-szolgáltatás szabályozott kéréseivel asszociált módon.
SharedOptions	Az Azure Cosmos DB-kiszolgálóknak kiadott kért szolgáltatásokhoz megadható beállítások.=
SpatialIndex
SqlParameter	Paramétert jelöl egy paraméteres SQL-lekérdezésben, amely SqlQuerySpec
SqlQuerySpec	SQL-lekérdezést jelöl az Azure Cosmos DB szolgáltatásban. Az SQL-injektálással szembeni védelem érdekében paraméteresen kell megadni a bemeneteket tartalmazó lekérdezéseket. példa Paraméteres SQL-lekérdezés const query: SqlQuerySpec = { query: "SELECT * FROM Families f where f.lastName = @lastName", parameters: [ {name: "@lastName", value: "Wakefield"} ] };
StoredProcedureDefinition
TriggerDefinition
UniqueKey	A UniqueKeyPolicy részeként átadott egyetlen egyedi kulcs felülete
UniqueKeyPolicy	Egyedi kulcsok tárolólétrehozáskor történő beállításának felülete
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition
VectorEmbedding	Vektoros beágyazást jelöl. A vektorbeágyazással vektormezőt definiálhat a dokumentumokban.
VectorEmbeddingPolicy	A vektoros beágyazások szabályzatkonfigurációját jelöli az Azure Cosmos DB szolgáltatásban.
VectorIndex	Vektorindexet jelöl az Azure Cosmos DB szolgáltatásban. A vektorindex a dokumentumok vektormezőinek indexelésére szolgál.

Típusaliasok

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic	Ez a típus a CosmosClient inicializálásával kapcsolatos információkat tartalmazza
ClientSideRequestStatistics	Ez az ügyféloldali diagnosztikai információk gyűjteménytípusa.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics	Ez a típus a CosmosDB-ügyfélművelet során a kiszolgálóra irányuló összes metaadat-kérelem diagnosztikai adatait tartalmazza.
NonePartitionKeyType	A visszaadott objektum egy partíciókulcs-értéket jelöl, amely lehetővé teszi a partíciókulcs érték nélküli elemeinek létrehozását és elérését
NullPartitionKeyType	A visszaadott objektum egy partíciókulcs-értéket jelöl, amely lehetővé teszi a partíciókulcs null értékű elemeinek létrehozását és elérését.
Operation
OperationInput
OperationWithItem
PartitionKey	Tároló Partíciókulcsa.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue	Egy primitív partíciókulcs-érték.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics	Ez a típus a CosmosDB-ügyfélművelet során végrehajtott újrapróbálkozások diagnosztikai adatait rögzíti.
TokenProvider
UpsertOperation

Enumerációk

ChangeFeedMode
ConflictResolutionMode
ConnectionMode	Meghatározza a CosmosClient kapcsolati viselkedését. Vegye figyelembe, hogy jelenleg csak az átjáró módot támogatjuk.
ConsistencyLevel	Az Azure Cosmos DB-ügyfélműveletekhez támogatott konzisztenciaszinteket jelöli. A kért konzisztenciaszintnek meg kell egyeznie vagy gyengébbnek kell lennie az adatbázisfiókhoz kiosztottnál. Konzisztenciaszintek. A konzisztenciaszintek erősségi sorrend szerint: Erős, BoundedStaleness, Session, Konzisztens előtag és Végleges. A konzisztenciaszintekkel kapcsolatos részletesebb dokumentációért lásd a https://aka.ms/cosmos-consistency.
CosmosDbDiagnosticLevel	Cosmos DB diagnosztikai szint
DataType	Egy indexútvonal-specifikáció céladattípusát határozza meg az Azure Cosmos DB szolgáltatásban.
GeospatialType
IndexKind	Megadja a támogatott indextípusokat.
IndexingMode	A támogatott indexelési módokat adja meg.
MetadataLookUpType	Ez a lehetséges metaadatok típusú keresések számbavétele.
PartitionKeyDefinitionVersion	PartitionKey-definíció verziója
PartitionKeyKind	A PartitionKey típusa, azaz kivonat, MultiHash
PermissionMode	Engedélymód értékeinek számbavétele.
PriorityLevel	Az egyes Azure Cosmos DB-ügyfélkérésekhez társított prioritási szintet jelöli. Az alacsony prioritású kérelmek mindig szabályozva vannak a magas prioritású kérések előtt. Alapértelmezés szerint minden kérés magas prioritású kérésnek minősül. A prioritásalapú szabályozás részletesebb dokumentációját a https://aka.ms/CosmosDB/PriorityBasedExecution találja.
SpatialType
TriggerOperation	Az eseményindító műveleti értékeinek számbavétele. meghatározza azokat a műveleteket, amelyeken az eseményindítót végre kell hajtani.
TriggerType	Az eseményindító típusértékeinek számbavétele. Az eseményindító típusát adja meg.
UserDefinedFunctionType	Enum for udf type values. Megadja a felhasználó által definiált függvények típusait.
VectorEmbeddingDataType	A vektor adattípusát jelöli.
VectorEmbeddingDistanceFunction	A vektorok közötti távolságszámításhoz használandó távolságfüggvényt jelöli.
VectorIndexType	A vektor indextípusát jelöli.

Függvények

createAuthorizationSasToken(string, SasTokenProperties)

A kísérleti belső csak az sas-jogkivonat engedélykonfigurációját képviselő hasznos adatokat hozza létre.

Függvény adatai

createAuthorizationSasToken(string, SasTokenProperties)

A kísérleti belső csak az sas-jogkivonat engedélykonfigurációját képviselő hasznos adatokat hozza létre.

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

Paraméterek

masterKey

string

sasTokenProperties

SasTokenProperties

Válaszok

Promise<string>