Container class

Csomag:

@azure/cosmos

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.

Tulajdonságok

conflicts	Műveletek az adott tároló ütközéseinek olvasásához és lekérdezéséhez. Egy adott ütközés olvasásához vagy törléséhez használja a következőt .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 következőt .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, eseményindítók és felhasználó által definiált függvények összes művelete
url	Egy hivatkozási URL-címet ad vissza az erőforrásnak. Az engedélyek csatolásához használatos.

Metódusok

conflict(string, PartitionKey)	Egy adott, meglévő ütközés azonosító alapján történő olvasására, cseréjére vagy törlésére szolgál. Új ütközések létrehozásához vagy az összes ütközés lekérdezéséhez/olvasásához használható .conflicts .
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 azonosító alapján történő olvasására, cseréjére vagy törlésére szolgál. Új elemek létrehozására vagy az összes elem lekérdezésére/olvasására használható .items . 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, egy offerResponse értéket ad vissza, amelynek nincs definiálva.
readPartitionKeyRanges(FeedOptions)
replace(ContainerDefinition, RequestOptions)	A tároló definíciójának cseréje

Tulajdonság adatai

conflicts

Műveletek az adott tároló ütközéseinek olvasásához és lekérdezéséhez.

Egy adott ütközés olvasásához vagy törléséhez használja a következőt .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 következőt .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, eseményindítók és felhasználó által definiált függvények összes művelete

Scripts scripts

Tulajdonság értéke

Scripts

url

Egy hivatkozási URL-címet ad vissza az erőforrásnak. 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és azonosító alapján történő olvasására, cseréjére vagy törlésére szolgál.

Új ütközések létrehozásához vagy az összes ütközés lekérdezéséhez/olvasásához használható .conflicts .

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

Paraméterek

id

string

Az Ütközés azonosí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 azonosító alapján történő olvasására, cseréjére vagy törlésére szolgál.

Új elemek létrehozására vagy az összes elem lekérdezésére/olvasására használható .items .

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 elem azonosítója.

partitionKeyValue

PartitionKey

Az Item 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, egy offerResponse értéket ad vissza, amelynek nincs definiálva.

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>