Container class

Pacchetto:

@azure/cosmos

Operazioni per la lettura, la sostituzione o l'eliminazione di un contenitore specifico in base all'ID.

Vedere Contenitori per la creazione di nuovi contenitori e lettura/query su tutti i contenitori; usare .containers.

Nota: tutte queste operazioni effettuano chiamate a un budget fisso. È consigliabile progettare il sistema in modo che queste chiamate vengano ridimensionate in modo secondario con l'applicazione. Ad esempio, non chiamare container(id).read() prima di ogni singola item.read() chiamata, per assicurarsi che il contenitore esista. Eseguire questa operazione una volta all'avvio dell'applicazione.

Proprietà

conflicts	Operazioni per la lettura e l'esecuzione di query sui conflitti per il contenitore specificato. Per la lettura o l'eliminazione di un conflitto specifico, usare .conflict(id).
database
id
items	Operazioni per la creazione di nuovi elementi e la lettura/esecuzione di query su tutti gli elementi Per la lettura, la sostituzione o l'eliminazione di un elemento esistente, usare .item(id). Esempio Creare un nuovo elemento const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});
scripts	Tutte le operazioni per stored procedure, trigger e funzioni definite dall'utente
url	Restituisce un URL di riferimento alla risorsa. Usato per il collegamento in Autorizzazioni.

Metodi

conflict(string, PartitionKey)	Usato per leggere, sostituire o eliminare un conflitto specifico esistente in base all'ID. Usare .conflicts per la creazione di nuovi conflitti o l'esecuzione di query/lettura di tutti i conflitti.
delete(RequestOptions)	Eliminare il contenitore
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)	Eliminare tutti i documenti appartengono al contenitore per il valore della chiave di partizione specificato
getFeedRanges()
getPartitionKeyDefinition()	Ottiene prima la definizione della chiave di partizione esaminando la cache in caso contrario leggendo la raccolta.
getQueryPlan(string | SqlQuerySpec)
item(string, PartitionKey)	Usato per leggere, sostituire o eliminare un elemento specifico, esistente in base all'ID. Usare .items per la creazione di nuovi elementi o l'esecuzione di query/lettura di tutti gli elementi. Esempio Sostituire un elemento const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});
read(RequestOptions)	Leggere la definizione del contenitore
readOffer(RequestOptions)	Ottiene l'offerta nel contenitore. Se non esiste, restituisce un oggetto OfferResponse con non definito.
readPartitionKeyRanges(FeedOptions)
replace(ContainerDefinition, RequestOptions)	Sostituire la definizione del contenitore

Dettagli proprietà

conflicts

Operazioni per la lettura e l'esecuzione di query sui conflitti per il contenitore specificato.

Per la lettura o l'eliminazione di un conflitto specifico, usare .conflict(id).

Conflicts conflicts

Valore della proprietà

Conflicts

database

database: Database

Valore della proprietà

Database

id

id: string

Valore della proprietà

string

items

Operazioni per la creazione di nuovi elementi e la lettura/esecuzione di query su tutti gli elementi

Per la lettura, la sostituzione o l'eliminazione di un elemento esistente, usare .item(id).

Esempio

Creare un nuovo elemento

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

Items items

Valore della proprietà

Items

scripts

Tutte le operazioni per stored procedure, trigger e funzioni definite dall'utente

Scripts scripts

Valore della proprietà

Scripts

url

Restituisce un URL di riferimento alla risorsa. Usato per il collegamento in Autorizzazioni.

string url

Valore della proprietà

string

Dettagli metodo

conflict(string, PartitionKey)

Usato per leggere, sostituire o eliminare un conflitto specifico esistente in base all'ID.

Usare .conflicts per la creazione di nuovi conflitti o l'esecuzione di query/lettura di tutti i conflitti.

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

Parametri

id

string

ID del conflitto.

partitionKey

PartitionKey

Restituisce

Conflict

delete(RequestOptions)

Eliminare il contenitore

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

Parametri

options

RequestOptions

Restituisce

Promise<ContainerResponse>

deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

Eliminare tutti i documenti appartengono al contenitore per il valore della chiave di partizione specificato

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

Parametri

partitionKey

PartitionKey

Valore della chiave di partizione degli elementi da eliminare

options

RequestOptions

Restituisce

Promise<ContainerResponse>

getFeedRanges()

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

Restituisce

Promise<readonly FeedRange[]>

tutti gli intervalli di feed per i quali è possibile recuperare changefeed.

getPartitionKeyDefinition()

Avviso

Questa API è ora deprecata.

This method has been renamed to readPartitionKeyDefinition.

Ottiene prima la definizione della chiave di partizione esaminando la cache in caso contrario leggendo la raccolta.

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

Restituisce

Promise<ResourceResponse<PartitionKeyDefinition>>

getQueryPlan(string | SqlQuerySpec)

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

Parametri

query

string | SqlQuerySpec

Restituisce

Promise<Response_2<PartitionedQueryExecutionInfo>>

item(string, PartitionKey)

Usato per leggere, sostituire o eliminare un elemento specifico, esistente in base all'ID.

Usare .items per la creazione di nuovi elementi o l'esecuzione di query/lettura di tutti gli elementi.

Esempio

Sostituire un elemento 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

Parametri

id

string

ID dell'elemento.

partitionKeyValue

PartitionKey

Valore della chiave di partizione Item

Restituisce

Item

read(RequestOptions)

Leggere la definizione del contenitore

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

Parametri

options

RequestOptions

Restituisce

Promise<ContainerResponse>

readOffer(RequestOptions)

Ottiene l'offerta nel contenitore. Se non esiste, restituisce un oggetto OfferResponse con non definito.

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

Parametri

options

RequestOptions

Restituisce

Promise<OfferResponse>

readPartitionKeyRanges(FeedOptions)

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

Parametri

feedOptions

FeedOptions

Restituisce

QueryIterator<PartitionKeyRange>

replace(ContainerDefinition, RequestOptions)

Sostituire la definizione del contenitore

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

Parametri

body

ContainerDefinition

options

RequestOptions

Restituisce

Promise<ContainerResponse>