@azure/cosmos package

  • Referencia

Osztályok

AbortError

Ez a hiba akkor jelenik meg, ha egy aszinkron műveletet megszakítottak. A hiba ellenőrzéséhez tesztelje, name hogy a hiba névtulajdonsága megegyezik-e "AbortError"a következővel: .

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áscsatornához.

A használatával Items.changeFeed() lekérheti az iterátor egy példányát.
ChangeFeedIteratorResponse

Az Azure Cosmos DB változáscsatornájának egyetlen válaszoldala
ChangeFeedResponse

Az Azure Cosmos DB változáscsatornájának egyetlen válaszoldala
ChangeFeedStartFrom

A ChangeFeedIterator indításának alaposztálya.
ClientSideMetrics
Conflict

Egy adott ütközés azonosító alapján történő olvasására vagy törlésére használható.

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ó.

Lásd: Ütközés adott ütközések azonosító alapján történő olvasásához vagy törléséhez.
Container

Műveletek adott meglévő tárolók azonosító alapján történő olvasásához, cseréjéhez vagy törléséhez.

Lásd: Tárolók új tárolók létrehozásához, valamint az összes tároló olvasása/lekérdezése; használja a következőt .containers: .

Megjegyzés: ezek a műveletek rögzített költségvetéshez kapcsolódó hívásokat kezdeményeznek. Úgy kell megterveznie a rendszert, hogy ezek a hívások az alkalmazással egy vonalban 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 tegye meg 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

A meglévő tárolók olvasásához, cseréjéhez vagy törléséhez lásd: Tároló; használja a következőt .container(id): .

Megjegyzés: ezek a műveletek rögzített költségvetéshez kapcsolódó hívásokat kezdeményeznek. Úgy kell megterveznie a rendszert, hogy ezek a hívások az alkalmazással egy vonalban 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 tegye meg 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>", auth: {masterKey: "<KEY HERE>"}});
await client.databases.create({id: "<datbase name here>"});

Példa

Ügyfél példányosítása egyéni kapcsolati szabályzattal

const connectionPolicy = new ConnectionPolicy();
connectionPolicy.RequestTimeout = 10000;
const client = new CosmosClient({
   endpoint: "<URL HERE>",
   auth: {masterKey: "<KEY HERE>"},
   connectionPolicy
});
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:
  1. clientSideRequestStatistics A tag összesített diagnosztikai információkat 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 felkeresett végpontok.
  • request, response payload stats.
  • 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.
  1. 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 részletek típusa a következő: CosmosDbDiagnosticLevel.
  • CosmosDbDiagnosticLevel.info – Az alapértelmezett érték. Ebben a szinten csak a clientSideRequestStatistics lesz rögzítve. Éles környezetekhez készült.
  • CosmosDbDiagnosticLevel.debug – A diagnosticNode és a clientConfig rögzítése. 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.debug alkalmazásban rögzített adatok mellett a kérések és válaszok hasznos adatait is rögzíti. Éles környezetben nem használható.
  1. clientConfig – Az ügyfél inicializálás során történő konfigurálásával kapcsolatos információkat rögzíti.
Database

Műveletek meglévő adatbázisok olvasásához vagy törléséhez.

Lásd: Adatbázisok új adatbázisok létrehozásához és az összes adatbázis olvasásához/lekérdezéséhez; használja a következőt client.databases: .

Megjegyzés: ezek a műveletek rögzített költségvetéshez kapcsolódó hívásokat kezdeményeznek. Úgy kell megterveznie a rendszert, hogy ezek a hívások az alkalmazással egy vonalban skálázhatók legyenek. Például ne hívjon database.read() minden egyes item.read() hívás előtt, hogy az adatbázis létezik-e. Ezt egyszer tegye meg az alkalmazás indításakor.
DatabaseAccount

Egy DatabaseAccountot jelöl az Azure Cosmos DB adatbázis-szolgáltatásban.
DatabaseResponse

Válaszobjektum adatbázis-műveletekhez
Databases

