Container class

Pakket:

@azure/cosmos

Bewerkingen voor het lezen, vervangen of verwijderen van een specifieke, bestaande container op id.

Zie Containers voor het maken van nieuwe containers en het lezen/opvragen van alle containers; gebruik .containers.

Opmerking: al deze bewerkingen voeren aanroepen uit tegen een vast budget. U moet uw systeem zo ontwerpen dat deze aanroepen sublineair worden geschaald met uw toepassing. Roep bijvoorbeeld niet container(id).read() aan vóór elke aanroep item.read() om ervoor te zorgen dat de container bestaat. Doe dit eenmaal bij het opstarten van de toepassing.

Eigenschappen

conflicts	Bewerkingen voor het lezen en opvragen van conflicten voor de opgegeven container. Gebruik .conflict(id)voor het lezen of verwijderen van een specifiek conflict.
database
id
items	Bewerkingen voor het maken van nieuwe items en het lezen/opvragen van alle items Gebruik voor het lezen, vervangen of verwijderen van een bestaand item .item(id). Voorbeeld Een nieuw item maken const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});
scripts	Alle bewerkingen voor opgeslagen procedures, triggers en door de gebruiker gedefinieerde functies
url	Retourneert een verwijzings-URL naar de resource. Wordt gebruikt voor het koppelen in Machtigingen.

Methoden

conflict(string, PartitionKey)	Wordt gebruikt om een specifiek bestaand conflict op id te lezen, vervangen of verwijderen. Gebruik .conflicts dit voor het maken van nieuwe conflicten of het opvragen/lezen van alle conflicten.
delete(RequestOptions)	De container verwijderen
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)	Alle documenten verwijderen die deel uitmaken van de container voor de opgegeven partitiesleutelwaarde
getFeedRanges()
getPartitionKeyDefinition()	Haalt de definitie van de partitiesleutel eerst op door in de cache te kijken, anders door de verzameling te lezen.
getQueryPlan(string | SqlQuerySpec)
item(string, PartitionKey)	Wordt gebruikt voor het lezen, vervangen of verwijderen van een specifiek bestaand item op id. Gebruik .items dit voor het maken van nieuwe items of het uitvoeren van query's/het lezen van alle items. Voorbeeld Een item vervangen const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});
read(RequestOptions)	De definitie van de container lezen
readOffer(RequestOptions)	Hiermee krijgt u een aanbieding voor de container. Als er geen bestaat, retourneert een OfferResponse met undefined.
readPartitionKeyRanges(FeedOptions)
replace(ContainerDefinition, RequestOptions)	De definitie van de container vervangen

Eigenschapdetails

conflicts

Bewerkingen voor het lezen en opvragen van conflicten voor de opgegeven container.

Gebruik .conflict(id)voor het lezen of verwijderen van een specifiek conflict.

Conflicts conflicts

Waarde van eigenschap

Conflicts

database

database: Database

Waarde van eigenschap

Database

id

id: string

Waarde van eigenschap

string

items

Bewerkingen voor het maken van nieuwe items en het lezen/opvragen van alle items

Gebruik voor het lezen, vervangen of verwijderen van een bestaand item .item(id).

Voorbeeld

Een nieuw item maken

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

Items items

Waarde van eigenschap

Items

scripts

Alle bewerkingen voor opgeslagen procedures, triggers en door de gebruiker gedefinieerde functies

Scripts scripts

Waarde van eigenschap

Scripts

url

Retourneert een verwijzings-URL naar de resource. Wordt gebruikt voor het koppelen in Machtigingen.

string url

Waarde van eigenschap

string

Methodedetails

conflict(string, PartitionKey)

Wordt gebruikt om een specifiek bestaand conflict op id te lezen, vervangen of verwijderen.

Gebruik .conflicts dit voor het maken van nieuwe conflicten of het opvragen/lezen van alle conflicten.

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

Parameters

id

string

De id van het conflict.

partitionKey

PartitionKey

Retouren

Conflict

delete(RequestOptions)

De container verwijderen

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

Parameters

options

RequestOptions

Retouren

Promise<ContainerResponse>

deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

Alle documenten verwijderen die deel uitmaken van de container voor de opgegeven partitiesleutelwaarde

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

Parameters

partitionKey

PartitionKey

De partitiesleutelwaarde van de items die moeten worden verwijderd

options

RequestOptions

Retouren

Promise<ContainerResponse>

getFeedRanges()

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

Retouren

Promise<readonly FeedRange[]>

alle feedbereiken waarvoor changefeed kan worden opgehaald.

getPartitionKeyDefinition()

Waarschuwing

Deze API is nu afgeschaft.

This method has been renamed to readPartitionKeyDefinition.

Haalt de definitie van de partitiesleutel eerst op door in de cache te kijken, anders door de verzameling te lezen.

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

Retouren

Promise<ResourceResponse<PartitionKeyDefinition>>

getQueryPlan(string | SqlQuerySpec)

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

Parameters

query

string | SqlQuerySpec

Retouren

Promise<Response_2<PartitionedQueryExecutionInfo>>

item(string, PartitionKey)

Wordt gebruikt voor het lezen, vervangen of verwijderen van een specifiek bestaand item op id.

Gebruik .items dit voor het maken van nieuwe items of het uitvoeren van query's/het lezen van alle items.

Voorbeeld

Een item vervangen 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

Parameters

id

string

De id van het item.

partitionKeyValue

PartitionKey

De waarde van de partitiesleutel Item

Retouren

Item

read(RequestOptions)

De definitie van de container lezen

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

Parameters

options

RequestOptions

Retouren

Promise<ContainerResponse>

readOffer(RequestOptions)

Hiermee krijgt u een aanbieding voor de container. Als er geen bestaat, retourneert een OfferResponse met undefined.

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

Parameters

options

RequestOptions

Retouren

Promise<OfferResponse>

readPartitionKeyRanges(FeedOptions)

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

Parameters

feedOptions

FeedOptions

Retouren

QueryIterator<PartitionKeyRange>

replace(ContainerDefinition, RequestOptions)

De definitie van de container vervangen

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

Parameters

body

ContainerDefinition

options

RequestOptions

Retouren

Promise<ContainerResponse>