@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 Példa
|
| AzureKeyVaultEncryptionKeyResolver |
A EncryptionKeyResolver implementációja, amely az Azure Key Vaultot használja az ügyfél által felügyelt kulcsokhoz. |
| ChangeFeedIterator |
Iterátort biztosít a változáscsatorna számára. Az |
| 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. |
| ClientEncryptionKeyResponse |
Válaszobjektum a ClientEncryptionKey műveletekhez |
| 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; 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 |
| 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ó; 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 |
| 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
Példa Ügyfél példányosítása egyéni kapcsolati házirenddel
Példa Ügyfél példányosítása AAD-hitelesítéssel és egyéni hatókörrel
|
| CosmosDiagnostics |
|
| 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; 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 |
| 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; 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 |
| EncryptionQueryBuilder |
A titkosított paraméterek paraméterezésben való létrehozásához használt szerkesztőosztályt jelöl. |
| ErrorResponse |
A műveletekben visszaadott hibaválaszt jelöli. |
| 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: |
| 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; |
| 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 | |
| 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 |
| TimeoutError | |
| Trigger |
triggerolvasására, cseréjére vagy törlésére szolgáló műveletek. Az |
| 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.
|
| User |
Felhasználók olvasására, cseréjére és törlésére szolgál. Emellett az adott felhasználó engedélyeit 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 | |
| BulkOperationResult |
egy műveletre adott választ tömegesen az executeBulkOperations API-val |
| 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ő:
Ha egyik beállítás sincs beállítva, az első |
| ChangeFeedPullModelIterator |
A |
| ClientEncryptionIncludedPath |
A titkosítás elérési útját és a hozzá tartozó beállításokat jelöli. |
| ClientEncryptionKeyProperties |
A Azure Cosmos DB szolgáltatással használható ügyféltitkosítási kulcs részletei. |
| ClientEncryptionKeyRequest |
Az ügyféltitkosítási kulcsra vonatkozó kérést képviselő felület a Cosmos DB. |
| ClientEncryptionOptions |
A CosmosClienthez társított titkosítási beállításokat jelöli. |
| ClientEncryptionPolicy |
A tárolóhoz társított ügyféltitkosítási szabályzatot jelöli. |
| 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 | |
| CosmosEncryptedNumber |
Ez a felület egy titkosított számot jelöl a Cosmos DB SDK-ban. Példa
|
| CosmosHeaders | |
| CreateOperationInput | |
| DatabaseDefinition | |
| DatabaseRequest | |
| DeleteOperationInput | |
| DiagnosticNode |
A diagnosztikai információk rögzítésére szolgáló faszerkezetet jelöl. |
| EncryptionKeyResolver |
Interfészt biztosít a kulcsfeloldó számára a különböző kulcsszolgáltatók számára. Minden feloldónak implementálnia kell ezt a felületet. |
| EncryptionKeyWrapMetadata |
Az adattitkosítási kulcs ügyfél által felügyelt kulccsal történő burkolásához/kicsomagolásához használt metaadatok |
| ErrorBody | |
| ExtendedOperationResponse |
válasz a sikeres műveletre tömegesen az executeBulkOperations API-val |
| 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. |
| FullTextIndex |
Teljes szöveges indexet jelöl az indexelési szabályzatban. |
| FullTextPath |
Az Azure Cosmos DB szolgáltatásban indexelendő teljes szöveges elérési utat jelöli. |
| FullTextPolicy |
Az Azure Cosmos DB szolgáltatás gyűjteményeinek teljes szöveges szabályzatát jelöli. |
| 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 | |
| RestError |
A sikertelen folyamatkérések egyéni hibatípusa. |
| 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
|
| 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 |
| 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 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 |
| CosmosEncryptedNumberType |
Ez a felsorolás a Cosmos DB SDK-ban szereplő szám típusát jelöli. |
| DataType |
Egy indexútvonal-specifikáció céladattípusát határozza meg az Azure Cosmos DB szolgáltatásban. |
| EncryptionAlgorithm |
Titkosítási algoritmusok Az adattitkosításhoz támogatott algoritmusok |
| EncryptionKeyResolverName |
A megvalósítások nevei Lásd: EncryptionKeyResolver |
| EncryptionType |
A végrehajtandó titkosítás típusa. |
| GeospatialType | |
| IndexKind |
Megadja a támogatott indextípusokat. |
| IndexingMode |
A támogatott indexelési módokat adja meg. |
| KeyEncryptionAlgorithm |
Az adattitkosítási kulcs kulcstitkosítási kulccsal való burkolásához/kicsomagolásához használt algoritmusok. |
| 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. 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 |
Felsorolás udf-típusértékekhez. 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
| create |
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>