Freigeben über

Container class

  • Referenz
Paket:
@azure/cosmos

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

Siehe Container zum Erstellen neuer Container und lesen/Abfragen aller Container; verwenden Sie .containers.

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

Eigenschaften

conflicts

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

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

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

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

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 zum Lesen, Ersetzen oder Löschen eines bestimmten, vorhandenen Conflict nach ID verwendet.

Verwenden Sie .conflicts zum Erstellen neuer Konflikte oder zum Abfragen/Lesen aller Konflikte.
delete(RequestOptions)

Löschen des Containers
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

Löschen aller Dokumente, die zum Container für den bereitgestellten Partitionsschlüsselwert gehören
getFeedRanges()
getPartitionKeyDefinition()

Ruft die Partitionsschlüsseldefinition zuerst ab, indem Sie den Cache durch Lesen der Auflistung andernfalls untersuchen.
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 .items zum 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 Containerdefinition
readOffer(RequestOptions)

Ruft Angebot auf Container ab. Wenn keine vorhanden ist, wird ein OfferResponse mit undefiniert zurückgegeben.
readPartitionKeyRanges(FeedOptions)
replace(ContainerDefinition, RequestOptions)

Ersetzen der Containerdefinition

Details zur Eigenschaft

conflicts

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

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

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 zum Lesen, Ersetzen oder Löschen eines vorhandenen Elements .item(id).

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 zum Lesen, Ersetzen oder Löschen eines bestimmten, vorhandenen Conflict nach ID verwendet.

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

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

Parameter

id

string

Die ID der Conflict.

partitionKey
PartitionKey

Gibt zurück

Conflict

delete(RequestOptions)

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 bereitgestellten 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 Änderungsfeed abgerufen werden konnte.

getPartitionKeyDefinition()

Warnung

Diese API ist nun veraltet.

This method has been renamed to readPartitionKeyDefinition.

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

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 .items zum 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 Item-.

partitionKeyValue
PartitionKey

Der Wert des partitionsschlüssels Item

Gibt zurück

Item

read(RequestOptions)

Lesen der Containerdefinition

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

Parameter

options
RequestOptions

Gibt zurück

Promise<ContainerResponse>

readOffer(RequestOptions)

Ruft Angebot auf 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 Containerdefinition

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

Parameter

body
ContainerDefinition
options
RequestOptions

Gibt zurück

Promise<ContainerResponse>