Container class

Paket:

@azure/cosmos

Vorgänge zum Lesen, Ersetzen oder Löschen eines bestimmten vorhandenen Containers nach id.

Weitere Informationen finden Sie unter Container zum Erstellen neuer Container und Lesen/Abfragen aller Container. Verwenden Sie .containers.

Hinweis: Alle diese Vorgänge führen Aufrufe mit einem festen Budget aus. Sie sollten Ihr System so entwerfen, dass diese Aufrufe sublinear mit Ihrer Anwendung skaliert werden. Rufen container(id).read() Sie für instance nicht vor jedem einzelnen item.read() Aufruf auf, um sicherzustellen, dass der Container vorhanden ist. Führen Sie dies einmal beim Anwendungsstart aus.

Eigenschaften

conflicts	Vorgänge zum Lesen und Abfragen von Konflikten für den angegebenen Container. Verwenden Sie .conflict(id)zum Lesen oder Löschen eines bestimmten Konflikts .
database
id
items	Vorgänge zum Erstellen neuer Elemente und Lesen/Abfragen aller Elemente Verwenden Sie .item(id)zum Lesen, Ersetzen oder Löschen eines vorhandenen Elements . Beispiel Erstellen eines neuen Elements const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});
scripts	Alle Vorgänge für gespeicherte Prozeduren, Trigger und benutzerdefinierte Funktionen
url	Gibt eine Verweis-URL für die Ressource zurück. Wird zum Verknüpfen in Berechtigungen verwendet.

Methoden

conflict(string, PartitionKey)	Wird verwendet, um einen bestimmten vorhandenen Konflikt nach ID zu lesen, zu ersetzen oder zu löschen. Verwenden Sie diese Option .conflicts zum Erstellen neuer Konflikte oder zum Abfragen/Lesen aller Konflikte.
delete(RequestOptions)	Zum Löschen des Containers
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)	Löschen aller Dokumente, die zum Container für den angegebenen Partitionsschlüsselwert gehören
getFeedRanges()
getPartitionKeyDefinition()	Ruft zuerst die Partitionsschlüsseldefinition ab, indem Sie den Cache untersuchen, andernfalls durch Lesen der Auflistung.
getQueryPlan(string | SqlQuerySpec)
item(string, PartitionKey)	Wird verwendet, um ein bestimmtes vorhandenes Element nach ID zu lesen, zu ersetzen oder zu löschen. Verwenden Sie zum .items Erstellen neuer Elemente oder zum Abfragen/Lesen aller Elemente. Beispiel Ersetzen eines Elements const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});
read(RequestOptions)	Lesen der Definition des Containers
readOffer(RequestOptions)	Ruft das Angebot für den Container ab. Wenn keine vorhanden ist, wird ein OfferResponse mit undefiniert zurückgegeben.
readPartitionKeyRanges(FeedOptions)
replace(ContainerDefinition, RequestOptions)	Ersetzen der Definition des Containers

Details zur Eigenschaft

conflicts

Vorgänge zum Lesen und Abfragen von Konflikten für den angegebenen Container.

Verwenden Sie .conflict(id)zum Lesen oder Löschen eines bestimmten Konflikts .

Conflicts conflicts

Eigenschaftswert

Conflicts

database

database: Database

Eigenschaftswert

Database

id

id: string

Eigenschaftswert

string

items

Vorgänge zum Erstellen neuer Elemente und Lesen/Abfragen aller Elemente

Verwenden Sie .item(id)zum Lesen, Ersetzen oder Löschen eines vorhandenen Elements .

Beispiel

Erstellen eines neuen Elements

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

Items items

Eigenschaftswert

Items

scripts

Alle Vorgänge für gespeicherte Prozeduren, Trigger und benutzerdefinierte Funktionen

Scripts scripts

Eigenschaftswert

Scripts

url

Gibt eine Verweis-URL für die Ressource zurück. Wird zum Verknüpfen in Berechtigungen verwendet.

string url

Eigenschaftswert

string

Details zur Methode

conflict(string, PartitionKey)

Wird verwendet, um einen bestimmten vorhandenen Konflikt nach ID zu lesen, zu ersetzen oder zu löschen.

Verwenden Sie diese Option .conflicts zum Erstellen neuer Konflikte oder zum Abfragen/Lesen aller Konflikte.

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

Parameter

id

string

Die ID des Konflikts.

partitionKey

PartitionKey

Gibt zurück

Conflict

delete(RequestOptions)

Zum Löschen des Containers

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

Parameter

options

RequestOptions

Gibt zurück

Promise<ContainerResponse>

deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

Löschen aller Dokumente, die zum Container für den angegebenen Partitionsschlüsselwert gehören

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

Parameter

partitionKey

PartitionKey

Der Partitionsschlüsselwert der zu löschenden Elemente

options

RequestOptions

Gibt zurück

Promise<ContainerResponse>

getFeedRanges()

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

Gibt zurück

Promise<readonly FeedRange[]>

alle Feedbereiche, für die changefeed abgerufen werden konnte.

getPartitionKeyDefinition()

Warnung

Diese API ist nun veraltet.

This method has been renamed to readPartitionKeyDefinition.

Ruft zuerst die Partitionsschlüsseldefinition ab, indem Sie den Cache untersuchen, andernfalls durch Lesen der Auflistung.

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

Gibt zurück

Promise<ResourceResponse<PartitionKeyDefinition>>

getQueryPlan(string | SqlQuerySpec)

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

Parameter

query

string | SqlQuerySpec

Gibt zurück

Promise<Response_2<PartitionedQueryExecutionInfo>>

item(string, PartitionKey)

Wird verwendet, um ein bestimmtes vorhandenes Element nach ID zu lesen, zu ersetzen oder zu löschen.

Verwenden Sie zum .items Erstellen neuer Elemente oder zum Abfragen/Lesen aller Elemente.

Beispiel

Ersetzen eines Elements 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

Parameter

id

string

Die ID des Elements.

partitionKeyValue

PartitionKey

Der Wert des Elementpartitionsschlüssels

Gibt zurück

Item

read(RequestOptions)

Lesen der Definition des Containers

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

Parameter

options

RequestOptions

Gibt zurück

Promise<ContainerResponse>

readOffer(RequestOptions)

Ruft das Angebot für den Container ab. Wenn keine vorhanden ist, wird ein OfferResponse mit undefiniert zurückgegeben.

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

Parameter

options

RequestOptions

Gibt zurück

Promise<OfferResponse>

readPartitionKeyRanges(FeedOptions)

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

Parameter

feedOptions

FeedOptions

Gibt zurück

QueryIterator<PartitionKeyRange>

replace(ContainerDefinition, RequestOptions)

Ersetzen der Definition des Containers

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

Parameter

body

ContainerDefinition

options

RequestOptions

Gibt zurück

Promise<ContainerResponse>