Műveletek új adatbázisok létrehozásához, valamint az összes adatbázis olvasásához/lekérdezéséhez

Lásd: Adatbázis meglévő adatbázis olvasásához vagy törléséhez; használja a következőt client.database(id): .

Megjegyzés: ezek a műveletek rögzített költségvetéshez kapcsolódó hívásokat kezdeményeznek. Úgy kell megterveznie a rendszert, hogy ezek a hívások az alkalmazással egy vonalban skálázhatók legyenek. Például ne hívjon databases.readAll() minden egyes item.read() hívás előtt, hogy az adatbázis létezik-e. Ezt egyszer tegye meg az alkalmazás indításakor.
ErrorResponse
FeedRange

A változáscsatorna hírcsatornatartományát adja meg.
FeedResponse
Item

Műveletek végrehajtására szolgál egy adott elemen.

Lásd: 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 lásd: Elem ; használja a következőt .item(id): .
Offer

Meglévő ajánlat azonosító alapján történő olvasásához vagy cseréjéhez használható.

Lásd: Ajánlatok az összes ajánlat lekérdezéséhez vagy olvasásához.
OfferResponse
Offers

Az összes ajánlat lekérdezéséhez vagy olvasásához használható.

Lásd: Ajánlat meglévő ajánlat azonosító alapján történő olvasására vagy cseréjére.
PartitionKeyBuilder

Builder osztály a PartitionKey felépítéséhez.
Permission

Egy adott engedély azonosító alapján történő olvasására, cseréjére vagy törlésére használható.

Lásd: 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: Adott engedély olvasására, cseréjére vagy törlésére vonatkozó engedély azonosító alapján.
QueryIterator

Egy QueryIterator objektumot jelöl, amely a hírcsatorna vagy a 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

Műveletek egy adott, meglévő tárolt eljárás azonosító alapján történő olvasásához, cseréjéhez, törléséhez vagy végrehajtásához.

Tárolt eljárások létrehozására, olvasására vagy lekérdezésére szolgáló műveletek esetén:
StoredProcedureResponse
StoredProcedures

Műveletek az összes tárolt eljárás létrehozásához, frissítéséhez vagy olvasásához/lekérdezéséhez.

Egy adott, meglévő tárolt eljárás azonosító alapján történő olvasásához, cseréjéhez, törléséhez vagy végrehajtásához lásd: container.storedProcedure().
TimeoutError
Trigger

Eseményindítók olvasására, cseréjére vagy törlésére szolgáló műveletek.

A használatával container.triggers létrehozhatja, beolvashatja, 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.

Eseményindítók olvasására, cseréjére vagy törlésére használhatócontainer.triggers.
User

Felhasználók olvasására, cseréjére és törlésére szolgál.

Emellett az és a használatával is elérheti egy adott felhasználó user.permissionuser.permissionsengedé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 azonosító alapján történő olvasására, cseréjére vagy törlésére szolgál.

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ára, frissítésére, lekérdezésére vagy olvasására szolgál.

Egy adott felhasználó által definiált függvény azonosító alapján történő olvasásához, cseréjéhez vagy törléséhez lásd: UserDefinedFunction .
UserResponse
Users

Az összes felhasználó létrehozására, frissítésére, lekérdezésére és olvasására szolgál.

Egy adott felhasználó azonosító alapján történő olvasásához, cseréjéhez vagy törléséhez lásd: Felhasználó .

Interfészek

@azure/cosmos.Index
Agent
BulkOptions

A tömeges végrehajtás módosításához használt options objektum. continueOnError (alapértelmezett érték: false) – 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

Ezen beállítások némelyike azt szabályozza, hogy hol és mikor kezdjen el olvasni a változáscsatornából. Az elsőbbségi sorrend a következő:

  • Folytatása
  • startTime
  • startFromBeginning

Ha egyik beállítás sincs beállítva, az első ChangeFeedIterator.fetchNext() hívásból elkezdi olvasni a módosításokat.
ChangeFeedPullModelIterator

