Container class

Paquet:

@azure/cosmos

Opérations de lecture, de remplacement ou de suppression d’un conteneur existant spécifique par ID.

Consultez Conteneurs pour la création de nouveaux conteneurs et la lecture/l’interrogation de tous les conteneurs . utilisez .containers.

Remarque : toutes ces opérations effectuent des appels sur un budget fixe. Vous devez concevoir votre système de manière à ce que ces appels soient mis à l’échelle de manière subligne avec votre application. Par instance, n’appelez container(id).read() pas avant chaque item.read() appel, pour vous assurer que le conteneur existe ; effectuez cette opération une fois au démarrage de l’application.

Propriétés

conflicts	Opérations de lecture et d’interrogation des conflits pour le conteneur donné. Pour lire ou supprimer un conflit spécifique, utilisez .conflict(id).
database
id
items	Opérations de création d’éléments et de lecture/interrogation de tous les éléments Pour lire, remplacer ou supprimer un élément existant, utilisez .item(id). Exemple Créer un élément const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});
scripts	Toutes les opérations pour les procédures stockées, les déclencheurs et les fonctions définies par l’utilisateur
url	Retourne une URL de référence à la ressource. Utilisé pour la liaison dans Autorisations.

Méthodes

conflict(string, PartitionKey)	Utilisé pour lire, remplacer ou supprimer un conflit existant spécifique par ID. Permet .conflicts de créer de nouveaux conflits ou d’interroger/lire tous les conflits.
delete(RequestOptions)	Supprimer un conteneur
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)	Supprimer tous les documents appartiennent au conteneur pour la valeur de clé de partition fournie
getFeedRanges()
getPartitionKeyDefinition()	Obtient d’abord la définition de clé de partition en examinant le cache en lisant la collection.
getQueryPlan(string | SqlQuerySpec)
item(string, PartitionKey)	Utilisé pour lire, remplacer ou supprimer un élément existant spécifique par id. Utilisez .items pour créer de nouveaux éléments ou interroger/lire tous les éléments. Exemple Remplacer un élément const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});
read(RequestOptions)	Lire la définition du conteneur
readOffer(RequestOptions)	Obtient l’offre sur le conteneur. S’il n’existe aucun élément, retourne une valeur OfferResponse dont la valeur n’est pas définie.
readPartitionKeyRanges(FeedOptions)
replace(ContainerDefinition, RequestOptions)	Remplacer la définition du conteneur

Détails de la propriété

conflicts

Opérations de lecture et d’interrogation des conflits pour le conteneur donné.

Pour lire ou supprimer un conflit spécifique, utilisez .conflict(id).

Conflicts conflicts

Valeur de propriété

Conflicts

database

database: Database

Valeur de propriété

Database

id

id: string

Valeur de propriété

string

items

Opérations de création d’éléments et de lecture/interrogation de tous les éléments

Pour lire, remplacer ou supprimer un élément existant, utilisez .item(id).

Exemple

Créer un élément

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

Items items

Valeur de propriété

Items

scripts

Toutes les opérations pour les procédures stockées, les déclencheurs et les fonctions définies par l’utilisateur

Scripts scripts

Valeur de propriété

Scripts

url

Retourne une URL de référence à la ressource. Utilisé pour la liaison dans Autorisations.

string url

Valeur de propriété

string

Détails de la méthode

conflict(string, PartitionKey)

Utilisé pour lire, remplacer ou supprimer un conflit existant spécifique par ID.

Permet .conflicts de créer de nouveaux conflits ou d’interroger/lire tous les conflits.

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

Paramètres

id

string

ID du conflit.

partitionKey

PartitionKey

Retours

Conflict

delete(RequestOptions)

Supprimer un conteneur

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

Paramètres

options

RequestOptions

Retours

Promise<ContainerResponse>

deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

Supprimer tous les documents appartiennent au conteneur pour la valeur de clé de partition fournie

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

Paramètres

partitionKey

PartitionKey

Valeur de clé de partition des éléments à supprimer

options

RequestOptions

Retours

Promise<ContainerResponse>

getFeedRanges()

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

Retours

Promise<readonly FeedRange[]>

toutes les plages de flux pour lesquelles le flux de modification peut être extrait.

getPartitionKeyDefinition()

Avertissement

Cette API est à présent déconseillée.

This method has been renamed to readPartitionKeyDefinition.

Obtient d’abord la définition de clé de partition en examinant le cache en lisant la collection.

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

Retours

Promise<ResourceResponse<PartitionKeyDefinition>>

getQueryPlan(string | SqlQuerySpec)

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

Paramètres

query

string | SqlQuerySpec

Retours

Promise<Response_2<PartitionedQueryExecutionInfo>>

item(string, PartitionKey)

Utilisé pour lire, remplacer ou supprimer un élément existant spécifique par id.

Utilisez .items pour créer de nouveaux éléments ou interroger/lire tous les éléments.

Exemple

Remplacer un élément 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ètres

id

string

ID de l’élément.

partitionKeyValue

PartitionKey

Valeur de la clé de partition Item

Retours

Item

read(RequestOptions)

Lire la définition du conteneur

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

Paramètres

options

RequestOptions

Retours

Promise<ContainerResponse>

readOffer(RequestOptions)

Obtient l’offre sur le conteneur. S’il n’existe aucun élément, retourne une valeur OfferResponse dont la valeur n’est pas définie.

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

Paramètres

options

RequestOptions

Retours

Promise<OfferResponse>

readPartitionKeyRanges(FeedOptions)

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

Paramètres

feedOptions

FeedOptions

Retours

QueryIterator<PartitionKeyRange>

replace(ContainerDefinition, RequestOptions)

Remplacer la définition du conteneur

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

Paramètres

body

ContainerDefinition

options

RequestOptions

Retours

Promise<ContainerResponse>