Container class

Paket:

@azure/cosmos

Åtgärder för att läsa, ersätta eller ta bort en specifik befintlig container med ID.

Se Containrar för att skapa nya containrar och läsa/fråga alla containrar. använd .containers.

Obs! Alla dessa åtgärder gör anrop mot en fast budget. Du bör utforma systemet så att dessa anrop skalas sublineärt med ditt program. Anropa container(id).read() till exempel inte före varje enskilt item.read() anrop för att säkerställa att containern finns. Gör detta en gång när programmet startas.

Egenskaper

conflicts	Åtgärder för att läsa och köra frågor mot konflikter för den angivna containern. Om du vill läsa eller ta bort en specifik konflikt använder du .conflict(id).
database
id
items	Åtgärder för att skapa nya objekt och läsa/fråga alla objekt Om du vill läsa, ersätta eller ta bort ett befintligt objekt använder du .item(id). Exempel Skapa ett nytt objekt const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});
scripts	Alla åtgärder för lagrade procedurer, utlösare och användardefinierade funktioner
url	Returnerar en referens-URL till resursen. Används för länkning i Behörigheter.

Metoder

conflict(string, PartitionKey)	Används för att läsa, ersätta eller ta bort en specifik, befintlig konflikt med ID. Använd .conflicts för att skapa nya konflikter eller fråga/läsa alla konflikter.
delete(RequestOptions)	Ta bort containern
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)	Ta bort alla dokument tillhör containern för det angivna partitionsnyckelvärdet
getFeedRanges()
getPartitionKeyDefinition()	Hämtar definitionen av partitionsnyckeln först genom att titta i cachen annars genom att läsa samlingen.
getQueryPlan(string | SqlQuerySpec)
item(string, PartitionKey)	Används för att läsa, ersätta eller ta bort ett specifikt befintligt objekt med ID. Använd .items för att skapa nya objekt eller fråga/läsa alla objekt. Exempel Ersätt ett objekt const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});
read(RequestOptions)	Läs containerns definition
readOffer(RequestOptions)	Hämtar erbjudande för container. Om ingen finns returnerar ett OfferResponse med odefinierat.
readPartitionKeyRanges(FeedOptions)
replace(ContainerDefinition, RequestOptions)	Ersätt containerns definition

Egenskapsinformation

conflicts

Åtgärder för att läsa och köra frågor mot konflikter för den angivna containern.

Om du vill läsa eller ta bort en specifik konflikt använder du .conflict(id).

Conflicts conflicts

Egenskapsvärde

Conflicts

database

database: Database

Egenskapsvärde

Database

id

id: string

Egenskapsvärde

string

items

Åtgärder för att skapa nya objekt och läsa/fråga alla objekt

Om du vill läsa, ersätta eller ta bort ett befintligt objekt använder du .item(id).

Exempel

Skapa ett nytt objekt

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

Items items

Egenskapsvärde

Items

scripts

Alla åtgärder för lagrade procedurer, utlösare och användardefinierade funktioner

Scripts scripts

Egenskapsvärde

Scripts

url

Returnerar en referens-URL till resursen. Används för länkning i Behörigheter.

string url

Egenskapsvärde

string

Metodinformation

conflict(string, PartitionKey)

Används för att läsa, ersätta eller ta bort en specifik, befintlig konflikt med ID.

Använd .conflicts för att skapa nya konflikter eller fråga/läsa alla konflikter.

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

Parametrar

id

string

ID:t för konflikten.

partitionKey

PartitionKey

Returer

Conflict

delete(RequestOptions)

Ta bort containern

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

Parametrar

options

RequestOptions

Returer

Promise<ContainerResponse>

deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

Ta bort alla dokument tillhör containern för det angivna partitionsnyckelvärdet

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

Parametrar

partitionKey

PartitionKey

Partitionsnyckelvärdet för de objekt som ska tas bort

options

RequestOptions

Returer

Promise<ContainerResponse>

getFeedRanges()

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

Returer

Promise<readonly FeedRange[]>

alla feedintervall som ändringsfeeden kan hämtas för.

getPartitionKeyDefinition()

Varning

Det här API:et är nu inaktuellt.

This method has been renamed to readPartitionKeyDefinition.

Hämtar definitionen av partitionsnyckeln först genom att titta i cachen annars genom att läsa samlingen.

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

Returer

Promise<ResourceResponse<PartitionKeyDefinition>>

getQueryPlan(string | SqlQuerySpec)

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

Parametrar

query

string | SqlQuerySpec

Returer

Promise<Response_2<PartitionedQueryExecutionInfo>>

item(string, PartitionKey)

Används för att läsa, ersätta eller ta bort ett specifikt befintligt objekt med ID.

Använd .items för att skapa nya objekt eller fråga/läsa alla objekt.

Exempel

Ersätt ett objekt 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

Parametrar

id

string

Objektets ID.

partitionKeyValue

PartitionKey

Värdet för objektpartitionsnyckeln

Returer

Item

read(RequestOptions)

Läs containerns definition

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

Parametrar

options

RequestOptions

Returer

Promise<ContainerResponse>

readOffer(RequestOptions)

Hämtar erbjudande för container. Om ingen finns returnerar ett OfferResponse med odefinierat.

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

Parametrar

options

RequestOptions

Returer

Promise<OfferResponse>

readPartitionKeyRanges(FeedOptions)

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

Parametrar

feedOptions

FeedOptions

Returer

QueryIterator<PartitionKeyRange>

replace(ContainerDefinition, RequestOptions)

Ersätt containerns definition

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

Parametrar

body

ContainerDefinition

options

RequestOptions

Returer

Promise<ContainerResponse>