Olyan iterátor visszaadására használható Items.getChangeFeedIterator() , amely egy partíciókulcs, adatcsatornatartomány vagy egy teljes tároló összes változását át tudja iterálni.
ConflictDefinition
ConflictResolutionPolicy

Az ütközésfeloldási szabályzat konfigurációját jelöli az ütközések feloldásának módjához abban az esetben, 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

Egy olyan fát jelöl, mint a struktúra, amely a diagnosztikai információk rögzítésére szolgál.
ErrorBody
FailedRequestAttemptDiagnostic

Ez a típus diagnosztikai adatokat rögzít a kiszolgálói API-nak küldött sikertelen kéréssel kapcsolatban.
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 Item 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áját itt tekintheti meg: <xref:ItemBody>
JSONArray
JSONObject
Location

Az elérhető 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érésekhez megadható beállítások.=
Resource
RetryOptions

Az Azure Cosmos DB adatbázis-szolgáltatásban szabályozott kérésekkel társított újrapróbálkozási szabályzatot jelöli.
SharedOptions

Az Azure Cosmos DB-kiszolgálóknak kiadott kérésekhez megadható beállítások.=
SpatialIndex
SqlParameter

Paramétert jelöl egy sqlQuerySpec paraméterrel rendelkező SQL-lekérdezésben
SqlQuerySpec

Egy SQL-lekérdezést jelöl az Azure Cosmos DB szolgáltatásban.

A bemeneti lekérdezéseket paraméteresen kell megadni az SQL-injektálás elleni védelem érdekében.

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 egyedi kulcs interfésze
UniqueKeyPolicy

Egyedi kulcsok tárolólétrehozáskor történő beállításának felülete
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition

Típusaliasok

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic

Ez a típus a következő inicializálásával kapcsolatos információkat tartalmazza: CosmosClient
ClientSideRequestStatistics

Ez az összes ügyféloldali diagnosztikai információ 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ónak küldött összes metaadat-kérésre vonatkozó diagnosztikai adatokat tartalmazza.
NonePartitionKeyType

A visszaadott objektum egy partíciókulcs-értéket jelöl, amely lehetővé teszi a partíciókulcs értéke nélküli elemek 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ó PartitionKey tulajdonsága.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue

Egy primitív partíciókulcs-érték.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics

Ez a típus diagnosztikai adatokat rögzít a CosmosDB-ügyfélművelet során végrehajtott újrapróbálkozási kísérletekről.
TokenProvider
UpsertOperation

Enumerációk

ConflictResolutionMode
ConnectionMode

Meghatározza a CosmosClient kapcsolati viselkedését. Vegye figyelembe, hogy jelenleg csak az átjáró üzemmó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 kiépítettnél. Konzisztenciaszintek.

A konzisztenciaszintek erősségi sorrendben: Erős, BoundedStaleness, Munkamenet, Konzisztens előtag és Végleges.

A konzisztenciaszintekkel kapcsolatos részletesebb dokumentációt lásd 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

A támogatott indextípusok megadása.
IndexingMode

A támogatott indexelési módokat határozza meg.
MetadataLookUpType

Ez a lehetséges metaadat-keresések típusának felsorolása.
PartitionKeyDefinitionVersion

PartitionKey Definíció verziója
PartitionKeyKind

A PartitionKey típusa, például 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érések mindig a magas prioritású kérések előtt vannak szabályozva.

Alapértelmezés szerint minden kérés magas prioritású kérésnek minősül.

A prioritásalapú szabályozással kapcsolatos részletesebb dokumentációt itt találja https://aka.ms/CosmosDB/PriorityBasedExecution .
SpatialType
TriggerOperation

Eseményindító műveleti értékeinek számbavétele. meghatározza azokat a műveleteket, amelyeken egy eseményindítót végre kell hajtani.
TriggerType

Eseményindító típusértékeinek számbavétele. Az eseményindító típusát adja meg.
UserDefinedFunctionType

Enumerálás udf típusú értékekhez. A felhasználó által definiált függvények típusait határozza meg.

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>