Megosztás a következőn keresztül:

Container class

  • Referencia
Csomag:
@azure/cosmos

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.

Tulajdonságok

conflicts

Az adott tárolóhoz tartozó ütközések olvasására és lekérdezésére szolgáló műveletek.

Egy adott ütközés olvasásához vagy törléséhez használja a .conflict(id).
database
id
items

Új elemek létrehozására és az összes elem olvasására/lekérdezésére szolgáló műveletek

Meglévő elem olvasásához, cseréjéhez vagy törléséhez használja a .item(id).

példa

Új elem létrehozása

const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});
scripts

Tárolt eljárások, triggerek és felhasználó által definiált függvények összes művelete
url

Az erőforrás hivatkozási URL-címét adja vissza. Az engedélyek csatolásához használatos.

Metódusok

conflict(string, PartitionKey)

Egy adott, meglévő ütközési azonosító alapján történő olvasására, cseréjére vagy törlésére szolgál.

Használja a .conflicts új ütközések létrehozásához, vagy az összes ütközés lekérdezéséhez/olvasásához.
delete(RequestOptions)

A tároló törlése
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

A megadott partíciókulcs-érték tárolójának összes dokumentumának törlése
getFeedRanges()
getPartitionKeyDefinition()

Először lekéri a partíciókulcs definícióját úgy, hogy a gyűjtemény olvasásával megkeresi a gyorsítótárat.
getQueryPlan(string | SqlQuerySpec)
item(string, PartitionKey)

Egy adott, meglévő elem olvasására, cseréjére vagy törlésére szolgál, azonosító alapján.

Használja a .items új elemek létrehozásához, vagy az összes elem lekérdezéséhez/olvasásához.

példa

Elem cseréje const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});
read(RequestOptions)

A tároló definíciójának olvasása
readOffer(RequestOptions)

Ajánlatot kap a tárolón. Ha nincs ilyen, akkor egy nem definiált OfferResponse értéket ad vissza.
readPartitionKeyRanges(FeedOptions)
replace(ContainerDefinition, RequestOptions)

A tároló definíciójának cseréje

Tulajdonság adatai

conflicts

Az adott tárolóhoz tartozó ütközések olvasására és lekérdezésére szolgáló műveletek.

Egy adott ütközés olvasásához vagy törléséhez használja a .conflict(id).

Conflicts conflicts

Tulajdonság értéke

Conflicts

database 

database: Database

Tulajdonság értéke

Database

id 

id: string

Tulajdonság értéke

string

items

Új elemek létrehozására és az összes elem olvasására/lekérdezésére szolgáló műveletek

Meglévő elem olvasásához, cseréjéhez vagy törléséhez használja a .item(id).

példa

Új elem létrehozása

const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});

Items items

Tulajdonság értéke

Items

scripts

Tárolt eljárások, triggerek és felhasználó által definiált függvények összes művelete

Scripts scripts

Tulajdonság értéke

Scripts

url

Az erőforrás hivatkozási URL-címét adja vissza. Az engedélyek csatolásához használatos.

string url

Tulajdonság értéke

string

Metódus adatai

conflict(string, PartitionKey)

Egy adott, meglévő ütközési azonosító alapján történő olvasására, cseréjére vagy törlésére szolgál.

Használja a .conflicts új ütközések létrehozásához, vagy az összes ütközés lekérdezéséhez/olvasásához.

function conflict(id: string, partitionKey?: PartitionKey): Conflict

Paraméterek

id

string

A Ütközésazonosítója.

partitionKey
PartitionKey

Válaszok

Conflict

delete(RequestOptions)

A tároló törlése

function delete(options?: RequestOptions): Promise<ContainerResponse>

Paraméterek

options
RequestOptions

Válaszok

Promise<ContainerResponse>

deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

A megadott partíciókulcs-érték tárolójának összes dokumentumának törlése

function deleteAllItemsForPartitionKey(partitionKey: PartitionKey, options?: RequestOptions): Promise<ContainerResponse>

Paraméterek

partitionKey
PartitionKey

A törölni kívánt elemek partíciókulcs-értéke

options
RequestOptions

Válaszok

Promise<ContainerResponse>

getFeedRanges() 

function getFeedRanges(): Promise<readonly FeedRange[]>

Válaszok

Promise<readonly FeedRange[]>

az összes olyan hírcsatornatartomány, amelyhez a változáscsatorna beolvasható.

getPartitionKeyDefinition()

Figyelmeztetés

Ez az API már elavult.

This method has been renamed to readPartitionKeyDefinition.

Először lekéri a partíciókulcs definícióját úgy, hogy a gyűjtemény olvasásával megkeresi a gyorsítótárat.

function getPartitionKeyDefinition(): Promise<ResourceResponse<PartitionKeyDefinition>>

Válaszok

Promise<ResourceResponse<PartitionKeyDefinition>>

getQueryPlan(string | SqlQuerySpec) 

function getQueryPlan(query: string | SqlQuerySpec): Promise<Response_2<PartitionedQueryExecutionInfo>>

Paraméterek

query

string | SqlQuerySpec

Válaszok

Promise<Response_2<PartitionedQueryExecutionInfo>>

item(string, PartitionKey)

Egy adott, meglévő elem olvasására, cseréjére vagy törlésére szolgál, azonosító alapján.

Használja a .items új elemek létrehozásához, vagy az összes elem lekérdezéséhez/olvasásához.

példa

Elem cseréje const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});

function item(id: string, partitionKeyValue?: PartitionKey): Item

Paraméterek

id

string

Az Elemazonosítója.

partitionKeyValue
PartitionKey

A Elem partíciókulcs értéke

Válaszok

Item

read(RequestOptions)

A tároló definíciójának olvasása

function read(options?: RequestOptions): Promise<ContainerResponse>

Paraméterek

options
RequestOptions

Válaszok

Promise<ContainerResponse>

readOffer(RequestOptions)

Ajánlatot kap a tárolón. Ha nincs ilyen, akkor egy nem definiált OfferResponse értéket ad vissza.

function readOffer(options?: RequestOptions): Promise<OfferResponse>

Paraméterek

options
RequestOptions

Válaszok

Promise<OfferResponse>

readPartitionKeyRanges(FeedOptions) 

function readPartitionKeyRanges(feedOptions?: FeedOptions): QueryIterator<PartitionKeyRange>

Paraméterek

feedOptions
FeedOptions

Válaszok

QueryIterator<PartitionKeyRange>

replace(ContainerDefinition, RequestOptions)

A tároló definíciójának cseréje

function replace(body: ContainerDefinition, options?: RequestOptions): Promise<ContainerResponse>

Paraméterek

body
ContainerDefinition
options
RequestOptions

Válaszok

Promise<ContainerResponse>